lib/libcurses/curses_private.h

   1 /*      $NetBSD: curses_private.h,v 1.49 2013/11/09 11:16:59 blymn Exp $        */
   2
   3 /*-
   4  * Copyright (c) 1998-2000 Brett Lymn
   5  *                         (blymn@baea.com.au, brett_lymn@yahoo.com.au)
   6  * All rights reserved.
   7  *
   8  * This code has been donated to The NetBSD Foundation by the Author.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  *
  30  */
  31
  32 /* Modified by Ruibiao Qiu <ruibiao@arl.wustl.edu,ruibiao@gmail.com>
  33  * to add support for wide characters
  34  * Changes:
  35  * - Add a compiler variable HAVE_WCHAR for wide character only code
  36  * - Add a pointer to liked list of non-spacing characters in __ldata
  37  *   and the macro to access the width field in the attribute field
  38  * - Add a circular input character buffer in __screen to handle
  39  *   wide-character input (used in get_wch())
  40  */
  41
  42 #include <term.h>
  43 #include <termios.h>
  44
  45 /* Private structure definitions for curses. */
  46
  47 /* Termcap capabilities. */
  48 #ifdef HAVE_WCHAR
  49 /*
  50  * Add a list of non-spacing characters to each spacing
  51  * character in a singly linked list
  52  */
  53 typedef struct nschar_t {
  54         wchar_t                 ch;             /* Non-spacing character */
  55         struct nschar_t *next;  /* Next non-spacing character */
  56 } nschar_t;
  57 #endif /* HAVE_WCHAR */
  58
  59 /*
  60  * A window is an array of __LINE structures pointed to by the 'lines' pointer.
  61  * A line is an array of __LDATA structures pointed to by the 'line' pointer.
  62  *
  63  * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new
  64  * fields are added -- padding fields with *constant values* should ensure
  65  * that the compiler will not generate any padding when storing an array of
  66  *  __LDATA structures.  This is to enable consistent use of memcmp, and memcpy
  67  * for comparing and copying arrays.
  68  */
  69
  70 struct __ldata {
  71         wchar_t ch;                     /* Character */
  72         attr_t  attr;                   /* Attributes */
  73 #ifdef HAVE_WCHAR
  74         nschar_t        *nsp;   /* Foreground non-spacing character pointer */
  75 #endif /* HAVE_WCHAR */
  76 };
  77
  78 #ifdef HAVE_WCHAR
  79 /* macros to extract the width of a wide character */
  80 #define __WCWIDTH 0xfc000000
  81 #define WCW_SHIFT 26
  82 #define WCOL(wc) ((((unsigned) (wc).attr) >> WCW_SHIFT ) > MB_LEN_MAX ? ((int)(((unsigned) (wc).attr ) >> WCW_SHIFT )) - 64 : ((int)(((unsigned) (wc).attr ) >> WCW_SHIFT)))
  83 #define SET_WCOL(c, w) do {                                             \
  84         ((c).attr) = ((((c).attr) & WA_ATTRIBUTES ) | ((w) << WCW_SHIFT )); \
  85 } while(/*CONSTCOND*/0)
  86 #define BGWCOL(wc) ((((wc).battr) >> WCW_SHIFT ) > MB_LEN_MAX ? (((wc).battr ) >> WCW_SHIFT ) - 64 : (((wc).battr ) >> WCW_SHIFT ))
  87 #define SET_BGWCOL(c, w) do {                                           \
  88         ((c).battr) = ((((c).battr) & WA_ATTRIBUTES ) | ((w) << WCW_SHIFT )); \
  89 } while(/*CONSTCOND*/0)
  90 #endif /* HAVE_WCHAR */
  91
  92 #define __LDATASIZE     (sizeof(__LDATA))
  93
  94 struct __line {
  95 #ifdef DEBUG
  96 #define SENTINEL_VALUE 0xaac0ffee
  97
  98         unsigned int sentinel;          /* try to catch line overflows */
  99 #endif
 100 #define __ISDIRTY       0x01            /* Line is dirty. */
 101 #define __ISPASTEOL     0x02            /* Cursor is past end of line */
 102 #define __ISFORCED      0x04            /* Force update, no optimisation */
 103         unsigned int flags;
 104         unsigned int hash;              /* Hash value for the line. */
 105         int *firstchp, *lastchp;        /* First and last chngd columns ptrs */
 106         int firstch, lastch;            /* First and last changed columns. */
 107         __LDATA *line;                  /* Pointer to the line text. */
 108 };
 109
 110 struct __window {               /* Window structure. */
 111         struct __window *nextp, *orig;  /* Subwindows list and parent. */
 112         int begy, begx;                 /* Window home. */
 113         int cury, curx;                 /* Current x, y coordinates. */
 114         int maxy, maxx;                 /* Maximum values for curx, cury. */
 115         int reqy, reqx;                 /* Size requested when created */
 116         int ch_off;                     /* x offset for firstch/lastch. */
 117         __LINE **alines;                /* Array of pointers to the lines */
 118         __LINE  *lspace;                /* line space (for cleanup) */
 119         __LDATA *wspace;                /* window space (for cleanup) */
 120
 121 #define __ENDLINE       0x00000001      /* End of screen. */
 122 #define __FLUSH         0x00000002      /* Fflush(stdout) after refresh. */
 123 #define __FULLWIN       0x00000004      /* Window is a screen. */
 124 #define __IDLINE        0x00000008      /* Insert/delete sequences. */
 125 #define __SCROLLWIN     0x00000010      /* Last char will scroll window. */
 126 #define __SCROLLOK      0x00000020      /* Scrolling ok. */
 127 #define __CLEAROK       0x00000040      /* Clear on next refresh. */
 128 #define __LEAVEOK       0x00000100      /* If cursor left */
 129 #define __KEYPAD        0x00010000      /* If interpreting keypad codes */
 130 #define __NOTIMEOUT     0x00020000      /* Wait indefinitely for func keys */
 131 #define __IDCHAR        0x00040000      /* insert/delete char sequences */
 132 #define __ISPAD         0x00080000      /* "window" is a pad */
 133         unsigned int flags;
 134         int     delay;                  /* delay for getch() */
 135         attr_t  wattr;                  /* Character attributes */
 136         wchar_t bch;                    /* Background character */
 137         attr_t  battr;                  /* Background attributes */
 138         int     scr_t, scr_b;           /* Scrolling region top, bottom */
 139         SCREEN  *screen;                /* Screen for this window */
 140         int     pbegy, pbegx,
 141                 sbegy, sbegx,
 142                 smaxy, smaxx;           /* Saved prefresh() values */
 143 #ifdef HAVE_WCHAR
 144         nschar_t *bnsp;                 /* Background non-spacing char list */
 145 #endif /* HAVE_WCHAR */
 146 };
 147
 148 /* Set of attributes unset by 'me' - 'mb', 'md', 'mh', 'mk', 'mp' and 'mr'. */
 149 #ifndef HAVE_WCHAR
 150 #define __TERMATTR \
 151         (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT)
 152 #else
 153 #define __TERMATTR \
 154         (__REVERSE | __BLINK | __DIM | __BOLD | __BLANK | __PROTECT \
 155         | WA_TOP | WA_LOW | WA_LEFT | WA_RIGHT | WA_HORIZONTAL | WA_VERTICAL)
 156 #endif /* HAVE_WCHAR */
 157
 158 struct __winlist {
 159         struct __window         *winp;  /* The window. */
 160         struct __winlist        *nextp; /* Next window. */
 161 };
 162
 163 struct __color {
 164         short   num;
 165         short   red;
 166         short   green;
 167         short   blue;
 168         int     flags;
 169 };
 170
 171 /* List of colour pairs */
 172 struct __pair {
 173         short   fore;
 174         short   back;
 175         int     flags;
 176 };
 177
 178 /* Maximum colours */
 179 #define MAX_COLORS      64
 180 /* Maximum colour pairs - determined by number of colour bits in attr_t */
 181 #define MAX_PAIRS       PAIR_NUMBER(__COLOR)
 182
 183 typedef struct keymap keymap_t;
 184
 185 /* this is the encapsulation of the terminal definition, one for
 186  * each terminal that curses talks to.
 187  */
 188 struct __screen {
 189         FILE    *infd, *outfd;  /* input and output file descriptors */
 190         WINDOW  *curscr;        /* Current screen. */
 191         WINDOW  *stdscr;        /* Standard screen. */
 192         WINDOW  *__virtscr;     /* Virtual screen (for doupdate()). */
 193         int      curwin;        /* current window for refresh */
 194         int      lx, ly;        /* loop parameters for refresh */
 195         int      COLS;          /* Columns on the screen. */
 196         int      LINES;         /* Lines on the screen. */
 197         int      TABSIZE;       /* Size of a tab. */
 198         int      COLORS;        /* Maximum colors on the screen */
 199         int      COLOR_PAIRS;   /* Maximum color pairs on the screen */
 200         int      My_term;       /* Use Def_term regardless. */
 201         char     GT;            /* Gtty indicates tabs. */
 202         char     NONL;          /* Term can't hack LF doing a CR. */
 203         char     UPPERCASE;     /* Terminal is uppercase only. */
 204
 205         chtype acs_char[NUM_ACS];
 206 #ifdef HAVE_WCHAR
 207         cchar_t wacs_char[ NUM_ACS ];
 208 #endif /* HAVE_WCHAR */
 209         struct __color colours[MAX_COLORS];
 210         struct __pair  colour_pairs[MAX_PAIRS];
 211         attr_t  nca;
 212
 213 /* Style of colour manipulation */
 214 #define COLOR_NONE      0
 215 #define COLOR_ANSI      1       /* ANSI/DEC-style colour manipulation */
 216 #define COLOR_HP        2       /* HP-style colour manipulation */
 217 #define COLOR_TEK       3       /* Tektronix-style colour manipulation */
 218 #define COLOR_OTHER     4       /* None of the others but can set fore/back */
 219         int color_type;
 220
 221         attr_t mask_op;
 222         attr_t mask_me;
 223         attr_t mask_ue;
 224         attr_t mask_se;
 225         TERMINAL *term;
 226         int old_mode; /* old cursor visibility state for terminal */
 227         keymap_t *base_keymap;
 228         int echoit;
 229         int pfast;
 230         int rawmode;
 231         int nl;
 232         int noqch;
 233         int clearok;
 234         int useraw;
 235         struct __winlist *winlistp;
 236         struct   termios cbreakt, rawt, *curt, save_termios;
 237         struct termios orig_termios, baset, savedtty;
 238         int ovmin;
 239         int ovtime;
 240         char *stdbuf;
 241         unsigned int len;
 242         int meta_state;
 243         char padchar;
 244         int endwin;
 245         int notty;
 246         int half_delay;
 247         int resized;
 248         wchar_t *unget_list;
 249         int unget_len, unget_pos;
 250 #ifdef HAVE_WCHAR
 251 #define MB_LEN_MAX 8
 252 #define MAX_CBUF_SIZE MB_LEN_MAX
 253         int             cbuf_head;              /* header to cbuf */
 254         int             cbuf_tail;              /* tail to cbuf */
 255         int             cbuf_cur;               /* the current char in cbuf */
 256         mbstate_t       sp;                     /* wide char processing state */
 257         char            cbuf[ MAX_CBUF_SIZE ];  /* input character buffer */
 258 #endif /* HAVE_WCHAR */
 259 };
 260
 261
 262 extern char      __GT;                  /* Gtty indicates tabs. */
 263 extern char      __NONL;                /* Term can't hack LF doing a CR. */
 264 extern char      __UPPERCASE;           /* Terminal is uppercase only. */
 265 extern int       My_term;               /* Use Def_term regardless. */
 266 extern const char       *Def_term;      /* Default terminal type. */
 267 extern SCREEN   *_cursesi_screen;       /* The current screen in use */
 268
 269 /* Debugging options/functions. */
 270 #ifdef DEBUG
 271 #define __CTRACE_TSTAMP         0x00000001
 272 #define __CTRACE_MISC           0x00000002
 273 #define __CTRACE_INIT           0x00000004
 274 #define __CTRACE_SCREEN         0x00000008
 275 #define __CTRACE_WINDOW         0x00000010
 276 #define __CTRACE_REFRESH        0x00000020
 277 #define __CTRACE_COLOR          0x00000040
 278 #define __CTRACE_INPUT          0x00000080
 279 #define __CTRACE_OUTPUT         0x00000100
 280 #define __CTRACE_LINE           0x00000200
 281 #define __CTRACE_ATTR           0x00000400
 282 #define __CTRACE_ERASE          0x00000800
 283 #define __CTRACE_FILEIO         0x00001000
 284 #define __CTRACE_ALL            0x7fffffff
 285 void     __CTRACE_init(void);
 286 void     __CTRACE(int, const char *, ...) __attribute__((__format__(__printf__, 2, 3)));
 287 #endif
 288
 289 /* Private functions. */
 290 int     __cputchar_args(int, void *);
 291 void     _cursesi_free_keymap(keymap_t *);
 292 int      _cursesi_gettmode(SCREEN *);
 293 void     _cursesi_reset_acs(SCREEN *);
 294 int     _cursesi_addbyte(WINDOW *, __LINE **, int *, int *, int , attr_t, int);
 295 int     _cursesi_addwchar(WINDOW *, __LINE **, int *, int *, const cchar_t *,
 296                           int);
 297 int     _cursesi_waddbytes(WINDOW *, const char *, int, attr_t, int);
 298 #ifdef HAVE_WCHAR
 299 void     _cursesi_reset_wacs(SCREEN *);
 300 #endif /* HAVE_WCHAR */
 301 void     _cursesi_resetterm(SCREEN *);
 302 int      _cursesi_setterm(char *, SCREEN *);
 303 int      __delay(void);
 304 u_int    __hash_more(const void *, size_t, u_int);
 305 #define __hash(s, len)  __hash_more((s), (len), 0u)
 306 void     __id_subwins(WINDOW *);
 307 void     __init_getch(SCREEN *);
 308 void     __init_acs(SCREEN *);
 309 #ifdef HAVE_WCHAR
 310 void     __init_get_wch(SCREEN *);
 311 void     __init_wacs(SCREEN *);
 312 int     __cputwchar_args( wchar_t, void * );
 313 int     _cursesi_copy_nsp(nschar_t *, struct __ldata *);
 314 void    __cursesi_free_nsp(nschar_t *);
 315 void    __cursesi_win_free_nsp(WINDOW *);
 316 void    __cursesi_putnsp(nschar_t *, const int, const int);
 317 void    __cursesi_chtype_to_cchar(chtype, cchar_t *);
 318 #endif /* HAVE_WCHAR */
 319 int      __unget(wint_t);
 320 int      __mvcur(int, int, int, int, int);
 321 WINDOW  *__newwin(SCREEN *, int, int, int, int, int);
 322 int      __nodelay(void);
 323 int      __notimeout(void);
 324 void     __restartwin(void);
 325 void     __restore_colors(void);
 326 void     __restore_cursor_vis(void);
 327 void     __restore_meta_state(void);
 328 void     __restore_termios(void);
 329 void     __restore_stophandler(void);
 330 void     __restore_winchhandler(void);
 331 void     __save_termios(void);
 332 void     __set_color(WINDOW *win, attr_t attr);
 333 void     __set_stophandler(void);
 334 void     __set_winchhandler(void);
 335 void     __set_subwin(WINDOW *, WINDOW *);
 336 void     __startwin(SCREEN *);
 337 void     __stop_signal_handler(int);
 338 int      __stopwin(void);
 339 void     __swflags(WINDOW *);
 340 int      __timeout(int);
 341 int      __touchline(WINDOW *, int, int, int);
 342 int      __touchwin(WINDOW *);
 343 void     __unsetattr(int);
 344 void     __unset_color(WINDOW *win);
 345 int      __waddch(WINDOW *, __LDATA *);
 346 int      __wgetnstr(WINDOW *, char *, int);
 347 void     __winch_signal_handler(int);
 348
 349 /* Private #defines. */
 350 #define min(a,b)        ((a) < (b) ? (a) : (b))
 351 #define max(a,b)        ((a) > (b) ? (a ): (b))
 352
 353 /* Private externs. */
 354 extern int               __echoit;
 355 extern int               __endwin;
 356 extern int               __pfast;
 357 extern int               __rawmode;
 358 extern int               __noqch;
 359 extern attr_t            __mask_op, __mask_me, __mask_ue, __mask_se;
 360 extern WINDOW           *__virtscr;
 361 extern int               __using_color;
 362 extern attr_t            __default_color;