home *** CD-ROM | disk | FTP | other *** search
/ The C Users' Group Library 1994 August / wc-cdrom-cusersgrouplibrary-1994-08.iso / vol_300 / 332_01 / curses.h < prev    next >
C/C++ Source or Header  |  1990-01-07  |  14KB  |  286 lines
  1. /****************************************************************/
  2. /*                CURSES.H                */
  3. /* Header file for definitions and declarations for the        */
  4. /* PCcurses package. This should be #include'd in all user    */
  5. /* programs.                            */
  6. /****************************************************************/
  7. /* This version of curses is based on ncurses, a curses version    */
  8. /* originally written by Pavel Curtis at Cornell University.    */
  9. /* I have made substantial changes to make it run on IBM PC's,    */
  10. /* and therefore consider myself free to make it public domain.    */
  11. /*                Bjorn Larsson (bl@infovox.se)    */
  12. /****************************************************************/
  13. /* 1.4:  Window origin mod in overlay() and overwrite(),    */
  14. /*     on public (and very reasonable) request. Swapped    */
  15. /*     #define'd values of OK and ERR; OK now 1, and        */
  16. /*     ERR is 0/NULL. Conforms better to UNIX versions.    */
  17. /*     borderchars[] removed from WINDOW struct since        */
  18. /*     the border() functions were re-defined. Use of        */
  19. /*     short wherever possible. Portability improve-        */
  20. /*     ments, mispelled name of [w]setscrreg():    900114    */
  21. /* 1.3:     All modules lint-checked with MSC '-W3' and        */
  22. /*     Turbo'C' '-w -w-pro' switches. Support for        */
  23. /*     border(), wborder() functions:            881005    */
  24. /* 1.2:     Rcsid[] string in all modules, for mainte-        */
  25. /*     nance:                        881002    */
  26. /* 1.1:     'Raw' output routines, revision info in        */
  27. /*     curses.h:                    880306    */
  28. /* 1.0:     Release:                    870515    */
  29. /****************************************************************/
  30.  
  31. /* general definitions */
  32.  
  33. #ifndef     bool
  34. #define  bool        char        /* boolean type */
  35. #endif
  36.  
  37. #ifndef     TRUE
  38. #define     TRUE        1        /* booleans */
  39. #endif
  40.  
  41. #ifndef     FALSE
  42. #define     FALSE        0
  43. #endif
  44.  
  45. #define     ERR        0        /* general error flag */
  46. #define     OK        1        /* general OK flag */
  47.  
  48. /* functions defined as macros */
  49.  
  50. #define getch()       wgetch(stdscr)    /* using macroes allows you to use */
  51. #define    ungetch(c) wungetch(c)        /* #undef getch/ungetch in your */
  52.                     /* programs to use MSC/TRC getch() */
  53.                     /* and ungetch() routines */
  54.  
  55. #define getyx(win,y,x)       (y = (win)->_cury, x = (win)->_curx)
  56.  
  57. #ifndef max
  58. #define max(a,b) (((a) > (b)) ? (a) : (b))
  59. #endif
  60. #ifndef min
  61. #define min(a,b) (((a) < (b)) ? (a) : (b))
  62. #endif
  63.  
  64. /* video attribute definitions. Colour definitions for */
  65. /* CGA/EGA should also go here... */
  66.  
  67. #define    A_ALTCHARSET   0
  68. #define    A_BLINK        0x100
  69. #define    A_BLANK        0x200
  70. #define    A_BOLD         0x400
  71. #define    A_DIM          0
  72. #define    A_PROTECT      0
  73. #define    A_REVERSE      0x800
  74. #define    A_STANDOUT     0x1000
  75. #define    A_UNDERLINE    0x2000
  76.  
  77. /* function and keypad key definitions. Many are just for compatibility */
  78.  
  79. #define KEY_BREAK      0x101        /* Not on PC */
  80. #define KEY_DOWN       0x102        /* The four arrow keys */
  81. #define KEY_UP         0x103
  82. #define KEY_LEFT       0x104
  83. #define KEY_RIGHT      0x105
  84. #define KEY_HOME       0x106        /* Home key */
  85. #define KEY_BACKSPACE  0x107        /* Not on PC */
  86. #define KEY_F0         0x108        /* Function keys. Space for */
  87. #define KEY_F(n)       (KEY_F0+(n)) /*  64 keys is reserved. */
  88. #define KEY_DL         0x148        /* Not on PC */
  89. #define KEY_IL         0x149        /* Insert line */
  90. #define KEY_DC         0x14a        /* Delete character */
  91. #define KEY_IC         0x14b        /* Insert char or enter insert mode */
  92. #define KEY_EIC        0x14c        /* Exit insert char mode */
  93. #define KEY_CLEAR      0x14d        /* Clear screen */
  94. #define KEY_EOS        0x14e        /* Clear to end of screen */
  95. #define KEY_EOL        0x14f        /* Clear to end of line */
  96. #define KEY_SF         0x150        /* Scroll 1 line forward */
  97. #define KEY_SR         0x151        /* Scroll 1 line backwards (reverse) */
  98. #define KEY_NPAGE      0x152        /* Next page */
  99. #define KEY_PPAGE      0x153        /* Previous page */
  100. #define KEY_STAB       0x154        /* Set tab */
  101. #define KEY_CTAB       0x155        /* Clear tab */
  102. #define KEY_CATAB      0x156        /* Clear all tabs */
  103. #define KEY_ENTER      0x157        /* Enter or send (unreliable) */
  104. #define KEY_SRESET     0x158        /* soft (partial) reset (unreliable) */
  105. #define KEY_RESET      0x159        /* reset or hard reset (unreliable) */
  106. #define KEY_PRINT      0x15a        /* print or copy */
  107. #define KEY_LL         0x15b        /* home down or bottom (lower left) */
  108. #define KEY_ABORT      0x15c        /*  Abort/Terminate key (any) */
  109. #define KEY_SHELP      0x15d        /* Short help */
  110. #define KEY_LHELP      0x15e        /* Long help */
  111.  
  112. /* type declarations */
  113.  
  114. typedef struct
  115.   {
  116.   short       _cury;            /* Current pseudo-cursor */
  117.   short       _curx;
  118.   short       _maxy;            /* Max coordinates */
  119.   short       _maxx;
  120.   short       _begy;            /* Origin on screen */
  121.   short       _begx;
  122.   short       _flags;            /* Window properties */
  123.   short       _attrs;            /* Attributes of written characters */
  124.   short       _tabsize;            /* Tab character size */
  125.   bool       _clear;            /* Causes clear at next refresh */
  126.   bool       _leave;            /* Leaves cursor as it happens */
  127.   bool       _scroll;            /* Allows window scrolling */
  128.   bool       _nodelay;            /* Input character wait flag */
  129.   bool       _keypad;            /* Flags keypad key mode active */
  130.   short   **_line;            /* Pointer to line pointer array */
  131.   short      *_minchng;            /* First changed character in line */
  132.   short      *_maxchng;            /* Last changed character in line */
  133.   short       _regtop;            /* Top of scrolling region */
  134.   short       _regbottom;            /* Bottom of scrolling region */
  135.   }    WINDOW;
  136.  
  137. /* External variables */
  138.  
  139. extern    int    LINES;            /* terminal height */
  140. extern    int    COLS;            /* terminal width */
  141. extern    WINDOW *curscr;            /* the current screen image */
  142. extern    WINDOW *stdscr;            /* the default screen window */
  143.  
  144. /* PCcurses function declarations */
  145.  
  146. extern    int     addch();        /* put char in stdscr */
  147. extern    int     addrawch();        /* put char in stdscr, raw */
  148. extern    int     addstr();        /* put string in stdscr */
  149. extern    void     attrset();        /* set stdscr char attributes */
  150. extern    void     attroff();        /* clear attribute(a) stdscr */
  151. extern    void     attron();        /* add attribute(s) stdscr */
  152. extern    int     baudrate();        /* compatibility dummy */
  153. extern    void     beep();        /* sound bell */
  154. extern    void     border();        /* Set non-std box characters */
  155. extern    void     box();            /* draw a box around a window */
  156. extern    void     cbreak();        /* set terminal cbreak mode */
  157. extern    void     clear();        /* clear stdscr */
  158. extern    void     clearok();        /* marks a window for screen clear */
  159. extern    int     clrtobot();        /* clear end of stdscr */
  160. extern    int     clrtoeol();        /* clear end of line in stdscr */
  161. extern    void     crmode();        /* set terminal cbreak mode */
  162. extern    void     cursoff();        /* turns off hardware cursor */
  163. extern    void     curson();        /* turns on hardware cursor */
  164. extern    void     def_prog_mode();    /* save TTY modes */
  165. extern    void     def_shell_mode();    /* compatibility dummy */
  166. extern    int     delch();        /* delete a char in stdscr */
  167. extern    int     deleteln();        /* delete a line in stdscr */
  168. extern    void     delwin();        /* delete a window or a subwindow */
  169. extern  void     doupdate();        /* update physical screen */
  170. extern    void     echo();        /* set terminal echo mode */
  171. extern    int     endwin();        /* cleanup and finitialization */
  172. extern    void     erase();        /* erase stdscr */
  173. extern    int     erasechar();        /* return char kill character */
  174. extern    int     fixterm();        /* compatibility dummy */
  175. extern    void     flash();        /* flash terminal screen */
  176. extern    void     flushinp();        /* kill pending keyboard input */
  177. extern  int     getstr();        /* get string to stdscr and buffer */
  178. extern    int     gettmode();        /* compatibility dummy */
  179. extern    void     idlok();        /* use ins/del line (dummy) */
  180. extern    int     initscr();        /* curses initialization */
  181. extern  int     inch();        /* get char at stdscr cursor */
  182. extern    int     insch();        /* insert character in stdscr */
  183. extern    int     insrawch();        /* insert character in stdscr, raw */
  184. extern    int     insertln();        /* insert new line in stdscr */
  185. extern    void     keypad();        /* marks a window for keypad usage */
  186. extern    int     killchar();        /* return line kill character */
  187. extern    char    *longname();        /* terminal description */
  188. extern    void     leaveok();        /* marks window for cursor 'leave' */
  189. extern    void     meta();        /* marks window for meta (dummy) */
  190. extern    int     move();        /* move cursor in stdscr */
  191. extern    int     mvaddch();        /* move & put char in stdscr */
  192. extern    int     mvaddrawch();        /* move & put char in stdscr, raw */
  193. extern    int     mvaddstr();        /* move & put string in stdscr */
  194. extern    int     mvclrtobot();        /* move & clear end of stdscr */
  195. extern    int     mvclrtoeol();        /* move & clear lineend in stdscr */
  196. extern    int     mvcur();        /* move terminal cursor */
  197. extern    int     mvdelch();        /* move & delete a char in stdscr */
  198. extern    int     mvdeleteln();        /* move & delete a line in stdscr */
  199. extern    int     mvgetch();        /* move & get char to stdscr */
  200. extern    int     mvgetstr();        /* move & get string to stdscr */
  201. extern    int     mvinch();        /* move & get char at stdscr cursor */
  202. extern    int     mvinsch();        /* move & insert char in stdscr */
  203. extern    int     mvinsrawch();        /* move & insert raw char in stdscr */
  204. extern    int     mvinsertln();        /* move & insert new line in stdscr */
  205. extern    int     mvprintw();        /* move & print string in stdscr */
  206. extern    int     mvscanw();        /* move & get values via stdscr */
  207. extern    int     mvwaddch();        /* move & put char in a window */
  208. extern    int     mvwaddrawch();        /* move & put char in a window, raw */
  209. extern    int     mvwaddstr();        /* move & put string in a window */
  210. extern    int     mvwclrtobot();        /* move & clear end of a window */
  211. extern    int     mvwclrtoeol();        /* move & clear lineend in a window */
  212. extern    int     mvwdelch();        /* move & delete a char in a window */
  213. extern    int     mvwdeleteln();        /* move & delete a line in a window */
  214. extern    int     mvwgetch();        /* move & get char to a window */
  215. extern    int     mvwgetstr();        /* move & get string to a window */
  216. extern    int     mvwinch();        /* move & get char at window cursor */
  217. extern    int     mvwinsch();        /* move & insert char in a window */
  218. extern    int     mvwinsrawch();        /* move & insert raw char in window */
  219. extern    int     mvwinsertln();        /* move & insert new line in window */
  220. extern    int     mvwin();        /* move window */
  221. extern    int     mvwprintw();        /* move & print string in a window */
  222. extern    int     mvwscanw();        /* move & get values via a window */
  223. extern    WINDOW    *newwin();        /* create a window */
  224. extern    void     nl();            /* set terminal cr-crlf map mode */
  225. extern    void     nocbreak();        /* unset terminal cbreak mode */
  226. extern    void     nocrmode();        /* unset terminal cbreak mode */
  227. extern    void     nodelay();        /* marks window for no input wait */
  228. extern    void     noecho();        /* unset terminal echo mode */
  229. extern    void     nonl();        /* unset terminal cr-crlf map mode */
  230. extern    void     noraw();        /* unset raw terminal mode */
  231. extern    void     overlay();        /* overlay one window on another */
  232. extern    void     overwrite();        /* overwrite one window on another */
  233. extern    int     printw();        /* print string in stdscr */
  234. extern    void     raw();            /* set raw terminal mode */
  235. extern    void     refrbrk();        /* set screen refresh break mode */
  236. extern    void     refresh();        /* refresh stdscr */
  237. extern    int     resetterm();        /* compatibility dummy */
  238. extern    int     resetty();        /* restore terminal I/O modes */
  239. extern    void     reset_prog_mode();    /* restore terminal I/O modes */
  240. extern    void     reset_shell_mode();    /* set terminal to default modes */
  241. extern    int     saveoldterm();        /* compatibility dummy */
  242. extern    int     saveterm();        /* compatibility dummy */
  243. extern    int     savetty();        /* save terminal I/O modes */
  244. extern    int     scanw();        /* get values via stdscr */
  245. extern    void     scroll();        /* scroll region in a window */
  246. extern    void     scrollok();        /* marks a window to allow scroll */
  247. extern    int     setscrreg();        /* define stdscr's scroll region */
  248. extern    int     setterm();        /* compatibility dummy */
  249. extern    int     setupterm();        /* set up terminal (no-op) */
  250. extern    void     standend();        /* start normal chars in stdscr */
  251. extern    void     standout();        /* start standout chars in stdscr */
  252. extern    WINDOW    *subwin();        /* create a sub-window */
  253. extern    int     tabsize();        /* set/get tabsize of stdscr */
  254. extern    void     touchwin();        /* mark a window as modified */
  255. extern    char    *unctrl();        /* char-to-string converter */
  256. extern    int     waddch();        /* put char in a window */
  257. extern    int     waddrawch();        /* put char in a window, raw */
  258. extern    int     waddstr();        /* put string in a window */
  259. extern    void     wattroff();        /* clear attribute(a) in window */
  260. extern    void     wattron();        /* add attribute(s) in window */
  261. extern    void     wattrset();        /* set window char attributes */
  262. extern    void     wborder();        /* Set non-std box characters */
  263. extern    int     wbox();        /* draw a box inside a window */
  264. extern    void     wclear();        /* clear a window */
  265. extern    int     wclrtobot();        /* clear end of a window */
  266. extern    int     wclrtoeol();        /* clear end of line in a window */
  267. extern    int     wdelch();        /* delete a char in a window */
  268. extern    int     wdeleteln();        /* delete a line in a window */
  269. extern    void     werase();        /* erase a window */
  270. extern    int     wgetch();        /* get char to a window */
  271. extern  int     wgetstr();        /* get string to window and buffer */
  272. extern    int     winch();        /* get char at window cursor */
  273. extern    int     winsch();        /* insert character in a window */
  274. extern    int     winsrawch();        /* insert raw character in a window */
  275. extern    int     winsertln();        /* insert new line in a window */
  276. extern    int     wmove();        /* move cursor in a window */
  277. extern    void     wnoutrefresh();    /* create screen image, w/o display */
  278. extern    int     wprintw();        /* print string in a window */
  279. extern    void     wrefresh();        /* refresh screen */
  280. extern    int     wscanw();        /* get values via a window */
  281. extern    int     wsetscrreg();        /* define a window's scroll region */
  282. extern    void     wstandend();        /* start normal chars in window */
  283. extern    void     wstandout();        /* start standout chars in window */
  284. extern    int     wtabsize();        /* set/get tabsize of a window */
  285. extern    int     wungetch();        /* character push-back */
  286.