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