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