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