1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer *
34 ****************************************************************************/
38 * $Id: curses.priv.h,v 1.443 2009/11/21 22:27:52 tom Exp $
42 * Header file for curses library objects which are private to
48 #define CURSES_PRIV_H 1
50 #include <ncurses_dll.h>
56 #include <ncurses_cfg.h>
59 #define MODULE_ID(id) static const char Ident[] = id;
61 #define MODULE_ID(id) /*nothing*/
66 #include <sys/types.h>
72 #if HAVE_SYS_BSDTYPES_H
73 #include <sys/bsdtypes.h> /* needed for ISC */
78 #elif HAVE_SYS_PARAM_H
79 # include <sys/param.h>
88 # if defined(_POSIX_PATH_MAX)
89 # define PATH_MAX _POSIX_PATH_MAX
90 # elif defined(MAXPATHLEN)
91 # define PATH_MAX MAXPATHLEN
93 # define PATH_MAX 255 /* the Posix minimum path-size */
101 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
102 #if HAVE_WORKING_POLL
103 #define USE_FUNC_POLL 1
107 #include <sys/poll.h>
110 #define USE_FUNC_POLL 0
113 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
116 /* Alessandro Rubini's GPM (general-purpose mouse) */
117 #if HAVE_LIBGPM && HAVE_GPM_H
118 #define USE_GPM_SUPPORT 1
120 #define USE_GPM_SUPPORT 0
123 /* QNX mouse support */
124 #if defined(__QNX__) && !defined(__QNXNTO__)
125 #define USE_QNX_MOUSE 1
127 #define USE_QNX_MOUSE 0
130 /* EMX mouse support */
132 #define USE_EMX_MOUSE 1
134 #define USE_EMX_MOUSE 0
137 #define DEFAULT_MAXCLICK 166
138 #define EV_MAX 8 /* size of mouse circular event queue */
141 * If we don't have signals to support it, don't add a sigwinch handler.
142 * In any case, resizing is an extended feature. Use it if we've got it.
144 #if !NCURSES_EXT_FUNCS
145 #undef HAVE_SIZECHANGE
146 #define HAVE_SIZECHANGE 0
149 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
150 #define USE_SIZECHANGE 1
152 #define USE_SIZECHANGE 0
154 #define USE_SIGWINCH 0
158 * If desired, one can configure this, disabling environment variables that
159 * point to custom terminfo/termcap locations.
161 #ifdef USE_ROOT_ENVIRON
162 #define use_terminfo_vars() 1
164 #define use_terminfo_vars() _nc_env_access()
165 extern NCURSES_EXPORT(int) _nc_env_access (void);
169 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
173 #define memmove(d,s,n) bcopy(s,d,n)
175 #define memmove(d,s,n) _nc_memmove(d,s,n)
176 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
180 * Scroll hints are useless when hashmap is used
182 #if !USE_SCROLL_HINTS
184 #define USE_SCROLL_HINTS 1
186 #define USE_SCROLL_HINTS 0
191 #define if_USE_SCROLL_HINTS(stmt) stmt
193 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
197 * Options for terminal drivers, etc...
199 #ifdef USE_TERM_DRIVER
200 #define USE_SP_RIPOFF 1
201 #define USE_SP_TERMTYPE 1
202 #define USE_SP_WINDOWLIST 1
206 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
207 * when we're throwing control codes at the screen at high volume. To see
208 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
209 * probably don't want to define this either due to uncertainties about tab
210 * delays and expansion in raw mode.
213 #define TRIES struct tries
215 TRIES *child; /* ptr to child. NULL if none */
216 TRIES *sibling; /* ptr to sibling. NULL if none */
217 unsigned char ch; /* character at this node */
218 unsigned short value; /* code of string so far. 0 if none. */
223 * Common/troublesome character definitions
225 #define StringOf(ch) {ch, 0}
232 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
235 * Structure for palette tables
240 short red, green, blue; /* what color_content() returns */
241 short r, g, b; /* params to init_color() */
242 int init; /* true if we called init_color() */
246 #define MAXCOLUMNS 135
248 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
252 #define WINDOWLIST struct _win_list
254 #if USE_WIDEC_SUPPORT
255 #define _nc_bkgd _bkgrnd
257 #undef _XOPEN_SOURCE_EXTENDED
258 #define _nc_bkgd _bkgd
259 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
260 #define wbkgrnd wbkgd
263 #undef NCURSES_OPAQUE
264 #define NCURSES_INTERNALS 1
265 #define NCURSES_OPAQUE 0
267 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
270 * If curses.h did not expose the SCREEN-functions, then we do not need the
271 * parameter in the corresponding unextended functions.
274 #define SP_PARM sp /* use parameter */
275 #define NCURSES_SP_ARG SP_PARM
276 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
277 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
278 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
279 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
281 #define SP_PARM SP /* use global variable */
282 #define NCURSES_SP_ARG
283 #define NCURSES_SP_DCL
284 #define NCURSES_SP_DCL0 void
285 #define NCURSES_SP_ARGx
286 #define NCURSES_SP_DCLx
289 #include <nc_panel.h>
291 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
292 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
293 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
295 #if BROKEN_LINKER || USE_REENTRANT
296 #define CurTerm _nc_prescreen._cur_term
298 #define CurTerm cur_term
302 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
304 #define TerminalOf(sp) CurTerm
310 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
311 * pointer to this data.
313 #ifdef USE_SP_TERMTYPE
317 #define SP_TERMTYPE TerminalOf(sp)->type.
319 #include <term_entry.h>
321 #include <nc_tparm.h>
323 #if NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT
324 #define if_EXT_COLORS(stmt) stmt
325 #define NetPair(value,p) (value).ext_color = (p), \
326 AttrOf(value) &= ALL_BUT_COLOR, \
327 AttrOf(value) |= (A_COLOR & COLOR_PAIR((p > 255) ? 255 : p))
328 #define SetPair(value,p) (value).ext_color = (p)
329 #define GetPair(value) (value).ext_color
330 #define unColor(n) (AttrOf(n) & ALL_BUT_COLOR)
331 #define GET_WINDOW_PAIR(w) (w)->_color
332 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
333 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
336 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
338 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
341 #else /* !(NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT) */
343 #define if_EXT_COLORS(stmt) /* nothing */
344 #define SetPair(value,p) RemAttr(value, A_COLOR), \
345 SetAttr(value, AttrOf(value) | (A_COLOR & COLOR_PAIR(p)))
346 #define GetPair(value) PAIR_NUMBER(AttrOf(value))
347 #define unColor(n) (AttrOf(n) & ALL_BUT_COLOR)
348 #define GET_WINDOW_PAIR(w) PAIR_NUMBER(WINDOW_ATTRS(w))
349 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
350 WINDOW_ATTRS(w) |= (A_COLOR & COLOR_PAIR(p))
351 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
354 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
356 #define VIDATTR(sp,attr,pair) vidattr(attr)
359 #endif /* NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT */
361 #if NCURSES_NO_PADDING
362 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
363 #define SetNoPadding(sp) _nc_set_no_padding(sp)
364 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
366 #define GetNoPadding(sp) FALSE
367 #define SetNoPadding(sp) /*nothing*/
370 #define WINDOW_ATTRS(w) ((w)->_attrs)
372 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
373 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
374 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
376 #if USE_REENTRANT || NCURSES_SP_FUNCS
377 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
378 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
379 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
380 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
385 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
386 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
387 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
388 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
390 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
391 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
392 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
393 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
397 #define ptrLines(sp) &LINES
398 #define ptrCols(sp) &COLS
399 #define ptrTabsize(sp) &TABSIZE
400 #define ptrEscdelay(sp) &ESCDELAY
402 #define SET_LINES(value) LINES = value
403 #define SET_COLS(value) COLS = value
404 #define SET_TABSIZE(value) TABSIZE = value
405 #define SET_ESCDELAY(value) ESCDELAY = value
409 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
410 __FILE__, __LINE__, \
411 (unsigned long) (pthread_self()), \
412 data.__data.__lock, \
413 data.__data.__count, \
414 data.__data.__owner, \
415 data.__data.__kind, \
416 (data.__data.__nusers > 5) ? " OOPS " : "", \
417 data.__data.__nusers)
418 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
424 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
425 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
426 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
427 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
428 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
429 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
430 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
431 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
434 #error POSIX threads requires --enable-reentrant option
438 #if defined(__GNUC__)
439 # if defined __USE_ISOC99
440 # define _cat_pragma(exp) _Pragma(#exp)
441 # define _weak_pragma(exp) _cat_pragma(weak name)
443 # define _weak_pragma(exp)
445 # define _declare(name) __extension__ extern __typeof__(name) name
446 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
451 # if USE_WEAK_SYMBOLS
452 weak_symbol(pthread_sigmask);
453 weak_symbol(pthread_self);
454 weak_symbol(pthread_equal);
455 weak_symbol(pthread_mutex_init);
456 weak_symbol(pthread_mutex_lock);
457 weak_symbol(pthread_mutex_unlock);
458 weak_symbol(pthread_mutex_trylock);
459 weak_symbol(pthread_mutexattr_settype);
460 weak_symbol(pthread_mutexattr_init);
461 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
463 # define sigprocmask _nc_sigprocmask
468 #undef HAVE_NANOSLEEP
469 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
472 #else /* !USE_PTHREADS */
474 #define _nc_init_pthreads() /* nothing */
475 #define _nc_mutex_init(obj) /* nothing */
477 #define _nc_lock_global(name) /* nothing */
478 #define _nc_try_global(name) 0
479 #define _nc_unlock_global(name) /* nothing */
481 #endif /* USE_PTHREADS */
484 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
485 * So the locking is done in the non-sp-func (which calls the sp-func) rather
486 * than in the sp-func itself.
488 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
489 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
493 #define _nc_nonsp_lock_global(name) /* nothing */
494 #define _nc_nonsp_try_global(name) 0
495 #define _nc_nonsp_unlock_global(name) /* nothing */
497 #define _nc_sp_lock_global(name) _nc_lock_global(name)
498 #define _nc_sp_try_global(name) _nc_try_global(name)
499 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
503 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
504 #define _nc_nonsp_try_global(name) _nc_try_global(name)
505 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
507 #define _nc_sp_lock_global(name) /* nothing */
508 #define _nc_sp_try_global(name) 0
509 #define _nc_sp_unlock_global(name) /* nothing */
513 #if HAVE_GETTIMEOFDAY
514 # define PRECISE_GETTIME 1
515 # define TimeType struct timeval
517 # define PRECISE_GETTIME 0
518 # define TimeType time_t
522 * Definitions for color pairs
524 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
525 #define C_SHIFT 9 /* we need more bits than there are colors */
526 #define C_MASK ((1 << C_SHIFT) - 1)
527 #define PAIR_OF(fg, bg) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
528 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
529 #define BACK_OF(c) ((c) & C_MASK)
530 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
532 #define COLOR_DEFAULT C_MASK
534 #if defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T)
536 #undef NCURSES_CH_T /* this is not a termlib feature */
537 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
539 #endif /* USE_TERMLIB */
544 NCURSES_CH_T *text; /* text of the line */
545 NCURSES_SIZE_T firstchar; /* first changed character in the line */
546 NCURSES_SIZE_T lastchar; /* last changed character in the line */
547 NCURSES_SIZE_T oldindex; /* index of the line at last update */
549 #endif /* USE_TERMLIB */
552 M_XTERM = -1 /* use xterm's mouse tracking? */
553 ,M_NONE = 0 /* no mouse device */
558 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
563 * Structures for scrolling.
567 unsigned long hashval;
568 int oldcount, newcount;
569 int oldindex, newindex;
573 * Structures for soft labels.
582 char *ent_text; /* text for the label */
583 char *form_text; /* formatted text (left/center/...) */
584 int ent_x; /* x coordinate of this field */
585 char dirty; /* this label has changed */
586 char visible; /* field is visible */
589 typedef struct _SLK {
590 bool dirty; /* all labels have changed */
591 bool hidden; /* soft labels are hidden */
594 short maxlab; /* number of available labels */
595 short labcnt; /* number of allocated labels */
596 short maxlen; /* length of labels */
597 NCURSES_CH_T attr; /* soft label attribute */
600 #endif /* USE_TERMLIB */
603 WINDOW *win; /* the window used in the hook */
604 int line; /* lines to take, < 0 => from bottom*/
605 int (*hook)(WINDOW *, int); /* callback for user */
609 #undef buttons /* term.h defines this, and gpm uses it! */
613 /* link dynamically to GPM */
614 typedef int *TYPE_gpm_fd;
615 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
616 typedef int (*TYPE_Gpm_Close) (void);
617 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
619 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
620 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
621 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
622 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
624 /* link statically to GPM */
625 #define my_gpm_fd &gpm_fd
626 #define my_Gpm_Open Gpm_Open
627 #define my_Gpm_Close Gpm_Close
628 #define my_Gpm_GetEvent Gpm_GetEvent
629 #endif /* HAVE_LIBDL */
630 #endif /* USE_GPM_SUPPORT */
635 char *fix_sgr0; /* this holds the filtered sgr0 string */
636 char *last_bufp; /* help with fix_sgr0 leak */
640 #define TGETENT_MAX 4
661 const char *tparam_base;
663 STACK_FRAME stack[STACKSIZE];
673 int dynamic_var[NUM_VARS];
674 int static_vars[NUM_VARS];
683 * The filesystem database normally uses a single-letter for the lower level
684 * of directories. Use a hexadecimal code for filesystems which do not
685 * preserve mixed-case names.
687 #if MIXEDCASE_FILENAMES
688 #define LEAF_FMT "%c"
690 #define LEAF_FMT "%02x"
694 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
695 * could at most have 10 digits, and the mask contains no more than 32 bits
696 * with each bit representing less than 15 characters. Usually the whole
697 * string is less than 80 columns, but this buffer size is an absolute
700 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
701 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
704 * Global data which is not specific to a screen.
707 SIG_ATOMIC_T have_sigwinch;
708 SIG_ATOMIC_T cleanup_nested;
713 const char *comp_sourcename;
716 bool have_tic_directory;
717 bool keep_tic_directory;
718 const char *tic_directory;
724 char **keyname_table;
729 size_t safeprint_used;
731 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
733 long tgetent_sequence;
735 #ifndef USE_SP_WINDOWLIST
736 WINDOWLIST *_nc_windowlist;
737 #define WindowList(sp) _nc_globals._nc_windowlist
740 #if USE_HOME_TERMINFO
744 #if !USE_SAFE_SPRINTF
751 char trace_fname[PATH_MAX];
756 size_t tracearg_used;
758 TRACEBUF *tracebuf_ptr;
759 size_t tracebuf_used;
761 char tracechr_buf[40];
764 size_t tracedmp_used;
766 unsigned char *tracetry_buf;
767 size_t tracetry_used;
769 char traceatr_color_buf[2][80];
770 int traceatr_color_sel;
771 int traceatr_color_last;
772 #if !defined(USE_PTHREADS) && USE_REENTRANT
778 pthread_mutex_t mutex_curses;
779 pthread_mutex_t mutex_tst_tracef;
780 pthread_mutex_t mutex_tracef;
783 #define _nc_use_pthreads _nc_globals.use_pthreads
787 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
792 * Global data which can be swept up into a SCREEN when one is created.
793 * It may be modified before the next SCREEN is created.
798 attr_t previous_attr;
799 #ifndef USE_SP_RIPOFF
800 ripoff_t rippedoff[N_RIPS];
803 TPARM_STATE tparm_state;
804 TTY *saved_tty; /* savetty/resetty information */
805 #if NCURSES_NO_PADDING
806 bool _no_padding; /* flag to set if padding disabled */
808 NCURSES_SP_OUTC _outch; /* output handler if not putc */
809 #if BROKEN_LINKER || USE_REENTRANT
810 chtype *real_acs_map;
818 const char *_tputs_trace;
824 * Use screen-specific ripoff data (for softkeys) rather than global.
827 #define safe_ripoff_sp (sp)->rsp
828 #define safe_ripoff_stack (sp)->rippedoff
830 #define safe_ripoff_sp _nc_prescreen.rsp
831 #define safe_ripoff_stack _nc_prescreen.rippedoff
834 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
837 * The SCREEN structure.
841 int _ifd; /* input file ptr for screen */
842 FILE *_ofp; /* output file ptr for screen */
843 char *_setbuf; /* buffered I/O for output */
844 bool _filtered; /* filter() was called */
845 bool _buffered; /* setvbuf uses _setbuf data */
846 bool _prescreen; /* is in prescreen phase */
847 bool _use_env; /* LINES & COLS from environment? */
848 int _checkfd; /* filedesc for typeahead check */
849 TERMINAL *_term; /* terminal type information */
850 TTY _saved_tty; /* savetty/resetty information */
851 NCURSES_SIZE_T _lines; /* screen lines */
852 NCURSES_SIZE_T _columns; /* screen columns */
854 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
855 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
857 WINDOW *_curscr; /* current screen */
858 WINDOW *_newscr; /* virtual screen to be updated to */
859 WINDOW *_stdscr; /* screen's full-window context */
861 #define CurScreen(sp) (sp)->_curscr
862 #define NewScreen(sp) (sp)->_newscr
863 #define StdScreen(sp) (sp)->_stdscr
865 TRIES *_keytry; /* "Try" for use with keypad mode */
866 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
867 bool _tried; /* keypad mode was initialized */
868 bool _keypad_on; /* keypad mode is currently on */
870 bool _called_wgetch; /* check for recursion in wgetch() */
871 int _fifo[FIFO_SIZE]; /* input push-back buffer */
872 short _fifohead, /* head of fifo queue */
873 _fifotail, /* tail of fifo queue */
874 _fifopeek, /* where to peek for next char */
875 _fifohold; /* set if breakout marked */
877 int _endwin; /* are we out of window mode? */
878 NCURSES_CH_T *_current_attr; /* holds current attributes set */
879 int _coloron; /* is color enabled? */
880 int _color_defs; /* are colors modified */
881 int _cursor; /* visibility of the cursor */
882 int _cursrow; /* physical cursor row */
883 int _curscol; /* physical cursor column */
884 bool _notty; /* true if we cannot switch non-tty */
885 int _nl; /* True if NL -> CR/NL is on */
886 int _raw; /* True if in raw mode */
887 int _cbreak; /* 1 if in cbreak mode */
888 /* > 1 if in halfdelay mode */
889 int _echo; /* True if echo on */
890 int _use_meta; /* use the meta key? */
891 struct _SLK *_slk; /* ptr to soft key struct / NULL */
892 int slk_format; /* selected format for this screen */
893 /* cursor movement costs; units are 10ths of milliseconds */
894 #if NCURSES_NO_PADDING
895 bool _no_padding; /* flag to set if padding disabled */
897 int _char_padding; /* cost of character put */
898 int _cr_cost; /* cost of (carriage_return) */
899 int _cup_cost; /* cost of (cursor_address) */
900 int _home_cost; /* cost of (cursor_home) */
901 int _ll_cost; /* cost of (cursor_to_ll) */
903 int _ht_cost; /* cost of (tab) */
904 int _cbt_cost; /* cost of (backtab) */
905 #endif /* USE_HARD_TABS */
906 int _cub1_cost; /* cost of (cursor_left) */
907 int _cuf1_cost; /* cost of (cursor_right) */
908 int _cud1_cost; /* cost of (cursor_down) */
909 int _cuu1_cost; /* cost of (cursor_up) */
910 int _cub_cost; /* cost of (parm_cursor_left) */
911 int _cuf_cost; /* cost of (parm_cursor_right) */
912 int _cud_cost; /* cost of (parm_cursor_down) */
913 int _cuu_cost; /* cost of (parm_cursor_up) */
914 int _hpa_cost; /* cost of (column_address) */
915 int _vpa_cost; /* cost of (row_address) */
916 /* used in tty_update.c, must be chars */
917 int _ed_cost; /* cost of (clr_eos) */
918 int _el_cost; /* cost of (clr_eol) */
919 int _el1_cost; /* cost of (clr_bol) */
920 int _dch1_cost; /* cost of (delete_character) */
921 int _ich1_cost; /* cost of (insert_character) */
922 int _dch_cost; /* cost of (parm_dch) */
923 int _ich_cost; /* cost of (parm_ich) */
924 int _ech_cost; /* cost of (erase_chars) */
925 int _rep_cost; /* cost of (repeat_char) */
926 int _hpa_ch_cost; /* cost of (column_address) */
927 int _cup_ch_cost; /* cost of (cursor_address) */
928 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
929 int _inline_cost; /* cost of inline-move */
930 int _smir_cost; /* cost of (enter_insert_mode) */
931 int _rmir_cost; /* cost of (exit_insert_mode) */
932 int _ip_cost; /* cost of (insert_padding) */
933 /* used in lib_mvcur.c */
934 char * _address_cursor;
935 /* used in tty_update.c */
936 int _scrolling; /* 1 if terminal's smart enough to */
938 /* used in lib_color.c */
939 color_t *_color_table; /* screen's color palette */
940 int _color_count; /* count of colors in palette */
941 colorpair_t *_color_pairs; /* screen's color pair list */
942 int _pair_count; /* count of color pairs */
943 int _pair_limit; /* actual limit of color-pairs */
944 #if NCURSES_EXT_FUNCS
945 bool _default_color; /* use default colors */
946 bool _has_sgr_39_49; /* has ECMA default color support */
947 int _default_fg; /* assumed default foreground */
948 int _default_bg; /* assumed default background */
949 int _default_pairs; /* count pairs using default color */
951 chtype _ok_attributes; /* valid attributes for terminal */
952 chtype _xmc_suppress; /* attributes to suppress if xmc */
953 chtype _xmc_triggers; /* attributes to process if xmc */
954 chtype * _acs_map; /* the real alternate-charset map */
955 bool * _screen_acs_map;
958 /* used in lib_vidattr.c */
959 bool _use_rmso; /* true if we may use 'rmso' */
960 bool _use_rmul; /* true if we may use 'rmul' */
963 * These data correspond to the state of the idcok() and idlok()
964 * functions. A caveat is in order here: the XSI and SVr4
965 * documentation specify that these functions apply to the window which
966 * is given as an argument. However, ncurses implements this logic
967 * only for the newscr/curscr update process, _not_ per-window.
973 * These are the data that support the mouse interface.
975 bool _mouse_initialized;
976 MouseType _mouse_type;
978 bool (*_mouse_event) (SCREEN *);
979 bool (*_mouse_inline)(SCREEN *);
980 bool (*_mouse_parse) (SCREEN *, int);
981 void (*_mouse_resume)(SCREEN *);
982 void (*_mouse_wrap) (SCREEN *);
983 int _mouse_fd; /* file-descriptor, if any */
984 bool _mouse_active; /* true if initialized */
986 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
987 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
988 MEVENT *_mouse_eventp; /* next free slot in event queue */
991 bool _mouse_gpm_loaded;
992 bool _mouse_gpm_found;
995 TYPE_gpm_fd _mouse_gpm_fd;
996 TYPE_Gpm_Open _mouse_Gpm_Open;
997 TYPE_Gpm_Close _mouse_Gpm_Close;
998 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1000 Gpm_Connect _mouse_gpm_connect;
1001 #endif /* USE_GPM_SUPPORT */
1005 int _emxmouse_thread;
1006 int _emxmouse_activated;
1007 char _emxmouse_buttons[4];
1011 MEVENT _sysmouse_fifo[FIFO_SIZE];
1014 int _sysmouse_char_width; /* character width */
1015 int _sysmouse_char_height; /* character height */
1016 int _sysmouse_old_buttons;
1017 int _sysmouse_new_buttons;
1021 * This supports automatic resizing
1024 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1028 * These are data that support the proper handling of the panel stack on an
1031 struct panelhook _panelHook;
1034 SCREEN *_next_screen;
1036 /* hashes for old and new lines */
1037 unsigned long *oldhash, *newhash;
1043 bool _cleanup; /* cleanup after int/quit signal */
1044 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1046 int _legacy_coding; /* see use_legacy_coding() */
1049 char _ttytype[NAMESIZE];
1056 const char *_tputs_trace;
1061 char tracechr_buf[40];
1062 char tracemse_buf[TRACEMSE_MAX];
1064 #ifdef USE_SP_WINDOWLIST
1065 WINDOWLIST* _windowlist;
1066 #define WindowList(sp) (sp)->_windowlist
1070 ripoff_t rippedoff[N_RIPS];
1074 * ncurses/ncursesw are the same up to this point.
1076 #if USE_WIDEC_SUPPORT
1077 /* recent versions of 'screen' have partially-working support for
1078 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1080 bool _screen_acs_fix;
1084 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1085 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1088 WINDOW win; /* first, so WINDOW_EXT() works */
1090 SCREEN *screen; /* screen containing the window */
1091 #ifdef _XOPEN_SOURCE_EXTENDED
1092 char addch_work[(MB_LEN_MAX * 9) + 1];
1093 unsigned addch_used; /* number of bytes in addch_work[] */
1094 int addch_x; /* x-position for addch_work[] */
1095 int addch_y; /* y-position for addch_work[] */
1099 #define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)
1101 #define SP_PRE_INIT(sp) \
1102 sp->_cursrow = -1; \
1103 sp->_curscol = -1; \
1108 sp->_fifohead = -1; \
1109 sp->_endwin = TRUE; \
1111 WindowList(sp) = 0; \
1112 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1115 /* usually in <limits.h> */
1117 #define UCHAR_MAX 255
1120 /* The terminfo source is assumed to be 7-bit ASCII */
1121 #define is7bits(c) ((unsigned)(c) < 128)
1123 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1124 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1127 #define min(a,b) ((a) > (b) ? (b) : (a))
1131 #define max(a,b) ((a) < (b) ? (b) : (a))
1134 /* usually in <unistd.h> */
1135 #ifndef STDIN_FILENO
1136 #define STDIN_FILENO 0
1139 #ifndef STDOUT_FILENO
1140 #define STDOUT_FILENO 1
1143 #ifndef STDERR_FILENO
1144 #define STDERR_FILENO 2
1147 #ifndef EXIT_SUCCESS
1148 #define EXIT_SUCCESS 0
1151 #ifndef EXIT_FAILURE
1152 #define EXIT_FAILURE 1
1156 #define R_OK 4 /* Test for read permission. */
1159 #define W_OK 2 /* Test for write permission. */
1162 #define X_OK 1 /* Test for execute permission. */
1165 #define F_OK 0 /* Test for existence. */
1169 #include <fcntl.h> /* may define O_BINARY */
1178 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1180 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1183 #define COUNT_OUTCHARS(n) /* nothing */
1186 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1188 #define UChar(c) ((unsigned char)(c))
1189 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1190 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1193 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1196 #if USE_WIDEC_SUPPORT /* { */
1197 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1199 #define init_mb(state) memset(&state, 0, sizeof(state))
1201 #if NCURSES_EXT_COLORS
1202 #define NulColor , 0
1204 #define NulColor /* nothing */
1207 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1208 #define CharOf(c) ((c).chars[0])
1209 #define AttrOf(c) ((c).attr)
1211 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1212 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1213 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1215 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1216 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1219 #define CharEq(a,b) (((a).attr == (b).attr) \
1220 && (a).chars[0] == (b).chars[0] \
1221 && (a).chars[1] == (b).chars[1] \
1222 && (a).chars[2] == (b).chars[2] \
1223 && (a).chars[3] == (b).chars[3] \
1224 && (a).chars[4] == (b).chars[4] \
1225 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1227 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1230 #define SetChar(ch,c,a) do { \
1231 NCURSES_CH_T *_cp = &ch; \
1232 memset(_cp, 0, sizeof(ch)); \
1233 _cp->chars[0] = (c); \
1235 if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a))); \
1237 #define CHREF(wch) (&wch)
1238 #define CHDEREF(wch) (*wch)
1239 #define ARG_CH_T NCURSES_CH_T *
1240 #define CARG_CH_T const NCURSES_CH_T *
1241 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1242 mbstate_t PUT_st; wchar_t PUTC_ch
1243 #define PUTC_INIT init_mb (PUT_st)
1244 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1245 if (Charable(ch)) { \
1246 fputc(CharOf(ch), b); \
1247 COUNT_OUTCHARS(1); \
1250 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1251 PUTC_ch = (ch).chars[PUTC_i]; \
1252 if (PUTC_ch == L'\0') \
1254 PUTC_n = wcrtomb(PUTC_buf, \
1255 (ch).chars[PUTC_i], &PUT_st); \
1256 if (PUTC_n <= 0) { \
1257 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1261 IGNORE_RC(fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b)); \
1263 COUNT_OUTCHARS(PUTC_i); \
1266 #define BLANK NewChar2(' ', WA_NORMAL)
1267 #define ZEROS NewChar2('\0', WA_NORMAL)
1268 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1271 * Wide characters cannot be represented in the A_CHARTEXT mask of
1272 * attr_t's but an application might have set a narrow character there.
1273 * But even in that case, it would only be a printable character, or
1274 * zero. Otherwise we can use those bits to tell if a cell is the
1275 * first or extension part of a wide character.
1277 #define WidecExt(ch) (AttrOf(ch) & A_CHARTEXT)
1278 #define isWidecBase(ch) (WidecExt(ch) == 1)
1279 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1280 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1281 AttrOf(dst) |= (ext + 1)
1283 #define if_WIDEC(code) code
1284 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1285 || (AttrOf(ch) & A_ALTCHARSET) \
1286 || (!isWidecExt(ch) && \
1287 (ch).chars[1] == L'\0' && \
1288 _nc_is_charable(CharOf(ch))))
1290 #define L(ch) L ## ch
1292 #define CharOf(c) ChCharOf(c)
1293 #define AttrOf(c) ChAttrOf(c)
1294 #define AddAttr(c,a) c |= (a)
1295 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1296 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1297 #define NewChar(ch) (ch)
1298 #define NewChar2(c,a) ((c) | (a))
1299 #define CharEq(a,b) ((a) == (b))
1300 #define SetChar(ch,c,a) ch = (c) | (a)
1301 #define CHREF(wch) wch
1302 #define CHDEREF(wch) wch
1303 #define ARG_CH_T NCURSES_CH_T
1304 #define CARG_CH_T NCURSES_CH_T
1305 #define PUTC_DATA int data = 0
1306 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1308 #define BLANK (' '|A_NORMAL)
1309 #define ZEROS ('\0'|A_NORMAL)
1310 #define ISBLANK(ch) (CharOf(ch) == ' ')
1312 #define isWidecExt(ch) (0)
1313 #define if_WIDEC(code) /* nothing */
1318 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1319 #define CharOfD(ch) CharOf(CHDEREF(ch))
1320 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1322 #define BLANK_ATTR A_NORMAL
1323 #define BLANK_TEXT L(' ')
1327 #define LEGALYX(w, y, x) \
1329 ((x) >= 0 && (x) <= (w)->_maxx && \
1330 (y) >= 0 && (y) <= (w)->_maxy))
1332 #define CHANGED_CELL(line,col) \
1333 if (line->firstchar == _NOCHANGE) \
1334 line->firstchar = line->lastchar = col; \
1335 else if ((col) < line->firstchar) \
1336 line->firstchar = col; \
1337 else if ((col) > line->lastchar) \
1338 line->lastchar = col
1340 #define CHANGED_RANGE(line,start,end) \
1341 if (line->firstchar == _NOCHANGE \
1342 || line->firstchar > (start)) \
1343 line->firstchar = start; \
1344 if (line->lastchar == _NOCHANGE \
1345 || line->lastchar < (end)) \
1346 line->lastchar = end
1348 #define CHANGED_TO_EOL(line,start,end) \
1349 if (line->firstchar == _NOCHANGE \
1350 || line->firstchar > (start)) \
1351 line->firstchar = start; \
1352 line->lastchar = end
1354 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1356 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1358 /* FreeAndNull() is not a comma-separated expression because some compilers
1359 * do not accept a mixture of void with values.
1361 #define FreeAndNull(p) free(p); p = 0
1363 #include <nc_alloc.h>
1366 * TTY bit definition for converting tabs to spaces.
1369 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1372 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1375 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1377 # define OFLAGS_TABS 0
1383 * Standardize/simplify common loops
1385 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1386 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1387 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1390 * Prefixes for call/return points of library function traces. We use these to
1391 * instrument the public functions so that the traces can be easily transformed
1392 * into regression scripts.
1394 #define T_CALLED(fmt) "called {" fmt
1395 #define T_CREATE(fmt) "create :" fmt
1396 #define T_RETURN(fmt) "return }" fmt
1401 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1403 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1406 #define START_TRACE() \
1407 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1408 int t = _nc_getenv_num("NCURSES_TRACE"); \
1410 trace((unsigned) t); \
1414 * Many of the _tracef() calls use static buffers; lock the trace state before
1415 * trying to fill them.
1418 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1419 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1420 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1422 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1423 #define _nc_locked_tracef _tracef
1426 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1427 #define T(a) TR(TRACE_CALLS, a)
1428 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1430 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1431 #define returnBits(code) TRACE_RETURN(code,unsigned)
1432 #define returnBool(code) TRACE_RETURN(code,bool)
1433 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1434 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1435 #define returnChtype(code) TRACE_RETURN(code,chtype)
1436 #define returnCode(code) TRACE_RETURN(code,int)
1437 #define returnPtr(code) TRACE_RETURN(code,ptr)
1438 #define returnSP(code) TRACE_RETURN(code,sp)
1439 #define returnVoid T((T_RETURN(""))); return
1440 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1441 #define returnWin(code) TRACE_RETURN(code,win)
1443 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
1444 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1445 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1446 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1447 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1448 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1449 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1450 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1451 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1452 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1453 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1454 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1455 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1456 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1457 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1460 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1461 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1462 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1463 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1464 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1465 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1467 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1468 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1471 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1473 #if USE_WIDEC_SUPPORT
1474 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1475 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1478 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1479 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1483 #define START_TRACE() /* nothing */
1487 #define TPUTS_TRACE(s)
1489 #define returnAttr(code) return code
1490 #define returnBits(code) return code
1491 #define returnBool(code) return code
1492 #define returnCPtr(code) return code
1493 #define returnCVoidPtr(code) return code
1494 #define returnChtype(code) return code
1495 #define returnCode(code) return code
1496 #define returnPtr(code) return code
1497 #define returnSP(code) return code
1498 #define returnVoid return
1499 #define returnVoidPtr(code) return code
1500 #define returnWin(code) return code
1502 #endif /* TRACE/!TRACE */
1505 * Workaround for defective implementation of gcc attribute warn_unused_result
1507 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1508 #define IGNORE_RC(func) errno = func
1510 #define IGNORE_RC(func) (void) func
1511 #endif /* gcc workarounds */
1514 * Return-codes for tgetent() and friends.
1516 #define TGETENT_YES 1 /* entry is found */
1517 #define TGETENT_NO 0 /* entry is not found */
1518 #define TGETENT_ERR -1 /* an error occurred */
1520 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1521 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1523 #define EMPTY_MODULE(name) \
1524 extern NCURSES_EXPORT(void) name (void); \
1525 NCURSES_EXPORT(void) name (void) { }
1527 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1528 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1529 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1531 #define toggle_attr_on(S,at) {\
1532 if (PAIR_NUMBER(at) > 0) {\
1533 (S) = ((S) & ALL_BUT_COLOR) | (at);\
1537 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1540 #define toggle_attr_off(S,at) {\
1541 if (PAIR_NUMBER(at) > 0) {\
1542 (S) &= ~(at|A_COLOR);\
1546 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1548 #define DelCharCost(sp,count) \
1551 : ((delete_character != 0) \
1552 ? (sp->_dch1_cost * count) \
1555 #define InsCharCost(sp,count) \
1558 : ((enter_insert_mode && exit_insert_mode) \
1559 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1560 : ((insert_character != 0) \
1561 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1565 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1566 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1567 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1568 if (magic_cookie_glitch > 0 \
1569 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1570 T(("%s @%d before glitch %d,%d", \
1571 __FILE__, __LINE__, \
1574 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1578 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) \
1579 VIDATTR(sp, AttrOf(c), GetPair(c));
1583 * Macros to make additional parameter to implement wgetch_events()
1585 #ifdef NCURSES_WGETCH_EVENTS
1586 #define EVENTLIST_0th(param) param
1587 #define EVENTLIST_1st(param) param
1588 #define EVENTLIST_2nd(param) , param
1590 #define EVENTLIST_0th(param) void
1591 #define EVENTLIST_1st(param) /* nothing */
1592 #define EVENTLIST_2nd(param) /* nothing */
1595 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1597 #undef toggle_attr_on
1598 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1599 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1601 #undef toggle_attr_off
1602 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1603 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1606 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1609 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1611 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1612 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1615 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1617 #if defined(NEED_NCURSES_CH_T)
1618 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1620 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1623 #if NCURSES_SP_FUNCS
1624 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1625 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1626 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1627 #endif /* NCURSES_SP_FUNCS */
1631 extern NCURSES_EXPORT(void) _nc_expanded (void);
1635 #if !NCURSES_EXT_FUNCS
1636 #define set_escdelay(value) ESCDELAY = value
1640 #define getcwd(buf,len) getwd(buf)
1644 #if USE_WIDEC_SUPPORT
1645 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1646 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1647 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1652 short nte_name; /* offset of name to hash on */
1653 int nte_type; /* BOOLEAN, NUMBER or STRING */
1654 short nte_index; /* index of associated variable in its array */
1655 short nte_link; /* index in table of next hash, or -1 */
1667 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1671 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1672 extern NCURSES_EXPORT(void) _nc_linedump (void);
1676 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1677 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1680 #if USE_WIDEC_SUPPORT
1681 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1685 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1686 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1690 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1693 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1696 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1699 #define INFINITY 1000000 /* cost: too high to use */
1701 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1702 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1703 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1705 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1707 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1708 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1709 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1712 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1715 #define INFINITY 1000000 /* cost: too high to use */
1716 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1719 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1720 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1721 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1722 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1723 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, char);
1725 /* lib_set_term.c */
1726 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1730 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1732 #define _nc_handle_sigwinch(a) /* nothing */
1736 #if USE_WIDEC_SUPPORT
1737 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1741 char *s_head; /* beginning of the string (may be null) */
1742 char *s_tail; /* end of the string (may be null) */
1743 size_t s_size; /* current remaining size available */
1744 size_t s_init; /* total size available */
1748 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1749 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1750 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1751 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1752 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1755 #define strstr _nc_strstr
1756 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1759 /* safe_sprintf.c */
1760 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1763 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1764 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1765 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1766 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1769 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1770 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1771 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1772 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1773 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1774 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1775 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1776 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1777 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1778 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1779 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1780 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1781 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1782 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1783 extern NCURSES_EXPORT(int) _nc_outch (int);
1784 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1785 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1786 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1787 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1788 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1789 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, NCURSES_OUTC);
1790 extern NCURSES_EXPORT(void) _nc_flush (void);
1791 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1792 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1793 extern NCURSES_EXPORT(void) _nc_freeall (void);
1794 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1795 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1796 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1797 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1798 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1799 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1800 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1801 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1802 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1803 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1806 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1807 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1808 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1809 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1810 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1811 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1812 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1813 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1817 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1818 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1819 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1822 #if USE_WIDEC_SUPPORT
1823 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1826 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1827 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1831 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1835 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1837 #define _nc_resize_margins(wp) /* nothing */
1840 #ifdef NCURSES_WGETCH_EVENTS
1841 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1843 #define wgetch_events(win, evl) wgetch(win)
1844 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1848 * Wide-character macros to hide some platform-differences.
1850 #if USE_WIDEC_SUPPORT
1851 #if HAVE_MBTOWC && HAVE_MBLEN
1852 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
1853 #define count_mbytes(buffer,length,state) mblen(buffer,length)
1854 #define check_mbytes(wch,buffer,length,state) \
1855 (int) mbtowc(&wch, buffer, length)
1856 #define state_unused
1857 #elif HAVE_MBRTOWC && HAVE_MBRLEN
1858 #define reset_mbytes(state) init_mb(state)
1859 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
1860 #define check_mbytes(wch,buffer,length,state) \
1861 (int) mbrtowc(&wch, buffer, length, &state)
1868 * Not everyone has vsscanf(), but we'd like to use it for scanw().
1871 extern int vsscanf(const char *str, const char *format, va_list __arg);
1874 /* scroll indices */
1875 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1877 #define USE_SETBUF_0 0
1879 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
1881 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
1884 * On systems with a broken linker, define 'SP' as a function to force the
1885 * linker to pull in the data-only module with 'SP'.
1887 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
1890 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1891 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1892 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1893 #define CURRENT_SCREEN _nc_screen()
1895 /* current screen is private data; avoid possible linking conflicts too */
1896 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1897 #define CURRENT_SCREEN SP
1898 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
1899 #define _nc_set_screen(sp) SP = sp
1902 #if NCURSES_SP_FUNCS
1903 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
1905 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
1909 * We don't want to use the lines or columns capabilities internally, because
1910 * if the application is running multiple screens under X, it's quite possible
1911 * they could all have type xterm but have different sizes! So...
1913 #define screen_lines(sp) (sp)->_lines
1914 #define screen_columns(sp) (sp)->_columns
1916 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1917 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
1920 * Some constants related to SLK's
1922 #define MAX_SKEY_OLD 8 /* count of soft keys */
1923 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
1924 #define MAX_SKEY_PC 12 /* This is what most PC's have */
1925 #define MAX_SKEY_LEN_PC 5
1927 /* Macro to check whether or not we use a standard format */
1928 #define SLK_STDFMT(fmt) (fmt < 3)
1929 /* Macro to determine height of label window */
1930 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1932 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1933 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1936 * Common error messages
1938 #define MSG_NO_MEMORY "Out of memory"
1939 #define MSG_NO_INPUTS "Premature EOF"
1941 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
1942 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
1944 /* timed_wait flag definitions */
1948 #define TW_ANY (TW_INPUT | TW_MOUSE)
1951 #define SetSafeOutcWrapper(outc) \
1952 SCREEN* sp = CURRENT_SCREEN; \
1954 struct screen dummy; \
1956 memset(sp,0,sizeof(struct screen)); \
1957 sp->_outch = _nc_outc_wrapper; \
1961 #ifdef USE_TERM_DRIVER
1962 struct DriverTCB; /* Terminal Control Block forward declaration */
1963 typedef void* TERM_HANDLE;
1965 typedef struct _termInfo
1983 const color_t* defaultPalette;
1986 typedef struct term_driver {
1988 bool (*CanHandle)(struct DriverTCB*,const char*,int*);
1989 void (*init)(struct DriverTCB*);
1990 void (*release)(struct DriverTCB*);
1991 int (*size)(struct DriverTCB*, int* Line, int *Cols);
1992 int (*sgmode)(struct DriverTCB*, bool setFlag, TTY*);
1993 chtype (*conattr)(struct DriverTCB*);
1994 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
1995 int (*mode)(struct DriverTCB*, bool progFlag, bool defFlag);
1996 bool (*rescol)(struct DriverTCB*);
1997 bool (*rescolors)(struct DriverTCB*);
1998 void (*color)(struct DriverTCB*,bool fore, int color, int(*)(SCREEN*,int));
1999 int (*doBeepOrFlash)(struct DriverTCB*, bool);
2000 void (*initpair)(struct DriverTCB*,short,short,short);
2001 void (*initcolor)(struct DriverTCB*,short,short,short,short);
2002 void (*docolor)(struct DriverTCB*,short,short,bool,int(*)(SCREEN*,int));
2003 void (*initmouse)(struct DriverTCB*);
2004 void (*setfilter)(struct DriverTCB*);
2005 void (*hwlabel)(struct DriverTCB*,int,char*);
2006 void (*hwlabelOnOff)(struct DriverTCB*,bool);
2007 int (*update)(struct DriverTCB*);
2008 int (*defaultcolors)(struct DriverTCB*,int,int);
2009 int (*print)(struct DriverTCB*,char*,int);
2010 int (*getsize)(struct DriverTCB*,int*,int*);
2011 int (*setsize)(struct DriverTCB*,int,int);
2012 void (*initacs)(struct DriverTCB*,chtype*,chtype*);
2013 void (*scinit)(SCREEN *);
2014 void (*scexit)(SCREEN *);
2015 int (*twait)(struct DriverTCB*,int,int,int* EVENTLIST_2nd(_nc_eventlist*));
2016 int (*read)(struct DriverTCB*,int*);
2017 int (*nap)(struct DriverTCB*,int);
2018 int (*kpad)(struct DriverTCB*, bool);
2019 int (*kyOk)(struct DriverTCB*, int, bool);
2020 bool (*kyExist)(struct DriverTCB*, int);
2023 typedef struct DriverTCB
2025 TERMINAL term; /* needs to be the first Element !!! */
2026 TERM_HANDLE inp; /* The input handle of the Terminal */
2027 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2028 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2029 TERM_DRIVER* drv; /* The driver for that Terminal */
2030 SCREEN* csp; /* The screen that owns that Terminal */
2031 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2032 void* prop; /* Driver dependent property storage to be used by the Driver */
2034 } TERMINAL_CONTROL_BLOCK;
2036 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2037 #define NCDRV_TINFO 0x01
2038 #define NCDRV_WINCONSOLE 0x02
2040 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2041 #define InfoOf(sp) TCBOf(sp)->info
2042 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2043 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2044 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2045 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2046 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2048 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2049 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2051 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2052 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2053 #endif /* USE_TERM_DRIVER */
2056 * Entrypoints which are actually provided in the terminal driver, which would
2057 * be an sp-name otherwise.
2059 #ifdef USE_TERM_DRIVER
2060 #define TINFO_HAS_KEY _nc_tinfo_has_key
2061 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2062 #define TINFO_MVCUR _nc_tinfo_mvcur
2063 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2064 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2065 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2067 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2068 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2069 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2073 * Entrypoints using an extra parameter with the terminal driver.
2075 #ifdef USE_TERM_DRIVER
2076 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2077 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, bool);
2078 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2079 _nc_get_screensize(sp, tp, lp, cp)
2080 #define TINFO_SET_CURTERM(sp, tp) \
2081 NCURSES_SP_NAME(set_curterm)(sp, tp)
2082 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2083 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2084 #else /* !USE_TERM_DRIVER */
2085 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2086 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2087 _nc_get_screensize(sp, lp, cp)
2088 #define TINFO_SET_CURTERM(sp, tp) \
2090 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2091 _nc_setupterm(name, fd, err, reuse)
2092 #endif /* !USE_TERM_DRIVER */
2094 #ifdef USE_TERM_DRIVER
2096 #include <nc_mingw.h>
2097 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2099 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2102 #ifdef USE_TERM_DRIVER
2103 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2105 #define IsTermInfo(sp) TRUE
2108 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2109 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2112 * Exported entrypoints beyond the published API
2114 #if NCURSES_SP_FUNCS
2115 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2116 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2117 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2118 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2121 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2122 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2125 #if NCURSES_EXT_FUNCS
2126 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2130 * We put the safe versions of various calls here as they are not published
2131 * part of the API up to now
2133 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2134 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2135 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2136 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2137 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2138 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2139 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2140 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2141 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2142 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2143 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2144 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2145 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2146 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2147 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2148 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2149 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2150 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2151 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2152 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2153 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, bool, int);
2154 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2155 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2156 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2157 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2158 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, short, short, bool, NCURSES_SP_OUTC);
2159 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2160 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2161 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2162 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2163 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2164 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2165 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2166 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2167 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2168 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2169 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2170 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2171 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2172 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2173 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2174 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, bool);
2176 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2178 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2179 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2182 #if USE_WIDEC_SUPPORT
2183 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2186 #endif /* NCURSES_SP_FUNCS */
2188 #if NCURSES_SP_FUNCS
2190 #define safe_keyname NCURSES_SP_NAME(keyname)
2191 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2192 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2196 #define safe_keyname _nc_keyname
2197 #define safe_unctrl _nc_unctrl
2198 #define safe_ungetch _nc_ungetch
2200 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2201 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2202 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2210 #endif /* CURSES_PRIV_H */