1 /****************************************************************************
2 * Copyright (c) 1998-2010,2011 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 ****************************************************************************/
37 * $Id: curses.priv.h,v 1.479 2011/06/04 23:14:09 tom Exp $
41 * Header file for curses library objects which are private to
47 #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 #if !(defined(_POSIX_SOURCE) || defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE))
68 #include <stddef.h> /* for offsetof */
71 #include <sys/types.h>
78 #if HAVE_SYS_BSDTYPES_H
79 #include <sys/bsdtypes.h> /* needed for ISC */
84 #elif HAVE_SYS_PARAM_H
85 # include <sys/param.h>
94 # if defined(_POSIX_PATH_MAX)
95 # define PATH_MAX _POSIX_PATH_MAX
96 # elif defined(MAXPATHLEN)
97 # define PATH_MAX MAXPATHLEN
99 # define PATH_MAX 255 /* the Posix minimum path-size */
107 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
108 #if HAVE_WORKING_POLL
109 #define USE_FUNC_POLL 1
113 #include <sys/poll.h>
116 #define USE_FUNC_POLL 0
119 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
122 /* Alessandro Rubini's GPM (general-purpose mouse) */
123 #if HAVE_LIBGPM && HAVE_GPM_H
124 #define USE_GPM_SUPPORT 1
126 #define USE_GPM_SUPPORT 0
129 /* QNX mouse support */
130 #if defined(__QNX__) && !defined(__QNXNTO__)
131 #define USE_QNX_MOUSE 1
133 #define USE_QNX_MOUSE 0
136 /* EMX mouse support */
138 #define USE_EMX_MOUSE 1
140 #define USE_EMX_MOUSE 0
143 #define DEFAULT_MAXCLICK 166
144 #define EV_MAX 8 /* size of mouse circular event queue */
147 * If we don't have signals to support it, don't add a sigwinch handler.
148 * In any case, resizing is an extended feature. Use it if we've got it.
150 #if !NCURSES_EXT_FUNCS
151 #undef HAVE_SIZECHANGE
152 #define HAVE_SIZECHANGE 0
155 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
156 #define USE_SIZECHANGE 1
158 #define USE_SIZECHANGE 0
160 #define USE_SIGWINCH 0
164 * If desired, one can configure this, disabling environment variables that
165 * point to custom terminfo/termcap locations.
167 #ifdef USE_ROOT_ENVIRON
168 #define use_terminfo_vars() 1
170 #define use_terminfo_vars() _nc_env_access()
171 extern NCURSES_EXPORT(int) _nc_env_access (void);
175 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
179 #define memmove(d,s,n) bcopy(s,d,n)
181 #define memmove(d,s,n) _nc_memmove(d,s,n)
182 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
186 * If we have va_copy(), use it for assigning va_list's.
188 #if defined(HAVE___VA_COPY)
189 #define begin_va_copy(dst,src) __va_copy(dst, src)
190 #define end_va_copy(dst) va_end(dst)
191 #elif defined(va_copy) || defined(HAVE_VA_COPY)
192 #define begin_va_copy(dst,src) va_copy(dst, src)
193 #define end_va_copy(dst) va_end(dst)
195 #define begin_va_copy(dst,src) (dst) = (src)
196 #define end_va_copy(dst) /* nothing */
200 * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
201 * lack one or the other.
204 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
208 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
212 * Scroll hints are useless when hashmap is used
214 #if !USE_SCROLL_HINTS
216 #define USE_SCROLL_HINTS 1
218 #define USE_SCROLL_HINTS 0
223 #define if_USE_SCROLL_HINTS(stmt) stmt
225 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
229 * Options for terminal drivers, etc...
231 #ifdef USE_TERM_DRIVER
232 #define USE_SP_RIPOFF 1
233 #define USE_SP_TERMTYPE 1
234 #define USE_SP_WINDOWLIST 1
238 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
239 * when we're throwing control codes at the screen at high volume. To see
240 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
241 * probably don't want to define this either due to uncertainties about tab
242 * delays and expansion in raw mode.
245 #define TRIES struct tries
247 TRIES *child; /* ptr to child. NULL if none */
248 TRIES *sibling; /* ptr to sibling. NULL if none */
249 unsigned char ch; /* character at this node */
250 unsigned short value; /* code of string so far. 0 if none. */
255 * Common/troublesome character definitions
257 #define StringOf(ch) {ch, 0}
264 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
267 * Structure for palette tables
272 short red, green, blue; /* what color_content() returns */
273 short r, g, b; /* params to init_color() */
274 int init; /* true if we called init_color() */
278 #define MAXCOLUMNS 135
280 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
284 #define WINDOWLIST struct _win_list
286 #if USE_WIDEC_SUPPORT
287 #define _nc_bkgd _bkgrnd
289 #undef _XOPEN_SOURCE_EXTENDED
291 #define _nc_bkgd _bkgd
292 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
293 #define wbkgrnd wbkgd
296 #undef NCURSES_OPAQUE
297 #define NCURSES_INTERNALS 1
298 #define NCURSES_OPAQUE 0
300 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
303 * If curses.h did not expose the SCREEN-functions, then we do not need the
304 * parameter in the corresponding unextended functions.
307 #define USE_SP_FUNC_SUPPORT NCURSES_SP_FUNCS
308 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
311 #define SP_PARM sp /* use parameter */
312 #define NCURSES_SP_ARG SP_PARM
313 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
314 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
315 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
316 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
318 #define SP_PARM SP /* use global variable */
319 #define NCURSES_SP_ARG
320 #define NCURSES_SP_DCL
321 #define NCURSES_SP_DCL0 void
322 #define NCURSES_SP_ARGx
323 #define NCURSES_SP_DCLx
326 #include <nc_panel.h>
328 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
329 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
330 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
332 #if BROKEN_LINKER || USE_REENTRANT
333 #define CurTerm _nc_prescreen._cur_term
335 #define CurTerm cur_term
339 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
341 #define TerminalOf(sp) CurTerm
347 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
348 * pointer to this data.
350 #ifdef USE_SP_TERMTYPE
354 #define SP_TERMTYPE TerminalOf(sp)->type.
356 #include <term_entry.h>
358 #include <nc_tparm.h>
361 * Use these macros internally, to make tracing less verbose. But leave the
362 * option for compiling the tracing into the library.
365 #define ColorPair(n) NCURSES_BITS(n, 0)
366 #define PairNumber(a) (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
368 #define ColorPair(pair) COLOR_PAIR(pair)
369 #define PairNumber(attr) PAIR_NUMBER(attr)
372 #define unColor(n) unColor2(AttrOf(n))
373 #define unColor2(a) ((a) & ALL_BUT_COLOR)
376 * Extended-colors stores the color pair in a separate struct-member than the
377 * attributes. But for compatibility, we handle most cases where a program
378 * written for non-extended colors stores the color in the attributes by
379 * checking for a color pair in both places.
381 #if NCURSES_EXT_COLORS
382 #define if_EXT_COLORS(stmt) stmt
383 #define SetPair(value,p) SetPair2((value).ext_color, AttrOf(value), p)
384 #define SetPair2(c,a,p) c = (p), \
385 a = (unColor2(a) | (A_COLOR & ColorPair(oldColor(c))))
386 #define GetPair(value) GetPair2((value).ext_color, AttrOf(value))
387 #define GetPair2(c,a) ((c) ? (c) : PairNumber(a))
388 #define oldColor(p) (((p) > 255) ? 255 : (p))
389 #define GET_WINDOW_PAIR(w) GetPair2((w)->_color, (w)->_attrs)
390 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
391 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
394 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
396 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
399 #else /* !NCURSES_EXT_COLORS */
401 #define if_EXT_COLORS(stmt) /* nothing */
402 #define SetPair(value,p) RemAttr(value, A_COLOR), \
403 SetAttr(value, AttrOf(value) | (A_COLOR & (attr_t) ColorPair(p)))
404 #define GetPair(value) PairNumber(AttrOf(value))
405 #define GET_WINDOW_PAIR(w) PairNumber(WINDOW_ATTRS(w))
406 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
407 WINDOW_ATTRS(w) |= (A_COLOR & (attr_t) ColorPair(p))
408 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
411 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
413 #define VIDATTR(sp,attr,pair) vidattr(attr)
416 #endif /* NCURSES_EXT_COLORS */
418 #if NCURSES_NO_PADDING
419 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
420 #define SetNoPadding(sp) _nc_set_no_padding(sp)
421 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
423 #define GetNoPadding(sp) FALSE
424 #define SetNoPadding(sp) /*nothing*/
427 #define WINDOW_ATTRS(w) ((w)->_attrs)
429 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
430 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
431 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
433 #if USE_REENTRANT || NCURSES_SP_FUNCS
434 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
435 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
436 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
437 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
442 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
443 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
444 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
445 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
447 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
448 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
449 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
450 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
454 #define ptrLines(sp) &LINES
455 #define ptrCols(sp) &COLS
456 #define ptrTabsize(sp) &TABSIZE
457 #define ptrEscdelay(sp) &ESCDELAY
459 #define SET_LINES(value) LINES = value
460 #define SET_COLS(value) COLS = value
461 #define SET_TABSIZE(value) TABSIZE = value
462 #define SET_ESCDELAY(value) ESCDELAY = value
466 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
467 __FILE__, __LINE__, \
468 (unsigned long) (pthread_self()), \
469 data.__data.__lock, \
470 data.__data.__count, \
471 data.__data.__owner, \
472 data.__data.__kind, \
473 (data.__data.__nusers > 5) ? " OOPS " : "", \
474 data.__data.__nusers)
475 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
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)
483 # define _weak_pragma(exp)
485 # define _declare(name) __extension__ extern __typeof__(name) name
486 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
494 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
495 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
496 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
497 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
498 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
499 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
500 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
501 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
504 #error POSIX threads requires --enable-reentrant option
508 # if USE_WEAK_SYMBOLS
509 weak_symbol(pthread_sigmask);
510 weak_symbol(pthread_kill);
511 weak_symbol(pthread_self);
512 weak_symbol(pthread_equal);
513 weak_symbol(pthread_mutex_init);
514 weak_symbol(pthread_mutex_lock);
515 weak_symbol(pthread_mutex_unlock);
516 weak_symbol(pthread_mutex_trylock);
517 weak_symbol(pthread_mutexattr_settype);
518 weak_symbol(pthread_mutexattr_init);
519 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
521 # define sigprocmask _nc_sigprocmask
526 #undef HAVE_NANOSLEEP
527 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
530 #else /* !USE_PTHREADS */
532 #if USE_PTHREADS_EINTR
533 # if USE_WEAK_SYMBOLS
535 weak_symbol(pthread_sigmask);
536 weak_symbol(pthread_kill);
537 weak_symbol(pthread_self);
538 weak_symbol(pthread_equal);
539 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
541 # define sigprocmask _nc_sigprocmask
543 #endif /* USE_PTHREADS_EINTR */
545 #define _nc_init_pthreads() /* nothing */
546 #define _nc_mutex_init(obj) /* nothing */
548 #define _nc_lock_global(name) /* nothing */
549 #define _nc_try_global(name) 0
550 #define _nc_unlock_global(name) /* nothing */
552 #endif /* USE_PTHREADS */
555 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
556 * So the locking is done in the non-sp-func (which calls the sp-func) rather
557 * than in the sp-func itself.
559 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
560 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
564 #define _nc_nonsp_lock_global(name) /* nothing */
565 #define _nc_nonsp_try_global(name) 0
566 #define _nc_nonsp_unlock_global(name) /* nothing */
568 #define _nc_sp_lock_global(name) _nc_lock_global(name)
569 #define _nc_sp_try_global(name) _nc_try_global(name)
570 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
574 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
575 #define _nc_nonsp_try_global(name) _nc_try_global(name)
576 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
578 #define _nc_sp_lock_global(name) /* nothing */
579 #define _nc_sp_try_global(name) 0
580 #define _nc_sp_unlock_global(name) /* nothing */
584 #if HAVE_GETTIMEOFDAY
585 # define PRECISE_GETTIME 1
586 # define TimeType struct timeval
588 # define PRECISE_GETTIME 0
589 # define TimeType time_t
593 * Definitions for color pairs
595 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
596 #define C_SHIFT 9 /* we need more bits than there are colors */
597 #define C_MASK ((1 << C_SHIFT) - 1)
598 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
599 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
600 #define BACK_OF(c) ((c) & C_MASK)
601 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
603 #define COLOR_DEFAULT C_MASK
605 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
607 #undef NCURSES_CH_T /* this is not a termlib feature */
608 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
610 #endif /* USE_TERMLIB */
615 NCURSES_CH_T *text; /* text of the line */
616 NCURSES_SIZE_T firstchar; /* first changed character in the line */
617 NCURSES_SIZE_T lastchar; /* last changed character in the line */
618 NCURSES_SIZE_T oldindex; /* index of the line at last update */
620 #endif /* USE_TERMLIB */
623 M_XTERM = -1 /* use xterm's mouse tracking? */
624 ,M_NONE = 0 /* no mouse device */
629 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
631 #ifdef USE_TERM_DRIVER
632 ,M_TERM_DRIVER /* Win32 console, etc */
637 * Structures for scrolling.
641 unsigned long hashval;
642 int oldcount, newcount;
643 int oldindex, newindex;
647 * Structures for soft labels.
652 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
656 char *ent_text; /* text for the label */
657 char *form_text; /* formatted text (left/center/...) */
658 int ent_x; /* x coordinate of this field */
659 char dirty; /* this label has changed */
660 char visible; /* field is visible */
663 typedef struct _SLK {
664 bool dirty; /* all labels have changed */
665 bool hidden; /* soft labels are hidden */
668 short maxlab; /* number of available labels */
669 short labcnt; /* number of allocated labels */
670 short maxlen; /* length of labels */
671 NCURSES_CH_T attr; /* soft label attribute */
674 #endif /* USE_TERMLIB */
677 WINDOW *win; /* the window used in the hook */
678 int line; /* lines to take, < 0 => from bottom*/
679 int (*hook)(WINDOW *, int); /* callback for user */
683 #undef buttons /* term.h defines this, and gpm uses it! */
687 /* link dynamically to GPM */
688 typedef int *TYPE_gpm_fd;
689 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
690 typedef int (*TYPE_Gpm_Close) (void);
691 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
693 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
694 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
695 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
696 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
698 /* link statically to GPM */
699 #define my_gpm_fd &gpm_fd
700 #define my_Gpm_Open Gpm_Open
701 #define my_Gpm_Close Gpm_Close
702 #define my_Gpm_GetEvent Gpm_GetEvent
703 #endif /* HAVE_LIBDL */
704 #endif /* USE_GPM_SUPPORT */
709 char *fix_sgr0; /* this holds the filtered sgr0 string */
710 char *last_bufp; /* help with fix_sgr0 leak */
714 #define TGETENT_MAX 4
735 const char *tparam_base;
737 STACK_FRAME stack[STACKSIZE];
747 int dynamic_var[NUM_VARS];
748 int static_vars[NUM_VARS];
757 * The filesystem database normally uses a single-letter for the lower level
758 * of directories. Use a hexadecimal code for filesystems which do not
759 * preserve mixed-case names.
761 #if MIXEDCASE_FILENAMES
762 #define LEAF_FMT "%c"
765 #define LEAF_FMT "%02x"
770 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
771 * could at most have 10 digits, and the mask contains no more than 32 bits
772 * with each bit representing less than 15 characters. Usually the whole
773 * string is less than 80 columns, but this buffer size is an absolute
776 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
777 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
779 #ifdef USE_TERM_DRIVER
780 struct DriverTCB; /* Terminal Control Block forward declaration */
781 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
783 #define INIT_TERM_DRIVER() /* nothing */
787 * Global data which is not specific to a screen.
790 SIG_ATOMIC_T have_sigwinch;
791 SIG_ATOMIC_T cleanup_nested;
796 const char *comp_sourcename;
799 bool have_tic_directory;
800 bool keep_tic_directory;
801 const char *tic_directory;
807 char **keyname_table;
812 size_t safeprint_used;
814 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
816 long tgetent_sequence;
818 #ifndef USE_SP_WINDOWLIST
819 WINDOWLIST *_nc_windowlist;
820 #define WindowList(sp) _nc_globals._nc_windowlist
823 #if USE_HOME_TERMINFO
827 #if !USE_SAFE_SPRINTF
832 #ifdef USE_TERM_DRIVER
833 int (*term_driver)(struct DriverTCB*, const char*, int*);
838 char trace_fname[PATH_MAX];
843 size_t tracearg_used;
845 TRACEBUF *tracebuf_ptr;
846 size_t tracebuf_used;
848 char tracechr_buf[40];
851 size_t tracedmp_used;
853 unsigned char *tracetry_buf;
854 size_t tracetry_used;
856 char traceatr_color_buf[2][80];
857 int traceatr_color_sel;
858 int traceatr_color_last;
859 #if !defined(USE_PTHREADS) && USE_REENTRANT
865 pthread_mutex_t mutex_curses;
866 pthread_mutex_t mutex_tst_tracef;
867 pthread_mutex_t mutex_tracef;
870 #define _nc_use_pthreads _nc_globals.use_pthreads
872 #if USE_PTHREADS_EINTR
873 pthread_t read_thread; /* The reading thread */
877 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
882 * Global data which can be swept up into a SCREEN when one is created.
883 * It may be modified before the next SCREEN is created.
888 attr_t previous_attr;
889 #ifndef USE_SP_RIPOFF
890 ripoff_t rippedoff[N_RIPS];
893 TPARM_STATE tparm_state;
894 TTY *saved_tty; /* savetty/resetty information */
895 #if NCURSES_NO_PADDING
896 bool _no_padding; /* flag to set if padding disabled */
898 NCURSES_SP_OUTC _outch; /* output handler if not putc */
899 #if BROKEN_LINKER || USE_REENTRANT
900 chtype *real_acs_map;
908 const char *_tputs_trace;
914 * Use screen-specific ripoff data (for softkeys) rather than global.
917 #define safe_ripoff_sp (sp)->rsp
918 #define safe_ripoff_stack (sp)->rippedoff
920 #define safe_ripoff_sp _nc_prescreen.rsp
921 #define safe_ripoff_stack _nc_prescreen.rippedoff
924 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
927 * The SCREEN structure.
931 int _ifd; /* input file ptr for screen */
932 FILE *_ofp; /* output file ptr for screen */
933 char *_setbuf; /* buffered I/O for output */
934 bool _filtered; /* filter() was called */
935 bool _buffered; /* setvbuf uses _setbuf data */
936 bool _prescreen; /* is in prescreen phase */
937 bool _use_env; /* LINES & COLS from environment? */
938 int _checkfd; /* filedesc for typeahead check */
939 TERMINAL *_term; /* terminal type information */
940 TTY _saved_tty; /* savetty/resetty information */
941 NCURSES_SIZE_T _lines; /* screen lines */
942 NCURSES_SIZE_T _columns; /* screen columns */
944 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
945 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
947 WINDOW *_curscr; /* current screen */
948 WINDOW *_newscr; /* virtual screen to be updated to */
949 WINDOW *_stdscr; /* screen's full-window context */
951 #define CurScreen(sp) (sp)->_curscr
952 #define NewScreen(sp) (sp)->_newscr
953 #define StdScreen(sp) (sp)->_stdscr
955 TRIES *_keytry; /* "Try" for use with keypad mode */
956 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
957 bool _tried; /* keypad mode was initialized */
958 bool _keypad_on; /* keypad mode is currently on */
960 bool _called_wgetch; /* check for recursion in wgetch() */
961 int _fifo[FIFO_SIZE]; /* input push-back buffer */
962 short _fifohead, /* head of fifo queue */
963 _fifotail, /* tail of fifo queue */
964 _fifopeek, /* where to peek for next char */
965 _fifohold; /* set if breakout marked */
967 int _endwin; /* are we out of window mode? */
968 NCURSES_CH_T *_current_attr; /* holds current attributes set */
969 int _coloron; /* is color enabled? */
970 int _color_defs; /* are colors modified */
971 int _cursor; /* visibility of the cursor */
972 int _cursrow; /* physical cursor row */
973 int _curscol; /* physical cursor column */
974 bool _notty; /* true if we cannot switch non-tty */
975 int _nl; /* True if NL -> CR/NL is on */
976 int _raw; /* True if in raw mode */
977 int _cbreak; /* 1 if in cbreak mode */
978 /* > 1 if in halfdelay mode */
979 int _echo; /* True if echo on */
980 int _use_meta; /* use the meta key? */
981 struct _SLK *_slk; /* ptr to soft key struct / NULL */
982 int slk_format; /* selected format for this screen */
983 /* cursor movement costs; units are 10ths of milliseconds */
984 #if NCURSES_NO_PADDING
985 bool _no_padding; /* flag to set if padding disabled */
987 int _char_padding; /* cost of character put */
988 int _cr_cost; /* cost of (carriage_return) */
989 int _cup_cost; /* cost of (cursor_address) */
990 int _home_cost; /* cost of (cursor_home) */
991 int _ll_cost; /* cost of (cursor_to_ll) */
993 int _ht_cost; /* cost of (tab) */
994 int _cbt_cost; /* cost of (backtab) */
995 #endif /* USE_HARD_TABS */
996 int _cub1_cost; /* cost of (cursor_left) */
997 int _cuf1_cost; /* cost of (cursor_right) */
998 int _cud1_cost; /* cost of (cursor_down) */
999 int _cuu1_cost; /* cost of (cursor_up) */
1000 int _cub_cost; /* cost of (parm_cursor_left) */
1001 int _cuf_cost; /* cost of (parm_cursor_right) */
1002 int _cud_cost; /* cost of (parm_cursor_down) */
1003 int _cuu_cost; /* cost of (parm_cursor_up) */
1004 int _hpa_cost; /* cost of (column_address) */
1005 int _vpa_cost; /* cost of (row_address) */
1006 /* used in tty_update.c, must be chars */
1007 int _ed_cost; /* cost of (clr_eos) */
1008 int _el_cost; /* cost of (clr_eol) */
1009 int _el1_cost; /* cost of (clr_bol) */
1010 int _dch1_cost; /* cost of (delete_character) */
1011 int _ich1_cost; /* cost of (insert_character) */
1012 int _dch_cost; /* cost of (parm_dch) */
1013 int _ich_cost; /* cost of (parm_ich) */
1014 int _ech_cost; /* cost of (erase_chars) */
1015 int _rep_cost; /* cost of (repeat_char) */
1016 int _hpa_ch_cost; /* cost of (column_address) */
1017 int _cup_ch_cost; /* cost of (cursor_address) */
1018 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1019 int _inline_cost; /* cost of inline-move */
1020 int _smir_cost; /* cost of (enter_insert_mode) */
1021 int _rmir_cost; /* cost of (exit_insert_mode) */
1022 int _ip_cost; /* cost of (insert_padding) */
1023 /* used in lib_mvcur.c */
1024 char * _address_cursor;
1025 /* used in tty_update.c */
1026 int _scrolling; /* 1 if terminal's smart enough to */
1028 /* used in lib_color.c */
1029 color_t *_color_table; /* screen's color palette */
1030 int _color_count; /* count of colors in palette */
1031 colorpair_t *_color_pairs; /* screen's color pair list */
1032 int _pair_count; /* count of color pairs */
1033 int _pair_limit; /* actual limit of color-pairs */
1034 #if NCURSES_EXT_FUNCS
1035 bool _assumed_color; /* use assumed colors */
1036 bool _default_color; /* use default colors */
1037 bool _has_sgr_39_49; /* has ECMA default color support */
1038 int _default_fg; /* assumed default foreground */
1039 int _default_bg; /* assumed default background */
1040 int _default_pairs; /* count pairs using default color */
1042 chtype _ok_attributes; /* valid attributes for terminal */
1043 chtype _xmc_suppress; /* attributes to suppress if xmc */
1044 chtype _xmc_triggers; /* attributes to process if xmc */
1045 chtype * _acs_map; /* the real alternate-charset map */
1046 bool * _screen_acs_map;
1049 /* used in lib_vidattr.c */
1050 bool _use_rmso; /* true if we may use 'rmso' */
1051 bool _use_rmul; /* true if we may use 'rmul' */
1054 * These data correspond to the state of the idcok() and idlok()
1055 * functions. A caveat is in order here: the XSI and SVr4
1056 * documentation specify that these functions apply to the window which
1057 * is given as an argument. However, ncurses implements this logic
1058 * only for the newscr/curscr update process, _not_ per-window.
1064 * These are the data that support the mouse interface.
1066 bool _mouse_initialized;
1067 MouseType _mouse_type;
1069 bool (*_mouse_event) (SCREEN *);
1070 bool (*_mouse_inline)(SCREEN *);
1071 bool (*_mouse_parse) (SCREEN *, int);
1072 void (*_mouse_resume)(SCREEN *);
1073 void (*_mouse_wrap) (SCREEN *);
1074 int _mouse_fd; /* file-descriptor, if any */
1075 bool _mouse_active; /* true if initialized */
1076 mmask_t _mouse_mask;
1077 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1078 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1079 MEVENT *_mouse_eventp; /* next free slot in event queue */
1082 bool _mouse_gpm_loaded;
1083 bool _mouse_gpm_found;
1086 TYPE_gpm_fd _mouse_gpm_fd;
1087 TYPE_Gpm_Open _mouse_Gpm_Open;
1088 TYPE_Gpm_Close _mouse_Gpm_Close;
1089 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1091 Gpm_Connect _mouse_gpm_connect;
1092 #endif /* USE_GPM_SUPPORT */
1096 int _emxmouse_thread;
1097 int _emxmouse_activated;
1098 char _emxmouse_buttons[4];
1102 MEVENT _sysmouse_fifo[FIFO_SIZE];
1105 int _sysmouse_char_width; /* character width */
1106 int _sysmouse_char_height; /* character height */
1107 int _sysmouse_old_buttons;
1108 int _sysmouse_new_buttons;
1111 #ifdef USE_TERM_DRIVER
1112 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1113 int _drv_mouse_head;
1114 int _drv_mouse_tail;
1115 int _drv_mouse_old_buttons;
1116 int _drv_mouse_new_buttons;
1119 * This supports automatic resizing
1122 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1126 * These are data that support the proper handling of the panel stack on an
1129 struct panelhook _panelHook;
1132 SCREEN *_next_screen;
1134 /* hashes for old and new lines */
1135 unsigned long *oldhash, *newhash;
1141 bool _cleanup; /* cleanup after int/quit signal */
1142 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1144 int _legacy_coding; /* see use_legacy_coding() */
1147 char _ttytype[NAMESIZE];
1154 const char *_tputs_trace;
1159 char tracechr_buf[40];
1160 char tracemse_buf[TRACEMSE_MAX];
1162 #ifdef USE_SP_WINDOWLIST
1163 WINDOWLIST* _windowlist;
1164 #define WindowList(sp) (sp)->_windowlist
1168 ripoff_t rippedoff[N_RIPS];
1172 * ncurses/ncursesw are the same up to this point.
1174 #if USE_WIDEC_SUPPORT
1175 /* recent versions of 'screen' have partially-working support for
1176 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1178 bool _screen_acs_fix;
1182 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1183 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1187 SCREEN *screen; /* screen containing the window */
1188 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1189 #ifdef NCURSES_WIDECHAR
1190 char addch_work[(MB_LEN_MAX * 9) + 1];
1191 unsigned addch_used; /* number of bytes in addch_work[] */
1192 int addch_x; /* x-position for addch_work[] */
1193 int addch_y; /* y-position for addch_work[] */
1197 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1199 #define SP_PRE_INIT(sp) \
1200 sp->_cursrow = -1; \
1201 sp->_curscol = -1; \
1206 sp->_fifohead = -1; \
1207 sp->_endwin = TRUE; \
1209 WindowList(sp) = 0; \
1210 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1213 /* usually in <limits.h> */
1215 #define UCHAR_MAX 255
1218 /* The terminfo source is assumed to be 7-bit ASCII */
1219 #define is7bits(c) ((unsigned)(c) < 128)
1221 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1222 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1225 #define min(a,b) ((a) > (b) ? (b) : (a))
1229 #define max(a,b) ((a) < (b) ? (b) : (a))
1232 /* usually in <unistd.h> */
1233 #ifndef STDIN_FILENO
1234 #define STDIN_FILENO 0
1237 #ifndef STDOUT_FILENO
1238 #define STDOUT_FILENO 1
1241 #ifndef STDERR_FILENO
1242 #define STDERR_FILENO 2
1245 #ifndef EXIT_SUCCESS
1246 #define EXIT_SUCCESS 0
1249 #ifndef EXIT_FAILURE
1250 #define EXIT_FAILURE 1
1254 #define R_OK 4 /* Test for read permission. */
1257 #define W_OK 2 /* Test for write permission. */
1260 #define X_OK 1 /* Test for execute permission. */
1263 #define F_OK 0 /* Test for existence. */
1267 #include <fcntl.h> /* may define O_BINARY */
1276 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1278 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1281 #define COUNT_OUTCHARS(n) /* nothing */
1284 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1286 #define UChar(c) ((unsigned char)(c))
1287 #define UShort(c) ((unsigned short)(c))
1288 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1289 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1292 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1295 #if USE_WIDEC_SUPPORT /* { */
1296 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1298 #define init_mb(state) memset(&state, 0, sizeof(state))
1300 #if NCURSES_EXT_COLORS
1301 #define NulColor , 0
1303 #define NulColor /* nothing */
1306 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1307 #define CharOf(c) ((c).chars[0])
1308 #define AttrOf(c) ((c).attr)
1310 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1311 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1312 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1314 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1315 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1318 #define CharEq(a,b) (((a).attr == (b).attr) \
1319 && (a).chars[0] == (b).chars[0] \
1320 && (a).chars[1] == (b).chars[1] \
1321 && (a).chars[2] == (b).chars[2] \
1322 && (a).chars[3] == (b).chars[3] \
1323 && (a).chars[4] == (b).chars[4] \
1324 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1326 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1329 #define SetChar(ch,c,a) do { \
1330 NCURSES_CH_T *_cp = &ch; \
1331 memset(_cp, 0, sizeof(ch)); \
1332 _cp->chars[0] = (wchar_t) (c); \
1334 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1336 #define CHREF(wch) (&wch)
1337 #define CHDEREF(wch) (*wch)
1338 #define ARG_CH_T NCURSES_CH_T *
1339 #define CARG_CH_T const NCURSES_CH_T *
1340 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1341 mbstate_t PUT_st; wchar_t PUTC_ch
1342 #define PUTC_INIT init_mb (PUT_st)
1343 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1344 if (Charable(ch)) { \
1345 fputc(CharOf(ch), b); \
1346 COUNT_OUTCHARS(1); \
1349 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1350 PUTC_ch = (ch).chars[PUTC_i]; \
1351 if (PUTC_ch == L'\0') \
1353 PUTC_n = (int) wcrtomb(PUTC_buf, \
1354 (ch).chars[PUTC_i], &PUT_st); \
1355 if (PUTC_n <= 0) { \
1356 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1360 IGNORE_RC(fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b)); \
1362 COUNT_OUTCHARS(PUTC_i); \
1365 #define BLANK NewChar2(' ', WA_NORMAL)
1366 #define ZEROS NewChar2('\0', WA_NORMAL)
1367 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1370 * Wide characters cannot be represented in the A_CHARTEXT mask of
1371 * attr_t's but an application might have set a narrow character there.
1372 * But even in that case, it would only be a printable character, or
1373 * zero. Otherwise we can use those bits to tell if a cell is the
1374 * first or extension part of a wide character.
1376 #define WidecExt(ch) (int) (AttrOf(ch) & A_CHARTEXT)
1377 #define isWidecBase(ch) (WidecExt(ch) == 1)
1378 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1379 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1380 AttrOf(dst) |= (attr_t) (ext + 1)
1382 #define if_WIDEC(code) code
1383 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1384 || (AttrOf(ch) & A_ALTCHARSET) \
1385 || (!isWidecExt(ch) && \
1386 (ch).chars[1] == L'\0' && \
1387 _nc_is_charable(CharOf(ch))))
1389 #define L(ch) L ## ch
1391 #define CharOf(c) ChCharOf(c)
1392 #define AttrOf(c) ChAttrOf(c)
1393 #define AddAttr(c,a) c |= (a)
1394 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1395 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1396 #define NewChar(ch) (ch)
1397 #define NewChar2(c,a) ((c) | (a))
1398 #define CharEq(a,b) ((a) == (b))
1399 #define SetChar(ch,c,a) ch = (c) | (a)
1400 #define CHREF(wch) wch
1401 #define CHDEREF(wch) wch
1402 #define ARG_CH_T NCURSES_CH_T
1403 #define CARG_CH_T NCURSES_CH_T
1404 #define PUTC_DATA int data = 0
1405 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1407 #define BLANK (' '|A_NORMAL)
1408 #define ZEROS ('\0'|A_NORMAL)
1409 #define ISBLANK(ch) (CharOf(ch) == ' ')
1411 #define isWidecExt(ch) (0)
1412 #define if_WIDEC(code) /* nothing */
1417 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1418 #define CharOfD(ch) CharOf(CHDEREF(ch))
1419 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1421 #define BLANK_ATTR A_NORMAL
1422 #define BLANK_TEXT L(' ')
1426 #define LEGALYX(w, y, x) \
1428 ((x) >= 0 && (x) <= (w)->_maxx && \
1429 (y) >= 0 && (y) <= (w)->_maxy))
1431 #define CHANGED_CELL(line,col) \
1432 if (line->firstchar == _NOCHANGE) \
1433 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1434 else if ((col) < line->firstchar) \
1435 line->firstchar = (NCURSES_SIZE_T) (col); \
1436 else if ((col) > line->lastchar) \
1437 line->lastchar = (NCURSES_SIZE_T) (col)
1439 #define CHANGED_RANGE(line,start,end) \
1440 if (line->firstchar == _NOCHANGE \
1441 || line->firstchar > (start)) \
1442 line->firstchar = (NCURSES_SIZE_T) (start); \
1443 if (line->lastchar == _NOCHANGE \
1444 || line->lastchar < (end)) \
1445 line->lastchar = (NCURSES_SIZE_T) (end)
1447 #define CHANGED_TO_EOL(line,start,end) \
1448 if (line->firstchar == _NOCHANGE \
1449 || line->firstchar > (start)) \
1450 line->firstchar = (NCURSES_SIZE_T) (start); \
1451 line->lastchar = (NCURSES_SIZE_T) (end)
1453 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1455 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1457 /* FreeAndNull() is not a comma-separated expression because some compilers
1458 * do not accept a mixture of void with values.
1460 #define FreeAndNull(p) free(p); p = 0
1462 #include <nc_alloc.h>
1465 * TTY bit definition for converting tabs to spaces.
1468 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1471 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1474 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1476 # define OFLAGS_TABS 0
1482 * Standardize/simplify common loops
1484 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1485 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1486 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1489 * Prefixes for call/return points of library function traces. We use these to
1490 * instrument the public functions so that the traces can be easily transformed
1491 * into regression scripts.
1493 #define T_CALLED(fmt) "called {" fmt
1494 #define T_CREATE(fmt) "create :" fmt
1495 #define T_RETURN(fmt) "return }" fmt
1500 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1502 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1505 #define START_TRACE() \
1506 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1507 int t = _nc_getenv_num("NCURSES_TRACE"); \
1509 trace((unsigned) t); \
1513 * Many of the _tracef() calls use static buffers; lock the trace state before
1514 * trying to fill them.
1517 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1518 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1519 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1521 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1522 #define _nc_locked_tracef _tracef
1525 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1526 #define T(a) TR(TRACE_CALLS, a)
1527 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1528 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1529 #define TRACE_RETURN_SP(value,type) return _nc_retrace_##type(SP_PARM, value)
1531 #define NonNull(s) ((s) != 0 ? s : "<null>")
1533 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1534 #define returnBits(code) TRACE_RETURN(code,unsigned)
1535 #define returnBool(code) TRACE_RETURN(code,bool)
1536 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1537 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1538 #define returnChar(code) TRACE_RETURN(code,char)
1539 #define returnChtype(code) TRACE_RETURN(code,chtype)
1540 #define returnCode(code) TRACE_RETURN(code,int)
1541 #define returnIntAttr(code) TRACE_RETURN2(code,int,attr_t)
1542 #define returnMMask(code) TRACE_RETURN_SP(code,mmask_t)
1543 #define returnPtr(code) TRACE_RETURN(code,ptr)
1544 #define returnSP(code) TRACE_RETURN(code,sp)
1545 #define returnVoid T((T_RETURN(""))); return
1546 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1547 #define returnWin(code) TRACE_RETURN(code,win)
1549 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
1550 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1551 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1552 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1553 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1554 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1555 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1556 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1557 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1558 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1559 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1560 extern NCURSES_EXPORT(char) _nc_retrace_char (char);
1561 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1562 extern NCURSES_EXPORT(int) _nc_retrace_int_attr_t (attr_t);
1563 extern NCURSES_EXPORT(mmask_t) _nc_retrace_mmask_t (SCREEN *, mmask_t);
1564 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1565 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1566 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1569 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1570 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1571 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1572 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1573 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1574 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1576 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1577 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1580 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1582 #if USE_WIDEC_SUPPORT
1583 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1584 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1587 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1588 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1592 #define START_TRACE() /* nothing */
1596 #define TPUTS_TRACE(s)
1598 #define returnAttr(code) return code
1599 #define returnBits(code) return code
1600 #define returnBool(code) return code
1601 #define returnCPtr(code) return code
1602 #define returnCVoidPtr(code) return code
1603 #define returnChar(code) return ((char) code)
1604 #define returnChtype(code) return code
1605 #define returnCode(code) return code
1606 #define returnIntAttr(code) return code
1607 #define returnMMask(code) return code
1608 #define returnPtr(code) return code
1609 #define returnSP(code) return code
1610 #define returnVoid return
1611 #define returnVoidPtr(code) return code
1612 #define returnWin(code) return code
1614 #endif /* TRACE/!TRACE */
1617 * Workaround for defective implementation of gcc attribute warn_unused_result
1619 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1620 #define IGNORE_RC(func) errno = (int) func
1622 #define IGNORE_RC(func) (void) func
1623 #endif /* gcc workarounds */
1626 * Return-codes for tgetent() and friends.
1628 #define TGETENT_YES 1 /* entry is found */
1629 #define TGETENT_NO 0 /* entry is not found */
1630 #define TGETENT_ERR -1 /* an error occurred */
1632 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1633 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1635 #define EMPTY_MODULE(name) \
1636 extern NCURSES_EXPORT(void) name (void); \
1637 NCURSES_EXPORT(void) name (void) { }
1639 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1640 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1641 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1643 #define toggle_attr_on(S,at) {\
1644 if (PairNumber(at) > 0) {\
1645 (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1647 (S) |= (attr_t) (at);\
1649 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1652 #define toggle_attr_off(S,at) {\
1653 if (PairNumber(at) > 0) {\
1654 (S) &= ~(at|A_COLOR);\
1658 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1660 #define DelCharCost(sp,count) \
1663 : ((delete_character != 0) \
1664 ? (sp->_dch1_cost * count) \
1667 #define InsCharCost(sp,count) \
1670 : ((enter_insert_mode && exit_insert_mode) \
1671 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1672 : ((insert_character != 0) \
1673 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1677 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1678 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1679 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1680 if (magic_cookie_glitch > 0 \
1681 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1682 T(("%s @%d before glitch %d,%d", \
1683 __FILE__, __LINE__, \
1686 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1690 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1691 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1696 * Macros to make additional parameter to implement wgetch_events()
1698 #ifdef NCURSES_WGETCH_EVENTS
1699 #define EVENTLIST_0th(param) param
1700 #define EVENTLIST_1st(param) param
1701 #define EVENTLIST_2nd(param) , param
1702 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1704 #define EVENTLIST_0th(param) void
1705 #define EVENTLIST_1st(param) /* nothing */
1706 #define EVENTLIST_2nd(param) /* nothing */
1707 #define TWAIT_MASK TW_ANY
1710 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1712 #undef toggle_attr_on
1713 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1714 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1716 #undef toggle_attr_off
1717 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1718 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1721 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1724 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1726 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1727 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1730 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1732 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1733 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1735 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1738 #if NCURSES_SP_FUNCS
1739 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1740 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1741 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1742 #endif /* NCURSES_SP_FUNCS */
1746 extern NCURSES_EXPORT(void) _nc_expanded (void);
1750 #if !NCURSES_EXT_FUNCS
1751 #define set_escdelay(value) ESCDELAY = value
1755 #define getcwd(buf,len) getwd(buf)
1759 #if USE_WIDEC_SUPPORT
1760 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1761 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1762 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1767 short nte_name; /* offset of name to hash on */
1768 int nte_type; /* BOOLEAN, NUMBER or STRING */
1769 short nte_index; /* index of associated variable in its array */
1770 short nte_link; /* index in table of next hash, or -1 */
1782 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1786 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1787 extern NCURSES_EXPORT(void) _nc_linedump (void);
1791 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1792 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1795 #if USE_WIDEC_SUPPORT
1796 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1800 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1801 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1805 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1808 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1811 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1814 #define INFINITY 1000000 /* cost: too high to use */
1816 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1817 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1818 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1820 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1822 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1823 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1824 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1827 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1830 #define INFINITY 1000000 /* cost: too high to use */
1831 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1834 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1835 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1836 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1837 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1838 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, char);
1840 /* lib_set_term.c */
1841 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1845 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1847 #define _nc_handle_sigwinch(a) /* nothing */
1851 #if USE_WIDEC_SUPPORT
1852 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1856 char *s_head; /* beginning of the string (may be null) */
1857 char *s_tail; /* end of the string (may be null) */
1858 size_t s_size; /* current remaining size available */
1859 size_t s_init; /* total size available */
1863 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1864 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1865 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1866 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1867 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1870 #define strstr _nc_strstr
1871 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1874 /* safe_sprintf.c */
1875 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1878 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1879 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1880 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1881 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1884 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1885 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1886 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1887 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1888 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1889 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1890 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1891 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1892 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1893 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1894 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1895 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1896 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1897 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1898 extern NCURSES_EXPORT(int) _nc_outch (int);
1899 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1900 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1901 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1902 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1903 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
1904 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1905 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, NCURSES_OUTC);
1906 extern NCURSES_EXPORT(void) _nc_flush (void);
1907 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1908 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1909 extern NCURSES_EXPORT(void) _nc_freeall (void);
1910 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1911 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1912 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1913 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1914 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1915 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1916 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1917 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1918 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1919 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1922 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1923 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1924 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1925 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1926 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1927 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1928 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1929 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1932 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1933 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1934 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1935 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1938 #if USE_WIDEC_SUPPORT
1939 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1942 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1943 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1947 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1951 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1953 #define _nc_resize_margins(wp) /* nothing */
1956 #ifdef NCURSES_WGETCH_EVENTS
1957 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1959 #define wgetch_events(win, evl) wgetch(win)
1960 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1964 * Wide-character macros to hide some platform-differences.
1966 #if USE_WIDEC_SUPPORT
1967 #if HAVE_MBTOWC && HAVE_MBLEN
1968 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
1969 #define count_mbytes(buffer,length,state) mblen(buffer,length)
1970 #define check_mbytes(wch,buffer,length,state) \
1971 (int) mbtowc(&wch, buffer, length)
1972 #define state_unused
1973 #elif HAVE_MBRTOWC && HAVE_MBRLEN
1974 #define reset_mbytes(state) init_mb(state)
1975 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
1976 #define check_mbytes(wch,buffer,length,state) \
1977 (int) mbrtowc(&wch, buffer, length, &state)
1984 * Not everyone has vsscanf(), but we'd like to use it for scanw().
1987 extern int vsscanf(const char *str, const char *format, va_list __arg);
1990 /* scroll indices */
1991 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1993 #define USE_SETBUF_0 0
1995 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
1997 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
2000 * On systems with a broken linker, define 'SP' as a function to force the
2001 * linker to pull in the data-only module with 'SP'.
2003 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2006 #define SP _nc_screen()
2007 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2008 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
2009 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
2010 #define CURRENT_SCREEN _nc_screen()
2012 /* current screen is private data; avoid possible linking conflicts too */
2013 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2014 #define CURRENT_SCREEN SP
2015 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
2016 #define _nc_set_screen(sp) SP = sp
2019 #if NCURSES_SP_FUNCS
2020 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2022 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
2026 * We don't want to use the lines or columns capabilities internally, because
2027 * if the application is running multiple screens under X, it's quite possible
2028 * they could all have type xterm but have different sizes! So...
2030 #define screen_lines(sp) (sp)->_lines
2031 #define screen_columns(sp) (sp)->_columns
2033 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2034 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2037 * Some constants related to SLK's
2039 #define MAX_SKEY_OLD 8 /* count of soft keys */
2040 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2041 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2042 #define MAX_SKEY_LEN_PC 5
2044 /* Macro to check whether or not we use a standard format */
2045 #define SLK_STDFMT(fmt) (fmt < 3)
2046 /* Macro to determine height of label window */
2047 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2049 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2050 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2053 * Common error messages
2055 #define MSG_NO_MEMORY "Out of memory"
2056 #define MSG_NO_INPUTS "Premature EOF"
2058 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2059 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2061 /* timed_wait flag definitions */
2065 #define TW_ANY (TW_INPUT | TW_MOUSE)
2068 #define SetSafeOutcWrapper(outc) \
2069 SCREEN* sp = CURRENT_SCREEN; \
2071 struct screen dummy; \
2073 memset(sp,0,sizeof(struct screen)); \
2074 sp->_outch = _nc_outc_wrapper; \
2078 #ifdef USE_TERM_DRIVER
2079 typedef void* TERM_HANDLE;
2081 typedef struct _termInfo
2100 const color_t* defaultPalette;
2103 typedef struct term_driver {
2105 bool (*CanHandle)(struct DriverTCB*,const char*,int*);
2106 void (*init)(struct DriverTCB*);
2107 void (*release)(struct DriverTCB*);
2108 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2109 int (*sgmode)(struct DriverTCB*, bool setFlag, TTY*);
2110 chtype (*conattr)(struct DriverTCB*);
2111 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2112 int (*mode)(struct DriverTCB*, bool progFlag, bool defFlag);
2113 bool (*rescol)(struct DriverTCB*);
2114 bool (*rescolors)(struct DriverTCB*);
2115 void (*color)(struct DriverTCB*,bool fore, int color, int(*)(SCREEN*,int));
2116 int (*doBeepOrFlash)(struct DriverTCB*, bool);
2117 void (*initpair)(struct DriverTCB*,short,short,short);
2118 void (*initcolor)(struct DriverTCB*,short,short,short,short);
2119 void (*docolor)(struct DriverTCB*,short,short,bool,int(*)(SCREEN*,int));
2120 void (*initmouse)(struct DriverTCB*);
2121 int (*testmouse)(struct DriverTCB*,int);
2122 void (*setfilter)(struct DriverTCB*);
2123 void (*hwlabel)(struct DriverTCB*,int,char*);
2124 void (*hwlabelOnOff)(struct DriverTCB*,bool);
2125 int (*update)(struct DriverTCB*);
2126 int (*defaultcolors)(struct DriverTCB*,int,int);
2127 int (*print)(struct DriverTCB*,char*,int);
2128 int (*getsize)(struct DriverTCB*,int*,int*);
2129 int (*setsize)(struct DriverTCB*,int,int);
2130 void (*initacs)(struct DriverTCB*,chtype*,chtype*);
2131 void (*scinit)(SCREEN *);
2132 void (*scexit)(SCREEN *);
2133 int (*twait)(struct DriverTCB*,int,int,int* EVENTLIST_2nd(_nc_eventlist*));
2134 int (*read)(struct DriverTCB*,int*);
2135 int (*nap)(struct DriverTCB*,int);
2136 int (*kpad)(struct DriverTCB*, bool);
2137 int (*kyOk)(struct DriverTCB*, int, bool);
2138 bool (*kyExist)(struct DriverTCB*, int);
2141 typedef struct DriverTCB
2143 TERMINAL term; /* needs to be the first Element !!! */
2144 TERM_HANDLE inp; /* The input handle of the Terminal */
2145 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2146 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2147 TERM_DRIVER* drv; /* The driver for that Terminal */
2148 SCREEN* csp; /* The screen that owns that Terminal */
2149 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2150 void* prop; /* Driver dependent property storage to be used by the Driver */
2152 } TERMINAL_CONTROL_BLOCK;
2154 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2155 #define NCDRV_TINFO 0x01
2156 #define NCDRV_WINCONSOLE 0x02
2158 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2159 #define InfoOf(sp) TCBOf(sp)->info
2160 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2161 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2162 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2163 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2164 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2166 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2167 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2169 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2170 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2171 #endif /* USE_TERM_DRIVER */
2174 * Entrypoints which are actually provided in the terminal driver, which would
2175 * be an sp-name otherwise.
2177 #ifdef USE_TERM_DRIVER
2178 #define TINFO_HAS_KEY _nc_tinfo_has_key
2179 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2180 #define TINFO_MVCUR _nc_tinfo_mvcur
2181 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2182 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2183 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2185 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2186 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2187 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2191 * Entrypoints using an extra parameter with the terminal driver.
2193 #ifdef USE_TERM_DRIVER
2194 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2195 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, bool);
2196 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2197 _nc_get_screensize(sp, tp, lp, cp)
2198 #define TINFO_SET_CURTERM(sp, tp) \
2199 NCURSES_SP_NAME(set_curterm)(sp, tp)
2200 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2201 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2202 #else /* !USE_TERM_DRIVER */
2203 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2204 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2205 _nc_get_screensize(sp, lp, cp)
2206 #define TINFO_SET_CURTERM(sp, tp) \
2208 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2209 _nc_setupterm(name, fd, err, reuse)
2210 #endif /* !USE_TERM_DRIVER */
2212 #ifdef USE_TERM_DRIVER
2214 #include <nc_mingw.h>
2215 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2217 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2220 #ifdef USE_TERM_DRIVER
2221 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2223 #define IsTermInfo(sp) TRUE
2226 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2227 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2230 * Exported entrypoints beyond the published API
2232 #if NCURSES_SP_FUNCS
2233 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2234 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2235 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2236 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2239 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2240 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2243 #if NCURSES_EXT_FUNCS
2244 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2248 * We put the safe versions of various calls here as they are not published
2249 * part of the API up to now
2251 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2252 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2253 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2254 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2255 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2256 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2257 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2258 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2259 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2260 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2261 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2262 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2263 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2264 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2265 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2266 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2267 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2268 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2269 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2270 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2271 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, bool, int);
2272 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2273 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2274 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2275 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2276 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, short, short, bool, NCURSES_SP_OUTC);
2277 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2278 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2279 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2280 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2281 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2282 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2283 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2284 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2285 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2286 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2287 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2288 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2289 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2290 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2291 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2292 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, bool);
2294 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2296 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2297 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2300 #if USE_WIDEC_SUPPORT
2301 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2304 #endif /* NCURSES_SP_FUNCS */
2306 #if NCURSES_SP_FUNCS
2308 #define safe_keyname NCURSES_SP_NAME(keyname)
2309 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2310 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2314 #define safe_keyname _nc_keyname
2315 #define safe_unctrl _nc_unctrl
2316 #define safe_ungetch _nc_ungetch
2318 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2319 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2320 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2330 #endif /* CURSES_PRIV_H */