NetBSD/lib/libcurses/curses.h

518 lines
20 KiB
C

/* $NetBSD: curses.h,v 1.28 1999/10/04 23:21:18 lukem Exp $ */
/*
* Copyright (c) 1981, 1993, 1994
* The Regents of the University of California. All rights reserved.
*
* 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.
*
* @(#)curses.h 8.5 (Berkeley) 4/29/95
*/
#ifndef _CURSES_H_
#define _CURSES_H_
#include <sys/types.h>
#include <sys/cdefs.h>
#include <stdio.h>
#include <termcap.h>
/*
* 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
#ifndef __cplusplus
#define bool char
#define reg register
#endif
#ifndef TRUE
#define TRUE (/*CONSTCOND*/1)
#endif
#ifndef FALSE
#define FALSE (/*CONSTCOND*/0)
#endif
#define _puts(s) tputs(s, 0, __cputchar)
#define _putchar(c) __cputchar(c)
/* Old-style terminal modes access. */
#define baudrate() (cfgetospeed(&__baset))
#define crmode() cbreak()
#define erasechar() (__baset.c_cc[VERASE])
#define killchar() (__baset.c_cc[VKILL])
#define nocrmode() nocbreak()
#define ospeed (cfgetospeed(&__baset))
#endif /* _CURSES_PRIVATE */
extern char GT; /* Gtty indicates tabs. */
extern char NONL; /* Term can't hack LF doing a CR. */
extern char UPPERCASE; /* Terminal is uppercase only. */
extern int My_term; /* Use Def_term regardless. */
extern char *Def_term; /* Default terminal type. */
/* Termcap capabilities. */
extern char AM, BS, CA, DA, EO, HC, IN, MI, MS, NC, NS, OS,
PC, UL, XB, XN, XT, XS, XX;
extern char *AL, *BC, *BL, *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, *MB, *MD, *ME, *MH, *MK,
*MP, *MR, *ND, *NL, *RC, *SC, *SE, *SF, *SO, *SR, *TA,
*TE, *TI, *UC, *UE, *UP, *US, *VB, *VS, *VE, *al, *dl,
*sf, *sr, *AL_PARM, *DL_PARM, *UP_PARM, *DOWN_PARM,
*LEFT_PARM, *RIGHT_PARM;
/* END BACKWARD COMPATIBILITY ONLY. */
/* symbols for values returned by getch in keypad mode */
#define KEY_MIN 0x101 /* minimum extended key value */
#define KEY_BREAK 0x101 /* break key */
#define KEY_DOWN 0x102 /* down arrow */
#define KEY_UP 0x103 /* up arrow */
#define KEY_LEFT 0x104 /* left arrow */
#define KEY_RIGHT 0x105 /* right arrow*/
#define KEY_HOME 0x106 /* home key */
#define KEY_BACKSPACE 0x107 /* Backspace */
/* First function key (block of 64 follow) */
#define KEY_F0 0x108
/* Function defining other function key values*/
#define KEY_F(n) (KEY_F0+(n))
#define KEY_DL 0x148 /* Delete Line */
#define KEY_IL 0x149 /* Insert Line*/
#define KEY_DC 0x14A /* Delete Character */
#define KEY_IC 0x14B /* Insert Character */
#define KEY_EIC 0x14C /* Exit Insert Char mode */
#define KEY_CLEAR 0x14D /* Clear screen */
#define KEY_EOS 0x14E /* Clear to end of screen */
#define KEY_EOL 0x14F /* Clear to end of line */
#define KEY_SF 0x150 /* Scroll one line forward */
#define KEY_SR 0x151 /* Scroll one line back */
#define KEY_NPAGE 0x152 /* Next Page */
#define KEY_PPAGE 0x153 /* Prev Page */
#define KEY_STAB 0x154 /* Set Tab */
#define KEY_CTAB 0x155 /* Clear Tab */
#define KEY_CATAB 0x156 /* Clear All Tabs */
#define KEY_ENTER 0x157 /* Enter or Send */
#define KEY_SRESET 0x158 /* Soft Reset */
#define KEY_RESET 0x159 /* Hard Reset */
#define KEY_PRINT 0x15A /* Print */
#define KEY_LL 0x15B /* Home Down */
/*
* "Keypad" keys arranged like this:
*
* A1 up A3
* left B2 right
* C1 down C3
*
*/
#define KEY_A1 0x15C /* Keypad upper left */
#define KEY_A3 0x15D /* Keypad upper right */
#define KEY_B2 0x15E /* Keypad centre key */
#define KEY_C1 0x15F /* Keypad lower left */
#define KEY_C3 0x160 /* Keypad lower right */
#define KEY_BTAB 0x161 /* Back Tab */
#define KEY_BEG 0x162 /* Begin key */
#define KEY_CANCEL 0x163 /* Cancel key */
#define KEY_CLOSE 0x164 /* Close Key */
#define KEY_COMMAND 0x165 /* Command Key */
#define KEY_COPY 0x166 /* Copy key */
#define KEY_CREATE 0x167 /* Create key */
#define KEY_END 0x168 /* End key */
#define KEY_EXIT 0x169 /* Exit key */
#define KEY_FIND 0x16A /* Find key */
#define KEY_HELP 0x16B /* Help key */
#define KEY_MARK 0x16C /* Mark key */
#define KEY_MESSAGE 0x16D /* Message key */
#define KEY_MOVE 0x16E /* Move key */
#define KEY_NEXT 0x16F /* Next Object key */
#define KEY_OPEN 0x170 /* Open key */
#define KEY_OPTIONS 0x171 /* Options key */
#define KEY_PREVIOUS 0x172 /* Previous Object key */
#define KEY_REDO 0x173 /* Redo key */
#define KEY_REFERENCE 0x174 /* Ref Key */
#define KEY_REFRESH 0x175 /* Refresh key */
#define KEY_REPLACE 0x176 /* Replace key */
#define KEY_RESTART 0x177 /* Restart key */
#define KEY_RESUME 0x178 /* Resume key */
#define KEY_SAVE 0x179 /* Save key */
#define KEY_SBEG 0x17A /* Shift begin key */
#define KEY_SCANCEL 0x17B /* Shift Cancel key */
#define KEY_SCOMMAND 0x17C /* Shift Command key */
#define KEY_SCOPY 0x17D /* Shift Copy key */
#define KEY_SCREATE 0x17E /* Shift Create key */
#define KEY_SDC 0x17F /* Shift Delete Character */
#define KEY_SDL 0x180 /* Shift Delete Line */
#define KEY_SELECT 0x181 /* Select key */
#define KEY_SEND 0x182 /* Send key */
#define KEY_SEOL 0x183 /* Shift Clear Line key */
#define KEY_SEXIT 0x184 /* Shift Exit key */
#define KEY_SFIND 0x185 /* Shift Find key */
#define KEY_SHELP 0x186 /* Shift Help key */
#define KEY_SHOME 0x187 /* Shift Home key */
#define KEY_SIC 0x188 /* Shift Input key */
#define KEY_SLEFT 0x189 /* Shift Left Arrow key */
#define KEY_SMESSAGE 0x18A /* Shift Message key */
#define KEY_SMOVE 0x18B /* Shift Move key */
#define KEY_SNEXT 0x18C /* Shift Next key */
#define KEY_SOPTIONS 0x18D /* Shift Options key */
#define KEY_SPREVIOUS 0x18E /* Shift Previous key */
#define KEY_SPRINT 0x18F /* Shift Print key */
#define KEY_SREDO 0x190 /* Shift Redo key */
#define KEY_SREPLACE 0x191 /* Shift Replace key */
#define KEY_SRIGHT 0x192 /* Shift Right Arrow key */
#define KEY_SRESUME 0x193 /* Shift Resume key */
#define KEY_SSAVE 0x194 /* Shift Save key */
#define KEY_SSUSPEND 0x195 /* Shift Suspend key */
#define KEY_SUNDO 0x196 /* Shift Undo key */
#define KEY_SUSPEND 0x197 /* Suspend key */
#define KEY_UNDO 0x198 /* Undo key */
#define KEY_MAX 0x198 /* maximum extended key value */
/* 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 {
int ch; /* the actual character */
#define __NORMAL 0x00 /* Added characters are normal. */
#define __STANDOUT 0x01 /* Added characters are standout. */
#define __UNDERSCORE 0x02 /* Added characters are underscored. */
#define __REVERSE 0x04 /* Added characters are reverse \
video. */
#define __BLINK 0x08 /* Added characters are blinking. */
#define __DIM 0x10 /* Added characters are dim. */
#define __BOLD 0x20 /* Added characters are bold. */
#define __BLANK 0x40 /* Added characters are blanked. */
#define __PROTECT 0x80 /* Added characters are protected. */
#define __ATTRIBUTES 0xfe /* All character attributes
(excluding standout). */
int 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 0x00001 /* End of screen. */
#define __FLUSH 0x00002 /* Fflush(stdout) after refresh. */
#define __FULLWIN 0x00004 /* Window is a screen. */
#define __IDLINE 0x00008 /* Insert/delete sequences. */
#define __SCROLLWIN 0x00010 /* Last char will scroll window. */
#define __SCROLLOK 0x00020 /* Scrolling ok. */
#define __CLEAROK 0x00040 /* Clear on next refresh. */
#define __WSTANDOUT 0x00080 /* Standout window */
#define __LEAVEOK 0x00100 /* If curser left */
#define __WUNDERSCORE 0x00200 /* Underscored window */
#define __WREVERSE 0x00400 /* Reverse video window */
#define __WBLINK 0x00800 /* Blinking window */
#define __WDIM 0x01000 /* Dim window */
#define __WBOLD 0x02000 /* Bold window */
#define __WBLANK 0x04000 /* Blanked window */
#define __WPROTECT 0x08000 /* Protected window */
#define __WATTRIBUTES 0x0fc00 /* All character attributes
(excluding standout). */
#define __KEYPAD 0x10000 /* If interpreting keypad codes */
#define __NOTIMEOUT 0x20000 /* Wait indefinitely for func keys */
unsigned int flags;
int delay; /* delay for getch() */
} WINDOW;
/* Curses external declarations. */
extern WINDOW *curscr; /* Current screen. */
extern WINDOW *stdscr; /* Standard screen. */
extern struct termios __orig_termios; /* Terminal state before curses */
extern struct termios __baset; /* Our base terminal state */
extern int __tcaction; /* If terminal hardware set. */
extern int COLS; /* Columns on the screen. */
extern int LINES; /* Lines on the screen. */
extern char *ttytype; /* Full name of current terminal. */
#define ERR (0) /* Error return. */
#define OK (1) /* Success return. */
/* 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) waddnstr(stdscr, s, -1)
#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 timeout(delay) wtimeout(stdscr, delay)
#define underscore() wunderscore(stdscr)
#define underend() wunderend(stdscr)
#define attron(attr) wattron(stdscr, attr)
#define attroff(attr) wattroff(stdscr, attr)
#define attrset(attr) wattrset(stdscr, attr)
#define waddbytes(w, s, n) __waddbytes(w, s, n, 0)
#define waddstr(w, s) waddnstr(w, s, -1)
/* Attributes */
#define A_NORMAL __NORMAL
#define A_STANDOUT __UNDERSCORE
#define A_UNDERLINE __UNDERSCORE
#define A_REVERSE __REVERSE
#define A_BLINK __BLINK
#define A_DIM __DIM
#define A_BOLD __BOLD
#define A_BLANK __BLANK
#define A_PROTECT __PROTECT
#define A_ATTRIBUTES __ATTRIBUTES
/* 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 : waddnstr(w, s, -1))
#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) \
((/* CONSTCOND */ 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)
#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)
/* Public function prototypes. */
__BEGIN_DECLS
int beep __P((void));
int box __P((WINDOW *, int, int));
int cbreak __P((void));
int delwin __P((WINDOW *));
int echo __P((void));
int endwin __P((void));
int flash __P((void));
int flushinp __P((void));
char *fullname __P((char *, char *));
char *getcap __P((char *));
int gettmode __P((void));
void idlok __P((WINDOW *, int));
WINDOW *initscr __P((void));
int isendwin __P((void));
void keypad __P((WINDOW *, int));
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));
void nodelay __P((WINDOW *, int));
int noecho __P((void));
int nonl __P((void));
int noraw __P((void));
void notimeout __P((WINDOW *, int));
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 *, ...));
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 *));
int vwprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
int vwscanw __P((WINDOW *, const char *, _BSD_VA_LIST_));
int waddch __P((WINDOW *, int));
int waddnstr __P((WINDOW *, const char *, int));
int wattron __P((WINDOW *, int));
int wattroff __P((WINDOW *, int));
int wattrset __P((WINDOW *, int));
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 *, ...));
int wstandend __P((WINDOW *));
int wstandout __P((WINDOW *));
void wtimeout __P((WINDOW *, int));
int wunderscore __P((WINDOW *));
int wunderend __P((WINDOW *));
int vwprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
/* Private functions that are needed for user programs prototypes. */
int __cputchar __P((int));
int __waddbytes __P((WINDOW *, const char *, int, int));
__END_DECLS
/* Private functions. */
#ifdef _CURSES_PRIVATE
void __CTRACE __P((const char *, ...));
int __delay __P((void));
unsigned int __hash __P((char *, int));
void __id_subwins __P((WINDOW *));
void __init_getch __P((char *));
int __mvcur __P((int, int, int, int, int));
int __nodelay __P((void));
int __notimeout __P((void));
void __restore_termios __P((void));
void __restore_stophandler __P((void));
void __save_termios __P((void));
void __set_stophandler __P((void));
void __set_subwin __P((WINDOW *, WINDOW *));
void __startwin __P((void));
void __stop_signal_handler __P((int));
void __swflags __P((WINDOW *));
int __timeout __P((int));
int __touchline __P((WINDOW *, int, int, int, int));
int __touchwin __P((WINDOW *));
char *__tscroll __P((const char *, int, int));
int __waddch __P((WINDOW *, __LDATA *));
int __stopwin __P((void));
void __restartwin __P((void));
/* Private #defines. */
#define min(a,b) (a < b ? a : b)
#define max(a,b) (a > b ? a : b)
/* Private externs. */
extern int __echoit;
extern int __endwin;
extern int __pfast;
extern int __rawmode;
extern int __noqch;
#endif
#endif /* !_CURSES_H_ */