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