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