NetBSD/lib/libcurses/curses.h

355 lines
13 KiB
C
Raw Normal View History

/* $NetBSD: curses.h,v 1.19 1997/09/12 21:08:22 phil Exp $ */
1997-07-22 11:36:17 +04:00
1993-03-21 12:45:37 +03:00
/*
1994-08-18 01:51:41 +04:00
* Copyright (c) 1981, 1993, 1994
* The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
1994-08-18 01:51:41 +04:00
* @(#)curses.h 8.4 (Berkeley) 8/10/94
1993-03-21 12:45:37 +03:00
*/
1993-08-07 09:48:37 +04:00
#ifndef _CURSES_H_
#define _CURSES_H_
1993-03-21 12:45:37 +03:00
#include <sys/types.h>
#include <sys/cdefs.h>
1993-08-07 09:48:37 +04:00
#include <stdio.h>
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/*
* The following #defines and #includes are present for backward
* compatibility only. They should not be used in future code.
*
* START BACKWARD COMPATIBILITY ONLY.
*/
#ifndef _CURSES_PRIVATE
1993-03-21 12:45:37 +03:00
#define bool char
#define reg register
1993-08-07 09:48:37 +04:00
#ifndef TRUE
1993-03-21 12:45:37 +03:00
#define TRUE (1)
1993-08-07 09:48:37 +04:00
#endif
#ifndef FALSE
1993-03-21 12:45:37 +03:00
#define FALSE (0)
1993-08-07 09:48:37 +04:00
#endif
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
#define _puts(s) tputs(s, 0, __cputchar)
#define _putchar(c) __cputchar(c)
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Old-style terminal modes access. */
#define baudrate() (cfgetospeed(&__baset))
1993-08-07 09:48:37 +04:00
#define crmode() cbreak()
#define erasechar() (__baset.c_cc[VERASE])
#define killchar() (__baset.c_cc[VKILL])
1993-08-07 09:48:37 +04:00
#define nocrmode() nocbreak()
#define ospeed (cfgetospeed(&__baset))
1993-08-07 09:48:37 +04:00
#endif /* _CURSES_PRIVATE */
1993-03-21 12:45:37 +03:00
extern char GT; /* Gtty indicates tabs. */
extern char NONL; /* Term can't hack LF doing a CR. */
extern char UPPERCASE; /* Terminal is uppercase only. */
1993-08-07 09:48:37 +04:00
extern int My_term; /* Use Def_term regardless. */
extern char *Def_term; /* Default terminal type. */
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Termcap capabilities. */
1993-12-05 02:03:43 +03:00
extern char AM, BS, CA, DA, EO, HC, IN, MI, MS, NC, NS, OS,
1993-08-07 09:48:37 +04:00
PC, UL, XB, XN, XT, XS, XX;
1993-03-21 12:45:37 +03:00
extern char *AL, *BC, *BT, *CD, *CE, *CL, *CM, *CR, *CS, *DC, *DL,
*DM, *DO, *ED, *EI, *K0, *K1, *K2, *K3, *K4, *K5, *K6,
*K7, *K8, *K9, *HO, *IC, *IM, *IP, *KD, *KE, *KH, *KL,
*KR, *KS, *KU, *LL, *MA, *ND, *NL, *RC, *SC, *SE, *SF,
*SO, *SR, *TA, *TE, *TI, *UC, *UE, *UP, *US, *VB, *VS,
*VE, *al, *dl, *sf, *sr,
1993-08-07 09:48:37 +04:00
*AL_PARM, *DL_PARM, *UP_PARM, *DOWN_PARM, *LEFT_PARM,
*RIGHT_PARM;
1993-03-21 12:45:37 +03:00
/* END BACKWARD COMPATIBILITY ONLY. */
/* 8-bit ASCII characters. */
#define unctrl(c) __unctrl[(c) & 0xff]
#define unctrllen(ch) __unctrllen[(ch) & 0xff]
extern char *__unctrl[256]; /* Control strings. */
extern char __unctrllen[256]; /* Control strings length. */
/*
* A window an array of __LINE structures pointed to by the 'lines' pointer.
* A line is an array of __LDATA structures pointed to by the 'line' pointer.
*
* IMPORTANT: the __LDATA structure must NOT induce any padding, so if new
* fields are added -- padding fields with *constant values* should ensure
* that the compiler will not generate any padding when storing an array of
* __LDATA structures. This is to enable consistent use of memcmp, and memcpy
* for comparing and copying arrays.
*/
typedef struct {
char ch; /* the actual character */
#define __STANDOUT 0x01 /* Added characters are standout. */
char attr; /* attributes of character */
} __LDATA;
#define __LDATASIZE (sizeof(__LDATA))
typedef struct {
#define __ISDIRTY 0x01 /* Line is dirty. */
#define __ISPASTEOL 0x02 /* Cursor is past end of line */
#define __FORCEPAINT 0x04 /* Force a repaint of the line */
unsigned int flags;
unsigned int hash; /* Hash value for the line. */
size_t *firstchp, *lastchp; /* First and last chngd columns ptrs */
size_t firstch, lastch; /* First and last changed columns. */
__LDATA *line; /* Pointer to the line text. */
} __LINE;
typedef struct __window { /* Window structure. */
struct __window *nextp, *orig; /* Subwindows list and parent. */
size_t begy, begx; /* Window home. */
size_t cury, curx; /* Current x, y coordinates. */
size_t maxy, maxx; /* Maximum values for curx, cury. */
short ch_off; /* x offset for firstch/lastch. */
__LINE **lines; /* Array of pointers to the lines */
__LINE *lspace; /* line space (for cleanup) */
__LDATA *wspace; /* window space (for cleanup) */
#define __ENDLINE 0x001 /* End of screen. */
#define __FLUSH 0x002 /* Fflush(stdout) after refresh. */
1994-08-18 01:51:41 +04:00
#define __FULLWIN 0x004 /* Window is a screen. */
#define __IDLINE 0x008 /* Insert/delete sequences. */
#define __SCROLLWIN 0x010 /* Last char will scroll window. */
#define __SCROLLOK 0x020 /* Scrolling ok. */
#define __CLEAROK 0x040 /* Clear on next refresh. */
#define __WSTANDOUT 0x080 /* Standout window */
#define __LEAVEOK 0x100 /* If curser left */
unsigned int flags;
} WINDOW;
1993-08-07 09:48:37 +04:00
/* Curses external declarations. */
extern WINDOW *curscr; /* Current screen. */
extern WINDOW *stdscr; /* Standard screen. */
1993-03-21 12:45:37 +03:00
extern struct termios __orig_termios; /* Terminal state before curses */
extern struct termios __baset; /* Our base terminal state */
extern int __tcaction; /* If terminal hardware set. */
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
extern int COLS; /* Columns on the screen. */
extern int LINES; /* Lines on the screen. */
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
extern char *ttytype; /* Full name of current terminal. */
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
#define ERR (0) /* Error return. */
#define OK (1) /* Success return. */
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Standard screen pseudo functions. */
#define addbytes(s, n) __waddbytes(stdscr, s, n, 0)
#define addch(ch) waddch(stdscr, ch)
#define addnstr(s, n) waddnstr(stdscr, s, n)
#define addstr(s) __waddbytes(stdscr, s, strlen(s), 0)
#define clear() wclear(stdscr)
#define clrtobot() wclrtobot(stdscr)
#define clrtoeol() wclrtoeol(stdscr)
#define delch() wdelch(stdscr)
#define deleteln() wdeleteln(stdscr)
#define erase() werase(stdscr)
#define getch() wgetch(stdscr)
#define getstr(s) wgetstr(stdscr, s)
#define inch() winch(stdscr)
#define insch(ch) winsch(stdscr, ch)
#define insertln() winsertln(stdscr)
#define move(y, x) wmove(stdscr, y, x)
#define refresh() wrefresh(stdscr)
#define standend() wstandend(stdscr)
#define standout() wstandout(stdscr)
#define waddbytes(w, s, n) __waddbytes(w, s, n, 0)
#define waddstr(w, s) __waddbytes(w, s, strlen(s), 0)
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Standard screen plus movement pseudo functions. */
#define mvaddbytes(y, x, s, n) mvwaddbytes(stdscr, y, x, s, n)
#define mvaddch(y, x, ch) mvwaddch(stdscr, y, x, ch)
#define mvaddnstr(y, x, s, n) mvwaddnstr(stdscr, y, x, s, n)
#define mvaddstr(y, x, s) mvwaddstr(stdscr, y, x, s)
#define mvdelch(y, x) mvwdelch(stdscr, y, x)
#define mvgetch(y, x) mvwgetch(stdscr, y, x)
#define mvgetstr(y, x, s) mvwgetstr(stdscr, y, x, s)
#define mvinch(y, x) mvwinch(stdscr, y, x)
#define mvinsch(y, x, c) mvwinsch(stdscr, y, x, c)
#define mvwaddbytes(w, y, x, s, n) \
(wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, n, 0))
#define mvwaddch(w, y, x, ch) \
(wmove(w, y, x) == ERR ? ERR : waddch(w, ch))
#define mvwaddnstr(w, y, x, s, n) \
(wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, n))
#define mvwaddstr(w, y, x, s) \
(wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, strlen(s), 0))
#define mvwdelch(w, y, x) \
(wmove(w, y, x) == ERR ? ERR : wdelch(w))
#define mvwgetch(w, y, x) \
(wmove(w, y, x) == ERR ? ERR : wgetch(w))
#define mvwgetstr(w, y, x, s) \
(wmove(w, y, x) == ERR ? ERR : wgetstr(w, s))
#define mvwinch(w, y, x) \
(wmove(w, y, x) == ERR ? ERR : winch(w))
#define mvwinsch(w, y, x, c) \
(wmove(w, y, x) == ERR ? ERR : winsch(w, c))
/* Psuedo functions. */
#define clearok(w, bf) \
((bf) ? ((w)->flags |= __CLEAROK) : ((w)->flags &= ~__CLEAROK))
#define flushok(w, bf) \
((bf) ? ((w)->flags |= __FLUSH) : ((w)->flags &= ~__FLUSH))
#define leaveok(w, bf) \
((bf) ? ((w)->flags |= __LEAVEOK) : ((w)->flags &= ~__LEAVEOK))
#define scrollok(w, bf) \
((bf) ? ((w)->flags |= __SCROLLOK) : ((w)->flags &= ~__SCROLLOK))
#define winch(w) \
((w)->lines[(w)->cury]->line[(w)->curx].ch & 0177)
1993-03-21 12:45:37 +03:00
#define getyx(w, y, x) (y) = getcury(w), (x) = getcurx(w)
#define getbegyx(w, y, x) (y) = getbegy(w), (x) = getbegx(w)
#define getmaxyx(w, y, x) (y) = getmaxy(w), (x) = getmaxx(w)
#define getcury(w) ((w)->cury)
#define getcurx(w) ((w)->curx)
#define getbegy(w) ((w)->begy)
#define getbegx(w) ((w)->begx)
#define getmaxy(w) ((w)->maxy)
#define getmaxx(w) ((w)->maxx)
1993-08-07 09:48:37 +04:00
/* Public function prototypes. */
__BEGIN_DECLS
1993-08-07 09:48:37 +04:00
int box __P((WINDOW *, int, int));
int cbreak __P((void));
int delwin __P((WINDOW *));
int echo __P((void));
int endwin __P((void));
char *fullname __P((char *, char *));
char *getcap __P((char *));
int gettmode __P((void));
void idlok __P((WINDOW *, int));
WINDOW *initscr __P((void));
char *longname __P((char *, char *));
int mvcur __P((int, int, int, int));
int mvprintw __P((int, int, const char *, ...));
int mvscanw __P((int, int, const char *, ...));
int mvwin __P((WINDOW *, int, int));
int mvwprintw __P((WINDOW *, int, int, const char *, ...));
int mvwscanw __P((WINDOW *, int, int, const char *, ...));
WINDOW *newwin __P((int, int, int, int));
int nl __P((void));
int nocbreak __P((void));
int noecho __P((void));
int nonl __P((void));
int noraw __P((void));
int overlay __P((WINDOW *, WINDOW *));
int overwrite __P((WINDOW *, WINDOW *));
int printw __P((const char *, ...));
int raw __P((void));
int resetty __P((void));
int savetty __P((void));
int scanw __P((const char *, ...));
int scroll __P((WINDOW *));
int setterm __P((char *));
int sscans __P((WINDOW *, const char *, ...));
1993-08-07 09:48:37 +04:00
WINDOW *subwin __P((WINDOW *, int, int, int, int));
int suspendwin __P((void));
int touchline __P((WINDOW *, int, int, int));
int touchoverlap __P((WINDOW *, WINDOW *));
int touchwin __P((WINDOW *));
1994-05-23 05:12:33 +04:00
int vwprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
int vwscanw __P((WINDOW *, const char *, _BSD_VA_LIST_));
1993-08-07 09:48:37 +04:00
int waddch __P((WINDOW *, int));
int waddnstr __P((WINDOW *, const char *, int));
1993-08-07 09:48:37 +04:00
int wclear __P((WINDOW *));
int wclrtobot __P((WINDOW *));
int wclrtoeol __P((WINDOW *));
int wdelch __P((WINDOW *));
int wdeleteln __P((WINDOW *));
int werase __P((WINDOW *));
int wgetch __P((WINDOW *));
int wgetstr __P((WINDOW *, char *));
int winsch __P((WINDOW *, int));
int winsertln __P((WINDOW *));
int wmove __P((WINDOW *, int, int));
int wprintw __P((WINDOW *, const char *, ...));
int wrefresh __P((WINDOW *));
int wscanw __P((WINDOW *, const char *, ...));
1994-08-18 01:51:41 +04:00
int wstandend __P((WINDOW *));
int wstandout __P((WINDOW *));
1994-05-23 05:12:33 +04:00
int vwprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
/* Private functions that are needed for user programs prototypes. */
void __cputchar __P((int));
int __waddbytes __P((WINDOW *, const char *, int, int));
__END_DECLS
1993-03-21 12:45:37 +03:00
/* Private functions. */
1993-08-07 09:48:37 +04:00
#ifdef _CURSES_PRIVATE
void __CTRACE __P((const char *, ...));
unsigned int __hash __P((char *, int));
1993-08-07 09:48:37 +04:00
void __id_subwins __P((WINDOW *));
int __mvcur __P((int, int, int, int, int));
void __restore_stophandler __P((void));
void __set_stophandler __P((void));
1993-08-07 09:48:37 +04:00
void __set_subwin __P((WINDOW *, WINDOW *));
void __startwin __P((void));
void __stop_signal_handler __P((int));
1993-08-07 09:48:37 +04:00
void __swflags __P((WINDOW *));
int __touchline __P((WINDOW *, int, int, int, int));
int __touchwin __P((WINDOW *));
1994-08-18 01:51:41 +04:00
char *__tscroll __P((const char *, int, int));
int __waddch __P((WINDOW *, __LDATA *));
int __stopwin __P((void));
void __restartwin __P((void));
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Private #defines. */
#define min(a,b) (a < b ? a : b)
#define max(a,b) (a > b ? a : b)
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Private externs. */
extern int __echoit;
extern int __endwin;
extern int __pfast;
extern int __rawmode;
extern int __noqch;
1993-08-07 09:48:37 +04:00
#endif
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
/* Termcap functions. */
__BEGIN_DECLS
1993-08-07 09:48:37 +04:00
int tgetent __P((char *, char *));
int tgetnum __P((char *));
int tgetflag __P((char *));
char *tgetstr __P((char *, char **));
char *tgoto __P((char *, int, int));
1995-06-06 12:10:00 +04:00
void tputs __P((char *, int, void (*)(int)));
__END_DECLS
1993-03-21 12:45:37 +03:00
1993-08-07 09:48:37 +04:00
#endif /* !_CURSES_H_ */