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