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