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