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.452 2010/03/06 19:15:50 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 * If we have va_copy(), use it for assigning va_list's.
183 #if defined(HAVE___VA_COPY)
184 #define begin_va_copy(dst,src) __va_copy(dst, src)
185 #define end_va_copy(dst) va_end(dst)
186 #elif defined(va_copy) || defined(HAVE_VA_COPY)
187 #define begin_va_copy(dst,src) va_copy(dst, src)
188 #define end_va_copy(dst) va_end(dst)
190 #define begin_va_copy(dst,src) (dst) = (src)
191 #define end_va_copy(dst) /* nothing */
195 * Scroll hints are useless when hashmap is used
197 #if !USE_SCROLL_HINTS
199 #define USE_SCROLL_HINTS 1
201 #define USE_SCROLL_HINTS 0
206 #define if_USE_SCROLL_HINTS(stmt) stmt
208 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
212 * Options for terminal drivers, etc...
214 #ifdef USE_TERM_DRIVER
215 #define USE_SP_RIPOFF 1
216 #define USE_SP_TERMTYPE 1
217 #define USE_SP_WINDOWLIST 1
221 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
222 * when we're throwing control codes at the screen at high volume. To see
223 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
224 * probably don't want to define this either due to uncertainties about tab
225 * delays and expansion in raw mode.
228 #define TRIES struct tries
230 TRIES *child; /* ptr to child. NULL if none */
231 TRIES *sibling; /* ptr to sibling. NULL if none */
232 unsigned char ch; /* character at this node */
233 unsigned short value; /* code of string so far. 0 if none. */
238 * Common/troublesome character definitions
240 #define StringOf(ch) {ch, 0}
247 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
250 * Structure for palette tables
255 short red, green, blue; /* what color_content() returns */
256 short r, g, b; /* params to init_color() */
257 int init; /* true if we called init_color() */
261 #define MAXCOLUMNS 135
263 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
267 #define WINDOWLIST struct _win_list
269 #if USE_WIDEC_SUPPORT
270 #define _nc_bkgd _bkgrnd
272 #undef _XOPEN_SOURCE_EXTENDED
273 #define _nc_bkgd _bkgd
274 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
275 #define wbkgrnd wbkgd
278 #undef NCURSES_OPAQUE
279 #define NCURSES_INTERNALS 1
280 #define NCURSES_OPAQUE 0
282 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
285 * If curses.h did not expose the SCREEN-functions, then we do not need the
286 * parameter in the corresponding unextended functions.
289 #define SP_PARM sp /* use parameter */
290 #define NCURSES_SP_ARG SP_PARM
291 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
292 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
293 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
294 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
296 #define SP_PARM SP /* use global variable */
297 #define NCURSES_SP_ARG
298 #define NCURSES_SP_DCL
299 #define NCURSES_SP_DCL0 void
300 #define NCURSES_SP_ARGx
301 #define NCURSES_SP_DCLx
304 #include <nc_panel.h>
306 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
307 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
308 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
310 #if BROKEN_LINKER || USE_REENTRANT
311 #define CurTerm _nc_prescreen._cur_term
313 #define CurTerm cur_term
317 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
319 #define TerminalOf(sp) CurTerm
325 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
326 * pointer to this data.
328 #ifdef USE_SP_TERMTYPE
332 #define SP_TERMTYPE TerminalOf(sp)->type.
334 #include <term_entry.h>
336 #include <nc_tparm.h>
338 #if NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT
339 #define if_EXT_COLORS(stmt) stmt
340 #define NetPair(value,p) (value).ext_color = (p), \
341 AttrOf(value) &= ALL_BUT_COLOR, \
342 AttrOf(value) |= (A_COLOR & COLOR_PAIR((p > 255) ? 255 : p))
343 #define SetPair(value,p) (value).ext_color = (p)
344 #define GetPair(value) (value).ext_color
345 #define unColor(n) (AttrOf(n) & ALL_BUT_COLOR)
346 #define GET_WINDOW_PAIR(w) (w)->_color
347 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
348 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
351 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
353 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
356 #else /* !(NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT) */
358 #define if_EXT_COLORS(stmt) /* nothing */
359 #define SetPair(value,p) RemAttr(value, A_COLOR), \
360 SetAttr(value, AttrOf(value) | (A_COLOR & COLOR_PAIR(p)))
361 #define GetPair(value) PAIR_NUMBER(AttrOf(value))
362 #define unColor(n) (AttrOf(n) & ALL_BUT_COLOR)
363 #define GET_WINDOW_PAIR(w) PAIR_NUMBER(WINDOW_ATTRS(w))
364 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
365 WINDOW_ATTRS(w) |= (A_COLOR & COLOR_PAIR(p))
366 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
369 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
371 #define VIDATTR(sp,attr,pair) vidattr(attr)
374 #endif /* NCURSES_EXT_COLORS && USE_WIDEC_SUPPORT */
376 #if NCURSES_NO_PADDING
377 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
378 #define SetNoPadding(sp) _nc_set_no_padding(sp)
379 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
381 #define GetNoPadding(sp) FALSE
382 #define SetNoPadding(sp) /*nothing*/
385 #define WINDOW_ATTRS(w) ((w)->_attrs)
387 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
388 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
389 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
391 #if USE_REENTRANT || NCURSES_SP_FUNCS
392 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
393 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
394 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
395 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
400 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
401 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
402 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
403 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
405 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
406 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
407 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
408 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
412 #define ptrLines(sp) &LINES
413 #define ptrCols(sp) &COLS
414 #define ptrTabsize(sp) &TABSIZE
415 #define ptrEscdelay(sp) &ESCDELAY
417 #define SET_LINES(value) LINES = value
418 #define SET_COLS(value) COLS = value
419 #define SET_TABSIZE(value) TABSIZE = value
420 #define SET_ESCDELAY(value) ESCDELAY = value
424 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
425 __FILE__, __LINE__, \
426 (unsigned long) (pthread_self()), \
427 data.__data.__lock, \
428 data.__data.__count, \
429 data.__data.__owner, \
430 data.__data.__kind, \
431 (data.__data.__nusers > 5) ? " OOPS " : "", \
432 data.__data.__nusers)
433 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
439 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
440 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
441 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
442 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
443 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
444 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
445 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
446 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
449 #error POSIX threads requires --enable-reentrant option
453 #if defined(__GNUC__)
454 # if defined __USE_ISOC99
455 # define _cat_pragma(exp) _Pragma(#exp)
456 # define _weak_pragma(exp) _cat_pragma(weak name)
458 # define _weak_pragma(exp)
460 # define _declare(name) __extension__ extern __typeof__(name) name
461 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
466 # if USE_WEAK_SYMBOLS
467 weak_symbol(pthread_sigmask);
468 weak_symbol(pthread_self);
469 weak_symbol(pthread_equal);
470 weak_symbol(pthread_mutex_init);
471 weak_symbol(pthread_mutex_lock);
472 weak_symbol(pthread_mutex_unlock);
473 weak_symbol(pthread_mutex_trylock);
474 weak_symbol(pthread_mutexattr_settype);
475 weak_symbol(pthread_mutexattr_init);
476 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
478 # define sigprocmask _nc_sigprocmask
483 #undef HAVE_NANOSLEEP
484 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
487 #else /* !USE_PTHREADS */
489 #define _nc_init_pthreads() /* nothing */
490 #define _nc_mutex_init(obj) /* nothing */
492 #define _nc_lock_global(name) /* nothing */
493 #define _nc_try_global(name) 0
494 #define _nc_unlock_global(name) /* nothing */
496 #endif /* USE_PTHREADS */
499 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
500 * So the locking is done in the non-sp-func (which calls the sp-func) rather
501 * than in the sp-func itself.
503 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
504 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
508 #define _nc_nonsp_lock_global(name) /* nothing */
509 #define _nc_nonsp_try_global(name) 0
510 #define _nc_nonsp_unlock_global(name) /* nothing */
512 #define _nc_sp_lock_global(name) _nc_lock_global(name)
513 #define _nc_sp_try_global(name) _nc_try_global(name)
514 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
518 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
519 #define _nc_nonsp_try_global(name) _nc_try_global(name)
520 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
522 #define _nc_sp_lock_global(name) /* nothing */
523 #define _nc_sp_try_global(name) 0
524 #define _nc_sp_unlock_global(name) /* nothing */
528 #if HAVE_GETTIMEOFDAY
529 # define PRECISE_GETTIME 1
530 # define TimeType struct timeval
532 # define PRECISE_GETTIME 0
533 # define TimeType time_t
537 * Definitions for color pairs
539 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
540 #define C_SHIFT 9 /* we need more bits than there are colors */
541 #define C_MASK ((1 << C_SHIFT) - 1)
542 #define PAIR_OF(fg, bg) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
543 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
544 #define BACK_OF(c) ((c) & C_MASK)
545 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
547 #define COLOR_DEFAULT C_MASK
549 #if defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T)
551 #undef NCURSES_CH_T /* this is not a termlib feature */
552 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
554 #endif /* USE_TERMLIB */
559 NCURSES_CH_T *text; /* text of the line */
560 NCURSES_SIZE_T firstchar; /* first changed character in the line */
561 NCURSES_SIZE_T lastchar; /* last changed character in the line */
562 NCURSES_SIZE_T oldindex; /* index of the line at last update */
564 #endif /* USE_TERMLIB */
567 M_XTERM = -1 /* use xterm's mouse tracking? */
568 ,M_NONE = 0 /* no mouse device */
573 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
575 #ifdef USE_TERM_DRIVER
576 ,M_TERM_DRIVER /* Win32 console, etc */
581 * Structures for scrolling.
585 unsigned long hashval;
586 int oldcount, newcount;
587 int oldindex, newindex;
591 * Structures for soft labels.
600 char *ent_text; /* text for the label */
601 char *form_text; /* formatted text (left/center/...) */
602 int ent_x; /* x coordinate of this field */
603 char dirty; /* this label has changed */
604 char visible; /* field is visible */
607 typedef struct _SLK {
608 bool dirty; /* all labels have changed */
609 bool hidden; /* soft labels are hidden */
612 short maxlab; /* number of available labels */
613 short labcnt; /* number of allocated labels */
614 short maxlen; /* length of labels */
615 NCURSES_CH_T attr; /* soft label attribute */
618 #endif /* USE_TERMLIB */
621 WINDOW *win; /* the window used in the hook */
622 int line; /* lines to take, < 0 => from bottom*/
623 int (*hook)(WINDOW *, int); /* callback for user */
627 #undef buttons /* term.h defines this, and gpm uses it! */
631 /* link dynamically to GPM */
632 typedef int *TYPE_gpm_fd;
633 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
634 typedef int (*TYPE_Gpm_Close) (void);
635 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
637 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
638 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
639 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
640 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
642 /* link statically to GPM */
643 #define my_gpm_fd &gpm_fd
644 #define my_Gpm_Open Gpm_Open
645 #define my_Gpm_Close Gpm_Close
646 #define my_Gpm_GetEvent Gpm_GetEvent
647 #endif /* HAVE_LIBDL */
648 #endif /* USE_GPM_SUPPORT */
653 char *fix_sgr0; /* this holds the filtered sgr0 string */
654 char *last_bufp; /* help with fix_sgr0 leak */
658 #define TGETENT_MAX 4
679 const char *tparam_base;
681 STACK_FRAME stack[STACKSIZE];
691 int dynamic_var[NUM_VARS];
692 int static_vars[NUM_VARS];
701 * The filesystem database normally uses a single-letter for the lower level
702 * of directories. Use a hexadecimal code for filesystems which do not
703 * preserve mixed-case names.
705 #if MIXEDCASE_FILENAMES
706 #define LEAF_FMT "%c"
709 #define LEAF_FMT "%02x"
714 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
715 * could at most have 10 digits, and the mask contains no more than 32 bits
716 * with each bit representing less than 15 characters. Usually the whole
717 * string is less than 80 columns, but this buffer size is an absolute
720 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
721 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
723 #ifdef USE_TERM_DRIVER
724 struct DriverTCB; /* Terminal Control Block forward declaration */
725 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
727 #define INIT_TERM_DRIVER() /* nothing */
731 * Global data which is not specific to a screen.
734 SIG_ATOMIC_T have_sigwinch;
735 SIG_ATOMIC_T cleanup_nested;
740 const char *comp_sourcename;
743 bool have_tic_directory;
744 bool keep_tic_directory;
745 const char *tic_directory;
751 char **keyname_table;
756 size_t safeprint_used;
758 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
760 long tgetent_sequence;
762 #ifndef USE_SP_WINDOWLIST
763 WINDOWLIST *_nc_windowlist;
764 #define WindowList(sp) _nc_globals._nc_windowlist
767 #if USE_HOME_TERMINFO
771 #if !USE_SAFE_SPRINTF
776 #ifdef USE_TERM_DRIVER
777 int (*term_driver)(struct DriverTCB*, const char*, int*);
782 char trace_fname[PATH_MAX];
787 size_t tracearg_used;
789 TRACEBUF *tracebuf_ptr;
790 size_t tracebuf_used;
792 char tracechr_buf[40];
795 size_t tracedmp_used;
797 unsigned char *tracetry_buf;
798 size_t tracetry_used;
800 char traceatr_color_buf[2][80];
801 int traceatr_color_sel;
802 int traceatr_color_last;
803 #if !defined(USE_PTHREADS) && USE_REENTRANT
809 pthread_mutex_t mutex_curses;
810 pthread_mutex_t mutex_tst_tracef;
811 pthread_mutex_t mutex_tracef;
814 #define _nc_use_pthreads _nc_globals.use_pthreads
818 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
823 * Global data which can be swept up into a SCREEN when one is created.
824 * It may be modified before the next SCREEN is created.
829 attr_t previous_attr;
830 #ifndef USE_SP_RIPOFF
831 ripoff_t rippedoff[N_RIPS];
834 TPARM_STATE tparm_state;
835 TTY *saved_tty; /* savetty/resetty information */
836 #if NCURSES_NO_PADDING
837 bool _no_padding; /* flag to set if padding disabled */
839 NCURSES_SP_OUTC _outch; /* output handler if not putc */
840 #if BROKEN_LINKER || USE_REENTRANT
841 chtype *real_acs_map;
849 const char *_tputs_trace;
855 * Use screen-specific ripoff data (for softkeys) rather than global.
858 #define safe_ripoff_sp (sp)->rsp
859 #define safe_ripoff_stack (sp)->rippedoff
861 #define safe_ripoff_sp _nc_prescreen.rsp
862 #define safe_ripoff_stack _nc_prescreen.rippedoff
865 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
868 * The SCREEN structure.
872 int _ifd; /* input file ptr for screen */
873 FILE *_ofp; /* output file ptr for screen */
874 char *_setbuf; /* buffered I/O for output */
875 bool _filtered; /* filter() was called */
876 bool _buffered; /* setvbuf uses _setbuf data */
877 bool _prescreen; /* is in prescreen phase */
878 bool _use_env; /* LINES & COLS from environment? */
879 int _checkfd; /* filedesc for typeahead check */
880 TERMINAL *_term; /* terminal type information */
881 TTY _saved_tty; /* savetty/resetty information */
882 NCURSES_SIZE_T _lines; /* screen lines */
883 NCURSES_SIZE_T _columns; /* screen columns */
885 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
886 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
888 WINDOW *_curscr; /* current screen */
889 WINDOW *_newscr; /* virtual screen to be updated to */
890 WINDOW *_stdscr; /* screen's full-window context */
892 #define CurScreen(sp) (sp)->_curscr
893 #define NewScreen(sp) (sp)->_newscr
894 #define StdScreen(sp) (sp)->_stdscr
896 TRIES *_keytry; /* "Try" for use with keypad mode */
897 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
898 bool _tried; /* keypad mode was initialized */
899 bool _keypad_on; /* keypad mode is currently on */
901 bool _called_wgetch; /* check for recursion in wgetch() */
902 int _fifo[FIFO_SIZE]; /* input push-back buffer */
903 short _fifohead, /* head of fifo queue */
904 _fifotail, /* tail of fifo queue */
905 _fifopeek, /* where to peek for next char */
906 _fifohold; /* set if breakout marked */
908 int _endwin; /* are we out of window mode? */
909 NCURSES_CH_T *_current_attr; /* holds current attributes set */
910 int _coloron; /* is color enabled? */
911 int _color_defs; /* are colors modified */
912 int _cursor; /* visibility of the cursor */
913 int _cursrow; /* physical cursor row */
914 int _curscol; /* physical cursor column */
915 bool _notty; /* true if we cannot switch non-tty */
916 int _nl; /* True if NL -> CR/NL is on */
917 int _raw; /* True if in raw mode */
918 int _cbreak; /* 1 if in cbreak mode */
919 /* > 1 if in halfdelay mode */
920 int _echo; /* True if echo on */
921 int _use_meta; /* use the meta key? */
922 struct _SLK *_slk; /* ptr to soft key struct / NULL */
923 int slk_format; /* selected format for this screen */
924 /* cursor movement costs; units are 10ths of milliseconds */
925 #if NCURSES_NO_PADDING
926 bool _no_padding; /* flag to set if padding disabled */
928 int _char_padding; /* cost of character put */
929 int _cr_cost; /* cost of (carriage_return) */
930 int _cup_cost; /* cost of (cursor_address) */
931 int _home_cost; /* cost of (cursor_home) */
932 int _ll_cost; /* cost of (cursor_to_ll) */
934 int _ht_cost; /* cost of (tab) */
935 int _cbt_cost; /* cost of (backtab) */
936 #endif /* USE_HARD_TABS */
937 int _cub1_cost; /* cost of (cursor_left) */
938 int _cuf1_cost; /* cost of (cursor_right) */
939 int _cud1_cost; /* cost of (cursor_down) */
940 int _cuu1_cost; /* cost of (cursor_up) */
941 int _cub_cost; /* cost of (parm_cursor_left) */
942 int _cuf_cost; /* cost of (parm_cursor_right) */
943 int _cud_cost; /* cost of (parm_cursor_down) */
944 int _cuu_cost; /* cost of (parm_cursor_up) */
945 int _hpa_cost; /* cost of (column_address) */
946 int _vpa_cost; /* cost of (row_address) */
947 /* used in tty_update.c, must be chars */
948 int _ed_cost; /* cost of (clr_eos) */
949 int _el_cost; /* cost of (clr_eol) */
950 int _el1_cost; /* cost of (clr_bol) */
951 int _dch1_cost; /* cost of (delete_character) */
952 int _ich1_cost; /* cost of (insert_character) */
953 int _dch_cost; /* cost of (parm_dch) */
954 int _ich_cost; /* cost of (parm_ich) */
955 int _ech_cost; /* cost of (erase_chars) */
956 int _rep_cost; /* cost of (repeat_char) */
957 int _hpa_ch_cost; /* cost of (column_address) */
958 int _cup_ch_cost; /* cost of (cursor_address) */
959 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
960 int _inline_cost; /* cost of inline-move */
961 int _smir_cost; /* cost of (enter_insert_mode) */
962 int _rmir_cost; /* cost of (exit_insert_mode) */
963 int _ip_cost; /* cost of (insert_padding) */
964 /* used in lib_mvcur.c */
965 char * _address_cursor;
966 /* used in tty_update.c */
967 int _scrolling; /* 1 if terminal's smart enough to */
969 /* used in lib_color.c */
970 color_t *_color_table; /* screen's color palette */
971 int _color_count; /* count of colors in palette */
972 colorpair_t *_color_pairs; /* screen's color pair list */
973 int _pair_count; /* count of color pairs */
974 int _pair_limit; /* actual limit of color-pairs */
975 #if NCURSES_EXT_FUNCS
976 bool _default_color; /* use default colors */
977 bool _has_sgr_39_49; /* has ECMA default color support */
978 int _default_fg; /* assumed default foreground */
979 int _default_bg; /* assumed default background */
980 int _default_pairs; /* count pairs using default color */
982 chtype _ok_attributes; /* valid attributes for terminal */
983 chtype _xmc_suppress; /* attributes to suppress if xmc */
984 chtype _xmc_triggers; /* attributes to process if xmc */
985 chtype * _acs_map; /* the real alternate-charset map */
986 bool * _screen_acs_map;
989 /* used in lib_vidattr.c */
990 bool _use_rmso; /* true if we may use 'rmso' */
991 bool _use_rmul; /* true if we may use 'rmul' */
994 * These data correspond to the state of the idcok() and idlok()
995 * functions. A caveat is in order here: the XSI and SVr4
996 * documentation specify that these functions apply to the window which
997 * is given as an argument. However, ncurses implements this logic
998 * only for the newscr/curscr update process, _not_ per-window.
1004 * These are the data that support the mouse interface.
1006 bool _mouse_initialized;
1007 MouseType _mouse_type;
1009 bool (*_mouse_event) (SCREEN *);
1010 bool (*_mouse_inline)(SCREEN *);
1011 bool (*_mouse_parse) (SCREEN *, int);
1012 void (*_mouse_resume)(SCREEN *);
1013 void (*_mouse_wrap) (SCREEN *);
1014 int _mouse_fd; /* file-descriptor, if any */
1015 bool _mouse_active; /* true if initialized */
1016 mmask_t _mouse_mask;
1017 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1018 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1019 MEVENT *_mouse_eventp; /* next free slot in event queue */
1022 bool _mouse_gpm_loaded;
1023 bool _mouse_gpm_found;
1026 TYPE_gpm_fd _mouse_gpm_fd;
1027 TYPE_Gpm_Open _mouse_Gpm_Open;
1028 TYPE_Gpm_Close _mouse_Gpm_Close;
1029 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1031 Gpm_Connect _mouse_gpm_connect;
1032 #endif /* USE_GPM_SUPPORT */
1036 int _emxmouse_thread;
1037 int _emxmouse_activated;
1038 char _emxmouse_buttons[4];
1042 MEVENT _sysmouse_fifo[FIFO_SIZE];
1045 int _sysmouse_char_width; /* character width */
1046 int _sysmouse_char_height; /* character height */
1047 int _sysmouse_old_buttons;
1048 int _sysmouse_new_buttons;
1051 #ifdef USE_TERM_DRIVER
1052 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1053 int _drv_mouse_head;
1054 int _drv_mouse_tail;
1055 int _drv_mouse_old_buttons;
1056 int _drv_mouse_new_buttons;
1059 * This supports automatic resizing
1062 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1066 * These are data that support the proper handling of the panel stack on an
1069 struct panelhook _panelHook;
1072 SCREEN *_next_screen;
1074 /* hashes for old and new lines */
1075 unsigned long *oldhash, *newhash;
1081 bool _cleanup; /* cleanup after int/quit signal */
1082 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1084 int _legacy_coding; /* see use_legacy_coding() */
1087 char _ttytype[NAMESIZE];
1094 const char *_tputs_trace;
1099 char tracechr_buf[40];
1100 char tracemse_buf[TRACEMSE_MAX];
1102 #ifdef USE_SP_WINDOWLIST
1103 WINDOWLIST* _windowlist;
1104 #define WindowList(sp) (sp)->_windowlist
1108 ripoff_t rippedoff[N_RIPS];
1112 * ncurses/ncursesw are the same up to this point.
1114 #if USE_WIDEC_SUPPORT
1115 /* recent versions of 'screen' have partially-working support for
1116 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1118 bool _screen_acs_fix;
1122 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1123 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1127 SCREEN *screen; /* screen containing the window */
1128 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1129 #ifdef _XOPEN_SOURCE_EXTENDED
1130 char addch_work[(MB_LEN_MAX * 9) + 1];
1131 unsigned addch_used; /* number of bytes in addch_work[] */
1132 int addch_x; /* x-position for addch_work[] */
1133 int addch_y; /* y-position for addch_work[] */
1137 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((char *)(w) - offsetof(WINDOWLIST, win)))->m)
1139 #define SP_PRE_INIT(sp) \
1140 sp->_cursrow = -1; \
1141 sp->_curscol = -1; \
1146 sp->_fifohead = -1; \
1147 sp->_endwin = TRUE; \
1149 WindowList(sp) = 0; \
1150 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1153 /* usually in <limits.h> */
1155 #define UCHAR_MAX 255
1158 /* The terminfo source is assumed to be 7-bit ASCII */
1159 #define is7bits(c) ((unsigned)(c) < 128)
1161 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1162 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1165 #define min(a,b) ((a) > (b) ? (b) : (a))
1169 #define max(a,b) ((a) < (b) ? (b) : (a))
1172 /* usually in <unistd.h> */
1173 #ifndef STDIN_FILENO
1174 #define STDIN_FILENO 0
1177 #ifndef STDOUT_FILENO
1178 #define STDOUT_FILENO 1
1181 #ifndef STDERR_FILENO
1182 #define STDERR_FILENO 2
1185 #ifndef EXIT_SUCCESS
1186 #define EXIT_SUCCESS 0
1189 #ifndef EXIT_FAILURE
1190 #define EXIT_FAILURE 1
1194 #define R_OK 4 /* Test for read permission. */
1197 #define W_OK 2 /* Test for write permission. */
1200 #define X_OK 1 /* Test for execute permission. */
1203 #define F_OK 0 /* Test for existence. */
1207 #include <fcntl.h> /* may define O_BINARY */
1216 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1218 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1221 #define COUNT_OUTCHARS(n) /* nothing */
1224 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1226 #define UChar(c) ((unsigned char)(c))
1227 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1228 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1231 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1234 #if USE_WIDEC_SUPPORT /* { */
1235 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1237 #define init_mb(state) memset(&state, 0, sizeof(state))
1239 #if NCURSES_EXT_COLORS
1240 #define NulColor , 0
1242 #define NulColor /* nothing */
1245 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1246 #define CharOf(c) ((c).chars[0])
1247 #define AttrOf(c) ((c).attr)
1249 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1250 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1251 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1253 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1254 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1257 #define CharEq(a,b) (((a).attr == (b).attr) \
1258 && (a).chars[0] == (b).chars[0] \
1259 && (a).chars[1] == (b).chars[1] \
1260 && (a).chars[2] == (b).chars[2] \
1261 && (a).chars[3] == (b).chars[3] \
1262 && (a).chars[4] == (b).chars[4] \
1263 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1265 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1268 #define SetChar(ch,c,a) do { \
1269 NCURSES_CH_T *_cp = &ch; \
1270 memset(_cp, 0, sizeof(ch)); \
1271 _cp->chars[0] = (c); \
1273 if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a))); \
1275 #define CHREF(wch) (&wch)
1276 #define CHDEREF(wch) (*wch)
1277 #define ARG_CH_T NCURSES_CH_T *
1278 #define CARG_CH_T const NCURSES_CH_T *
1279 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1280 mbstate_t PUT_st; wchar_t PUTC_ch
1281 #define PUTC_INIT init_mb (PUT_st)
1282 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1283 if (Charable(ch)) { \
1284 fputc(CharOf(ch), b); \
1285 COUNT_OUTCHARS(1); \
1288 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1289 PUTC_ch = (ch).chars[PUTC_i]; \
1290 if (PUTC_ch == L'\0') \
1292 PUTC_n = wcrtomb(PUTC_buf, \
1293 (ch).chars[PUTC_i], &PUT_st); \
1294 if (PUTC_n <= 0) { \
1295 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1299 IGNORE_RC(fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b)); \
1301 COUNT_OUTCHARS(PUTC_i); \
1304 #define BLANK NewChar2(' ', WA_NORMAL)
1305 #define ZEROS NewChar2('\0', WA_NORMAL)
1306 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1309 * Wide characters cannot be represented in the A_CHARTEXT mask of
1310 * attr_t's but an application might have set a narrow character there.
1311 * But even in that case, it would only be a printable character, or
1312 * zero. Otherwise we can use those bits to tell if a cell is the
1313 * first or extension part of a wide character.
1315 #define WidecExt(ch) (AttrOf(ch) & A_CHARTEXT)
1316 #define isWidecBase(ch) (WidecExt(ch) == 1)
1317 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1318 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1319 AttrOf(dst) |= (ext + 1)
1321 #define if_WIDEC(code) code
1322 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1323 || (AttrOf(ch) & A_ALTCHARSET) \
1324 || (!isWidecExt(ch) && \
1325 (ch).chars[1] == L'\0' && \
1326 _nc_is_charable(CharOf(ch))))
1328 #define L(ch) L ## ch
1330 #define CharOf(c) ChCharOf(c)
1331 #define AttrOf(c) ChAttrOf(c)
1332 #define AddAttr(c,a) c |= (a)
1333 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1334 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1335 #define NewChar(ch) (ch)
1336 #define NewChar2(c,a) ((c) | (a))
1337 #define CharEq(a,b) ((a) == (b))
1338 #define SetChar(ch,c,a) ch = (c) | (a)
1339 #define CHREF(wch) wch
1340 #define CHDEREF(wch) wch
1341 #define ARG_CH_T NCURSES_CH_T
1342 #define CARG_CH_T NCURSES_CH_T
1343 #define PUTC_DATA int data = 0
1344 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1346 #define BLANK (' '|A_NORMAL)
1347 #define ZEROS ('\0'|A_NORMAL)
1348 #define ISBLANK(ch) (CharOf(ch) == ' ')
1350 #define isWidecExt(ch) (0)
1351 #define if_WIDEC(code) /* nothing */
1356 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1357 #define CharOfD(ch) CharOf(CHDEREF(ch))
1358 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1360 #define BLANK_ATTR A_NORMAL
1361 #define BLANK_TEXT L(' ')
1365 #define LEGALYX(w, y, x) \
1367 ((x) >= 0 && (x) <= (w)->_maxx && \
1368 (y) >= 0 && (y) <= (w)->_maxy))
1370 #define CHANGED_CELL(line,col) \
1371 if (line->firstchar == _NOCHANGE) \
1372 line->firstchar = line->lastchar = col; \
1373 else if ((col) < line->firstchar) \
1374 line->firstchar = col; \
1375 else if ((col) > line->lastchar) \
1376 line->lastchar = col
1378 #define CHANGED_RANGE(line,start,end) \
1379 if (line->firstchar == _NOCHANGE \
1380 || line->firstchar > (start)) \
1381 line->firstchar = start; \
1382 if (line->lastchar == _NOCHANGE \
1383 || line->lastchar < (end)) \
1384 line->lastchar = end
1386 #define CHANGED_TO_EOL(line,start,end) \
1387 if (line->firstchar == _NOCHANGE \
1388 || line->firstchar > (start)) \
1389 line->firstchar = start; \
1390 line->lastchar = end
1392 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1394 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1396 /* FreeAndNull() is not a comma-separated expression because some compilers
1397 * do not accept a mixture of void with values.
1399 #define FreeAndNull(p) free(p); p = 0
1401 #include <nc_alloc.h>
1404 * TTY bit definition for converting tabs to spaces.
1407 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1410 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1413 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1415 # define OFLAGS_TABS 0
1421 * Standardize/simplify common loops
1423 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1424 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1425 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1428 * Prefixes for call/return points of library function traces. We use these to
1429 * instrument the public functions so that the traces can be easily transformed
1430 * into regression scripts.
1432 #define T_CALLED(fmt) "called {" fmt
1433 #define T_CREATE(fmt) "create :" fmt
1434 #define T_RETURN(fmt) "return }" fmt
1439 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1441 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1444 #define START_TRACE() \
1445 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1446 int t = _nc_getenv_num("NCURSES_TRACE"); \
1448 trace((unsigned) t); \
1452 * Many of the _tracef() calls use static buffers; lock the trace state before
1453 * trying to fill them.
1456 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1457 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1458 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1460 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1461 #define _nc_locked_tracef _tracef
1464 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1465 #define T(a) TR(TRACE_CALLS, a)
1466 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1468 #define NonNull(s) ((s) != 0 ? s : "<null>")
1470 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1471 #define returnBits(code) TRACE_RETURN(code,unsigned)
1472 #define returnBool(code) TRACE_RETURN(code,bool)
1473 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1474 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1475 #define returnChar(code) TRACE_RETURN(code,char)
1476 #define returnChtype(code) TRACE_RETURN(code,chtype)
1477 #define returnCode(code) TRACE_RETURN(code,int)
1478 #define returnPtr(code) TRACE_RETURN(code,ptr)
1479 #define returnSP(code) TRACE_RETURN(code,sp)
1480 #define returnVoid T((T_RETURN(""))); return
1481 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1482 #define returnWin(code) TRACE_RETURN(code,win)
1484 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
1485 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1486 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1487 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1488 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1489 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1490 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1491 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1492 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1493 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1494 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1495 extern NCURSES_EXPORT(char) _nc_retrace_char (char);
1496 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1497 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1498 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1499 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1502 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1503 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1504 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1505 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1506 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1507 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1509 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1510 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1513 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1515 #if USE_WIDEC_SUPPORT
1516 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1517 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1520 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1521 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1525 #define START_TRACE() /* nothing */
1529 #define TPUTS_TRACE(s)
1531 #define returnAttr(code) return code
1532 #define returnBits(code) return code
1533 #define returnBool(code) return code
1534 #define returnCPtr(code) return code
1535 #define returnCVoidPtr(code) return code
1536 #define returnChar(code) return ((char) code)
1537 #define returnChtype(code) return code
1538 #define returnCode(code) return code
1539 #define returnPtr(code) return code
1540 #define returnSP(code) return code
1541 #define returnVoid return
1542 #define returnVoidPtr(code) return code
1543 #define returnWin(code) return code
1545 #endif /* TRACE/!TRACE */
1548 * Workaround for defective implementation of gcc attribute warn_unused_result
1550 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1551 #define IGNORE_RC(func) errno = func
1553 #define IGNORE_RC(func) (void) func
1554 #endif /* gcc workarounds */
1557 * Return-codes for tgetent() and friends.
1559 #define TGETENT_YES 1 /* entry is found */
1560 #define TGETENT_NO 0 /* entry is not found */
1561 #define TGETENT_ERR -1 /* an error occurred */
1563 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1564 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1566 #define EMPTY_MODULE(name) \
1567 extern NCURSES_EXPORT(void) name (void); \
1568 NCURSES_EXPORT(void) name (void) { }
1570 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1571 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1572 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1574 #define toggle_attr_on(S,at) {\
1575 if (PAIR_NUMBER(at) > 0) {\
1576 (S) = ((S) & ALL_BUT_COLOR) | (at);\
1580 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1583 #define toggle_attr_off(S,at) {\
1584 if (PAIR_NUMBER(at) > 0) {\
1585 (S) &= ~(at|A_COLOR);\
1589 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1591 #define DelCharCost(sp,count) \
1594 : ((delete_character != 0) \
1595 ? (sp->_dch1_cost * count) \
1598 #define InsCharCost(sp,count) \
1601 : ((enter_insert_mode && exit_insert_mode) \
1602 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1603 : ((insert_character != 0) \
1604 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1608 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1609 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1610 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1611 if (magic_cookie_glitch > 0 \
1612 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1613 T(("%s @%d before glitch %d,%d", \
1614 __FILE__, __LINE__, \
1617 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1621 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) \
1622 VIDATTR(sp, AttrOf(c), GetPair(c));
1626 * Macros to make additional parameter to implement wgetch_events()
1628 #ifdef NCURSES_WGETCH_EVENTS
1629 #define EVENTLIST_0th(param) param
1630 #define EVENTLIST_1st(param) param
1631 #define EVENTLIST_2nd(param) , param
1633 #define EVENTLIST_0th(param) void
1634 #define EVENTLIST_1st(param) /* nothing */
1635 #define EVENTLIST_2nd(param) /* nothing */
1638 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1640 #undef toggle_attr_on
1641 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1642 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1644 #undef toggle_attr_off
1645 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1646 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1649 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1652 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1654 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1655 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1658 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1660 #if defined(NEED_NCURSES_CH_T)
1661 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1663 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1666 #if NCURSES_SP_FUNCS
1667 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1668 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1669 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1670 #endif /* NCURSES_SP_FUNCS */
1674 extern NCURSES_EXPORT(void) _nc_expanded (void);
1678 #if !NCURSES_EXT_FUNCS
1679 #define set_escdelay(value) ESCDELAY = value
1683 #define getcwd(buf,len) getwd(buf)
1687 #if USE_WIDEC_SUPPORT
1688 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1689 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1690 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1695 short nte_name; /* offset of name to hash on */
1696 int nte_type; /* BOOLEAN, NUMBER or STRING */
1697 short nte_index; /* index of associated variable in its array */
1698 short nte_link; /* index in table of next hash, or -1 */
1710 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1714 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1715 extern NCURSES_EXPORT(void) _nc_linedump (void);
1719 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1720 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1723 #if USE_WIDEC_SUPPORT
1724 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1728 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1729 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1733 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1736 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1739 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1742 #define INFINITY 1000000 /* cost: too high to use */
1744 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1745 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1746 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1748 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1750 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1751 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1752 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1755 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1758 #define INFINITY 1000000 /* cost: too high to use */
1759 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1762 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1763 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1764 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1765 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1766 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, char);
1768 /* lib_set_term.c */
1769 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1773 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1775 #define _nc_handle_sigwinch(a) /* nothing */
1779 #if USE_WIDEC_SUPPORT
1780 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1784 char *s_head; /* beginning of the string (may be null) */
1785 char *s_tail; /* end of the string (may be null) */
1786 size_t s_size; /* current remaining size available */
1787 size_t s_init; /* total size available */
1791 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1792 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1793 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1794 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1795 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1798 #define strstr _nc_strstr
1799 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1802 /* safe_sprintf.c */
1803 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1806 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1807 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1808 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1809 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1812 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1813 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1814 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1815 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1816 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1817 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1818 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1819 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1820 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1821 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1822 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1823 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1824 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, bool);
1825 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1826 extern NCURSES_EXPORT(int) _nc_outch (int);
1827 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1828 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1829 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1830 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1831 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1832 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, NCURSES_OUTC);
1833 extern NCURSES_EXPORT(void) _nc_flush (void);
1834 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1835 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1836 extern NCURSES_EXPORT(void) _nc_freeall (void);
1837 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1838 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1839 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1840 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1841 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1842 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1843 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1844 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1845 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1846 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1849 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1850 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1851 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1852 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1853 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1854 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1855 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1856 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1860 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1861 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1862 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1865 #if USE_WIDEC_SUPPORT
1866 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1869 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1870 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1874 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1878 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1880 #define _nc_resize_margins(wp) /* nothing */
1883 #ifdef NCURSES_WGETCH_EVENTS
1884 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1886 #define wgetch_events(win, evl) wgetch(win)
1887 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1891 * Wide-character macros to hide some platform-differences.
1893 #if USE_WIDEC_SUPPORT
1894 #if HAVE_MBTOWC && HAVE_MBLEN
1895 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, 0)), IGNORE_RC(mbtowc(NULL, NULL, 0))
1896 #define count_mbytes(buffer,length,state) mblen(buffer,length)
1897 #define check_mbytes(wch,buffer,length,state) \
1898 (int) mbtowc(&wch, buffer, length)
1899 #define state_unused
1900 #elif HAVE_MBRTOWC && HAVE_MBRLEN
1901 #define reset_mbytes(state) init_mb(state)
1902 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
1903 #define check_mbytes(wch,buffer,length,state) \
1904 (int) mbrtowc(&wch, buffer, length, &state)
1911 * Not everyone has vsscanf(), but we'd like to use it for scanw().
1914 extern int vsscanf(const char *str, const char *format, va_list __arg);
1917 /* scroll indices */
1918 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1920 #define USE_SETBUF_0 0
1922 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
1924 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
1927 * On systems with a broken linker, define 'SP' as a function to force the
1928 * linker to pull in the data-only module with 'SP'.
1930 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
1933 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1934 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1935 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1936 #define CURRENT_SCREEN _nc_screen()
1938 /* current screen is private data; avoid possible linking conflicts too */
1939 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1940 #define CURRENT_SCREEN SP
1941 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
1942 #define _nc_set_screen(sp) SP = sp
1945 #if NCURSES_SP_FUNCS
1946 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
1948 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
1952 * We don't want to use the lines or columns capabilities internally, because
1953 * if the application is running multiple screens under X, it's quite possible
1954 * they could all have type xterm but have different sizes! So...
1956 #define screen_lines(sp) (sp)->_lines
1957 #define screen_columns(sp) (sp)->_columns
1959 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1960 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
1963 * Some constants related to SLK's
1965 #define MAX_SKEY_OLD 8 /* count of soft keys */
1966 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
1967 #define MAX_SKEY_PC 12 /* This is what most PC's have */
1968 #define MAX_SKEY_LEN_PC 5
1970 /* Macro to check whether or not we use a standard format */
1971 #define SLK_STDFMT(fmt) (fmt < 3)
1972 /* Macro to determine height of label window */
1973 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1975 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1976 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1979 * Common error messages
1981 #define MSG_NO_MEMORY "Out of memory"
1982 #define MSG_NO_INPUTS "Premature EOF"
1984 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
1985 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
1987 /* timed_wait flag definitions */
1991 #define TW_ANY (TW_INPUT | TW_MOUSE)
1994 #define SetSafeOutcWrapper(outc) \
1995 SCREEN* sp = CURRENT_SCREEN; \
1997 struct screen dummy; \
1999 memset(sp,0,sizeof(struct screen)); \
2000 sp->_outch = _nc_outc_wrapper; \
2004 #ifdef USE_TERM_DRIVER
2005 typedef void* TERM_HANDLE;
2007 typedef struct _termInfo
2025 const color_t* defaultPalette;
2028 typedef struct term_driver {
2030 bool (*CanHandle)(struct DriverTCB*,const char*,int*);
2031 void (*init)(struct DriverTCB*);
2032 void (*release)(struct DriverTCB*);
2033 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2034 int (*sgmode)(struct DriverTCB*, bool setFlag, TTY*);
2035 chtype (*conattr)(struct DriverTCB*);
2036 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2037 int (*mode)(struct DriverTCB*, bool progFlag, bool defFlag);
2038 bool (*rescol)(struct DriverTCB*);
2039 bool (*rescolors)(struct DriverTCB*);
2040 void (*color)(struct DriverTCB*,bool fore, int color, int(*)(SCREEN*,int));
2041 int (*doBeepOrFlash)(struct DriverTCB*, bool);
2042 void (*initpair)(struct DriverTCB*,short,short,short);
2043 void (*initcolor)(struct DriverTCB*,short,short,short,short);
2044 void (*docolor)(struct DriverTCB*,short,short,bool,int(*)(SCREEN*,int));
2045 void (*initmouse)(struct DriverTCB*);
2046 void (*setfilter)(struct DriverTCB*);
2047 void (*hwlabel)(struct DriverTCB*,int,char*);
2048 void (*hwlabelOnOff)(struct DriverTCB*,bool);
2049 int (*update)(struct DriverTCB*);
2050 int (*defaultcolors)(struct DriverTCB*,int,int);
2051 int (*print)(struct DriverTCB*,char*,int);
2052 int (*getsize)(struct DriverTCB*,int*,int*);
2053 int (*setsize)(struct DriverTCB*,int,int);
2054 void (*initacs)(struct DriverTCB*,chtype*,chtype*);
2055 void (*scinit)(SCREEN *);
2056 void (*scexit)(SCREEN *);
2057 int (*twait)(struct DriverTCB*,int,int,int* EVENTLIST_2nd(_nc_eventlist*));
2058 int (*read)(struct DriverTCB*,int*);
2059 int (*nap)(struct DriverTCB*,int);
2060 int (*kpad)(struct DriverTCB*, bool);
2061 int (*kyOk)(struct DriverTCB*, int, bool);
2062 bool (*kyExist)(struct DriverTCB*, int);
2065 typedef struct DriverTCB
2067 TERMINAL term; /* needs to be the first Element !!! */
2068 TERM_HANDLE inp; /* The input handle of the Terminal */
2069 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2070 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2071 TERM_DRIVER* drv; /* The driver for that Terminal */
2072 SCREEN* csp; /* The screen that owns that Terminal */
2073 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2074 void* prop; /* Driver dependent property storage to be used by the Driver */
2076 } TERMINAL_CONTROL_BLOCK;
2078 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2079 #define NCDRV_TINFO 0x01
2080 #define NCDRV_WINCONSOLE 0x02
2082 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2083 #define InfoOf(sp) TCBOf(sp)->info
2084 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2085 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2086 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2087 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2088 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2090 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2091 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2093 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2094 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2095 #endif /* USE_TERM_DRIVER */
2098 * Entrypoints which are actually provided in the terminal driver, which would
2099 * be an sp-name otherwise.
2101 #ifdef USE_TERM_DRIVER
2102 #define TINFO_HAS_KEY _nc_tinfo_has_key
2103 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2104 #define TINFO_MVCUR _nc_tinfo_mvcur
2105 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2106 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2107 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2109 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2110 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2111 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2115 * Entrypoints using an extra parameter with the terminal driver.
2117 #ifdef USE_TERM_DRIVER
2118 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2119 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, bool);
2120 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2121 _nc_get_screensize(sp, tp, lp, cp)
2122 #define TINFO_SET_CURTERM(sp, tp) \
2123 NCURSES_SP_NAME(set_curterm)(sp, tp)
2124 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2125 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2126 #else /* !USE_TERM_DRIVER */
2127 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2128 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2129 _nc_get_screensize(sp, lp, cp)
2130 #define TINFO_SET_CURTERM(sp, tp) \
2132 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2133 _nc_setupterm(name, fd, err, reuse)
2134 #endif /* !USE_TERM_DRIVER */
2136 #ifdef USE_TERM_DRIVER
2138 #include <nc_mingw.h>
2139 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2141 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2144 #ifdef USE_TERM_DRIVER
2145 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2147 #define IsTermInfo(sp) TRUE
2150 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2151 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2154 * Exported entrypoints beyond the published API
2156 #if NCURSES_SP_FUNCS
2157 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2158 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2159 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2160 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2163 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2164 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2167 #if NCURSES_EXT_FUNCS
2168 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2172 * We put the safe versions of various calls here as they are not published
2173 * part of the API up to now
2175 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2176 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2177 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2178 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2179 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2180 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2181 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2182 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2183 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2184 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2185 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2186 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2187 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2188 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2189 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2190 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2191 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2192 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2193 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2194 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2195 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, bool, int);
2196 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2197 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2198 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2199 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2200 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, short, short, bool, NCURSES_SP_OUTC);
2201 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2202 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2203 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2204 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2205 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2206 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2207 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2208 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2209 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2210 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2211 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2212 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2213 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2214 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2215 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2216 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, bool);
2218 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2220 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2221 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2224 #if USE_WIDEC_SUPPORT
2225 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2228 #endif /* NCURSES_SP_FUNCS */
2230 #if NCURSES_SP_FUNCS
2232 #define safe_keyname NCURSES_SP_NAME(keyname)
2233 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2234 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2238 #define safe_keyname _nc_keyname
2239 #define safe_unctrl _nc_unctrl
2240 #define safe_ungetch _nc_ungetch
2242 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2243 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2244 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2252 #endif /* CURSES_PRIV_H */