1 /****************************************************************************
2 * Copyright (c) 1998-2013,2014 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.530 2014/02/01 22:09:27 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>
96 # if defined(_POSIX_PATH_MAX)
97 # define PATH_MAX _POSIX_PATH_MAX
98 # elif defined(MAXPATHLEN)
99 # define PATH_MAX MAXPATHLEN
101 # define PATH_MAX 255 /* the Posix minimum path-size */
109 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
110 #if HAVE_WORKING_POLL
111 #define USE_FUNC_POLL 1
115 #include <sys/poll.h>
118 #define USE_FUNC_POLL 0
122 # include <inttypes.h>
129 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
132 /* Alessandro Rubini's GPM (general-purpose mouse) */
133 #if HAVE_LIBGPM && HAVE_GPM_H
134 #define USE_GPM_SUPPORT 1
136 #define USE_GPM_SUPPORT 0
139 /* QNX mouse support */
140 #if defined(__QNX__) && !defined(__QNXNTO__)
141 #define USE_QNX_MOUSE 1
143 #define USE_QNX_MOUSE 0
146 /* EMX mouse support */
148 #define USE_EMX_MOUSE 1
150 #define USE_EMX_MOUSE 0
153 /* kLIBC keyboard/mouse support */
154 #if defined(__OS2__) && defined(__KLIBC__)
155 #define USE_KLIBC_KBD 1
156 #define USE_KLIBC_MOUSE 1
158 #define USE_KLIBC_KBD 0
159 #define USE_KLIBC_MOUSE 0
162 #define DEFAULT_MAXCLICK 166
163 #define EV_MAX 8 /* size of mouse circular event queue */
166 * If we don't have signals to support it, don't add a sigwinch handler.
167 * In any case, resizing is an extended feature. Use it if we've got it.
169 #if !NCURSES_EXT_FUNCS
170 #undef HAVE_SIZECHANGE
171 #define HAVE_SIZECHANGE 0
174 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
175 #define USE_SIZECHANGE 1
177 #define USE_SIZECHANGE 0
179 #define USE_SIGWINCH 0
183 * If desired, one can configure this, disabling environment variables that
184 * point to custom terminfo/termcap locations.
186 #ifdef USE_ROOT_ENVIRON
187 #define use_terminfo_vars() 1
189 #define use_terminfo_vars() _nc_env_access()
190 extern NCURSES_EXPORT(int) _nc_env_access (void);
194 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
198 #define memmove(d,s,n) bcopy(s,d,n)
200 #define memmove(d,s,n) _nc_memmove(d,s,n)
201 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
205 * If we have va_copy(), use it for assigning va_list's.
207 #if defined(HAVE___VA_COPY)
208 #define begin_va_copy(dst,src) __va_copy(dst, src)
209 #define end_va_copy(dst) va_end(dst)
210 #elif defined(va_copy) || defined(HAVE_VA_COPY)
211 #define begin_va_copy(dst,src) va_copy(dst, src)
212 #define end_va_copy(dst) va_end(dst)
214 #define begin_va_copy(dst,src) (dst) = (src)
215 #define end_va_copy(dst) /* nothing */
219 * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
220 * lack one or the other.
223 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
227 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
231 * Scroll hints are useless when hashmap is used
233 #if !USE_SCROLL_HINTS
235 #define USE_SCROLL_HINTS 1
237 #define USE_SCROLL_HINTS 0
242 #define if_USE_SCROLL_HINTS(stmt) stmt
244 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
247 #include <nc_string.h>
250 * Options for terminal drivers, etc...
252 #ifdef USE_TERM_DRIVER
253 #define USE_SP_RIPOFF 1
254 #define USE_SP_TERMTYPE 1
255 #define USE_SP_WINDOWLIST 1
259 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
260 * when we're throwing control codes at the screen at high volume. To see
261 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
262 * probably don't want to define this either due to uncertainties about tab
263 * delays and expansion in raw mode.
266 #define TRIES struct tries
268 TRIES *child; /* ptr to child. NULL if none */
269 TRIES *sibling; /* ptr to sibling. NULL if none */
270 unsigned char ch; /* character at this node */
271 unsigned short value; /* code of string so far. 0 if none. */
276 * Common/troublesome character definitions
278 #define StringOf(ch) {ch, 0}
285 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
288 * Structure for palette tables
291 #define MAXCOLUMNS 135
293 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
297 #define WINDOWLIST struct _win_list
299 #if USE_WIDEC_SUPPORT
300 #define _nc_bkgd _bkgrnd
302 #undef _XOPEN_SOURCE_EXTENDED
304 #define _nc_bkgd _bkgd
305 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
306 #define wbkgrnd wbkgd
309 #undef NCURSES_OPAQUE
310 #define NCURSES_INTERNALS 1
311 #define NCURSES_OPAQUE 0
313 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
317 NCURSES_COLOR_T red, green, blue; /* what color_content() returns */
318 NCURSES_COLOR_T r, g, b; /* params to init_color() */
319 int init; /* true if we called init_color() */
324 * If curses.h did not expose the SCREEN-functions, then we do not need the
325 * parameter in the corresponding unextended functions.
328 #define USE_SP_FUNC_SUPPORT NCURSES_SP_FUNCS
329 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
332 #define SP_PARM sp /* use parameter */
333 #define NCURSES_SP_ARG SP_PARM
334 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
335 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
336 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
337 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
339 #define SP_PARM SP /* use global variable */
340 #define NCURSES_SP_ARG
341 #define NCURSES_SP_DCL
342 #define NCURSES_SP_DCL0 void
343 #define NCURSES_SP_ARGx
344 #define NCURSES_SP_DCLx
347 #include <nc_panel.h>
349 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
350 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
351 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
354 #define CurTerm _nc_prescreen._cur_term
356 #define CurTerm cur_term
360 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
362 #define TerminalOf(sp) CurTerm
366 #include <nc_termios.h>
369 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
370 * pointer to this data.
372 #ifdef USE_SP_TERMTYPE
376 #define SP_TERMTYPE TerminalOf(sp)->type.
378 #include <term_entry.h>
380 #include <nc_tparm.h>
383 * Simplify ifdef's for the "*_ATTR" macros in case italics are not configured.
393 * Use these macros internally, to make tracing less verbose. But leave the
394 * option for compiling the tracing into the library.
397 #define ColorPair(n) NCURSES_BITS(n, 0)
398 #define PairNumber(a) (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
400 #define ColorPair(pair) COLOR_PAIR(pair)
401 #define PairNumber(attr) PAIR_NUMBER(attr)
404 #define unColor(n) unColor2(AttrOf(n))
405 #define unColor2(a) ((a) & ALL_BUT_COLOR)
408 * Extended-colors stores the color pair in a separate struct-member than the
409 * attributes. But for compatibility, we handle most cases where a program
410 * written for non-extended colors stores the color in the attributes by
411 * checking for a color pair in both places.
413 #if NCURSES_EXT_COLORS
414 #define if_EXT_COLORS(stmt) stmt
415 #define SetPair(value,p) SetPair2((value).ext_color, AttrOf(value), p)
416 #define SetPair2(c,a,p) c = (p), \
417 a = (unColor2(a) | (A_COLOR & (unsigned) ColorPair(oldColor(c))))
418 #define GetPair(value) GetPair2((value).ext_color, AttrOf(value))
419 #define GetPair2(c,a) ((c) ? (c) : PairNumber(a))
420 #define oldColor(p) (((p) > 255) ? 255 : (p))
421 #define GET_WINDOW_PAIR(w) GetPair2((w)->_color, (w)->_attrs)
422 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
423 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
425 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_puts)(NCURSES_SP_ARGx attr, (short) pair, 0, NCURSES_OUTC_FUNC)
427 #else /* !NCURSES_EXT_COLORS */
429 #define if_EXT_COLORS(stmt) /* nothing */
430 #define SetPair(value,p) RemAttr(value, A_COLOR), \
431 SetAttr(value, AttrOf(value) | (A_COLOR & (attr_t) ColorPair(p)))
432 #define GetPair(value) PairNumber(AttrOf(value))
433 #define GET_WINDOW_PAIR(w) PairNumber(WINDOW_ATTRS(w))
434 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
435 WINDOW_ATTRS(w) |= (A_COLOR & (attr_t) ColorPair(p))
436 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
438 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidputs)(NCURSES_SP_ARGx attr, NCURSES_OUTC_FUNC)
440 #endif /* NCURSES_EXT_COLORS */
442 #define NCURSES_OUTC_FUNC NCURSES_SP_NAME(_nc_outch)
443 #define NCURSES_PUTP2(name,value) NCURSES_SP_NAME(_nc_putp)(NCURSES_SP_ARGx name, value)
444 #define NCURSES_PUTP2_FLUSH(name,value) NCURSES_SP_NAME(_nc_putp_flush)(NCURSES_SP_ARGx name, value)
446 #if NCURSES_NO_PADDING
447 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
448 #define SetNoPadding(sp) _nc_set_no_padding(sp)
449 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
451 #define GetNoPadding(sp) FALSE
452 #define SetNoPadding(sp) /*nothing*/
455 #define WINDOW_ATTRS(w) ((w)->_attrs)
457 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
458 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
459 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
461 #if USE_REENTRANT || NCURSES_SP_FUNCS
462 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
463 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
464 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
465 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
470 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
471 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
472 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
473 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
475 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
476 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
477 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
478 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
482 #define ptrLines(sp) &LINES
483 #define ptrCols(sp) &COLS
484 #define ptrTabsize(sp) &TABSIZE
485 #define ptrEscdelay(sp) &ESCDELAY
487 #define SET_LINES(value) LINES = value
488 #define SET_COLS(value) COLS = value
489 #define SET_TABSIZE(value) TABSIZE = value
490 #define SET_ESCDELAY(value) ESCDELAY = value
494 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
495 __FILE__, __LINE__, \
496 (unsigned long) (pthread_self()), \
497 data.__data.__lock, \
498 data.__data.__count, \
499 data.__data.__owner, \
500 data.__data.__kind, \
501 (data.__data.__nusers > 5) ? " OOPS " : "", \
502 data.__data.__nusers)
503 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
506 #if defined(__GNUC__)
507 # if defined __USE_ISOC99
508 # define _cat_pragma(exp) _Pragma(#exp)
509 # define _weak_pragma(exp) _cat_pragma(weak name)
511 # define _weak_pragma(exp)
513 # define _declare(name) __extension__ extern __typeof__(name) name
514 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
516 # undef USE_WEAK_SYMBOLS
517 # define USE_WEAK_SYMBOLS 0
525 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
526 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
527 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
528 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
529 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
530 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
531 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
532 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
535 #error POSIX threads requires --enable-reentrant option
539 # if USE_WEAK_SYMBOLS
540 weak_symbol(pthread_sigmask);
541 weak_symbol(pthread_kill);
542 weak_symbol(pthread_self);
543 weak_symbol(pthread_equal);
544 weak_symbol(pthread_mutex_init);
545 weak_symbol(pthread_mutex_lock);
546 weak_symbol(pthread_mutex_unlock);
547 weak_symbol(pthread_mutex_trylock);
548 weak_symbol(pthread_mutexattr_settype);
549 weak_symbol(pthread_mutexattr_init);
550 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
552 # define sigprocmask _nc_sigprocmask
557 #undef HAVE_NANOSLEEP
558 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
561 #else /* !USE_PTHREADS */
563 #if USE_PTHREADS_EINTR
564 # if USE_WEAK_SYMBOLS
566 weak_symbol(pthread_sigmask);
567 weak_symbol(pthread_kill);
568 weak_symbol(pthread_self);
569 weak_symbol(pthread_equal);
570 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
572 # define sigprocmask _nc_sigprocmask
574 #endif /* USE_PTHREADS_EINTR */
576 #define _nc_init_pthreads() /* nothing */
577 #define _nc_mutex_init(obj) /* nothing */
579 #define _nc_lock_global(name) /* nothing */
580 #define _nc_try_global(name) 0
581 #define _nc_unlock_global(name) /* nothing */
583 #endif /* USE_PTHREADS */
586 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
587 * So the locking is done in the non-sp-func (which calls the sp-func) rather
588 * than in the sp-func itself.
590 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
591 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
595 #define _nc_nonsp_lock_global(name) /* nothing */
596 #define _nc_nonsp_try_global(name) 0
597 #define _nc_nonsp_unlock_global(name) /* nothing */
599 #define _nc_sp_lock_global(name) _nc_lock_global(name)
600 #define _nc_sp_try_global(name) _nc_try_global(name)
601 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
605 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
606 #define _nc_nonsp_try_global(name) _nc_try_global(name)
607 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
609 #define _nc_sp_lock_global(name) /* nothing */
610 #define _nc_sp_try_global(name) 0
611 #define _nc_sp_unlock_global(name) /* nothing */
615 #if HAVE_GETTIMEOFDAY
616 # define PRECISE_GETTIME 1
617 # define TimeType struct timeval
619 # define PRECISE_GETTIME 0
620 # define TimeType time_t
624 * Definitions for color pairs
626 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
627 #define C_SHIFT 9 /* we need more bits than there are colors */
628 #define C_MASK ((1 << C_SHIFT) - 1)
629 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
630 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
631 #define BACK_OF(c) ((c) & C_MASK)
632 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
634 #define COLOR_DEFAULT C_MASK
636 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
638 #undef NCURSES_CH_T /* this is not a termlib feature */
639 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
641 #endif /* USE_TERMLIB */
646 NCURSES_CH_T *text; /* text of the line */
647 NCURSES_SIZE_T firstchar; /* first changed character in the line */
648 NCURSES_SIZE_T lastchar; /* last changed character in the line */
649 NCURSES_SIZE_T oldindex; /* index of the line at last update */
651 #endif /* USE_TERMLIB */
654 M_XTERM = -1 /* use xterm's mouse tracking? */
655 ,M_NONE = 0 /* no mouse device */
660 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
662 #ifdef USE_TERM_DRIVER
663 ,M_TERM_DRIVER /* Win32 console, etc */
668 * Structures for scrolling.
672 unsigned long hashval;
673 int oldcount, newcount;
674 int oldindex, newindex;
678 * Structures for soft labels.
683 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
687 char *ent_text; /* text for the label */
688 char *form_text; /* formatted text (left/center/...) */
689 int ent_x; /* x coordinate of this field */
690 char dirty; /* this label has changed */
691 char visible; /* field is visible */
694 typedef struct _SLK {
695 bool dirty; /* all labels have changed */
696 bool hidden; /* soft labels are hidden */
699 short maxlab; /* number of available labels */
700 short labcnt; /* number of allocated labels */
701 short maxlen; /* length of labels */
702 NCURSES_CH_T attr; /* soft label attribute */
705 #endif /* USE_TERMLIB */
708 WINDOW *win; /* the window used in the hook */
709 int line; /* lines to take, < 0 => from bottom*/
710 int (*hook)(WINDOW *, int); /* callback for user */
714 #undef buttons /* term.h defines this, and gpm uses it! */
717 weak_symbol(Gpm_Wgetch);
721 /* link dynamically to GPM */
722 typedef int *TYPE_gpm_fd;
723 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
724 typedef int (*TYPE_Gpm_Close) (void);
725 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
727 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
728 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
729 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
730 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
732 /* link statically to GPM */
733 #define my_gpm_fd &gpm_fd
734 #define my_Gpm_Open Gpm_Open
735 #define my_Gpm_Close Gpm_Close
736 #define my_Gpm_GetEvent Gpm_GetEvent
737 #endif /* HAVE_LIBDL */
738 #endif /* USE_GPM_SUPPORT */
743 char *fix_sgr0; /* this holds the filtered sgr0 string */
744 char *last_bufp; /* help with fix_sgr0 leak */
748 #define TGETENT_MAX 4
769 const char *tparam_base;
771 STACK_FRAME stack[STACKSIZE];
781 int dynamic_var[NUM_VARS];
782 int static_vars[NUM_VARS];
791 * The filesystem database normally uses a single-letter for the lower level
792 * of directories. Use a hexadecimal code for filesystems which do not
793 * preserve mixed-case names.
795 #if MIXEDCASE_FILENAMES
796 #define LEAF_FMT "%c"
799 #define LEAF_FMT "%02x"
804 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
805 * could at most have 10 digits, and the mask contains no more than 32 bits
806 * with each bit representing less than 15 characters. Usually the whole
807 * string is less than 80 columns, but this buffer size is an absolute
810 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
811 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
813 #ifdef USE_TERM_DRIVER
814 struct DriverTCB; /* Terminal Control Block forward declaration */
815 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
817 #define INIT_TERM_DRIVER() /* nothing */
826 * Global data which is not specific to a screen.
829 SIG_ATOMIC_T have_sigtstp;
830 SIG_ATOMIC_T have_sigwinch;
831 SIG_ATOMIC_T cleanup_nested;
836 char *comp_sourcename;
839 bool have_tic_directory;
840 bool keep_tic_directory;
841 const char *tic_directory;
847 char **keyname_table;
853 size_t safeprint_used;
855 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
857 long tgetent_sequence;
859 char *dbd_blob; /* string-heap for dbd_list[] */
860 char **dbd_list; /* distinct places to look for data */
861 int dbd_size; /* length of dbd_list[] */
862 time_t dbd_time; /* cache last updated */
863 ITERATOR_VARS dbd_vars[dbdLAST];
865 #ifndef USE_SP_WINDOWLIST
866 WINDOWLIST *_nc_windowlist;
867 #define WindowList(sp) _nc_globals._nc_windowlist
870 #if USE_HOME_TERMINFO
874 #if !USE_SAFE_SPRINTF
879 #ifdef USE_TERM_DRIVER
880 int (*term_driver)(struct DriverTCB*, const char*, int*);
885 char trace_fname[PATH_MAX];
890 size_t tracearg_used;
892 TRACEBUF *tracebuf_ptr;
893 size_t tracebuf_used;
895 char tracechr_buf[40];
898 size_t tracedmp_used;
900 unsigned char *tracetry_buf;
901 size_t tracetry_used;
903 char traceatr_color_buf[2][80];
904 int traceatr_color_sel;
905 int traceatr_color_last;
906 #if !defined(USE_PTHREADS) && USE_REENTRANT
912 pthread_mutex_t mutex_curses;
913 pthread_mutex_t mutex_tst_tracef;
914 pthread_mutex_t mutex_tracef;
917 #define _nc_use_pthreads _nc_globals.use_pthreads
919 #if USE_PTHREADS_EINTR
920 pthread_t read_thread; /* The reading thread */
924 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
929 * Global data which can be swept up into a SCREEN when one is created.
930 * It may be modified before the next SCREEN is created.
935 attr_t previous_attr;
936 #ifndef USE_SP_RIPOFF
937 ripoff_t rippedoff[N_RIPS];
940 TPARM_STATE tparm_state;
941 TTY *saved_tty; /* savetty/resetty information */
942 #if NCURSES_NO_PADDING
943 bool _no_padding; /* flag to set if padding disabled */
945 NCURSES_SP_OUTC _outch; /* output handler if not putc */
946 #if BROKEN_LINKER || USE_REENTRANT
947 chtype *real_acs_map;
955 const char *_tputs_trace;
962 * Use screen-specific ripoff data (for softkeys) rather than global.
965 #define safe_ripoff_sp (sp)->rsp
966 #define safe_ripoff_stack (sp)->rippedoff
968 #define safe_ripoff_sp _nc_prescreen.rsp
969 #define safe_ripoff_stack _nc_prescreen.rippedoff
972 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
975 * The SCREEN structure.
979 int _ifd; /* input file descriptor for screen */
980 int _ofd; /* output file descriptor for screen */
981 FILE *_ofp; /* output file ptr for screen */
982 char *out_buffer; /* output buffer */
983 size_t out_limit; /* output buffer size */
984 size_t out_inuse; /* output buffer current use */
985 bool _filtered; /* filter() was called */
986 bool _prescreen; /* is in prescreen phase */
987 bool _use_env; /* LINES & COLS from environment? */
988 int _checkfd; /* filedesc for typeahead check */
989 TERMINAL *_term; /* terminal type information */
990 TTY _saved_tty; /* savetty/resetty information */
991 NCURSES_SIZE_T _lines; /* screen lines */
992 NCURSES_SIZE_T _columns; /* screen columns */
994 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
995 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
997 WINDOW *_curscr; /* current screen */
998 WINDOW *_newscr; /* virtual screen to be updated to */
999 WINDOW *_stdscr; /* screen's full-window context */
1001 #define CurScreen(sp) (sp)->_curscr
1002 #define NewScreen(sp) (sp)->_newscr
1003 #define StdScreen(sp) (sp)->_stdscr
1005 TRIES *_keytry; /* "Try" for use with keypad mode */
1006 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
1007 bool _tried; /* keypad mode was initialized */
1008 bool _keypad_on; /* keypad mode is currently on */
1010 bool _called_wgetch; /* check for recursion in wgetch() */
1011 int _fifo[FIFO_SIZE]; /* input push-back buffer */
1012 short _fifohead, /* head of fifo queue */
1013 _fifotail, /* tail of fifo queue */
1014 _fifopeek, /* where to peek for next char */
1015 _fifohold; /* set if breakout marked */
1017 int _endwin; /* are we out of window mode? */
1018 NCURSES_CH_T *_current_attr; /* holds current attributes set */
1019 int _coloron; /* is color enabled? */
1020 int _color_defs; /* are colors modified */
1021 int _cursor; /* visibility of the cursor */
1022 int _cursrow; /* physical cursor row */
1023 int _curscol; /* physical cursor column */
1024 bool _notty; /* true if we cannot switch non-tty */
1025 int _nl; /* True if NL -> CR/NL is on */
1026 int _raw; /* True if in raw mode */
1027 int _cbreak; /* 1 if in cbreak mode */
1028 /* > 1 if in halfdelay mode */
1029 int _echo; /* True if echo on */
1030 int _use_meta; /* use the meta key? */
1031 struct _SLK *_slk; /* ptr to soft key struct / NULL */
1032 int slk_format; /* selected format for this screen */
1033 /* cursor movement costs; units are 10ths of milliseconds */
1034 #if NCURSES_NO_PADDING
1035 bool _no_padding; /* flag to set if padding disabled */
1037 int _char_padding; /* cost of character put */
1038 int _cr_cost; /* cost of (carriage_return) */
1039 int _cup_cost; /* cost of (cursor_address) */
1040 int _home_cost; /* cost of (cursor_home) */
1041 int _ll_cost; /* cost of (cursor_to_ll) */
1043 int _ht_cost; /* cost of (tab) */
1044 int _cbt_cost; /* cost of (backtab) */
1045 #endif /* USE_HARD_TABS */
1046 int _cub1_cost; /* cost of (cursor_left) */
1047 int _cuf1_cost; /* cost of (cursor_right) */
1048 int _cud1_cost; /* cost of (cursor_down) */
1049 int _cuu1_cost; /* cost of (cursor_up) */
1050 int _cub_cost; /* cost of (parm_cursor_left) */
1051 int _cuf_cost; /* cost of (parm_cursor_right) */
1052 int _cud_cost; /* cost of (parm_cursor_down) */
1053 int _cuu_cost; /* cost of (parm_cursor_up) */
1054 int _hpa_cost; /* cost of (column_address) */
1055 int _vpa_cost; /* cost of (row_address) */
1056 /* used in tty_update.c, must be chars */
1057 int _ed_cost; /* cost of (clr_eos) */
1058 int _el_cost; /* cost of (clr_eol) */
1059 int _el1_cost; /* cost of (clr_bol) */
1060 int _dch1_cost; /* cost of (delete_character) */
1061 int _ich1_cost; /* cost of (insert_character) */
1062 int _dch_cost; /* cost of (parm_dch) */
1063 int _ich_cost; /* cost of (parm_ich) */
1064 int _ech_cost; /* cost of (erase_chars) */
1065 int _rep_cost; /* cost of (repeat_char) */
1066 int _hpa_ch_cost; /* cost of (column_address) */
1067 int _cup_ch_cost; /* cost of (cursor_address) */
1068 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1069 int _inline_cost; /* cost of inline-move */
1070 int _smir_cost; /* cost of (enter_insert_mode) */
1071 int _rmir_cost; /* cost of (exit_insert_mode) */
1072 int _ip_cost; /* cost of (insert_padding) */
1073 /* used in lib_mvcur.c */
1074 char * _address_cursor;
1075 /* used in tty_update.c */
1076 int _scrolling; /* 1 if terminal's smart enough to */
1078 /* used in lib_color.c */
1079 color_t *_color_table; /* screen's color palette */
1080 int _color_count; /* count of colors in palette */
1081 colorpair_t *_color_pairs; /* screen's color pair list */
1082 int _pair_count; /* count of color pairs */
1083 int _pair_limit; /* actual limit of color-pairs */
1084 #if NCURSES_EXT_FUNCS
1085 bool _assumed_color; /* use assumed colors */
1086 bool _default_color; /* use default colors */
1087 bool _has_sgr_39_49; /* has ECMA default color support */
1088 int _default_fg; /* assumed default foreground */
1089 int _default_bg; /* assumed default background */
1090 int _default_pairs; /* count pairs using default color */
1092 chtype _ok_attributes; /* valid attributes for terminal */
1093 chtype _xmc_suppress; /* attributes to suppress if xmc */
1094 chtype _xmc_triggers; /* attributes to process if xmc */
1095 chtype * _acs_map; /* the real alternate-charset map */
1096 bool * _screen_acs_map;
1099 /* used in lib_vidattr.c */
1100 bool _use_rmso; /* true if we may use 'rmso' */
1101 bool _use_rmul; /* true if we may use 'rmul' */
1103 bool _use_ritm; /* true if we may use 'ritm' */
1107 bool _extended_key; /* true if an extended key */
1111 * These data correspond to the state of the idcok() and idlok()
1112 * functions. A caveat is in order here: the XSI and SVr4
1113 * documentation specify that these functions apply to the window which
1114 * is given as an argument. However, ncurses implements this logic
1115 * only for the newscr/curscr update process, _not_ per-window.
1121 * These are the data that support the mouse interface.
1123 bool _mouse_initialized;
1124 MouseType _mouse_type;
1126 bool (*_mouse_event) (SCREEN *);
1127 bool (*_mouse_inline)(SCREEN *);
1128 bool (*_mouse_parse) (SCREEN *, int);
1129 void (*_mouse_resume)(SCREEN *);
1130 void (*_mouse_wrap) (SCREEN *);
1131 int _mouse_fd; /* file-descriptor, if any */
1132 bool _mouse_active; /* true if initialized */
1133 mmask_t _mouse_mask; /* set via mousemask() */
1134 mmask_t _mouse_mask2; /* OR's in press/release bits */
1135 mmask_t _mouse_bstate;
1136 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1137 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1138 MEVENT *_mouse_eventp; /* next free slot in event queue */
1141 bool _mouse_gpm_loaded;
1142 bool _mouse_gpm_found;
1145 TYPE_gpm_fd _mouse_gpm_fd;
1146 TYPE_Gpm_Open _mouse_Gpm_Open;
1147 TYPE_Gpm_Close _mouse_Gpm_Close;
1148 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1150 Gpm_Connect _mouse_gpm_connect;
1151 #endif /* USE_GPM_SUPPORT */
1155 int _emxmouse_thread;
1156 int _emxmouse_activated;
1157 char _emxmouse_buttons[4];
1161 MEVENT _sysmouse_fifo[FIFO_SIZE];
1164 int _sysmouse_char_width; /* character width */
1165 int _sysmouse_char_height; /* character height */
1166 int _sysmouse_old_buttons;
1167 int _sysmouse_new_buttons;
1170 #ifdef USE_TERM_DRIVER
1171 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1172 int _drv_mouse_head;
1173 int _drv_mouse_tail;
1174 int _drv_mouse_old_buttons;
1175 int _drv_mouse_new_buttons;
1178 * This supports automatic resizing
1181 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1182 int (*_ungetch)(SCREEN *, int);
1186 * These are data that support the proper handling of the panel stack on an
1189 struct panelhook _panelHook;
1192 SCREEN *_next_screen;
1194 /* hashes for old and new lines */
1195 unsigned long *oldhash, *newhash;
1201 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1203 int _legacy_coding; /* see use_legacy_coding() */
1206 char _ttytype[NAMESIZE];
1213 const char *_tputs_trace;
1218 char tracechr_buf[40];
1219 char tracemse_buf[TRACEMSE_MAX];
1221 #ifdef USE_SP_WINDOWLIST
1222 WINDOWLIST* _windowlist;
1223 #define WindowList(sp) (sp)->_windowlist
1227 ripoff_t rippedoff[N_RIPS];
1231 * ncurses/ncursesw are the same up to this point.
1233 #if USE_WIDEC_SUPPORT
1234 /* recent versions of 'screen' have partially-working support for
1235 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1237 bool _screen_acs_fix;
1238 bool _screen_unicode;
1244 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1245 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1249 SCREEN *screen; /* screen containing the window */
1250 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1251 #if NCURSES_WIDECHAR
1252 char addch_work[(MB_LEN_MAX * 9) + 1];
1253 unsigned addch_used; /* number of bytes in addch_work[] */
1254 int addch_x; /* x-position for addch_work[] */
1255 int addch_y; /* y-position for addch_work[] */
1259 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1261 #define SP_PRE_INIT(sp) \
1262 sp->_cursrow = -1; \
1263 sp->_curscol = -1; \
1268 sp->_fifohead = -1; \
1269 sp->_endwin = TRUE; \
1271 WindowList(sp) = 0; \
1272 sp->_outch = NCURSES_OUTC_FUNC; \
1275 /* usually in <limits.h> */
1277 #define UCHAR_MAX 255
1280 /* The terminfo source is assumed to be 7-bit ASCII */
1281 #define is7bits(c) ((unsigned)(c) < 128)
1283 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1284 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1287 #define min(a,b) ((a) > (b) ? (b) : (a))
1291 #define max(a,b) ((a) < (b) ? (b) : (a))
1294 /* usually in <unistd.h> */
1295 #ifndef STDIN_FILENO
1296 #define STDIN_FILENO 0
1299 #ifndef STDOUT_FILENO
1300 #define STDOUT_FILENO 1
1303 #ifndef STDERR_FILENO
1304 #define STDERR_FILENO 2
1307 #ifndef EXIT_SUCCESS
1308 #define EXIT_SUCCESS 0
1311 #ifndef EXIT_FAILURE
1312 #define EXIT_FAILURE 1
1316 #define R_OK 4 /* Test for read permission. */
1319 #define W_OK 2 /* Test for write permission. */
1322 #define X_OK 1 /* Test for execute permission. */
1325 #define F_OK 0 /* Test for existence. */
1329 #include <fcntl.h> /* may define O_BINARY */
1338 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1340 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1343 #define COUNT_OUTCHARS(n) /* nothing */
1346 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1348 #define UChar(c) ((unsigned char)(c))
1349 #define UShort(c) ((unsigned short)(c))
1350 #define ChCharOf(c) ((chtype)(c) & (chtype)A_CHARTEXT)
1351 #define ChAttrOf(c) ((chtype)(c) & (chtype)A_ATTRIBUTES)
1354 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1357 #if USE_WIDEC_SUPPORT /* { */
1358 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1360 #define init_mb(state) memset(&state, 0, sizeof(state))
1362 #if NCURSES_EXT_COLORS
1363 #define NulColor , 0
1365 #define NulColor /* nothing */
1368 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1369 #define CharOf(c) ((c).chars[0])
1370 #define AttrOf(c) ((c).attr)
1372 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1373 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1374 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1376 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1377 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1380 #define CharEq(a,b) (((a).attr == (b).attr) \
1381 && (a).chars[0] == (b).chars[0] \
1382 && (a).chars[1] == (b).chars[1] \
1383 && (a).chars[2] == (b).chars[2] \
1384 && (a).chars[3] == (b).chars[3] \
1385 && (a).chars[4] == (b).chars[4] \
1386 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1388 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1391 #define SetChar(ch,c,a) do { \
1392 NCURSES_CH_T *_cp = &ch; \
1393 memset(_cp, 0, sizeof(ch)); \
1394 _cp->chars[0] = (wchar_t) (c); \
1396 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1398 #define CHREF(wch) (&wch)
1399 #define CHDEREF(wch) (*wch)
1400 #define ARG_CH_T NCURSES_CH_T *
1401 #define CARG_CH_T const NCURSES_CH_T *
1402 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1403 mbstate_t PUT_st; wchar_t PUTC_ch
1404 #define PUTC_INIT init_mb (PUT_st)
1405 #define PUTC(ch) do { if(!isWidecExt(ch)) { \
1406 if (Charable(ch)) { \
1407 NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1408 COUNT_OUTCHARS(1); \
1411 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1412 PUTC_ch = (ch).chars[PUTC_i]; \
1413 if (PUTC_ch == L'\0') \
1415 PUTC_n = (int) wcrtomb(PUTC_buf, \
1416 (ch).chars[PUTC_i], &PUT_st); \
1417 if (PUTC_n <= 0) { \
1418 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1419 NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1423 for (PUTC_j = 0; PUTC_j < PUTC_n; ++PUTC_j) { \
1424 NCURSES_OUTC_FUNC (NCURSES_SP_ARGx PUTC_buf[PUTC_j]); \
1428 COUNT_OUTCHARS(PUTC_i); \
1431 #define BLANK NewChar2(' ', WA_NORMAL)
1432 #define ZEROS NewChar2('\0', WA_NORMAL)
1433 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1436 * Wide characters cannot be represented in the A_CHARTEXT mask of
1437 * attr_t's but an application might have set a narrow character there.
1438 * But even in that case, it would only be a printable character, or
1439 * zero. Otherwise we can use those bits to tell if a cell is the
1440 * first or extension part of a wide character.
1442 #define WidecExt(ch) (int) (AttrOf(ch) & A_CHARTEXT)
1443 #define isWidecBase(ch) (WidecExt(ch) == 1)
1444 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1445 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1446 AttrOf(dst) |= (attr_t) (ext + 1)
1448 #define if_WIDEC(code) code
1449 #define Charable(ch) ((SP_PARM->_legacy_coding) \
1450 || (AttrOf(ch) & A_ALTCHARSET) \
1451 || (!isWidecExt(ch) && \
1452 (ch).chars[1] == L'\0' && \
1453 _nc_is_charable(CharOf(ch))))
1455 #define L(ch) L ## ch
1457 #define CharOf(c) ChCharOf(c)
1458 #define AttrOf(c) ChAttrOf(c)
1459 #define AddAttr(c,a) c |= (a)
1460 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1461 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1462 #define NewChar(ch) (ch)
1463 #define NewChar2(c,a) ((c) | (a))
1464 #define CharEq(a,b) ((a) == (b))
1465 #define SetChar(ch,c,a) ch = (c) | (a)
1466 #define CHREF(wch) wch
1467 #define CHDEREF(wch) wch
1468 #define ARG_CH_T NCURSES_CH_T
1469 #define CARG_CH_T NCURSES_CH_T
1470 #define PUTC_DATA /* nothing */
1471 #define PUTC(ch) NCURSES_OUTC_FUNC (NCURSES_SP_ARGx (int) ch)
1473 #define BLANK (' '|A_NORMAL)
1474 #define ZEROS ('\0'|A_NORMAL)
1475 #define ISBLANK(ch) (CharOf(ch) == ' ')
1477 #define isWidecExt(ch) (0)
1478 #define if_WIDEC(code) /* nothing */
1483 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1484 #define CharOfD(ch) CharOf(CHDEREF(ch))
1485 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1487 #define BLANK_ATTR A_NORMAL
1488 #define BLANK_TEXT L(' ')
1492 #define LEGALYX(w, y, x) \
1494 ((x) >= 0 && (x) <= (w)->_maxx && \
1495 (y) >= 0 && (y) <= (w)->_maxy))
1497 #define CHANGED_CELL(line,col) \
1498 if (line->firstchar == _NOCHANGE) \
1499 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1500 else if ((col) < line->firstchar) \
1501 line->firstchar = (NCURSES_SIZE_T) (col); \
1502 else if ((col) > line->lastchar) \
1503 line->lastchar = (NCURSES_SIZE_T) (col)
1505 #define CHANGED_RANGE(line,start,end) \
1506 if (line->firstchar == _NOCHANGE \
1507 || line->firstchar > (start)) \
1508 line->firstchar = (NCURSES_SIZE_T) (start); \
1509 if (line->lastchar == _NOCHANGE \
1510 || line->lastchar < (end)) \
1511 line->lastchar = (NCURSES_SIZE_T) (end)
1513 #define CHANGED_TO_EOL(line,start,end) \
1514 if (line->firstchar == _NOCHANGE \
1515 || line->firstchar > (start)) \
1516 line->firstchar = (NCURSES_SIZE_T) (start); \
1517 line->lastchar = (NCURSES_SIZE_T) (end)
1519 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1521 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1523 /* FreeAndNull() is not a comma-separated expression because some compilers
1524 * do not accept a mixture of void with values.
1526 #define FreeAndNull(p) free(p); p = 0
1528 #include <nc_alloc.h>
1531 * Use these for tic/infocmp malloc failures. Generally the ncurses library
1532 * tries to limp along after a failure.
1534 #define TYPE_MALLOC(type, size, name) \
1535 name = typeMalloc(type, size); \
1537 _nc_err_abort(MSG_NO_MEMORY)
1539 #define TYPE_REALLOC(type, size, name) \
1540 name = typeRealloc(type, size, name); \
1542 _nc_err_abort(MSG_NO_MEMORY)
1545 * TTY bit definition for converting tabs to spaces.
1548 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1551 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1554 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1556 # define OFLAGS_TABS 0
1562 * Standardize/simplify common loops
1564 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1565 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1566 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1569 * Prefixes for call/return points of library function traces. We use these to
1570 * instrument the public functions so that the traces can be easily transformed
1571 * into regression scripts.
1573 #define T_CALLED(fmt) "called {" fmt
1574 #define T_CREATE(fmt) "create :" fmt
1575 #define T_RETURN(fmt) "return }" fmt
1580 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1582 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1585 #define START_TRACE() \
1586 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1587 int t = _nc_getenv_num("NCURSES_TRACE"); \
1589 trace((unsigned) t); \
1593 * Many of the _tracef() calls use static buffers; lock the trace state before
1594 * trying to fill them.
1597 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1598 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1599 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1601 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1602 #define _nc_locked_tracef _tracef
1605 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1606 #define T(a) TR(TRACE_CALLS, a)
1607 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1608 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1609 #define TRACE_RETURN_SP(value,type) return _nc_retrace_##type(SP_PARM, value)
1611 #define NonNull(s) ((s) != 0 ? s : "<null>")
1613 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1614 #define returnBits(code) TRACE_RETURN(code,unsigned)
1615 #define returnBool(code) TRACE_RETURN(code,bool)
1616 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1617 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1618 #define returnChar(code) TRACE_RETURN(code,char)
1619 #define returnChtype(code) TRACE_RETURN(code,chtype)
1620 #define returnCode(code) TRACE_RETURN(code,int)
1621 #define returnIntAttr(code) TRACE_RETURN2(code,int,attr_t)
1622 #define returnMMask(code) TRACE_RETURN_SP(code,mmask_t)
1623 #define returnPtr(code) TRACE_RETURN(code,ptr)
1624 #define returnSP(code) TRACE_RETURN(code,sp)
1625 #define returnVoid T((T_RETURN(""))); return
1626 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1627 #define returnWin(code) TRACE_RETURN(code,win)
1629 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (int);
1630 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1631 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1632 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1633 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1634 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1635 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1636 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1637 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1638 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1639 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1640 extern NCURSES_EXPORT(char) _nc_retrace_char (int);
1641 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1642 extern NCURSES_EXPORT(int) _nc_retrace_int_attr_t (attr_t);
1643 extern NCURSES_EXPORT(mmask_t) _nc_retrace_mmask_t (SCREEN *, mmask_t);
1644 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1645 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1646 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1649 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1650 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1651 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1652 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1653 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1654 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1656 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1657 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1660 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1662 #if USE_WIDEC_SUPPORT
1663 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1664 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1667 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1668 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1672 #define START_TRACE() /* nothing */
1676 #define TPUTS_TRACE(s)
1678 #define returnAttr(code) return code
1679 #define returnBits(code) return code
1680 #define returnBool(code) return code
1681 #define returnCPtr(code) return code
1682 #define returnCVoidPtr(code) return code
1683 #define returnChar(code) return ((char) code)
1684 #define returnChtype(code) return code
1685 #define returnCode(code) return code
1686 #define returnIntAttr(code) return code
1687 #define returnMMask(code) return code
1688 #define returnPtr(code) return code
1689 #define returnSP(code) return code
1690 #define returnVoid return
1691 #define returnVoidPtr(code) return code
1692 #define returnWin(code) return code
1694 #endif /* TRACE/!TRACE */
1697 * Workaround for defective implementation of gcc attribute warn_unused_result
1699 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1700 #define IGNORE_RC(func) errno = (int) func
1702 #define IGNORE_RC(func) (void) func
1703 #endif /* gcc workarounds */
1706 * Return-codes for tgetent() and friends.
1708 #define TGETENT_YES 1 /* entry is found */
1709 #define TGETENT_NO 0 /* entry is not found */
1710 #define TGETENT_ERR -1 /* an error occurred */
1712 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1713 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1715 #define EMPTY_MODULE(name) \
1716 extern NCURSES_EXPORT(void) name (void); \
1717 NCURSES_EXPORT(void) name (void) { }
1719 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1720 #define NONBLANK_ATTR (A_BOLD | A_DIM | A_BLINK | A_ITALIC)
1721 #define TPARM_ATTR (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_ALTCHARSET | A_INVIS | A_PROTECT)
1722 #define XMC_CONFLICT (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_INVIS | A_PROTECT | A_ITALIC)
1723 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1725 #define toggle_attr_on(S,at) {\
1726 if (PairNumber(at) > 0) {\
1727 (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1729 (S) |= (attr_t) (at);\
1731 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1734 #define toggle_attr_off(S,at) {\
1735 if (PairNumber(at) > 0) {\
1736 (S) &= ~(at|A_COLOR);\
1740 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1742 #define DelCharCost(sp,count) \
1745 : ((delete_character != 0) \
1746 ? (sp->_dch1_cost * count) \
1749 #define InsCharCost(sp,count) \
1752 : ((enter_insert_mode && exit_insert_mode) \
1753 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1754 : ((insert_character != 0) \
1755 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1759 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1760 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1761 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1762 if (magic_cookie_glitch > 0 \
1763 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1764 T(("%s @%d before glitch %d,%d", \
1765 __FILE__, __LINE__, \
1768 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1772 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1773 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1778 * Macros to make additional parameter to implement wgetch_events()
1780 #ifdef NCURSES_WGETCH_EVENTS
1781 #define EVENTLIST_0th(param) param
1782 #define EVENTLIST_1st(param) param
1783 #define EVENTLIST_2nd(param) , param
1784 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1786 #define EVENTLIST_0th(param) void
1787 #define EVENTLIST_1st(param) /* nothing */
1788 #define EVENTLIST_2nd(param) /* nothing */
1789 #define TWAIT_MASK TW_ANY
1792 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1794 #undef toggle_attr_on
1795 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1796 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1798 #undef toggle_attr_off
1799 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1800 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1803 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1806 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1808 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1809 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1812 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1814 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1815 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1817 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1820 #if NCURSES_SP_FUNCS
1821 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1822 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1823 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1824 #endif /* NCURSES_SP_FUNCS */
1828 extern NCURSES_EXPORT(void) _nc_expanded (void);
1832 #if !NCURSES_EXT_FUNCS
1833 #define set_escdelay(value) ESCDELAY = value
1837 #define getcwd(buf,len) getwd(buf)
1841 #if USE_WIDEC_SUPPORT
1842 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1843 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1844 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1849 short nte_name; /* offset of name to hash on */
1850 int nte_type; /* BOOLEAN, NUMBER or STRING */
1851 short nte_index; /* index of associated variable in its array */
1852 short nte_link; /* index in table of next hash, or -1 */
1864 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1868 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1869 extern NCURSES_EXPORT(void) _nc_linedump (void);
1873 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1874 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1877 #if USE_WIDEC_SUPPORT
1878 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1882 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1883 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1887 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1890 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1893 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1896 #define INFINITY 1000000 /* cost: too high to use */
1898 extern NCURSES_EXPORT(int) _nc_mvcur(int yold, int xold, int ynew, int xnew);
1900 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1901 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1902 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1904 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1906 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1907 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1908 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1911 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1914 #define INFINITY 1000000 /* cost: too high to use */
1915 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1918 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1919 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1920 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1921 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, int);
1922 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, int);
1924 /* lib_set_term.c */
1925 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1928 #define ret_error(code, fmt, arg) if (errret) {\
1932 fprintf(stderr, fmt, arg);\
1933 exit(EXIT_FAILURE);\
1936 #define ret_error1(code, fmt, arg) ret_error(code, "'%s': " fmt, arg)
1938 #define ret_error0(code, msg) if (errret) {\
1942 fprintf(stderr, msg);\
1943 exit(EXIT_FAILURE);\
1948 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1950 #define _nc_handle_sigwinch(a) /* nothing */
1954 #if USE_WIDEC_SUPPORT
1955 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1959 char *s_head; /* beginning of the string (may be null) */
1960 char *s_tail; /* end of the string (may be null) */
1961 size_t s_size; /* current remaining size available */
1962 size_t s_init; /* total size available */
1966 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1967 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1968 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1969 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1970 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1973 #define strstr _nc_strstr
1974 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1977 /* safe_sprintf.c */
1978 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1981 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1982 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1983 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1984 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1987 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1988 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1989 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1990 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1991 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1992 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1993 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1994 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1995 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1996 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1997 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1998 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1999 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
2000 extern NCURSES_EXPORT(int) _nc_ospeed (int);
2001 extern NCURSES_EXPORT(int) _nc_outch (int);
2002 extern NCURSES_EXPORT(int) _nc_putchar (int);
2003 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
2004 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
2005 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
2006 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
2007 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
2008 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
2009 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
2010 extern NCURSES_EXPORT(void) _nc_flush (void);
2011 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
2012 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
2013 extern NCURSES_EXPORT(void) _nc_freeall (void);
2014 extern NCURSES_EXPORT(void) _nc_hash_map (void);
2015 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
2016 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
2017 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
2018 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
2019 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
2020 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
2021 extern NCURSES_EXPORT(void) _nc_setenv_num (const char *, int);
2022 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
2023 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
2024 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
2027 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
2028 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
2029 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
2030 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
2031 extern NCURSES_EXPORT(void) _nc_comp_error_leaks(void);
2032 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
2033 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
2034 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
2035 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
2036 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
2039 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2040 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
2041 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
2042 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
2045 #if USE_WIDEC_SUPPORT
2046 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
2049 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2050 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
2054 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
2058 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
2060 #define _nc_resize_margins(wp) /* nothing */
2063 #ifdef NCURSES_WGETCH_EVENTS
2064 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2066 #define wgetch_events(win, evl) wgetch(win)
2067 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2071 * Wide-character macros to hide some platform-differences.
2073 #if USE_WIDEC_SUPPORT
2075 #if defined(__MINGW32__)
2077 * MinGW has wide-character functions, but they do not work correctly.
2080 extern int __MINGW_NOTHROW _nc_wctomb(char *, wchar_t);
2081 #define wctomb(s,wc) _nc_wctomb(s,wc)
2082 #define wcrtomb(s,wc,n) _nc_wctomb(s,wc)
2084 extern int __MINGW_NOTHROW _nc_mbtowc(wchar_t *, const char *, size_t);
2085 #define mbtowc(pwc,s,n) _nc_mbtowc(pwc,s,n)
2087 extern int __MINGW_NOTHROW _nc_mblen(const char *, size_t);
2088 #define mblen(s,n) _nc_mblen(s, n)
2090 #endif /* __MINGW32__ */
2092 #if HAVE_MBTOWC && HAVE_MBLEN
2093 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2094 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2095 #define check_mbytes(wch,buffer,length,state) \
2096 (int) mbtowc(&wch, buffer, length)
2097 #define state_unused
2098 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2099 #define reset_mbytes(state) init_mb(state)
2100 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
2101 #define check_mbytes(wch,buffer,length,state) \
2102 (int) mbrtowc(&wch, buffer, length, &state)
2107 #endif /* USE_WIDEC_SUPPORT */
2110 * Not everyone has vsscanf(), but we'd like to use it for scanw().
2113 extern int vsscanf(const char *str, const char *format, va_list __arg);
2116 /* scroll indices */
2117 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2119 #define USE_SETBUF_0 0
2121 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
2123 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
2126 * On systems with a broken linker, define 'SP' as a function to force the
2127 * linker to pull in the data-only module with 'SP'.
2129 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2132 #define SP _nc_screen()
2133 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2134 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
2135 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
2136 #define CURRENT_SCREEN _nc_screen()
2138 /* current screen is private data; avoid possible linking conflicts too */
2139 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2140 #define CURRENT_SCREEN SP
2141 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
2142 #define _nc_set_screen(sp) SP = sp
2145 #if NCURSES_SP_FUNCS
2146 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2148 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
2152 * We don't want to use the lines or columns capabilities internally, because
2153 * if the application is running multiple screens under X, it's quite possible
2154 * they could all have type xterm but have different sizes! So...
2156 #define screen_lines(sp) (sp)->_lines
2157 #define screen_columns(sp) (sp)->_columns
2159 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2160 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2163 * Some constants related to SLK's
2165 #define MAX_SKEY_OLD 8 /* count of soft keys */
2166 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2167 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2168 #define MAX_SKEY_LEN_PC 5
2170 /* Macro to check whether or not we use a standard format */
2171 #define SLK_STDFMT(fmt) (fmt < 3)
2172 /* Macro to determine height of label window */
2173 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2175 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2176 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2179 * Common error messages
2181 #define MSG_NO_MEMORY "Out of memory"
2182 #define MSG_NO_INPUTS "Premature EOF"
2184 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2185 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2187 /* timed_wait flag definitions */
2191 #define TW_ANY (TW_INPUT | TW_MOUSE)
2194 #define SetSafeOutcWrapper(outc) \
2195 SCREEN* sp = CURRENT_SCREEN; \
2196 struct screen outc_wrapper; \
2198 sp = &outc_wrapper; \
2199 memset(sp,0,sizeof(struct screen)); \
2200 sp->_outch = _nc_outc_wrapper; \
2204 #ifdef USE_TERM_DRIVER
2205 typedef void* TERM_HANDLE;
2207 typedef struct _termInfo
2226 const color_t* defaultPalette;
2229 typedef struct term_driver {
2231 bool (*CanHandle)(struct DriverTCB*, const char*, int*);
2232 void (*init)(struct DriverTCB*);
2233 void (*release)(struct DriverTCB*);
2234 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2235 int (*sgmode)(struct DriverTCB*, int setFlag, TTY*);
2236 chtype (*conattr)(struct DriverTCB*);
2237 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2238 int (*mode)(struct DriverTCB*, int progFlag, int defFlag);
2239 bool (*rescol)(struct DriverTCB*);
2240 bool (*rescolors)(struct DriverTCB*);
2241 void (*color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2242 int (*doBeepOrFlash)(struct DriverTCB*, int);
2243 void (*initpair)(struct DriverTCB*, int, int, int);
2244 void (*initcolor)(struct DriverTCB*, int, int, int, int);
2245 void (*docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2246 void (*initmouse)(struct DriverTCB*);
2247 int (*testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2248 void (*setfilter)(struct DriverTCB*);
2249 void (*hwlabel)(struct DriverTCB*, int, char*);
2250 void (*hwlabelOnOff)(struct DriverTCB*, int);
2251 int (*update)(struct DriverTCB*);
2252 int (*defaultcolors)(struct DriverTCB*, int, int);
2253 int (*print)(struct DriverTCB*, char*, int);
2254 int (*getsize)(struct DriverTCB*, int*, int*);
2255 int (*setsize)(struct DriverTCB*, int, int);
2256 void (*initacs)(struct DriverTCB*, chtype*, chtype*);
2257 void (*scinit)(SCREEN *);
2258 void (*scexit)(SCREEN *);
2259 int (*twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2260 int (*read)(struct DriverTCB*, int*);
2261 int (*nap)(struct DriverTCB*, int);
2262 int (*kpad)(struct DriverTCB*, int);
2263 int (*kyOk)(struct DriverTCB*, int, int);
2264 bool (*kyExist)(struct DriverTCB*, int);
2267 typedef struct DriverTCB
2269 TERMINAL term; /* needs to be the first Element !!! */
2270 TERM_HANDLE inp; /* The input handle of the Terminal */
2271 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2272 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2273 TERM_DRIVER* drv; /* The driver for that Terminal */
2274 SCREEN* csp; /* The screen that owns that Terminal */
2275 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2276 void* prop; /* Driver dependent property storage to be used by the Driver */
2278 } TERMINAL_CONTROL_BLOCK;
2280 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2281 #define NCDRV_TINFO 0x01
2282 #define NCDRV_WINCONSOLE 0x02
2284 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2285 #define InfoOf(sp) TCBOf(sp)->info
2286 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2287 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2288 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2289 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2290 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2292 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2293 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2295 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2296 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2297 #endif /* USE_TERM_DRIVER */
2300 * Entrypoints which are actually provided in the terminal driver, which would
2301 * be an sp-name otherwise.
2303 #ifdef USE_TERM_DRIVER
2304 #define TINFO_HAS_KEY _nc_tinfo_has_key
2305 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2306 #define TINFO_MVCUR _nc_tinfo_mvcur
2307 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2308 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2309 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2311 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2312 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2313 #define TINFO_MVCUR NCURSES_SP_NAME(_nc_mvcur)
2317 * Entrypoints using an extra parameter with the terminal driver.
2319 #ifdef USE_TERM_DRIVER
2320 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2321 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, int);
2322 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2323 _nc_get_screensize(sp, tp, lp, cp)
2324 #define TINFO_SET_CURTERM(sp, tp) \
2325 NCURSES_SP_NAME(set_curterm)(sp, tp)
2326 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2327 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2328 #else /* !USE_TERM_DRIVER */
2329 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2330 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2331 _nc_get_screensize(sp, lp, cp)
2332 #define TINFO_SET_CURTERM(sp, tp) \
2334 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2335 _nc_setupterm(name, fd, err, reuse)
2336 #endif /* !USE_TERM_DRIVER */
2338 #ifdef USE_TERM_DRIVER
2340 #include <nc_mingw.h>
2341 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2343 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2346 #ifdef USE_TERM_DRIVER
2347 #define IsTermInfo(sp) ((TCBOf(sp) != 0) && ((TCBOf(sp)->drv->isTerminfo)))
2348 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2350 #define IsTermInfo(sp) TRUE
2351 #define HasTInfoTerminal(sp) (0 != TerminalOf(sp))
2354 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2357 * Exported entrypoints beyond the published API
2359 #if NCURSES_SP_FUNCS
2360 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2361 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2362 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2363 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2366 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2367 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2370 #if NCURSES_EXT_FUNCS
2371 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2375 * We put the safe versions of various calls here as they are not published
2376 * part of the API up to now
2378 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2379 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2380 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2381 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2382 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2383 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2384 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2385 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2386 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2387 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mvcur)(SCREEN*, int, int, int, int);
2388 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2389 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putchar)(SCREEN*, int);
2390 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2391 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2392 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2393 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2394 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2395 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2396 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2397 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2398 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2399 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2400 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2401 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2402 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2403 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, NCURSES_COLOR_T, void *);
2404 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2405 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2406 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2407 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2408 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2409 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2410 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2411 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2412 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2413 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2414 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2415 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2416 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2417 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2418 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2419 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2420 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2421 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2423 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2425 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2426 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2429 #if USE_WIDEC_SUPPORT
2430 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2433 #endif /* NCURSES_SP_FUNCS */
2435 #if NCURSES_SP_FUNCS
2437 #define safe_keyname NCURSES_SP_NAME(keyname)
2438 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2439 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2443 #define safe_keyname _nc_keyname
2444 #define safe_unctrl _nc_unctrl
2445 #define safe_ungetch _nc_ungetch
2447 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2448 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2449 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2459 #endif /* CURSES_PRIV_H */