1 /****************************************************************************
2 * Copyright (c) 1998-2011,2012 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.496 2012/02/22 22:10:37 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 #include <stddef.h> /* for offsetof */
67 #include <sys/types.h>
74 #if HAVE_SYS_BSDTYPES_H
75 #include <sys/bsdtypes.h> /* needed for ISC */
80 #elif HAVE_SYS_PARAM_H
81 # include <sys/param.h>
90 # if defined(_POSIX_PATH_MAX)
91 # define PATH_MAX _POSIX_PATH_MAX
92 # elif defined(MAXPATHLEN)
93 # define PATH_MAX MAXPATHLEN
95 # define PATH_MAX 255 /* the Posix minimum path-size */
103 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
104 #if HAVE_WORKING_POLL
105 #define USE_FUNC_POLL 1
109 #include <sys/poll.h>
112 #define USE_FUNC_POLL 0
116 # include <inttypes.h>
123 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
126 /* Alessandro Rubini's GPM (general-purpose mouse) */
127 #if HAVE_LIBGPM && HAVE_GPM_H
128 #define USE_GPM_SUPPORT 1
130 #define USE_GPM_SUPPORT 0
133 /* QNX mouse support */
134 #if defined(__QNX__) && !defined(__QNXNTO__)
135 #define USE_QNX_MOUSE 1
137 #define USE_QNX_MOUSE 0
140 /* EMX mouse support */
142 #define USE_EMX_MOUSE 1
144 #define USE_EMX_MOUSE 0
147 /* kLIBC keyboard/mouse support */
148 #if defined(__OS2__) && defined(__KLIBC__)
149 #define USE_KLIBC_KBD 1
150 #define USE_KLIBC_MOUSE 1
152 #define USE_KLIBC_KBD 0
153 #define USE_KLIBC_MOUSE 0
156 #define DEFAULT_MAXCLICK 166
157 #define EV_MAX 8 /* size of mouse circular event queue */
160 * If we don't have signals to support it, don't add a sigwinch handler.
161 * In any case, resizing is an extended feature. Use it if we've got it.
163 #if !NCURSES_EXT_FUNCS
164 #undef HAVE_SIZECHANGE
165 #define HAVE_SIZECHANGE 0
168 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
169 #define USE_SIZECHANGE 1
171 #define USE_SIZECHANGE 0
173 #define USE_SIGWINCH 0
177 * If desired, one can configure this, disabling environment variables that
178 * point to custom terminfo/termcap locations.
180 #ifdef USE_ROOT_ENVIRON
181 #define use_terminfo_vars() 1
183 #define use_terminfo_vars() _nc_env_access()
184 extern NCURSES_EXPORT(int) _nc_env_access (void);
188 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
192 #define memmove(d,s,n) bcopy(s,d,n)
194 #define memmove(d,s,n) _nc_memmove(d,s,n)
195 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
199 * If we have va_copy(), use it for assigning va_list's.
201 #if defined(HAVE___VA_COPY)
202 #define begin_va_copy(dst,src) __va_copy(dst, src)
203 #define end_va_copy(dst) va_end(dst)
204 #elif defined(va_copy) || defined(HAVE_VA_COPY)
205 #define begin_va_copy(dst,src) va_copy(dst, src)
206 #define end_va_copy(dst) va_end(dst)
208 #define begin_va_copy(dst,src) (dst) = (src)
209 #define end_va_copy(dst) /* nothing */
213 * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
214 * lack one or the other.
217 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
221 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
225 * Scroll hints are useless when hashmap is used
227 #if !USE_SCROLL_HINTS
229 #define USE_SCROLL_HINTS 1
231 #define USE_SCROLL_HINTS 0
236 #define if_USE_SCROLL_HINTS(stmt) stmt
238 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
241 #include <nc_string.h>
244 * Options for terminal drivers, etc...
246 #ifdef USE_TERM_DRIVER
247 #define USE_SP_RIPOFF 1
248 #define USE_SP_TERMTYPE 1
249 #define USE_SP_WINDOWLIST 1
253 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
254 * when we're throwing control codes at the screen at high volume. To see
255 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
256 * probably don't want to define this either due to uncertainties about tab
257 * delays and expansion in raw mode.
260 #define TRIES struct tries
262 TRIES *child; /* ptr to child. NULL if none */
263 TRIES *sibling; /* ptr to sibling. NULL if none */
264 unsigned char ch; /* character at this node */
265 unsigned short value; /* code of string so far. 0 if none. */
270 * Common/troublesome character definitions
272 #define StringOf(ch) {ch, 0}
279 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
282 * Structure for palette tables
287 short red, green, blue; /* what color_content() returns */
288 short r, g, b; /* params to init_color() */
289 int init; /* true if we called init_color() */
293 #define MAXCOLUMNS 135
295 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
299 #define WINDOWLIST struct _win_list
301 #if USE_WIDEC_SUPPORT
302 #define _nc_bkgd _bkgrnd
304 #undef _XOPEN_SOURCE_EXTENDED
306 #define _nc_bkgd _bkgd
307 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
308 #define wbkgrnd wbkgd
311 #undef NCURSES_OPAQUE
312 #define NCURSES_INTERNALS 1
313 #define NCURSES_OPAQUE 0
315 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
318 * If curses.h did not expose the SCREEN-functions, then we do not need the
319 * parameter in the corresponding unextended functions.
322 #define USE_SP_FUNC_SUPPORT NCURSES_SP_FUNCS
323 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
326 #define SP_PARM sp /* use parameter */
327 #define NCURSES_SP_ARG SP_PARM
328 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
329 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
330 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
331 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
333 #define SP_PARM SP /* use global variable */
334 #define NCURSES_SP_ARG
335 #define NCURSES_SP_DCL
336 #define NCURSES_SP_DCL0 void
337 #define NCURSES_SP_ARGx
338 #define NCURSES_SP_DCLx
341 #include <nc_panel.h>
343 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
344 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
345 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
347 #if BROKEN_LINKER || USE_REENTRANT
348 #define CurTerm _nc_prescreen._cur_term
350 #define CurTerm cur_term
354 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
356 #define TerminalOf(sp) CurTerm
360 #include <nc_termios.h>
363 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
364 * pointer to this data.
366 #ifdef USE_SP_TERMTYPE
370 #define SP_TERMTYPE TerminalOf(sp)->type.
372 #include <term_entry.h>
374 #include <nc_tparm.h>
377 * Use these macros internally, to make tracing less verbose. But leave the
378 * option for compiling the tracing into the library.
381 #define ColorPair(n) NCURSES_BITS(n, 0)
382 #define PairNumber(a) (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
384 #define ColorPair(pair) COLOR_PAIR(pair)
385 #define PairNumber(attr) PAIR_NUMBER(attr)
388 #define unColor(n) unColor2(AttrOf(n))
389 #define unColor2(a) ((a) & ALL_BUT_COLOR)
392 * Extended-colors stores the color pair in a separate struct-member than the
393 * attributes. But for compatibility, we handle most cases where a program
394 * written for non-extended colors stores the color in the attributes by
395 * checking for a color pair in both places.
397 #if NCURSES_EXT_COLORS
398 #define if_EXT_COLORS(stmt) stmt
399 #define SetPair(value,p) SetPair2((value).ext_color, AttrOf(value), p)
400 #define SetPair2(c,a,p) c = (p), \
401 a = (unColor2(a) | (A_COLOR & ColorPair(oldColor(c))))
402 #define GetPair(value) GetPair2((value).ext_color, AttrOf(value))
403 #define GetPair2(c,a) ((c) ? (c) : PairNumber(a))
404 #define oldColor(p) (((p) > 255) ? 255 : (p))
405 #define GET_WINDOW_PAIR(w) GetPair2((w)->_color, (w)->_attrs)
406 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
407 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
410 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
412 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
415 #else /* !NCURSES_EXT_COLORS */
417 #define if_EXT_COLORS(stmt) /* nothing */
418 #define SetPair(value,p) RemAttr(value, A_COLOR), \
419 SetAttr(value, AttrOf(value) | (A_COLOR & (attr_t) ColorPair(p)))
420 #define GetPair(value) PairNumber(AttrOf(value))
421 #define GET_WINDOW_PAIR(w) PairNumber(WINDOW_ATTRS(w))
422 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
423 WINDOW_ATTRS(w) |= (A_COLOR & (attr_t) ColorPair(p))
424 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
427 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
429 #define VIDATTR(sp,attr,pair) vidattr(attr)
432 #endif /* NCURSES_EXT_COLORS */
434 #if NCURSES_NO_PADDING
435 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
436 #define SetNoPadding(sp) _nc_set_no_padding(sp)
437 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
439 #define GetNoPadding(sp) FALSE
440 #define SetNoPadding(sp) /*nothing*/
443 #define WINDOW_ATTRS(w) ((w)->_attrs)
445 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
446 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
447 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
449 #if USE_REENTRANT || NCURSES_SP_FUNCS
450 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
451 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
452 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
453 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
458 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
459 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
460 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
461 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
463 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
464 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
465 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
466 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
470 #define ptrLines(sp) &LINES
471 #define ptrCols(sp) &COLS
472 #define ptrTabsize(sp) &TABSIZE
473 #define ptrEscdelay(sp) &ESCDELAY
475 #define SET_LINES(value) LINES = value
476 #define SET_COLS(value) COLS = value
477 #define SET_TABSIZE(value) TABSIZE = value
478 #define SET_ESCDELAY(value) ESCDELAY = value
482 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
483 __FILE__, __LINE__, \
484 (unsigned long) (pthread_self()), \
485 data.__data.__lock, \
486 data.__data.__count, \
487 data.__data.__owner, \
488 data.__data.__kind, \
489 (data.__data.__nusers > 5) ? " OOPS " : "", \
490 data.__data.__nusers)
491 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
494 #if defined(__GNUC__)
495 # if defined __USE_ISOC99
496 # define _cat_pragma(exp) _Pragma(#exp)
497 # define _weak_pragma(exp) _cat_pragma(weak name)
499 # define _weak_pragma(exp)
501 # define _declare(name) __extension__ extern __typeof__(name) name
502 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
510 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
511 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
512 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
513 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
514 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
515 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
516 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
517 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
520 #error POSIX threads requires --enable-reentrant option
524 # if USE_WEAK_SYMBOLS
525 weak_symbol(pthread_sigmask);
526 weak_symbol(pthread_kill);
527 weak_symbol(pthread_self);
528 weak_symbol(pthread_equal);
529 weak_symbol(pthread_mutex_init);
530 weak_symbol(pthread_mutex_lock);
531 weak_symbol(pthread_mutex_unlock);
532 weak_symbol(pthread_mutex_trylock);
533 weak_symbol(pthread_mutexattr_settype);
534 weak_symbol(pthread_mutexattr_init);
535 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
537 # define sigprocmask _nc_sigprocmask
542 #undef HAVE_NANOSLEEP
543 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
546 #else /* !USE_PTHREADS */
548 #if USE_PTHREADS_EINTR
549 # if USE_WEAK_SYMBOLS
551 weak_symbol(pthread_sigmask);
552 weak_symbol(pthread_kill);
553 weak_symbol(pthread_self);
554 weak_symbol(pthread_equal);
555 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
557 # define sigprocmask _nc_sigprocmask
559 #endif /* USE_PTHREADS_EINTR */
561 #define _nc_init_pthreads() /* nothing */
562 #define _nc_mutex_init(obj) /* nothing */
564 #define _nc_lock_global(name) /* nothing */
565 #define _nc_try_global(name) 0
566 #define _nc_unlock_global(name) /* nothing */
568 #endif /* USE_PTHREADS */
571 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
572 * So the locking is done in the non-sp-func (which calls the sp-func) rather
573 * than in the sp-func itself.
575 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
576 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
580 #define _nc_nonsp_lock_global(name) /* nothing */
581 #define _nc_nonsp_try_global(name) 0
582 #define _nc_nonsp_unlock_global(name) /* nothing */
584 #define _nc_sp_lock_global(name) _nc_lock_global(name)
585 #define _nc_sp_try_global(name) _nc_try_global(name)
586 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
590 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
591 #define _nc_nonsp_try_global(name) _nc_try_global(name)
592 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
594 #define _nc_sp_lock_global(name) /* nothing */
595 #define _nc_sp_try_global(name) 0
596 #define _nc_sp_unlock_global(name) /* nothing */
600 #if HAVE_GETTIMEOFDAY
601 # define PRECISE_GETTIME 1
602 # define TimeType struct timeval
604 # define PRECISE_GETTIME 0
605 # define TimeType time_t
609 * Definitions for color pairs
611 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
612 #define C_SHIFT 9 /* we need more bits than there are colors */
613 #define C_MASK ((1 << C_SHIFT) - 1)
614 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
615 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
616 #define BACK_OF(c) ((c) & C_MASK)
617 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
619 #define COLOR_DEFAULT C_MASK
621 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
623 #undef NCURSES_CH_T /* this is not a termlib feature */
624 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
626 #endif /* USE_TERMLIB */
631 NCURSES_CH_T *text; /* text of the line */
632 NCURSES_SIZE_T firstchar; /* first changed character in the line */
633 NCURSES_SIZE_T lastchar; /* last changed character in the line */
634 NCURSES_SIZE_T oldindex; /* index of the line at last update */
636 #endif /* USE_TERMLIB */
639 M_XTERM = -1 /* use xterm's mouse tracking? */
640 ,M_NONE = 0 /* no mouse device */
645 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
647 #ifdef USE_TERM_DRIVER
648 ,M_TERM_DRIVER /* Win32 console, etc */
653 * Structures for scrolling.
657 unsigned long hashval;
658 int oldcount, newcount;
659 int oldindex, newindex;
663 * Structures for soft labels.
668 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
672 char *ent_text; /* text for the label */
673 char *form_text; /* formatted text (left/center/...) */
674 int ent_x; /* x coordinate of this field */
675 char dirty; /* this label has changed */
676 char visible; /* field is visible */
679 typedef struct _SLK {
680 bool dirty; /* all labels have changed */
681 bool hidden; /* soft labels are hidden */
684 short maxlab; /* number of available labels */
685 short labcnt; /* number of allocated labels */
686 short maxlen; /* length of labels */
687 NCURSES_CH_T attr; /* soft label attribute */
690 #endif /* USE_TERMLIB */
693 WINDOW *win; /* the window used in the hook */
694 int line; /* lines to take, < 0 => from bottom*/
695 int (*hook)(WINDOW *, int); /* callback for user */
699 #undef buttons /* term.h defines this, and gpm uses it! */
703 /* link dynamically to GPM */
704 typedef int *TYPE_gpm_fd;
705 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
706 typedef int (*TYPE_Gpm_Close) (void);
707 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
709 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
710 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
711 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
712 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
714 /* link statically to GPM */
715 #define my_gpm_fd &gpm_fd
716 #define my_Gpm_Open Gpm_Open
717 #define my_Gpm_Close Gpm_Close
718 #define my_Gpm_GetEvent Gpm_GetEvent
719 #endif /* HAVE_LIBDL */
720 #endif /* USE_GPM_SUPPORT */
725 char *fix_sgr0; /* this holds the filtered sgr0 string */
726 char *last_bufp; /* help with fix_sgr0 leak */
730 #define TGETENT_MAX 4
751 const char *tparam_base;
753 STACK_FRAME stack[STACKSIZE];
763 int dynamic_var[NUM_VARS];
764 int static_vars[NUM_VARS];
773 * The filesystem database normally uses a single-letter for the lower level
774 * of directories. Use a hexadecimal code for filesystems which do not
775 * preserve mixed-case names.
777 #if MIXEDCASE_FILENAMES
778 #define LEAF_FMT "%c"
781 #define LEAF_FMT "%02x"
786 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
787 * could at most have 10 digits, and the mask contains no more than 32 bits
788 * with each bit representing less than 15 characters. Usually the whole
789 * string is less than 80 columns, but this buffer size is an absolute
792 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
793 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
795 #ifdef USE_TERM_DRIVER
796 struct DriverTCB; /* Terminal Control Block forward declaration */
797 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
799 #define INIT_TERM_DRIVER() /* nothing */
808 * Global data which is not specific to a screen.
811 SIG_ATOMIC_T have_sigwinch;
812 SIG_ATOMIC_T cleanup_nested;
817 char *comp_sourcename;
820 bool have_tic_directory;
821 bool keep_tic_directory;
822 const char *tic_directory;
828 char **keyname_table;
833 size_t safeprint_used;
835 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
837 long tgetent_sequence;
839 char *dbd_blob; /* string-heap for dbd_list[] */
840 char **dbd_list; /* distinct places to look for data */
841 int dbd_size; /* length of dbd_list[] */
842 time_t dbd_time; /* cache last updated */
843 ITERATOR_VARS dbd_vars[dbdLAST];
845 #ifndef USE_SP_WINDOWLIST
846 WINDOWLIST *_nc_windowlist;
847 #define WindowList(sp) _nc_globals._nc_windowlist
850 #if USE_HOME_TERMINFO
854 #if !USE_SAFE_SPRINTF
859 #ifdef USE_TERM_DRIVER
860 int (*term_driver)(struct DriverTCB*, const char*, int*);
865 char trace_fname[PATH_MAX];
870 size_t tracearg_used;
872 TRACEBUF *tracebuf_ptr;
873 size_t tracebuf_used;
875 char tracechr_buf[40];
878 size_t tracedmp_used;
880 unsigned char *tracetry_buf;
881 size_t tracetry_used;
883 char traceatr_color_buf[2][80];
884 int traceatr_color_sel;
885 int traceatr_color_last;
886 #if !defined(USE_PTHREADS) && USE_REENTRANT
892 pthread_mutex_t mutex_curses;
893 pthread_mutex_t mutex_tst_tracef;
894 pthread_mutex_t mutex_tracef;
897 #define _nc_use_pthreads _nc_globals.use_pthreads
899 #if USE_PTHREADS_EINTR
900 pthread_t read_thread; /* The reading thread */
904 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
909 * Global data which can be swept up into a SCREEN when one is created.
910 * It may be modified before the next SCREEN is created.
915 attr_t previous_attr;
916 #ifndef USE_SP_RIPOFF
917 ripoff_t rippedoff[N_RIPS];
920 TPARM_STATE tparm_state;
921 TTY *saved_tty; /* savetty/resetty information */
922 #if NCURSES_NO_PADDING
923 bool _no_padding; /* flag to set if padding disabled */
925 NCURSES_SP_OUTC _outch; /* output handler if not putc */
926 #if BROKEN_LINKER || USE_REENTRANT
927 chtype *real_acs_map;
935 const char *_tputs_trace;
941 * Use screen-specific ripoff data (for softkeys) rather than global.
944 #define safe_ripoff_sp (sp)->rsp
945 #define safe_ripoff_stack (sp)->rippedoff
947 #define safe_ripoff_sp _nc_prescreen.rsp
948 #define safe_ripoff_stack _nc_prescreen.rippedoff
951 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
954 * The SCREEN structure.
958 int _ifd; /* input file ptr for screen */
959 FILE *_ofp; /* output file ptr for screen */
960 char *_setbuf; /* buffered I/O for output */
961 bool _filtered; /* filter() was called */
962 bool _buffered; /* setvbuf uses _setbuf data */
963 bool _prescreen; /* is in prescreen phase */
964 bool _use_env; /* LINES & COLS from environment? */
965 int _checkfd; /* filedesc for typeahead check */
966 TERMINAL *_term; /* terminal type information */
967 TTY _saved_tty; /* savetty/resetty information */
968 NCURSES_SIZE_T _lines; /* screen lines */
969 NCURSES_SIZE_T _columns; /* screen columns */
971 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
972 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
974 WINDOW *_curscr; /* current screen */
975 WINDOW *_newscr; /* virtual screen to be updated to */
976 WINDOW *_stdscr; /* screen's full-window context */
978 #define CurScreen(sp) (sp)->_curscr
979 #define NewScreen(sp) (sp)->_newscr
980 #define StdScreen(sp) (sp)->_stdscr
982 TRIES *_keytry; /* "Try" for use with keypad mode */
983 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
984 bool _tried; /* keypad mode was initialized */
985 bool _keypad_on; /* keypad mode is currently on */
987 bool _called_wgetch; /* check for recursion in wgetch() */
988 int _fifo[FIFO_SIZE]; /* input push-back buffer */
989 short _fifohead, /* head of fifo queue */
990 _fifotail, /* tail of fifo queue */
991 _fifopeek, /* where to peek for next char */
992 _fifohold; /* set if breakout marked */
994 int _endwin; /* are we out of window mode? */
995 NCURSES_CH_T *_current_attr; /* holds current attributes set */
996 int _coloron; /* is color enabled? */
997 int _color_defs; /* are colors modified */
998 int _cursor; /* visibility of the cursor */
999 int _cursrow; /* physical cursor row */
1000 int _curscol; /* physical cursor column */
1001 bool _notty; /* true if we cannot switch non-tty */
1002 int _nl; /* True if NL -> CR/NL is on */
1003 int _raw; /* True if in raw mode */
1004 int _cbreak; /* 1 if in cbreak mode */
1005 /* > 1 if in halfdelay mode */
1006 int _echo; /* True if echo on */
1007 int _use_meta; /* use the meta key? */
1008 struct _SLK *_slk; /* ptr to soft key struct / NULL */
1009 int slk_format; /* selected format for this screen */
1010 /* cursor movement costs; units are 10ths of milliseconds */
1011 #if NCURSES_NO_PADDING
1012 bool _no_padding; /* flag to set if padding disabled */
1014 int _char_padding; /* cost of character put */
1015 int _cr_cost; /* cost of (carriage_return) */
1016 int _cup_cost; /* cost of (cursor_address) */
1017 int _home_cost; /* cost of (cursor_home) */
1018 int _ll_cost; /* cost of (cursor_to_ll) */
1020 int _ht_cost; /* cost of (tab) */
1021 int _cbt_cost; /* cost of (backtab) */
1022 #endif /* USE_HARD_TABS */
1023 int _cub1_cost; /* cost of (cursor_left) */
1024 int _cuf1_cost; /* cost of (cursor_right) */
1025 int _cud1_cost; /* cost of (cursor_down) */
1026 int _cuu1_cost; /* cost of (cursor_up) */
1027 int _cub_cost; /* cost of (parm_cursor_left) */
1028 int _cuf_cost; /* cost of (parm_cursor_right) */
1029 int _cud_cost; /* cost of (parm_cursor_down) */
1030 int _cuu_cost; /* cost of (parm_cursor_up) */
1031 int _hpa_cost; /* cost of (column_address) */
1032 int _vpa_cost; /* cost of (row_address) */
1033 /* used in tty_update.c, must be chars */
1034 int _ed_cost; /* cost of (clr_eos) */
1035 int _el_cost; /* cost of (clr_eol) */
1036 int _el1_cost; /* cost of (clr_bol) */
1037 int _dch1_cost; /* cost of (delete_character) */
1038 int _ich1_cost; /* cost of (insert_character) */
1039 int _dch_cost; /* cost of (parm_dch) */
1040 int _ich_cost; /* cost of (parm_ich) */
1041 int _ech_cost; /* cost of (erase_chars) */
1042 int _rep_cost; /* cost of (repeat_char) */
1043 int _hpa_ch_cost; /* cost of (column_address) */
1044 int _cup_ch_cost; /* cost of (cursor_address) */
1045 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1046 int _inline_cost; /* cost of inline-move */
1047 int _smir_cost; /* cost of (enter_insert_mode) */
1048 int _rmir_cost; /* cost of (exit_insert_mode) */
1049 int _ip_cost; /* cost of (insert_padding) */
1050 /* used in lib_mvcur.c */
1051 char * _address_cursor;
1052 /* used in tty_update.c */
1053 int _scrolling; /* 1 if terminal's smart enough to */
1055 /* used in lib_color.c */
1056 color_t *_color_table; /* screen's color palette */
1057 int _color_count; /* count of colors in palette */
1058 colorpair_t *_color_pairs; /* screen's color pair list */
1059 int _pair_count; /* count of color pairs */
1060 int _pair_limit; /* actual limit of color-pairs */
1061 #if NCURSES_EXT_FUNCS
1062 bool _assumed_color; /* use assumed colors */
1063 bool _default_color; /* use default colors */
1064 bool _has_sgr_39_49; /* has ECMA default color support */
1065 int _default_fg; /* assumed default foreground */
1066 int _default_bg; /* assumed default background */
1067 int _default_pairs; /* count pairs using default color */
1069 chtype _ok_attributes; /* valid attributes for terminal */
1070 chtype _xmc_suppress; /* attributes to suppress if xmc */
1071 chtype _xmc_triggers; /* attributes to process if xmc */
1072 chtype * _acs_map; /* the real alternate-charset map */
1073 bool * _screen_acs_map;
1076 /* used in lib_vidattr.c */
1077 bool _use_rmso; /* true if we may use 'rmso' */
1078 bool _use_rmul; /* true if we may use 'rmul' */
1081 bool _extended_key; /* true if an extended key */
1085 * These data correspond to the state of the idcok() and idlok()
1086 * functions. A caveat is in order here: the XSI and SVr4
1087 * documentation specify that these functions apply to the window which
1088 * is given as an argument. However, ncurses implements this logic
1089 * only for the newscr/curscr update process, _not_ per-window.
1095 * These are the data that support the mouse interface.
1097 bool _mouse_initialized;
1098 MouseType _mouse_type;
1100 bool (*_mouse_event) (SCREEN *);
1101 bool (*_mouse_inline)(SCREEN *);
1102 bool (*_mouse_parse) (SCREEN *, int);
1103 void (*_mouse_resume)(SCREEN *);
1104 void (*_mouse_wrap) (SCREEN *);
1105 int _mouse_fd; /* file-descriptor, if any */
1106 bool _mouse_active; /* true if initialized */
1107 mmask_t _mouse_mask; /* set via mousemask() */
1108 mmask_t _mouse_mask2; /* OR's in press/release bits */
1109 mmask_t _mouse_bstate;
1110 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1111 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1112 MEVENT *_mouse_eventp; /* next free slot in event queue */
1115 bool _mouse_gpm_loaded;
1116 bool _mouse_gpm_found;
1119 TYPE_gpm_fd _mouse_gpm_fd;
1120 TYPE_Gpm_Open _mouse_Gpm_Open;
1121 TYPE_Gpm_Close _mouse_Gpm_Close;
1122 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1124 Gpm_Connect _mouse_gpm_connect;
1125 #endif /* USE_GPM_SUPPORT */
1129 int _emxmouse_thread;
1130 int _emxmouse_activated;
1131 char _emxmouse_buttons[4];
1135 MEVENT _sysmouse_fifo[FIFO_SIZE];
1138 int _sysmouse_char_width; /* character width */
1139 int _sysmouse_char_height; /* character height */
1140 int _sysmouse_old_buttons;
1141 int _sysmouse_new_buttons;
1144 #ifdef USE_TERM_DRIVER
1145 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1146 int _drv_mouse_head;
1147 int _drv_mouse_tail;
1148 int _drv_mouse_old_buttons;
1149 int _drv_mouse_new_buttons;
1152 * This supports automatic resizing
1155 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1159 * These are data that support the proper handling of the panel stack on an
1162 struct panelhook _panelHook;
1165 SCREEN *_next_screen;
1167 /* hashes for old and new lines */
1168 unsigned long *oldhash, *newhash;
1174 bool _cleanup; /* cleanup after int/quit signal */
1175 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1177 int _legacy_coding; /* see use_legacy_coding() */
1180 char _ttytype[NAMESIZE];
1187 const char *_tputs_trace;
1192 char tracechr_buf[40];
1193 char tracemse_buf[TRACEMSE_MAX];
1195 #ifdef USE_SP_WINDOWLIST
1196 WINDOWLIST* _windowlist;
1197 #define WindowList(sp) (sp)->_windowlist
1201 ripoff_t rippedoff[N_RIPS];
1205 * ncurses/ncursesw are the same up to this point.
1207 #if USE_WIDEC_SUPPORT
1208 /* recent versions of 'screen' have partially-working support for
1209 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1211 bool _screen_acs_fix;
1215 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1216 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1220 SCREEN *screen; /* screen containing the window */
1221 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1222 #if NCURSES_WIDECHAR
1223 char addch_work[(MB_LEN_MAX * 9) + 1];
1224 unsigned addch_used; /* number of bytes in addch_work[] */
1225 int addch_x; /* x-position for addch_work[] */
1226 int addch_y; /* y-position for addch_work[] */
1230 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1232 #define SP_PRE_INIT(sp) \
1233 sp->_cursrow = -1; \
1234 sp->_curscol = -1; \
1239 sp->_fifohead = -1; \
1240 sp->_endwin = TRUE; \
1242 WindowList(sp) = 0; \
1243 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1246 /* usually in <limits.h> */
1248 #define UCHAR_MAX 255
1251 /* The terminfo source is assumed to be 7-bit ASCII */
1252 #define is7bits(c) ((unsigned)(c) < 128)
1254 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1255 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1258 #define min(a,b) ((a) > (b) ? (b) : (a))
1262 #define max(a,b) ((a) < (b) ? (b) : (a))
1265 /* usually in <unistd.h> */
1266 #ifndef STDIN_FILENO
1267 #define STDIN_FILENO 0
1270 #ifndef STDOUT_FILENO
1271 #define STDOUT_FILENO 1
1274 #ifndef STDERR_FILENO
1275 #define STDERR_FILENO 2
1278 #ifndef EXIT_SUCCESS
1279 #define EXIT_SUCCESS 0
1282 #ifndef EXIT_FAILURE
1283 #define EXIT_FAILURE 1
1287 #define R_OK 4 /* Test for read permission. */
1290 #define W_OK 2 /* Test for write permission. */
1293 #define X_OK 1 /* Test for execute permission. */
1296 #define F_OK 0 /* Test for existence. */
1300 #include <fcntl.h> /* may define O_BINARY */
1309 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1311 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1314 #define COUNT_OUTCHARS(n) /* nothing */
1317 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1319 #define UChar(c) ((unsigned char)(c))
1320 #define UShort(c) ((unsigned short)(c))
1321 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1322 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1325 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1328 #if USE_WIDEC_SUPPORT /* { */
1329 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1331 #define init_mb(state) memset(&state, 0, sizeof(state))
1333 #if NCURSES_EXT_COLORS
1334 #define NulColor , 0
1336 #define NulColor /* nothing */
1339 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1340 #define CharOf(c) ((c).chars[0])
1341 #define AttrOf(c) ((c).attr)
1343 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1344 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1345 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1347 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1348 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1351 #define CharEq(a,b) (((a).attr == (b).attr) \
1352 && (a).chars[0] == (b).chars[0] \
1353 && (a).chars[1] == (b).chars[1] \
1354 && (a).chars[2] == (b).chars[2] \
1355 && (a).chars[3] == (b).chars[3] \
1356 && (a).chars[4] == (b).chars[4] \
1357 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1359 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1362 #define SetChar(ch,c,a) do { \
1363 NCURSES_CH_T *_cp = &ch; \
1364 memset(_cp, 0, sizeof(ch)); \
1365 _cp->chars[0] = (wchar_t) (c); \
1367 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1369 #define CHREF(wch) (&wch)
1370 #define CHDEREF(wch) (*wch)
1371 #define ARG_CH_T NCURSES_CH_T *
1372 #define CARG_CH_T const NCURSES_CH_T *
1373 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1374 mbstate_t PUT_st; wchar_t PUTC_ch
1375 #define PUTC_INIT init_mb (PUT_st)
1376 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1377 if (Charable(ch)) { \
1378 fputc(CharOf(ch), b); \
1379 COUNT_OUTCHARS(1); \
1382 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1383 PUTC_ch = (ch).chars[PUTC_i]; \
1384 if (PUTC_ch == L'\0') \
1386 PUTC_n = (int) wcrtomb(PUTC_buf, \
1387 (ch).chars[PUTC_i], &PUT_st); \
1388 if (PUTC_n <= 0) { \
1389 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1393 IGNORE_RC(fwrite(PUTC_buf, (size_t) PUTC_n, (size_t) 1, b)); \
1395 COUNT_OUTCHARS(PUTC_i); \
1398 #define BLANK NewChar2(' ', WA_NORMAL)
1399 #define ZEROS NewChar2('\0', WA_NORMAL)
1400 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1403 * Wide characters cannot be represented in the A_CHARTEXT mask of
1404 * attr_t's but an application might have set a narrow character there.
1405 * But even in that case, it would only be a printable character, or
1406 * zero. Otherwise we can use those bits to tell if a cell is the
1407 * first or extension part of a wide character.
1409 #define WidecExt(ch) (int) (AttrOf(ch) & A_CHARTEXT)
1410 #define isWidecBase(ch) (WidecExt(ch) == 1)
1411 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1412 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1413 AttrOf(dst) |= (attr_t) (ext + 1)
1415 #define if_WIDEC(code) code
1416 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1417 || (AttrOf(ch) & A_ALTCHARSET) \
1418 || (!isWidecExt(ch) && \
1419 (ch).chars[1] == L'\0' && \
1420 _nc_is_charable(CharOf(ch))))
1422 #define L(ch) L ## ch
1424 #define CharOf(c) ChCharOf(c)
1425 #define AttrOf(c) ChAttrOf(c)
1426 #define AddAttr(c,a) c |= (a)
1427 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1428 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1429 #define NewChar(ch) (ch)
1430 #define NewChar2(c,a) ((c) | (a))
1431 #define CharEq(a,b) ((a) == (b))
1432 #define SetChar(ch,c,a) ch = (c) | (a)
1433 #define CHREF(wch) wch
1434 #define CHDEREF(wch) wch
1435 #define ARG_CH_T NCURSES_CH_T
1436 #define CARG_CH_T NCURSES_CH_T
1437 #define PUTC_DATA int data = 0
1438 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1440 #define BLANK (' '|A_NORMAL)
1441 #define ZEROS ('\0'|A_NORMAL)
1442 #define ISBLANK(ch) (CharOf(ch) == ' ')
1444 #define isWidecExt(ch) (0)
1445 #define if_WIDEC(code) /* nothing */
1450 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1451 #define CharOfD(ch) CharOf(CHDEREF(ch))
1452 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1454 #define BLANK_ATTR A_NORMAL
1455 #define BLANK_TEXT L(' ')
1459 #define LEGALYX(w, y, x) \
1461 ((x) >= 0 && (x) <= (w)->_maxx && \
1462 (y) >= 0 && (y) <= (w)->_maxy))
1464 #define CHANGED_CELL(line,col) \
1465 if (line->firstchar == _NOCHANGE) \
1466 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1467 else if ((col) < line->firstchar) \
1468 line->firstchar = (NCURSES_SIZE_T) (col); \
1469 else if ((col) > line->lastchar) \
1470 line->lastchar = (NCURSES_SIZE_T) (col)
1472 #define CHANGED_RANGE(line,start,end) \
1473 if (line->firstchar == _NOCHANGE \
1474 || line->firstchar > (start)) \
1475 line->firstchar = (NCURSES_SIZE_T) (start); \
1476 if (line->lastchar == _NOCHANGE \
1477 || line->lastchar < (end)) \
1478 line->lastchar = (NCURSES_SIZE_T) (end)
1480 #define CHANGED_TO_EOL(line,start,end) \
1481 if (line->firstchar == _NOCHANGE \
1482 || line->firstchar > (start)) \
1483 line->firstchar = (NCURSES_SIZE_T) (start); \
1484 line->lastchar = (NCURSES_SIZE_T) (end)
1486 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1488 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1490 /* FreeAndNull() is not a comma-separated expression because some compilers
1491 * do not accept a mixture of void with values.
1493 #define FreeAndNull(p) free(p); p = 0
1495 #include <nc_alloc.h>
1498 * TTY bit definition for converting tabs to spaces.
1501 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1504 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1507 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1509 # define OFLAGS_TABS 0
1515 * Standardize/simplify common loops
1517 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1518 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1519 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1522 * Prefixes for call/return points of library function traces. We use these to
1523 * instrument the public functions so that the traces can be easily transformed
1524 * into regression scripts.
1526 #define T_CALLED(fmt) "called {" fmt
1527 #define T_CREATE(fmt) "create :" fmt
1528 #define T_RETURN(fmt) "return }" fmt
1533 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1535 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1538 #define START_TRACE() \
1539 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1540 int t = _nc_getenv_num("NCURSES_TRACE"); \
1542 trace((unsigned) t); \
1546 * Many of the _tracef() calls use static buffers; lock the trace state before
1547 * trying to fill them.
1550 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1551 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1552 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1554 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1555 #define _nc_locked_tracef _tracef
1558 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1559 #define T(a) TR(TRACE_CALLS, a)
1560 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1561 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1562 #define TRACE_RETURN_SP(value,type) return _nc_retrace_##type(SP_PARM, value)
1564 #define NonNull(s) ((s) != 0 ? s : "<null>")
1566 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1567 #define returnBits(code) TRACE_RETURN(code,unsigned)
1568 #define returnBool(code) TRACE_RETURN(code,bool)
1569 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1570 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1571 #define returnChar(code) TRACE_RETURN(code,char)
1572 #define returnChtype(code) TRACE_RETURN(code,chtype)
1573 #define returnCode(code) TRACE_RETURN(code,int)
1574 #define returnIntAttr(code) TRACE_RETURN2(code,int,attr_t)
1575 #define returnMMask(code) TRACE_RETURN_SP(code,mmask_t)
1576 #define returnPtr(code) TRACE_RETURN(code,ptr)
1577 #define returnSP(code) TRACE_RETURN(code,sp)
1578 #define returnVoid T((T_RETURN(""))); return
1579 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1580 #define returnWin(code) TRACE_RETURN(code,win)
1582 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (int);
1583 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1584 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1585 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1586 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1587 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1588 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1589 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1590 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1591 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1592 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1593 extern NCURSES_EXPORT(char) _nc_retrace_char (int);
1594 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1595 extern NCURSES_EXPORT(int) _nc_retrace_int_attr_t (attr_t);
1596 extern NCURSES_EXPORT(mmask_t) _nc_retrace_mmask_t (SCREEN *, mmask_t);
1597 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1598 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1599 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1602 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1603 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1604 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1605 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1606 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1607 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1609 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1610 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1613 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1615 #if USE_WIDEC_SUPPORT
1616 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1617 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1620 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1621 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1625 #define START_TRACE() /* nothing */
1629 #define TPUTS_TRACE(s)
1631 #define returnAttr(code) return code
1632 #define returnBits(code) return code
1633 #define returnBool(code) return code
1634 #define returnCPtr(code) return code
1635 #define returnCVoidPtr(code) return code
1636 #define returnChar(code) return ((char) code)
1637 #define returnChtype(code) return code
1638 #define returnCode(code) return code
1639 #define returnIntAttr(code) return code
1640 #define returnMMask(code) return code
1641 #define returnPtr(code) return code
1642 #define returnSP(code) return code
1643 #define returnVoid return
1644 #define returnVoidPtr(code) return code
1645 #define returnWin(code) return code
1647 #endif /* TRACE/!TRACE */
1650 * Workaround for defective implementation of gcc attribute warn_unused_result
1652 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1653 #define IGNORE_RC(func) errno = (int) func
1655 #define IGNORE_RC(func) (void) func
1656 #endif /* gcc workarounds */
1659 * Return-codes for tgetent() and friends.
1661 #define TGETENT_YES 1 /* entry is found */
1662 #define TGETENT_NO 0 /* entry is not found */
1663 #define TGETENT_ERR -1 /* an error occurred */
1665 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1666 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1668 #define EMPTY_MODULE(name) \
1669 extern NCURSES_EXPORT(void) name (void); \
1670 NCURSES_EXPORT(void) name (void) { }
1672 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1673 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1674 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1676 #define toggle_attr_on(S,at) {\
1677 if (PairNumber(at) > 0) {\
1678 (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1680 (S) |= (attr_t) (at);\
1682 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1685 #define toggle_attr_off(S,at) {\
1686 if (PairNumber(at) > 0) {\
1687 (S) &= ~(at|A_COLOR);\
1691 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1693 #define DelCharCost(sp,count) \
1696 : ((delete_character != 0) \
1697 ? (sp->_dch1_cost * count) \
1700 #define InsCharCost(sp,count) \
1703 : ((enter_insert_mode && exit_insert_mode) \
1704 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1705 : ((insert_character != 0) \
1706 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1710 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1711 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1712 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1713 if (magic_cookie_glitch > 0 \
1714 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1715 T(("%s @%d before glitch %d,%d", \
1716 __FILE__, __LINE__, \
1719 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1723 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1724 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1729 * Macros to make additional parameter to implement wgetch_events()
1731 #ifdef NCURSES_WGETCH_EVENTS
1732 #define EVENTLIST_0th(param) param
1733 #define EVENTLIST_1st(param) param
1734 #define EVENTLIST_2nd(param) , param
1735 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1737 #define EVENTLIST_0th(param) void
1738 #define EVENTLIST_1st(param) /* nothing */
1739 #define EVENTLIST_2nd(param) /* nothing */
1740 #define TWAIT_MASK TW_ANY
1743 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1745 #undef toggle_attr_on
1746 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1747 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1749 #undef toggle_attr_off
1750 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1751 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1754 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1757 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1759 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1760 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1763 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1765 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1766 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1768 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1771 #if NCURSES_SP_FUNCS
1772 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1773 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1774 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1775 #endif /* NCURSES_SP_FUNCS */
1779 extern NCURSES_EXPORT(void) _nc_expanded (void);
1783 #if !NCURSES_EXT_FUNCS
1784 #define set_escdelay(value) ESCDELAY = value
1788 #define getcwd(buf,len) getwd(buf)
1792 #if USE_WIDEC_SUPPORT
1793 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1794 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1795 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1800 short nte_name; /* offset of name to hash on */
1801 int nte_type; /* BOOLEAN, NUMBER or STRING */
1802 short nte_index; /* index of associated variable in its array */
1803 short nte_link; /* index in table of next hash, or -1 */
1815 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1819 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1820 extern NCURSES_EXPORT(void) _nc_linedump (void);
1824 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1825 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1828 #if USE_WIDEC_SUPPORT
1829 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1833 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1834 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1838 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1841 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1844 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1847 #define INFINITY 1000000 /* cost: too high to use */
1849 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1850 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1851 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1853 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1855 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1856 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1857 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1860 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1863 #define INFINITY 1000000 /* cost: too high to use */
1864 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1867 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1868 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1869 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1870 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, int);
1871 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, int);
1873 /* lib_set_term.c */
1874 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1877 #define ret_error(code, fmt, arg) if (errret) {\
1881 fprintf(stderr, fmt, arg);\
1882 exit(EXIT_FAILURE);\
1885 #define ret_error1(code, fmt, arg) ret_error(code, "'%s': " fmt, arg)
1887 #define ret_error0(code, msg) if (errret) {\
1891 fprintf(stderr, msg);\
1892 exit(EXIT_FAILURE);\
1897 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1899 #define _nc_handle_sigwinch(a) /* nothing */
1903 #if USE_WIDEC_SUPPORT
1904 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1908 char *s_head; /* beginning of the string (may be null) */
1909 char *s_tail; /* end of the string (may be null) */
1910 size_t s_size; /* current remaining size available */
1911 size_t s_init; /* total size available */
1915 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1916 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1917 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1918 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1919 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1922 #define strstr _nc_strstr
1923 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1926 /* safe_sprintf.c */
1927 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1930 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1931 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1932 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1933 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1936 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1937 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1938 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1939 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1940 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1941 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1942 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1943 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1944 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1945 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1946 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1947 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1948 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
1949 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1950 extern NCURSES_EXPORT(int) _nc_outch (int);
1951 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1952 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1953 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1954 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
1955 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
1956 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1957 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
1958 extern NCURSES_EXPORT(void) _nc_flush (void);
1959 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1960 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1961 extern NCURSES_EXPORT(void) _nc_freeall (void);
1962 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1963 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1964 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1965 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1966 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1967 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1968 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
1969 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
1970 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1971 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1974 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1975 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1976 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1977 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1978 extern NCURSES_EXPORT(void) _nc_comp_error_leaks(void);
1979 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1980 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
1981 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1982 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1983 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1986 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1987 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1988 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1989 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
1992 #if USE_WIDEC_SUPPORT
1993 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1996 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1997 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
2001 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
2005 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
2007 #define _nc_resize_margins(wp) /* nothing */
2010 #ifdef NCURSES_WGETCH_EVENTS
2011 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2013 #define wgetch_events(win, evl) wgetch(win)
2014 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2018 * Wide-character macros to hide some platform-differences.
2020 #if USE_WIDEC_SUPPORT
2021 #if HAVE_MBTOWC && HAVE_MBLEN
2022 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2023 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2024 #define check_mbytes(wch,buffer,length,state) \
2025 (int) mbtowc(&wch, buffer, length)
2026 #define state_unused
2027 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2028 #define reset_mbytes(state) init_mb(state)
2029 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
2030 #define check_mbytes(wch,buffer,length,state) \
2031 (int) mbrtowc(&wch, buffer, length, &state)
2038 * Not everyone has vsscanf(), but we'd like to use it for scanw().
2041 extern int vsscanf(const char *str, const char *format, va_list __arg);
2044 /* scroll indices */
2045 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2047 #define USE_SETBUF_0 0
2049 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
2051 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
2054 * On systems with a broken linker, define 'SP' as a function to force the
2055 * linker to pull in the data-only module with 'SP'.
2057 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2060 #define SP _nc_screen()
2061 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2062 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
2063 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
2064 #define CURRENT_SCREEN _nc_screen()
2066 /* current screen is private data; avoid possible linking conflicts too */
2067 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2068 #define CURRENT_SCREEN SP
2069 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
2070 #define _nc_set_screen(sp) SP = sp
2073 #if NCURSES_SP_FUNCS
2074 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2076 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
2080 * We don't want to use the lines or columns capabilities internally, because
2081 * if the application is running multiple screens under X, it's quite possible
2082 * they could all have type xterm but have different sizes! So...
2084 #define screen_lines(sp) (sp)->_lines
2085 #define screen_columns(sp) (sp)->_columns
2087 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2088 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2091 * Some constants related to SLK's
2093 #define MAX_SKEY_OLD 8 /* count of soft keys */
2094 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2095 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2096 #define MAX_SKEY_LEN_PC 5
2098 /* Macro to check whether or not we use a standard format */
2099 #define SLK_STDFMT(fmt) (fmt < 3)
2100 /* Macro to determine height of label window */
2101 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2103 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2104 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2107 * Common error messages
2109 #define MSG_NO_MEMORY "Out of memory"
2110 #define MSG_NO_INPUTS "Premature EOF"
2112 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2113 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2115 /* timed_wait flag definitions */
2119 #define TW_ANY (TW_INPUT | TW_MOUSE)
2122 #define SetSafeOutcWrapper(outc) \
2123 SCREEN* sp = CURRENT_SCREEN; \
2125 struct screen dummy; \
2127 memset(sp,0,sizeof(struct screen)); \
2128 sp->_outch = _nc_outc_wrapper; \
2132 #ifdef USE_TERM_DRIVER
2133 typedef void* TERM_HANDLE;
2135 typedef struct _termInfo
2154 const color_t* defaultPalette;
2157 typedef struct term_driver {
2159 bool (*CanHandle)(struct DriverTCB*, const char*, int*);
2160 void (*init)(struct DriverTCB*);
2161 void (*release)(struct DriverTCB*);
2162 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2163 int (*sgmode)(struct DriverTCB*, int setFlag, TTY*);
2164 chtype (*conattr)(struct DriverTCB*);
2165 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2166 int (*mode)(struct DriverTCB*, int progFlag, int defFlag);
2167 bool (*rescol)(struct DriverTCB*);
2168 bool (*rescolors)(struct DriverTCB*);
2169 void (*color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2170 int (*doBeepOrFlash)(struct DriverTCB*, int);
2171 void (*initpair)(struct DriverTCB*, int, int, int);
2172 void (*initcolor)(struct DriverTCB*, int, int, int, int);
2173 void (*docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2174 void (*initmouse)(struct DriverTCB*);
2175 int (*testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2176 void (*setfilter)(struct DriverTCB*);
2177 void (*hwlabel)(struct DriverTCB*, int, char*);
2178 void (*hwlabelOnOff)(struct DriverTCB*, int);
2179 int (*update)(struct DriverTCB*);
2180 int (*defaultcolors)(struct DriverTCB*, int, int);
2181 int (*print)(struct DriverTCB*, char*, int);
2182 int (*getsize)(struct DriverTCB*, int*, int*);
2183 int (*setsize)(struct DriverTCB*, int, int);
2184 void (*initacs)(struct DriverTCB*, chtype*, chtype*);
2185 void (*scinit)(SCREEN *);
2186 void (*scexit)(SCREEN *);
2187 int (*twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2188 int (*read)(struct DriverTCB*, int*);
2189 int (*nap)(struct DriverTCB*, int);
2190 int (*kpad)(struct DriverTCB*, int);
2191 int (*kyOk)(struct DriverTCB*, int, int);
2192 bool (*kyExist)(struct DriverTCB*, int);
2195 typedef struct DriverTCB
2197 TERMINAL term; /* needs to be the first Element !!! */
2198 TERM_HANDLE inp; /* The input handle of the Terminal */
2199 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2200 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2201 TERM_DRIVER* drv; /* The driver for that Terminal */
2202 SCREEN* csp; /* The screen that owns that Terminal */
2203 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2204 void* prop; /* Driver dependent property storage to be used by the Driver */
2206 } TERMINAL_CONTROL_BLOCK;
2208 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2209 #define NCDRV_TINFO 0x01
2210 #define NCDRV_WINCONSOLE 0x02
2212 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2213 #define InfoOf(sp) TCBOf(sp)->info
2214 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2215 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2216 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2217 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2218 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2220 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2221 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2223 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2224 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2225 #endif /* USE_TERM_DRIVER */
2228 * Entrypoints which are actually provided in the terminal driver, which would
2229 * be an sp-name otherwise.
2231 #ifdef USE_TERM_DRIVER
2232 #define TINFO_HAS_KEY _nc_tinfo_has_key
2233 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2234 #define TINFO_MVCUR _nc_tinfo_mvcur
2235 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2236 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2237 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2239 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2240 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2241 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2245 * Entrypoints using an extra parameter with the terminal driver.
2247 #ifdef USE_TERM_DRIVER
2248 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2249 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, int);
2250 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2251 _nc_get_screensize(sp, tp, lp, cp)
2252 #define TINFO_SET_CURTERM(sp, tp) \
2253 NCURSES_SP_NAME(set_curterm)(sp, tp)
2254 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2255 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2256 #else /* !USE_TERM_DRIVER */
2257 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2258 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2259 _nc_get_screensize(sp, lp, cp)
2260 #define TINFO_SET_CURTERM(sp, tp) \
2262 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2263 _nc_setupterm(name, fd, err, reuse)
2264 #endif /* !USE_TERM_DRIVER */
2266 #ifdef USE_TERM_DRIVER
2268 #include <nc_mingw.h>
2269 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2271 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2274 #ifdef USE_TERM_DRIVER
2275 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2277 #define IsTermInfo(sp) TRUE
2280 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2281 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2284 * Exported entrypoints beyond the published API
2286 #if NCURSES_SP_FUNCS
2287 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2288 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2289 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2290 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2293 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2294 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2297 #if NCURSES_EXT_FUNCS
2298 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2302 * We put the safe versions of various calls here as they are not published
2303 * part of the API up to now
2305 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2306 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2307 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2308 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2309 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2310 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2311 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2312 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2313 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2314 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2315 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2316 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2317 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2318 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2319 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2320 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2321 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2322 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2323 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2324 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2325 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2326 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2327 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2328 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2329 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2330 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2331 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2332 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2333 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2334 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2335 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2336 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2337 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2338 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2339 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2340 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2341 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2342 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2343 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2344 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2345 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2346 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2348 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2350 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2351 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2354 #if USE_WIDEC_SUPPORT
2355 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2358 #endif /* NCURSES_SP_FUNCS */
2360 #if NCURSES_SP_FUNCS
2362 #define safe_keyname NCURSES_SP_NAME(keyname)
2363 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2364 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2368 #define safe_keyname _nc_keyname
2369 #define safe_unctrl _nc_unctrl
2370 #define safe_ungetch _nc_ungetch
2372 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2373 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2374 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2384 #endif /* CURSES_PRIV_H */