ncurses 5.6 - patch 20080503
[ncurses.git] / ncurses / curses.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2007,2008 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.373 2008/05/03 23:30:35 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 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
304             __FILE__, __LINE__, \
305             (unsigned long) (pthread_self()), \
306             data.__data.__lock, \
307             data.__data.__count, \
308             data.__data.__owner, \
309             data.__data.__kind, \
310             (data.__data.__nusers > 5) ? " OOPS " : "", \
311             data.__data.__nusers)
312 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
313
314 #ifdef USE_PTHREADS
315
316 #if USE_REENTRANT
317 #include <pthread.h>
318 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
319 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
320 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
321 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
322 #define _nc_lock_global(name)   _nc_mutex_lock(&_nc_globals.mutex_##name)
323 #define _nc_try_global(name)    _nc_mutex_trylock(&_nc_globals.mutex_##name)
324 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
325
326 extern NCURSES_EXPORT(void) _nc_lock_window(const WINDOW *);
327 extern NCURSES_EXPORT(void) _nc_unlock_window(const WINDOW *);
328
329 #else
330 #error POSIX threads requires --enable-reentrant option
331 #endif
332
333 #if HAVE_NANOSLEEP
334 #undef HAVE_NANOSLEEP
335 #define HAVE_NANOSLEEP 0        /* nanosleep suspends all threads */
336 #endif
337
338 #else /* !USE_PTHREADS */
339
340 #define _nc_mutex_init(obj)     /* nothing */
341
342 #define _nc_lock_global(name)   /* nothing */
343 #define _nc_try_global(name)    0
344 #define _nc_unlock_global(name) /* nothing */
345
346 #define _nc_lock_window(name)   (void) TRUE
347 #define _nc_unlock_window(name) /* nothing */
348
349 #endif /* USE_PTHREADS */
350
351 #if HAVE_GETTIMEOFDAY
352 # define PRECISE_GETTIME 1
353 # define TimeType struct timeval
354 #else
355 # define PRECISE_GETTIME 0
356 # define TimeType time_t
357 #endif
358
359 /*
360  * Definitions for color pairs
361  */
362 typedef unsigned colorpair_t;   /* type big enough to store PAIR_OF() */
363 #define C_SHIFT 9               /* we need more bits than there are colors */
364 #define C_MASK                  ((1 << C_SHIFT) - 1)
365 #define PAIR_OF(fg, bg)         ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
366 #define isDefaultColor(c)       ((c) >= COLOR_DEFAULT || (c) < 0)
367
368 #define COLOR_DEFAULT           C_MASK
369
370 #if defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T)
371
372 #undef NCURSES_CH_T             /* this is not a termlib feature */
373 #define NCURSES_CH_T void       /* ...but we need a pointer in SCREEN */
374
375 #endif  /* USE_TERMLIB */
376
377 #ifndef USE_TERMLIB
378 struct ldat
379 {
380         NCURSES_CH_T    *text;          /* text of the line */
381         NCURSES_SIZE_T  firstchar;      /* first changed character in the line */
382         NCURSES_SIZE_T  lastchar;       /* last changed character in the line */
383         NCURSES_SIZE_T  oldindex;       /* index of the line at last update */
384 };
385 #endif  /* USE_TERMLIB */
386
387 typedef enum {
388         M_XTERM = -1            /* use xterm's mouse tracking? */
389         ,M_NONE = 0             /* no mouse device */
390 #if USE_GPM_SUPPORT
391         ,M_GPM                  /* use GPM */
392 #endif
393 #if USE_SYSMOUSE
394         ,M_SYSMOUSE             /* FreeBSD sysmouse on console */
395 #endif
396 } MouseType;
397
398 /*
399  * Structures for scrolling.
400  */
401
402 typedef struct {
403         unsigned long hashval;
404         int oldcount, newcount;
405         int oldindex, newindex;
406 } HASHMAP;
407
408 /*
409  * Structures for soft labels.
410  */
411
412 struct _SLK;
413
414 #ifndef USE_TERMLIB
415
416 typedef struct
417 {
418         char *ent_text;         /* text for the label */
419         char *form_text;        /* formatted text (left/center/...) */
420         int ent_x;              /* x coordinate of this field */
421         char dirty;             /* this label has changed */
422         char visible;           /* field is visible */
423 } slk_ent;
424
425 typedef struct _SLK {
426         char dirty;             /* all labels have changed */
427         char hidden;            /* soft labels are hidden */
428         WINDOW *win;
429         slk_ent *ent;
430         short  maxlab;          /* number of available labels */
431         short  labcnt;          /* number of allocated labels */
432         short  maxlen;          /* length of labels */
433         NCURSES_CH_T attr;      /* soft label attribute */
434 } SLK;
435
436 #endif  /* USE_TERMLIB */
437
438 typedef struct {
439         WINDOW *win;            /* the window used in the hook      */
440         int     line;           /* lines to take, < 0 => from bottom*/
441         int     (*hook)(WINDOW *, int); /* callback for user        */
442 } ripoff_t;
443
444 #if USE_GPM_SUPPORT
445 #undef buttons                  /* term.h defines this, and gpm uses it! */
446 #include <gpm.h>
447
448 #ifdef HAVE_LIBDL
449 /* link dynamically to GPM */
450 typedef int *TYPE_gpm_fd;
451 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
452 typedef int (*TYPE_Gpm_Close) (void);
453 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
454
455 #define my_gpm_fd       SP->_mouse_gpm_fd
456 #define my_Gpm_Open     SP->_mouse_Gpm_Open
457 #define my_Gpm_Close    SP->_mouse_Gpm_Close
458 #define my_Gpm_GetEvent SP->_mouse_Gpm_GetEvent
459 #else
460 /* link statically to GPM */
461 #define my_gpm_fd       &gpm_fd
462 #define my_Gpm_Open     Gpm_Open
463 #define my_Gpm_Close    Gpm_Close
464 #define my_Gpm_GetEvent Gpm_GetEvent
465 #endif /* HAVE_LIBDL */
466 #endif /* USE_GPM_SUPPORT */
467
468 typedef struct {
469     long sequence;
470     bool last_used;
471     char *fix_sgr0;             /* this holds the filtered sgr0 string */
472     char *last_bufp;            /* help with fix_sgr0 leak */
473     TERMINAL *last_term;
474 } TGETENT_CACHE;
475
476 #define TGETENT_MAX 4
477
478 /*
479  * State of tparm().
480  */
481 #define STACKSIZE 20
482
483 typedef struct {
484         union {
485                 int     num;
486                 char    *str;
487         } data;
488         bool num_type;
489 } STACK_FRAME;
490
491 #define NUM_VARS 26
492
493 typedef struct {
494 #ifdef TRACE
495         const char      *tname;
496 #endif
497         const char      *tparam_base;
498
499         STACK_FRAME     stack[STACKSIZE];
500         int             stack_ptr;
501
502         char            *out_buff;
503         size_t          out_size;
504         size_t          out_used;
505
506         char            *fmt_buff;
507         size_t          fmt_size;
508
509         int             dynamic_var[NUM_VARS];
510         int             static_vars[NUM_VARS];
511 } TPARM_STATE;
512
513 typedef struct {
514     char *text;
515     size_t size;
516 } TRACEBUF;
517
518 /*
519  * The filesystem database normally uses a single-letter for the lower level
520  * of directories.  Use a hexadecimal code for filesystems which do not
521  * preserve mixed-case names.
522  */
523 #if MIXEDCASE_FILENAMES
524 #define LEAF_FMT "%c"
525 #else
526 #define LEAF_FMT "%02x"
527 #endif
528
529 /*
530  * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
531  * could at most have 10 digits, and the mask contains no more than 32 bits
532  * with each bit representing less than 15 characters.  Usually the whole
533  * string is less than 80 columns, but this buffer size is an absolute
534  * limit.
535  */
536 #define TRACEMSE_MAX    (80 + (5 * 10) + (32 * 15))
537 #define TRACEMSE_FMT    "id %2d  at (%2d, %2d, %2d) state %4lx = {" /* } */
538
539 /*
540  * Global data which is not specific to a screen.
541  */
542 typedef struct {
543         SIG_ATOMIC_T    have_sigwinch;
544         SIG_ATOMIC_T    cleanup_nested;
545
546         bool            init_signals;
547         bool            init_screen;
548
549         const char      *comp_sourcename;
550         char            *comp_termtype;
551
552         bool            have_tic_directory;
553         bool            keep_tic_directory;
554         const char      *tic_directory;
555
556         char            *dbi_list;
557         int             dbi_size;
558
559         char            *first_name;
560         char            **keyname_table;
561
562         int             slk_format;
563
564         char            *safeprint_buf;
565         size_t          safeprint_used;
566
567         TGETENT_CACHE   tgetent_cache[TGETENT_MAX];
568         int             tgetent_index;
569         long            tgetent_sequence;
570
571         WINDOWLIST      *_nc_windowlist;
572 #define _nc_windows     _nc_globals._nc_windowlist
573
574 #if USE_HOME_TERMINFO
575         char            *home_terminfo;
576 #endif
577
578 #if !USE_SAFE_SPRINTF
579         int             safeprint_cols;
580         int             safeprint_rows;
581 #endif
582
583 #ifdef TRACE
584         bool            init_trace;
585         char            trace_fname[PATH_MAX];
586         int             trace_level;
587         FILE            *trace_fp;
588
589         char            *tracearg_buf;
590         size_t          tracearg_used;
591
592         TRACEBUF        *tracebuf_ptr;
593         size_t          tracebuf_used;
594
595         char            tracechr_buf[40];
596
597         char            *tracedmp_buf;
598         size_t          tracedmp_used;
599
600         char            tracemse_buf[TRACEMSE_MAX];
601
602         unsigned char   *tracetry_buf;
603         size_t          tracetry_used;
604
605         char            traceatr_color_buf[2][80];
606         int             traceatr_color_sel;
607         int             traceatr_color_last;
608
609 #endif  /* TRACE */
610
611 #ifdef USE_PTHREADS
612        pthread_mutex_t  mutex_set_SP;
613        pthread_mutex_t  mutex_use_screen;
614        pthread_mutex_t  mutex_use_window;
615        pthread_mutex_t  mutex_windowlist;
616        pthread_mutex_t  mutex_tst_tracef;
617        pthread_mutex_t  mutex_tracef;
618        int              nested_tracef;
619 #endif
620 } NCURSES_GLOBALS;
621
622 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
623
624 #define N_RIPS 5
625
626 /*
627  * Global data which can be swept up into a SCREEN when one is created.
628  * It may be modified before the next SCREEN is created.
629  */
630 typedef struct {
631         bool            use_env;
632         bool            filter_mode;
633         attr_t          previous_attr;
634         ripoff_t        rippedoff[N_RIPS];
635         ripoff_t        *rsp;
636         TPARM_STATE     tparm_state;
637         TTY             *saved_tty;     /* savetty/resetty information      */
638 #if BROKEN_LINKER || USE_REENTRANT
639         chtype          *real_acs_map;
640         int             _LINES;
641         int             _COLS;
642 #ifdef TRACE
643         long            _outchars;
644         const char      *_tputs_trace;
645 #endif
646 #endif
647 } NCURSES_PRESCREEN;
648
649 #define ripoff_sp       _nc_prescreen.rsp
650 #define ripoff_stack    _nc_prescreen.rippedoff
651
652 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
653
654 /*
655  * The SCREEN structure.
656  */
657
658 struct screen {
659         int             _ifd;           /* input file ptr for screen        */
660         FILE            *_ofp;          /* output file ptr for screen       */
661         char            *_setbuf;       /* buffered I/O for output          */
662         bool            _filtered;      /* filter() was called              */
663         bool            _buffered;      /* setvbuf uses _setbuf data        */
664         int             _checkfd;       /* filedesc for typeahead check     */
665         TERMINAL        *_term;         /* terminal type information        */
666         TTY             _saved_tty;     /* savetty/resetty information      */
667         NCURSES_SIZE_T  _lines;         /* screen lines                     */
668         NCURSES_SIZE_T  _columns;       /* screen columns                   */
669
670         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
671         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
672
673         WINDOW          *_curscr;       /* current screen                   */
674         WINDOW          *_newscr;       /* virtual screen to be updated to  */
675         WINDOW          *_stdscr;       /* screen's full-window context     */
676
677         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
678         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
679         bool            _tried;         /* keypad mode was initialized      */
680         bool            _keypad_on;     /* keypad mode is currently on      */
681
682         bool            _called_wgetch; /* check for recursion in wgetch()  */
683         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
684         short           _fifohead,      /* head of fifo queue               */
685                         _fifotail,      /* tail of fifo queue               */
686                         _fifopeek,      /* where to peek for next char      */
687                         _fifohold;      /* set if breakout marked           */
688
689         int             _endwin;        /* are we out of window mode?       */
690         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
691         int             _coloron;       /* is color enabled?                */
692         int             _color_defs;    /* are colors modified              */
693         int             _cursor;        /* visibility of the cursor         */
694         int             _cursrow;       /* physical cursor row              */
695         int             _curscol;       /* physical cursor column           */
696         bool            _notty;         /* true if we cannot switch non-tty */
697         int             _nl;            /* True if NL -> CR/NL is on        */
698         int             _raw;           /* True if in raw mode              */
699         int             _cbreak;        /* 1 if in cbreak mode              */
700                                         /* > 1 if in halfdelay mode         */
701         int             _echo;          /* True if echo on                  */
702         int             _use_meta;      /* use the meta key?                */
703         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
704         int             slk_format;     /* selected format for this screen  */
705         /* cursor movement costs; units are 10ths of milliseconds */
706 #if NCURSES_NO_PADDING
707         int             _no_padding;    /* flag to set if padding disabled  */
708 #endif
709         int             _char_padding;  /* cost of character put            */
710         int             _cr_cost;       /* cost of (carriage_return)        */
711         int             _cup_cost;      /* cost of (cursor_address)         */
712         int             _home_cost;     /* cost of (cursor_home)            */
713         int             _ll_cost;       /* cost of (cursor_to_ll)           */
714 #if USE_HARD_TABS
715         int             _ht_cost;       /* cost of (tab)                    */
716         int             _cbt_cost;      /* cost of (backtab)                */
717 #endif /* USE_HARD_TABS */
718         int             _cub1_cost;     /* cost of (cursor_left)            */
719         int             _cuf1_cost;     /* cost of (cursor_right)           */
720         int             _cud1_cost;     /* cost of (cursor_down)            */
721         int             _cuu1_cost;     /* cost of (cursor_up)              */
722         int             _cub_cost;      /* cost of (parm_cursor_left)       */
723         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
724         int             _cud_cost;      /* cost of (parm_cursor_down)       */
725         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
726         int             _hpa_cost;      /* cost of (column_address)         */
727         int             _vpa_cost;      /* cost of (row_address)            */
728         /* used in tty_update.c, must be chars */
729         int             _ed_cost;       /* cost of (clr_eos)                */
730         int             _el_cost;       /* cost of (clr_eol)                */
731         int             _el1_cost;      /* cost of (clr_bol)                */
732         int             _dch1_cost;     /* cost of (delete_character)       */
733         int             _ich1_cost;     /* cost of (insert_character)       */
734         int             _dch_cost;      /* cost of (parm_dch)               */
735         int             _ich_cost;      /* cost of (parm_ich)               */
736         int             _ech_cost;      /* cost of (erase_chars)            */
737         int             _rep_cost;      /* cost of (repeat_char)            */
738         int             _hpa_ch_cost;   /* cost of (column_address)         */
739         int             _cup_ch_cost;   /* cost of (cursor_address)         */
740         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
741         int             _inline_cost;   /* cost of inline-move              */
742         int             _smir_cost;     /* cost of (enter_insert_mode)      */
743         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
744         int             _ip_cost;       /* cost of (insert_padding)         */
745         /* used in lib_mvcur.c */
746         char *          _address_cursor;
747         /* used in tty_update.c */
748         int             _scrolling;     /* 1 if terminal's smart enough to  */
749
750         /* used in lib_color.c */
751         color_t         *_color_table;  /* screen's color palette            */
752         int             _color_count;   /* count of colors in palette        */
753         colorpair_t     *_color_pairs;  /* screen's color pair list          */
754         int             _pair_count;    /* count of color pairs              */
755 #if NCURSES_EXT_FUNCS
756         bool            _default_color; /* use default colors                */
757         bool            _has_sgr_39_49; /* has ECMA default color support    */
758         int             _default_fg;    /* assumed default foreground        */
759         int             _default_bg;    /* assumed default background        */
760 #endif
761         chtype          _ok_attributes; /* valid attributes for terminal     */
762         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
763         chtype          _xmc_triggers;  /* attributes to process if xmc      */
764         chtype *        _acs_map;       /* the real alternate-charset map    */
765         bool *          _screen_acs_map;
766
767
768         /* used in lib_vidattr.c */
769         bool            _use_rmso;      /* true if we may use 'rmso'         */
770         bool            _use_rmul;      /* true if we may use 'rmul'         */
771
772         /*
773          * These data correspond to the state of the idcok() and idlok()
774          * functions.  A caveat is in order here:  the XSI and SVr4
775          * documentation specify that these functions apply to the window which
776          * is given as an argument.  However, ncurses implements this logic
777          * only for the newscr/curscr update process, _not_ per-window.
778          */
779         bool            _nc_sp_idlok;
780         bool            _nc_sp_idcok;
781 #define _nc_idlok SP->_nc_sp_idlok
782 #define _nc_idcok SP->_nc_sp_idcok
783
784         /*
785          * These are the data that support the mouse interface.
786          */
787         bool            _mouse_initialized;
788         MouseType       _mouse_type;
789         int             _maxclick;
790         bool            (*_mouse_event) (SCREEN *);
791         bool            (*_mouse_inline)(SCREEN *);
792         bool            (*_mouse_parse) (int);
793         void            (*_mouse_resume)(SCREEN *);
794         void            (*_mouse_wrap)  (SCREEN *);
795         int             _mouse_fd;      /* file-descriptor, if any */
796         bool            _mouse_active;  /* true if initialized */
797         mmask_t         _mouse_mask;
798         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
799         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
800         MEVENT          *_mouse_eventp; /* next free slot in event queue */
801
802 #if USE_GPM_SUPPORT
803         bool            _mouse_gpm_loaded;
804         bool            _mouse_gpm_found;
805 #ifdef HAVE_LIBDL
806         TYPE_gpm_fd     _mouse_gpm_fd;
807         TYPE_Gpm_Open   _mouse_Gpm_Open;
808         TYPE_Gpm_Close  _mouse_Gpm_Close;
809         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
810 #endif
811         Gpm_Connect     _mouse_gpm_connect;
812 #endif /* USE_GPM_SUPPORT */
813
814 #if USE_EMX_MOUSE
815         int             _emxmouse_wfd;
816         int             _emxmouse_thread;
817         int             _emxmouse_activated;
818         char            _emxmouse_buttons[4];
819 #endif
820
821 #if USE_SYSMOUSE
822         MEVENT          _sysmouse_fifo[FIFO_SIZE];
823         int             _sysmouse_head;
824         int             _sysmouse_tail;
825         int             _sysmouse_char_width;   /* character width */
826         int             _sysmouse_char_height;  /* character height */
827         int             _sysmouse_old_buttons;
828         int             _sysmouse_new_buttons;
829 #endif
830
831         /*
832          * This supports automatic resizing
833          */
834 #if USE_SIZECHANGE
835         int             (*_resize)(int,int);
836 #endif
837
838         /*
839          * These are data that support the proper handling of the panel stack on an
840          * per screen basis.
841          */
842         struct panelhook _panelHook;
843
844         bool            _sig_winch;
845         SCREEN          *_next_screen;
846
847         /* hashes for old and new lines */
848         unsigned long   *oldhash, *newhash;
849         HASHMAP         *hashtab;
850         int             hashtab_len;
851         int             *_oldnum_list;
852         int             _oldnum_size;
853
854         bool            _cleanup;       /* cleanup after int/quit signal */
855         int             (*_outch)(int); /* output handler if not putc */
856
857         int             _legacy_coding; /* see use_legacy_coding() */
858
859 #if USE_REENTRANT
860         char            _ttytype[NAMESIZE];
861         int             _ESCDELAY;
862         int             _TABSIZE;
863         int             _LINES;
864         int             _COLS;
865 #ifdef TRACE
866         long            _outchars;
867         const char      *_tputs_trace;
868 #endif
869 #endif
870         /*
871          * ncurses/ncursesw are the same up to this point.
872          */
873 #if USE_WIDEC_SUPPORT
874         /* recent versions of 'screen' have partially-working support for
875          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
876          */
877         bool            _screen_acs_fix;
878 #endif
879 };
880
881 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
882 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
883
884         WINDOWLIST {
885         WINDOW  win;    /* first, so WINDOW_EXT() works */
886         WINDOWLIST *next;
887 #ifdef _XOPEN_SOURCE_EXTENDED
888         char addch_work[(MB_LEN_MAX * 9) + 1];
889         unsigned addch_used;    /* number of bytes in addch_work[] */
890         int addch_x;            /* x-position for addch_work[] */
891         int addch_y;            /* y-position for addch_work[] */
892 #endif
893 #ifdef USE_PTHREADS
894         pthread_mutex_t mutex_use_window;
895 #endif
896 };
897
898 #define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)
899
900 /* usually in <limits.h> */
901 #ifndef UCHAR_MAX
902 #define UCHAR_MAX 255
903 #endif
904
905 /* The terminfo source is assumed to be 7-bit ASCII */
906 #define is7bits(c)      ((unsigned)(c) < 128)
907
908 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
909 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
910
911 #ifndef min
912 #define min(a,b)        ((a) > (b)  ?  (b)  :  (a))
913 #endif
914
915 #ifndef max
916 #define max(a,b)        ((a) < (b)  ?  (b)  :  (a))
917 #endif
918
919 /* usually in <unistd.h> */
920 #ifndef STDIN_FILENO
921 #define STDIN_FILENO 0
922 #endif
923
924 #ifndef STDOUT_FILENO
925 #define STDOUT_FILENO 1
926 #endif
927
928 #ifndef STDERR_FILENO
929 #define STDERR_FILENO 2
930 #endif
931
932 #ifndef EXIT_SUCCESS
933 #define EXIT_SUCCESS 0
934 #endif
935
936 #ifndef EXIT_FAILURE
937 #define EXIT_FAILURE 1
938 #endif
939
940 #ifndef R_OK
941 #define R_OK    4               /* Test for read permission.  */
942 #endif
943 #ifndef W_OK
944 #define W_OK    2               /* Test for write permission.  */
945 #endif
946 #ifndef X_OK
947 #define X_OK    1               /* Test for execute permission.  */
948 #endif
949 #ifndef F_OK
950 #define F_OK    0               /* Test for existence.  */
951 #endif
952
953 #if HAVE_FCNTL_H
954 #include <fcntl.h>              /* may define O_BINARY  */
955 #endif
956
957 #ifndef O_BINARY
958 #define O_BINARY 0
959 #endif
960
961 #ifdef TRACE
962 #if USE_REENTRANT
963 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
964 #else
965 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
966 #endif
967 #else
968 #define COUNT_OUTCHARS(n) /* nothing */
969 #endif
970
971 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
972
973 #define UChar(c)        ((unsigned char)(c))
974 #define ChCharOf(c)     ((c) & (chtype)A_CHARTEXT)
975 #define ChAttrOf(c)     ((c) & (chtype)A_ATTRIBUTES)
976
977 #ifndef MB_LEN_MAX
978 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
979 #endif
980
981 #if USE_WIDEC_SUPPORT /* { */
982 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
983
984 #define init_mb(state)  memset(&state, 0, sizeof(state))
985
986 #if NCURSES_EXT_COLORS
987 #define NulColor        , 0
988 #else
989 #define NulColor        /* nothing */
990 #endif
991
992 #define NulChar         0,0,0,0 /* FIXME: see CCHARW_MAX */
993 #define CharOf(c)       ((c).chars[0])
994 #define AttrOf(c)       ((c).attr)
995
996 #define AddAttr(c,a)    AttrOf(c) |=  ((a) & A_ATTRIBUTES)
997 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
998 #define SetAttr(c,a)    AttrOf(c) =   ((a) & A_ATTRIBUTES) | WidecExt(c)
999
1000 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
1001 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
1002
1003 #if CCHARW_MAX == 5
1004 #define CharEq(a,b)     (((a).attr == (b).attr) \
1005                        && (a).chars[0] == (b).chars[0] \
1006                        && (a).chars[1] == (b).chars[1] \
1007                        && (a).chars[2] == (b).chars[2] \
1008                        && (a).chars[3] == (b).chars[3] \
1009                        && (a).chars[4] == (b).chars[4] \
1010                         if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1011 #else
1012 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
1013 #endif
1014
1015 #define SetChar(ch,c,a) do {                                                        \
1016                             NCURSES_CH_T *_cp = &ch;                                \
1017                             memset(_cp, 0, sizeof(ch));                             \
1018                             _cp->chars[0] = (c);                                            \
1019                             _cp->attr = (a);                                        \
1020                             if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a)));             \
1021                         } while (0)
1022 #define CHREF(wch)      (&wch)
1023 #define CHDEREF(wch)    (*wch)
1024 #define ARG_CH_T        NCURSES_CH_T *
1025 #define CARG_CH_T       const NCURSES_CH_T *
1026 #define PUTC_DATA       char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1027                         mbstate_t PUT_st; wchar_t PUTC_ch
1028 #define PUTC_INIT       init_mb (PUT_st)
1029 #define PUTC(ch,b)      do { if(!isWidecExt(ch)) {                                  \
1030                         if (Charable(ch)) {                                         \
1031                             fputc(CharOf(ch), b);                                   \
1032                             COUNT_OUTCHARS(1);                                      \
1033                         } else {                                                    \
1034                             PUTC_INIT;                                              \
1035                             for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {       \
1036                                 PUTC_ch = (ch).chars[PUTC_i];                       \
1037                                 if (PUTC_ch == L'\0')                               \
1038                                     break;                                          \
1039                                 PUTC_n = wcrtomb(PUTC_buf,                          \
1040                                                  (ch).chars[PUTC_i], &PUT_st);      \
1041                                 if (PUTC_n <= 0) {                                  \
1042                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1043                                         putc(PUTC_ch,b);                            \
1044                                     break;                                          \
1045                                 }                                                   \
1046                                 fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b);          \
1047                             }                                                       \
1048                             COUNT_OUTCHARS(PUTC_i);                                 \
1049                         } } } while (0)
1050
1051 #define BLANK           NewChar2(' ', WA_NORMAL)
1052 #define ZEROS           NewChar2('\0', WA_NORMAL)
1053 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1054
1055         /*
1056          * Wide characters cannot be represented in the A_CHARTEXT mask of
1057          * attr_t's but an application might have set a narrow character there.
1058          * But even in that case, it would only be a printable character, or
1059          * zero.  Otherwise we can use those bits to tell if a cell is the
1060          * first or extension part of a wide character.
1061          */
1062 #define WidecExt(ch)    (AttrOf(ch) & A_CHARTEXT)
1063 #define isWidecBase(ch) (WidecExt(ch) == 1)
1064 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1065 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
1066                                 AttrOf(dst) |= (ext + 1)
1067
1068 #define if_WIDEC(code)  code
1069 #define Charable(ch)    ((SP != 0 && SP->_legacy_coding)                \
1070                          || (AttrOf(ch) & A_ALTCHARSET)                 \
1071                          || (!isWidecExt(ch) &&                         \
1072                              (ch).chars[1] == L'\0' &&                  \
1073                              _nc_is_charable(CharOf(ch))))
1074
1075 #define L(ch)           L ## ch
1076 #else /* }{ */
1077 #define CharOf(c)       ChCharOf(c)
1078 #define AttrOf(c)       ChAttrOf(c)
1079 #define AddAttr(c,a)    c |= (a)
1080 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
1081 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
1082 #define NewChar(ch)     (ch)
1083 #define NewChar2(c,a)   ((c) | (a))
1084 #define CharEq(a,b)     ((a) == (b))
1085 #define SetChar(ch,c,a) ch = (c) | (a)
1086 #define CHREF(wch)      wch
1087 #define CHDEREF(wch)    wch
1088 #define ARG_CH_T        NCURSES_CH_T
1089 #define CARG_CH_T       NCURSES_CH_T
1090 #define PUTC_DATA       int data = 0
1091 #define PUTC(ch,b)      do { data = CharOf(ch); putc(data,b); } while (0)
1092
1093 #define BLANK           (' '|A_NORMAL)
1094 #define ZEROS           ('\0'|A_NORMAL)
1095 #define ISBLANK(ch)     (CharOf(ch) == ' ')
1096
1097 #define isWidecExt(ch)  (0)
1098 #define if_WIDEC(code) /* nothing */
1099
1100 #define L(ch)           ch
1101 #endif /* } */
1102
1103 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
1104 #define CharOfD(ch)     CharOf(CHDEREF(ch))
1105 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1106
1107 #define BLANK_ATTR      A_NORMAL
1108 #define BLANK_TEXT      L(' ')
1109
1110 #define CHANGED     -1
1111
1112 #define LEGALYX(w, y, x) \
1113               ((w) != 0 && \
1114                 ((x) >= 0 && (x) <= (w)->_maxx && \
1115                  (y) >= 0 && (y) <= (w)->_maxy))
1116
1117 #define CHANGED_CELL(line,col) \
1118         if (line->firstchar == _NOCHANGE) \
1119                 line->firstchar = line->lastchar = col; \
1120         else if ((col) < line->firstchar) \
1121                 line->firstchar = col; \
1122         else if ((col) > line->lastchar) \
1123                 line->lastchar = col
1124
1125 #define CHANGED_RANGE(line,start,end) \
1126         if (line->firstchar == _NOCHANGE \
1127          || line->firstchar > (start)) \
1128                 line->firstchar = start; \
1129         if (line->lastchar == _NOCHANGE \
1130          || line->lastchar < (end)) \
1131                 line->lastchar = end
1132
1133 #define CHANGED_TO_EOL(line,start,end) \
1134         if (line->firstchar == _NOCHANGE \
1135          || line->firstchar > (start)) \
1136                 line->firstchar = start; \
1137         line->lastchar = end
1138
1139 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1140
1141 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
1142
1143 /* FreeAndNull() is not a comma-separated expression because some compilers
1144  * do not accept a mixture of void with values.
1145  */
1146 #define FreeAndNull(p)   free(p); p = 0
1147
1148 #include <nc_alloc.h>
1149
1150 /*
1151  * TTY bit definition for converting tabs to spaces.
1152  */
1153 #ifdef TAB3
1154 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
1155 #else
1156 # ifdef XTABS
1157 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
1158 # else
1159 #  ifdef OXTABS
1160 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
1161 #  else
1162 #   define OFLAGS_TABS 0
1163 #  endif
1164 # endif
1165 #endif
1166
1167 /*
1168  * Standardize/simplify common loops
1169  */
1170 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1171 #define each_window(p) p = _nc_windows; p != 0; p = (p)->next
1172 #define each_ripoff(p) p = ripoff_stack; (p - ripoff_stack) < N_RIPS; ++p
1173
1174 /*
1175  * Prefixes for call/return points of library function traces.  We use these to
1176  * instrument the public functions so that the traces can be easily transformed
1177  * into regression scripts.
1178  */
1179 #define T_CALLED(fmt) "called {" fmt
1180 #define T_CREATE(fmt) "create :" fmt
1181 #define T_RETURN(fmt) "return }" fmt
1182
1183 #ifdef TRACE
1184
1185 #if USE_REENTRANT
1186 #define TPUTS_TRACE(s)  _nc_set_tputs_trace(s);
1187 #else
1188 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
1189 #endif
1190
1191 #define START_TRACE() \
1192         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1193             int t = _nc_getenv_num("NCURSES_TRACE"); \
1194             if (t >= 0) \
1195                 trace((unsigned) t); \
1196         }
1197
1198 /*
1199  * Many of the _tracef() calls use static buffers; lock the trace state before
1200  * trying to fill them.
1201  */
1202 #if USE_REENTRANT
1203 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1204 extern NCURSES_EXPORT(int)      _nc_use_tracef (unsigned);
1205 extern NCURSES_EXPORT(void)     _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1206 #else
1207 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1208 #define _nc_locked_tracef _tracef
1209 #endif
1210
1211 #define TR(n, a)        if (USE_TRACEF(n)) _nc_locked_tracef a
1212 #define T(a)            TR(TRACE_CALLS, a)
1213 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1214
1215 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
1216 #define returnBits(code)        TRACE_RETURN(code,unsigned)
1217 #define returnBool(code)        TRACE_RETURN(code,bool)
1218 #define returnCPtr(code)        TRACE_RETURN(code,cptr)
1219 #define returnCVoidPtr(code)    TRACE_RETURN(code,cvoid_ptr)
1220 #define returnChar(code)        TRACE_RETURN(code,chtype)
1221 #define returnCode(code)        TRACE_RETURN(code,int)
1222 #define returnPtr(code)         TRACE_RETURN(code,ptr)
1223 #define returnSP(code)          TRACE_RETURN(code,sp)
1224 #define returnVoid              T((T_RETURN(""))); return
1225 #define returnVoidPtr(code)     TRACE_RETURN(code,void_ptr)
1226 #define returnWin(code)         TRACE_RETURN(code,win)
1227
1228 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (NCURSES_BOOL);
1229 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1230 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
1231 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
1232 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
1233 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
1234 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(TTY *tty);
1235 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
1236 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
1237 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
1238 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
1239 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
1240 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
1241 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
1242 extern NCURSES_EXPORT(void)             _nc_fifo_dump (SCREEN *);
1243
1244 #if USE_REENTRANT
1245 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1246 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1247 #define _nc_outchars       NCURSES_PUBLIC_VAR(_nc_outchars())
1248 #define _nc_tputs_trace    NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1249 extern NCURSES_EXPORT(void)             _nc_set_tputs_trace (const char *);
1250 extern NCURSES_EXPORT(void)             _nc_count_outchars (long);
1251 #else
1252 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1253 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
1254 #endif
1255
1256 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
1257
1258 #if USE_WIDEC_SUPPORT
1259 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1260 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1261 #endif
1262
1263 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1264 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1265
1266 #else /* !TRACE */
1267
1268 #define START_TRACE() /* nothing */
1269
1270 #define T(a)
1271 #define TR(n, a)
1272 #define TPUTS_TRACE(s)
1273
1274 #define returnAttr(code)        return code
1275 #define returnBits(code)        return code
1276 #define returnBool(code)        return code
1277 #define returnCPtr(code)        return code
1278 #define returnCVoidPtr(code)    return code
1279 #define returnChar(code)        return code
1280 #define returnCode(code)        return code
1281 #define returnPtr(code)         return code
1282 #define returnSP(code)          return code
1283 #define returnVoid              return
1284 #define returnVoidPtr(code)     return code
1285 #define returnWin(code)         return code
1286
1287 #endif /* TRACE/!TRACE */
1288
1289 /*
1290  * Return-codes for tgetent() and friends.
1291  */
1292 #define TGETENT_YES  1          /* entry is found */
1293 #define TGETENT_NO   0          /* entry is not found */
1294 #define TGETENT_ERR -1          /* an error occurred */
1295
1296 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1297 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1298
1299 #define empty_module(name) \
1300 extern  NCURSES_EXPORT(void) name (void); \
1301         NCURSES_EXPORT(void) name (void) { }
1302
1303 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1304 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1305 #define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)
1306
1307 #define toggle_attr_on(S,at) {\
1308    if (PAIR_NUMBER(at) > 0) {\
1309       (S) = ((S) & ALL_BUT_COLOR) | (at);\
1310    } else {\
1311       (S) |= (at);\
1312    }\
1313    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1314
1315
1316 #define toggle_attr_off(S,at) {\
1317    if (PAIR_NUMBER(at) > 0) {\
1318       (S) &= ~(at|A_COLOR);\
1319    } else {\
1320       (S) &= ~(at);\
1321    }\
1322    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1323
1324 #define DelCharCost(count) \
1325                 ((parm_dch != 0) \
1326                 ? SP->_dch_cost \
1327                 : ((delete_character != 0) \
1328                         ? (SP->_dch1_cost * count) \
1329                         : INFINITY))
1330
1331 #define InsCharCost(count) \
1332                 ((parm_ich != 0) \
1333                 ? SP->_ich_cost \
1334                 : ((enter_insert_mode && exit_insert_mode) \
1335                   ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
1336                   : ((insert_character != 0) \
1337                     ? ((SP->_ich1_cost + SP->_ip_cost) * count) \
1338                     : INFINITY)))
1339
1340 #if USE_XMC_SUPPORT
1341 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) { \
1342                                 attr_t chg = AttrOf(SCREEN_ATTRS(SP)); \
1343                                 VIDATTR(AttrOf(c), GetPair(c)); \
1344                                 if (magic_cookie_glitch > 0 \
1345                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(SP))))) { \
1346                                         T(("%s @%d before glitch %d,%d", \
1347                                                 __FILE__, __LINE__, \
1348                                                 SP->_cursrow, \
1349                                                 SP->_curscol)); \
1350                                         _nc_do_xmc_glitch(chg); \
1351                                 } \
1352                         }
1353 #else
1354 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) \
1355                                 VIDATTR(AttrOf(c), GetPair(c));
1356 #endif
1357
1358 /*
1359  * Macros to make additional parameter to implement wgetch_events()
1360  */
1361 #ifdef NCURSES_WGETCH_EVENTS
1362 #define EVENTLIST_0th(param) param
1363 #define EVENTLIST_1st(param) param
1364 #define EVENTLIST_2nd(param) , param
1365 #else
1366 #define EVENTLIST_0th(param) void
1367 #define EVENTLIST_1st(param) /* nothing */
1368 #define EVENTLIST_2nd(param) /* nothing */
1369 #endif
1370
1371 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1372
1373 #undef  toggle_attr_on
1374 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1375 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1376
1377 #undef  toggle_attr_off
1378 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1379 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1380
1381 #undef  DelCharCost
1382 #define DelCharCost(count) _nc_DelCharCost(count)
1383 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1384
1385 #undef  InsCharCost
1386 #define InsCharCost(count) _nc_InsCharCost(count)
1387 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1388
1389 #undef  UpdateAttrs
1390 #define UpdateAttrs(c) _nc_UpdateAttrs(c)
1391 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (NCURSES_CH_T);
1392
1393 #else
1394
1395 extern NCURSES_EXPORT(void) _nc_expanded (void);
1396
1397 #endif
1398
1399 #if !HAVE_GETCWD
1400 #define getcwd(buf,len) getwd(buf)
1401 #endif
1402
1403 /* charable.c */
1404 #if USE_WIDEC_SUPPORT
1405 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1406 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1407 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1408 #endif
1409
1410 /* comp_captab.c */
1411 typedef struct {
1412         short   nte_name;       /* offset of name to hash on */
1413         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
1414         short   nte_index;      /* index of associated variable in its array */
1415         short   nte_link;       /* index in table of next hash, or -1 */
1416 } name_table_data;
1417
1418 typedef struct
1419 {
1420         short   from;
1421         short   to;
1422         short   source;
1423 } alias_table_data;
1424
1425 /* doupdate.c */
1426 #if USE_XMC_SUPPORT
1427 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1428 #endif
1429
1430 /* hardscroll.c */
1431 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1432 extern NCURSES_EXPORT(void) _nc_linedump (void);
1433 #endif
1434
1435 /* lib_acs.c */
1436 extern NCURSES_EXPORT(void) _nc_init_acs (void);        /* corresponds to traditional 'init_acs()' */
1437 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int);  /* used by 'tack' program */
1438
1439 /* lib_addch.c */
1440 #if USE_WIDEC_SUPPORT
1441 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1442 #endif
1443
1444 /* lib_addstr.c */
1445 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1446 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1447 #endif
1448
1449 /* lib_color.c */
1450 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1451
1452 /* lib_getch.c */
1453 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1454
1455 /* lib_insch.c */
1456 extern NCURSES_EXPORT(int) _nc_insert_ch(WINDOW *, chtype);
1457
1458 /* lib_mvcur.c */
1459 #define INFINITY        1000000 /* cost: too high to use */
1460
1461 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1462 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1463 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1464
1465 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1466
1467 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1468 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1469 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1470
1471 /* lib_mouse.c */
1472 extern NCURSES_EXPORT(int) _nc_has_mouse (void);
1473
1474 /* lib_mvcur.c */
1475 #define INFINITY        1000000 /* cost: too high to use */
1476 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
1477
1478 /* lib_setup.c */
1479 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1480 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1481 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(void);
1482 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1483 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
1484
1485 /* lib_tstp.c */
1486 #if USE_SIGWINCH
1487 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1488 #else
1489 #define _nc_handle_sigwinch(a) /* nothing */
1490 #endif
1491
1492 /* lib_ungetch.c */
1493 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
1494
1495 /* lib_wacs.c */
1496 #if USE_WIDEC_SUPPORT
1497 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1498 #endif
1499
1500 typedef struct {
1501     char *s_head;       /* beginning of the string (may be null) */
1502     char *s_tail;       /* end of the string (may be null) */
1503     size_t s_size;      /* current remaining size available */
1504     size_t s_init;      /* total size available */
1505 } string_desc;
1506
1507 /* strings.c */
1508 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1509 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1510 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1511 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1512 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1513
1514 #if !HAVE_STRSTR
1515 #define strstr _nc_strstr
1516 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1517 #endif
1518
1519 /* safe_sprintf.c */
1520 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1521
1522 /* tries.c */
1523 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1524 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1525 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1526 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1527
1528 /* elsewhere ... */
1529 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry(ENTRY *, TERMTYPE *);
1530 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1531 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1532 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1533 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1534 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1535 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1536 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1537 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1538 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1539 extern NCURSES_EXPORT(int) _nc_outch (int);
1540 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1541 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1542 extern NCURSES_EXPORT(int) _nc_timed_wait(SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1543 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, int (*)(int));
1544 extern NCURSES_EXPORT(void) _nc_flush (void);
1545 extern NCURSES_EXPORT(void) _nc_free_entry(ENTRY *, TERMTYPE *);
1546 extern NCURSES_EXPORT(void) _nc_freeall (void);
1547 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1548 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1549 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1550 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1551 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1552 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1553 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1554 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1555 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1556 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1557
1558 #if NO_LEAKS
1559 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1560 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1561 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1562 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1563 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1564 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1565 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1566 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1567 #endif
1568
1569 #ifndef USE_TERMLIB
1570 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1571 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1572 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1573 #endif
1574
1575 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1576 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1577 #endif
1578
1579 #if USE_SIZECHANGE
1580 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1581 #endif
1582
1583 #if HAVE_RESIZETERM
1584 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1585 #else
1586 #define _nc_resize_margins(wp) /* nothing */
1587 #endif
1588
1589 #ifdef NCURSES_WGETCH_EVENTS
1590 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1591 #else
1592 #define wgetch_events(win, evl) wgetch(win)
1593 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1594 #endif
1595
1596 /*
1597  * Not everyone has vsscanf(), but we'd like to use it for scanw().
1598  */
1599 #if !HAVE_VSSCANF
1600 extern int vsscanf(const char *str, const char *format, va_list __arg);
1601 #endif
1602
1603 /* scroll indices */
1604 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1605
1606 #define USE_SETBUF_0 0
1607
1608 #define NC_BUFFERED(flag) _nc_set_buffer(SP->_ofp, flag)
1609
1610 #define NC_OUTPUT ((SP != 0) ? SP->_ofp : stdout)
1611
1612 /*
1613  * On systems with a broken linker, define 'SP' as a function to force the
1614  * linker to pull in the data-only module with 'SP'.
1615  */
1616 #if BROKEN_LINKER
1617 #define SP _nc_screen()
1618 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1619 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1620 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1621 #else
1622 /* current screen is private data; avoid possible linking conflicts too */
1623 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1624 #define _nc_alloc_screen() ((SP = typeCalloc(SCREEN, 1)) != 0)
1625 #define _nc_set_screen(sp) SP = sp
1626 #endif
1627
1628 /*
1629  * We don't want to use the lines or columns capabilities internally, because
1630  * if the application is running multiple screens under X, it's quite possible
1631  * they could all have type xterm but have different sizes!  So...
1632  */
1633 #define screen_lines    SP->_lines
1634 #define screen_columns  SP->_columns
1635
1636 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1637
1638 /*
1639  * Some constants related to SLK's
1640  */
1641 #define MAX_SKEY_OLD       8    /* count of soft keys */
1642 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
1643 #define MAX_SKEY_PC       12    /* This is what most PC's have */
1644 #define MAX_SKEY_LEN_PC    5
1645
1646 /* Macro to check whether or not we use a standard format */
1647 #define SLK_STDFMT(fmt) (fmt < 3)
1648 /* Macro to determine height of label window */
1649 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1650
1651 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1652 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1653
1654 extern NCURSES_EXPORT(int) _nc_ripoffline (int line, int (*init)(WINDOW *,int));
1655
1656 /*
1657  * Common error messages
1658  */
1659 #define MSG_NO_MEMORY "Out of memory"
1660 #define MSG_NO_INPUTS "Premature EOF"
1661
1662 #ifdef __cplusplus
1663 }
1664 #endif
1665
1666 #endif /* CURSES_PRIV_H */