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