1 /****************************************************************************
2 * Copyright (c) 1998-2009,2010 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.450 2010/01/23 22:05:30 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*/
64 #include <stddef.h> /* for offsetof */
67 #include <sys/types.h>
73 #if HAVE_SYS_BSDTYPES_H
74 #include <sys/bsdtypes.h> /* needed for ISC */
79 #elif HAVE_SYS_PARAM_H
80 # include <sys/param.h>
89 # if defined(_POSIX_PATH_MAX)
90 # define PATH_MAX _POSIX_PATH_MAX
91 # elif defined(MAXPATHLEN)
92 # define PATH_MAX MAXPATHLEN
94 # define PATH_MAX 255 /* the Posix minimum path-size */
102 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
103 #if HAVE_WORKING_POLL
104 #define USE_FUNC_POLL 1
108 #include <sys/poll.h>
111 #define USE_FUNC_POLL 0
114 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
117 /* Alessandro Rubini's GPM (general-purpose mouse) */
118 #if HAVE_LIBGPM && HAVE_GPM_H
119 #define USE_GPM_SUPPORT 1
121 #define USE_GPM_SUPPORT 0
124 /* QNX mouse support */
125 #if defined(__QNX__) && !defined(__QNXNTO__)
126 #define USE_QNX_MOUSE 1
128 #define USE_QNX_MOUSE 0
131 /* EMX mouse support */
133 #define USE_EMX_MOUSE 1
135 #define USE_EMX_MOUSE 0
138 #define DEFAULT_MAXCLICK 166
139 #define EV_MAX 8 /* size of mouse circular event queue */
142 * If we don't have signals to support it, don't add a sigwinch handler.
143 * In any case, resizing is an extended feature. Use it if we've got it.
145 #if !NCURSES_EXT_FUNCS
146 #undef HAVE_SIZECHANGE
147 #define HAVE_SIZECHANGE 0
150 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
151 #define USE_SIZECHANGE 1
153 #define USE_SIZECHANGE 0
155 #define USE_SIGWINCH 0
159 * If desired, one can configure this, disabling environment variables that
160 * point to custom terminfo/termcap locations.
162 #ifdef USE_ROOT_ENVIRON
163 #define use_terminfo_vars() 1
165 #define use_terminfo_vars() _nc_env_access()
166 extern NCURSES_EXPORT(int) _nc_env_access (void);
170 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
174 #define memmove(d,s,n) bcopy(s,d,n)
176 #define memmove(d,s,n) _nc_memmove(d,s,n)
177 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
181 * Scroll hints are useless when hashmap is used
183 #if !USE_SCROLL_HINTS
185 #define USE_SCROLL_HINTS 1
187 #define USE_SCROLL_HINTS 0
192 #define if_USE_SCROLL_HINTS(stmt) stmt
194 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
198 * Options for terminal drivers, etc...
200 #ifdef USE_TERM_DRIVER
201 #define USE_SP_RIPOFF 1
202 #define USE_SP_TERMTYPE 1
203 #define USE_SP_WINDOWLIST 1
207 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
208 * when we're throwing control codes at the screen at high volume. To see
209 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
210 * probably don't want to define this either due to uncertainties about tab
211 * delays and expansion in raw mode.
214 #define TRIES struct tries
216 TRIES *child; /* ptr to child. NULL if none */
217 TRIES *sibling; /* ptr to sibling. NULL if none */
218 unsigned char ch; /* character at this node */
219 unsigned short value; /* code of string so far. 0 if none. */
224 * Common/troublesome character definitions
226 #define StringOf(ch) {ch, 0}
233 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
236 * Structure for palette tables
241 short red, green, blue; /* what color_content() returns */
242 short r, g, b; /* params to init_color() */
243 int init; /* true if we called init_color() */
247 #define MAXCOLUMNS 135
249 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
253 #define WINDOWLIST struct _win_list
255 #if USE_WIDEC_SUPPORT
256 #define _nc_bkgd _bkgrnd
258 #undef _XOPEN_SOURCE_EXTENDED
259 #define _nc_bkgd _bkgd
260 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
261 #define wbkgrnd wbkgd
264 #undef NCURSES_OPAQUE
265 #define NCURSES_INTERNALS 1
266 #define NCURSES_OPAQUE 0
268 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
271 * If curses.h did not expose the SCREEN-functions, then we do not need the
272 * parameter in the corresponding unextended functions.
275 #define SP_PARM sp /* use parameter */
276 #define NCURSES_SP_ARG SP_PARM
277 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
278 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
279 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
280 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
282 #define SP_PARM SP /* use global variable */
283 #define NCURSES_SP_ARG
284 #define NCURSES_SP_DCL
285 #define NCURSES_SP_DCL0 void
286 #define NCURSES_SP_ARGx
287 #define NCURSES_SP_DCLx
290 #include <nc_panel.h>
292 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
293 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
294 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
296 #if BROKEN_LINKER || USE_REENTRANT
297 #define CurTerm _nc_prescreen._cur_term
299 #define CurTerm cur_term
303 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
305 #define TerminalOf(sp) CurTerm
311 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
312 * pointer to this data.
314 #ifdef USE_SP_TERMTYPE
318 #define SP_TERMTYPE TerminalOf(sp)->type.
320 #include <term_entry.h>
322 #include <nc_tparm.h>
324 #if NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT
325 #define if_EXT_COLORS(stmt) stmt
326 #define NetPair(value,p) (value).ext_color = (p), \
327 AttrOf(value) &= ALL_BUT_COLOR, \
328 AttrOf(value) |= (A_COLOR & COLOR_PAIR((p > 255) ? 255 : p))
329 #define SetPair(value,p) (value).ext_color = (p)
330 #define GetPair(value) (value).ext_color
331 #define unColor(n) (AttrOf(n) & ALL_BUT_COLOR)
332 #define GET_WINDOW_PAIR(w) (w)->_color
333 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
334 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
337 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
339 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
342 #else /* !(NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT) */
344 #define if_EXT_COLORS(stmt) /* nothing */
345 #define SetPair(value,p) RemAttr(value, A_COLOR), \
346 SetAttr(value, AttrOf(value) | (A_COLOR & COLOR_PAIR(p)))
347 #define GetPair(value) PAIR_NUMBER(AttrOf(value))
348 #define unColor(n) (AttrOf(n) & ALL_BUT_COLOR)
349 #define GET_WINDOW_PAIR(w) PAIR_NUMBER(WINDOW_ATTRS(w))
350 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
351 WINDOW_ATTRS(w) |= (A_COLOR & COLOR_PAIR(p))
352 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
355 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
357 #define VIDATTR(sp,attr,pair) vidattr(attr)
360 #endif /* NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT */
362 #if NCURSES_NO_PADDING
363 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
364 #define SetNoPadding(sp) _nc_set_no_padding(sp)
365 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
367 #define GetNoPadding(sp) FALSE
368 #define SetNoPadding(sp) /*nothing*/
371 #define WINDOW_ATTRS(w) ((w)->_attrs)
373 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
374 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
375 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
377 #if USE_REENTRANT || NCURSES_SP_FUNCS
378 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
379 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
380 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
381 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
386 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
387 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
388 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
389 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
391 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
392 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
393 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
394 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
398 #define ptrLines(sp) &LINES
399 #define ptrCols(sp) &COLS
400 #define ptrTabsize(sp) &TABSIZE
401 #define ptrEscdelay(sp) &ESCDELAY
403 #define SET_LINES(value) LINES = value
404 #define SET_COLS(value) COLS = value
405 #define SET_TABSIZE(value) TABSIZE = value
406 #define SET_ESCDELAY(value) ESCDELAY = value
410 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
411 __FILE__, __LINE__, \
412 (unsigned long) (pthread_self()), \
413 data.__data.__lock, \
414 data.__data.__count, \
415 data.__data.__owner, \
416 data.__data.__kind, \
417 (data.__data.__nusers > 5) ? " OOPS " : "", \
418 data.__data.__nusers)
419 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
425 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
426 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
427 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
428 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
429 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
430 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
431 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
432 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
435 #error POSIX threads requires --enable-reentrant option
439 #if defined(__GNUC__)
440 # if defined __USE_ISOC99
441 # define _cat_pragma(exp) _Pragma(#exp)
442 # define _weak_pragma(exp) _cat_pragma(weak name)
444 # define _weak_pragma(exp)
446 # define _declare(name) __extension__ extern __typeof__(name) name
447 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
452 # if USE_WEAK_SYMBOLS
453 weak_symbol(pthread_sigmask);
454 weak_symbol(pthread_self);
455 weak_symbol(pthread_equal);
456 weak_symbol(pthread_mutex_init);
457 weak_symbol(pthread_mutex_lock);
458 weak_symbol(pthread_mutex_unlock);
459 weak_symbol(pthread_mutex_trylock);
460 weak_symbol(pthread_mutexattr_settype);
461 weak_symbol(pthread_mutexattr_init);
462 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
464 # define sigprocmask _nc_sigprocmask
469 #undef HAVE_NANOSLEEP
470 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
473 #else /* !USE_PTHREADS */
475 #define _nc_init_pthreads() /* nothing */
476 #define _nc_mutex_init(obj) /* nothing */
478 #define _nc_lock_global(name) /* nothing */
479 #define _nc_try_global(name) 0
480 #define _nc_unlock_global(name) /* nothing */
482 #endif /* USE_PTHREADS */
485 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
486 * So the locking is done in the non-sp-func (which calls the sp-func) rather
487 * than in the sp-func itself.
489 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
490 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
494 #define _nc_nonsp_lock_global(name) /* nothing */
495 #define _nc_nonsp_try_global(name) 0
496 #define _nc_nonsp_unlock_global(name) /* nothing */
498 #define _nc_sp_lock_global(name) _nc_lock_global(name)
499 #define _nc_sp_try_global(name) _nc_try_global(name)
500 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
504 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
505 #define _nc_nonsp_try_global(name) _nc_try_global(name)
506 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
508 #define _nc_sp_lock_global(name) /* nothing */
509 #define _nc_sp_try_global(name) 0
510 #define _nc_sp_unlock_global(name) /* nothing */
514 #if HAVE_GETTIMEOFDAY
515 # define PRECISE_GETTIME 1
516 # define TimeType struct timeval
518 # define PRECISE_GETTIME 0
519 # define TimeType time_t
523 * Definitions for color pairs
525 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
526 #define C_SHIFT 9 /* we need more bits than there are colors */
527 #define C_MASK ((1 << C_SHIFT) - 1)
528 #define PAIR_OF(fg, bg) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
529 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
530 #define BACK_OF(c) ((c) & C_MASK)
531 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
533 #define COLOR_DEFAULT C_MASK
535 #if defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T)
537 #undef NCURSES_CH_T /* this is not a termlib feature */
538 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
540 #endif /* USE_TERMLIB */
545 NCURSES_CH_T *text; /* text of the line */
546 NCURSES_SIZE_T firstchar; /* first changed character in the line */
547 NCURSES_SIZE_T lastchar; /* last changed character in the line */
548 NCURSES_SIZE_T oldindex; /* index of the line at last update */
550 #endif /* USE_TERMLIB */
553 M_XTERM = -1 /* use xterm's mouse tracking? */
554 ,M_NONE = 0 /* no mouse device */
559 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
564 * Structures for scrolling.
568 unsigned long hashval;
569 int oldcount, newcount;
570 int oldindex, newindex;
574 * Structures for soft labels.
583 char *ent_text; /* text for the label */
584 char *form_text; /* formatted text (left/center/...) */
585 int ent_x; /* x coordinate of this field */
586 char dirty; /* this label has changed */
587 char visible; /* field is visible */
590 typedef struct _SLK {
591 bool dirty; /* all labels have changed */
592 bool hidden; /* soft labels are hidden */
595 short maxlab; /* number of available labels */
596 short labcnt; /* number of allocated labels */
597 short maxlen; /* length of labels */
598 NCURSES_CH_T attr; /* soft label attribute */
601 #endif /* USE_TERMLIB */
604 WINDOW *win; /* the window used in the hook */
605 int line; /* lines to take, < 0 => from bottom*/
606 int (*hook)(WINDOW *, int); /* callback for user */
610 #undef buttons /* term.h defines this, and gpm uses it! */
614 /* link dynamically to GPM */
615 typedef int *TYPE_gpm_fd;
616 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
617 typedef int (*TYPE_Gpm_Close) (void);
618 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
620 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
621 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
622 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
623 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
625 /* link statically to GPM */
626 #define my_gpm_fd &gpm_fd
627 #define my_Gpm_Open Gpm_Open
628 #define my_Gpm_Close Gpm_Close
629 #define my_Gpm_GetEvent Gpm_GetEvent
630 #endif /* HAVE_LIBDL */
631 #endif /* USE_GPM_SUPPORT */
636 char *fix_sgr0; /* this holds the filtered sgr0 string */
637 char *last_bufp; /* help with fix_sgr0 leak */
641 #define TGETENT_MAX 4
662 const char *tparam_base;
664 STACK_FRAME stack[STACKSIZE];
674 int dynamic_var[NUM_VARS];
675 int static_vars[NUM_VARS];
684 * The filesystem database normally uses a single-letter for the lower level
685 * of directories. Use a hexadecimal code for filesystems which do not
686 * preserve mixed-case names.
688 #if MIXEDCASE_FILENAMES
689 #define LEAF_FMT "%c"
692 #define LEAF_FMT "%02x"
697 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
698 * could at most have 10 digits, and the mask contains no more than 32 bits
699 * with each bit representing less than 15 characters. Usually the whole
700 * string is less than 80 columns, but this buffer size is an absolute
703 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
704 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
706 #ifdef USE_TERM_DRIVER
707 struct DriverTCB; /* Terminal Control Block forward declaration */
708 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
710 #define INIT_TERM_DRIVER() /* nothing */
714 * Global data which is not specific to a screen.
717 SIG_ATOMIC_T have_sigwinch;
718 SIG_ATOMIC_T cleanup_nested;
723 const char *comp_sourcename;
726 bool have_tic_directory;
727 bool keep_tic_directory;
728 const char *tic_directory;
734 char **keyname_table;
739 size_t safeprint_used;
741 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
743 long tgetent_sequence;
745 #ifndef USE_SP_WINDOWLIST
746 WINDOWLIST *_nc_windowlist;
747 #define WindowList(sp) _nc_globals._nc_windowlist
750 #if USE_HOME_TERMINFO
754 #if !USE_SAFE_SPRINTF
759 #ifdef USE_TERM_DRIVER
760 int (*term_driver)(struct DriverTCB*, const char*, int*);
765 char trace_fname[PATH_MAX];
770 size_t tracearg_used;
772 TRACEBUF *tracebuf_ptr;
773 size_t tracebuf_used;
775 char tracechr_buf[40];
778 size_t tracedmp_used;
780 unsigned char *tracetry_buf;
781 size_t tracetry_used;
783 char traceatr_color_buf[2][80];
784 int traceatr_color_sel;
785 int traceatr_color_last;
786 #if !defined(USE_PTHREADS) && USE_REENTRANT
792 pthread_mutex_t mutex_curses;
793 pthread_mutex_t mutex_tst_tracef;
794 pthread_mutex_t mutex_tracef;
797 #define _nc_use_pthreads _nc_globals.use_pthreads
801 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
806 * Global data which can be swept up into a SCREEN when one is created.
807 * It may be modified before the next SCREEN is created.
812 attr_t previous_attr;
813 #ifndef USE_SP_RIPOFF
814 ripoff_t rippedoff[N_RIPS];
817 TPARM_STATE tparm_state;
818 TTY *saved_tty; /* savetty/resetty information */
819 #if NCURSES_NO_PADDING
820 bool _no_padding; /* flag to set if padding disabled */
822 NCURSES_SP_OUTC _outch; /* output handler if not putc */
823 #if BROKEN_LINKER || USE_REENTRANT
824 chtype *real_acs_map;
832 const char *_tputs_trace;
838 * Use screen-specific ripoff data (for softkeys) rather than global.
841 #define safe_ripoff_sp (sp)->rsp
842 #define safe_ripoff_stack (sp)->rippedoff
844 #define safe_ripoff_sp _nc_prescreen.rsp
845 #define safe_ripoff_stack _nc_prescreen.rippedoff
848 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
851 * The SCREEN structure.
855 int _ifd; /* input file ptr for screen */
856 FILE *_ofp; /* output file ptr for screen */
857 char *_setbuf; /* buffered I/O for output */
858 bool _filtered; /* filter() was called */
859 bool _buffered; /* setvbuf uses _setbuf data */
860 bool _prescreen; /* is in prescreen phase */
861 bool _use_env; /* LINES & COLS from environment? */
862 int _checkfd; /* filedesc for typeahead check */
863 TERMINAL *_term; /* terminal type information */
864 TTY _saved_tty; /* savetty/resetty information */
865 NCURSES_SIZE_T _lines; /* screen lines */
866 NCURSES_SIZE_T _columns; /* screen columns */
868 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
869 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
871 WINDOW *_curscr; /* current screen */
872 WINDOW *_newscr; /* virtual screen to be updated to */
873 WINDOW *_stdscr; /* screen's full-window context */
875 #define CurScreen(sp) (sp)->_curscr
876 #define NewScreen(sp) (sp)->_newscr
877 #define StdScreen(sp) (sp)->_stdscr
879 TRIES *_keytry; /* "Try" for use with keypad mode */
880 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
881 bool _tried; /* keypad mode was initialized */
882 bool _keypad_on; /* keypad mode is currently on */
884 bool _called_wgetch; /* check for recursion in wgetch() */
885 int _fifo[FIFO_SIZE]; /* input push-back buffer */
886 short _fifohead, /* head of fifo queue */
887 _fifotail, /* tail of fifo queue */
888 _fifopeek, /* where to peek for next char */
889 _fifohold; /* set if breakout marked */
891 int _endwin; /* are we out of window mode? */
892 NCURSES_CH_T *_current_attr; /* holds current attributes set */
893 int _coloron; /* is color enabled? */
894 int _color_defs; /* are colors modified */
895 int _cursor; /* visibility of the cursor */
896 int _cursrow; /* physical cursor row */
897 int _curscol; /* physical cursor column */
898 bool _notty; /* true if we cannot switch non-tty */
899 int _nl; /* True if NL -> CR/NL is on */
900 int _raw; /* True if in raw mode */
901 int _cbreak; /* 1 if in cbreak mode */
902 /* > 1 if in halfdelay mode */
903 int _echo; /* True if echo on */
904 int _use_meta; /* use the meta key? */
905 struct _SLK *_slk; /* ptr to soft key struct / NULL */
906 int slk_format; /* selected format for this screen */
907 /* cursor movement costs; units are 10ths of milliseconds */
908 #if NCURSES_NO_PADDING
909 bool _no_padding; /* flag to set if padding disabled */
911 int _char_padding; /* cost of character put */
912 int _cr_cost; /* cost of (carriage_return) */
913 int _cup_cost; /* cost of (cursor_address) */
914 int _home_cost; /* cost of (cursor_home) */
915 int _ll_cost; /* cost of (cursor_to_ll) */
917 int _ht_cost; /* cost of (tab) */
918 int _cbt_cost; /* cost of (backtab) */
919 #endif /* USE_HARD_TABS */
920 int _cub1_cost; /* cost of (cursor_left) */
921 int _cuf1_cost; /* cost of (cursor_right) */
922 int _cud1_cost; /* cost of (cursor_down) */
923 int _cuu1_cost; /* cost of (cursor_up) */
924 int _cub_cost; /* cost of (parm_cursor_left) */
925 int _cuf_cost; /* cost of (parm_cursor_right) */
926 int _cud_cost; /* cost of (parm_cursor_down) */
927 int _cuu_cost; /* cost of (parm_cursor_up) */
928 int _hpa_cost; /* cost of (column_address) */
929 int _vpa_cost; /* cost of (row_address) */
930 /* used in tty_update.c, must be chars */
931 int _ed_cost; /* cost of (clr_eos) */
932 int _el_cost; /* cost of (clr_eol) */
933 int _el1_cost; /* cost of (clr_bol) */
934 int _dch1_cost; /* cost of (delete_character) */
935 int _ich1_cost; /* cost of (insert_character) */
936 int _dch_cost; /* cost of (parm_dch) */
937 int _ich_cost; /* cost of (parm_ich) */
938 int _ech_cost; /* cost of (erase_chars) */
939 int _rep_cost; /* cost of (repeat_char) */
940 int _hpa_ch_cost; /* cost of (column_address) */
941 int _cup_ch_cost; /* cost of (cursor_address) */
942 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
943 int _inline_cost; /* cost of inline-move */
944 int _smir_cost; /* cost of (enter_insert_mode) */
945 int _rmir_cost; /* cost of (exit_insert_mode) */
946 int _ip_cost; /* cost of (insert_padding) */
947 /* used in lib_mvcur.c */
948 char * _address_cursor;
949 /* used in tty_update.c */
950 int _scrolling; /* 1 if terminal's smart enough to */
952 /* used in lib_color.c */
953 color_t *_color_table; /* screen's color palette */
954 int _color_count; /* count of colors in palette */
955 colorpair_t *_color_pairs; /* screen's color pair list */
956 int _pair_count; /* count of color pairs */
957 int _pair_limit; /* actual limit of color-pairs */
958 #if NCURSES_EXT_FUNCS
959 bool _default_color; /* use default colors */
960 bool _has_sgr_39_49; /* has ECMA default color support */
961 int _default_fg; /* assumed default foreground */
962 int _default_bg; /* assumed default background */
963 int _default_pairs; /* count pairs using default color */
965 chtype _ok_attributes; /* valid attributes for terminal */
966 chtype _xmc_suppress; /* attributes to suppress if xmc */
967 chtype _xmc_triggers; /* attributes to process if xmc */
968 chtype * _acs_map; /* the real alternate-charset map */
969 bool * _screen_acs_map;
972 /* used in lib_vidattr.c */
973 bool _use_rmso; /* true if we may use 'rmso' */
974 bool _use_rmul; /* true if we may use 'rmul' */
977 * These data correspond to the state of the idcok() and idlok()
978 * functions. A caveat is in order here: the XSI and SVr4
979 * documentation specify that these functions apply to the window which
980 * is given as an argument. However, ncurses implements this logic
981 * only for the newscr/curscr update process, _not_ per-window.
987 * These are the data that support the mouse interface.
989 bool _mouse_initialized;
990 MouseType _mouse_type;
992 bool (*_mouse_event) (SCREEN *);
993 bool (*_mouse_inline)(SCREEN *);
994 bool (*_mouse_parse) (SCREEN *, int);
995 void (*_mouse_resume)(SCREEN *);
996 void (*_mouse_wrap) (SCREEN *);
997 int _mouse_fd; /* file-descriptor, if any */
998 bool _mouse_active; /* true if initialized */
1000 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1001 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1002 MEVENT *_mouse_eventp; /* next free slot in event queue */
1005 bool _mouse_gpm_loaded;
1006 bool _mouse_gpm_found;
1009 TYPE_gpm_fd _mouse_gpm_fd;
1010 TYPE_Gpm_Open _mouse_Gpm_Open;
1011 TYPE_Gpm_Close _mouse_Gpm_Close;
1012 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1014 Gpm_Connect _mouse_gpm_connect;
1015 #endif /* USE_GPM_SUPPORT */
1019 int _emxmouse_thread;
1020 int _emxmouse_activated;
1021 char _emxmouse_buttons[4];
1025 MEVENT _sysmouse_fifo[FIFO_SIZE];
1028 int _sysmouse_char_width; /* character width */
1029 int _sysmouse_char_height; /* character height */
1030 int _sysmouse_old_buttons;
1031 int _sysmouse_new_buttons;
1035 * This supports automatic resizing
1038 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1042 * These are data that support the proper handling of the panel stack on an
1045 struct panelhook _panelHook;
1048 SCREEN *_next_screen;
1050 /* hashes for old and new lines */
1051 unsigned long *oldhash, *newhash;
1057 bool _cleanup; /* cleanup after int/quit signal */
1058 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1060 int _legacy_coding; /* see use_legacy_coding() */
1063 char _ttytype[NAMESIZE];
1070 const char *_tputs_trace;
1075 char tracechr_buf[40];
1076 char tracemse_buf[TRACEMSE_MAX];
1078 #ifdef USE_SP_WINDOWLIST
1079 WINDOWLIST* _windowlist;
1080 #define WindowList(sp) (sp)->_windowlist
1084 ripoff_t rippedoff[N_RIPS];
1088 * ncurses/ncursesw are the same up to this point.
1090 #if USE_WIDEC_SUPPORT
1091 /* recent versions of 'screen' have partially-working support for
1092 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1094 bool _screen_acs_fix;
1098 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1099 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1103 SCREEN *screen; /* screen containing the window */
1104 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1105 #ifdef _XOPEN_SOURCE_EXTENDED
1106 char addch_work[(MB_LEN_MAX * 9) + 1];
1107 unsigned addch_used; /* number of bytes in addch_work[] */
1108 int addch_x; /* x-position for addch_work[] */
1109 int addch_y; /* y-position for addch_work[] */
1113 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((char *)(w) - offsetof(WINDOWLIST, win)))->m)
1115 #define SP_PRE_INIT(sp) \
1116 sp->_cursrow = -1; \
1117 sp->_curscol = -1; \
1122 sp->_fifohead = -1; \
1123 sp->_endwin = TRUE; \
1125 WindowList(sp) = 0; \
1126 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1129 /* usually in <limits.h> */
1131 #define UCHAR_MAX 255
1134 /* The terminfo source is assumed to be 7-bit ASCII */
1135 #define is7bits(c) ((unsigned)(c) < 128)
1137 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1138 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1141 #define min(a,b) ((a) > (b) ? (b) : (a))
1145 #define max(a,b) ((a) < (b) ? (b) : (a))
1148 /* usually in <unistd.h> */
1149 #ifndef STDIN_FILENO
1150 #define STDIN_FILENO 0
1153 #ifndef STDOUT_FILENO
1154 #define STDOUT_FILENO 1
1157 #ifndef STDERR_FILENO
1158 #define STDERR_FILENO 2
1161 #ifndef EXIT_SUCCESS
1162 #define EXIT_SUCCESS 0
1165 #ifndef EXIT_FAILURE
1166 #define EXIT_FAILURE 1
1170 #define R_OK 4 /* Test for read permission. */
1173 #define W_OK 2 /* Test for write permission. */
1176 #define X_OK 1 /* Test for execute permission. */
1179 #define F_OK 0 /* Test for existence. */
1183 #include <fcntl.h> /* may define O_BINARY */
1192 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1194 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1197 #define COUNT_OUTCHARS(n) /* nothing */
1200 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1202 #define UChar(c) ((unsigned char)(c))
1203 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1204 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1207 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1210 #if USE_WIDEC_SUPPORT /* { */
1211 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1213 #define init_mb(state) memset(&state, 0, sizeof(state))
1215 #if NCURSES_EXT_COLORS
1216 #define NulColor , 0
1218 #define NulColor /* nothing */
1221 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1222 #define CharOf(c) ((c).chars[0])
1223 #define AttrOf(c) ((c).attr)
1225 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1226 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1227 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1229 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1230 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1233 #define CharEq(a,b) (((a).attr == (b).attr) \
1234 && (a).chars[0] == (b).chars[0] \
1235 && (a).chars[1] == (b).chars[1] \
1236 && (a).chars[2] == (b).chars[2] \
1237 && (a).chars[3] == (b).chars[3] \
1238 && (a).chars[4] == (b).chars[4] \
1239 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1241 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1244 #define SetChar(ch,c,a) do { \
1245 NCURSES_CH_T *_cp = &ch; \
1246 memset(_cp, 0, sizeof(ch)); \
1247 _cp->chars[0] = (c); \
1249 if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a))); \
1251 #define CHREF(wch) (&wch)
1252 #define CHDEREF(wch) (*wch)
1253 #define ARG_CH_T NCURSES_CH_T *
1254 #define CARG_CH_T const NCURSES_CH_T *
1255 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1256 mbstate_t PUT_st; wchar_t PUTC_ch
1257 #define PUTC_INIT init_mb (PUT_st)
1258 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1259 if (Charable(ch)) { \
1260 fputc(CharOf(ch), b); \
1261 COUNT_OUTCHARS(1); \
1264 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1265 PUTC_ch = (ch).chars[PUTC_i]; \
1266 if (PUTC_ch == L'\0') \
1268 PUTC_n = wcrtomb(PUTC_buf, \
1269 (ch).chars[PUTC_i], &PUT_st); \
1270 if (PUTC_n <= 0) { \
1271 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1275 IGNORE_RC(fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b)); \
1277 COUNT_OUTCHARS(PUTC_i); \
1280 #define BLANK NewChar2(' ', WA_NORMAL)
1281 #define ZEROS NewChar2('\0', WA_NORMAL)
1282 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1285 * Wide characters cannot be represented in the A_CHARTEXT mask of
1286 * attr_t's but an application might have set a narrow character there.
1287 * But even in that case, it would only be a printable character, or
1288 * zero. Otherwise we can use those bits to tell if a cell is the
1289 * first or extension part of a wide character.
1291 #define WidecExt(ch) (AttrOf(ch) & A_CHARTEXT)
1292 #define isWidecBase(ch) (WidecExt(ch) == 1)
1293 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1294 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1295 AttrOf(dst) |= (ext + 1)
1297 #define if_WIDEC(code) code
1298 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1299 || (AttrOf(ch) & A_ALTCHARSET) \
1300 || (!isWidecExt(ch) && \
1301 (ch).chars[1] == L'\0' && \
1302 _nc_is_charable(CharOf(ch))))
1304 #define L(ch) L ## ch
1306 #define CharOf(c) ChCharOf(c)
1307 #define AttrOf(c) ChAttrOf(c)
1308 #define AddAttr(c,a) c |= (a)
1309 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1310 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1311 #define NewChar(ch) (ch)
1312 #define NewChar2(c,a) ((c) | (a))
1313 #define CharEq(a,b) ((a) == (b))
1314 #define SetChar(ch,c,a) ch = (c) | (a)
1315 #define CHREF(wch) wch
1316 #define CHDEREF(wch) wch
1317 #define ARG_CH_T NCURSES_CH_T
1318 #define CARG_CH_T NCURSES_CH_T
1319 #define PUTC_DATA int data = 0
1320 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1322 #define BLANK (' '|A_NORMAL)
1323 #define ZEROS ('\0'|A_NORMAL)
1324 #define ISBLANK(ch) (CharOf(ch) == ' ')
1326 #define isWidecExt(ch) (0)
1327 #define if_WIDEC(code) /* nothing */
1332 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1333 #define CharOfD(ch) CharOf(CHDEREF(ch))
1334 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1336 #define BLANK_ATTR A_NORMAL
1337 #define BLANK_TEXT L(' ')
1341 #define LEGALYX(w, y, x) \
1343 ((x) >= 0 && (x) <= (w)->_maxx && \
1344 (y) >= 0 && (y) <= (w)->_maxy))
1346 #define CHANGED_CELL(line,col) \
1347 if (line->firstchar == _NOCHANGE) \
1348 line->firstchar = line->lastchar = col; \
1349 else if ((col) < line->firstchar) \
1350 line->firstchar = col; \
1351 else if ((col) > line->lastchar) \
1352 line->lastchar = col
1354 #define CHANGED_RANGE(line,start,end) \
1355 if (line->firstchar == _NOCHANGE \
1356 || line->firstchar > (start)) \
1357 line->firstchar = start; \
1358 if (line->lastchar == _NOCHANGE \
1359 || line->lastchar < (end)) \
1360 line->lastchar = end
1362 #define CHANGED_TO_EOL(line,start,end) \
1363 if (line->firstchar == _NOCHANGE \
1364 || line->firstchar > (start)) \
1365 line->firstchar = start; \
1366 line->lastchar = end
1368 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1370 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1372 /* FreeAndNull() is not a comma-separated expression because some compilers
1373 * do not accept a mixture of void with values.
1375 #define FreeAndNull(p) free(p); p = 0
1377 #include <nc_alloc.h>
1380 * TTY bit definition for converting tabs to spaces.
1383 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1386 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1389 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1391 # define OFLAGS_TABS 0
1397 * Standardize/simplify common loops
1399 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1400 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1401 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1404 * Prefixes for call/return points of library function traces. We use these to
1405 * instrument the public functions so that the traces can be easily transformed
1406 * into regression scripts.
1408 #define T_CALLED(fmt) "called {" fmt
1409 #define T_CREATE(fmt) "create :" fmt
1410 #define T_RETURN(fmt) "return }" fmt
1415 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1417 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1420 #define START_TRACE() \
1421 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1422 int t = _nc_getenv_num("NCURSES_TRACE"); \
1424 trace((unsigned) t); \
1428 * Many of the _tracef() calls use static buffers; lock the trace state before
1429 * trying to fill them.
1432 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1433 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1434 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1436 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1437 #define _nc_locked_tracef _tracef
1440 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1441 #define T(a) TR(TRACE_CALLS, a)
1442 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1444 #define NonNull(s) ((s) != 0 ? s : "<null>")
1446 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1447 #define returnBits(code) TRACE_RETURN(code,unsigned)
1448 #define returnBool(code) TRACE_RETURN(code,bool)
1449 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1450 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1451 #define returnChar(code) TRACE_RETURN(code,char)
1452 #define returnChtype(code) TRACE_RETURN(code,chtype)
1453 #define returnCode(code) TRACE_RETURN(code,int)
1454 #define returnPtr(code) TRACE_RETURN(code,ptr)
1455 #define returnSP(code) TRACE_RETURN(code,sp)
1456 #define returnVoid T((T_RETURN(""))); return
1457 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1458 #define returnWin(code) TRACE_RETURN(code,win)
1460 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
1461 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1462 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1463 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1464 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1465 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1466 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1467 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1468 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1469 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1470 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1471 extern NCURSES_EXPORT(char) _nc_retrace_char (char);
1472 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1473 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1474 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1475 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1478 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1479 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1480 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1481 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1482 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1483 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1485 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1486 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1489 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1491 #if USE_WIDEC_SUPPORT
1492 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1493 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1496 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1497 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1501 #define START_TRACE() /* nothing */
1505 #define TPUTS_TRACE(s)
1507 #define returnAttr(code) return code
1508 #define returnBits(code) return code
1509 #define returnBool(code) return code
1510 #define returnCPtr(code) return code
1511 #define returnCVoidPtr(code) return code
1512 #define returnChar(code) return ((char) code)
1513 #define returnChtype(code) return code
1514 #define returnCode(code) return code
1515 #define returnPtr(code) return code
1516 #define returnSP(code) return code
1517 #define returnVoid return
1518 #define returnVoidPtr(code) return code
1519 #define returnWin(code) return code
1521 #endif /* TRACE/!TRACE */
1524 * Workaround for defective implementation of gcc attribute warn_unused_result
1526 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1527 #define IGNORE_RC(func) errno = func
1529 #define IGNORE_RC(func) (void) func
1530 #endif /* gcc workarounds */
1533 * Return-codes for tgetent() and friends.
1535 #define TGETENT_YES 1 /* entry is found */
1536 #define TGETENT_NO 0 /* entry is not found */
1537 #define TGETENT_ERR -1 /* an error occurred */
1539 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1540 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1542 #define EMPTY_MODULE(name) \
1543 extern NCURSES_EXPORT(void) name (void); \
1544 NCURSES_EXPORT(void) name (void) { }
1546 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1547 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1548 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1550 #define toggle_attr_on(S,at) {\
1551 if (PAIR_NUMBER(at) > 0) {\
1552 (S) = ((S) & ALL_BUT_COLOR) | (at);\
1556 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1559 #define toggle_attr_off(S,at) {\
1560 if (PAIR_NUMBER(at) > 0) {\
1561 (S) &= ~(at|A_COLOR);\
1565 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1567 #define DelCharCost(sp,count) \
1570 : ((delete_character != 0) \
1571 ? (sp->_dch1_cost * count) \
1574 #define InsCharCost(sp,count) \
1577 : ((enter_insert_mode && exit_insert_mode) \
1578 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1579 : ((insert_character != 0) \
1580 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1584 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1585 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1586 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1587 if (magic_cookie_glitch > 0 \
1588 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1589 T(("%s @%d before glitch %d,%d", \
1590 __FILE__, __LINE__, \
1593 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1597 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) \
1598 VIDATTR(sp, AttrOf(c), GetPair(c));
1602 * Macros to make additional parameter to implement wgetch_events()
1604 #ifdef NCURSES_WGETCH_EVENTS
1605 #define EVENTLIST_0th(param) param
1606 #define EVENTLIST_1st(param) param
1607 #define EVENTLIST_2nd(param) , param
1609 #define EVENTLIST_0th(param) void
1610 #define EVENTLIST_1st(param) /* nothing */
1611 #define EVENTLIST_2nd(param) /* nothing */
1614 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1616 #undef toggle_attr_on
1617 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1618 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1620 #undef toggle_attr_off
1621 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1622 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1625 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1628 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1630 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1631 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1634 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1636 #if defined(NEED_NCURSES_CH_T)
1637 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1639 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1642 #if NCURSES_SP_FUNCS
1643 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1644 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1645 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1646 #endif /* NCURSES_SP_FUNCS */
1650 extern NCURSES_EXPORT(void) _nc_expanded (void);
1654 #if !NCURSES_EXT_FUNCS
1655 #define set_escdelay(value) ESCDELAY = value
1659 #define getcwd(buf,len) getwd(buf)
1663 #if USE_WIDEC_SUPPORT
1664 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1665 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1666 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1671 short nte_name; /* offset of name to hash on */
1672 int nte_type; /* BOOLEAN, NUMBER or STRING */
1673 short nte_index; /* index of associated variable in its array */
1674 short nte_link; /* index in table of next hash, or -1 */
1686 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1690 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1691 extern NCURSES_EXPORT(void) _nc_linedump (void);
1695 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1696 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1699 #if USE_WIDEC_SUPPORT
1700 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1704 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1705 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1709 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1712 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1715 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1718 #define INFINITY 1000000 /* cost: too high to use */
1720 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1721 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1722 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1724 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1726 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1727 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1728 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1731 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1734 #define INFINITY 1000000 /* cost: too high to use */
1735 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1738 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1739 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1740 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1741 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1742 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, char);
1744 /* lib_set_term.c */
1745 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1749 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1751 #define _nc_handle_sigwinch(a) /* nothing */
1755 #if USE_WIDEC_SUPPORT
1756 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1760 char *s_head; /* beginning of the string (may be null) */
1761 char *s_tail; /* end of the string (may be null) */
1762 size_t s_size; /* current remaining size available */
1763 size_t s_init; /* total size available */
1767 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1768 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1769 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1770 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1771 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1774 #define strstr _nc_strstr
1775 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1778 /* safe_sprintf.c */
1779 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1782 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1783 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1784 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1785 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1788 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1789 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1790 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1791 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1792 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1793 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1794 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1795 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1796 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1797 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1798 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1799 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1800 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1801 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1802 extern NCURSES_EXPORT(int) _nc_outch (int);
1803 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1804 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1805 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1806 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1807 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1808 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, NCURSES_OUTC);
1809 extern NCURSES_EXPORT(void) _nc_flush (void);
1810 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1811 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1812 extern NCURSES_EXPORT(void) _nc_freeall (void);
1813 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1814 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1815 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1816 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1817 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1818 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1819 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1820 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1821 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1822 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1825 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1826 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1827 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1828 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1829 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1830 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1831 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1832 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1836 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1837 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1838 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1841 #if USE_WIDEC_SUPPORT
1842 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1845 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1846 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1850 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1854 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1856 #define _nc_resize_margins(wp) /* nothing */
1859 #ifdef NCURSES_WGETCH_EVENTS
1860 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1862 #define wgetch_events(win, evl) wgetch(win)
1863 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1867 * Wide-character macros to hide some platform-differences.
1869 #if USE_WIDEC_SUPPORT
1870 #if HAVE_MBTOWC && HAVE_MBLEN
1871 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
1872 #define count_mbytes(buffer,length,state) mblen(buffer,length)
1873 #define check_mbytes(wch,buffer,length,state) \
1874 (int) mbtowc(&wch, buffer, length)
1875 #define state_unused
1876 #elif HAVE_MBRTOWC && HAVE_MBRLEN
1877 #define reset_mbytes(state) init_mb(state)
1878 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
1879 #define check_mbytes(wch,buffer,length,state) \
1880 (int) mbrtowc(&wch, buffer, length, &state)
1887 * Not everyone has vsscanf(), but we'd like to use it for scanw().
1890 extern int vsscanf(const char *str, const char *format, va_list __arg);
1893 /* scroll indices */
1894 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1896 #define USE_SETBUF_0 0
1898 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
1900 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
1903 * On systems with a broken linker, define 'SP' as a function to force the
1904 * linker to pull in the data-only module with 'SP'.
1906 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
1909 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1910 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1911 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1912 #define CURRENT_SCREEN _nc_screen()
1914 /* current screen is private data; avoid possible linking conflicts too */
1915 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1916 #define CURRENT_SCREEN SP
1917 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
1918 #define _nc_set_screen(sp) SP = sp
1921 #if NCURSES_SP_FUNCS
1922 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
1924 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
1928 * We don't want to use the lines or columns capabilities internally, because
1929 * if the application is running multiple screens under X, it's quite possible
1930 * they could all have type xterm but have different sizes! So...
1932 #define screen_lines(sp) (sp)->_lines
1933 #define screen_columns(sp) (sp)->_columns
1935 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1936 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
1939 * Some constants related to SLK's
1941 #define MAX_SKEY_OLD 8 /* count of soft keys */
1942 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
1943 #define MAX_SKEY_PC 12 /* This is what most PC's have */
1944 #define MAX_SKEY_LEN_PC 5
1946 /* Macro to check whether or not we use a standard format */
1947 #define SLK_STDFMT(fmt) (fmt < 3)
1948 /* Macro to determine height of label window */
1949 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1951 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1952 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1955 * Common error messages
1957 #define MSG_NO_MEMORY "Out of memory"
1958 #define MSG_NO_INPUTS "Premature EOF"
1960 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
1961 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
1963 /* timed_wait flag definitions */
1967 #define TW_ANY (TW_INPUT | TW_MOUSE)
1970 #define SetSafeOutcWrapper(outc) \
1971 SCREEN* sp = CURRENT_SCREEN; \
1973 struct screen dummy; \
1975 memset(sp,0,sizeof(struct screen)); \
1976 sp->_outch = _nc_outc_wrapper; \
1980 #ifdef USE_TERM_DRIVER
1981 typedef void* TERM_HANDLE;
1983 typedef struct _termInfo
2001 const color_t* defaultPalette;
2004 typedef struct term_driver {
2006 bool (*CanHandle)(struct DriverTCB*,const char*,int*);
2007 void (*init)(struct DriverTCB*);
2008 void (*release)(struct DriverTCB*);
2009 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2010 int (*sgmode)(struct DriverTCB*, bool setFlag, TTY*);
2011 chtype (*conattr)(struct DriverTCB*);
2012 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2013 int (*mode)(struct DriverTCB*, bool progFlag, bool defFlag);
2014 bool (*rescol)(struct DriverTCB*);
2015 bool (*rescolors)(struct DriverTCB*);
2016 void (*color)(struct DriverTCB*,bool fore, int color, int(*)(SCREEN*,int));
2017 int (*doBeepOrFlash)(struct DriverTCB*, bool);
2018 void (*initpair)(struct DriverTCB*,short,short,short);
2019 void (*initcolor)(struct DriverTCB*,short,short,short,short);
2020 void (*docolor)(struct DriverTCB*,short,short,bool,int(*)(SCREEN*,int));
2021 void (*initmouse)(struct DriverTCB*);
2022 void (*setfilter)(struct DriverTCB*);
2023 void (*hwlabel)(struct DriverTCB*,int,char*);
2024 void (*hwlabelOnOff)(struct DriverTCB*,bool);
2025 int (*update)(struct DriverTCB*);
2026 int (*defaultcolors)(struct DriverTCB*,int,int);
2027 int (*print)(struct DriverTCB*,char*,int);
2028 int (*getsize)(struct DriverTCB*,int*,int*);
2029 int (*setsize)(struct DriverTCB*,int,int);
2030 void (*initacs)(struct DriverTCB*,chtype*,chtype*);
2031 void (*scinit)(SCREEN *);
2032 void (*scexit)(SCREEN *);
2033 int (*twait)(struct DriverTCB*,int,int,int* EVENTLIST_2nd(_nc_eventlist*));
2034 int (*read)(struct DriverTCB*,int*);
2035 int (*nap)(struct DriverTCB*,int);
2036 int (*kpad)(struct DriverTCB*, bool);
2037 int (*kyOk)(struct DriverTCB*, int, bool);
2038 bool (*kyExist)(struct DriverTCB*, int);
2041 typedef struct DriverTCB
2043 TERMINAL term; /* needs to be the first Element !!! */
2044 TERM_HANDLE inp; /* The input handle of the Terminal */
2045 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2046 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2047 TERM_DRIVER* drv; /* The driver for that Terminal */
2048 SCREEN* csp; /* The screen that owns that Terminal */
2049 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2050 void* prop; /* Driver dependent property storage to be used by the Driver */
2052 } TERMINAL_CONTROL_BLOCK;
2054 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2055 #define NCDRV_TINFO 0x01
2056 #define NCDRV_WINCONSOLE 0x02
2058 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2059 #define InfoOf(sp) TCBOf(sp)->info
2060 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2061 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2062 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2063 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2064 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2066 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2067 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2069 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2070 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2071 #endif /* USE_TERM_DRIVER */
2074 * Entrypoints which are actually provided in the terminal driver, which would
2075 * be an sp-name otherwise.
2077 #ifdef USE_TERM_DRIVER
2078 #define TINFO_HAS_KEY _nc_tinfo_has_key
2079 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2080 #define TINFO_MVCUR _nc_tinfo_mvcur
2081 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2082 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2083 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2085 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2086 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2087 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2091 * Entrypoints using an extra parameter with the terminal driver.
2093 #ifdef USE_TERM_DRIVER
2094 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2095 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, bool);
2096 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2097 _nc_get_screensize(sp, tp, lp, cp)
2098 #define TINFO_SET_CURTERM(sp, tp) \
2099 NCURSES_SP_NAME(set_curterm)(sp, tp)
2100 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2101 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2102 #else /* !USE_TERM_DRIVER */
2103 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2104 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2105 _nc_get_screensize(sp, lp, cp)
2106 #define TINFO_SET_CURTERM(sp, tp) \
2108 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2109 _nc_setupterm(name, fd, err, reuse)
2110 #endif /* !USE_TERM_DRIVER */
2112 #ifdef USE_TERM_DRIVER
2114 #include <nc_mingw.h>
2115 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2117 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2120 #ifdef USE_TERM_DRIVER
2121 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2123 #define IsTermInfo(sp) TRUE
2126 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2127 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2130 * Exported entrypoints beyond the published API
2132 #if NCURSES_SP_FUNCS
2133 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2134 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2135 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2136 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2139 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2140 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2143 #if NCURSES_EXT_FUNCS
2144 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2148 * We put the safe versions of various calls here as they are not published
2149 * part of the API up to now
2151 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2152 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2153 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2154 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2155 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2156 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2157 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2158 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2159 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2160 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2161 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2162 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2163 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2164 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2165 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2166 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2167 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2168 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2169 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2170 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2171 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, bool, int);
2172 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2173 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2174 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2175 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2176 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, short, short, bool, NCURSES_SP_OUTC);
2177 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2178 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2179 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2180 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2181 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2182 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2183 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2184 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2185 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2186 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2187 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2188 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2189 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2190 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2191 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2192 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, bool);
2194 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2196 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2197 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2200 #if USE_WIDEC_SUPPORT
2201 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2204 #endif /* NCURSES_SP_FUNCS */
2206 #if NCURSES_SP_FUNCS
2208 #define safe_keyname NCURSES_SP_NAME(keyname)
2209 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2210 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2214 #define safe_keyname _nc_keyname
2215 #define safe_unctrl _nc_unctrl
2216 #define safe_ungetch _nc_ungetch
2218 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2219 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2220 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2228 #endif /* CURSES_PRIV_H */