ncurses 6.2 - patch 20200906
[ncurses.git] / ncurses / curses.priv.h
1 /****************************************************************************
2  * Copyright 2018-2019,2020 Thomas E. Dickey                                *
3  * Copyright 1998-2017,2018 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Thomas E. Dickey                        1996-on                 *
34  *     and: Juergen Pfeifer                                                 *
35  ****************************************************************************/
36
37 /*
38  * $Id: curses.priv.h,v 1.636 2020/09/06 20:53:41 tom Exp $
39  *
40  *      curses.priv.h
41  *
42  *      Header file for curses library objects which are private to
43  *      the library.
44  *
45  */
46
47 #ifndef CURSES_PRIV_H
48 #define CURSES_PRIV_H 1
49 /* *INDENT-OFF* */
50
51 #include <ncurses_dll.h>
52
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 #include <ncurses_cfg.h>
58
59 #if USE_RCS_IDS
60 #define MODULE_ID(id) static const char Ident[] = id;
61 #else
62 #define MODULE_ID(id) /*nothing*/
63 #endif
64
65 #include <stddef.h>             /* for offsetof */
66 #include <stdlib.h>
67 #include <string.h>
68 #include <sys/types.h>
69 #include <sys/stat.h>
70
71 #if HAVE_UNISTD_H
72 #include <unistd.h>
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 #if defined __hpux
87 #  ifndef EILSEQ
88 #    define EILSEQ 47
89 #  endif
90 #endif
91
92 #ifndef PATH_MAX
93 # if defined(_POSIX_PATH_MAX)
94 #  define PATH_MAX _POSIX_PATH_MAX
95 # elif defined(MAXPATHLEN)
96 #  define PATH_MAX MAXPATHLEN
97 # else
98 #  define PATH_MAX 255  /* the Posix minimum path-size */
99 # endif
100 #endif
101
102 #if DECL_ERRNO
103 extern int errno;
104 #endif
105
106 /* Some Windows related defines */
107 #undef _NC_WINDOWS
108 #if (defined(_WIN32) || defined(_WIN64))
109 #define _NC_WINDOWS
110 #else
111 #undef EXP_WIN32_DRIVER
112 #endif
113
114 #undef _NC_MINGW
115 #if (defined(__MINGW32__) || defined(__MINGW64__))
116 #define _NC_MINGW
117 #endif
118
119 #undef _NC_MSC
120 #ifdef _MSC_VER
121 #define _NC_MSC
122 #endif
123
124 /* Some systems have a broken 'select()', but workable 'poll()'.  Use that */
125 #if HAVE_WORKING_POLL
126 #define USE_FUNC_POLL 1
127 #if HAVE_POLL_H
128 #include <poll.h>
129 #else
130 #include <sys/poll.h>
131 #endif
132 #else
133 #define USE_FUNC_POLL 0
134 #endif
135
136 #if HAVE_INTTYPES_H
137 # include <inttypes.h>
138 #else
139 # if HAVE_STDINT_H
140 #  include <stdint.h>
141 # endif
142 #endif
143
144 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
145 #include <signal.h>
146
147 /* Alessandro Rubini's GPM (general-purpose mouse) */
148 #if HAVE_LIBGPM && HAVE_GPM_H
149 #define USE_GPM_SUPPORT 1
150 #else
151 #define USE_GPM_SUPPORT 0
152 #endif
153
154 /* QNX mouse support */
155 #if defined(__QNX__) && !defined(__QNXNTO__)
156 #define USE_QNX_MOUSE 1
157 #else
158 #define USE_QNX_MOUSE 0
159 #endif
160
161 /* EMX mouse support */
162 #ifdef __EMX__
163 #define USE_EMX_MOUSE 1
164 #else
165 #define USE_EMX_MOUSE 0
166 #endif
167
168 /* kLIBC keyboard/mouse support */
169 #if defined(__OS2__) && defined(__KLIBC__)
170 #define USE_KLIBC_KBD   1
171 #define USE_KLIBC_MOUSE 1
172 #else
173 #define USE_KLIBC_KBD   0
174 #define USE_KLIBC_MOUSE 0
175 #endif
176
177 #define DEFAULT_MAXCLICK 166
178 #define EV_MAX          8       /* size of mouse circular event queue */
179
180 /*
181  * If we don't have signals to support it, don't add a sigwinch handler.
182  * In any case, resizing is an extended feature.  Use it if we've got it.
183  */
184 #if !NCURSES_EXT_FUNCS
185 #undef HAVE_SIZECHANGE
186 #define HAVE_SIZECHANGE 0
187 #endif
188
189 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
190 #define USE_SIZECHANGE 1
191 #else
192 #define USE_SIZECHANGE 0
193 #undef USE_SIGWINCH
194 #define USE_SIGWINCH 0
195 #endif
196
197 /*
198  * When building in the MSYS2 environment, the automatic discovery of
199  * the path separator in configure doesn't work properly. So, if building
200  * for MinGW, we enforce the correct Windows PATH separator
201  */
202 #if defined(_NC_WINDOWS)
203 #  ifdef NCURSES_PATHSEP
204 #    undef NCURSES_PATHSEP
205 #  endif
206 #  define NCURSES_PATHSEP ';'
207 #endif
208
209 /*
210  * If desired, one can configure this, disabling environment variables that
211  * point to custom terminfo/termcap locations.
212  */
213 #ifdef USE_ROOT_ENVIRON
214 #define use_terminfo_vars() 1
215 #else
216 #define use_terminfo_vars() _nc_env_access()
217 extern NCURSES_EXPORT(int) _nc_env_access (void);
218 #endif
219
220 /*
221  * Not all platforms have memmove; some have an equivalent bcopy.  (Some may
222  * have neither).
223  */
224 #if USE_OK_BCOPY
225 #define memmove(d,s,n) bcopy(s,d,n)
226 #elif USE_MY_MEMMOVE
227 #define memmove(d,s,n) _nc_memmove(d,s,n)
228 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
229 #endif
230
231 /*
232  * If we have va_copy(), use it for assigning va_list's.
233  */
234 #if defined(HAVE___VA_COPY)
235 #define begin_va_copy(dst,src)  __va_copy(dst, src)
236 #define end_va_copy(dst)        va_end(dst)
237 #elif defined(va_copy) || defined(HAVE_VA_COPY)
238 #define begin_va_copy(dst,src)  va_copy(dst, src)
239 #define end_va_copy(dst)        va_end(dst)
240 #else
241 #define begin_va_copy(dst,src) (dst) = (src)
242 #define end_va_copy(dst)        /* nothing */
243 #endif
244
245 /*
246  * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
247  * lack one or the other.
248  */
249 #ifndef S_ISDIR
250 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
251 #endif
252
253 #ifndef S_ISREG
254 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
255 #endif
256
257 /*
258  * POSIX ignores the "b", which c89 specified.  Some very old systems do not
259  * accept it.
260  */
261 #if USE_FOPEN_BIN_R
262 #define BIN_R   "rb"
263 #define BIN_W   "wb"
264 #else
265 #define BIN_R   "r"
266 #define BIN_W   "w"
267 #endif
268
269 /*
270  * Scroll hints are useless when hashmap is used
271  */
272 #if !USE_SCROLL_HINTS
273 #if !USE_HASHMAP
274 #define USE_SCROLL_HINTS 1
275 #else
276 #define USE_SCROLL_HINTS 0
277 #endif
278 #endif
279
280 #if USE_SCROLL_HINTS
281 #define if_USE_SCROLL_HINTS(stmt) stmt
282 #else
283 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
284 #endif
285
286 #include <nc_string.h>
287
288 /*
289  * Options for terminal drivers, etc...
290  */
291 #ifdef USE_TERM_DRIVER
292 #define NO_TERMINAL "unknown"
293 #define USE_SP_RIPOFF     1
294 #define USE_SP_TERMTYPE   1
295 #define USE_SP_WINDOWLIST 1
296 #else
297 #define NO_TERMINAL 0
298 #endif
299
300 #define CHECK_TERM_ENV(term_env, no_terminal) \
301         (term_env = (NonEmpty(term_env) \
302                      ? term_env \
303                      : no_terminal), \
304          !NonEmpty(term_env))
305
306 /*
307  * Note:  ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
308  * when we're throwing control codes at the screen at high volume.  To see
309  * this, re-enable USE_HARD_TABS and run worm for a while.  Other systems
310  * probably don't want to define this either due to uncertainties about tab
311  * delays and expansion in raw mode.
312  */
313
314 #define TRIES struct tries
315 typedef TRIES {
316         TRIES    *child;            /* ptr to child.  NULL if none          */
317         TRIES    *sibling;          /* ptr to sibling.  NULL if none        */
318         unsigned char    ch;        /* character at this node               */
319         unsigned short   value;     /* code of string so far.  0 if none.   */
320 #undef TRIES
321 } TRIES;
322
323 /*
324  * Common/troublesome character definitions
325  */
326 #define StringOf(ch) {ch, 0}
327
328 #define L_BRACE '{'
329 #define R_BRACE '}'
330 #define S_QUOTE '\''
331 #define D_QUOTE '"'
332
333 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
334
335 /*
336  * Structure for palette tables
337  */
338
339 #define MAXCOLUMNS    135
340 #define MAXLINES      66
341 #define FIFO_SIZE     MAXCOLUMNS+2  /* for nocbreak mode input */
342
343 #define ACS_LEN       128
344
345 #define WINDOWLIST struct _win_list
346
347 #if USE_WIDEC_SUPPORT
348 #define _nc_bkgd    _bkgrnd
349 #else
350 #undef _XOPEN_SOURCE_EXTENDED
351 #undef _XPG5
352 #define _nc_bkgd    _bkgd
353 #define wgetbkgrnd(win, wch)    ((*wch = win->_bkgd) != 0 ? OK : ERR)
354 #define wbkgrnd     wbkgd
355 #endif
356
357 #undef NCURSES_OPAQUE
358 #define NCURSES_INTERNALS 1
359 #define NCURSES_OPAQUE 0
360
361 #include <curses.h>     /* we'll use -Ipath directive to get the right one! */
362
363 #if !(defined(NCURSES_WGETCH_EVENTS) && defined(NEED_KEY_EVENT))
364 #undef KEY_EVENT                /* reduce compiler-warnings with Visual C++ */
365 #endif
366
367 typedef struct
368 {
369     int red, green, blue;       /* what color_content() returns */
370     int r, g, b;                /* params to init_color() */
371     int init;                   /* true if we called init_color() */
372 }
373 color_t;
374
375 typedef union {
376     struct {
377         unsigned char red;
378         unsigned char green;
379         unsigned char blue;
380     } bits;                     /* bits per color-value in RGB */
381     unsigned value;
382 } rgb_bits_t;
383
384 /*
385  * If curses.h did not expose the SCREEN-functions, then we do not need the
386  * parameter in the corresponding unextended functions.
387  */
388
389 #define USE_SP_FUNC_SUPPORT     NCURSES_SP_FUNCS
390 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
391
392 #if NCURSES_SP_FUNCS
393 #define SP_PARM         sp      /* use parameter */
394 #define NCURSES_SP_ARG          SP_PARM
395 #define NCURSES_SP_DCL  SCREEN *NCURSES_SP_ARG
396 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
397 #define NCURSES_SP_ARGx         NCURSES_SP_ARG,
398 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
399 #else
400 #define SP_PARM         SP      /* use global variable */
401 #define NCURSES_SP_ARG
402 #define NCURSES_SP_DCL
403 #define NCURSES_SP_DCL0 void
404 #define NCURSES_SP_ARGx
405 #define NCURSES_SP_DCLx
406 #endif
407
408 #include <nc_panel.h>
409
410 #include <term.h>
411 #include <nc_termios.h>
412
413 #define IsPreScreen(sp)      (((sp) != 0) && sp->_prescreen)
414 #define HasTerminal(sp)      (((sp) != 0) && (0 != ((sp)->_term)))
415 #define IsValidScreen(sp)    (HasTerminal(sp) && !IsPreScreen(sp))
416
417 #if USE_REENTRANT
418 #define CurTerm              _nc_prescreen._cur_term
419 #else
420 #define CurTerm              cur_term
421 #endif
422
423 #if NCURSES_SP_FUNCS
424 #define TerminalOf(sp)       ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
425 #else
426 #define TerminalOf(sp)       CurTerm
427 #endif
428
429 /*
430  * The legacy layout for TERMTYPE uses "short" for all of the numbers.  Moving
431  * past that, numeric capabilities can be "int" by using a TERMTYPE2 structure
432  * in TERMINAL, and doing most of the internal work using TERMTYPE2.  There are
433  * a few places (mostly to expose the legacy layout) where the distinction
434  * needs attention.
435  */
436 #if NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR
437 #define NCURSES_EXT_NUMBERS  1
438 #define NCURSES_INT2         int
439 #define SIZEOF_INT2          4
440 #define TerminalType(tp)     (tp)->type2
441 #else
442 #define NCURSES_EXT_NUMBERS  0
443 #define NCURSES_INT2         short
444 #define SIZEOF_INT2          2
445 #define TerminalType(tp)     (tp)->type
446 #endif
447
448 #define SIZEOF_SHORT         2
449
450 #ifdef CUR
451 #undef CUR
452 #define CUR TerminalType(cur_term).
453 #endif
454
455 /*
456  * Reduce dependency on cur_term global by using terminfo data from SCREEN's
457  * pointer to this data.
458  */
459 #ifdef USE_SP_TERMTYPE
460 #undef CUR
461 #endif
462
463 #define SP_TERMTYPE TerminalType(TerminalOf(sp)).
464
465 #include <term_entry.h>
466
467 #include <nc_tparm.h>
468
469 /*
470  * Simplify ifdef's for the "*_ATTR" macros in case italics are not configured.
471  */
472 #if defined(A_ITALIC) && defined(exit_italics_mode)
473 #define USE_ITALIC 1
474 #else
475 #define USE_ITALIC 0
476 #undef  A_ITALIC
477 #define A_ITALIC 0
478 #endif
479
480 /*
481  * Use these macros internally, to make tracing less verbose.  But leave the
482  * option for compiling the tracing into the library.
483  */
484 #if 1
485 #define ColorPair(n)            (NCURSES_BITS(n, 0) & A_COLOR)
486 #define PairNumber(a)           (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
487 #else
488 #define ColorPair(pair)         COLOR_PAIR(pair)
489 #define PairNumber(attr)        PAIR_NUMBER(attr)
490 #endif
491
492 #define unColor(n)              unColor2(AttrOf(n))
493 #define unColor2(a)             ((a) & ALL_BUT_COLOR)
494
495 /*
496  * Extended-colors stores the color pair in a separate struct-member than the
497  * attributes.  But for compatibility, we handle most cases where a program
498  * written for non-extended colors stores the color in the attributes by
499  * checking for a color pair in both places.
500  */
501 #if NCURSES_EXT_COLORS
502 #define if_EXT_COLORS(stmt)     stmt
503 #define SetPair(value,p)        SetPair2((value).ext_color, AttrOf(value), p)
504 #define SetPair2(c,a,p)         c = (p), \
505                                 a = (unColor2(a) | ColorPair(oldColor(c)))
506 #define GetPair(value)          GetPair2((value).ext_color, AttrOf(value))
507 #define GetPair2(c,a)           ((c) ? (c) : PairNumber(a))
508 #define oldColor(p)             (((p) > 255) ? 255 : (p))
509 #define GET_WINDOW_PAIR(w)      GetPair2((w)->_color, (w)->_attrs)
510 #define SET_WINDOW_PAIR(w,p)    (w)->_color = (p)
511 #define SameAttrOf(a,b)         (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
512
513 #define VIDPUTS(sp,attr,pair)   do { \
514                                     int vid_pair = pair; \
515                                     NCURSES_SP_NAME(vid_puts)( \
516                                         NCURSES_SP_ARGx attr, \
517                                         (NCURSES_PAIRS_T) pair, \
518                                         &vid_pair, \
519                                         NCURSES_OUTC_FUNC); \
520                                 } while (0)
521
522 #else /* !NCURSES_EXT_COLORS */
523
524 #define if_EXT_COLORS(stmt)     /* nothing */
525 #define SetPair(value,p)        RemAttr(value, A_COLOR), \
526                                 SetAttr(value, AttrOf(value) | ColorPair(p))
527 #define GetPair(value)          PairNumber(AttrOf(value))
528 #define GET_WINDOW_PAIR(w)      PairNumber(WINDOW_ATTRS(w))
529 #define SET_WINDOW_PAIR(w,p)    WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
530                                 WINDOW_ATTRS(w) |= ColorPair(p)
531 #define SameAttrOf(a,b)         (AttrOf(a) == AttrOf(b))
532
533 #define VIDPUTS(sp,attr,pair)   NCURSES_SP_NAME(vidputs)(NCURSES_SP_ARGx attr, NCURSES_OUTC_FUNC)
534
535 #endif /* NCURSES_EXT_COLORS */
536
537 #define NCURSES_OUTC_FUNC       NCURSES_SP_NAME(_nc_outch)
538 #define NCURSES_PUTP2(name,value)    NCURSES_SP_NAME(_nc_putp)(NCURSES_SP_ARGx name, value)
539 #define NCURSES_PUTP2_FLUSH(name,value)    NCURSES_SP_NAME(_nc_putp_flush)(NCURSES_SP_ARGx name, value)
540
541 #if NCURSES_NO_PADDING
542 #define GetNoPadding(sp)        ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
543 #define SetNoPadding(sp)        _nc_set_no_padding(sp)
544 extern NCURSES_EXPORT(void)     _nc_set_no_padding(SCREEN *);
545 #else
546 #define GetNoPadding(sp)        FALSE
547 #define SetNoPadding(sp)        /*nothing*/
548 #endif
549
550 #define WINDOW_ATTRS(w)         ((w)->_attrs)
551
552 #define SCREEN_ATTRS(s)         (*((s)->_current_attr))
553 #define GET_SCREEN_PAIR(s)      GetPair(SCREEN_ATTRS(s))
554 #define SET_SCREEN_PAIR(s,p)    SetPair(SCREEN_ATTRS(s), p)
555
556 #if USE_REENTRANT || NCURSES_SP_FUNCS
557 NCURSES_EXPORT(int *)        _nc_ptr_Lines (SCREEN *);
558 NCURSES_EXPORT(int *)        _nc_ptr_Cols (SCREEN *);
559 NCURSES_EXPORT(int *)        _nc_ptr_Tabsize (SCREEN *);
560 NCURSES_EXPORT(int *)        _nc_ptr_Escdelay (SCREEN *);
561 #endif
562
563 #if USE_REENTRANT
564
565 #define ptrLines(sp)         (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
566 #define ptrCols(sp)          (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
567 #define ptrTabsize(sp)       (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
568 #define ptrEscdelay(sp)      (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
569
570 #define SET_LINES(value)     *_nc_ptr_Lines(SP_PARM) = value
571 #define SET_COLS(value)      *_nc_ptr_Cols(SP_PARM) = value
572 #define SET_TABSIZE(value)   *_nc_ptr_Tabsize(SP_PARM) = value
573 #define SET_ESCDELAY(value)  *_nc_ptr_Escdelay(SP_PARM) = value
574
575 #else
576
577 #define ptrLines(sp)         &LINES
578 #define ptrCols(sp)          &COLS
579 #define ptrTabsize(sp)       &TABSIZE
580 #define ptrEscdelay(sp)      &ESCDELAY
581
582 #define SET_LINES(value)     LINES = value
583 #define SET_COLS(value)      COLS = value
584 #define SET_TABSIZE(value)   TABSIZE = value
585 #define SET_ESCDELAY(value)  ESCDELAY = value
586
587 #endif
588
589 #define HasHardTabs()   (NonEmpty(clear_all_tabs) && NonEmpty(set_tab))
590
591 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
592             __FILE__, __LINE__, \
593             (unsigned long) (pthread_self()), \
594             data.__data.__lock, \
595             data.__data.__count, \
596             data.__data.__owner, \
597             data.__data.__kind, \
598             (data.__data.__nusers > 5) ? " OOPS " : "", \
599             data.__data.__nusers)
600 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
601
602 #if USE_WEAK_SYMBOLS
603 #if defined(__GNUC__)
604 #  if defined __USE_ISOC99
605 #    define _cat_pragma(exp)    _Pragma(#exp)
606 #    define _weak_pragma(exp)   _cat_pragma(weak name)
607 #  else
608 #    define _weak_pragma(exp)
609 #  endif
610 #  define _declare(name)        __extension__ extern __typeof__(name) name
611 #  define weak_symbol(name)     _weak_pragma(name) _declare(name) __attribute__((weak))
612 #else
613 #  undef USE_WEAK_SYMBOLS
614 #  define USE_WEAK_SYMBOLS 0
615 #endif
616 #endif
617
618 #ifdef USE_PTHREADS
619
620 #if USE_REENTRANT
621 #include <pthread.h>
622 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
623 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
624 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
625 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
626 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
627 #define _nc_lock_global(name)   _nc_mutex_lock(&_nc_globals.mutex_##name)
628 #define _nc_try_global(name)    _nc_mutex_trylock(&_nc_globals.mutex_##name)
629 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
630
631 #else
632 #error POSIX threads requires --enable-reentrant option
633 #endif
634
635 #ifdef USE_PTHREADS
636 #  if USE_WEAK_SYMBOLS
637 weak_symbol(pthread_sigmask);
638 weak_symbol(pthread_kill);
639 weak_symbol(pthread_self);
640 weak_symbol(pthread_equal);
641 weak_symbol(pthread_mutex_init);
642 weak_symbol(pthread_mutex_lock);
643 weak_symbol(pthread_mutex_unlock);
644 weak_symbol(pthread_mutex_trylock);
645 weak_symbol(pthread_mutexattr_settype);
646 weak_symbol(pthread_mutexattr_init);
647 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
648 #    undef  sigprocmask
649 #    define sigprocmask(a, b, c) _nc_sigprocmask(a, b, c)
650 #    define GetThreadID() (((pthread_self)) ? pthread_self() : (pthread_t) getpid())
651 #  else
652 #    define GetThreadID() pthread_self()
653 #  endif
654 #endif
655
656 #if HAVE_NANOSLEEP
657 #undef HAVE_NANOSLEEP
658 #define HAVE_NANOSLEEP 0        /* nanosleep suspends all threads */
659 #endif
660
661 #else /* !USE_PTHREADS */
662
663 #if USE_PTHREADS_EINTR
664 #  if USE_WEAK_SYMBOLS
665 #include <pthread.h>
666 weak_symbol(pthread_sigmask);
667 weak_symbol(pthread_kill);
668 weak_symbol(pthread_self);
669 weak_symbol(pthread_equal);
670 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
671 #    undef  sigprocmask
672 #    define sigprocmask(a, b, c) _nc_sigprocmask(a, b, c)
673 #  endif
674 #endif /* USE_PTHREADS_EINTR */
675
676 #define _nc_init_pthreads()     /* nothing */
677 #define _nc_mutex_init(obj)     /* nothing */
678
679 #define _nc_lock_global(name)   /* nothing */
680 #define _nc_try_global(name)    0
681 #define _nc_unlock_global(name) /* nothing */
682
683 #endif /* USE_PTHREADS */
684
685 /*
686  * When using sp-funcs, locks are targeted to SCREEN-level granularity.
687  * So the locking is done in the non-sp-func (which calls the sp-func) rather
688  * than in the sp-func itself.
689  *
690  * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
691  * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
692  */
693 #if NCURSES_SP_FUNCS
694
695 #define _nc_nonsp_lock_global(name)     /* nothing */
696 #define _nc_nonsp_try_global(name)    0
697 #define _nc_nonsp_unlock_global(name)   /* nothing */
698
699 #define _nc_sp_lock_global(name)        _nc_lock_global(name)
700 #define _nc_sp_try_global(name)         _nc_try_global(name)
701 #define _nc_sp_unlock_global(name)      _nc_unlock_global(name)
702
703 #else
704
705 #define _nc_nonsp_lock_global(name)     _nc_lock_global(name)
706 #define _nc_nonsp_try_global(name)      _nc_try_global(name)
707 #define _nc_nonsp_unlock_global(name)   _nc_unlock_global(name)
708
709 #define _nc_sp_lock_global(name)        /* nothing */
710 #define _nc_sp_try_global(name)    0
711 #define _nc_sp_unlock_global(name)      /* nothing */
712
713 #endif
714
715 #if HAVE_GETTIMEOFDAY
716 # define PRECISE_GETTIME 1
717 # define TimeType struct timeval
718 #else
719 # define PRECISE_GETTIME 0
720 # define TimeType time_t
721 #endif
722
723 /*
724  * Definitions for color pairs
725  */
726
727 #define MAX_OF_TYPE(t)   (int)(((unsigned t)(~0))>>1)
728
729 #include <new_pair.h>
730
731 #define isDefaultColor(c)       ((c) < 0)
732 #define COLOR_DEFAULT           -1
733
734 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
735
736 #undef NCURSES_CH_T             /* this is not a termlib feature */
737 #define NCURSES_CH_T void       /* ...but we need a pointer in SCREEN */
738
739 #endif  /* USE_TERMLIB */
740
741 #ifndef USE_TERMLIB
742 struct ldat
743 {
744         NCURSES_CH_T    *text;          /* text of the line */
745         NCURSES_SIZE_T  firstchar;      /* first changed character in the line */
746         NCURSES_SIZE_T  lastchar;       /* last changed character in the line */
747         NCURSES_SIZE_T  oldindex;       /* index of the line at last update */
748 };
749 #endif  /* USE_TERMLIB */
750
751 typedef enum {
752         M_XTERM = -1            /* use xterm's mouse tracking? */
753         ,M_NONE = 0             /* no mouse device */
754 #if USE_GPM_SUPPORT
755         ,M_GPM                  /* use GPM */
756 #endif
757 #if USE_SYSMOUSE
758         ,M_SYSMOUSE             /* FreeBSD sysmouse on console */
759 #endif
760 #ifdef USE_TERM_DRIVER
761         ,M_TERM_DRIVER          /* Win32 console, etc */
762 #endif
763 } MouseType;
764
765 typedef enum {
766         MF_X10 = 0              /* conventional 3-byte format */
767         , MF_SGR1006            /* xterm private mode 1006, SGR-style */
768 #ifdef EXP_XTERM_1005
769         , MF_XTERM_1005         /* xterm UTF-8 private mode 1005 */
770 #endif
771 } MouseFormat;
772
773 /*
774  * Structures for scrolling.
775  */
776
777 typedef struct {
778         unsigned long hashval;
779         int oldcount, newcount;
780         int oldindex, newindex;
781 } HASHMAP;
782
783 /*
784  * Structures for soft labels.
785  */
786
787 struct _SLK;
788
789 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
790
791 typedef struct
792 {
793         char *ent_text;         /* text for the label */
794         char *form_text;        /* formatted text (left/center/...) */
795         int ent_x;              /* x coordinate of this field */
796         char dirty;             /* this label has changed */
797         char visible;           /* field is visible */
798 } slk_ent;
799
800 typedef struct _SLK {
801         bool    dirty;          /* all labels have changed */
802         bool    hidden;         /* soft labels are hidden */
803         WINDOW  *win;
804         slk_ent *ent;
805         short   maxlab;         /* number of available labels */
806         short   labcnt;         /* number of allocated labels */
807         short   maxlen;         /* length of labels */
808         NCURSES_CH_T attr;      /* soft label attribute */
809 } SLK;
810
811 #endif  /* USE_TERMLIB */
812
813 typedef struct {
814         WINDOW *win;            /* the window used in the hook      */
815         int     line;           /* lines to take, < 0 => from bottom*/
816         int     (*hook)(WINDOW *, int); /* callback for user        */
817 } ripoff_t;
818
819 #if USE_GPM_SUPPORT
820 #undef buttons                  /* term.h defines this, and gpm uses it! */
821 #include <gpm.h>
822 #if USE_WEAK_SYMBOLS
823 weak_symbol(Gpm_Wgetch);
824 #endif
825
826 #ifdef HAVE_LIBDL
827 /* link dynamically to GPM */
828 typedef int *TYPE_gpm_fd;
829 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
830 typedef int (*TYPE_Gpm_Close) (void);
831 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
832
833 #define my_gpm_fd       SP_PARM->_mouse_gpm_fd
834 #define my_Gpm_Open     SP_PARM->_mouse_Gpm_Open
835 #define my_Gpm_Close    SP_PARM->_mouse_Gpm_Close
836 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
837 #else
838 /* link statically to GPM */
839 #define my_gpm_fd       &gpm_fd
840 #define my_Gpm_Open     Gpm_Open
841 #define my_Gpm_Close    Gpm_Close
842 #define my_Gpm_GetEvent Gpm_GetEvent
843 #endif /* HAVE_LIBDL */
844 #endif /* USE_GPM_SUPPORT */
845
846 typedef struct {
847     long sequence;
848     bool last_used;
849     char *fix_sgr0;             /* this holds the filtered sgr0 string */
850     char *last_bufp;            /* help with fix_sgr0 leak */
851     TERMINAL *last_term;
852 } TGETENT_CACHE;
853
854 #define TGETENT_MAX 4
855
856 /*
857  * When converting from terminfo to termcap, check for cases where we can trim
858  * octal escapes down to 2-character form.  It is useful for terminfo format
859  * also, but not as important.
860  */
861 #define MAX_TC_FIXUPS   10
862 #define MIN_TC_FIXUPS   4
863
864 #define isoctal(c) ((c) >= '0' && (c) <= '7')
865
866 /*
867  * State of tparm().
868  */
869 #define STACKSIZE 20
870
871 typedef struct {
872         union {
873                 int     num;
874                 char    *str;
875         } data;
876         bool num_type;
877 } STACK_FRAME;
878
879 #define NUM_VARS 26
880
881 typedef struct {
882         const char      *tparam_base;
883
884         STACK_FRAME     stack[STACKSIZE];
885         int             stack_ptr;
886
887         char            *out_buff;
888         size_t          out_size;
889         size_t          out_used;
890
891         char            *fmt_buff;
892         size_t          fmt_size;
893
894         int             dynamic_var[NUM_VARS];
895         int             static_vars[NUM_VARS];
896 #ifdef TRACE
897         const char      *tname;
898 #endif
899 } TPARM_STATE;
900
901 typedef struct {
902     char *text;
903     size_t size;
904 } TRACEBUF;
905
906 /*
907  * The filesystem database normally uses a single-letter for the lower level
908  * of directories.  Use a hexadecimal code for filesystems which do not
909  * preserve mixed-case names.
910  */
911 #if MIXEDCASE_FILENAMES
912 #define LEAF_FMT "%c"
913 #define LEAF_LEN 1
914 #else
915 #define LEAF_FMT "%02x"
916 #define LEAF_LEN 2
917 #endif
918
919 /*
920  * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
921  * could at most have 10 digits, and the mask contains no more than 32 bits
922  * with each bit representing less than 15 characters.  Usually the whole
923  * string is less than 80 columns, but this buffer size is an absolute
924  * limit.
925  */
926 #define TRACEMSE_MAX    (80 + (5 * 10) + (32 * 15))
927 #define TRACEMSE_FMT    "id %2d  at (%2d, %2d, %2d) state %4lx = {" /* } */
928
929 #ifdef USE_TERM_DRIVER
930 struct DriverTCB; /* Terminal Control Block forward declaration */
931 #define INIT_TERM_DRIVER()      _nc_globals.term_driver = _nc_get_driver
932 #else
933 #define INIT_TERM_DRIVER()      /* nothing */
934 #endif
935
936 typedef struct {
937     const char *name;
938     char *value;
939 } ITERATOR_VARS;
940
941 /*
942  * Global data which is not specific to a screen.
943  */
944 typedef struct {
945         SIG_ATOMIC_T    have_sigtstp;
946         SIG_ATOMIC_T    have_sigwinch;
947         SIG_ATOMIC_T    cleanup_nested;
948
949         bool            init_signals;
950         bool            init_screen;
951
952         char            *comp_sourcename;
953         char            *comp_termtype;
954
955         bool            have_tic_directory;
956         bool            keep_tic_directory;
957         const char      *tic_directory;
958
959         char            *dbi_list;
960         int             dbi_size;
961
962         char            *first_name;
963         char            **keyname_table;
964         int             init_keyname;
965
966         int             slk_format;
967
968         int             getstr_limit;   /* getstr_limit based on POSIX LINE_MAX */
969
970         char            *safeprint_buf;
971         size_t          safeprint_used;
972
973         TGETENT_CACHE   tgetent_cache[TGETENT_MAX];
974         int             tgetent_index;
975         long            tgetent_sequence;
976
977         char            *dbd_blob;      /* string-heap for dbd_list[] */
978         char            **dbd_list;     /* distinct places to look for data */
979         int             dbd_size;       /* length of dbd_list[] */
980         time_t          dbd_time;       /* cache last updated */
981         ITERATOR_VARS   dbd_vars[dbdLAST];
982
983 #if HAVE_TSEARCH
984         void            *cached_tparm;
985         int             count_tparm;
986 #endif /* HAVE_TSEARCH */
987
988 #ifdef USE_TERM_DRIVER
989         int             (*term_driver)(struct DriverTCB*, const char*, int*);
990 #endif
991
992 #ifndef USE_SP_WINDOWLIST
993         WINDOWLIST      *_nc_windowlist;
994 #define WindowList(sp)  _nc_globals._nc_windowlist
995 #endif
996
997 #if USE_HOME_TERMINFO
998         char            *home_terminfo;
999 #endif
1000
1001 #if !USE_SAFE_SPRINTF
1002         int             safeprint_cols;
1003         int             safeprint_rows;
1004 #endif
1005
1006 #ifdef USE_PTHREADS
1007         pthread_mutex_t mutex_curses;
1008         pthread_mutex_t mutex_prescreen;
1009         pthread_mutex_t mutex_screen;
1010         pthread_mutex_t mutex_update;
1011         pthread_mutex_t mutex_tst_tracef;
1012         pthread_mutex_t mutex_tracef;
1013         int             nested_tracef;
1014         int             use_pthreads;
1015 #define _nc_use_pthreads        _nc_globals.use_pthreads
1016 #if USE_PTHREADS_EINTR
1017         pthread_t       read_thread;            /* The reading thread */
1018 #endif
1019 #endif
1020 #if USE_WIDEC_SUPPORT
1021         char            key_name[MB_LEN_MAX + 1];
1022 #endif
1023
1024 #ifdef TRACE
1025         bool            trace_opened;
1026         char            trace_fname[PATH_MAX];
1027         int             trace_level;
1028         FILE            *trace_fp;
1029         int             trace_fd;
1030
1031         char            *tracearg_buf;
1032         size_t          tracearg_used;
1033
1034         TRACEBUF        *tracebuf_ptr;
1035         size_t          tracebuf_used;
1036
1037         char            tracechr_buf[40];
1038
1039         char            *tracedmp_buf;
1040         size_t          tracedmp_used;
1041
1042         unsigned char   *tracetry_buf;
1043         size_t          tracetry_used;
1044
1045         char            traceatr_color_buf[2][80];
1046         int             traceatr_color_sel;
1047         int             traceatr_color_last;
1048 #if !defined(USE_PTHREADS) && USE_REENTRANT
1049         int             nested_tracef;
1050 #endif
1051 #endif  /* TRACE */
1052
1053 #if NO_LEAKS
1054         bool            leak_checking;
1055 #endif
1056 } NCURSES_GLOBALS;
1057
1058 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
1059
1060 #define N_RIPS 5
1061
1062 /* The limit reserves one byte for a terminating NUL */
1063 #define my_getstr_limit (_nc_globals.getstr_limit - 1)
1064 #define _nc_getstr_limit(n) \
1065         (((n) < 0) \
1066          ? my_getstr_limit \
1067          : (((n) > my_getstr_limit) \
1068             ? my_getstr_limit \
1069             : (n)))
1070
1071 #ifdef USE_PTHREADS
1072 typedef struct _prescreen_list {
1073         struct _prescreen_list *next;
1074         pthread_t id;
1075         struct screen *sp;
1076 } PRESCREEN_LIST;
1077 #endif
1078
1079 /*
1080  * Global data which can be swept up into a SCREEN when one is created.
1081  * It may be modified before the next SCREEN is created.
1082  */
1083 typedef struct {
1084 #ifdef USE_PTHREADS
1085         PRESCREEN_LIST *allocated;
1086 #else
1087         struct screen * allocated;
1088 #endif
1089         bool            use_env;
1090         bool            filter_mode;
1091         attr_t          previous_attr;
1092         TPARM_STATE     tparm_state;
1093         TTY             *saved_tty;     /* savetty/resetty information      */
1094         bool            use_tioctl;
1095         NCURSES_SP_OUTC _outch;         /* output handler if not putc */
1096 #ifndef USE_SP_RIPOFF
1097         ripoff_t        rippedoff[N_RIPS];
1098         ripoff_t        *rsp;
1099 #endif
1100 #if NCURSES_NO_PADDING
1101         bool            _no_padding;    /* flag to set if padding disabled  */
1102 #endif
1103 #if BROKEN_LINKER || USE_REENTRANT
1104         chtype          *real_acs_map;
1105         int             _LINES;
1106         int             _COLS;
1107         int             _TABSIZE;
1108         int             _ESCDELAY;
1109         TERMINAL        *_cur_term;
1110 #endif
1111 #ifdef TRACE
1112 #if BROKEN_LINKER || USE_REENTRANT
1113         long            _outchars;
1114         const char      *_tputs_trace;
1115 #endif
1116 #endif
1117 } NCURSES_PRESCREEN;
1118
1119 /*
1120  * Use screen-specific ripoff data (for softkeys) rather than global.
1121  */
1122 #ifdef USE_SP_RIPOFF
1123 #define safe_ripoff_sp     (sp)->rsp
1124 #define safe_ripoff_stack  (sp)->rippedoff
1125 #else
1126 #define safe_ripoff_sp     _nc_prescreen.rsp
1127 #define safe_ripoff_stack  _nc_prescreen.rippedoff
1128 #endif
1129
1130 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
1131
1132 typedef enum {
1133     ewInitial = 0,
1134     ewRunning,
1135     ewSuspend
1136 } ENDWIN;
1137
1138 /*
1139  * The SCREEN structure.
1140  */
1141
1142 struct screen {
1143         int             _ifd;           /* input file descriptor for screen */
1144         int             _ofd;           /* output file descriptor for screen */
1145         FILE            *_ofp;          /* output file ptr for screen       */
1146         char            *out_buffer;    /* output buffer                    */
1147         size_t          out_limit;      /* output buffer size               */
1148         size_t          out_inuse;      /* output buffer current use        */
1149         bool            _filtered;      /* filter() was called              */
1150         bool            _prescreen;     /* is in prescreen phase            */
1151         bool            _use_env;       /* LINES & COLS from environment?   */
1152         int             _checkfd;       /* filedesc for typeahead check     */
1153         TERMINAL        *_term;         /* terminal type information        */
1154         TTY             _saved_tty;     /* savetty/resetty information      */
1155         NCURSES_SIZE_T  _lines;         /* screen lines                     */
1156         NCURSES_SIZE_T  _columns;       /* screen columns                   */
1157
1158         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
1159         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
1160
1161         WINDOW          *_curscr;       /* current screen                   */
1162         WINDOW          *_newscr;       /* virtual screen to be updated to  */
1163         WINDOW          *_stdscr;       /* screen's full-window context     */
1164
1165 #define CurScreen(sp)  (sp)->_curscr
1166 #define NewScreen(sp)  (sp)->_newscr
1167 #define StdScreen(sp)  (sp)->_stdscr
1168
1169         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
1170         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
1171         bool            _tried;         /* keypad mode was initialized      */
1172         bool            _keypad_on;     /* keypad mode is currently on      */
1173
1174         bool            _called_wgetch; /* check for recursion in wgetch()  */
1175         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
1176         short           _fifohead,      /* head of fifo queue               */
1177                         _fifotail,      /* tail of fifo queue               */
1178                         _fifopeek,      /* where to peek for next char      */
1179                         _fifohold;      /* set if breakout marked           */
1180
1181         int             _endwin;        /* are we out of window mode?       */
1182         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
1183         int             _coloron;       /* is color enabled?                */
1184         int             _color_defs;    /* are colors modified              */
1185         int             _cursor;        /* visibility of the cursor         */
1186         int             _cursrow;       /* physical cursor row              */
1187         int             _curscol;       /* physical cursor column           */
1188         bool            _notty;         /* true if we cannot switch non-tty */
1189         int             _nl;            /* True if NL -> CR/NL is on        */
1190         int             _raw;           /* True if in raw mode              */
1191         int             _cbreak;        /* 1 if in cbreak mode              */
1192                                         /* > 1 if in halfdelay mode         */
1193         int             _echo;          /* True if echo on                  */
1194         int             _use_meta;      /* use the meta key?                */
1195         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
1196         int             slk_format;     /* selected format for this screen  */
1197         /* cursor movement costs; units are 10ths of milliseconds */
1198         int             _char_padding;  /* cost of character put            */
1199         int             _cr_cost;       /* cost of (carriage_return)        */
1200         int             _cup_cost;      /* cost of (cursor_address)         */
1201         int             _home_cost;     /* cost of (cursor_home)            */
1202         int             _ll_cost;       /* cost of (cursor_to_ll)           */
1203         int             _cub1_cost;     /* cost of (cursor_left)            */
1204         int             _cuf1_cost;     /* cost of (cursor_right)           */
1205         int             _cud1_cost;     /* cost of (cursor_down)            */
1206         int             _cuu1_cost;     /* cost of (cursor_up)              */
1207         int             _cub_cost;      /* cost of (parm_cursor_left)       */
1208         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
1209         int             _cud_cost;      /* cost of (parm_cursor_down)       */
1210         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
1211         int             _hpa_cost;      /* cost of (column_address)         */
1212         int             _vpa_cost;      /* cost of (row_address)            */
1213         /* used in tty_update.c, must be chars */
1214         int             _ed_cost;       /* cost of (clr_eos)                */
1215         int             _el_cost;       /* cost of (clr_eol)                */
1216         int             _el1_cost;      /* cost of (clr_bol)                */
1217         int             _dch1_cost;     /* cost of (delete_character)       */
1218         int             _ich1_cost;     /* cost of (insert_character)       */
1219         int             _dch_cost;      /* cost of (parm_dch)               */
1220         int             _ich_cost;      /* cost of (parm_ich)               */
1221         int             _ech_cost;      /* cost of (erase_chars)            */
1222         int             _rep_cost;      /* cost of (repeat_char)            */
1223         int             _hpa_ch_cost;   /* cost of (column_address)         */
1224         int             _cup_ch_cost;   /* cost of (cursor_address)         */
1225         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
1226         int             _inline_cost;   /* cost of inline-move              */
1227         int             _smir_cost;     /* cost of (enter_insert_mode)      */
1228         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
1229         int             _ip_cost;       /* cost of (insert_padding)         */
1230         /* used in lib_mvcur.c */
1231         char *          _address_cursor;
1232         /* used in tty_update.c */
1233         int             _scrolling;     /* 1 if terminal's smart enough to  */
1234
1235         /* used in lib_color.c */
1236         rgb_bits_t      _direct_color;  /* RGB overrides color-table         */
1237         color_t         *_color_table;  /* screen's color palette            */
1238         int             _color_count;   /* count of colors in palette        */
1239         colorpair_t     *_color_pairs;  /* screen's color pair list          */
1240         int             _pair_count;    /* same as COLOR_PAIRS               */
1241         int             _pair_limit;    /* actual limit of color-pairs       */
1242         int             _pair_alloc;    /* current table-size of color-pairs */
1243         chtype          _ok_attributes; /* valid attributes for terminal     */
1244         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
1245         chtype          _xmc_triggers;  /* attributes to process if xmc      */
1246         chtype *        _acs_map;       /* the real alternate-charset map    */
1247         bool *          _screen_acs_map;
1248
1249
1250         /* used in lib_vidattr.c */
1251         bool            _use_rmso;      /* true if we may use 'rmso'         */
1252         bool            _use_rmul;      /* true if we may use 'rmul'         */
1253
1254         /*
1255          * These data correspond to the state of the idcok() and idlok()
1256          * functions.  A caveat is in order here:  the XSI and SVr4
1257          * documentation specify that these functions apply to the window which
1258          * is given as an argument.  However, ncurses implements this logic
1259          * only for the newscr/curscr update process, _not_ per-window.
1260          */
1261         bool            _nc_sp_idlok;
1262         bool            _nc_sp_idcok;
1263
1264         /*
1265          * These are the data that support the mouse interface.
1266          */
1267         bool            _mouse_initialized;
1268         MouseType       _mouse_type;
1269         int             _maxclick;
1270         bool            (*_mouse_event) (SCREEN *);
1271         bool            (*_mouse_inline)(SCREEN *);
1272         bool            (*_mouse_parse) (SCREEN *, int);
1273         void            (*_mouse_resume)(SCREEN *);
1274         void            (*_mouse_wrap)  (SCREEN *);
1275         int             _mouse_fd;      /* file-descriptor, if any */
1276         bool            _mouse_active;  /* true if initialized */
1277         mmask_t         _mouse_mask;    /* set via mousemask() */
1278         mmask_t         _mouse_mask2;   /* OR's in press/release bits */
1279         mmask_t         _mouse_bstate;
1280         MouseFormat     _mouse_format;  /* type of xterm mouse protocol */
1281         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1282         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
1283         MEVENT          *_mouse_eventp; /* next free slot in event queue */
1284
1285         /*
1286          * These are data that support the proper handling of the panel stack on an
1287          * per screen basis.
1288          */
1289         struct panelhook _panelHook;
1290
1291         bool            _sig_winch;
1292         SCREEN          *_next_screen;
1293
1294         /* hashes for old and new lines */
1295         unsigned long   *oldhash, *newhash;
1296         HASHMAP         *hashtab;
1297         int             hashtab_len;
1298         int             *_oldnum_list;
1299         int             _oldnum_size;
1300
1301         NCURSES_SP_OUTC _outch;         /* output handler if not putc */
1302         NCURSES_OUTC    jump;
1303
1304         ripoff_t        rippedoff[N_RIPS];
1305         ripoff_t        *rsp;
1306
1307         int             _legacy_coding; /* see use_legacy_coding() */
1308
1309 #if NCURSES_NO_PADDING
1310         bool            _no_padding;    /* flag to set if padding disabled  */
1311 #endif
1312
1313 #if USE_HARD_TABS
1314         int             _ht_cost;       /* cost of (tab)                    */
1315         int             _cbt_cost;      /* cost of (backtab)                */
1316 #endif /* USE_HARD_TABS */
1317
1318         /* used in lib_vidattr.c */
1319 #if USE_ITALIC
1320         bool            _use_ritm;      /* true if we may use 'ritm'         */
1321 #endif
1322
1323         /* used in getch/twait */
1324 #if USE_KLIBC_KBD
1325         bool            _extended_key;  /* true if an extended key           */
1326 #endif
1327
1328         /* used in lib_color.c */
1329 #if NCURSES_EXT_FUNCS
1330         bool            _assumed_color; /* use assumed colors                */
1331         bool            _default_color; /* use default colors                */
1332         bool            _has_sgr_39_49; /* has ECMA default color support    */
1333         int             _default_fg;    /* assumed default foreground        */
1334         int             _default_bg;    /* assumed default background        */
1335         int             _default_pairs; /* count pairs using default color   */
1336 #endif
1337
1338         /* system-dependent mouse data */
1339 #if USE_GPM_SUPPORT
1340         bool            _mouse_gpm_loaded;
1341         bool            _mouse_gpm_found;
1342 #ifdef HAVE_LIBDL
1343         void            *_dlopen_gpm;
1344         TYPE_gpm_fd     _mouse_gpm_fd;
1345         TYPE_Gpm_Open   _mouse_Gpm_Open;
1346         TYPE_Gpm_Close  _mouse_Gpm_Close;
1347         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1348 #endif
1349         Gpm_Connect     _mouse_gpm_connect;
1350 #endif /* USE_GPM_SUPPORT */
1351
1352 #if USE_EMX_MOUSE
1353         int             _emxmouse_wfd;
1354         int             _emxmouse_thread;
1355         int             _emxmouse_activated;
1356         char            _emxmouse_buttons[4];
1357 #endif
1358
1359 #if USE_SYSMOUSE
1360         MEVENT          _sysmouse_fifo[FIFO_SIZE];
1361         int             _sysmouse_head;
1362         int             _sysmouse_tail;
1363         int             _sysmouse_char_width;   /* character width */
1364         int             _sysmouse_char_height;  /* character height */
1365         int             _sysmouse_old_buttons;
1366         int             _sysmouse_new_buttons;
1367 #endif
1368
1369 #if defined(USE_TERM_DRIVER) || defined(EXP_WIN32_DRIVER)
1370         MEVENT          _drv_mouse_fifo[FIFO_SIZE];
1371         int             _drv_mouse_head;
1372         int             _drv_mouse_tail;
1373         int             _drv_mouse_old_buttons;
1374         int             _drv_mouse_new_buttons;
1375 #endif
1376         /*
1377          * This supports automatic resizing
1378          */
1379 #if USE_SIZECHANGE
1380         int             (*_resize)(NCURSES_SP_DCLx int y, int x);
1381         int             (*_ungetch)(SCREEN *, int);
1382 #endif
1383
1384 #ifdef USE_SP_WINDOWLIST
1385         WINDOWLIST*     _windowlist;
1386 #define WindowList(sp)  (sp)->_windowlist
1387 #endif
1388
1389 #if USE_REENTRANT
1390         char            _ttytype[NAMESIZE];
1391         int             _ESCDELAY;
1392         int             _TABSIZE;
1393         int             _LINES;
1394         int             _COLS;
1395 #endif
1396
1397 #if NCURSES_SP_FUNCS
1398         bool            use_tioctl;
1399 #endif
1400
1401         /*
1402          * ncurses/ncursesw are the same up to this point.
1403          */
1404 #if USE_WIDEC_SUPPORT
1405         /* recent versions of 'screen' have partially-working support for
1406          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1407          */
1408         bool            _screen_acs_fix;
1409         bool            _screen_unicode;
1410 #endif
1411
1412 #if NCURSES_EXT_FUNCS && NCURSES_EXT_COLORS
1413         void            *_ordered_pairs; /* index used by alloc_pair()       */
1414         int             _pairs_used;    /* actual number of color-pairs used */
1415         int             _recent_pair;   /* number for most recent free-pair  */
1416 #endif
1417
1418 #ifdef TRACE
1419         char            tracechr_buf[40];
1420         char            tracemse_buf[TRACEMSE_MAX];
1421 #if USE_REENTRANT
1422         long            _outchars;
1423         const char      *_tputs_trace;
1424 #endif
1425 #endif
1426 };
1427
1428 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1429 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1430
1431         WINDOWLIST {
1432         WINDOWLIST *next;
1433         SCREEN *screen;         /* screen containing the window */
1434         WINDOW  win;            /* WINDOW_EXT() needs to account for offset */
1435 #if NCURSES_WIDECHAR
1436         char addch_work[(MB_LEN_MAX * 9) + 1];
1437         unsigned addch_used;    /* number of bytes in addch_work[] */
1438         int addch_x;            /* x-position for addch_work[] */
1439         int addch_y;            /* y-position for addch_work[] */
1440 #endif
1441 };
1442
1443 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1444
1445 #ifdef USE_SP_WINDOWLIST
1446 #define SP_INIT_WINDOWLIST(sp)  WindowList(sp) = 0
1447 #else
1448 #define SP_INIT_WINDOWLIST(sp)  /* nothing */
1449 #endif
1450
1451 #define SP_PRE_INIT(sp)                         \
1452     sp->_cursrow = -1;                          \
1453     sp->_curscol = -1;                          \
1454     sp->_nl = TRUE;                             \
1455     sp->_raw = FALSE;                           \
1456     sp->_cbreak = 0;                            \
1457     sp->_echo = TRUE;                           \
1458     sp->_fifohead = -1;                         \
1459     sp->_endwin = ewSuspend;                    \
1460     sp->_cursor = -1;                           \
1461     SP_INIT_WINDOWLIST(sp);                     \
1462     sp->_outch = NCURSES_OUTC_FUNC;             \
1463     sp->jump = 0                                \
1464
1465 /* usually in <limits.h> */
1466 #ifndef UCHAR_MAX
1467 #define UCHAR_MAX 255
1468 #endif
1469
1470 /* The terminfo source is assumed to be 7-bit ASCII */
1471 #define is7bits(c)      ((unsigned)(c) < 128)
1472
1473 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1474 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
1475
1476 #ifndef min
1477 #define min(a,b)        ((a) > (b)  ?  (b)  :  (a))
1478 #endif
1479
1480 #ifndef max
1481 #define max(a,b)        ((a) < (b)  ?  (b)  :  (a))
1482 #endif
1483
1484 /* usually in <unistd.h> */
1485 #ifndef STDIN_FILENO
1486 #define STDIN_FILENO 0
1487 #endif
1488
1489 #ifndef STDOUT_FILENO
1490 #define STDOUT_FILENO 1
1491 #endif
1492
1493 #ifndef STDERR_FILENO
1494 #define STDERR_FILENO 2
1495 #endif
1496
1497 #ifndef EXIT_SUCCESS
1498 #define EXIT_SUCCESS 0
1499 #endif
1500
1501 #ifndef EXIT_FAILURE
1502 #define EXIT_FAILURE 1
1503 #endif
1504
1505 #ifndef R_OK
1506 #define R_OK    4               /* Test for read permission.  */
1507 #endif
1508 #ifndef W_OK
1509 #define W_OK    2               /* Test for write permission.  */
1510 #endif
1511 #ifndef X_OK
1512 #define X_OK    1               /* Test for execute permission.  */
1513 #endif
1514 #ifndef F_OK
1515 #define F_OK    0               /* Test for existence.  */
1516 #endif
1517
1518 #if HAVE_FCNTL_H
1519 #include <fcntl.h>              /* may define O_BINARY  */
1520 #endif
1521
1522 #ifndef O_BINARY
1523 #define O_BINARY 0
1524 #endif
1525
1526 #ifdef TRACE
1527 #if USE_REENTRANT
1528 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1529 #else
1530 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1531 #endif
1532 #else
1533 #define COUNT_OUTCHARS(n) /* nothing */
1534 #endif
1535
1536 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1537
1538 #define UChar(c)        ((unsigned char)(c))
1539 #define UShort(c)       ((unsigned short)(c))
1540 #define ChCharOf(c)     ((chtype)(c) & (chtype)A_CHARTEXT)
1541 #define ChAttrOf(c)     ((chtype)(c) & (chtype)A_ATTRIBUTES)
1542
1543 #define TR_PUTC(c)      TR(TRACE_CHARPUT, ("PUTC %#x", UChar(c)))
1544
1545 #ifndef MB_LEN_MAX
1546 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1547 #endif
1548
1549 #if USE_WIDEC_SUPPORT /* { */
1550 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1551
1552 #define init_mb(state)  memset(&state, 0, sizeof(state))
1553
1554 #if NCURSES_EXT_COLORS
1555 #define NulColor        , 0
1556 #else
1557 #define NulColor        /* nothing */
1558 #endif
1559
1560 #define NulChar         0,0,0,0 /* FIXME: see CCHARW_MAX */
1561 #define CharOf(c)       ((c).chars[0])
1562 #define AttrOf(c)       ((c).attr)
1563
1564 #define AddAttr(c,a)    AttrOf(c) |=  ((a) & A_ATTRIBUTES)
1565 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1566 #define SetAttr(c,a)    AttrOf(c) =   ((a) & A_ATTRIBUTES) | WidecExt(c)
1567
1568 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
1569 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
1570
1571 #if CCHARW_MAX == 5
1572 #define CharEq(a,b)     (((a).attr == (b).attr) \
1573                        && (a).chars[0] == (b).chars[0] \
1574                        && (a).chars[1] == (b).chars[1] \
1575                        && (a).chars[2] == (b).chars[2] \
1576                        && (a).chars[3] == (b).chars[3] \
1577                        && (a).chars[4] == (b).chars[4] \
1578                         if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1579 #elif CCHARW_MAX > 0
1580 #error Inconsistent values for CCHARW_MAX
1581 #else
1582 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
1583 #endif
1584
1585 #define SetChar(ch,c,a) do {                                                        \
1586                             NCURSES_CH_T *_cp = &ch;                                \
1587                             memset(_cp, 0, sizeof(ch));                             \
1588                             _cp->chars[0] = (wchar_t) (c);                          \
1589                             _cp->attr = (a);                                        \
1590                             if_EXT_COLORS(SetPair(ch, PairNumber(a)));              \
1591                         } while (0)
1592 #define CHREF(wch)      (&wch)
1593 #define CHDEREF(wch)    (*wch)
1594 #define ARG_CH_T        NCURSES_CH_T *
1595 #define CARG_CH_T       const NCURSES_CH_T *
1596 #define PUTC_DATA       char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1597                         mbstate_t PUT_st; wchar_t PUTC_ch
1598 #define PUTC_INIT       init_mb (PUT_st)
1599 #define PUTC(ch)        do { if(!isWidecExt(ch)) {                                  \
1600                         if (Charable(ch)) {                                         \
1601                             TR_PUTC(CharOf(ch));                                    \
1602                             NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch));         \
1603                             COUNT_OUTCHARS(1);                                      \
1604                         } else {                                                    \
1605                             for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {       \
1606                                 PUTC_ch = (ch).chars[PUTC_i];                       \
1607                                 if (PUTC_ch == L'\0')                               \
1608                                     break;                                          \
1609                                 PUTC_INIT;                                          \
1610                                 PUTC_n = (int) wcrtomb(PUTC_buf,                    \
1611                                                        (ch).chars[PUTC_i], &PUT_st); \
1612                                 if (PUTC_n <= 0) {                                  \
1613                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) { \
1614                                         TR_PUTC(CharOf(ch));                        \
1615                                         NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1616                                     }                                               \
1617                                     break;                                          \
1618                                 } else {                                            \
1619                                     int PUTC_j;                                     \
1620                                     for (PUTC_j = 0; PUTC_j < PUTC_n; ++PUTC_j) {   \
1621                                         TR_PUTC(PUTC_buf[PUTC_j]);                  \
1622                                         NCURSES_OUTC_FUNC (NCURSES_SP_ARGx PUTC_buf[PUTC_j]); \
1623                                     }                                               \
1624                                 }                                                   \
1625                             }                                                       \
1626                             COUNT_OUTCHARS(PUTC_i);                                 \
1627                         } } } while (0)
1628
1629 #define BLANK           NewChar2(' ', WA_NORMAL)
1630 #define ZEROS           NewChar2('\0', WA_NORMAL)
1631 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1632
1633         /*
1634          * Wide characters cannot be represented in the A_CHARTEXT mask of
1635          * attr_t's but an application might have set a narrow character there.
1636          * But even in that case, it would only be a printable character, or
1637          * zero.  Otherwise we can use those bits to tell if a cell is the
1638          * first or extension part of a wide character.
1639          */
1640 #define WidecExt(ch)    (int) (AttrOf(ch) & A_CHARTEXT)
1641 #define isWidecBase(ch) (WidecExt(ch) == 1)
1642 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1643 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
1644                                 AttrOf(dst) |= (attr_t) (ext + 1)
1645
1646 #define if_WIDEC(code)  code
1647 #define Charable(ch)    (((SP_PARM->_legacy_coding)                     \
1648                          || (AttrOf(ch) & A_ALTCHARSET)                 \
1649                          || (!isWidecExt(ch))) &&                       \
1650                              (ch).chars[1] == L'\0' &&                  \
1651                              _nc_is_charable(CharOf(ch)))
1652
1653 #define L(ch)           L ## ch
1654 #else /* }{ */
1655 #define CharOf(c)       ChCharOf(c)
1656 #define AttrOf(c)       ChAttrOf(c)
1657 #define AddAttr(c,a)    c |= (a)
1658 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
1659 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
1660 #define NewChar(ch)     (ch)
1661 #define NewChar2(c,a)   ((c) | (a))
1662 #define CharEq(a,b)     ((a) == (b))
1663 #define SetChar(ch,c,a) ch = (c) | (a)
1664 #define CHREF(wch)      wch
1665 #define CHDEREF(wch)    wch
1666 #define ARG_CH_T        NCURSES_CH_T
1667 #define CARG_CH_T       NCURSES_CH_T
1668 #define PUTC_DATA       /* nothing */
1669 #define PUTC(ch)        { \
1670                             TR_PUTC(ch); \
1671                             NCURSES_OUTC_FUNC (NCURSES_SP_ARGx (int) ch); \
1672                         }
1673
1674 #define BLANK           (' '|A_NORMAL)
1675 #define ZEROS           ('\0'|A_NORMAL)
1676 #define ISBLANK(ch)     (CharOf(ch) == ' ')
1677
1678 #define isWidecExt(ch)  (0)
1679 #define if_WIDEC(code) /* nothing */
1680
1681 #define Charable(ch)    ((ch) >= ' ' && (ch) <= '~')
1682 #define L(ch)           ch
1683 #endif /* } */
1684
1685 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
1686 #define CharOfD(ch)     CharOf(CHDEREF(ch))
1687 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1688
1689 #define BLANK_ATTR      A_NORMAL
1690 #define BLANK_TEXT      L(' ')
1691
1692 #define CHANGED     -1
1693
1694 #define LEGALYX(w, y, x) \
1695               ((w) != 0 && \
1696                 ((x) >= 0 && (x) <= (w)->_maxx && \
1697                  (y) >= 0 && (y) <= (w)->_maxy))
1698
1699 #define CHANGED_CELL(line,col) \
1700         if (line->firstchar == _NOCHANGE) \
1701                 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1702         else if ((col) < line->firstchar) \
1703                 line->firstchar = (NCURSES_SIZE_T) (col); \
1704         else if ((col) > line->lastchar) \
1705                 line->lastchar = (NCURSES_SIZE_T) (col)
1706
1707 #define CHANGED_RANGE(line,start,end) \
1708         if (line->firstchar == _NOCHANGE \
1709          || line->firstchar > (start)) \
1710                 line->firstchar = (NCURSES_SIZE_T) (start); \
1711         if (line->lastchar == _NOCHANGE \
1712          || line->lastchar < (end)) \
1713                 line->lastchar = (NCURSES_SIZE_T) (end)
1714
1715 #define CHANGED_TO_EOL(line,start,end) \
1716         if (line->firstchar == _NOCHANGE \
1717          || line->firstchar > (start)) \
1718                 line->firstchar = (NCURSES_SIZE_T) (start); \
1719         line->lastchar = (NCURSES_SIZE_T) (end)
1720
1721 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1722
1723 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
1724
1725 /* FreeAndNull() is not a comma-separated expression because some compilers
1726  * do not accept a mixture of void with values.
1727  */
1728 #define FreeAndNull(p)   do { free(p); p = 0; } while (0)
1729
1730 #include <nc_alloc.h>
1731
1732 /*
1733  * Use these for tic/infocmp malloc failures.  Generally the ncurses library
1734  * tries to limp along after a failure.
1735  */
1736 #define TYPE_MALLOC(type, size, name) \
1737         do { \
1738             name = typeMalloc(type, size); \
1739             if (name == 0) \
1740                 _nc_err_abort(MSG_NO_MEMORY); \
1741         } while (0)
1742
1743 #define TYPE_REALLOC(type, size, name) \
1744         do { \
1745             name = typeRealloc(type, size, name); \
1746             if (name == 0) \
1747                 _nc_err_abort(MSG_NO_MEMORY); \
1748         } while (0)
1749
1750 /*
1751  * TTY bit definition for converting tabs to spaces.
1752  */
1753 #ifdef TAB3
1754 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
1755 #else
1756 # ifdef XTABS
1757 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
1758 # else
1759 #  ifdef OXTABS
1760 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
1761 #  else
1762 #   define OFLAGS_TABS 0
1763 #  endif
1764 # endif
1765 #endif
1766
1767 #ifdef __TANDEM
1768 #define ROOT_UID 65535
1769 #endif
1770
1771 #ifndef ROOT_UID
1772 #define ROOT_UID 0
1773 #endif
1774
1775 /*
1776  * Standardize/simplify common loops
1777  */
1778 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1779 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1780 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1781
1782 /*
1783  * Prefixes for call/return points of library function traces.  We use these to
1784  * instrument the public functions so that the traces can be easily transformed
1785  * into regression scripts.
1786  */
1787 #define T_CALLED(fmt) "called {" fmt
1788 #define T_CREATE(fmt) "create :" fmt
1789 #define T_RETURN(fmt) "return }" fmt
1790
1791 #define NonNull(s)              ((s) != 0 ? s : "<null>")
1792 #define NonEmpty(s)             ((s) != 0 && *(s) != '\0')
1793
1794 #ifdef TRACE
1795
1796 #if USE_REENTRANT
1797 #define TPUTS_TRACE(s)  _nc_set_tputs_trace(s);
1798 #else
1799 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
1800 #endif
1801
1802 #ifdef HAVE_CONSISTENT_GETENV
1803 #define START_TRACE() \
1804         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1805             int t = _nc_getenv_num("NCURSES_TRACE"); \
1806             if (t >= 0) \
1807                 curses_trace((unsigned) t); \
1808         }
1809 #else
1810 #define START_TRACE() /* nothing */
1811 #endif
1812
1813 /*
1814  * Many of the _tracef() calls use static buffers; lock the trace state before
1815  * trying to fill them.
1816  */
1817 #if USE_REENTRANT
1818 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1819 extern NCURSES_EXPORT(int)      _nc_use_tracef (unsigned);
1820 extern NCURSES_EXPORT(void)     _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1821 #else
1822 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1823 #define _nc_locked_tracef _tracef
1824 #endif
1825
1826 #define TR(n, a)        if (USE_TRACEF(n)) _nc_locked_tracef a
1827 #define T(a)            TR(TRACE_CALLS, a)
1828 #define TRACE_RETURN(value,type)     return _nc_retrace_##type((type)(value))
1829 #define TRACE_RETURN1(value,dst)     return _nc_retrace_##dst(value)
1830 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1831 #define TRACE_RETURN_SP(value,type)  return _nc_retrace_##type(SP_PARM, value)
1832
1833 typedef void VoidFunc(void);
1834
1835 #define TR_FUNC_LEN             ((sizeof(void *) + sizeof(void (*)(void))) * 2 + 4)
1836 #define TR_FUNC_BFR(max)        char tr_func_data[max][TR_FUNC_LEN]
1837 #define TR_FUNC_ARG(num,func)   _nc_fmt_funcptr(&tr_func_data[num][0], (const char *)&(func), sizeof((func)))
1838
1839 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
1840 #define returnBits(code)        TRACE_RETURN(code,unsigned)
1841 #define returnBool(code)        TRACE_RETURN(code,bool)
1842 #define returnCPtr(code)        TRACE_RETURN1(code,cptr)
1843 #define returnCVoidPtr(code)    TRACE_RETURN1(code,cvoid_ptr)
1844 #define returnChar(code)        TRACE_RETURN(code,char)
1845 #define returnChtype(code)      TRACE_RETURN(code,chtype)
1846 #define returnCode(code)        TRACE_RETURN(code,int)
1847 #define returnIntAttr(code)     TRACE_RETURN2(code,int,attr_t)
1848 #define returnMMask(code)       TRACE_RETURN_SP(code,mmask_t)
1849 #define returnPtr(code)         TRACE_RETURN1(code,ptr)
1850 #define returnSP(code)          TRACE_RETURN1(code,sp)
1851 #define returnVoid              T((T_RETURN(""))); return
1852 #define returnVoidPtr(code)     TRACE_RETURN1(code,void_ptr)
1853 #define returnWin(code)         TRACE_RETURN1(code,win)
1854
1855 #define returnDB(rc)            do { TR(TRACE_DATABASE,(T_RETURN("code %d"), (rc))); return (rc); } while (0)
1856
1857 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (int);
1858 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1859 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
1860 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
1861 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
1862 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
1863 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(TTY *tty);
1864 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
1865 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
1866 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
1867 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
1868 extern NCURSES_EXPORT(char)             _nc_retrace_char (int);
1869 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
1870 extern NCURSES_EXPORT(int)              _nc_retrace_int_attr_t (attr_t);
1871 extern NCURSES_EXPORT(mmask_t)          _nc_retrace_mmask_t (SCREEN *, mmask_t);
1872 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
1873 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
1874 extern NCURSES_EXPORT(void)             _nc_fifo_dump (SCREEN *);
1875
1876 extern NCURSES_EXPORT(char *)           _nc_fmt_funcptr(char *, const char *, size_t);
1877
1878 #if USE_REENTRANT
1879 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1880 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1881 #define _nc_outchars       NCURSES_PUBLIC_VAR(_nc_outchars())
1882 #define _nc_tputs_trace    NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1883 extern NCURSES_EXPORT(void)             _nc_set_tputs_trace (const char *);
1884 extern NCURSES_EXPORT(void)             _nc_count_outchars (long);
1885 #else
1886 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1887 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
1888 #endif
1889
1890 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
1891
1892 extern NCURSES_EXPORT(char *) _nc_tracebits (void);
1893 extern NCURSES_EXPORT(char *) _tracemouse (const MEVENT *);
1894 extern NCURSES_EXPORT(void) _tracedump (const char *, WINDOW *);
1895
1896 #if USE_WIDEC_SUPPORT
1897 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1898 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1899 #endif
1900
1901 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1902 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1903
1904 #else /* !TRACE */
1905
1906 #define START_TRACE() /* nothing */
1907
1908 #define T(a)
1909 #define TR(n, a)
1910 #define TPUTS_TRACE(s)
1911 #define TR_FUNC_BFR(max)
1912
1913 #define returnAttr(code)        return code
1914 #define returnBits(code)        return code
1915 #define returnBool(code)        return code
1916 #define returnCPtr(code)        return code
1917 #define returnCVoidPtr(code)    return code
1918 #define returnChar(code)        return ((char) code)
1919 #define returnChtype(code)      return code
1920 #define returnCode(code)        return code
1921 #define returnIntAttr(code)     return code
1922 #define returnMMask(code)       return code
1923 #define returnPtr(code)         return code
1924 #define returnSP(code)          return code
1925 #define returnVoid              return
1926 #define returnVoidPtr(code)     return code
1927 #define returnWin(code)         return code
1928
1929 #define returnDB(code)          return code
1930
1931 #endif /* TRACE/!TRACE */
1932
1933 /*
1934  * Workaround for defective implementation of gcc attribute warn_unused_result
1935  */
1936 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1937 #define IGNORE_RC(func) errno = (int) func
1938 #else
1939 #define IGNORE_RC(func) (void) func
1940 #endif /* gcc workarounds */
1941
1942 /*
1943  * Return-codes for tgetent() and friends.
1944  */
1945 #define TGETENT_YES  1          /* entry is found */
1946 #define TGETENT_NO   0          /* entry is not found */
1947 #define TGETENT_ERR -1          /* an error occurred */
1948
1949 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1950 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1951
1952 #define EMPTY_MODULE(name) \
1953 extern  NCURSES_EXPORT(void) name (void); \
1954         NCURSES_EXPORT(void) name (void) { }
1955
1956 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1957 #define NONBLANK_ATTR (A_BOLD | A_DIM | A_BLINK | A_ITALIC)
1958 #define TPARM_ATTR    (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_ALTCHARSET | A_INVIS | A_PROTECT)
1959 #define XMC_CONFLICT  (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_INVIS | A_PROTECT | A_ITALIC)
1960 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1961
1962 #define toggle_attr_on(S,at) {\
1963    if (PairNumber(at) > 0) {\
1964       (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1965    } else {\
1966       (S) |= (attr_t) (at);\
1967    }\
1968    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1969
1970
1971 #define toggle_attr_off(S,at) {\
1972    if (PairNumber(at) > 0) {\
1973       (S) &= ~(at|A_COLOR);\
1974    } else {\
1975       (S) &= ~(at);\
1976    }\
1977    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1978
1979 #define DelCharCost(sp,count) \
1980                 ((parm_dch != 0) \
1981                 ? sp->_dch_cost \
1982                 : ((delete_character != 0) \
1983                         ? (sp->_dch1_cost * count) \
1984                         : INFINITY))
1985
1986 #define InsCharCost(sp,count) \
1987                 ((parm_ich != 0) \
1988                 ? sp->_ich_cost \
1989                 : ((enter_insert_mode && exit_insert_mode) \
1990                   ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1991                   : ((insert_character != 0) \
1992                     ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1993                     : INFINITY)))
1994
1995 #if USE_XMC_SUPPORT
1996 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1997                                 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1998                                 VIDPUTS(sp, AttrOf(c), GetPair(c)); \
1999                                 if (magic_cookie_glitch > 0 \
2000                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
2001                                         T(("%s @%d before glitch %d,%d", \
2002                                                 __FILE__, __LINE__, \
2003                                                 sp->_cursrow, \
2004                                                 sp->_curscol)); \
2005                                         NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
2006                                 } \
2007                         }
2008 #else
2009 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
2010                                     VIDPUTS(sp, AttrOf(c), GetPair(c)); \
2011                         }
2012 #endif
2013
2014 /*
2015  * Macros to make additional parameter to implement wgetch_events()
2016  */
2017 #ifdef NCURSES_WGETCH_EVENTS
2018 #define EVENTLIST_0th(param) param
2019 #define EVENTLIST_1st(param) param
2020 #define EVENTLIST_2nd(param) , param
2021 #define TWAIT_MASK (TW_ANY | TW_EVENT)
2022 #else
2023 #define EVENTLIST_0th(param) void
2024 #define EVENTLIST_1st(param) /* nothing */
2025 #define EVENTLIST_2nd(param) /* nothing */
2026 #define TWAIT_MASK TW_ANY
2027 #endif
2028
2029 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
2030
2031 #undef  toggle_attr_on
2032 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
2033 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
2034
2035 #undef  toggle_attr_off
2036 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
2037 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
2038
2039 #undef  DelCharCost
2040 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
2041
2042 #undef  InsCharCost
2043 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
2044
2045 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
2046 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
2047
2048 #undef  UpdateAttrs
2049 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
2050
2051 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
2052 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
2053 #else
2054 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
2055 #endif
2056
2057 #if NCURSES_SP_FUNCS
2058 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
2059 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
2060 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
2061 #endif /* NCURSES_SP_FUNCS */
2062
2063 #else
2064
2065 extern NCURSES_EXPORT(void) _nc_expanded (void);
2066
2067 #endif
2068
2069 #if !NCURSES_EXT_FUNCS
2070 #define set_escdelay(value) ESCDELAY = value
2071 #endif
2072
2073 #if !HAVE_GETCWD
2074 #define getcwd(buf,len) getwd(buf)
2075 #endif
2076
2077 #define save_ttytype(termp) \
2078         if (TerminalType(termp).term_names != 0) { \
2079             _nc_STRNCPY(ttytype, \
2080                         TerminalType(termp).term_names, \
2081                         NAMESIZE - 1); \
2082             ttytype[NAMESIZE - 1] = '\0'; \
2083         }
2084
2085 #if !NCURSES_WCWIDTH_GRAPHICS
2086 extern NCURSES_EXPORT(int) _nc_wacs_width(unsigned);
2087 #else
2088 #define _nc_wacs_width(ch) wcwidth(ch)
2089 #endif
2090
2091 /* charable.c */
2092 #if USE_WIDEC_SUPPORT
2093 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
2094 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
2095 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
2096 #endif
2097
2098 /* comp_captab.c */
2099 typedef struct {
2100         short   nte_name;       /* offset of name to hash on */
2101         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
2102         short   nte_index;      /* index of associated variable in its array */
2103         short   nte_link;       /* index in table of next hash, or -1 */
2104 } name_table_data;
2105
2106 typedef struct
2107 {
2108         short   from;
2109         short   to;
2110         short   source;
2111 } alias_table_data;
2112
2113 /* comp_userdefs.c */
2114 typedef struct {
2115         short   ute_name;       /* offset of name to hash on */
2116         unsigned ute_type;      /* mask (BOOLEAN, NUMBER, STRING) */
2117         unsigned ute_argc;      /* number of parameters */
2118         unsigned ute_args;      /* bit-mask for string parameters */
2119         short   ute_index;      /* index of associated variable in its array */
2120         short   ute_link;       /* index in table of next hash, or -1 */
2121 } user_table_data;
2122
2123 /* doupdate.c */
2124 #if USE_XMC_SUPPORT
2125 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
2126 #endif
2127
2128 /* hardscroll.c */
2129 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2130 extern NCURSES_EXPORT(void) _nc_linedump (void);
2131 #endif
2132
2133 /* lib_acs.c */
2134 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
2135 extern NCURSES_EXPORT(int)  _nc_msec_cost (const char *const, int);  /* used by 'tack' program */
2136
2137 /* lib_addch.c */
2138 #if USE_WIDEC_SUPPORT
2139 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
2140 #endif
2141
2142 /* lib_addstr.c */
2143 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2144 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
2145 #endif
2146
2147 /* lib_color.c */
2148 extern NCURSES_EXPORT(int) _nc_init_color(SCREEN *, int, int, int, int);
2149 extern NCURSES_EXPORT(int) _nc_init_pair(SCREEN *, int, int, int);
2150 extern NCURSES_EXPORT(int) _nc_pair_content(SCREEN *, int, int *, int *);
2151 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
2152 extern NCURSES_EXPORT(void) _nc_reserve_pairs(SCREEN *, int);
2153 extern NCURSES_EXPORT(void) _nc_change_pair(SCREEN *, int);
2154
2155 #define ReservePairs(sp,want) \
2156             if ((sp->_color_pairs == 0) || (want >= sp->_pair_alloc)) \
2157                 _nc_reserve_pairs(sp, want)
2158
2159 /* lib_getch.c */
2160 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
2161
2162 /* lib_insch.c */
2163 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
2164
2165 /* lib_mvcur.c */
2166 #define INFINITY        1000000 /* cost: too high to use */
2167
2168 extern NCURSES_EXPORT(int) _nc_mvcur(int yold, int xold, int ynew, int xnew);
2169
2170 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
2171 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
2172 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
2173
2174 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
2175
2176 extern NCURSES_EXPORT(void) _nc_screen_init (void);
2177 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
2178 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
2179
2180 /* lib_mouse.c */
2181 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
2182
2183 /* lib_mvcur.c */
2184 #define INFINITY        1000000 /* cost: too high to use */
2185 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
2186
2187 /* lib_setup.c */
2188 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
2189 extern NCURSES_EXPORT(int)    _nc_unicode_locale(void);
2190 extern NCURSES_EXPORT(int)    _nc_locale_breaks_acs(TERMINAL *);
2191 extern NCURSES_EXPORT(int)    _nc_setupterm(const char *, int, int *, int);
2192 extern NCURSES_EXPORT(void)   _nc_tinfo_cmdch(TERMINAL *, int);
2193
2194 #ifdef USE_PTHREADS
2195 extern NCURSES_EXPORT(SCREEN *) _nc_find_prescr(void);
2196 extern NCURSES_EXPORT(void)   _nc_forget_prescr(void);
2197 #else
2198 #define _nc_find_prescr()     _nc_prescreen.allocated
2199 #define _nc_forget_prescr()   _nc_prescreen.allocated = 0
2200 #endif
2201
2202 /* lib_set_term.c */
2203 extern NCURSES_EXPORT(int)    _nc_ripoffline(int, int(*)(WINDOW*, int));
2204
2205 /* lib_setup.c */
2206 #define ExitTerminfo(code)    exit_terminfo(code)
2207
2208 #define SETUP_FAIL ERR
2209
2210 #define ret_error(rc, fmt, p, q)        if (errret) {\
2211                                             *errret = rc;\
2212                                             q;\
2213                                             returnCode(SETUP_FAIL);\
2214                                         } else {\
2215                                             fprintf(stderr, fmt, p);\
2216                                             q;\
2217                                             ExitTerminfo(EXIT_FAILURE);\
2218                                         }
2219
2220 #define ret_error1(rc, fmt, p, q)       ret_error(rc, "'%s': " fmt, p, q)
2221
2222 #define ret_error0(rc, msg)             if (errret) {\
2223                                             *errret = rc;\
2224                                             returnCode(SETUP_FAIL);\
2225                                         } else {\
2226                                             fprintf(stderr, msg);\
2227                                             ExitTerminfo(EXIT_FAILURE);\
2228                                         }
2229
2230 /* lib_tstp.c */
2231 #if USE_SIGWINCH
2232 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
2233 #else
2234 #define _nc_handle_sigwinch(a) /* nothing */
2235 #endif
2236
2237 /* lib_wacs.c */
2238 #if USE_WIDEC_SUPPORT
2239 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
2240 #endif
2241
2242 typedef struct {
2243     char *s_head;       /* beginning of the string (may be null) */
2244     char *s_tail;       /* end of the string (may be null) */
2245     size_t s_size;      /* current remaining size available */
2246     size_t s_init;      /* total size available */
2247 } string_desc;
2248
2249 /* strings.c */
2250 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
2251 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
2252 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
2253 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
2254 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
2255
2256 #if !HAVE_STRSTR
2257 #define strstr _nc_strstr
2258 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
2259 #endif
2260
2261 /* safe_sprintf.c */
2262 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
2263
2264 /* tries.c */
2265 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
2266 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
2267 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
2268 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
2269
2270 /* elsewhere ... */
2271 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
2272 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
2273 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
2274 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
2275 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
2276 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
2277 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
2278 extern NCURSES_EXPORT(char *) _nc_trace_mmask_t (SCREEN *, mmask_t);
2279 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
2280 extern NCURSES_EXPORT(int) _nc_baudrate (int);
2281 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
2282 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
2283 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
2284 extern NCURSES_EXPORT(int) _nc_ospeed (int);
2285 extern NCURSES_EXPORT(int) _nc_outch (int);
2286 extern NCURSES_EXPORT(int) _nc_putchar (int);
2287 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
2288 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
2289 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE2 *const);
2290 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE2 *);
2291 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
2292 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
2293 extern NCURSES_EXPORT(void) _nc_init_termtype (TERMTYPE2 *const);
2294 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
2295 extern NCURSES_EXPORT(void) _nc_flush (void);
2296 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE2 *);
2297 extern NCURSES_EXPORT(void) _nc_freeall (void);
2298 extern NCURSES_EXPORT(void) _nc_hash_map (void);
2299 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
2300 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
2301 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
2302 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
2303 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
2304 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
2305 extern NCURSES_EXPORT(void) _nc_setenv_num (const char *, int);
2306 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
2307 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
2308 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
2309
2310 #if NCURSES_EXT_NUMBERS
2311 extern NCURSES_EXPORT(const TERMTYPE2 *) _nc_fallback2 (const char *);
2312 #else
2313 #define _nc_fallback2(tp) _nc_fallback(tp)
2314 #endif
2315
2316 #if NCURSES_EXT_NUMBERS
2317 extern NCURSES_EXPORT(void) _nc_copy_termtype2 (TERMTYPE2 *, const TERMTYPE2 *);
2318 extern NCURSES_EXPORT(void) _nc_export_termtype2(TERMTYPE *, const TERMTYPE2 *);
2319 #else
2320 #define _nc_copy_termtype2(dst,src) _nc_copy_termtype((dst),(src))
2321 #define _nc_export_termtype2(dst,src) /* nothing */
2322 #define _nc_free_termtype2(t) _nc_free_termtype(t)
2323 /* also... */
2324 #define _nc_read_entry2 _nc_read_entry
2325 #endif
2326
2327 #if NO_LEAKS
2328 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
2329 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
2330 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
2331 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
2332 extern NCURSES_EXPORT(void) _nc_comp_error_leaks(void);
2333 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
2334 extern NCURSES_EXPORT(void) _nc_comp_userdefs_leaks(void);
2335 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
2336 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
2337 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
2338 extern NCURSES_EXPORT(void) _nc_tgetent_leak(TERMINAL *);
2339 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
2340 #endif
2341
2342 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2343 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
2344 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
2345 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
2346 #endif
2347
2348 #if USE_WIDEC_SUPPORT
2349 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
2350 #endif
2351
2352 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2353 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
2354 #endif
2355
2356 #if USE_SIZECHANGE
2357 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
2358 #endif
2359
2360 #if HAVE_RESIZETERM
2361 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
2362 #else
2363 #define _nc_resize_margins(wp) /* nothing */
2364 #endif
2365
2366 #ifdef NCURSES_WGETCH_EVENTS
2367 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2368 #else
2369 #define wgetch_events(win, evl) wgetch(win)
2370 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2371 #endif
2372
2373 /*
2374  * Wide-character macros to hide some platform-differences.
2375  */
2376 #if USE_WIDEC_SUPPORT
2377
2378 #if defined(_NC_WINDOWS) && !defined(_NC_MSC)
2379 /*
2380  * MinGW has wide-character functions, but they do not work correctly.
2381  */
2382 extern int __MINGW_NOTHROW _nc_wctomb(char *, wchar_t);
2383 #define wctomb(s,wc) _nc_wctomb(s,wc)
2384 #define wcrtomb(s,wc,n) _nc_wctomb(s,wc)
2385
2386 extern int __MINGW_NOTHROW _nc_mbtowc(wchar_t *, const char *, size_t);
2387 #define mbtowc(pwc,s,n) _nc_mbtowc(pwc,s,n)
2388
2389 extern int __MINGW_NOTHROW _nc_mblen(const char *, size_t);
2390 #define mblen(s,n) _nc_mblen(s, n)
2391
2392 #endif /* _NC_WINDOWS && !_NC_MSC */
2393
2394 #if HAVE_MBTOWC && HAVE_MBLEN
2395 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2396 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2397 #define check_mbytes(wch,buffer,length,state) \
2398         (int) mbtowc(&wch, buffer, length)
2399 #define state_unused
2400 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2401 #define reset_mbytes(state) init_mb(state)
2402 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
2403 #define check_mbytes(wch,buffer,length,state) \
2404         (int) mbrtowc(&wch, buffer, length, &state)
2405 #else
2406 make an error
2407 #endif
2408
2409 #endif /* USE_WIDEC_SUPPORT */
2410
2411 /*
2412  * Not everyone has vsscanf(), but we'd like to use it for scanw().
2413  */
2414 #if !HAVE_VSSCANF
2415 extern int vsscanf(const char *str, const char *format, va_list __arg);
2416 #endif
2417
2418 /* scroll indices */
2419 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2420
2421 #define USE_SETBUF_0 0
2422
2423 #define NC_OUTPUT(sp) ((sp != 0 && sp->_ofp != 0) ? sp->_ofp : stdout)
2424
2425 /*
2426  * On systems with a broken linker, define 'SP' as a function to force the
2427  * linker to pull in the data-only module with 'SP'.
2428  */
2429 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2430
2431 #if BROKEN_LINKER
2432 #define SP _nc_screen()
2433 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2434 extern NCURSES_EXPORT(int)      _nc_alloc_screen (void);
2435 extern NCURSES_EXPORT(void)     _nc_set_screen (SCREEN *);
2436 #define CURRENT_SCREEN          _nc_screen()
2437 #else
2438 /* current screen is private data; avoid possible linking conflicts too */
2439 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2440 #define CURRENT_SCREEN SP
2441 #define _nc_alloc_screen()      ((SP = _nc_alloc_screen_sp()) != 0)
2442 #define _nc_set_screen(sp)      SP = sp
2443 #endif
2444
2445 #if NCURSES_SP_FUNCS
2446 #define CURRENT_SCREEN_PRE      (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2447 #else
2448 #define CURRENT_SCREEN_PRE      CURRENT_SCREEN
2449 #endif
2450
2451 /*
2452  * We don't want to use the lines or columns capabilities internally, because
2453  * if the application is running multiple screens under X, it's quite possible
2454  * they could all have type xterm but have different sizes!  So...
2455  */
2456 #define screen_lines(sp)        (sp)->_lines
2457 #define screen_columns(sp)      (sp)->_columns
2458
2459 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2460 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2461
2462 /*
2463  * Some constants related to SLK's
2464  */
2465 #define MAX_SKEY_OLD       8    /* count of soft keys */
2466 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
2467 #define MAX_SKEY_PC       12    /* This is what most PC's have */
2468 #define MAX_SKEY_LEN_PC    5
2469
2470 /* Macro to check whether or not we use a standard format */
2471 #define SLK_STDFMT(fmt) (fmt < 3)
2472 /* Macro to determine height of label window */
2473 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2474
2475 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2476 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2477
2478 /*
2479  * Common error messages
2480  */
2481 #define MSG_NO_MEMORY "Out of memory"
2482 #define MSG_NO_INPUTS "Premature EOF"
2483
2484 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2485 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2486
2487 /* timed_wait flag definitions */
2488 #define TW_NONE    0
2489 #define TW_INPUT   1
2490 #define TW_MOUSE   2
2491 #define TW_ANY     (TW_INPUT | TW_MOUSE)
2492 #define TW_EVENT   4
2493
2494 #define SetSafeOutcWrapper(outc)            \
2495     SCREEN* sp = CURRENT_SCREEN;            \
2496     struct screen outc_wrapper;             \
2497     if (sp==0) {                            \
2498         sp = &outc_wrapper;                 \
2499         memset(sp,0,sizeof(struct screen)); \
2500         sp->_outch = _nc_outc_wrapper;      \
2501     }\
2502     sp->jump = outc
2503
2504 #ifdef USE_TERM_DRIVER
2505
2506 typedef struct _termInfo
2507 {
2508     bool caninit;
2509
2510     bool hascolor;
2511     bool initcolor;
2512     bool canchange;
2513
2514     int  tabsize;
2515
2516     int  maxcolors;
2517     int  maxpairs;
2518     int  nocolorvideo;
2519
2520     int  numbuttons;
2521     int  numlabels;
2522     int  labelwidth;
2523     int  labelheight;
2524
2525     const color_t* defaultPalette;
2526 } TerminalInfo;
2527
2528 typedef struct term_driver {
2529     bool   isTerminfo;
2530     const char* (*td_name)(struct DriverTCB*);
2531     bool   (*td_CanHandle)(struct DriverTCB*, const char*, int*);
2532     void   (*td_init)(struct DriverTCB*);
2533     void   (*td_release)(struct DriverTCB*);
2534     int    (*td_size)(struct DriverTCB*, int* Line, int *Cols);
2535     int    (*td_sgmode)(struct DriverTCB*, int setFlag, TTY*);
2536     chtype (*td_conattr)(struct DriverTCB*);
2537     int    (*td_hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2538     int    (*td_mode)(struct DriverTCB*, int progFlag, int defFlag);
2539     bool   (*td_rescol)(struct DriverTCB*);
2540     bool   (*td_rescolors)(struct DriverTCB*);
2541     void   (*td_color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2542     int    (*td_doBeepOrFlash)(struct DriverTCB*, int);
2543     void   (*td_initpair)(struct DriverTCB*, int, int, int);
2544     void   (*td_initcolor)(struct DriverTCB*, int, int, int, int);
2545     void   (*td_docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2546     void   (*td_initmouse)(struct DriverTCB*);
2547     int    (*td_testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2548     void   (*td_setfilter)(struct DriverTCB*);
2549     void   (*td_hwlabel)(struct DriverTCB*, int, char*);
2550     void   (*td_hwlabelOnOff)(struct DriverTCB*, int);
2551     int    (*td_update)(struct DriverTCB*);
2552     int    (*td_defaultcolors)(struct DriverTCB*, int, int);
2553     int    (*td_print)(struct DriverTCB*, char*, int);
2554     int    (*td_getsize)(struct DriverTCB*, int*, int*);
2555     int    (*td_setsize)(struct DriverTCB*, int, int);
2556     void   (*td_initacs)(struct DriverTCB*, chtype*, chtype*);
2557     void   (*td_scinit)(SCREEN *);
2558     void   (*td_scexit)(SCREEN *);
2559     int    (*td_twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2560     int    (*td_read)(struct DriverTCB*, int*);
2561     int    (*td_nap)(struct DriverTCB*, int);
2562     int    (*td_kpad)(struct DriverTCB*, int);
2563     int    (*td_kyOk)(struct DriverTCB*, int, int);
2564     bool   (*td_kyExist)(struct DriverTCB*, int);
2565     int    (*td_cursorSet)(struct DriverTCB*, int);
2566 } TERM_DRIVER;
2567
2568 typedef struct DriverTCB
2569 {
2570     TERMINAL      term;   /* needs to be the first Element !!! */
2571     TERM_DRIVER*  drv;    /* The driver for that Terminal */
2572     SCREEN*       csp;    /* The screen that owns that Terminal */
2573     TerminalInfo  info;   /* Driver independent core capabilities of the Terminal */
2574     void*         prop;   /* Driver dependent property storage to be used by the Driver */
2575     long          magic;
2576 } TERMINAL_CONTROL_BLOCK;
2577
2578 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2579 #define NCDRV_TINFO      0x01
2580 #define NCDRV_WINCONSOLE 0x02
2581
2582 #define TCBOf(sp)    ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2583 #define InfoOf(sp)   TCBOf(sp)->info
2584 #define CallDriver(sp,method)                        TCBOf(sp)->drv->method(TCBOf(sp))
2585 #define CallDriver_1(sp,method,arg1)                 TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2586 #define CallDriver_2(sp,method,arg1,arg2)            TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2587 #define CallDriver_3(sp,method,arg1,arg2,arg3)       TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2588 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4)  TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2589
2590 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2591 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2592
2593 extern NCURSES_EXPORT(int)      _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2594 extern NCURSES_EXPORT(void)     _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2595 #endif /* USE_TERM_DRIVER */
2596
2597 /*
2598  * Entrypoints which are actually provided in the terminal driver, which would
2599  * be an sp-name otherwise.
2600  */
2601 #ifdef USE_TERM_DRIVER
2602 #define TINFO_HAS_KEY           _nc_tinfo_has_key
2603 #define TINFO_DOUPDATE          _nc_tinfo_doupdate
2604 #define TINFO_MVCUR             _nc_tinfo_mvcur
2605 extern NCURSES_EXPORT(int)      TINFO_HAS_KEY(SCREEN*, int);
2606 extern NCURSES_EXPORT(int)      TINFO_DOUPDATE(SCREEN *);
2607 extern NCURSES_EXPORT(int)      TINFO_MVCUR(SCREEN*, int, int, int, int);
2608 #else
2609 #define TINFO_HAS_KEY           NCURSES_SP_NAME(has_key)
2610 #define TINFO_DOUPDATE          NCURSES_SP_NAME(doupdate)
2611 #define TINFO_MVCUR             NCURSES_SP_NAME(_nc_mvcur)
2612 #endif
2613
2614 #if defined(EXP_WIN32_DRIVER)
2615 #include <nc_win32.h>
2616 #endif
2617
2618 /*
2619  * Entrypoints using an extra parameter with the terminal driver.
2620  */
2621 #ifdef USE_TERM_DRIVER
2622 extern NCURSES_EXPORT(void)   _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2623 extern NCURSES_EXPORT(int)    _nc_setupterm_ex(TERMINAL **, const char *, int , int *, int);
2624 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2625         _nc_get_screensize(sp, tp, lp, cp)
2626 #define TINFO_SET_CURTERM(sp, tp) \
2627         NCURSES_SP_NAME(set_curterm)(sp, tp)
2628 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2629         _nc_setupterm_ex(tpp, name, fd, err, reuse)
2630 #else /* !USE_TERM_DRIVER */
2631 extern NCURSES_EXPORT(void)   _nc_get_screensize(SCREEN *, int *, int *);
2632 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2633         _nc_get_screensize(sp, lp, cp)
2634 #define TINFO_SET_CURTERM(sp, tp) \
2635         set_curterm(tp)
2636 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2637         _nc_setupterm(name, fd, err, reuse)
2638 #endif /* !USE_TERM_DRIVER */
2639
2640 #ifdef EXP_WIN32_DRIVER
2641 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2642 #else
2643 #ifdef USE_TERM_DRIVER
2644 #if defined(USE_WIN32CON_DRIVER)
2645 #include <nc_mingw.h>
2646 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2647 extern NCURSES_EXPORT(int)  _nc_mingw_isatty(int fd);
2648 extern NCURSES_EXPORT(int)  _nc_mingw_isconsole(int fd);
2649 extern NCURSES_EXPORT(int) _nc_mingw_console_read(
2650     SCREEN *sp,
2651     HANDLE  fd,
2652     int *buf);
2653 extern NCURSES_EXPORT(int) _nc_mingw_testmouse(
2654     SCREEN * sp,
2655     HANDLE fd,
2656     int delay EVENTLIST_2nd(_nc_eventlist*));
2657 #else
2658 #endif
2659 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2660 #endif /* USE_TERM_DRIVER */
2661 #endif /* EXP_WIN32_DRIVER */
2662
2663 #if defined(USE_TERM_DRIVER) && defined(EXP_WIN32_DRIVER)
2664 #define NC_ISATTY(fd) (0 != _nc_console_isatty(fd))
2665 #elif defined(USE_TERM_DRIVER) && defined(USE_WIN32CON_DRIVER)
2666 #define NC_ISATTY(fd) _nc_mingw_isatty(fd)
2667 #else
2668 #define NC_ISATTY(fd) isatty(fd)
2669 #endif
2670
2671 #ifdef USE_TERM_DRIVER
2672 #  define IsTermInfo(sp)       ((TCBOf(sp) != 0) && ((TCBOf(sp)->drv->isTerminfo)))
2673 #  define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2674 #  if defined(EXP_WIN32_DRIVER)
2675 #    define IsTermInfoOnConsole(sp) (IsTermInfo(sp)&&_nc_console_test(TerminalOf(sp)->Filedes))
2676 #  elif defined(USE_WIN32CON_DRIVER)
2677 #    define IsTermInfoOnConsole(sp) (IsTermInfo(sp)&&_nc_mingw_isconsole(TerminalOf(sp)->Filedes))
2678 #  else
2679 #    define IsTermInfoOnConsole(sp) FALSE
2680 #  endif
2681 #else
2682 #  define IsTermInfo(sp)       TRUE
2683 #  define HasTInfoTerminal(sp) (0 != TerminalOf(sp))
2684 #  if defined(EXP_WIN32_DRIVER)
2685 #    define IsTermInfoOnConsole(sp) _nc_console_test(TerminalOf(sp)->Filedes)
2686 #  else
2687 #    define IsTermInfoOnConsole(sp) FALSE
2688 #  endif
2689 #endif
2690
2691 #define IsValidTIScreen(sp)  (HasTInfoTerminal(sp))
2692
2693 /*
2694  * Exported entrypoints beyond the published API
2695  */
2696 #if NCURSES_SP_FUNCS
2697 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2698 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2699 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2700 extern NCURSES_EXPORT(int)      _nc_outc_wrapper(SCREEN*,int);
2701
2702 #if USE_REENTRANT
2703 extern NCURSES_EXPORT(int)       NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2704 extern NCURSES_EXPORT(char *)    NCURSES_SP_NAME(longname)(SCREEN*);
2705 #endif
2706
2707 #if NCURSES_EXT_FUNCS
2708 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2709 #endif
2710
2711 /*
2712  * We put the safe versions of various calls here as they are not published
2713  * part of the API up to now
2714  */
2715 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2716 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2717 extern NCURSES_EXPORT(bool)     NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2718 extern NCURSES_EXPORT(char *)   NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2719 extern NCURSES_EXPORT(chtype)   NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2720 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2721 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2722 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2723 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_mvcur)(SCREEN*, int, int, int, int);
2724 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2725 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putchar)(SCREEN*, int);
2726 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2727 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2728 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2729 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2730 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2731 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2732 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2733 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2734 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2735 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2736 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2737 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2738 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2739 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2740 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2741 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2742 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2743 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2744 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2745 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2746 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2747 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2748 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2749 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2750
2751 extern NCURSES_EXPORT(void)     _nc_cookie_init(SCREEN *sp);
2752
2753 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2754 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2755 #endif
2756
2757 #if USE_WIDEC_SUPPORT
2758 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2759 #endif
2760
2761 #endif /* NCURSES_SP_FUNCS */
2762
2763 #if NCURSES_SP_FUNCS
2764
2765 #define safe_keyname NCURSES_SP_NAME(keyname)
2766 #define safe_unctrl  NCURSES_SP_NAME(unctrl)
2767 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2768
2769 #else
2770
2771 #define safe_keyname _nc_keyname
2772 #define safe_unctrl  _nc_unctrl
2773 #define safe_ungetch _nc_ungetch
2774
2775 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2776 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2777 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2778
2779 #endif
2780
2781 #ifdef EXP_XTERM_1005
2782 NCURSES_EXPORT(int) _nc_conv_to_utf8(unsigned char *, unsigned, unsigned);
2783 NCURSES_EXPORT(int) _nc_conv_to_utf32(unsigned *, const char *, unsigned);
2784 #endif
2785
2786 #ifdef __cplusplus
2787 }
2788 #endif
2789
2790 /* *INDENT-ON* */
2791
2792 #endif /* CURSES_PRIV_H */