1 /****************************************************************************
2 * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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 ****************************************************************************/
38 * $Id: curses.priv.h,v 1.465 2010/08/28 20:56:48 tom Exp $
42 * Header file for curses library objects which are private to
48 #define CURSES_PRIV_H 1
50 #include <ncurses_dll.h>
56 #include <ncurses_cfg.h>
59 #define MODULE_ID(id) static const char Ident[] = id;
61 #define MODULE_ID(id) /*nothing*/
64 #include <stddef.h> /* for offsetof */
67 #include <sys/types.h>
73 #if HAVE_SYS_BSDTYPES_H
74 #include <sys/bsdtypes.h> /* needed for ISC */
79 #elif HAVE_SYS_PARAM_H
80 # include <sys/param.h>
89 # if defined(_POSIX_PATH_MAX)
90 # define PATH_MAX _POSIX_PATH_MAX
91 # elif defined(MAXPATHLEN)
92 # define PATH_MAX MAXPATHLEN
94 # define PATH_MAX 255 /* the Posix minimum path-size */
102 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
103 #if HAVE_WORKING_POLL
104 #define USE_FUNC_POLL 1
108 #include <sys/poll.h>
111 #define USE_FUNC_POLL 0
114 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
117 /* Alessandro Rubini's GPM (general-purpose mouse) */
118 #if HAVE_LIBGPM && HAVE_GPM_H
119 #define USE_GPM_SUPPORT 1
121 #define USE_GPM_SUPPORT 0
124 /* QNX mouse support */
125 #if defined(__QNX__) && !defined(__QNXNTO__)
126 #define USE_QNX_MOUSE 1
128 #define USE_QNX_MOUSE 0
131 /* EMX mouse support */
133 #define USE_EMX_MOUSE 1
135 #define USE_EMX_MOUSE 0
138 #define DEFAULT_MAXCLICK 166
139 #define EV_MAX 8 /* size of mouse circular event queue */
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.
145 #if !NCURSES_EXT_FUNCS
146 #undef HAVE_SIZECHANGE
147 #define HAVE_SIZECHANGE 0
150 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
151 #define USE_SIZECHANGE 1
153 #define USE_SIZECHANGE 0
155 #define USE_SIGWINCH 0
159 * If desired, one can configure this, disabling environment variables that
160 * point to custom terminfo/termcap locations.
162 #ifdef USE_ROOT_ENVIRON
163 #define use_terminfo_vars() 1
165 #define use_terminfo_vars() _nc_env_access()
166 extern NCURSES_EXPORT(int) _nc_env_access (void);
170 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
174 #define memmove(d,s,n) bcopy(s,d,n)
176 #define memmove(d,s,n) _nc_memmove(d,s,n)
177 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
181 * If we have va_copy(), use it for assigning va_list's.
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)
190 #define begin_va_copy(dst,src) (dst) = (src)
191 #define end_va_copy(dst) /* nothing */
195 * Scroll hints are useless when hashmap is used
197 #if !USE_SCROLL_HINTS
199 #define USE_SCROLL_HINTS 1
201 #define USE_SCROLL_HINTS 0
206 #define if_USE_SCROLL_HINTS(stmt) stmt
208 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
212 * Options for terminal drivers, etc...
214 #ifdef USE_TERM_DRIVER
215 #define USE_SP_RIPOFF 1
216 #define USE_SP_TERMTYPE 1
217 #define USE_SP_WINDOWLIST 1
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.
228 #define TRIES struct 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. */
238 * Common/troublesome character definitions
240 #define StringOf(ch) {ch, 0}
247 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
250 * Structure for palette tables
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() */
261 #define MAXCOLUMNS 135
263 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
267 #define WINDOWLIST struct _win_list
269 #if USE_WIDEC_SUPPORT
270 #define _nc_bkgd _bkgrnd
272 #undef _XOPEN_SOURCE_EXTENDED
274 #define _nc_bkgd _bkgd
275 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
276 #define wbkgrnd wbkgd
279 #undef NCURSES_OPAQUE
280 #define NCURSES_INTERNALS 1
281 #define NCURSES_OPAQUE 0
283 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
286 * If curses.h did not expose the SCREEN-functions, then we do not need the
287 * parameter in the corresponding unextended functions.
290 #define USE_SP_FUNC_SUPPORT NCURSES_SP_FUNCS
291 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_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
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
309 #include <nc_panel.h>
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))
315 #if BROKEN_LINKER || USE_REENTRANT
316 #define CurTerm _nc_prescreen._cur_term
318 #define CurTerm cur_term
322 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
324 #define TerminalOf(sp) CurTerm
330 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
331 * pointer to this data.
333 #ifdef USE_SP_TERMTYPE
337 #define SP_TERMTYPE TerminalOf(sp)->type.
339 #include <term_entry.h>
341 #include <nc_tparm.h>
344 * Use these macros internally, to make tracing less verbose. But leave the
345 * option for compiling the tracing into the library.
348 #define ColorPair(n) NCURSES_BITS(n, 0)
349 #define PairNumber(a) (NCURSES_CAST(int,(((a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
351 #define ColorPair(pair) COLOR_PAIR(pair)
352 #define PairNumber(attr) PAIR_NUMBER(attr)
355 #define unColor(n) unColor2(AttrOf(n))
356 #define unColor2(a) ((a) & ALL_BUT_COLOR)
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.
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))
377 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
379 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
382 #else /* !NCURSES_EXT_COLORS */
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))
394 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
396 #define VIDATTR(sp,attr,pair) vidattr(attr)
399 #endif /* NCURSES_EXT_COLORS */
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 *);
406 #define GetNoPadding(sp) FALSE
407 #define SetNoPadding(sp) /*nothing*/
410 #define WINDOW_ATTRS(w) ((w)->_attrs)
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)
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 *);
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))
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
437 #define ptrLines(sp) &LINES
438 #define ptrCols(sp) &COLS
439 #define ptrTabsize(sp) &TABSIZE
440 #define ptrEscdelay(sp) &ESCDELAY
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
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)
461 #if defined(__GNUC__)
462 # if defined __USE_ISOC99
463 # define _cat_pragma(exp) _Pragma(#exp)
464 # define _weak_pragma(exp) _cat_pragma(weak name)
466 # define _weak_pragma(exp)
468 # define _declare(name) __extension__ extern __typeof__(name) name
469 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
477 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
478 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
479 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
480 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
481 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
482 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
483 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
484 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
487 #error POSIX threads requires --enable-reentrant option
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 *);
503 # define sigprocmask _nc_sigprocmask
508 #undef HAVE_NANOSLEEP
509 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
512 #else /* !USE_PTHREADS */
514 #if USE_PTHREADS_EINTR
515 # if USE_WEAK_SYMBOLS
517 weak_symbol(pthread_sigmask);
518 weak_symbol(pthread_kill);
519 weak_symbol(pthread_self);
520 weak_symbol(pthread_equal);
521 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
523 # define sigprocmask _nc_sigprocmask
525 #endif /* USE_PTHREADS_EINTR */
527 #define _nc_init_pthreads() /* nothing */
528 #define _nc_mutex_init(obj) /* nothing */
530 #define _nc_lock_global(name) /* nothing */
531 #define _nc_try_global(name) 0
532 #define _nc_unlock_global(name) /* nothing */
534 #endif /* USE_PTHREADS */
537 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
538 * So the locking is done in the non-sp-func (which calls the sp-func) rather
539 * than in the sp-func itself.
541 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
542 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
546 #define _nc_nonsp_lock_global(name) /* nothing */
547 #define _nc_nonsp_try_global(name) 0
548 #define _nc_nonsp_unlock_global(name) /* nothing */
550 #define _nc_sp_lock_global(name) _nc_lock_global(name)
551 #define _nc_sp_try_global(name) _nc_try_global(name)
552 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
556 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
557 #define _nc_nonsp_try_global(name) _nc_try_global(name)
558 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
560 #define _nc_sp_lock_global(name) /* nothing */
561 #define _nc_sp_try_global(name) 0
562 #define _nc_sp_unlock_global(name) /* nothing */
566 #if HAVE_GETTIMEOFDAY
567 # define PRECISE_GETTIME 1
568 # define TimeType struct timeval
570 # define PRECISE_GETTIME 0
571 # define TimeType time_t
575 * Definitions for color pairs
577 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
578 #define C_SHIFT 9 /* we need more bits than there are colors */
579 #define C_MASK ((1 << C_SHIFT) - 1)
580 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
581 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
582 #define BACK_OF(c) ((c) & C_MASK)
583 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
585 #define COLOR_DEFAULT C_MASK
587 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
589 #undef NCURSES_CH_T /* this is not a termlib feature */
590 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
592 #endif /* USE_TERMLIB */
597 NCURSES_CH_T *text; /* text of the line */
598 NCURSES_SIZE_T firstchar; /* first changed character in the line */
599 NCURSES_SIZE_T lastchar; /* last changed character in the line */
600 NCURSES_SIZE_T oldindex; /* index of the line at last update */
602 #endif /* USE_TERMLIB */
605 M_XTERM = -1 /* use xterm's mouse tracking? */
606 ,M_NONE = 0 /* no mouse device */
611 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
613 #ifdef USE_TERM_DRIVER
614 ,M_TERM_DRIVER /* Win32 console, etc */
619 * Structures for scrolling.
623 unsigned long hashval;
624 int oldcount, newcount;
625 int oldindex, newindex;
629 * Structures for soft labels.
634 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
638 char *ent_text; /* text for the label */
639 char *form_text; /* formatted text (left/center/...) */
640 int ent_x; /* x coordinate of this field */
641 char dirty; /* this label has changed */
642 char visible; /* field is visible */
645 typedef struct _SLK {
646 bool dirty; /* all labels have changed */
647 bool hidden; /* soft labels are hidden */
650 short maxlab; /* number of available labels */
651 short labcnt; /* number of allocated labels */
652 short maxlen; /* length of labels */
653 NCURSES_CH_T attr; /* soft label attribute */
656 #endif /* USE_TERMLIB */
659 WINDOW *win; /* the window used in the hook */
660 int line; /* lines to take, < 0 => from bottom*/
661 int (*hook)(WINDOW *, int); /* callback for user */
665 #undef buttons /* term.h defines this, and gpm uses it! */
669 /* link dynamically to GPM */
670 typedef int *TYPE_gpm_fd;
671 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
672 typedef int (*TYPE_Gpm_Close) (void);
673 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
675 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
676 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
677 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
678 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
680 /* link statically to GPM */
681 #define my_gpm_fd &gpm_fd
682 #define my_Gpm_Open Gpm_Open
683 #define my_Gpm_Close Gpm_Close
684 #define my_Gpm_GetEvent Gpm_GetEvent
685 #endif /* HAVE_LIBDL */
686 #endif /* USE_GPM_SUPPORT */
691 char *fix_sgr0; /* this holds the filtered sgr0 string */
692 char *last_bufp; /* help with fix_sgr0 leak */
696 #define TGETENT_MAX 4
717 const char *tparam_base;
719 STACK_FRAME stack[STACKSIZE];
729 int dynamic_var[NUM_VARS];
730 int static_vars[NUM_VARS];
739 * The filesystem database normally uses a single-letter for the lower level
740 * of directories. Use a hexadecimal code for filesystems which do not
741 * preserve mixed-case names.
743 #if MIXEDCASE_FILENAMES
744 #define LEAF_FMT "%c"
747 #define LEAF_FMT "%02x"
752 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
753 * could at most have 10 digits, and the mask contains no more than 32 bits
754 * with each bit representing less than 15 characters. Usually the whole
755 * string is less than 80 columns, but this buffer size is an absolute
758 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
759 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
761 #ifdef USE_TERM_DRIVER
762 struct DriverTCB; /* Terminal Control Block forward declaration */
763 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
765 #define INIT_TERM_DRIVER() /* nothing */
769 * Global data which is not specific to a screen.
772 SIG_ATOMIC_T have_sigwinch;
773 SIG_ATOMIC_T cleanup_nested;
778 const char *comp_sourcename;
781 bool have_tic_directory;
782 bool keep_tic_directory;
783 const char *tic_directory;
789 char **keyname_table;
794 size_t safeprint_used;
796 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
798 long tgetent_sequence;
800 #ifndef USE_SP_WINDOWLIST
801 WINDOWLIST *_nc_windowlist;
802 #define WindowList(sp) _nc_globals._nc_windowlist
805 #if USE_HOME_TERMINFO
809 #if !USE_SAFE_SPRINTF
814 #ifdef USE_TERM_DRIVER
815 int (*term_driver)(struct DriverTCB*, const char*, int*);
820 char trace_fname[PATH_MAX];
825 size_t tracearg_used;
827 TRACEBUF *tracebuf_ptr;
828 size_t tracebuf_used;
830 char tracechr_buf[40];
833 size_t tracedmp_used;
835 unsigned char *tracetry_buf;
836 size_t tracetry_used;
838 char traceatr_color_buf[2][80];
839 int traceatr_color_sel;
840 int traceatr_color_last;
841 #if !defined(USE_PTHREADS) && USE_REENTRANT
847 pthread_mutex_t mutex_curses;
848 pthread_mutex_t mutex_tst_tracef;
849 pthread_mutex_t mutex_tracef;
852 #define _nc_use_pthreads _nc_globals.use_pthreads
854 #if USE_PTHREADS_EINTR
855 pthread_t read_thread; /* The reading thread */
859 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
864 * Global data which can be swept up into a SCREEN when one is created.
865 * It may be modified before the next SCREEN is created.
870 attr_t previous_attr;
871 #ifndef USE_SP_RIPOFF
872 ripoff_t rippedoff[N_RIPS];
875 TPARM_STATE tparm_state;
876 TTY *saved_tty; /* savetty/resetty information */
877 #if NCURSES_NO_PADDING
878 bool _no_padding; /* flag to set if padding disabled */
880 NCURSES_SP_OUTC _outch; /* output handler if not putc */
881 #if BROKEN_LINKER || USE_REENTRANT
882 chtype *real_acs_map;
890 const char *_tputs_trace;
896 * Use screen-specific ripoff data (for softkeys) rather than global.
899 #define safe_ripoff_sp (sp)->rsp
900 #define safe_ripoff_stack (sp)->rippedoff
902 #define safe_ripoff_sp _nc_prescreen.rsp
903 #define safe_ripoff_stack _nc_prescreen.rippedoff
906 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
909 * The SCREEN structure.
913 int _ifd; /* input file ptr for screen */
914 FILE *_ofp; /* output file ptr for screen */
915 char *_setbuf; /* buffered I/O for output */
916 bool _filtered; /* filter() was called */
917 bool _buffered; /* setvbuf uses _setbuf data */
918 bool _prescreen; /* is in prescreen phase */
919 bool _use_env; /* LINES & COLS from environment? */
920 int _checkfd; /* filedesc for typeahead check */
921 TERMINAL *_term; /* terminal type information */
922 TTY _saved_tty; /* savetty/resetty information */
923 NCURSES_SIZE_T _lines; /* screen lines */
924 NCURSES_SIZE_T _columns; /* screen columns */
926 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
927 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
929 WINDOW *_curscr; /* current screen */
930 WINDOW *_newscr; /* virtual screen to be updated to */
931 WINDOW *_stdscr; /* screen's full-window context */
933 #define CurScreen(sp) (sp)->_curscr
934 #define NewScreen(sp) (sp)->_newscr
935 #define StdScreen(sp) (sp)->_stdscr
937 TRIES *_keytry; /* "Try" for use with keypad mode */
938 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
939 bool _tried; /* keypad mode was initialized */
940 bool _keypad_on; /* keypad mode is currently on */
942 bool _called_wgetch; /* check for recursion in wgetch() */
943 int _fifo[FIFO_SIZE]; /* input push-back buffer */
944 short _fifohead, /* head of fifo queue */
945 _fifotail, /* tail of fifo queue */
946 _fifopeek, /* where to peek for next char */
947 _fifohold; /* set if breakout marked */
949 int _endwin; /* are we out of window mode? */
950 NCURSES_CH_T *_current_attr; /* holds current attributes set */
951 int _coloron; /* is color enabled? */
952 int _color_defs; /* are colors modified */
953 int _cursor; /* visibility of the cursor */
954 int _cursrow; /* physical cursor row */
955 int _curscol; /* physical cursor column */
956 bool _notty; /* true if we cannot switch non-tty */
957 int _nl; /* True if NL -> CR/NL is on */
958 int _raw; /* True if in raw mode */
959 int _cbreak; /* 1 if in cbreak mode */
960 /* > 1 if in halfdelay mode */
961 int _echo; /* True if echo on */
962 int _use_meta; /* use the meta key? */
963 struct _SLK *_slk; /* ptr to soft key struct / NULL */
964 int slk_format; /* selected format for this screen */
965 /* cursor movement costs; units are 10ths of milliseconds */
966 #if NCURSES_NO_PADDING
967 bool _no_padding; /* flag to set if padding disabled */
969 int _char_padding; /* cost of character put */
970 int _cr_cost; /* cost of (carriage_return) */
971 int _cup_cost; /* cost of (cursor_address) */
972 int _home_cost; /* cost of (cursor_home) */
973 int _ll_cost; /* cost of (cursor_to_ll) */
975 int _ht_cost; /* cost of (tab) */
976 int _cbt_cost; /* cost of (backtab) */
977 #endif /* USE_HARD_TABS */
978 int _cub1_cost; /* cost of (cursor_left) */
979 int _cuf1_cost; /* cost of (cursor_right) */
980 int _cud1_cost; /* cost of (cursor_down) */
981 int _cuu1_cost; /* cost of (cursor_up) */
982 int _cub_cost; /* cost of (parm_cursor_left) */
983 int _cuf_cost; /* cost of (parm_cursor_right) */
984 int _cud_cost; /* cost of (parm_cursor_down) */
985 int _cuu_cost; /* cost of (parm_cursor_up) */
986 int _hpa_cost; /* cost of (column_address) */
987 int _vpa_cost; /* cost of (row_address) */
988 /* used in tty_update.c, must be chars */
989 int _ed_cost; /* cost of (clr_eos) */
990 int _el_cost; /* cost of (clr_eol) */
991 int _el1_cost; /* cost of (clr_bol) */
992 int _dch1_cost; /* cost of (delete_character) */
993 int _ich1_cost; /* cost of (insert_character) */
994 int _dch_cost; /* cost of (parm_dch) */
995 int _ich_cost; /* cost of (parm_ich) */
996 int _ech_cost; /* cost of (erase_chars) */
997 int _rep_cost; /* cost of (repeat_char) */
998 int _hpa_ch_cost; /* cost of (column_address) */
999 int _cup_ch_cost; /* cost of (cursor_address) */
1000 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1001 int _inline_cost; /* cost of inline-move */
1002 int _smir_cost; /* cost of (enter_insert_mode) */
1003 int _rmir_cost; /* cost of (exit_insert_mode) */
1004 int _ip_cost; /* cost of (insert_padding) */
1005 /* used in lib_mvcur.c */
1006 char * _address_cursor;
1007 /* used in tty_update.c */
1008 int _scrolling; /* 1 if terminal's smart enough to */
1010 /* used in lib_color.c */
1011 color_t *_color_table; /* screen's color palette */
1012 int _color_count; /* count of colors in palette */
1013 colorpair_t *_color_pairs; /* screen's color pair list */
1014 int _pair_count; /* count of color pairs */
1015 int _pair_limit; /* actual limit of color-pairs */
1016 #if NCURSES_EXT_FUNCS
1017 bool _default_color; /* use default colors */
1018 bool _has_sgr_39_49; /* has ECMA default color support */
1019 int _default_fg; /* assumed default foreground */
1020 int _default_bg; /* assumed default background */
1021 int _default_pairs; /* count pairs using default color */
1023 chtype _ok_attributes; /* valid attributes for terminal */
1024 chtype _xmc_suppress; /* attributes to suppress if xmc */
1025 chtype _xmc_triggers; /* attributes to process if xmc */
1026 chtype * _acs_map; /* the real alternate-charset map */
1027 bool * _screen_acs_map;
1030 /* used in lib_vidattr.c */
1031 bool _use_rmso; /* true if we may use 'rmso' */
1032 bool _use_rmul; /* true if we may use 'rmul' */
1035 * These data correspond to the state of the idcok() and idlok()
1036 * functions. A caveat is in order here: the XSI and SVr4
1037 * documentation specify that these functions apply to the window which
1038 * is given as an argument. However, ncurses implements this logic
1039 * only for the newscr/curscr update process, _not_ per-window.
1045 * These are the data that support the mouse interface.
1047 bool _mouse_initialized;
1048 MouseType _mouse_type;
1050 bool (*_mouse_event) (SCREEN *);
1051 bool (*_mouse_inline)(SCREEN *);
1052 bool (*_mouse_parse) (SCREEN *, int);
1053 void (*_mouse_resume)(SCREEN *);
1054 void (*_mouse_wrap) (SCREEN *);
1055 int _mouse_fd; /* file-descriptor, if any */
1056 bool _mouse_active; /* true if initialized */
1057 mmask_t _mouse_mask;
1058 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1059 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1060 MEVENT *_mouse_eventp; /* next free slot in event queue */
1063 bool _mouse_gpm_loaded;
1064 bool _mouse_gpm_found;
1067 TYPE_gpm_fd _mouse_gpm_fd;
1068 TYPE_Gpm_Open _mouse_Gpm_Open;
1069 TYPE_Gpm_Close _mouse_Gpm_Close;
1070 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1072 Gpm_Connect _mouse_gpm_connect;
1073 #endif /* USE_GPM_SUPPORT */
1077 int _emxmouse_thread;
1078 int _emxmouse_activated;
1079 char _emxmouse_buttons[4];
1083 MEVENT _sysmouse_fifo[FIFO_SIZE];
1086 int _sysmouse_char_width; /* character width */
1087 int _sysmouse_char_height; /* character height */
1088 int _sysmouse_old_buttons;
1089 int _sysmouse_new_buttons;
1092 #ifdef USE_TERM_DRIVER
1093 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1094 int _drv_mouse_head;
1095 int _drv_mouse_tail;
1096 int _drv_mouse_old_buttons;
1097 int _drv_mouse_new_buttons;
1100 * This supports automatic resizing
1103 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1107 * These are data that support the proper handling of the panel stack on an
1110 struct panelhook _panelHook;
1113 SCREEN *_next_screen;
1115 /* hashes for old and new lines */
1116 unsigned long *oldhash, *newhash;
1122 bool _cleanup; /* cleanup after int/quit signal */
1123 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1125 int _legacy_coding; /* see use_legacy_coding() */
1128 char _ttytype[NAMESIZE];
1135 const char *_tputs_trace;
1140 char tracechr_buf[40];
1141 char tracemse_buf[TRACEMSE_MAX];
1143 #ifdef USE_SP_WINDOWLIST
1144 WINDOWLIST* _windowlist;
1145 #define WindowList(sp) (sp)->_windowlist
1149 ripoff_t rippedoff[N_RIPS];
1153 * ncurses/ncursesw are the same up to this point.
1155 #if USE_WIDEC_SUPPORT
1156 /* recent versions of 'screen' have partially-working support for
1157 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1159 bool _screen_acs_fix;
1163 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1164 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1168 SCREEN *screen; /* screen containing the window */
1169 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1170 #ifdef NCURSES_WIDECHAR
1171 char addch_work[(MB_LEN_MAX * 9) + 1];
1172 unsigned addch_used; /* number of bytes in addch_work[] */
1173 int addch_x; /* x-position for addch_work[] */
1174 int addch_y; /* y-position for addch_work[] */
1178 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((char *)(w) - offsetof(WINDOWLIST, win)))->m)
1180 #define SP_PRE_INIT(sp) \
1181 sp->_cursrow = -1; \
1182 sp->_curscol = -1; \
1187 sp->_fifohead = -1; \
1188 sp->_endwin = TRUE; \
1190 WindowList(sp) = 0; \
1191 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1194 /* usually in <limits.h> */
1196 #define UCHAR_MAX 255
1199 /* The terminfo source is assumed to be 7-bit ASCII */
1200 #define is7bits(c) ((unsigned)(c) < 128)
1202 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1203 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1206 #define min(a,b) ((a) > (b) ? (b) : (a))
1210 #define max(a,b) ((a) < (b) ? (b) : (a))
1213 /* usually in <unistd.h> */
1214 #ifndef STDIN_FILENO
1215 #define STDIN_FILENO 0
1218 #ifndef STDOUT_FILENO
1219 #define STDOUT_FILENO 1
1222 #ifndef STDERR_FILENO
1223 #define STDERR_FILENO 2
1226 #ifndef EXIT_SUCCESS
1227 #define EXIT_SUCCESS 0
1230 #ifndef EXIT_FAILURE
1231 #define EXIT_FAILURE 1
1235 #define R_OK 4 /* Test for read permission. */
1238 #define W_OK 2 /* Test for write permission. */
1241 #define X_OK 1 /* Test for execute permission. */
1244 #define F_OK 0 /* Test for existence. */
1248 #include <fcntl.h> /* may define O_BINARY */
1257 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1259 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1262 #define COUNT_OUTCHARS(n) /* nothing */
1265 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1267 #define UChar(c) ((unsigned char)(c))
1268 #define UShort(c) ((unsigned short)(c))
1269 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1270 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1273 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1276 #if USE_WIDEC_SUPPORT /* { */
1277 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1279 #define init_mb(state) memset(&state, 0, sizeof(state))
1281 #if NCURSES_EXT_COLORS
1282 #define NulColor , 0
1284 #define NulColor /* nothing */
1287 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1288 #define CharOf(c) ((c).chars[0])
1289 #define AttrOf(c) ((c).attr)
1291 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1292 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1293 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1295 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1296 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1299 #define CharEq(a,b) (((a).attr == (b).attr) \
1300 && (a).chars[0] == (b).chars[0] \
1301 && (a).chars[1] == (b).chars[1] \
1302 && (a).chars[2] == (b).chars[2] \
1303 && (a).chars[3] == (b).chars[3] \
1304 && (a).chars[4] == (b).chars[4] \
1305 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1307 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1310 #define SetChar(ch,c,a) do { \
1311 NCURSES_CH_T *_cp = &ch; \
1312 memset(_cp, 0, sizeof(ch)); \
1313 _cp->chars[0] = (c); \
1315 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1317 #define CHREF(wch) (&wch)
1318 #define CHDEREF(wch) (*wch)
1319 #define ARG_CH_T NCURSES_CH_T *
1320 #define CARG_CH_T const NCURSES_CH_T *
1321 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1322 mbstate_t PUT_st; wchar_t PUTC_ch
1323 #define PUTC_INIT init_mb (PUT_st)
1324 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1325 if (Charable(ch)) { \
1326 fputc(CharOf(ch), b); \
1327 COUNT_OUTCHARS(1); \
1330 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1331 PUTC_ch = (ch).chars[PUTC_i]; \
1332 if (PUTC_ch == L'\0') \
1334 PUTC_n = wcrtomb(PUTC_buf, \
1335 (ch).chars[PUTC_i], &PUT_st); \
1336 if (PUTC_n <= 0) { \
1337 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1341 IGNORE_RC(fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b)); \
1343 COUNT_OUTCHARS(PUTC_i); \
1346 #define BLANK NewChar2(' ', WA_NORMAL)
1347 #define ZEROS NewChar2('\0', WA_NORMAL)
1348 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1351 * Wide characters cannot be represented in the A_CHARTEXT mask of
1352 * attr_t's but an application might have set a narrow character there.
1353 * But even in that case, it would only be a printable character, or
1354 * zero. Otherwise we can use those bits to tell if a cell is the
1355 * first or extension part of a wide character.
1357 #define WidecExt(ch) (AttrOf(ch) & A_CHARTEXT)
1358 #define isWidecBase(ch) (WidecExt(ch) == 1)
1359 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1360 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1361 AttrOf(dst) |= (attr_t) (ext + 1)
1363 #define if_WIDEC(code) code
1364 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1365 || (AttrOf(ch) & A_ALTCHARSET) \
1366 || (!isWidecExt(ch) && \
1367 (ch).chars[1] == L'\0' && \
1368 _nc_is_charable(CharOf(ch))))
1370 #define L(ch) L ## ch
1372 #define CharOf(c) ChCharOf(c)
1373 #define AttrOf(c) ChAttrOf(c)
1374 #define AddAttr(c,a) c |= (a)
1375 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1376 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1377 #define NewChar(ch) (ch)
1378 #define NewChar2(c,a) ((c) | (a))
1379 #define CharEq(a,b) ((a) == (b))
1380 #define SetChar(ch,c,a) ch = (c) | (a)
1381 #define CHREF(wch) wch
1382 #define CHDEREF(wch) wch
1383 #define ARG_CH_T NCURSES_CH_T
1384 #define CARG_CH_T NCURSES_CH_T
1385 #define PUTC_DATA int data = 0
1386 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1388 #define BLANK (' '|A_NORMAL)
1389 #define ZEROS ('\0'|A_NORMAL)
1390 #define ISBLANK(ch) (CharOf(ch) == ' ')
1392 #define isWidecExt(ch) (0)
1393 #define if_WIDEC(code) /* nothing */
1398 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1399 #define CharOfD(ch) CharOf(CHDEREF(ch))
1400 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1402 #define BLANK_ATTR A_NORMAL
1403 #define BLANK_TEXT L(' ')
1407 #define LEGALYX(w, y, x) \
1409 ((x) >= 0 && (x) <= (w)->_maxx && \
1410 (y) >= 0 && (y) <= (w)->_maxy))
1412 #define CHANGED_CELL(line,col) \
1413 if (line->firstchar == _NOCHANGE) \
1414 line->firstchar = line->lastchar = (NCURSES_SIZE_T) col; \
1415 else if ((col) < line->firstchar) \
1416 line->firstchar = (NCURSES_SIZE_T) col; \
1417 else if ((col) > line->lastchar) \
1418 line->lastchar = (NCURSES_SIZE_T) col
1420 #define CHANGED_RANGE(line,start,end) \
1421 if (line->firstchar == _NOCHANGE \
1422 || line->firstchar > (start)) \
1423 line->firstchar = start; \
1424 if (line->lastchar == _NOCHANGE \
1425 || line->lastchar < (end)) \
1426 line->lastchar = end
1428 #define CHANGED_TO_EOL(line,start,end) \
1429 if (line->firstchar == _NOCHANGE \
1430 || line->firstchar > (start)) \
1431 line->firstchar = start; \
1432 line->lastchar = end
1434 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1436 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1438 /* FreeAndNull() is not a comma-separated expression because some compilers
1439 * do not accept a mixture of void with values.
1441 #define FreeAndNull(p) free(p); p = 0
1443 #include <nc_alloc.h>
1446 * TTY bit definition for converting tabs to spaces.
1449 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1452 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1455 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1457 # define OFLAGS_TABS 0
1463 * Standardize/simplify common loops
1465 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1466 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1467 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1470 * Prefixes for call/return points of library function traces. We use these to
1471 * instrument the public functions so that the traces can be easily transformed
1472 * into regression scripts.
1474 #define T_CALLED(fmt) "called {" fmt
1475 #define T_CREATE(fmt) "create :" fmt
1476 #define T_RETURN(fmt) "return }" fmt
1481 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1483 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1486 #define START_TRACE() \
1487 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1488 int t = _nc_getenv_num("NCURSES_TRACE"); \
1490 trace((unsigned) t); \
1494 * Many of the _tracef() calls use static buffers; lock the trace state before
1495 * trying to fill them.
1498 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1499 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1500 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1502 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1503 #define _nc_locked_tracef _tracef
1506 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1507 #define T(a) TR(TRACE_CALLS, a)
1508 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1510 #define NonNull(s) ((s) != 0 ? s : "<null>")
1512 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1513 #define returnBits(code) TRACE_RETURN(code,unsigned)
1514 #define returnBool(code) TRACE_RETURN(code,bool)
1515 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1516 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1517 #define returnChar(code) TRACE_RETURN(code,char)
1518 #define returnChtype(code) TRACE_RETURN(code,chtype)
1519 #define returnCode(code) TRACE_RETURN(code,int)
1520 #define returnPtr(code) TRACE_RETURN(code,ptr)
1521 #define returnSP(code) TRACE_RETURN(code,sp)
1522 #define returnVoid T((T_RETURN(""))); return
1523 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1524 #define returnWin(code) TRACE_RETURN(code,win)
1526 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
1527 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1528 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1529 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1530 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1531 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1532 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1533 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1534 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1535 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1536 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1537 extern NCURSES_EXPORT(char) _nc_retrace_char (char);
1538 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1539 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1540 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1541 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1544 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1545 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1546 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1547 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1548 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1549 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1551 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1552 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1555 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1557 #if USE_WIDEC_SUPPORT
1558 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1559 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1562 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1563 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1567 #define START_TRACE() /* nothing */
1571 #define TPUTS_TRACE(s)
1573 #define returnAttr(code) return code
1574 #define returnBits(code) return code
1575 #define returnBool(code) return code
1576 #define returnCPtr(code) return code
1577 #define returnCVoidPtr(code) return code
1578 #define returnChar(code) return ((char) code)
1579 #define returnChtype(code) return code
1580 #define returnCode(code) return code
1581 #define returnPtr(code) return code
1582 #define returnSP(code) return code
1583 #define returnVoid return
1584 #define returnVoidPtr(code) return code
1585 #define returnWin(code) return code
1587 #endif /* TRACE/!TRACE */
1590 * Workaround for defective implementation of gcc attribute warn_unused_result
1592 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1593 #define IGNORE_RC(func) errno = func
1595 #define IGNORE_RC(func) (void) func
1596 #endif /* gcc workarounds */
1599 * Return-codes for tgetent() and friends.
1601 #define TGETENT_YES 1 /* entry is found */
1602 #define TGETENT_NO 0 /* entry is not found */
1603 #define TGETENT_ERR -1 /* an error occurred */
1605 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1606 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1608 #define EMPTY_MODULE(name) \
1609 extern NCURSES_EXPORT(void) name (void); \
1610 NCURSES_EXPORT(void) name (void) { }
1612 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1613 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1614 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1616 #define toggle_attr_on(S,at) {\
1617 if (PairNumber(at) > 0) {\
1618 (S) = ((S) & ALL_BUT_COLOR) | (at);\
1622 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1625 #define toggle_attr_off(S,at) {\
1626 if (PairNumber(at) > 0) {\
1627 (S) &= ~(at|A_COLOR);\
1631 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1633 #define DelCharCost(sp,count) \
1636 : ((delete_character != 0) \
1637 ? (sp->_dch1_cost * count) \
1640 #define InsCharCost(sp,count) \
1643 : ((enter_insert_mode && exit_insert_mode) \
1644 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1645 : ((insert_character != 0) \
1646 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1650 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1651 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1652 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1653 if (magic_cookie_glitch > 0 \
1654 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1655 T(("%s @%d before glitch %d,%d", \
1656 __FILE__, __LINE__, \
1659 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1663 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1664 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1669 * Macros to make additional parameter to implement wgetch_events()
1671 #ifdef NCURSES_WGETCH_EVENTS
1672 #define EVENTLIST_0th(param) param
1673 #define EVENTLIST_1st(param) param
1674 #define EVENTLIST_2nd(param) , param
1675 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1677 #define EVENTLIST_0th(param) void
1678 #define EVENTLIST_1st(param) /* nothing */
1679 #define EVENTLIST_2nd(param) /* nothing */
1680 #define TWAIT_MASK TW_ANY
1683 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1685 #undef toggle_attr_on
1686 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1687 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1689 #undef toggle_attr_off
1690 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1691 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1694 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1697 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1699 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1700 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1703 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1705 #if defined(NEED_NCURSES_CH_T)
1706 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1708 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1711 #if NCURSES_SP_FUNCS
1712 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1713 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1714 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1715 #endif /* NCURSES_SP_FUNCS */
1719 extern NCURSES_EXPORT(void) _nc_expanded (void);
1723 #if !NCURSES_EXT_FUNCS
1724 #define set_escdelay(value) ESCDELAY = value
1728 #define getcwd(buf,len) getwd(buf)
1732 #if USE_WIDEC_SUPPORT
1733 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1734 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1735 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1740 short nte_name; /* offset of name to hash on */
1741 int nte_type; /* BOOLEAN, NUMBER or STRING */
1742 short nte_index; /* index of associated variable in its array */
1743 short nte_link; /* index in table of next hash, or -1 */
1755 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1759 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1760 extern NCURSES_EXPORT(void) _nc_linedump (void);
1764 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1765 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1768 #if USE_WIDEC_SUPPORT
1769 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1773 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1774 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1778 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1781 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1784 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1787 #define INFINITY 1000000 /* cost: too high to use */
1789 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1790 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1791 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1793 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1795 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1796 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1797 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1800 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1803 #define INFINITY 1000000 /* cost: too high to use */
1804 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1807 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1808 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1809 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1810 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1811 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, char);
1813 /* lib_set_term.c */
1814 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1818 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1820 #define _nc_handle_sigwinch(a) /* nothing */
1824 #if USE_WIDEC_SUPPORT
1825 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1829 char *s_head; /* beginning of the string (may be null) */
1830 char *s_tail; /* end of the string (may be null) */
1831 size_t s_size; /* current remaining size available */
1832 size_t s_init; /* total size available */
1836 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1837 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1838 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1839 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1840 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1843 #define strstr _nc_strstr
1844 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1847 /* safe_sprintf.c */
1848 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1851 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1852 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1853 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1854 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1857 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1858 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1859 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1860 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1861 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1862 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1863 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1864 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1865 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1866 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1867 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1868 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1869 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1870 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1871 extern NCURSES_EXPORT(int) _nc_outch (int);
1872 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1873 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1874 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1875 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1876 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
1877 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1878 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, NCURSES_OUTC);
1879 extern NCURSES_EXPORT(void) _nc_flush (void);
1880 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1881 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1882 extern NCURSES_EXPORT(void) _nc_freeall (void);
1883 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1884 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1885 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1886 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1887 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1888 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1889 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1890 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1891 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1892 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1895 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1896 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1897 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1898 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1899 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1900 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1901 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1902 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1905 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1906 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1907 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1908 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1911 #if USE_WIDEC_SUPPORT
1912 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1915 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1916 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1920 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1924 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1926 #define _nc_resize_margins(wp) /* nothing */
1929 #ifdef NCURSES_WGETCH_EVENTS
1930 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1932 #define wgetch_events(win, evl) wgetch(win)
1933 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1937 * Wide-character macros to hide some platform-differences.
1939 #if USE_WIDEC_SUPPORT
1940 #if HAVE_MBTOWC && HAVE_MBLEN
1941 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
1942 #define count_mbytes(buffer,length,state) mblen(buffer,length)
1943 #define check_mbytes(wch,buffer,length,state) \
1944 (int) mbtowc(&wch, buffer, length)
1945 #define state_unused
1946 #elif HAVE_MBRTOWC && HAVE_MBRLEN
1947 #define reset_mbytes(state) init_mb(state)
1948 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
1949 #define check_mbytes(wch,buffer,length,state) \
1950 (int) mbrtowc(&wch, buffer, length, &state)
1957 * Not everyone has vsscanf(), but we'd like to use it for scanw().
1960 extern int vsscanf(const char *str, const char *format, va_list __arg);
1963 /* scroll indices */
1964 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1966 #define USE_SETBUF_0 0
1968 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
1970 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
1973 * On systems with a broken linker, define 'SP' as a function to force the
1974 * linker to pull in the data-only module with 'SP'.
1976 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
1979 #define SP _nc_screen()
1980 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1981 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1982 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1983 #define CURRENT_SCREEN _nc_screen()
1985 /* current screen is private data; avoid possible linking conflicts too */
1986 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1987 #define CURRENT_SCREEN SP
1988 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
1989 #define _nc_set_screen(sp) SP = sp
1992 #if NCURSES_SP_FUNCS
1993 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
1995 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
1999 * We don't want to use the lines or columns capabilities internally, because
2000 * if the application is running multiple screens under X, it's quite possible
2001 * they could all have type xterm but have different sizes! So...
2003 #define screen_lines(sp) (sp)->_lines
2004 #define screen_columns(sp) (sp)->_columns
2006 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2007 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2010 * Some constants related to SLK's
2012 #define MAX_SKEY_OLD 8 /* count of soft keys */
2013 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2014 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2015 #define MAX_SKEY_LEN_PC 5
2017 /* Macro to check whether or not we use a standard format */
2018 #define SLK_STDFMT(fmt) (fmt < 3)
2019 /* Macro to determine height of label window */
2020 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2022 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2023 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2026 * Common error messages
2028 #define MSG_NO_MEMORY "Out of memory"
2029 #define MSG_NO_INPUTS "Premature EOF"
2031 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2032 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2034 /* timed_wait flag definitions */
2038 #define TW_ANY (TW_INPUT | TW_MOUSE)
2041 #define SetSafeOutcWrapper(outc) \
2042 SCREEN* sp = CURRENT_SCREEN; \
2044 struct screen dummy; \
2046 memset(sp,0,sizeof(struct screen)); \
2047 sp->_outch = _nc_outc_wrapper; \
2051 #ifdef USE_TERM_DRIVER
2052 typedef void* TERM_HANDLE;
2054 typedef struct _termInfo
2073 const color_t* defaultPalette;
2076 typedef struct term_driver {
2078 bool (*CanHandle)(struct DriverTCB*,const char*,int*);
2079 void (*init)(struct DriverTCB*);
2080 void (*release)(struct DriverTCB*);
2081 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2082 int (*sgmode)(struct DriverTCB*, bool setFlag, TTY*);
2083 chtype (*conattr)(struct DriverTCB*);
2084 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2085 int (*mode)(struct DriverTCB*, bool progFlag, bool defFlag);
2086 bool (*rescol)(struct DriverTCB*);
2087 bool (*rescolors)(struct DriverTCB*);
2088 void (*color)(struct DriverTCB*,bool fore, int color, int(*)(SCREEN*,int));
2089 int (*doBeepOrFlash)(struct DriverTCB*, bool);
2090 void (*initpair)(struct DriverTCB*,short,short,short);
2091 void (*initcolor)(struct DriverTCB*,short,short,short,short);
2092 void (*docolor)(struct DriverTCB*,short,short,bool,int(*)(SCREEN*,int));
2093 void (*initmouse)(struct DriverTCB*);
2094 int (*testmouse)(struct DriverTCB*,int);
2095 void (*setfilter)(struct DriverTCB*);
2096 void (*hwlabel)(struct DriverTCB*,int,char*);
2097 void (*hwlabelOnOff)(struct DriverTCB*,bool);
2098 int (*update)(struct DriverTCB*);
2099 int (*defaultcolors)(struct DriverTCB*,int,int);
2100 int (*print)(struct DriverTCB*,char*,int);
2101 int (*getsize)(struct DriverTCB*,int*,int*);
2102 int (*setsize)(struct DriverTCB*,int,int);
2103 void (*initacs)(struct DriverTCB*,chtype*,chtype*);
2104 void (*scinit)(SCREEN *);
2105 void (*scexit)(SCREEN *);
2106 int (*twait)(struct DriverTCB*,int,int,int* EVENTLIST_2nd(_nc_eventlist*));
2107 int (*read)(struct DriverTCB*,int*);
2108 int (*nap)(struct DriverTCB*,int);
2109 int (*kpad)(struct DriverTCB*, bool);
2110 int (*kyOk)(struct DriverTCB*, int, bool);
2111 bool (*kyExist)(struct DriverTCB*, int);
2114 typedef struct DriverTCB
2116 TERMINAL term; /* needs to be the first Element !!! */
2117 TERM_HANDLE inp; /* The input handle of the Terminal */
2118 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2119 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2120 TERM_DRIVER* drv; /* The driver for that Terminal */
2121 SCREEN* csp; /* The screen that owns that Terminal */
2122 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2123 void* prop; /* Driver dependent property storage to be used by the Driver */
2125 } TERMINAL_CONTROL_BLOCK;
2127 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2128 #define NCDRV_TINFO 0x01
2129 #define NCDRV_WINCONSOLE 0x02
2131 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2132 #define InfoOf(sp) TCBOf(sp)->info
2133 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2134 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2135 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2136 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2137 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2139 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2140 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2142 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2143 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2144 #endif /* USE_TERM_DRIVER */
2147 * Entrypoints which are actually provided in the terminal driver, which would
2148 * be an sp-name otherwise.
2150 #ifdef USE_TERM_DRIVER
2151 #define TINFO_HAS_KEY _nc_tinfo_has_key
2152 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2153 #define TINFO_MVCUR _nc_tinfo_mvcur
2154 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2155 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2156 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2158 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2159 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2160 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2164 * Entrypoints using an extra parameter with the terminal driver.
2166 #ifdef USE_TERM_DRIVER
2167 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2168 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, bool);
2169 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2170 _nc_get_screensize(sp, tp, lp, cp)
2171 #define TINFO_SET_CURTERM(sp, tp) \
2172 NCURSES_SP_NAME(set_curterm)(sp, tp)
2173 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2174 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2175 #else /* !USE_TERM_DRIVER */
2176 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2177 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2178 _nc_get_screensize(sp, lp, cp)
2179 #define TINFO_SET_CURTERM(sp, tp) \
2181 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2182 _nc_setupterm(name, fd, err, reuse)
2183 #endif /* !USE_TERM_DRIVER */
2185 #ifdef USE_TERM_DRIVER
2187 #include <nc_mingw.h>
2188 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2190 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2193 #ifdef USE_TERM_DRIVER
2194 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2196 #define IsTermInfo(sp) TRUE
2199 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2200 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2203 * Exported entrypoints beyond the published API
2205 #if NCURSES_SP_FUNCS
2206 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2207 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2208 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2209 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2212 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2213 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2216 #if NCURSES_EXT_FUNCS
2217 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2221 * We put the safe versions of various calls here as they are not published
2222 * part of the API up to now
2224 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2225 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2226 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2227 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2228 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2229 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2230 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2231 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2232 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2233 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2234 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2235 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2236 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2237 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2238 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2239 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2240 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2241 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2242 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2243 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2244 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, bool, int);
2245 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2246 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2247 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2248 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2249 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, short, short, bool, NCURSES_SP_OUTC);
2250 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2251 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2252 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2253 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2254 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2255 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2256 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2257 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2258 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2259 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2260 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2261 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2262 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2263 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2264 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2265 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, bool);
2267 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2269 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2270 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2273 #if USE_WIDEC_SUPPORT
2274 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2277 #endif /* NCURSES_SP_FUNCS */
2279 #if NCURSES_SP_FUNCS
2281 #define safe_keyname NCURSES_SP_NAME(keyname)
2282 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2283 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2287 #define safe_keyname _nc_keyname
2288 #define safe_unctrl _nc_unctrl
2289 #define safe_ungetch _nc_ungetch
2291 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2292 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2293 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2301 #endif /* CURSES_PRIV_H */