home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 April / macformat-049.iso / mac / Shareware Plus / Developers / dropg++ / usr / include / curses.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-02-20  |  12.3 KB  |  336 lines  |  [TEXT/R*ch]
  1. /*
  2.  * Copyright (c) 1981, 1993
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    @(#)curses.h    8.2 (Berkeley) 1/2/94
  34.  */
  35.  
  36. #ifndef _CURSES_H_
  37. #define    _CURSES_H_
  38.  
  39. #include <stdio.h>
  40.  
  41. /*
  42.  * The following #defines and #includes are present for backward
  43.  * compatibility only.  They should not be used in future code.
  44.  *
  45.  * START BACKWARD COMPATIBILITY ONLY.
  46.  */
  47. #ifndef _CURSES_PRIVATE
  48. #define    bool    char
  49. #define    reg    register
  50.  
  51. #ifndef TRUE
  52. #define    TRUE    (1)
  53. #endif
  54. #ifndef FALSE
  55. #define    FALSE    (0)
  56. #endif
  57.  
  58. #define    _puts(s)    tputs(s, 0, __cputchar)
  59. #define    _putchar(c)    __cputchar(c)
  60.  
  61. /* Old-style terminal modes access. */
  62. #define    baudrate()    (cfgetospeed(&__baset))
  63. #define    crmode()    cbreak()
  64. #define    erasechar()    (__baset.c_cc[VERASE])
  65. #define    killchar()    (__baset.c_cc[VKILL])
  66. #define    nocrmode()    nocbreak()
  67. #define    ospeed        (cfgetospeed(&__baset))
  68. #endif /* _CURSES_PRIVATE */
  69.  
  70. extern char     GT;            /* Gtty indicates tabs. */
  71. extern char     NONL;            /* Term can't hack LF doing a CR. */
  72. extern char     UPPERCASE;        /* Terminal is uppercase only. */
  73.  
  74. extern int     My_term;        /* Use Def_term regardless. */
  75. extern char    *Def_term;        /* Default terminal type. */
  76.  
  77. /* Termcap capabilities. */
  78. extern char    AM, BS, CA, DA, EO, HC, IN, MI, MS, NC, NS, OS,
  79.         PC, UL, XB, XN, XT, XS, XX;
  80. extern char    *AL, *BC, *BT, *CD, *CE, *CL, *CM, *CR, *CS, *DC, *DL,
  81.         *DM, *DO, *ED, *EI, *K0, *K1, *K2, *K3, *K4, *K5, *K6,
  82.         *K7, *K8, *K9, *HO, *IC, *IM, *IP, *KD, *KE, *KH, *KL,
  83.         *KR, *KS, *KU, *LL, *MA, *ND, *NL, *RC, *SC, *SE, *SF,
  84.         *SO, *SR, *TA, *TE, *TI, *UC, *UE, *UP, *US, *VB, *VS,
  85.         *VE, *al, *dl, *sf, *sr,
  86.         *AL_PARM, *DL_PARM, *UP_PARM, *DOWN_PARM, *LEFT_PARM,
  87.         *RIGHT_PARM;
  88.  
  89. /* END BACKWARD COMPATIBILITY ONLY. */
  90.  
  91. /* 8-bit ASCII characters. */
  92. #define    unctrl(c)        __unctrl[(c) & 0xff]
  93. #define    unctrllen(ch)        __unctrllen[(ch) & 0xff]
  94.  
  95. extern char    *__unctrl[256];    /* Control strings. */
  96. extern char     __unctrllen[256];    /* Control strings length. */
  97.  
  98. /*
  99.  * A window an array of __LINE structures pointed to by the 'lines' pointer.
  100.  * A line is an array of __LDATA structures pointed to by the 'line' pointer.
  101.  *
  102.  * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new
  103.  * fields are added -- padding fields with *constant values* should ensure 
  104.  * that the compiler will not generate any padding when storing an array of
  105.  *  __LDATA structures.  This is to enable consistent use of memcmp, and memcpy
  106.  * for comparing and copying arrays.
  107.  */
  108. typedef struct {
  109.     char ch;            /* the actual character */
  110.  
  111. #define    __STANDOUT    0x01          /* Added characters are standout. */
  112.     char attr;            /* attributes of character */
  113. } __LDATA;
  114.  
  115. #define __LDATASIZE    (sizeof(__LDATA))
  116.  
  117. typedef struct {
  118. #define    __ISDIRTY    0x01        /* Line is dirty. */
  119. #define __ISPASTEOL    0x02        /* Cursor is past end of line */
  120. #define __FORCEPAINT    0x04        /* Force a repaint of the line */
  121.     u_int flags;
  122.     u_int hash;            /* Hash value for the line. */
  123.     size_t *firstchp, *lastchp;    /* First and last chngd columns ptrs */
  124.     size_t firstch, lastch;        /* First and last changed columns. */
  125.     __LDATA *line;            /* Pointer to the line text. */
  126. } __LINE;
  127.  
  128. typedef struct __window {        /* Window structure. */
  129.     struct __window    *nextp, *orig;    /* Subwindows list and parent. */
  130.     size_t begy, begx;        /* Window home. */
  131.     size_t cury, curx;        /* Current x, y coordinates. */
  132.     size_t maxy, maxx;        /* Maximum values for curx, cury. */
  133.     short ch_off;            /* x offset for firstch/lastch. */
  134.     __LINE **lines;            /* Array of pointers to the lines */
  135.     __LINE  *lspace;        /* line space (for cleanup) */
  136.     __LDATA *wspace;        /* window space (for cleanup) */
  137.  
  138. #define    __ENDLINE    0x001        /* End of screen. */
  139. #define    __FLUSH        0x002        /* Fflush(stdout) after refresh. */
  140. #define    __FULLLINE    0x004        /* Line width = terminal width. */
  141. #define    __FULLWIN    0x008        /* Window is a screen. */
  142. #define    __IDLINE    0x010        /* Insert/delete sequences. */
  143. #define    __SCROLLWIN    0x020        /* Last char will scroll window. */
  144. #define    __SCROLLOK    0x040        /* Scrolling ok. */
  145. #define    __CLEAROK    0x080        /* Clear on next refresh. */
  146. #define __WSTANDOUT    0x100        /* Standout window */
  147. #define __LEAVEOK    0x200        /* If curser left */    
  148.     u_int flags;
  149. } WINDOW;
  150.  
  151. /* Curses external declarations. */
  152. extern WINDOW    *curscr;        /* Current screen. */
  153. extern WINDOW    *stdscr;        /* Standard screen. */
  154.  
  155. extern struct termios __orig_termios;    /* Terminal state before curses */
  156. extern struct termios __baset;        /* Our base terminal state */
  157. extern int __tcaction;            /* If terminal hardware set. */
  158.  
  159. extern int     COLS;            /* Columns on the screen. */
  160. extern int     LINES;            /* Lines on the screen. */
  161.  
  162. extern char    *ttytype;        /* Full name of current terminal. */
  163.  
  164. #define    ERR    (0)            /* Error return. */
  165. #define    OK    (1)            /* Success return. */
  166.  
  167. /* Standard screen pseudo functions. */
  168. #define    addbytes(s, n)            __waddbytes(stdscr, s, n, 0)
  169. #define    addch(ch)            waddch(stdscr, ch)
  170. #define    addnstr(s, n)            waddnstr(stdscr, s, n)
  171. #define    addstr(s)            __waddbytes(stdscr, s, strlen(s), 0)
  172. #define    clear()                wclear(stdscr)
  173. #define    clrtobot()            wclrtobot(stdscr)
  174. #define    clrtoeol()            wclrtoeol(stdscr)
  175. #define    delch()                wdelch(stdscr)
  176. #define    deleteln()            wdeleteln(stdscr)
  177. #define    erase()                werase(stdscr)
  178. #define    getch()                wgetch(stdscr)
  179. #define    getstr(s)            wgetstr(stdscr, s)
  180. #define    inch()                winch(stdscr)
  181. #define    insch(ch)            winsch(stdscr, ch)
  182. #define    insertln()            winsertln(stdscr)
  183. #define    move(y, x)            wmove(stdscr, y, x)
  184. #define    refresh()            wrefresh(stdscr)
  185. #define    standend()            wstandend(stdscr)
  186. #define    standout()            wstandout(stdscr)
  187. #define    waddbytes(w, s, n)        __waddbytes(w, s, n, 0)
  188. #define    waddstr(w, s)            __waddbytes(w, s, strlen(s), 0)
  189.  
  190. /* Standard screen plus movement pseudo functions. */
  191. #define    mvaddbytes(y, x, s, n)        mvwaddbytes(stdscr, y, x, s, n)
  192. #define    mvaddch(y, x, ch)        mvwaddch(stdscr, y, x, ch)
  193. #define    mvaddnstr(y, x, s, n)        mvwaddnstr(stdscr, y, x, s, n)
  194. #define    mvaddstr(y, x, s)        mvwaddstr(stdscr, y, x, s)
  195. #define    mvdelch(y, x)            mvwdelch(stdscr, y, x)
  196. #define    mvgetch(y, x)            mvwgetch(stdscr, y, x)
  197. #define    mvgetstr(y, x, s)        mvwgetstr(stdscr, y, x, s)
  198. #define    mvinch(y, x)            mvwinch(stdscr, y, x)
  199. #define    mvinsch(y, x, c)        mvwinsch(stdscr, y, x, c)
  200. #define    mvwaddbytes(w, y, x, s, n) \
  201.     (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, n, 0))
  202. #define    mvwaddch(w, y, x, ch) \
  203.     (wmove(w, y, x) == ERR ? ERR : waddch(w, ch))
  204. #define    mvwaddnstr(w, y, x, s, n) \
  205.     (wmove(w, y, x) == ERR ? ERR : waddnstr(w, s, n))
  206. #define    mvwaddstr(w, y, x, s) \
  207.     (wmove(w, y, x) == ERR ? ERR : __waddbytes(w, s, strlen(s), 0))
  208. #define    mvwdelch(w, y, x) \
  209.     (wmove(w, y, x) == ERR ? ERR : wdelch(w))
  210. #define    mvwgetch(w, y, x) \
  211.     (wmove(w, y, x) == ERR ? ERR : wgetch(w))
  212. #define    mvwgetstr(w, y, x, s) \
  213.     (wmove(w, y, x) == ERR ? ERR : wgetstr(w, s))
  214. #define    mvwinch(w, y, x) \
  215.     (wmove(w, y, x) == ERR ? ERR : winch(w))
  216. #define    mvwinsch(w, y, x, c) \
  217.     (wmove(w, y, x) == ERR ? ERR : winsch(w, c))
  218.  
  219. /* Psuedo functions. */
  220. #define    clearok(w, bf) \
  221.     ((bf) ? ((w)->flags |= __CLEAROK) : ((w)->flags &= ~__CLEAROK))
  222. #define    flushok(w, bf) \
  223.     ((bf) ? ((w)->flags |= __FLUSH) : ((w)->flags &= ~__FLUSH))
  224. #define    getyx(w, y, x) \
  225.     (y) = (w)->cury, (x) = (w)->curx
  226. #define    leaveok(w, bf) \
  227.     ((bf) ? ((w)->flags |= __LEAVEOK) : ((w)->flags &= ~__LEAVEOK))
  228. #define    scrollok(w, bf) \
  229.     ((bf) ? ((w)->flags |= __SCROLLOK) : ((w)->flags &= ~__SCROLLOK))
  230. #define    winch(w) \
  231.     ((w)->lines[(w)->cury]->line[(w)->curx].ch & 0177)
  232.  
  233. /* Public function prototypes. */
  234. int     box __P((WINDOW *, int, int));
  235. int     cbreak __P((void));
  236. int     delwin __P((WINDOW *));
  237. int     echo __P((void));
  238. int     endwin __P((void));
  239. char    *fullname __P((char *, char *));
  240. char    *getcap __P((char *));
  241. int     gettmode __P((void));
  242. void     idlok __P((WINDOW *, int));
  243. WINDOW    *initscr __P((void));
  244. char    *longname __P((char *, char *));
  245. int     mvcur __P((int, int, int, int));
  246. int     mvprintw __P((int, int, const char *, ...));
  247. int     mvscanw __P((int, int, const char *, ...));
  248. int     mvwin __P((WINDOW *, int, int));
  249. int     mvwprintw __P((WINDOW *, int, int, const char *, ...));
  250. int     mvwscanw __P((WINDOW *, int, int, const char *, ...));
  251. WINDOW    *newwin __P((int, int, int, int));
  252. int     nl __P((void));
  253. int     nocbreak __P((void));
  254. int     noecho __P((void));
  255. int     nonl __P((void));
  256. int     noraw __P((void));
  257. int     overlay __P((WINDOW *, WINDOW *));
  258. int     overwrite __P((WINDOW *, WINDOW *));
  259. int     printw __P((const char *, ...));
  260. int     raw __P((void));
  261. int     resetty __P((void));
  262. int     savetty __P((void));
  263. int     scanw __P((const char *, ...));
  264. int     scroll __P((WINDOW *));
  265. int     setterm __P((char *));
  266. int     sscans __P((WINDOW *, const char *, ...));
  267. WINDOW    *subwin __P((WINDOW *, int, int, int, int));
  268. int     suspendwin __P((void));
  269. int     touchline __P((WINDOW *, int, int, int));
  270. int     touchoverlap __P((WINDOW *, WINDOW *));
  271. int     touchwin __P((WINDOW *));
  272. int      vwprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
  273. int      vwscanw __P((WINDOW *, const char *, _BSD_VA_LIST_));
  274. int     waddch __P((WINDOW *, int));
  275. int     waddnstr __P((WINDOW *, const char *, int));
  276. int     wclear __P((WINDOW *));
  277. int     wclrtobot __P((WINDOW *));
  278. int     wclrtoeol __P((WINDOW *));
  279. int     wdelch __P((WINDOW *));
  280. int     wdeleteln __P((WINDOW *));
  281. int     werase __P((WINDOW *));
  282. int     wgetch __P((WINDOW *));
  283. int     wgetstr __P((WINDOW *, char *));
  284. int     winsch __P((WINDOW *, int));
  285. int     winsertln __P((WINDOW *));
  286. int     wmove __P((WINDOW *, int, int));
  287. int     wprintw __P((WINDOW *, const char *, ...));
  288. int     wrefresh __P((WINDOW *));
  289. int     wscanw __P((WINDOW *, const char *, ...));
  290. char    *wstandend __P((WINDOW *));
  291. char    *wstandout __P((WINDOW *));
  292. int     vwprintw __P((WINDOW *, const char *, _BSD_VA_LIST_));
  293.  
  294. /* Private functions that are needed for user programs prototypes. */
  295. void     __cputchar __P((int));
  296. int     __waddbytes __P((WINDOW *, const char *, int, int));
  297.  
  298. /* Private functions. */
  299. #ifdef _CURSES_PRIVATE
  300. void     __CTRACE __P((const char *, ...));
  301. u_int     __hash __P((char *, int));
  302. void     __id_subwins __P((WINDOW *));
  303. int     __mvcur __P((int, int, int, int, int));
  304. void     __restore_stophandler __P((void));
  305. void     __set_stophandler __P((void));
  306. void     __set_subwin __P((WINDOW *, WINDOW *));
  307. void     __startwin __P((void));
  308. void     __stop_signal_handler __P((int));
  309. void     __swflags __P((WINDOW *));
  310. int     __touchline __P((WINDOW *, int, int, int, int));
  311. int     __touchwin __P((WINDOW *));
  312. char    *__tscroll __P((const char *, int));
  313. int     __waddch __P((WINDOW *, __LDATA *));
  314.  
  315. /* Private #defines. */
  316. #define    min(a,b)    (a < b ? a : b)
  317. #define    max(a,b)    (a > b ? a : b)
  318.  
  319. /* Private externs. */
  320. extern int     __echoit;
  321. extern int     __endwin;
  322. extern int     __pfast;
  323. extern int     __rawmode;
  324. extern int     __noqch;
  325. #endif
  326.  
  327. /* Termcap functions. */
  328. int     tgetent __P((char *, char *));
  329. int     tgetnum __P((char *));
  330. int     tgetflag __P((char *));
  331. char    *tgetstr __P((char *, char **));
  332. char    *tgoto __P((char *, int, int));
  333. int     tputs __P((char *, int, void (*)(int)));
  334.  
  335. #endif /* !_CURSES_H_ */
  336.