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