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