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