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