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.485 2011/10/08 21:00:56 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
345 #include <nc_termios.h>
348 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
349 * pointer to this data.
351 #ifdef USE_SP_TERMTYPE
355 #define SP_TERMTYPE TerminalOf(sp)->type.
357 #include <term_entry.h>
359 #include <nc_tparm.h>
362 * Use these macros internally, to make tracing less verbose. But leave the
363 * option for compiling the tracing into the library.
366 #define ColorPair(n) NCURSES_BITS(n, 0)
367 #define PairNumber(a) (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
369 #define ColorPair(pair) COLOR_PAIR(pair)
370 #define PairNumber(attr) PAIR_NUMBER(attr)
373 #define unColor(n) unColor2(AttrOf(n))
374 #define unColor2(a) ((a) & ALL_BUT_COLOR)
377 * Extended-colors stores the color pair in a separate struct-member than the
378 * attributes. But for compatibility, we handle most cases where a program
379 * written for non-extended colors stores the color in the attributes by
380 * checking for a color pair in both places.
382 #if NCURSES_EXT_COLORS
383 #define if_EXT_COLORS(stmt) stmt
384 #define SetPair(value,p) SetPair2((value).ext_color, AttrOf(value), p)
385 #define SetPair2(c,a,p) c = (p), \
386 a = (unColor2(a) | (A_COLOR & ColorPair(oldColor(c))))
387 #define GetPair(value) GetPair2((value).ext_color, AttrOf(value))
388 #define GetPair2(c,a) ((c) ? (c) : PairNumber(a))
389 #define oldColor(p) (((p) > 255) ? 255 : (p))
390 #define GET_WINDOW_PAIR(w) GetPair2((w)->_color, (w)->_attrs)
391 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
392 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
395 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
397 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
400 #else /* !NCURSES_EXT_COLORS */
402 #define if_EXT_COLORS(stmt) /* nothing */
403 #define SetPair(value,p) RemAttr(value, A_COLOR), \
404 SetAttr(value, AttrOf(value) | (A_COLOR & (attr_t) ColorPair(p)))
405 #define GetPair(value) PairNumber(AttrOf(value))
406 #define GET_WINDOW_PAIR(w) PairNumber(WINDOW_ATTRS(w))
407 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
408 WINDOW_ATTRS(w) |= (A_COLOR & (attr_t) ColorPair(p))
409 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
412 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
414 #define VIDATTR(sp,attr,pair) vidattr(attr)
417 #endif /* NCURSES_EXT_COLORS */
419 #if NCURSES_NO_PADDING
420 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
421 #define SetNoPadding(sp) _nc_set_no_padding(sp)
422 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
424 #define GetNoPadding(sp) FALSE
425 #define SetNoPadding(sp) /*nothing*/
428 #define WINDOW_ATTRS(w) ((w)->_attrs)
430 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
431 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
432 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
434 #if USE_REENTRANT || NCURSES_SP_FUNCS
435 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
436 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
437 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
438 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
443 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
444 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
445 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
446 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
448 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
449 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
450 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
451 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
455 #define ptrLines(sp) &LINES
456 #define ptrCols(sp) &COLS
457 #define ptrTabsize(sp) &TABSIZE
458 #define ptrEscdelay(sp) &ESCDELAY
460 #define SET_LINES(value) LINES = value
461 #define SET_COLS(value) COLS = value
462 #define SET_TABSIZE(value) TABSIZE = value
463 #define SET_ESCDELAY(value) ESCDELAY = value
467 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
468 __FILE__, __LINE__, \
469 (unsigned long) (pthread_self()), \
470 data.__data.__lock, \
471 data.__data.__count, \
472 data.__data.__owner, \
473 data.__data.__kind, \
474 (data.__data.__nusers > 5) ? " OOPS " : "", \
475 data.__data.__nusers)
476 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
479 #if defined(__GNUC__)
480 # if defined __USE_ISOC99
481 # define _cat_pragma(exp) _Pragma(#exp)
482 # define _weak_pragma(exp) _cat_pragma(weak name)
484 # define _weak_pragma(exp)
486 # define _declare(name) __extension__ extern __typeof__(name) name
487 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
495 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
496 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
497 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
498 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
499 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
500 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
501 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
502 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
505 #error POSIX threads requires --enable-reentrant option
509 # if USE_WEAK_SYMBOLS
510 weak_symbol(pthread_sigmask);
511 weak_symbol(pthread_kill);
512 weak_symbol(pthread_self);
513 weak_symbol(pthread_equal);
514 weak_symbol(pthread_mutex_init);
515 weak_symbol(pthread_mutex_lock);
516 weak_symbol(pthread_mutex_unlock);
517 weak_symbol(pthread_mutex_trylock);
518 weak_symbol(pthread_mutexattr_settype);
519 weak_symbol(pthread_mutexattr_init);
520 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
522 # define sigprocmask _nc_sigprocmask
527 #undef HAVE_NANOSLEEP
528 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
531 #else /* !USE_PTHREADS */
533 #if USE_PTHREADS_EINTR
534 # if USE_WEAK_SYMBOLS
536 weak_symbol(pthread_sigmask);
537 weak_symbol(pthread_kill);
538 weak_symbol(pthread_self);
539 weak_symbol(pthread_equal);
540 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
542 # define sigprocmask _nc_sigprocmask
544 #endif /* USE_PTHREADS_EINTR */
546 #define _nc_init_pthreads() /* nothing */
547 #define _nc_mutex_init(obj) /* nothing */
549 #define _nc_lock_global(name) /* nothing */
550 #define _nc_try_global(name) 0
551 #define _nc_unlock_global(name) /* nothing */
553 #endif /* USE_PTHREADS */
556 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
557 * So the locking is done in the non-sp-func (which calls the sp-func) rather
558 * than in the sp-func itself.
560 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
561 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
565 #define _nc_nonsp_lock_global(name) /* nothing */
566 #define _nc_nonsp_try_global(name) 0
567 #define _nc_nonsp_unlock_global(name) /* nothing */
569 #define _nc_sp_lock_global(name) _nc_lock_global(name)
570 #define _nc_sp_try_global(name) _nc_try_global(name)
571 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
575 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
576 #define _nc_nonsp_try_global(name) _nc_try_global(name)
577 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
579 #define _nc_sp_lock_global(name) /* nothing */
580 #define _nc_sp_try_global(name) 0
581 #define _nc_sp_unlock_global(name) /* nothing */
585 #if HAVE_GETTIMEOFDAY
586 # define PRECISE_GETTIME 1
587 # define TimeType struct timeval
589 # define PRECISE_GETTIME 0
590 # define TimeType time_t
594 * Definitions for color pairs
596 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
597 #define C_SHIFT 9 /* we need more bits than there are colors */
598 #define C_MASK ((1 << C_SHIFT) - 1)
599 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
600 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
601 #define BACK_OF(c) ((c) & C_MASK)
602 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
604 #define COLOR_DEFAULT C_MASK
606 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
608 #undef NCURSES_CH_T /* this is not a termlib feature */
609 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
611 #endif /* USE_TERMLIB */
616 NCURSES_CH_T *text; /* text of the line */
617 NCURSES_SIZE_T firstchar; /* first changed character in the line */
618 NCURSES_SIZE_T lastchar; /* last changed character in the line */
619 NCURSES_SIZE_T oldindex; /* index of the line at last update */
621 #endif /* USE_TERMLIB */
624 M_XTERM = -1 /* use xterm's mouse tracking? */
625 ,M_NONE = 0 /* no mouse device */
630 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
632 #ifdef USE_TERM_DRIVER
633 ,M_TERM_DRIVER /* Win32 console, etc */
638 * Structures for scrolling.
642 unsigned long hashval;
643 int oldcount, newcount;
644 int oldindex, newindex;
648 * Structures for soft labels.
653 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
657 char *ent_text; /* text for the label */
658 char *form_text; /* formatted text (left/center/...) */
659 int ent_x; /* x coordinate of this field */
660 char dirty; /* this label has changed */
661 char visible; /* field is visible */
664 typedef struct _SLK {
665 bool dirty; /* all labels have changed */
666 bool hidden; /* soft labels are hidden */
669 short maxlab; /* number of available labels */
670 short labcnt; /* number of allocated labels */
671 short maxlen; /* length of labels */
672 NCURSES_CH_T attr; /* soft label attribute */
675 #endif /* USE_TERMLIB */
678 WINDOW *win; /* the window used in the hook */
679 int line; /* lines to take, < 0 => from bottom*/
680 int (*hook)(WINDOW *, int); /* callback for user */
684 #undef buttons /* term.h defines this, and gpm uses it! */
688 /* link dynamically to GPM */
689 typedef int *TYPE_gpm_fd;
690 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
691 typedef int (*TYPE_Gpm_Close) (void);
692 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
694 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
695 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
696 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
697 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
699 /* link statically to GPM */
700 #define my_gpm_fd &gpm_fd
701 #define my_Gpm_Open Gpm_Open
702 #define my_Gpm_Close Gpm_Close
703 #define my_Gpm_GetEvent Gpm_GetEvent
704 #endif /* HAVE_LIBDL */
705 #endif /* USE_GPM_SUPPORT */
710 char *fix_sgr0; /* this holds the filtered sgr0 string */
711 char *last_bufp; /* help with fix_sgr0 leak */
715 #define TGETENT_MAX 4
736 const char *tparam_base;
738 STACK_FRAME stack[STACKSIZE];
748 int dynamic_var[NUM_VARS];
749 int static_vars[NUM_VARS];
758 * The filesystem database normally uses a single-letter for the lower level
759 * of directories. Use a hexadecimal code for filesystems which do not
760 * preserve mixed-case names.
762 #if MIXEDCASE_FILENAMES
763 #define LEAF_FMT "%c"
766 #define LEAF_FMT "%02x"
771 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
772 * could at most have 10 digits, and the mask contains no more than 32 bits
773 * with each bit representing less than 15 characters. Usually the whole
774 * string is less than 80 columns, but this buffer size is an absolute
777 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
778 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
780 #ifdef USE_TERM_DRIVER
781 struct DriverTCB; /* Terminal Control Block forward declaration */
782 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
784 #define INIT_TERM_DRIVER() /* nothing */
793 * Global data which is not specific to a screen.
796 SIG_ATOMIC_T have_sigwinch;
797 SIG_ATOMIC_T cleanup_nested;
802 char *comp_sourcename;
805 bool have_tic_directory;
806 bool keep_tic_directory;
807 const char *tic_directory;
813 char **keyname_table;
818 size_t safeprint_used;
820 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
822 long tgetent_sequence;
824 char *dbd_blob; /* string-heap for dbd_list[] */
825 char **dbd_list; /* distinct places to look for data */
826 int dbd_size; /* length of dbd_list[] */
827 time_t dbd_time; /* cache last updated */
828 ITERATOR_VARS dbd_vars[dbdLAST];
830 #ifndef USE_SP_WINDOWLIST
831 WINDOWLIST *_nc_windowlist;
832 #define WindowList(sp) _nc_globals._nc_windowlist
835 #if USE_HOME_TERMINFO
839 #if !USE_SAFE_SPRINTF
844 #ifdef USE_TERM_DRIVER
845 int (*term_driver)(struct DriverTCB*, const char*, int*);
850 char trace_fname[PATH_MAX];
855 size_t tracearg_used;
857 TRACEBUF *tracebuf_ptr;
858 size_t tracebuf_used;
860 char tracechr_buf[40];
863 size_t tracedmp_used;
865 unsigned char *tracetry_buf;
866 size_t tracetry_used;
868 char traceatr_color_buf[2][80];
869 int traceatr_color_sel;
870 int traceatr_color_last;
871 #if !defined(USE_PTHREADS) && USE_REENTRANT
877 pthread_mutex_t mutex_curses;
878 pthread_mutex_t mutex_tst_tracef;
879 pthread_mutex_t mutex_tracef;
882 #define _nc_use_pthreads _nc_globals.use_pthreads
884 #if USE_PTHREADS_EINTR
885 pthread_t read_thread; /* The reading thread */
889 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
894 * Global data which can be swept up into a SCREEN when one is created.
895 * It may be modified before the next SCREEN is created.
900 attr_t previous_attr;
901 #ifndef USE_SP_RIPOFF
902 ripoff_t rippedoff[N_RIPS];
905 TPARM_STATE tparm_state;
906 TTY *saved_tty; /* savetty/resetty information */
907 #if NCURSES_NO_PADDING
908 bool _no_padding; /* flag to set if padding disabled */
910 NCURSES_SP_OUTC _outch; /* output handler if not putc */
911 #if BROKEN_LINKER || USE_REENTRANT
912 chtype *real_acs_map;
920 const char *_tputs_trace;
926 * Use screen-specific ripoff data (for softkeys) rather than global.
929 #define safe_ripoff_sp (sp)->rsp
930 #define safe_ripoff_stack (sp)->rippedoff
932 #define safe_ripoff_sp _nc_prescreen.rsp
933 #define safe_ripoff_stack _nc_prescreen.rippedoff
936 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
939 * The SCREEN structure.
943 int _ifd; /* input file ptr for screen */
944 FILE *_ofp; /* output file ptr for screen */
945 char *_setbuf; /* buffered I/O for output */
946 bool _filtered; /* filter() was called */
947 bool _buffered; /* setvbuf uses _setbuf data */
948 bool _prescreen; /* is in prescreen phase */
949 bool _use_env; /* LINES & COLS from environment? */
950 int _checkfd; /* filedesc for typeahead check */
951 TERMINAL *_term; /* terminal type information */
952 TTY _saved_tty; /* savetty/resetty information */
953 NCURSES_SIZE_T _lines; /* screen lines */
954 NCURSES_SIZE_T _columns; /* screen columns */
956 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
957 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
959 WINDOW *_curscr; /* current screen */
960 WINDOW *_newscr; /* virtual screen to be updated to */
961 WINDOW *_stdscr; /* screen's full-window context */
963 #define CurScreen(sp) (sp)->_curscr
964 #define NewScreen(sp) (sp)->_newscr
965 #define StdScreen(sp) (sp)->_stdscr
967 TRIES *_keytry; /* "Try" for use with keypad mode */
968 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
969 bool _tried; /* keypad mode was initialized */
970 bool _keypad_on; /* keypad mode is currently on */
972 bool _called_wgetch; /* check for recursion in wgetch() */
973 int _fifo[FIFO_SIZE]; /* input push-back buffer */
974 short _fifohead, /* head of fifo queue */
975 _fifotail, /* tail of fifo queue */
976 _fifopeek, /* where to peek for next char */
977 _fifohold; /* set if breakout marked */
979 int _endwin; /* are we out of window mode? */
980 NCURSES_CH_T *_current_attr; /* holds current attributes set */
981 int _coloron; /* is color enabled? */
982 int _color_defs; /* are colors modified */
983 int _cursor; /* visibility of the cursor */
984 int _cursrow; /* physical cursor row */
985 int _curscol; /* physical cursor column */
986 bool _notty; /* true if we cannot switch non-tty */
987 int _nl; /* True if NL -> CR/NL is on */
988 int _raw; /* True if in raw mode */
989 int _cbreak; /* 1 if in cbreak mode */
990 /* > 1 if in halfdelay mode */
991 int _echo; /* True if echo on */
992 int _use_meta; /* use the meta key? */
993 struct _SLK *_slk; /* ptr to soft key struct / NULL */
994 int slk_format; /* selected format for this screen */
995 /* cursor movement costs; units are 10ths of milliseconds */
996 #if NCURSES_NO_PADDING
997 bool _no_padding; /* flag to set if padding disabled */
999 int _char_padding; /* cost of character put */
1000 int _cr_cost; /* cost of (carriage_return) */
1001 int _cup_cost; /* cost of (cursor_address) */
1002 int _home_cost; /* cost of (cursor_home) */
1003 int _ll_cost; /* cost of (cursor_to_ll) */
1005 int _ht_cost; /* cost of (tab) */
1006 int _cbt_cost; /* cost of (backtab) */
1007 #endif /* USE_HARD_TABS */
1008 int _cub1_cost; /* cost of (cursor_left) */
1009 int _cuf1_cost; /* cost of (cursor_right) */
1010 int _cud1_cost; /* cost of (cursor_down) */
1011 int _cuu1_cost; /* cost of (cursor_up) */
1012 int _cub_cost; /* cost of (parm_cursor_left) */
1013 int _cuf_cost; /* cost of (parm_cursor_right) */
1014 int _cud_cost; /* cost of (parm_cursor_down) */
1015 int _cuu_cost; /* cost of (parm_cursor_up) */
1016 int _hpa_cost; /* cost of (column_address) */
1017 int _vpa_cost; /* cost of (row_address) */
1018 /* used in tty_update.c, must be chars */
1019 int _ed_cost; /* cost of (clr_eos) */
1020 int _el_cost; /* cost of (clr_eol) */
1021 int _el1_cost; /* cost of (clr_bol) */
1022 int _dch1_cost; /* cost of (delete_character) */
1023 int _ich1_cost; /* cost of (insert_character) */
1024 int _dch_cost; /* cost of (parm_dch) */
1025 int _ich_cost; /* cost of (parm_ich) */
1026 int _ech_cost; /* cost of (erase_chars) */
1027 int _rep_cost; /* cost of (repeat_char) */
1028 int _hpa_ch_cost; /* cost of (column_address) */
1029 int _cup_ch_cost; /* cost of (cursor_address) */
1030 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1031 int _inline_cost; /* cost of inline-move */
1032 int _smir_cost; /* cost of (enter_insert_mode) */
1033 int _rmir_cost; /* cost of (exit_insert_mode) */
1034 int _ip_cost; /* cost of (insert_padding) */
1035 /* used in lib_mvcur.c */
1036 char * _address_cursor;
1037 /* used in tty_update.c */
1038 int _scrolling; /* 1 if terminal's smart enough to */
1040 /* used in lib_color.c */
1041 color_t *_color_table; /* screen's color palette */
1042 int _color_count; /* count of colors in palette */
1043 colorpair_t *_color_pairs; /* screen's color pair list */
1044 int _pair_count; /* count of color pairs */
1045 int _pair_limit; /* actual limit of color-pairs */
1046 #if NCURSES_EXT_FUNCS
1047 bool _assumed_color; /* use assumed colors */
1048 bool _default_color; /* use default colors */
1049 bool _has_sgr_39_49; /* has ECMA default color support */
1050 int _default_fg; /* assumed default foreground */
1051 int _default_bg; /* assumed default background */
1052 int _default_pairs; /* count pairs using default color */
1054 chtype _ok_attributes; /* valid attributes for terminal */
1055 chtype _xmc_suppress; /* attributes to suppress if xmc */
1056 chtype _xmc_triggers; /* attributes to process if xmc */
1057 chtype * _acs_map; /* the real alternate-charset map */
1058 bool * _screen_acs_map;
1061 /* used in lib_vidattr.c */
1062 bool _use_rmso; /* true if we may use 'rmso' */
1063 bool _use_rmul; /* true if we may use 'rmul' */
1066 * These data correspond to the state of the idcok() and idlok()
1067 * functions. A caveat is in order here: the XSI and SVr4
1068 * documentation specify that these functions apply to the window which
1069 * is given as an argument. However, ncurses implements this logic
1070 * only for the newscr/curscr update process, _not_ per-window.
1076 * These are the data that support the mouse interface.
1078 bool _mouse_initialized;
1079 MouseType _mouse_type;
1081 bool (*_mouse_event) (SCREEN *);
1082 bool (*_mouse_inline)(SCREEN *);
1083 bool (*_mouse_parse) (SCREEN *, int);
1084 void (*_mouse_resume)(SCREEN *);
1085 void (*_mouse_wrap) (SCREEN *);
1086 int _mouse_fd; /* file-descriptor, if any */
1087 bool _mouse_active; /* true if initialized */
1088 mmask_t _mouse_mask;
1089 mmask_t _mouse_bstate;
1090 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1091 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1092 MEVENT *_mouse_eventp; /* next free slot in event queue */
1095 bool _mouse_gpm_loaded;
1096 bool _mouse_gpm_found;
1099 TYPE_gpm_fd _mouse_gpm_fd;
1100 TYPE_Gpm_Open _mouse_Gpm_Open;
1101 TYPE_Gpm_Close _mouse_Gpm_Close;
1102 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1104 Gpm_Connect _mouse_gpm_connect;
1105 #endif /* USE_GPM_SUPPORT */
1109 int _emxmouse_thread;
1110 int _emxmouse_activated;
1111 char _emxmouse_buttons[4];
1115 MEVENT _sysmouse_fifo[FIFO_SIZE];
1118 int _sysmouse_char_width; /* character width */
1119 int _sysmouse_char_height; /* character height */
1120 int _sysmouse_old_buttons;
1121 int _sysmouse_new_buttons;
1124 #ifdef USE_TERM_DRIVER
1125 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1126 int _drv_mouse_head;
1127 int _drv_mouse_tail;
1128 int _drv_mouse_old_buttons;
1129 int _drv_mouse_new_buttons;
1132 * This supports automatic resizing
1135 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1139 * These are data that support the proper handling of the panel stack on an
1142 struct panelhook _panelHook;
1145 SCREEN *_next_screen;
1147 /* hashes for old and new lines */
1148 unsigned long *oldhash, *newhash;
1154 bool _cleanup; /* cleanup after int/quit signal */
1155 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1157 int _legacy_coding; /* see use_legacy_coding() */
1160 char _ttytype[NAMESIZE];
1167 const char *_tputs_trace;
1172 char tracechr_buf[40];
1173 char tracemse_buf[TRACEMSE_MAX];
1175 #ifdef USE_SP_WINDOWLIST
1176 WINDOWLIST* _windowlist;
1177 #define WindowList(sp) (sp)->_windowlist
1181 ripoff_t rippedoff[N_RIPS];
1185 * ncurses/ncursesw are the same up to this point.
1187 #if USE_WIDEC_SUPPORT
1188 /* recent versions of 'screen' have partially-working support for
1189 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1191 bool _screen_acs_fix;
1195 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1196 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1200 SCREEN *screen; /* screen containing the window */
1201 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1202 #ifdef NCURSES_WIDECHAR
1203 char addch_work[(MB_LEN_MAX * 9) + 1];
1204 unsigned addch_used; /* number of bytes in addch_work[] */
1205 int addch_x; /* x-position for addch_work[] */
1206 int addch_y; /* y-position for addch_work[] */
1210 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1212 #define SP_PRE_INIT(sp) \
1213 sp->_cursrow = -1; \
1214 sp->_curscol = -1; \
1219 sp->_fifohead = -1; \
1220 sp->_endwin = TRUE; \
1222 WindowList(sp) = 0; \
1223 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1226 /* usually in <limits.h> */
1228 #define UCHAR_MAX 255
1231 /* The terminfo source is assumed to be 7-bit ASCII */
1232 #define is7bits(c) ((unsigned)(c) < 128)
1234 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1235 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1238 #define min(a,b) ((a) > (b) ? (b) : (a))
1242 #define max(a,b) ((a) < (b) ? (b) : (a))
1245 /* usually in <unistd.h> */
1246 #ifndef STDIN_FILENO
1247 #define STDIN_FILENO 0
1250 #ifndef STDOUT_FILENO
1251 #define STDOUT_FILENO 1
1254 #ifndef STDERR_FILENO
1255 #define STDERR_FILENO 2
1258 #ifndef EXIT_SUCCESS
1259 #define EXIT_SUCCESS 0
1262 #ifndef EXIT_FAILURE
1263 #define EXIT_FAILURE 1
1267 #define R_OK 4 /* Test for read permission. */
1270 #define W_OK 2 /* Test for write permission. */
1273 #define X_OK 1 /* Test for execute permission. */
1276 #define F_OK 0 /* Test for existence. */
1280 #include <fcntl.h> /* may define O_BINARY */
1289 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1291 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1294 #define COUNT_OUTCHARS(n) /* nothing */
1297 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1299 #define UChar(c) ((unsigned char)(c))
1300 #define UShort(c) ((unsigned short)(c))
1301 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1302 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1305 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1308 #if USE_WIDEC_SUPPORT /* { */
1309 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1311 #define init_mb(state) memset(&state, 0, sizeof(state))
1313 #if NCURSES_EXT_COLORS
1314 #define NulColor , 0
1316 #define NulColor /* nothing */
1319 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1320 #define CharOf(c) ((c).chars[0])
1321 #define AttrOf(c) ((c).attr)
1323 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1324 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1325 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1327 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1328 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1331 #define CharEq(a,b) (((a).attr == (b).attr) \
1332 && (a).chars[0] == (b).chars[0] \
1333 && (a).chars[1] == (b).chars[1] \
1334 && (a).chars[2] == (b).chars[2] \
1335 && (a).chars[3] == (b).chars[3] \
1336 && (a).chars[4] == (b).chars[4] \
1337 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1339 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1342 #define SetChar(ch,c,a) do { \
1343 NCURSES_CH_T *_cp = &ch; \
1344 memset(_cp, 0, sizeof(ch)); \
1345 _cp->chars[0] = (wchar_t) (c); \
1347 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1349 #define CHREF(wch) (&wch)
1350 #define CHDEREF(wch) (*wch)
1351 #define ARG_CH_T NCURSES_CH_T *
1352 #define CARG_CH_T const NCURSES_CH_T *
1353 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1354 mbstate_t PUT_st; wchar_t PUTC_ch
1355 #define PUTC_INIT init_mb (PUT_st)
1356 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1357 if (Charable(ch)) { \
1358 fputc(CharOf(ch), b); \
1359 COUNT_OUTCHARS(1); \
1362 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1363 PUTC_ch = (ch).chars[PUTC_i]; \
1364 if (PUTC_ch == L'\0') \
1366 PUTC_n = (int) wcrtomb(PUTC_buf, \
1367 (ch).chars[PUTC_i], &PUT_st); \
1368 if (PUTC_n <= 0) { \
1369 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1373 IGNORE_RC(fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b)); \
1375 COUNT_OUTCHARS(PUTC_i); \
1378 #define BLANK NewChar2(' ', WA_NORMAL)
1379 #define ZEROS NewChar2('\0', WA_NORMAL)
1380 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1383 * Wide characters cannot be represented in the A_CHARTEXT mask of
1384 * attr_t's but an application might have set a narrow character there.
1385 * But even in that case, it would only be a printable character, or
1386 * zero. Otherwise we can use those bits to tell if a cell is the
1387 * first or extension part of a wide character.
1389 #define WidecExt(ch) (int) (AttrOf(ch) & A_CHARTEXT)
1390 #define isWidecBase(ch) (WidecExt(ch) == 1)
1391 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1392 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1393 AttrOf(dst) |= (attr_t) (ext + 1)
1395 #define if_WIDEC(code) code
1396 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1397 || (AttrOf(ch) & A_ALTCHARSET) \
1398 || (!isWidecExt(ch) && \
1399 (ch).chars[1] == L'\0' && \
1400 _nc_is_charable(CharOf(ch))))
1402 #define L(ch) L ## ch
1404 #define CharOf(c) ChCharOf(c)
1405 #define AttrOf(c) ChAttrOf(c)
1406 #define AddAttr(c,a) c |= (a)
1407 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1408 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1409 #define NewChar(ch) (ch)
1410 #define NewChar2(c,a) ((c) | (a))
1411 #define CharEq(a,b) ((a) == (b))
1412 #define SetChar(ch,c,a) ch = (c) | (a)
1413 #define CHREF(wch) wch
1414 #define CHDEREF(wch) wch
1415 #define ARG_CH_T NCURSES_CH_T
1416 #define CARG_CH_T NCURSES_CH_T
1417 #define PUTC_DATA int data = 0
1418 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1420 #define BLANK (' '|A_NORMAL)
1421 #define ZEROS ('\0'|A_NORMAL)
1422 #define ISBLANK(ch) (CharOf(ch) == ' ')
1424 #define isWidecExt(ch) (0)
1425 #define if_WIDEC(code) /* nothing */
1430 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1431 #define CharOfD(ch) CharOf(CHDEREF(ch))
1432 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1434 #define BLANK_ATTR A_NORMAL
1435 #define BLANK_TEXT L(' ')
1439 #define LEGALYX(w, y, x) \
1441 ((x) >= 0 && (x) <= (w)->_maxx && \
1442 (y) >= 0 && (y) <= (w)->_maxy))
1444 #define CHANGED_CELL(line,col) \
1445 if (line->firstchar == _NOCHANGE) \
1446 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1447 else if ((col) < line->firstchar) \
1448 line->firstchar = (NCURSES_SIZE_T) (col); \
1449 else if ((col) > line->lastchar) \
1450 line->lastchar = (NCURSES_SIZE_T) (col)
1452 #define CHANGED_RANGE(line,start,end) \
1453 if (line->firstchar == _NOCHANGE \
1454 || line->firstchar > (start)) \
1455 line->firstchar = (NCURSES_SIZE_T) (start); \
1456 if (line->lastchar == _NOCHANGE \
1457 || line->lastchar < (end)) \
1458 line->lastchar = (NCURSES_SIZE_T) (end)
1460 #define CHANGED_TO_EOL(line,start,end) \
1461 if (line->firstchar == _NOCHANGE \
1462 || line->firstchar > (start)) \
1463 line->firstchar = (NCURSES_SIZE_T) (start); \
1464 line->lastchar = (NCURSES_SIZE_T) (end)
1466 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1468 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1470 /* FreeAndNull() is not a comma-separated expression because some compilers
1471 * do not accept a mixture of void with values.
1473 #define FreeAndNull(p) free(p); p = 0
1475 #include <nc_alloc.h>
1478 * TTY bit definition for converting tabs to spaces.
1481 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1484 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1487 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1489 # define OFLAGS_TABS 0
1495 * Standardize/simplify common loops
1497 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1498 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1499 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1502 * Prefixes for call/return points of library function traces. We use these to
1503 * instrument the public functions so that the traces can be easily transformed
1504 * into regression scripts.
1506 #define T_CALLED(fmt) "called {" fmt
1507 #define T_CREATE(fmt) "create :" fmt
1508 #define T_RETURN(fmt) "return }" fmt
1513 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1515 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1518 #define START_TRACE() \
1519 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1520 int t = _nc_getenv_num("NCURSES_TRACE"); \
1522 trace((unsigned) t); \
1526 * Many of the _tracef() calls use static buffers; lock the trace state before
1527 * trying to fill them.
1530 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1531 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1532 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1534 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1535 #define _nc_locked_tracef _tracef
1538 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1539 #define T(a) TR(TRACE_CALLS, a)
1540 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1541 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1542 #define TRACE_RETURN_SP(value,type) return _nc_retrace_##type(SP_PARM, value)
1544 #define NonNull(s) ((s) != 0 ? s : "<null>")
1546 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1547 #define returnBits(code) TRACE_RETURN(code,unsigned)
1548 #define returnBool(code) TRACE_RETURN(code,bool)
1549 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1550 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1551 #define returnChar(code) TRACE_RETURN(code,char)
1552 #define returnChtype(code) TRACE_RETURN(code,chtype)
1553 #define returnCode(code) TRACE_RETURN(code,int)
1554 #define returnIntAttr(code) TRACE_RETURN2(code,int,attr_t)
1555 #define returnMMask(code) TRACE_RETURN_SP(code,mmask_t)
1556 #define returnPtr(code) TRACE_RETURN(code,ptr)
1557 #define returnSP(code) TRACE_RETURN(code,sp)
1558 #define returnVoid T((T_RETURN(""))); return
1559 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1560 #define returnWin(code) TRACE_RETURN(code,win)
1562 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
1563 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1564 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1565 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1566 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1567 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1568 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1569 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1570 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1571 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1572 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1573 extern NCURSES_EXPORT(char) _nc_retrace_char (char);
1574 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1575 extern NCURSES_EXPORT(int) _nc_retrace_int_attr_t (attr_t);
1576 extern NCURSES_EXPORT(mmask_t) _nc_retrace_mmask_t (SCREEN *, mmask_t);
1577 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1578 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1579 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1582 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1583 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1584 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1585 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1586 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1587 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1589 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1590 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1593 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1595 #if USE_WIDEC_SUPPORT
1596 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1597 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1600 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1601 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1605 #define START_TRACE() /* nothing */
1609 #define TPUTS_TRACE(s)
1611 #define returnAttr(code) return code
1612 #define returnBits(code) return code
1613 #define returnBool(code) return code
1614 #define returnCPtr(code) return code
1615 #define returnCVoidPtr(code) return code
1616 #define returnChar(code) return ((char) code)
1617 #define returnChtype(code) return code
1618 #define returnCode(code) return code
1619 #define returnIntAttr(code) return code
1620 #define returnMMask(code) return code
1621 #define returnPtr(code) return code
1622 #define returnSP(code) return code
1623 #define returnVoid return
1624 #define returnVoidPtr(code) return code
1625 #define returnWin(code) return code
1627 #endif /* TRACE/!TRACE */
1630 * Workaround for defective implementation of gcc attribute warn_unused_result
1632 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1633 #define IGNORE_RC(func) errno = (int) func
1635 #define IGNORE_RC(func) (void) func
1636 #endif /* gcc workarounds */
1639 * Return-codes for tgetent() and friends.
1641 #define TGETENT_YES 1 /* entry is found */
1642 #define TGETENT_NO 0 /* entry is not found */
1643 #define TGETENT_ERR -1 /* an error occurred */
1645 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1646 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1648 #define EMPTY_MODULE(name) \
1649 extern NCURSES_EXPORT(void) name (void); \
1650 NCURSES_EXPORT(void) name (void) { }
1652 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1653 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1654 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1656 #define toggle_attr_on(S,at) {\
1657 if (PairNumber(at) > 0) {\
1658 (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1660 (S) |= (attr_t) (at);\
1662 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1665 #define toggle_attr_off(S,at) {\
1666 if (PairNumber(at) > 0) {\
1667 (S) &= ~(at|A_COLOR);\
1671 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1673 #define DelCharCost(sp,count) \
1676 : ((delete_character != 0) \
1677 ? (sp->_dch1_cost * count) \
1680 #define InsCharCost(sp,count) \
1683 : ((enter_insert_mode && exit_insert_mode) \
1684 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1685 : ((insert_character != 0) \
1686 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1690 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1691 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1692 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1693 if (magic_cookie_glitch > 0 \
1694 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1695 T(("%s @%d before glitch %d,%d", \
1696 __FILE__, __LINE__, \
1699 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1703 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1704 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1709 * Macros to make additional parameter to implement wgetch_events()
1711 #ifdef NCURSES_WGETCH_EVENTS
1712 #define EVENTLIST_0th(param) param
1713 #define EVENTLIST_1st(param) param
1714 #define EVENTLIST_2nd(param) , param
1715 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1717 #define EVENTLIST_0th(param) void
1718 #define EVENTLIST_1st(param) /* nothing */
1719 #define EVENTLIST_2nd(param) /* nothing */
1720 #define TWAIT_MASK TW_ANY
1723 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1725 #undef toggle_attr_on
1726 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1727 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1729 #undef toggle_attr_off
1730 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1731 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1734 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1737 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1739 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1740 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1743 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1745 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1746 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1748 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1751 #if NCURSES_SP_FUNCS
1752 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1753 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1754 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1755 #endif /* NCURSES_SP_FUNCS */
1759 extern NCURSES_EXPORT(void) _nc_expanded (void);
1763 #if !NCURSES_EXT_FUNCS
1764 #define set_escdelay(value) ESCDELAY = value
1768 #define getcwd(buf,len) getwd(buf)
1772 #if USE_WIDEC_SUPPORT
1773 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1774 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1775 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1780 short nte_name; /* offset of name to hash on */
1781 int nte_type; /* BOOLEAN, NUMBER or STRING */
1782 short nte_index; /* index of associated variable in its array */
1783 short nte_link; /* index in table of next hash, or -1 */
1795 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1799 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1800 extern NCURSES_EXPORT(void) _nc_linedump (void);
1804 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1805 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1808 #if USE_WIDEC_SUPPORT
1809 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1813 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1814 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1818 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1821 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1824 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1827 #define INFINITY 1000000 /* cost: too high to use */
1829 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1830 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1831 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1833 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1835 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1836 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1837 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1840 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1843 #define INFINITY 1000000 /* cost: too high to use */
1844 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1847 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1848 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1849 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1850 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1851 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, char);
1853 /* lib_set_term.c */
1854 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1857 #define ret_error(code, fmt, arg) if (errret) {\
1861 fprintf(stderr, fmt, arg);\
1862 exit(EXIT_FAILURE);\
1865 #define ret_error1(code, fmt, arg) ret_error(code, "'%s': " fmt, arg)
1867 #define ret_error0(code, msg) if (errret) {\
1871 fprintf(stderr, msg);\
1872 exit(EXIT_FAILURE);\
1877 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1879 #define _nc_handle_sigwinch(a) /* nothing */
1883 #if USE_WIDEC_SUPPORT
1884 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1888 char *s_head; /* beginning of the string (may be null) */
1889 char *s_tail; /* end of the string (may be null) */
1890 size_t s_size; /* current remaining size available */
1891 size_t s_init; /* total size available */
1895 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1896 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1897 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1898 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1899 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1902 #define strstr _nc_strstr
1903 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1906 /* safe_sprintf.c */
1907 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1910 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1911 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1912 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1913 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1916 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1917 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1918 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1919 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1920 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1921 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1922 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1923 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1924 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1925 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1926 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1927 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1928 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1929 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1930 extern NCURSES_EXPORT(int) _nc_outch (int);
1931 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1932 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1933 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1934 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1935 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
1936 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1937 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, NCURSES_OUTC);
1938 extern NCURSES_EXPORT(void) _nc_flush (void);
1939 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1940 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1941 extern NCURSES_EXPORT(void) _nc_freeall (void);
1942 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1943 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1944 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1945 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1946 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1947 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1948 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1949 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1950 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1951 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1954 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1955 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1956 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1957 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1958 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1959 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
1960 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1961 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1962 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1965 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1966 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1967 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1968 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1971 #if USE_WIDEC_SUPPORT
1972 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1975 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1976 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1980 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1984 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1986 #define _nc_resize_margins(wp) /* nothing */
1989 #ifdef NCURSES_WGETCH_EVENTS
1990 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1992 #define wgetch_events(win, evl) wgetch(win)
1993 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1997 * Wide-character macros to hide some platform-differences.
1999 #if USE_WIDEC_SUPPORT
2000 #if HAVE_MBTOWC && HAVE_MBLEN
2001 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
2002 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2003 #define check_mbytes(wch,buffer,length,state) \
2004 (int) mbtowc(&wch, buffer, length)
2005 #define state_unused
2006 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2007 #define reset_mbytes(state) init_mb(state)
2008 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
2009 #define check_mbytes(wch,buffer,length,state) \
2010 (int) mbrtowc(&wch, buffer, length, &state)
2017 * Not everyone has vsscanf(), but we'd like to use it for scanw().
2020 extern int vsscanf(const char *str, const char *format, va_list __arg);
2023 /* scroll indices */
2024 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2026 #define USE_SETBUF_0 0
2028 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
2030 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
2033 * On systems with a broken linker, define 'SP' as a function to force the
2034 * linker to pull in the data-only module with 'SP'.
2036 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2039 #define SP _nc_screen()
2040 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2041 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
2042 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
2043 #define CURRENT_SCREEN _nc_screen()
2045 /* current screen is private data; avoid possible linking conflicts too */
2046 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2047 #define CURRENT_SCREEN SP
2048 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
2049 #define _nc_set_screen(sp) SP = sp
2052 #if NCURSES_SP_FUNCS
2053 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2055 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
2059 * We don't want to use the lines or columns capabilities internally, because
2060 * if the application is running multiple screens under X, it's quite possible
2061 * they could all have type xterm but have different sizes! So...
2063 #define screen_lines(sp) (sp)->_lines
2064 #define screen_columns(sp) (sp)->_columns
2066 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2067 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2070 * Some constants related to SLK's
2072 #define MAX_SKEY_OLD 8 /* count of soft keys */
2073 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2074 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2075 #define MAX_SKEY_LEN_PC 5
2077 /* Macro to check whether or not we use a standard format */
2078 #define SLK_STDFMT(fmt) (fmt < 3)
2079 /* Macro to determine height of label window */
2080 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2082 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2083 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2086 * Common error messages
2088 #define MSG_NO_MEMORY "Out of memory"
2089 #define MSG_NO_INPUTS "Premature EOF"
2091 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2092 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2094 /* timed_wait flag definitions */
2098 #define TW_ANY (TW_INPUT | TW_MOUSE)
2101 #define SetSafeOutcWrapper(outc) \
2102 SCREEN* sp = CURRENT_SCREEN; \
2104 struct screen dummy; \
2106 memset(sp,0,sizeof(struct screen)); \
2107 sp->_outch = _nc_outc_wrapper; \
2111 #ifdef USE_TERM_DRIVER
2112 typedef void* TERM_HANDLE;
2114 typedef struct _termInfo
2133 const color_t* defaultPalette;
2136 typedef struct term_driver {
2138 bool (*CanHandle)(struct DriverTCB*,const char*,int*);
2139 void (*init)(struct DriverTCB*);
2140 void (*release)(struct DriverTCB*);
2141 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2142 int (*sgmode)(struct DriverTCB*, bool setFlag, TTY*);
2143 chtype (*conattr)(struct DriverTCB*);
2144 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2145 int (*mode)(struct DriverTCB*, bool progFlag, bool defFlag);
2146 bool (*rescol)(struct DriverTCB*);
2147 bool (*rescolors)(struct DriverTCB*);
2148 void (*color)(struct DriverTCB*,bool fore, int color, int(*)(SCREEN*,int));
2149 int (*doBeepOrFlash)(struct DriverTCB*, bool);
2150 void (*initpair)(struct DriverTCB*,short,short,short);
2151 void (*initcolor)(struct DriverTCB*,short,short,short,short);
2152 void (*docolor)(struct DriverTCB*,short,short,bool,int(*)(SCREEN*,int));
2153 void (*initmouse)(struct DriverTCB*);
2154 int (*testmouse)(struct DriverTCB*,int);
2155 void (*setfilter)(struct DriverTCB*);
2156 void (*hwlabel)(struct DriverTCB*,int,char*);
2157 void (*hwlabelOnOff)(struct DriverTCB*,bool);
2158 int (*update)(struct DriverTCB*);
2159 int (*defaultcolors)(struct DriverTCB*,int,int);
2160 int (*print)(struct DriverTCB*,char*,int);
2161 int (*getsize)(struct DriverTCB*,int*,int*);
2162 int (*setsize)(struct DriverTCB*,int,int);
2163 void (*initacs)(struct DriverTCB*,chtype*,chtype*);
2164 void (*scinit)(SCREEN *);
2165 void (*scexit)(SCREEN *);
2166 int (*twait)(struct DriverTCB*,int,int,int* EVENTLIST_2nd(_nc_eventlist*));
2167 int (*read)(struct DriverTCB*,int*);
2168 int (*nap)(struct DriverTCB*,int);
2169 int (*kpad)(struct DriverTCB*, bool);
2170 int (*kyOk)(struct DriverTCB*, int, bool);
2171 bool (*kyExist)(struct DriverTCB*, int);
2174 typedef struct DriverTCB
2176 TERMINAL term; /* needs to be the first Element !!! */
2177 TERM_HANDLE inp; /* The input handle of the Terminal */
2178 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2179 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2180 TERM_DRIVER* drv; /* The driver for that Terminal */
2181 SCREEN* csp; /* The screen that owns that Terminal */
2182 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2183 void* prop; /* Driver dependent property storage to be used by the Driver */
2185 } TERMINAL_CONTROL_BLOCK;
2187 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2188 #define NCDRV_TINFO 0x01
2189 #define NCDRV_WINCONSOLE 0x02
2191 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2192 #define InfoOf(sp) TCBOf(sp)->info
2193 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2194 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2195 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2196 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2197 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2199 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2200 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2202 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2203 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2204 #endif /* USE_TERM_DRIVER */
2207 * Entrypoints which are actually provided in the terminal driver, which would
2208 * be an sp-name otherwise.
2210 #ifdef USE_TERM_DRIVER
2211 #define TINFO_HAS_KEY _nc_tinfo_has_key
2212 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2213 #define TINFO_MVCUR _nc_tinfo_mvcur
2214 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2215 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2216 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2218 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2219 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2220 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2224 * Entrypoints using an extra parameter with the terminal driver.
2226 #ifdef USE_TERM_DRIVER
2227 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2228 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, bool);
2229 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2230 _nc_get_screensize(sp, tp, lp, cp)
2231 #define TINFO_SET_CURTERM(sp, tp) \
2232 NCURSES_SP_NAME(set_curterm)(sp, tp)
2233 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2234 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2235 #else /* !USE_TERM_DRIVER */
2236 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2237 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2238 _nc_get_screensize(sp, lp, cp)
2239 #define TINFO_SET_CURTERM(sp, tp) \
2241 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2242 _nc_setupterm(name, fd, err, reuse)
2243 #endif /* !USE_TERM_DRIVER */
2245 #ifdef USE_TERM_DRIVER
2247 #include <nc_mingw.h>
2248 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2250 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2253 #ifdef USE_TERM_DRIVER
2254 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2256 #define IsTermInfo(sp) TRUE
2259 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2260 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2263 * Exported entrypoints beyond the published API
2265 #if NCURSES_SP_FUNCS
2266 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2267 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2268 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2269 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2272 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2273 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2276 #if NCURSES_EXT_FUNCS
2277 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2281 * We put the safe versions of various calls here as they are not published
2282 * part of the API up to now
2284 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2285 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2286 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2287 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2288 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2289 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2290 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2291 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2292 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2293 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2294 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2295 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2296 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2297 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2298 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2299 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2300 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2301 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2302 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2303 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2304 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, bool, int);
2305 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2306 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2307 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2308 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2309 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, short, short, bool, NCURSES_SP_OUTC);
2310 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2311 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2312 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2313 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2314 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2315 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2316 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2317 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2318 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2319 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2320 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2321 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2322 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2323 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2324 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2325 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, bool);
2327 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2329 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2330 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2333 #if USE_WIDEC_SUPPORT
2334 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2337 #endif /* NCURSES_SP_FUNCS */
2339 #if NCURSES_SP_FUNCS
2341 #define safe_keyname NCURSES_SP_NAME(keyname)
2342 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2343 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2347 #define safe_keyname _nc_keyname
2348 #define safe_unctrl _nc_unctrl
2349 #define safe_ungetch _nc_ungetch
2351 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2352 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2353 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2363 #endif /* CURSES_PRIV_H */