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