6252973b27f43d756d0be0ac1da69bef3450a72f
[ncurses.git] / ncurses / curses.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35
36 /*
37  * $Id: curses.priv.h,v 1.338 2007/09/01 21:35:50 tom Exp $
38  *
39  *      curses.priv.h
40  *
41  *      Header file for curses library objects which are private to
42  *      the library.
43  *
44  */
45
46 #ifndef CURSES_PRIV_H
47 #define CURSES_PRIV_H 1
48
49 #include <ncurses_dll.h>
50
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54
55 #include <ncurses_cfg.h>
56
57 #if USE_RCS_IDS
58 #define MODULE_ID(id) static const char Ident[] = id;
59 #else
60 #define MODULE_ID(id) /*nothing*/
61 #endif
62
63 #include <stdlib.h>
64 #include <string.h>
65 #include <sys/types.h>
66
67 #if HAVE_UNISTD_H
68 #include <unistd.h>
69 #endif
70
71 #if HAVE_SYS_BSDTYPES_H
72 #include <sys/bsdtypes.h>       /* needed for ISC */
73 #endif
74
75 #if HAVE_LIMITS_H
76 # include <limits.h>
77 #elif HAVE_SYS_PARAM_H
78 # include <sys/param.h>
79 #endif
80
81 #include <assert.h>
82 #include <stdio.h>
83
84 #include <errno.h>
85
86 #ifndef PATH_MAX
87 # if defined(_POSIX_PATH_MAX)
88 #  define PATH_MAX _POSIX_PATH_MAX
89 # elif defined(MAXPATHLEN)
90 #  define PATH_MAX MAXPATHLEN
91 # else
92 #  define PATH_MAX 255  /* the Posix minimum path-size */
93 # endif
94 #endif
95
96 #if DECL_ERRNO
97 extern int errno;
98 #endif
99
100 #include <nc_panel.h>
101
102 /* Some systems have a broken 'select()', but workable 'poll()'.  Use that */
103 #if HAVE_WORKING_POLL
104 #define USE_FUNC_POLL 1
105 #if HAVE_POLL_H
106 #include <poll.h>
107 #else
108 #include <sys/poll.h>
109 #endif
110 #else
111 #define USE_FUNC_POLL 0
112 #endif
113
114 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
115 #include <signal.h>
116
117 /* Alessandro Rubini's GPM (general-purpose mouse) */
118 #if HAVE_LIBGPM && HAVE_GPM_H
119 #define USE_GPM_SUPPORT 1
120 #else
121 #define USE_GPM_SUPPORT 0
122 #endif
123
124 /* QNX mouse support */
125 #if defined(__QNX__) && !defined(__QNXNTO__)
126 #define USE_QNX_MOUSE 1
127 #else
128 #define USE_QNX_MOUSE 0
129 #endif
130
131 /* EMX mouse support */
132 #ifdef __EMX__
133 #define USE_EMX_MOUSE 1
134 #else
135 #define USE_EMX_MOUSE 0
136 #endif
137
138 #define DEFAULT_MAXCLICK 166
139 #define EV_MAX          8       /* size of mouse circular event queue */
140
141 /*
142  * If we don't have signals to support it, don't add a sigwinch handler.
143  * In any case, resizing is an extended feature.  Use it if we've got it.
144  */
145 #if !NCURSES_EXT_FUNCS
146 #undef HAVE_SIZECHANGE
147 #define HAVE_SIZECHANGE 0
148 #endif
149
150 #if HAVE_SIZECHANGE && defined(SIGWINCH)
151 #define USE_SIZECHANGE 1
152 #else
153 #define USE_SIZECHANGE 0
154 #undef USE_SIGWINCH
155 #define USE_SIGWINCH 0
156 #endif
157
158 /*
159  * If desired, one can configure this, disabling environment variables that
160  * point to custom terminfo/termcap locations.
161  */
162 #ifdef USE_ROOT_ENVIRON
163 #define use_terminfo_vars() 1
164 #else
165 #define use_terminfo_vars() _nc_env_access()
166 extern NCURSES_EXPORT(int) _nc_env_access (void);
167 #endif
168
169 /*
170  * Not all platforms have memmove; some have an equivalent bcopy.  (Some may
171  * have neither).
172  */
173 #if USE_OK_BCOPY
174 #define memmove(d,s,n) bcopy(s,d,n)
175 #elif USE_MY_MEMMOVE
176 #define memmove(d,s,n) _nc_memmove(d,s,n)
177 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
178 #endif
179
180 /*
181  * Scroll hints are useless when hashmap is used
182  */
183 #if !USE_SCROLL_HINTS
184 #if !USE_HASHMAP
185 #define USE_SCROLL_HINTS 1
186 #else
187 #define USE_SCROLL_HINTS 0
188 #endif
189 #endif
190
191 #if USE_SCROLL_HINTS
192 #define if_USE_SCROLL_HINTS(stmt) stmt
193 #else
194 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
195 #endif
196
197 /*
198  * Note:  ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
199  * when we're throwing control codes at the screen at high volume.  To see
200  * this, re-enable USE_HARD_TABS and run worm for a while.  Other systems
201  * probably don't want to define this either due to uncertainties about tab
202  * delays and expansion in raw mode.
203  */
204
205 #define TRIES struct tries
206 typedef TRIES {
207         TRIES    *child;            /* ptr to child.  NULL if none          */
208         TRIES    *sibling;          /* ptr to sibling.  NULL if none        */
209         unsigned char    ch;        /* character at this node               */
210         unsigned short   value;     /* code of string so far.  0 if none.   */
211 #undef TRIES
212 } TRIES;
213
214 /*
215  * Common/troublesome character definitions
216  */
217 #define StringOf(ch) {ch, 0}
218
219 #define L_BRACE '{'
220 #define R_BRACE '}'
221 #define S_QUOTE '\''
222 #define D_QUOTE '"'
223
224 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
225
226 /*
227  * Structure for palette tables
228  */
229
230 typedef struct
231 {
232     short red, green, blue;     /* what color_content() returns */
233     short r, g, b;              /* params to init_color() */
234     int init;                   /* true if we called init_color() */
235 }
236 color_t;
237
238 #define MAXCOLUMNS    135
239 #define MAXLINES      66
240 #define FIFO_SIZE     MAXCOLUMNS+2  /* for nocbreak mode input */
241
242 #define ACS_LEN       128
243
244 #define WINDOWLIST struct _win_list
245
246 #if USE_WIDEC_SUPPORT
247 #define _nc_bkgd    _bkgrnd
248 #else
249 #undef _XOPEN_SOURCE_EXTENDED
250 #define _nc_bkgd    _bkgd
251 #define wgetbkgrnd(win, wch)    *wch = win->_bkgd
252 #define wbkgrnd     wbkgd
253 #endif
254
255 #undef NCURSES_OPAQUE
256 #define NCURSES_INTERNALS 1
257 #define NCURSES_OPAQUE 0
258
259 #include <curses.h>     /* we'll use -Ipath directive to get the right one! */
260 #include <term.h>
261 #include <term_entry.h>
262 #include <nc_tparm.h>
263
264 #if NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT
265 #define if_EXT_COLORS(stmt)     stmt
266 #define NetPair(value,p)        (value).ext_color = (p), \
267                                 AttrOf(value) &= ALL_BUT_COLOR, \
268                                 AttrOf(value) |= (A_COLOR & COLOR_PAIR((p > 255) ? 255 : p))
269 #define SetPair(value,p)        (value).ext_color = (p)
270 #define GetPair(value)          (value).ext_color
271 #define unColor(n)              (AttrOf(n) & ALL_BUT_COLOR)
272 #define GET_WINDOW_PAIR(w)      (w)->_color
273 #define SET_WINDOW_PAIR(w,p)    (w)->_color = (p)
274 #define SameAttrOf(a,b)         (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
275 #define VIDATTR(attr, pair)     vid_attr(attr, pair, 0)
276 #else
277 #define if_EXT_COLORS(stmt)     /* nothing */
278 #define SetPair(value,p)        RemAttr(value, A_COLOR), \
279                                 SetAttr(value, AttrOf(value) | (A_COLOR & COLOR_PAIR(p)))
280 #define GetPair(value)          PAIR_NUMBER(AttrOf(value))
281 #define unColor(n)              (AttrOf(n) & ALL_BUT_COLOR)
282 #define GET_WINDOW_PAIR(w)      PAIR_NUMBER(WINDOW_ATTRS(w))
283 #define SET_WINDOW_PAIR(w,p)    WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
284                                 WINDOW_ATTRS(w) |= (A_COLOR & COLOR_PAIR(p))
285 #define SameAttrOf(a,b)         (AttrOf(a) == AttrOf(b))
286 #define VIDATTR(attr, pair)     vidattr(attr)
287 #endif
288
289 #define WINDOW_ATTRS(w)         ((w)->_attrs)
290
291 #define SCREEN_ATTRS(s)         (*((s)->_current_attr))
292 #define GET_SCREEN_PAIR(s)      GetPair(SCREEN_ATTRS(s))
293 #define SET_SCREEN_PAIR(s,p)    SetPair(SCREEN_ATTRS(s), p)
294
295 #if USE_REENTRANT
296 #define SET_LINES(value) SP->_LINES = value
297 #define SET_COLS(value)  SP->_COLS = value
298 #else
299 #define SET_LINES(value) LINES = value
300 #define SET_COLS(value)  COLS = value
301 #endif
302
303 #ifdef USE_PTHREADS
304 #if USE_REENTRANT
305 #include <pthread.h>
306 #define _nc_lock_mutex(name)    pthread_mutex_lock(&_nc_globals.mutex_##name)
307 #define _nc_unlock_mutex(name)  pthread_mutex_unlock(&_nc_globals.mutex_##name)
308 #else
309 #error POSIX threads requires --enable-reentrant option
310 #endif
311 #else
312 #define _nc_lock_mutex(name)    /* nothing */
313 #define _nc_unlock_mutex(name)  /* nothing */
314 #endif
315
316 /*
317  * Definitions for color pairs
318  */
319 typedef unsigned colorpair_t;   /* type big enough to store PAIR_OF() */
320 #define C_SHIFT 9               /* we need more bits than there are colors */
321 #define C_MASK                  ((1 << C_SHIFT) - 1)
322 #define PAIR_OF(fg, bg)         ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
323 #define isDefaultColor(c)       ((c) >= COLOR_DEFAULT || (c) < 0)
324
325 #define COLOR_DEFAULT           C_MASK
326
327 #if defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T)
328
329 #undef NCURSES_CH_T             /* this is not a termlib feature */
330 #define NCURSES_CH_T void       /* ...but we need a pointer in SCREEN */
331
332 #endif  /* USE_TERMLIB */
333
334 #ifndef USE_TERMLIB
335 struct ldat
336 {
337         NCURSES_CH_T    *text;          /* text of the line */
338         NCURSES_SIZE_T  firstchar;      /* first changed character in the line */
339         NCURSES_SIZE_T  lastchar;       /* last changed character in the line */
340         NCURSES_SIZE_T  oldindex;       /* index of the line at last update */
341 };
342 #endif  /* USE_TERMLIB */
343
344 typedef enum {
345         M_XTERM = -1            /* use xterm's mouse tracking? */
346         ,M_NONE = 0             /* no mouse device */
347 #if USE_GPM_SUPPORT
348         ,M_GPM                  /* use GPM */
349 #endif
350 #if USE_SYSMOUSE
351         ,M_SYSMOUSE             /* FreeBSD sysmouse on console */
352 #endif
353 } MouseType;
354
355 /*
356  * Structures for scrolling.
357  */
358
359 typedef struct {
360         unsigned long hashval;
361         int oldcount, newcount;
362         int oldindex, newindex;
363 } HASHMAP;
364
365 /*
366  * Structures for soft labels.
367  */
368
369 struct _SLK;
370
371 #ifndef USE_TERMLIB
372
373 typedef struct
374 {
375         char *ent_text;         /* text for the label */
376         char *form_text;        /* formatted text (left/center/...) */
377         int ent_x;              /* x coordinate of this field */
378         char dirty;             /* this label has changed */
379         char visible;           /* field is visible */
380 } slk_ent;
381
382 typedef struct _SLK {
383         char dirty;             /* all labels have changed */
384         char hidden;            /* soft labels are hidden */
385         WINDOW *win;
386         slk_ent *ent;
387         short  maxlab;          /* number of available labels */
388         short  labcnt;          /* number of allocated labels */
389         short  maxlen;          /* length of labels */
390         NCURSES_CH_T attr;      /* soft label attribute */
391 } SLK;
392
393 #endif  /* USE_TERMLIB */
394
395 typedef struct {
396         int     line;           /* lines to take, < 0 => from bottom*/
397         int     (*hook)(WINDOW *, int); /* callback for user        */
398 } ripoff_t;
399
400 #if USE_GPM_SUPPORT
401 #undef buttons                  /* term.h defines this, and gpm uses it! */
402 #include <gpm.h>
403
404 #ifdef HAVE_LIBDL
405 /* link dynamically to GPM */
406 typedef int *TYPE_gpm_fd;
407 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
408 typedef int (*TYPE_Gpm_Close) (void);
409 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
410
411 #define my_gpm_fd       SP->_mouse_gpm_fd
412 #define my_Gpm_Open     SP->_mouse_Gpm_Open
413 #define my_Gpm_Close    SP->_mouse_Gpm_Close
414 #define my_Gpm_GetEvent SP->_mouse_Gpm_GetEvent
415 #else
416 /* link statically to GPM */
417 #define my_gpm_fd       &gpm_fd
418 #define my_Gpm_Open     Gpm_Open
419 #define my_Gpm_Close    Gpm_Close
420 #define my_Gpm_GetEvent Gpm_GetEvent
421 #endif /* HAVE_LIBDL */
422 #endif /* USE_GPM_SUPPORT */
423
424 typedef struct {
425     long sequence;
426     bool last_used;
427     char *fix_sgr0;             /* this holds the filtered sgr0 string */
428     char *last_bufp;            /* help with fix_sgr0 leak */
429     TERMINAL *last_term;
430 } TGETENT_CACHE;
431
432 #define TGETENT_MAX 4
433
434 /*
435  * State of tparm().
436  */
437 #define STACKSIZE 20
438
439 typedef struct {
440         union {
441                 int     num;
442                 char    *str;
443         } data;
444         bool num_type;
445 } STACK_FRAME;
446
447 #define NUM_VARS 26
448
449 typedef struct {
450 #ifdef TRACE
451         const char      *tname;
452 #endif
453         const char      *tparam_base;
454
455         STACK_FRAME     stack[STACKSIZE];
456         int             stack_ptr;
457
458         char            *out_buff;
459         size_t          out_size;
460         size_t          out_used;
461
462         char            *fmt_buff;
463         size_t          fmt_size;
464
465         int             dynamic_var[NUM_VARS];
466         int             static_vars[NUM_VARS];
467 } TPARM_STATE;
468
469 typedef struct {
470     char *text;
471     size_t size;
472 } TRACEBUF;
473
474 /*
475  * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
476  * could at most have 10 digits, and the mask contains no more than 32 bits
477  * with each bit representing less than 15 characters.  Usually the whole
478  * string is less than 80 columns, but this buffer size is an absolute
479  * limit.
480  */
481 #define TRACEMSE_MAX    (80 + (5 * 10) + (32 * 15))
482 #define TRACEMSE_FMT    "id %2d  at (%2d, %2d, %2d) state %4lx = {" /* } */
483
484 /*
485  * Global data which is not specific to a screen.
486  */
487 typedef struct {
488         SIG_ATOMIC_T    have_sigwinch;
489         SIG_ATOMIC_T    cleanup_nested;
490
491         bool            init_signals;
492         bool            init_screen;
493
494         const char      *comp_sourcename;
495         char            *comp_termtype;
496
497         bool            have_tic_directory;
498         bool            keep_tic_directory;
499         const char      *tic_directory;
500
501         char            *dbi_list;
502         int             dbi_size;
503
504         char            *first_name;
505         char            **keyname_table;
506
507         char            *safeprint_buf;
508         size_t          safeprint_used;
509
510         TGETENT_CACHE   tgetent_cache[TGETENT_MAX];
511         int             tgetent_index;
512         long            tgetent_sequence;
513
514 #if USE_HOME_TERMINFO
515         char            *home_terminfo;
516 #endif
517
518 #if !USE_SAFE_SPRINTF
519         int             safeprint_cols;
520         int             safeprint_rows;
521 #endif
522
523 #ifdef TRACE
524         bool            init_trace;
525         char            trace_fname[PATH_MAX];
526         int             trace_level;
527         FILE            *trace_fp;
528
529         char            *tracearg_buf;
530         size_t          tracearg_used;
531
532         TRACEBUF        *tracebuf_ptr;
533         size_t          tracebuf_used;
534
535         char            tracechr_buf[40];
536
537         char            *tracedmp_buf;
538         size_t          tracedmp_used;
539
540         char            tracemse_buf[TRACEMSE_MAX];
541
542         unsigned char   *tracetry_buf;
543         size_t          tracetry_used;
544
545 #ifndef USE_TERMLIB
546         char            traceatr_color_buf[2][80];
547         int             traceatr_color_sel;
548         int             traceatr_color_last;
549 #endif  /* USE_TERMLIB */
550
551 #endif  /* TRACE */
552
553 #ifdef USE_PTHREADS
554        pthread_mutex_t  mutex_set_SP;
555 #endif
556 } NCURSES_GLOBALS;
557
558 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
559
560 #define N_RIPS 5
561
562 /*
563  * Global data which is swept up into a SCREEN when one is created.
564  * It may be modified before the next SCREEN is created.
565  */
566 typedef struct {
567         bool            use_env;
568         bool            filter_mode;
569         attr_t          previous_attr;
570         ripoff_t        rippedoff[N_RIPS];
571         ripoff_t        *rsp;
572         TPARM_STATE     tparm_state;
573         TTY             *saved_tty;     /* savetty/resetty information      */
574 #if BROKEN_LINKER || USE_REENTRANT
575         chtype          *real_acs_map;
576         int             _LINES;
577         int             _COLS;
578 #endif
579 } NCURSES_PRESCREEN;
580
581 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
582
583 /*
584  * The SCREEN structure.
585  */
586
587 struct screen {
588         int             _ifd;           /* input file ptr for screen        */
589         FILE            *_ofp;          /* output file ptr for screen       */
590         char            *_setbuf;       /* buffered I/O for output          */
591         bool            _filtered;      /* filter() was called              */
592         bool            _buffered;      /* setvbuf uses _setbuf data        */
593         int             _checkfd;       /* filedesc for typeahead check     */
594         TERMINAL        *_term;         /* terminal type information        */
595         TTY             _saved_tty;     /* savetty/resetty information      */
596         NCURSES_SIZE_T  _lines;         /* screen lines                     */
597         NCURSES_SIZE_T  _columns;       /* screen columns                   */
598
599         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
600         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
601
602         WINDOW          *_curscr;       /* current screen                   */
603         WINDOW          *_newscr;       /* virtual screen to be updated to  */
604         WINDOW          *_stdscr;       /* screen's full-window context     */
605
606         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
607         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
608         bool            _tried;         /* keypad mode was initialized      */
609         bool            _keypad_on;     /* keypad mode is currently on      */
610
611         bool            _called_wgetch; /* check for recursion in wgetch()  */
612         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
613         short           _fifohead,      /* head of fifo queue               */
614                         _fifotail,      /* tail of fifo queue               */
615                         _fifopeek,      /* where to peek for next char      */
616                         _fifohold;      /* set if breakout marked           */
617
618         int             _endwin;        /* are we out of window mode?       */
619         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
620         int             _coloron;       /* is color enabled?                */
621         int             _color_defs;    /* are colors modified              */
622         int             _cursor;        /* visibility of the cursor         */
623         int             _cursrow;       /* physical cursor row              */
624         int             _curscol;       /* physical cursor column           */
625         bool            _notty;         /* true if we cannot switch non-tty */
626         int             _nl;            /* True if NL -> CR/NL is on        */
627         int             _raw;           /* True if in raw mode              */
628         int             _cbreak;        /* 1 if in cbreak mode              */
629                                         /* > 1 if in halfdelay mode         */
630         int             _echo;          /* True if echo on                  */
631         int             _use_meta;      /* use the meta key?                */
632         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
633         int             slk_format;     /* selected format for this screen  */
634         /* cursor movement costs; units are 10ths of milliseconds */
635 #if NCURSES_NO_PADDING
636         int             _no_padding;    /* flag to set if padding disabled  */
637 #endif
638         int             _char_padding;  /* cost of character put            */
639         int             _cr_cost;       /* cost of (carriage_return)        */
640         int             _cup_cost;      /* cost of (cursor_address)         */
641         int             _home_cost;     /* cost of (cursor_home)            */
642         int             _ll_cost;       /* cost of (cursor_to_ll)           */
643 #if USE_HARD_TABS
644         int             _ht_cost;       /* cost of (tab)                    */
645         int             _cbt_cost;      /* cost of (backtab)                */
646 #endif /* USE_HARD_TABS */
647         int             _cub1_cost;     /* cost of (cursor_left)            */
648         int             _cuf1_cost;     /* cost of (cursor_right)           */
649         int             _cud1_cost;     /* cost of (cursor_down)            */
650         int             _cuu1_cost;     /* cost of (cursor_up)              */
651         int             _cub_cost;      /* cost of (parm_cursor_left)       */
652         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
653         int             _cud_cost;      /* cost of (parm_cursor_down)       */
654         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
655         int             _hpa_cost;      /* cost of (column_address)         */
656         int             _vpa_cost;      /* cost of (row_address)            */
657         /* used in tty_update.c, must be chars */
658         int             _ed_cost;       /* cost of (clr_eos)                */
659         int             _el_cost;       /* cost of (clr_eol)                */
660         int             _el1_cost;      /* cost of (clr_bol)                */
661         int             _dch1_cost;     /* cost of (delete_character)       */
662         int             _ich1_cost;     /* cost of (insert_character)       */
663         int             _dch_cost;      /* cost of (parm_dch)               */
664         int             _ich_cost;      /* cost of (parm_ich)               */
665         int             _ech_cost;      /* cost of (erase_chars)            */
666         int             _rep_cost;      /* cost of (repeat_char)            */
667         int             _hpa_ch_cost;   /* cost of (column_address)         */
668         int             _cup_ch_cost;   /* cost of (cursor_address)         */
669         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
670         int             _inline_cost;   /* cost of inline-move              */
671         int             _smir_cost;     /* cost of (enter_insert_mode)      */
672         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
673         int             _ip_cost;       /* cost of (insert_padding)         */
674         /* used in lib_mvcur.c */
675         char *          _address_cursor;
676         /* used in tty_update.c */
677         int             _scrolling;     /* 1 if terminal's smart enough to  */
678
679         /* used in lib_color.c */
680         color_t         *_color_table;  /* screen's color palette            */
681         int             _color_count;   /* count of colors in palette        */
682         colorpair_t     *_color_pairs;  /* screen's color pair list          */
683         int             _pair_count;    /* count of color pairs              */
684 #if NCURSES_EXT_FUNCS
685         bool            _default_color; /* use default colors                */
686         bool            _has_sgr_39_49; /* has ECMA default color support    */
687         int             _default_fg;    /* assumed default foreground        */
688         int             _default_bg;    /* assumed default background        */
689 #endif
690         chtype          _ok_attributes; /* valid attributes for terminal     */
691         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
692         chtype          _xmc_triggers;  /* attributes to process if xmc      */
693         chtype *        _acs_map;       /* the real alternate-charset map    */
694         bool *          _screen_acs_map;
695
696
697         /* used in lib_vidattr.c */
698         bool            _use_rmso;      /* true if we may use 'rmso'         */
699         bool            _use_rmul;      /* true if we may use 'rmul'         */
700
701         /*
702          * These data correspond to the state of the idcok() and idlok()
703          * functions.  A caveat is in order here:  the XSI and SVr4
704          * documentation specify that these functions apply to the window which
705          * is given as an argument.  However, ncurses implements this logic
706          * only for the newscr/curscr update process, _not_ per-window.
707          */
708         bool            _nc_sp_idlok;
709         bool            _nc_sp_idcok;
710 #define _nc_idlok SP->_nc_sp_idlok
711 #define _nc_idcok SP->_nc_sp_idcok
712
713         /*
714          * These are the data that support the mouse interface.
715          */
716         bool            _mouse_initialized;
717         MouseType       _mouse_type;
718         int             _maxclick;
719         bool            (*_mouse_event) (SCREEN *);
720         bool            (*_mouse_inline)(SCREEN *);
721         bool            (*_mouse_parse) (int);
722         void            (*_mouse_resume)(SCREEN *);
723         void            (*_mouse_wrap)  (SCREEN *);
724         int             _mouse_fd;      /* file-descriptor, if any */
725         bool            _mouse_active;  /* true if initialized */
726         mmask_t         _mouse_mask;
727         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
728         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
729         MEVENT          *_mouse_eventp; /* next free slot in event queue */
730
731 #if USE_GPM_SUPPORT
732         bool            _mouse_gpm_loaded;
733         bool            _mouse_gpm_found;
734 #ifdef HAVE_LIBDL
735         TYPE_gpm_fd     _mouse_gpm_fd;
736         TYPE_Gpm_Open   _mouse_Gpm_Open;
737         TYPE_Gpm_Close  _mouse_Gpm_Close;
738         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
739 #endif
740         Gpm_Connect     _mouse_gpm_connect;
741 #endif /* USE_GPM_SUPPORT */
742
743 #if USE_EMX_MOUSE
744         int             _emxmouse_wfd;
745         int             _emxmouse_thread;
746         int             _emxmouse_activated;
747         char            _emxmouse_buttons[4];
748 #endif
749
750 #if USE_SYSMOUSE
751         MEVENT          _sysmouse_fifo[FIFO_SIZE];
752         int             _sysmouse_head;
753         int             _sysmouse_tail;
754         int             _sysmouse_char_width;   /* character width */
755         int             _sysmouse_char_height;  /* character height */
756         int             _sysmouse_old_buttons;
757         int             _sysmouse_new_buttons;
758 #endif
759
760         /*
761          * This supports automatic resizing
762          */
763 #if USE_SIZECHANGE
764         int             (*_resize)(int,int);
765 #endif
766
767         /*
768          * These are data that support the proper handling of the panel stack on an
769          * per screen basis.
770          */
771         struct panelhook _panelHook;
772         /*
773          * Linked-list of all windows, to support '_nc_resizeall()' and
774          * '_nc_freeall()'
775          */
776         WINDOWLIST      *_nc_sp_windows;
777 #define _nc_windows SP->_nc_sp_windows
778
779         bool            _sig_winch;
780         SCREEN          *_next_screen;
781
782         /* hashes for old and new lines */
783         unsigned long   *oldhash, *newhash;
784         HASHMAP         *hashtab;
785         int             hashtab_len;
786         int             *_oldnum_list;
787         int             _oldnum_size;
788
789         bool            _cleanup;       /* cleanup after int/quit signal */
790         int             (*_outch)(int); /* output handler if not putc */
791
792         int             _legacy_coding; /* see use_legacy_coding() */
793
794 #if USE_REENTRANT
795         char            _ttytype[NAMESIZE];
796         int             _ESCDELAY;
797         int             _TABSIZE;
798         int             _LINES;
799         int             _COLS;
800 #endif
801         /*
802          * ncurses/ncursesw are the same up to this point.
803          */
804 #if USE_WIDEC_SUPPORT
805         /* recent versions of 'screen' have partially-working support for
806          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
807          */
808         bool            _screen_acs_fix;
809 #endif
810 };
811
812 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
813 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
814
815         WINDOWLIST {
816         WINDOW  win;    /* first, so WINDOW_EXT() works */
817         WINDOWLIST *next;
818 #ifdef _XOPEN_SOURCE_EXTENDED
819         char addch_work[(MB_LEN_MAX * 9) + 1];
820         unsigned addch_used;    /* number of bytes in addch_work[] */
821         int addch_x;            /* x-position for addch_work[] */
822         int addch_y;            /* y-position for addch_work[] */
823 #endif
824 };
825
826 #define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)
827
828 /* usually in <limits.h> */
829 #ifndef UCHAR_MAX
830 #define UCHAR_MAX 255
831 #endif
832
833 /* The terminfo source is assumed to be 7-bit ASCII */
834 #define is7bits(c)      ((unsigned)(c) < 128)
835
836 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
837 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
838
839 #ifndef min
840 #define min(a,b)        ((a) > (b)  ?  (b)  :  (a))
841 #endif
842
843 #ifndef max
844 #define max(a,b)        ((a) < (b)  ?  (b)  :  (a))
845 #endif
846
847 /* usually in <unistd.h> */
848 #ifndef STDIN_FILENO
849 #define STDIN_FILENO 0
850 #endif
851
852 #ifndef STDOUT_FILENO
853 #define STDOUT_FILENO 1
854 #endif
855
856 #ifndef STDERR_FILENO
857 #define STDERR_FILENO 2
858 #endif
859
860 #ifndef EXIT_SUCCESS
861 #define EXIT_SUCCESS 0
862 #endif
863
864 #ifndef EXIT_FAILURE
865 #define EXIT_FAILURE 1
866 #endif
867
868 #ifndef R_OK
869 #define R_OK    4               /* Test for read permission.  */
870 #endif
871 #ifndef W_OK
872 #define W_OK    2               /* Test for write permission.  */
873 #endif
874 #ifndef X_OK
875 #define X_OK    1               /* Test for execute permission.  */
876 #endif
877 #ifndef F_OK
878 #define F_OK    0               /* Test for existence.  */
879 #endif
880
881 #if HAVE_FCNTL_H
882 #include <fcntl.h>              /* may define O_BINARY  */
883 #endif
884
885 #ifndef O_BINARY
886 #define O_BINARY 0
887 #endif
888
889 #ifdef TRACE
890 #define TRACE_OUTCHARS(n) _nc_outchars += (n);
891 #else
892 #define TRACE_OUTCHARS(n) /* nothing */
893 #endif
894
895 #define UChar(c)        ((unsigned char)(c))
896 #define ChCharOf(c)     ((c) & (chtype)A_CHARTEXT)
897 #define ChAttrOf(c)     ((c) & (chtype)A_ATTRIBUTES)
898
899 #ifndef MB_LEN_MAX
900 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
901 #endif
902
903 #if USE_WIDEC_SUPPORT /* { */
904 #define isEILSEQ(status) ((status == (size_t)-1) && (errno == EILSEQ))
905
906 #define init_mb(state)  memset(&state, 0, sizeof(state))
907
908 #if NCURSES_EXT_COLORS
909 #define NulColor        , 0
910 #else
911 #define NulColor        /* nothing */
912 #endif
913
914 #define NulChar         0,0,0,0 /* FIXME: see CCHARW_MAX */
915 #define CharOf(c)       ((c).chars[0])
916 #define AttrOf(c)       ((c).attr)
917 #define AddAttr(c,a)    AttrOf(c) |=  ((a) & A_ATTRIBUTES)
918 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
919 #define SetAttr(c,a)    AttrOf(c) =   ((a) & A_ATTRIBUTES) | WidecExt(c)
920 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
921 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
922 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
923 #define SetChar(ch,c,a) do {                                                        \
924                             NCURSES_CH_T *_cp = &ch;                                \
925                             memset(_cp, 0, sizeof(ch));                             \
926                             _cp->chars[0] = (c);                                            \
927                             _cp->attr = (a);                                        \
928                             if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a)));             \
929                         } while (0)
930 #define CHREF(wch)      (&wch)
931 #define CHDEREF(wch)    (*wch)
932 #define ARG_CH_T        NCURSES_CH_T *
933 #define CARG_CH_T       const NCURSES_CH_T *
934 #define PUTC_DATA       char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
935                         mbstate_t PUT_st; wchar_t PUTC_ch
936 #define PUTC_INIT       init_mb (PUT_st)
937 #define PUTC(ch,b)      do { if(!isWidecExt(ch)) {                                  \
938                         if (Charable(ch)) {                                         \
939                             fputc(CharOf(ch), b);                                   \
940                             TRACE_OUTCHARS(1);                                      \
941                         } else {                                                    \
942                             PUTC_INIT;                                              \
943                             for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {       \
944                                 PUTC_ch = (ch).chars[PUTC_i];                       \
945                                 if (PUTC_ch == L'\0')                               \
946                                     break;                                          \
947                                 PUTC_n = wcrtomb(PUTC_buf,                          \
948                                                  (ch).chars[PUTC_i], &PUT_st);      \
949                                 if (PUTC_n <= 0) {                                  \
950                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
951                                         putc(PUTC_ch,b);                            \
952                                     break;                                          \
953                                 }                                                   \
954                                 fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b);          \
955                             }                                                       \
956                             TRACE_OUTCHARS(PUTC_i);                                 \
957                         } } } while (0)
958
959 #define BLANK           { WA_NORMAL, {' '} NulColor }
960 #define ZEROS           { WA_NORMAL, {'\0'} NulColor }
961 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
962
963         /*
964          * Wide characters cannot be represented in the A_CHARTEXT mask of
965          * attr_t's but an application might have set a narrow character there.
966          * But even in that case, it would only be a printable character, or
967          * zero.  Otherwise we can use those bits to tell if a cell is the
968          * first or extension part of a wide character.
969          */
970 #define WidecExt(ch)    (AttrOf(ch) & A_CHARTEXT)
971 #define isWidecBase(ch) (WidecExt(ch) == 1)
972 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
973 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
974                                 AttrOf(dst) |= (ext + 1)
975
976 #define if_WIDEC(code)  code
977 #define Charable(ch)    ((SP != 0 && SP->_legacy_coding)                \
978                          || (AttrOf(ch) & A_ALTCHARSET)                 \
979                          || (!isWidecExt(ch) &&                         \
980                              (ch).chars[1] == L'\0' &&                  \
981                              _nc_is_charable(CharOf(ch))))
982
983 #define L(ch)           L ## ch
984 #else /* }{ */
985 #define CharOf(c)       ChCharOf(c)
986 #define AttrOf(c)       ChAttrOf(c)
987 #define AddAttr(c,a)    c |= (a)
988 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
989 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
990 #define NewChar(ch)     (ch)
991 #define NewChar2(c,a)   ((c) | (a))
992 #define CharEq(a,b)     ((a) == (b))
993 #define SetChar(ch,c,a) ch = (c) | (a)
994 #define CHREF(wch)      wch
995 #define CHDEREF(wch)    wch
996 #define ARG_CH_T        NCURSES_CH_T
997 #define CARG_CH_T       NCURSES_CH_T
998 #define PUTC_DATA       int data = 0
999 #define PUTC(ch,b)      do { data = CharOf(ch); putc(data,b); } while (0)
1000
1001 #define BLANK           (' '|A_NORMAL)
1002 #define ZEROS           ('\0'|A_NORMAL)
1003 #define ISBLANK(ch)     (CharOf(ch) == ' ')
1004
1005 #define isWidecExt(ch)  (0)
1006 #define if_WIDEC(code) /* nothing */
1007
1008 #define L(ch)           ch
1009 #endif /* } */
1010
1011 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
1012 #define CharOfD(ch)     CharOf(CHDEREF(ch))
1013 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1014
1015 #define BLANK_ATTR      A_NORMAL
1016 #define BLANK_TEXT      L(' ')
1017
1018 #define CHANGED     -1
1019
1020 #define LEGALYX(w, y, x) \
1021               ((w) != 0 && \
1022                 ((x) >= 0 && (x) <= (w)->_maxx && \
1023                  (y) >= 0 && (y) <= (w)->_maxy))
1024
1025 #define CHANGED_CELL(line,col) \
1026         if (line->firstchar == _NOCHANGE) \
1027                 line->firstchar = line->lastchar = col; \
1028         else if ((col) < line->firstchar) \
1029                 line->firstchar = col; \
1030         else if ((col) > line->lastchar) \
1031                 line->lastchar = col
1032
1033 #define CHANGED_RANGE(line,start,end) \
1034         if (line->firstchar == _NOCHANGE \
1035          || line->firstchar > (start)) \
1036                 line->firstchar = start; \
1037         if (line->lastchar == _NOCHANGE \
1038          || line->lastchar < (end)) \
1039                 line->lastchar = end
1040
1041 #define CHANGED_TO_EOL(line,start,end) \
1042         if (line->firstchar == _NOCHANGE \
1043          || line->firstchar > (start)) \
1044                 line->firstchar = start; \
1045         line->lastchar = end
1046
1047 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1048
1049 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
1050
1051 /* FreeAndNull() is not a comma-separated expression because some compilers
1052  * do not accept a mixture of void with values.
1053  */
1054 #define FreeAndNull(p)   free(p); p = 0
1055
1056 #include <nc_alloc.h>
1057
1058 /*
1059  * TTY bit definition for converting tabs to spaces.
1060  */
1061 #ifdef TAB3
1062 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
1063 #else
1064 # ifdef XTABS
1065 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
1066 # else
1067 #  ifdef OXTABS
1068 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
1069 #  else
1070 #   define OFLAGS_TABS 0
1071 #  endif
1072 # endif
1073 #endif
1074
1075 /*
1076  * Prefixes for call/return points of library function traces.  We use these to
1077  * instrument the public functions so that the traces can be easily transformed
1078  * into regression scripts.
1079  */
1080 #define T_CALLED(fmt) "called {" fmt
1081 #define T_CREATE(fmt) "create :" fmt
1082 #define T_RETURN(fmt) "return }" fmt
1083
1084 #ifdef TRACE
1085
1086 #define START_TRACE() \
1087         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1088             int t = _nc_getenv_num("NCURSES_TRACE"); \
1089             if (t >= 0) \
1090                 trace((unsigned) t); \
1091         }
1092
1093 #define TR(n, a)        if (_nc_tracing & (n)) _tracef a
1094 #define T(a)            TR(TRACE_CALLS, a)
1095 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
1096 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1097
1098 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
1099 #define returnBits(code)        TRACE_RETURN(code,unsigned)
1100 #define returnBool(code)        TRACE_RETURN(code,bool)
1101 #define returnCPtr(code)        TRACE_RETURN(code,cptr)
1102 #define returnCVoidPtr(code)    TRACE_RETURN(code,cvoid_ptr)
1103 #define returnChar(code)        TRACE_RETURN(code,chtype)
1104 #define returnCode(code)        TRACE_RETURN(code,int)
1105 #define returnPtr(code)         TRACE_RETURN(code,ptr)
1106 #define returnSP(code)          TRACE_RETURN(code,sp)
1107 #define returnVoid              T((T_RETURN(""))); return
1108 #define returnVoidPtr(code)     TRACE_RETURN(code,void_ptr)
1109 #define returnWin(code)         TRACE_RETURN(code,win)
1110
1111 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (NCURSES_BOOL);
1112 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1113 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
1114 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
1115 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
1116 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
1117 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(TTY *tty);
1118 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
1119 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
1120 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
1121 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
1122 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
1123 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
1124 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
1125 extern NCURSES_EXPORT(void)             _nc_fifo_dump (void);
1126 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1127 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
1128 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
1129
1130 #if USE_WIDEC_SUPPORT
1131 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1132 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1133 #endif
1134
1135 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1136 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1137
1138 #else /* !TRACE */
1139
1140 #define START_TRACE() /* nothing */
1141
1142 #define T(a)
1143 #define TR(n, a)
1144 #define TPUTS_TRACE(s)
1145
1146 #define returnAttr(code)        return code
1147 #define returnBits(code)        return code
1148 #define returnBool(code)        return code
1149 #define returnCPtr(code)        return code
1150 #define returnCVoidPtr(code)    return code
1151 #define returnChar(code)        return code
1152 #define returnCode(code)        return code
1153 #define returnPtr(code)         return code
1154 #define returnSP(code)          return code
1155 #define returnVoid              return
1156 #define returnVoidPtr(code)     return code
1157 #define returnWin(code)         return code
1158
1159 #endif /* TRACE/!TRACE */
1160
1161 /*
1162  * Return-codes for tgetent() and friends.
1163  */
1164 #define TGETENT_YES  1          /* entry is found */
1165 #define TGETENT_NO   0          /* entry is not found */
1166 #define TGETENT_ERR -1          /* an error occurred */
1167
1168 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1169 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1170
1171 #define empty_module(name) \
1172 extern  NCURSES_EXPORT(void) name (void); \
1173         NCURSES_EXPORT(void) name (void) { }
1174
1175 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1176 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1177 #define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)
1178
1179 #define toggle_attr_on(S,at) {\
1180    if (PAIR_NUMBER(at) > 0) {\
1181       (S) = ((S) & ALL_BUT_COLOR) | (at);\
1182    } else {\
1183       (S) |= (at);\
1184    }\
1185    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1186
1187
1188 #define toggle_attr_off(S,at) {\
1189    if (PAIR_NUMBER(at) > 0) {\
1190       (S) &= ~(at|A_COLOR);\
1191    } else {\
1192       (S) &= ~(at);\
1193    }\
1194    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1195
1196 #define DelCharCost(count) \
1197                 ((parm_dch != 0) \
1198                 ? SP->_dch_cost \
1199                 : ((delete_character != 0) \
1200                         ? (SP->_dch1_cost * count) \
1201                         : INFINITY))
1202
1203 #define InsCharCost(count) \
1204                 ((parm_ich != 0) \
1205                 ? SP->_ich_cost \
1206                 : ((enter_insert_mode && exit_insert_mode) \
1207                   ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
1208                   : ((insert_character != 0) \
1209                     ? ((SP->_ich1_cost + SP->_ip_cost) * count) \
1210                     : INFINITY)))
1211
1212 #if USE_XMC_SUPPORT
1213 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) { \
1214                                 attr_t chg = AttrOf(SCREEN_ATTRS(SP)); \
1215                                 VIDATTR(AttrOf(c), GetPair(c)); \
1216                                 if (magic_cookie_glitch > 0 \
1217                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(SP))))) { \
1218                                         T(("%s @%d before glitch %d,%d", \
1219                                                 __FILE__, __LINE__, \
1220                                                 SP->_cursrow, \
1221                                                 SP->_curscol)); \
1222                                         _nc_do_xmc_glitch(chg); \
1223                                 } \
1224                         }
1225 #else
1226 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) \
1227                                 VIDATTR(AttrOf(c), GetPair(c));
1228 #endif
1229
1230 /*
1231  * Macros to make additional parameter to implement wgetch_events()
1232  */
1233 #ifdef NCURSES_WGETCH_EVENTS
1234 #define EVENTLIST_0th(param) param
1235 #define EVENTLIST_1st(param) param
1236 #define EVENTLIST_2nd(param) , param
1237 #else
1238 #define EVENTLIST_0th(param) void
1239 #define EVENTLIST_1st(param) /* nothing */
1240 #define EVENTLIST_2nd(param) /* nothing */
1241 #endif
1242
1243 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1244
1245 #undef  toggle_attr_on
1246 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1247 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1248
1249 #undef  toggle_attr_off
1250 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1251 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1252
1253 #undef  DelCharCost
1254 #define DelCharCost(count) _nc_DelCharCost(count)
1255 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1256
1257 #undef  InsCharCost
1258 #define InsCharCost(count) _nc_InsCharCost(count)
1259 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1260
1261 #undef  UpdateAttrs
1262 #define UpdateAttrs(c) _nc_UpdateAttrs(c)
1263 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (NCURSES_CH_T);
1264
1265 #else
1266
1267 extern NCURSES_EXPORT(void) _nc_expanded (void);
1268
1269 #endif
1270
1271 #if !HAVE_GETCWD
1272 #define getcwd(buf,len) getwd(buf)
1273 #endif
1274
1275 /* charable.c */
1276 #if USE_WIDEC_SUPPORT
1277 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1278 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1279 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1280 #endif
1281
1282 /* comp_captab.c */
1283 typedef struct {
1284         short   nte_name;       /* offset of name to hash on */
1285         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
1286         short   nte_index;      /* index of associated variable in its array */
1287         short   nte_link;       /* index in table of next hash, or -1 */
1288 } name_table_data;
1289
1290 typedef struct
1291 {
1292         short   from;
1293         short   to;
1294         short   source;
1295 } alias_table_data;
1296
1297 /* doupdate.c */
1298 #if USE_XMC_SUPPORT
1299 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1300 #endif
1301
1302 /* hardscroll.c */
1303 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1304 extern NCURSES_EXPORT(void) _nc_linedump (void);
1305 #endif
1306
1307 /* lib_acs.c */
1308 extern NCURSES_EXPORT(void) _nc_init_acs (void);        /* corresponds to traditional 'init_acs()' */
1309 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int);  /* used by 'tack' program */
1310
1311 /* lib_addch.c */
1312 #if USE_WIDEC_SUPPORT
1313 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1314 #endif
1315
1316 /* lib_addstr.c */
1317 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1318 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1319 #endif
1320
1321 /* lib_color.c */
1322 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1323
1324 /* lib_getch.c */
1325 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1326
1327 /* lib_insch.c */
1328 extern NCURSES_EXPORT(int) _nc_insert_ch(WINDOW *, chtype);
1329
1330 /* lib_mvcur.c */
1331 #define INFINITY        1000000 /* cost: too high to use */
1332
1333 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1334 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1335 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1336
1337 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1338
1339 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1340 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1341 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1342
1343 /* lib_mouse.c */
1344 extern NCURSES_EXPORT(int) _nc_has_mouse (void);
1345
1346 /* lib_mvcur.c */
1347 #define INFINITY        1000000 /* cost: too high to use */
1348 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
1349
1350 /* lib_setup.c */
1351 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1352 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1353 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(void);
1354 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1355 extern NCURSES_EXPORT(void) _nc_get_screensize(int *, int *);
1356
1357 /* lib_tstp.c */
1358 #if USE_SIGWINCH
1359 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(int);
1360 #else
1361 #define _nc_handle_sigwinch(a) /* nothing */
1362 #endif
1363
1364 /* lib_wacs.c */
1365 #if USE_WIDEC_SUPPORT
1366 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1367 #endif
1368
1369 typedef struct {
1370     char *s_head;       /* beginning of the string (may be null) */
1371     char *s_tail;       /* end of the string (may be null) */
1372     size_t s_size;      /* current remaining size available */
1373     size_t s_init;      /* total size available */
1374 } string_desc;
1375
1376 /* strings.c */
1377 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1378 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1379 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1380 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1381 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1382
1383 #if !HAVE_STRSTR
1384 #define strstr _nc_strstr
1385 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1386 #endif
1387
1388 /* safe_sprintf.c */
1389 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1390
1391 /* tries.c */
1392 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1393 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1394 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1395 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1396
1397 /* elsewhere ... */
1398 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry(ENTRY *, TERMTYPE *);
1399 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1400 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1401 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1402 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1403 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1404 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1405 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1406 extern NCURSES_EXPORT(int) _nc_keypad (bool);
1407 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1408 extern NCURSES_EXPORT(int) _nc_outch (int);
1409 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1410 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1411 extern NCURSES_EXPORT(int) _nc_timed_wait(int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1412 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, int (*)(int));
1413 extern NCURSES_EXPORT(void) _nc_flush (void);
1414 extern NCURSES_EXPORT(void) _nc_free_entry(ENTRY *, TERMTYPE *);
1415 extern NCURSES_EXPORT(void) _nc_freeall (void);
1416 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1417 extern NCURSES_EXPORT(void) _nc_init_keytry (void);
1418 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1419 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1420 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1421 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1422 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1423 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1424 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1425 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1426
1427 #if NO_LEAKS
1428 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1429 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1430 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1431 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1432 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1433 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1434 #endif
1435
1436 #ifndef USE_TERMLIB
1437 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1438 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1439 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1440 #endif
1441
1442 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1443 #ifdef linux
1444 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1445 #else
1446 #define _nc_wcrtomb(s,wc,ps) wcrtomb(s,wc,ps)
1447 #endif
1448 #endif
1449
1450 #if USE_SIZECHANGE
1451 extern NCURSES_EXPORT(void) _nc_update_screensize (void);
1452 #endif
1453
1454 #if HAVE_RESIZETERM
1455 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1456 #else
1457 #define _nc_resize_margins(wp) /* nothing */
1458 #endif
1459
1460 #ifdef NCURSES_WGETCH_EVENTS
1461 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1462 #else
1463 #define wgetch_events(win, evl) wgetch(win)
1464 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1465 #endif
1466
1467 /*
1468  * Not everyone has vsscanf(), but we'd like to use it for scanw().
1469  */
1470 #if !HAVE_VSSCANF
1471 extern int vsscanf(const char *str, const char *format, va_list __arg);
1472 #endif
1473
1474 /* scroll indices */
1475 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1476
1477 #define USE_SETBUF_0 0
1478
1479 #define NC_BUFFERED(flag) _nc_set_buffer(SP->_ofp, flag)
1480
1481 #define NC_OUTPUT ((SP != 0) ? SP->_ofp : stdout)
1482
1483 /*
1484  * On systems with a broken linker, define 'SP' as a function to force the
1485  * linker to pull in the data-only module with 'SP'.
1486  */
1487 #if BROKEN_LINKER
1488 #define SP _nc_screen()
1489 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1490 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1491 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1492 #else
1493 /* current screen is private data; avoid possible linking conflicts too */
1494 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1495 #define _nc_alloc_screen() ((SP = typeCalloc(SCREEN, 1)) != 0)
1496 #define _nc_set_screen(sp) SP = sp
1497 #endif
1498
1499 /*
1500  * We don't want to use the lines or columns capabilities internally, because
1501  * if the application is running multiple screens under X, it's quite possible
1502  * they could all have type xterm but have different sizes!  So...
1503  */
1504 #define screen_lines    SP->_lines
1505 #define screen_columns  SP->_columns
1506
1507 extern NCURSES_EXPORT_VAR(int) _nc_slk_format;  /* != 0 if slk_init() called */
1508 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1509
1510 /*
1511  * Some constants related to SLK's
1512  */
1513 #define MAX_SKEY_OLD       8    /* count of soft keys */
1514 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
1515 #define MAX_SKEY_PC       12    /* This is what most PC's have */
1516 #define MAX_SKEY_LEN_PC    5
1517
1518 /* Macro to check whether or not we use a standard format */
1519 #define SLK_STDFMT(fmt) (fmt < 3)
1520 /* Macro to determine height of label window */
1521 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1522
1523 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1524 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1525
1526 extern NCURSES_EXPORT(int) _nc_ripoffline (int line, int (*init)(WINDOW *,int));
1527
1528 /*
1529  * Common error messages
1530  */
1531 #define MSG_NO_MEMORY "Out of memory"
1532 #define MSG_NO_INPUTS "Premature EOF"
1533
1534 #ifdef __cplusplus
1535 }
1536 #endif
1537
1538 #endif /* CURSES_PRIV_H */