1 /****************************************************************************
2 * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer *
34 ****************************************************************************/
37 * $Id: curses.priv.h,v 1.492 2012/01/21 19:21:29 KO.Myung-Hun Exp $
41 * Header file for curses library objects which are private to
47 #define CURSES_PRIV_H 1
50 #include <ncurses_dll.h>
56 #include <ncurses_cfg.h>
59 #define MODULE_ID(id) static const char Ident[] = id;
61 #define MODULE_ID(id) /*nothing*/
64 #include <stddef.h> /* for offsetof */
67 #include <sys/types.h>
74 #if HAVE_SYS_BSDTYPES_H
75 #include <sys/bsdtypes.h> /* needed for ISC */
80 #elif HAVE_SYS_PARAM_H
81 # include <sys/param.h>
90 # if defined(_POSIX_PATH_MAX)
91 # define PATH_MAX _POSIX_PATH_MAX
92 # elif defined(MAXPATHLEN)
93 # define PATH_MAX MAXPATHLEN
95 # define PATH_MAX 255 /* the Posix minimum path-size */
103 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
104 #if HAVE_WORKING_POLL
105 #define USE_FUNC_POLL 1
109 #include <sys/poll.h>
112 #define USE_FUNC_POLL 0
115 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
118 /* Alessandro Rubini's GPM (general-purpose mouse) */
119 #if HAVE_LIBGPM && HAVE_GPM_H
120 #define USE_GPM_SUPPORT 1
122 #define USE_GPM_SUPPORT 0
125 /* QNX mouse support */
126 #if defined(__QNX__) && !defined(__QNXNTO__)
127 #define USE_QNX_MOUSE 1
129 #define USE_QNX_MOUSE 0
132 /* EMX mouse support */
134 #define USE_EMX_MOUSE 1
136 #define USE_EMX_MOUSE 0
139 /* kLIBC keyboard/mouse support */
140 #if defined(__OS2__) && defined(__KLIBC__)
141 #define USE_KLIBC_KBD 1
142 #define USE_KLIBC_MOUSE 1
144 #define USE_KLIBC_KBD 0
145 #define USE_KLIBC_MOUSE 0
148 #define DEFAULT_MAXCLICK 166
149 #define EV_MAX 8 /* size of mouse circular event queue */
152 * If we don't have signals to support it, don't add a sigwinch handler.
153 * In any case, resizing is an extended feature. Use it if we've got it.
155 #if !NCURSES_EXT_FUNCS
156 #undef HAVE_SIZECHANGE
157 #define HAVE_SIZECHANGE 0
160 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
161 #define USE_SIZECHANGE 1
163 #define USE_SIZECHANGE 0
165 #define USE_SIGWINCH 0
169 * If desired, one can configure this, disabling environment variables that
170 * point to custom terminfo/termcap locations.
172 #ifdef USE_ROOT_ENVIRON
173 #define use_terminfo_vars() 1
175 #define use_terminfo_vars() _nc_env_access()
176 extern NCURSES_EXPORT(int) _nc_env_access (void);
180 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
184 #define memmove(d,s,n) bcopy(s,d,n)
186 #define memmove(d,s,n) _nc_memmove(d,s,n)
187 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
191 * If we have va_copy(), use it for assigning va_list's.
193 #if defined(HAVE___VA_COPY)
194 #define begin_va_copy(dst,src) __va_copy(dst, src)
195 #define end_va_copy(dst) va_end(dst)
196 #elif defined(va_copy) || defined(HAVE_VA_COPY)
197 #define begin_va_copy(dst,src) va_copy(dst, src)
198 #define end_va_copy(dst) va_end(dst)
200 #define begin_va_copy(dst,src) (dst) = (src)
201 #define end_va_copy(dst) /* nothing */
205 * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
206 * lack one or the other.
209 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
213 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
217 * Scroll hints are useless when hashmap is used
219 #if !USE_SCROLL_HINTS
221 #define USE_SCROLL_HINTS 1
223 #define USE_SCROLL_HINTS 0
228 #define if_USE_SCROLL_HINTS(stmt) stmt
230 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
234 * Options for terminal drivers, etc...
236 #ifdef USE_TERM_DRIVER
237 #define USE_SP_RIPOFF 1
238 #define USE_SP_TERMTYPE 1
239 #define USE_SP_WINDOWLIST 1
243 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
244 * when we're throwing control codes at the screen at high volume. To see
245 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
246 * probably don't want to define this either due to uncertainties about tab
247 * delays and expansion in raw mode.
250 #define TRIES struct tries
252 TRIES *child; /* ptr to child. NULL if none */
253 TRIES *sibling; /* ptr to sibling. NULL if none */
254 unsigned char ch; /* character at this node */
255 unsigned short value; /* code of string so far. 0 if none. */
260 * Common/troublesome character definitions
262 #define StringOf(ch) {ch, 0}
269 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
272 * Structure for palette tables
277 short red, green, blue; /* what color_content() returns */
278 short r, g, b; /* params to init_color() */
279 int init; /* true if we called init_color() */
283 #define MAXCOLUMNS 135
285 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
289 #define WINDOWLIST struct _win_list
291 #if USE_WIDEC_SUPPORT
292 #define _nc_bkgd _bkgrnd
294 #undef _XOPEN_SOURCE_EXTENDED
296 #define _nc_bkgd _bkgd
297 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
298 #define wbkgrnd wbkgd
301 #undef NCURSES_OPAQUE
302 #define NCURSES_INTERNALS 1
303 #define NCURSES_OPAQUE 0
305 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
308 * If curses.h did not expose the SCREEN-functions, then we do not need the
309 * parameter in the corresponding unextended functions.
312 #define USE_SP_FUNC_SUPPORT NCURSES_SP_FUNCS
313 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
316 #define SP_PARM sp /* use parameter */
317 #define NCURSES_SP_ARG SP_PARM
318 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
319 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
320 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
321 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
323 #define SP_PARM SP /* use global variable */
324 #define NCURSES_SP_ARG
325 #define NCURSES_SP_DCL
326 #define NCURSES_SP_DCL0 void
327 #define NCURSES_SP_ARGx
328 #define NCURSES_SP_DCLx
331 #include <nc_panel.h>
333 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
334 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
335 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
337 #if BROKEN_LINKER || USE_REENTRANT
338 #define CurTerm _nc_prescreen._cur_term
340 #define CurTerm cur_term
344 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
346 #define TerminalOf(sp) CurTerm
350 #include <nc_termios.h>
353 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
354 * pointer to this data.
356 #ifdef USE_SP_TERMTYPE
360 #define SP_TERMTYPE TerminalOf(sp)->type.
362 #include <term_entry.h>
364 #include <nc_tparm.h>
367 * Use these macros internally, to make tracing less verbose. But leave the
368 * option for compiling the tracing into the library.
371 #define ColorPair(n) NCURSES_BITS(n, 0)
372 #define PairNumber(a) (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
374 #define ColorPair(pair) COLOR_PAIR(pair)
375 #define PairNumber(attr) PAIR_NUMBER(attr)
378 #define unColor(n) unColor2(AttrOf(n))
379 #define unColor2(a) ((a) & ALL_BUT_COLOR)
382 * Extended-colors stores the color pair in a separate struct-member than the
383 * attributes. But for compatibility, we handle most cases where a program
384 * written for non-extended colors stores the color in the attributes by
385 * checking for a color pair in both places.
387 #if NCURSES_EXT_COLORS
388 #define if_EXT_COLORS(stmt) stmt
389 #define SetPair(value,p) SetPair2((value).ext_color, AttrOf(value), p)
390 #define SetPair2(c,a,p) c = (p), \
391 a = (unColor2(a) | (A_COLOR & ColorPair(oldColor(c))))
392 #define GetPair(value) GetPair2((value).ext_color, AttrOf(value))
393 #define GetPair2(c,a) ((c) ? (c) : PairNumber(a))
394 #define oldColor(p) (((p) > 255) ? 255 : (p))
395 #define GET_WINDOW_PAIR(w) GetPair2((w)->_color, (w)->_attrs)
396 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
397 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
400 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_attr)(sp, attr, pair, 0)
402 #define VIDATTR(sp,attr,pair) vid_attr(attr, pair, 0)
405 #else /* !NCURSES_EXT_COLORS */
407 #define if_EXT_COLORS(stmt) /* nothing */
408 #define SetPair(value,p) RemAttr(value, A_COLOR), \
409 SetAttr(value, AttrOf(value) | (A_COLOR & (attr_t) ColorPair(p)))
410 #define GetPair(value) PairNumber(AttrOf(value))
411 #define GET_WINDOW_PAIR(w) PairNumber(WINDOW_ATTRS(w))
412 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
413 WINDOW_ATTRS(w) |= (A_COLOR & (attr_t) ColorPair(p))
414 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
417 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidattr)(sp, attr)
419 #define VIDATTR(sp,attr,pair) vidattr(attr)
422 #endif /* NCURSES_EXT_COLORS */
424 #if NCURSES_NO_PADDING
425 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
426 #define SetNoPadding(sp) _nc_set_no_padding(sp)
427 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
429 #define GetNoPadding(sp) FALSE
430 #define SetNoPadding(sp) /*nothing*/
433 #define WINDOW_ATTRS(w) ((w)->_attrs)
435 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
436 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
437 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
439 #if USE_REENTRANT || NCURSES_SP_FUNCS
440 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
441 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
442 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
443 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
448 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
449 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
450 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
451 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
453 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
454 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
455 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
456 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
460 #define ptrLines(sp) &LINES
461 #define ptrCols(sp) &COLS
462 #define ptrTabsize(sp) &TABSIZE
463 #define ptrEscdelay(sp) &ESCDELAY
465 #define SET_LINES(value) LINES = value
466 #define SET_COLS(value) COLS = value
467 #define SET_TABSIZE(value) TABSIZE = value
468 #define SET_ESCDELAY(value) ESCDELAY = value
472 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
473 __FILE__, __LINE__, \
474 (unsigned long) (pthread_self()), \
475 data.__data.__lock, \
476 data.__data.__count, \
477 data.__data.__owner, \
478 data.__data.__kind, \
479 (data.__data.__nusers > 5) ? " OOPS " : "", \
480 data.__data.__nusers)
481 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
484 #if defined(__GNUC__)
485 # if defined __USE_ISOC99
486 # define _cat_pragma(exp) _Pragma(#exp)
487 # define _weak_pragma(exp) _cat_pragma(weak name)
489 # define _weak_pragma(exp)
491 # define _declare(name) __extension__ extern __typeof__(name) name
492 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
500 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
501 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
502 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
503 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
504 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
505 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
506 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
507 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
510 #error POSIX threads requires --enable-reentrant option
514 # if USE_WEAK_SYMBOLS
515 weak_symbol(pthread_sigmask);
516 weak_symbol(pthread_kill);
517 weak_symbol(pthread_self);
518 weak_symbol(pthread_equal);
519 weak_symbol(pthread_mutex_init);
520 weak_symbol(pthread_mutex_lock);
521 weak_symbol(pthread_mutex_unlock);
522 weak_symbol(pthread_mutex_trylock);
523 weak_symbol(pthread_mutexattr_settype);
524 weak_symbol(pthread_mutexattr_init);
525 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
527 # define sigprocmask _nc_sigprocmask
532 #undef HAVE_NANOSLEEP
533 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
536 #else /* !USE_PTHREADS */
538 #if USE_PTHREADS_EINTR
539 # if USE_WEAK_SYMBOLS
541 weak_symbol(pthread_sigmask);
542 weak_symbol(pthread_kill);
543 weak_symbol(pthread_self);
544 weak_symbol(pthread_equal);
545 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
547 # define sigprocmask _nc_sigprocmask
549 #endif /* USE_PTHREADS_EINTR */
551 #define _nc_init_pthreads() /* nothing */
552 #define _nc_mutex_init(obj) /* nothing */
554 #define _nc_lock_global(name) /* nothing */
555 #define _nc_try_global(name) 0
556 #define _nc_unlock_global(name) /* nothing */
558 #endif /* USE_PTHREADS */
561 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
562 * So the locking is done in the non-sp-func (which calls the sp-func) rather
563 * than in the sp-func itself.
565 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
566 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
570 #define _nc_nonsp_lock_global(name) /* nothing */
571 #define _nc_nonsp_try_global(name) 0
572 #define _nc_nonsp_unlock_global(name) /* nothing */
574 #define _nc_sp_lock_global(name) _nc_lock_global(name)
575 #define _nc_sp_try_global(name) _nc_try_global(name)
576 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
580 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
581 #define _nc_nonsp_try_global(name) _nc_try_global(name)
582 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
584 #define _nc_sp_lock_global(name) /* nothing */
585 #define _nc_sp_try_global(name) 0
586 #define _nc_sp_unlock_global(name) /* nothing */
590 #if HAVE_GETTIMEOFDAY
591 # define PRECISE_GETTIME 1
592 # define TimeType struct timeval
594 # define PRECISE_GETTIME 0
595 # define TimeType time_t
599 * Definitions for color pairs
601 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
602 #define C_SHIFT 9 /* we need more bits than there are colors */
603 #define C_MASK ((1 << C_SHIFT) - 1)
604 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
605 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
606 #define BACK_OF(c) ((c) & C_MASK)
607 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
609 #define COLOR_DEFAULT C_MASK
611 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
613 #undef NCURSES_CH_T /* this is not a termlib feature */
614 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
616 #endif /* USE_TERMLIB */
621 NCURSES_CH_T *text; /* text of the line */
622 NCURSES_SIZE_T firstchar; /* first changed character in the line */
623 NCURSES_SIZE_T lastchar; /* last changed character in the line */
624 NCURSES_SIZE_T oldindex; /* index of the line at last update */
626 #endif /* USE_TERMLIB */
629 M_XTERM = -1 /* use xterm's mouse tracking? */
630 ,M_NONE = 0 /* no mouse device */
635 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
637 #ifdef USE_TERM_DRIVER
638 ,M_TERM_DRIVER /* Win32 console, etc */
643 * Structures for scrolling.
647 unsigned long hashval;
648 int oldcount, newcount;
649 int oldindex, newindex;
653 * Structures for soft labels.
658 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
662 char *ent_text; /* text for the label */
663 char *form_text; /* formatted text (left/center/...) */
664 int ent_x; /* x coordinate of this field */
665 char dirty; /* this label has changed */
666 char visible; /* field is visible */
669 typedef struct _SLK {
670 bool dirty; /* all labels have changed */
671 bool hidden; /* soft labels are hidden */
674 short maxlab; /* number of available labels */
675 short labcnt; /* number of allocated labels */
676 short maxlen; /* length of labels */
677 NCURSES_CH_T attr; /* soft label attribute */
680 #endif /* USE_TERMLIB */
683 WINDOW *win; /* the window used in the hook */
684 int line; /* lines to take, < 0 => from bottom*/
685 int (*hook)(WINDOW *, int); /* callback for user */
689 #undef buttons /* term.h defines this, and gpm uses it! */
693 /* link dynamically to GPM */
694 typedef int *TYPE_gpm_fd;
695 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
696 typedef int (*TYPE_Gpm_Close) (void);
697 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
699 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
700 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
701 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
702 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
704 /* link statically to GPM */
705 #define my_gpm_fd &gpm_fd
706 #define my_Gpm_Open Gpm_Open
707 #define my_Gpm_Close Gpm_Close
708 #define my_Gpm_GetEvent Gpm_GetEvent
709 #endif /* HAVE_LIBDL */
710 #endif /* USE_GPM_SUPPORT */
715 char *fix_sgr0; /* this holds the filtered sgr0 string */
716 char *last_bufp; /* help with fix_sgr0 leak */
720 #define TGETENT_MAX 4
741 const char *tparam_base;
743 STACK_FRAME stack[STACKSIZE];
753 int dynamic_var[NUM_VARS];
754 int static_vars[NUM_VARS];
763 * The filesystem database normally uses a single-letter for the lower level
764 * of directories. Use a hexadecimal code for filesystems which do not
765 * preserve mixed-case names.
767 #if MIXEDCASE_FILENAMES
768 #define LEAF_FMT "%c"
771 #define LEAF_FMT "%02x"
776 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
777 * could at most have 10 digits, and the mask contains no more than 32 bits
778 * with each bit representing less than 15 characters. Usually the whole
779 * string is less than 80 columns, but this buffer size is an absolute
782 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
783 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
785 #ifdef USE_TERM_DRIVER
786 struct DriverTCB; /* Terminal Control Block forward declaration */
787 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
789 #define INIT_TERM_DRIVER() /* nothing */
798 * Global data which is not specific to a screen.
801 SIG_ATOMIC_T have_sigwinch;
802 SIG_ATOMIC_T cleanup_nested;
807 char *comp_sourcename;
810 bool have_tic_directory;
811 bool keep_tic_directory;
812 const char *tic_directory;
818 char **keyname_table;
823 size_t safeprint_used;
825 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
827 long tgetent_sequence;
829 char *dbd_blob; /* string-heap for dbd_list[] */
830 char **dbd_list; /* distinct places to look for data */
831 int dbd_size; /* length of dbd_list[] */
832 time_t dbd_time; /* cache last updated */
833 ITERATOR_VARS dbd_vars[dbdLAST];
835 #ifndef USE_SP_WINDOWLIST
836 WINDOWLIST *_nc_windowlist;
837 #define WindowList(sp) _nc_globals._nc_windowlist
840 #if USE_HOME_TERMINFO
844 #if !USE_SAFE_SPRINTF
849 #ifdef USE_TERM_DRIVER
850 int (*term_driver)(struct DriverTCB*, const char*, int*);
855 char trace_fname[PATH_MAX];
860 size_t tracearg_used;
862 TRACEBUF *tracebuf_ptr;
863 size_t tracebuf_used;
865 char tracechr_buf[40];
868 size_t tracedmp_used;
870 unsigned char *tracetry_buf;
871 size_t tracetry_used;
873 char traceatr_color_buf[2][80];
874 int traceatr_color_sel;
875 int traceatr_color_last;
876 #if !defined(USE_PTHREADS) && USE_REENTRANT
882 pthread_mutex_t mutex_curses;
883 pthread_mutex_t mutex_tst_tracef;
884 pthread_mutex_t mutex_tracef;
887 #define _nc_use_pthreads _nc_globals.use_pthreads
889 #if USE_PTHREADS_EINTR
890 pthread_t read_thread; /* The reading thread */
894 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
899 * Global data which can be swept up into a SCREEN when one is created.
900 * It may be modified before the next SCREEN is created.
905 attr_t previous_attr;
906 #ifndef USE_SP_RIPOFF
907 ripoff_t rippedoff[N_RIPS];
910 TPARM_STATE tparm_state;
911 TTY *saved_tty; /* savetty/resetty information */
912 #if NCURSES_NO_PADDING
913 bool _no_padding; /* flag to set if padding disabled */
915 NCURSES_SP_OUTC _outch; /* output handler if not putc */
916 #if BROKEN_LINKER || USE_REENTRANT
917 chtype *real_acs_map;
925 const char *_tputs_trace;
931 * Use screen-specific ripoff data (for softkeys) rather than global.
934 #define safe_ripoff_sp (sp)->rsp
935 #define safe_ripoff_stack (sp)->rippedoff
937 #define safe_ripoff_sp _nc_prescreen.rsp
938 #define safe_ripoff_stack _nc_prescreen.rippedoff
941 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
944 * The SCREEN structure.
948 int _ifd; /* input file ptr for screen */
949 FILE *_ofp; /* output file ptr for screen */
950 char *_setbuf; /* buffered I/O for output */
951 bool _filtered; /* filter() was called */
952 bool _buffered; /* setvbuf uses _setbuf data */
953 bool _prescreen; /* is in prescreen phase */
954 bool _use_env; /* LINES & COLS from environment? */
955 int _checkfd; /* filedesc for typeahead check */
956 TERMINAL *_term; /* terminal type information */
957 TTY _saved_tty; /* savetty/resetty information */
958 NCURSES_SIZE_T _lines; /* screen lines */
959 NCURSES_SIZE_T _columns; /* screen columns */
961 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
962 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
964 WINDOW *_curscr; /* current screen */
965 WINDOW *_newscr; /* virtual screen to be updated to */
966 WINDOW *_stdscr; /* screen's full-window context */
968 #define CurScreen(sp) (sp)->_curscr
969 #define NewScreen(sp) (sp)->_newscr
970 #define StdScreen(sp) (sp)->_stdscr
972 TRIES *_keytry; /* "Try" for use with keypad mode */
973 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
974 bool _tried; /* keypad mode was initialized */
975 bool _keypad_on; /* keypad mode is currently on */
977 bool _called_wgetch; /* check for recursion in wgetch() */
978 int _fifo[FIFO_SIZE]; /* input push-back buffer */
979 short _fifohead, /* head of fifo queue */
980 _fifotail, /* tail of fifo queue */
981 _fifopeek, /* where to peek for next char */
982 _fifohold; /* set if breakout marked */
984 int _endwin; /* are we out of window mode? */
985 NCURSES_CH_T *_current_attr; /* holds current attributes set */
986 int _coloron; /* is color enabled? */
987 int _color_defs; /* are colors modified */
988 int _cursor; /* visibility of the cursor */
989 int _cursrow; /* physical cursor row */
990 int _curscol; /* physical cursor column */
991 bool _notty; /* true if we cannot switch non-tty */
992 int _nl; /* True if NL -> CR/NL is on */
993 int _raw; /* True if in raw mode */
994 int _cbreak; /* 1 if in cbreak mode */
995 /* > 1 if in halfdelay mode */
996 int _echo; /* True if echo on */
997 int _use_meta; /* use the meta key? */
998 struct _SLK *_slk; /* ptr to soft key struct / NULL */
999 int slk_format; /* selected format for this screen */
1000 /* cursor movement costs; units are 10ths of milliseconds */
1001 #if NCURSES_NO_PADDING
1002 bool _no_padding; /* flag to set if padding disabled */
1004 int _char_padding; /* cost of character put */
1005 int _cr_cost; /* cost of (carriage_return) */
1006 int _cup_cost; /* cost of (cursor_address) */
1007 int _home_cost; /* cost of (cursor_home) */
1008 int _ll_cost; /* cost of (cursor_to_ll) */
1010 int _ht_cost; /* cost of (tab) */
1011 int _cbt_cost; /* cost of (backtab) */
1012 #endif /* USE_HARD_TABS */
1013 int _cub1_cost; /* cost of (cursor_left) */
1014 int _cuf1_cost; /* cost of (cursor_right) */
1015 int _cud1_cost; /* cost of (cursor_down) */
1016 int _cuu1_cost; /* cost of (cursor_up) */
1017 int _cub_cost; /* cost of (parm_cursor_left) */
1018 int _cuf_cost; /* cost of (parm_cursor_right) */
1019 int _cud_cost; /* cost of (parm_cursor_down) */
1020 int _cuu_cost; /* cost of (parm_cursor_up) */
1021 int _hpa_cost; /* cost of (column_address) */
1022 int _vpa_cost; /* cost of (row_address) */
1023 /* used in tty_update.c, must be chars */
1024 int _ed_cost; /* cost of (clr_eos) */
1025 int _el_cost; /* cost of (clr_eol) */
1026 int _el1_cost; /* cost of (clr_bol) */
1027 int _dch1_cost; /* cost of (delete_character) */
1028 int _ich1_cost; /* cost of (insert_character) */
1029 int _dch_cost; /* cost of (parm_dch) */
1030 int _ich_cost; /* cost of (parm_ich) */
1031 int _ech_cost; /* cost of (erase_chars) */
1032 int _rep_cost; /* cost of (repeat_char) */
1033 int _hpa_ch_cost; /* cost of (column_address) */
1034 int _cup_ch_cost; /* cost of (cursor_address) */
1035 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1036 int _inline_cost; /* cost of inline-move */
1037 int _smir_cost; /* cost of (enter_insert_mode) */
1038 int _rmir_cost; /* cost of (exit_insert_mode) */
1039 int _ip_cost; /* cost of (insert_padding) */
1040 /* used in lib_mvcur.c */
1041 char * _address_cursor;
1042 /* used in tty_update.c */
1043 int _scrolling; /* 1 if terminal's smart enough to */
1045 /* used in lib_color.c */
1046 color_t *_color_table; /* screen's color palette */
1047 int _color_count; /* count of colors in palette */
1048 colorpair_t *_color_pairs; /* screen's color pair list */
1049 int _pair_count; /* count of color pairs */
1050 int _pair_limit; /* actual limit of color-pairs */
1051 #if NCURSES_EXT_FUNCS
1052 bool _assumed_color; /* use assumed colors */
1053 bool _default_color; /* use default colors */
1054 bool _has_sgr_39_49; /* has ECMA default color support */
1055 int _default_fg; /* assumed default foreground */
1056 int _default_bg; /* assumed default background */
1057 int _default_pairs; /* count pairs using default color */
1059 chtype _ok_attributes; /* valid attributes for terminal */
1060 chtype _xmc_suppress; /* attributes to suppress if xmc */
1061 chtype _xmc_triggers; /* attributes to process if xmc */
1062 chtype * _acs_map; /* the real alternate-charset map */
1063 bool * _screen_acs_map;
1066 /* used in lib_vidattr.c */
1067 bool _use_rmso; /* true if we may use 'rmso' */
1068 bool _use_rmul; /* true if we may use 'rmul' */
1071 bool _extended_key; /* true if an extended key */
1075 * These data correspond to the state of the idcok() and idlok()
1076 * functions. A caveat is in order here: the XSI and SVr4
1077 * documentation specify that these functions apply to the window which
1078 * is given as an argument. However, ncurses implements this logic
1079 * only for the newscr/curscr update process, _not_ per-window.
1085 * These are the data that support the mouse interface.
1087 bool _mouse_initialized;
1088 MouseType _mouse_type;
1090 bool (*_mouse_event) (SCREEN *);
1091 bool (*_mouse_inline)(SCREEN *);
1092 bool (*_mouse_parse) (SCREEN *, int);
1093 void (*_mouse_resume)(SCREEN *);
1094 void (*_mouse_wrap) (SCREEN *);
1095 int _mouse_fd; /* file-descriptor, if any */
1096 bool _mouse_active; /* true if initialized */
1097 mmask_t _mouse_mask; /* set via mousemask() */
1098 mmask_t _mouse_mask2; /* OR's in press/release bits */
1099 mmask_t _mouse_bstate;
1100 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1101 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1102 MEVENT *_mouse_eventp; /* next free slot in event queue */
1105 bool _mouse_gpm_loaded;
1106 bool _mouse_gpm_found;
1109 TYPE_gpm_fd _mouse_gpm_fd;
1110 TYPE_Gpm_Open _mouse_Gpm_Open;
1111 TYPE_Gpm_Close _mouse_Gpm_Close;
1112 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1114 Gpm_Connect _mouse_gpm_connect;
1115 #endif /* USE_GPM_SUPPORT */
1119 int _emxmouse_thread;
1120 int _emxmouse_activated;
1121 char _emxmouse_buttons[4];
1125 MEVENT _sysmouse_fifo[FIFO_SIZE];
1128 int _sysmouse_char_width; /* character width */
1129 int _sysmouse_char_height; /* character height */
1130 int _sysmouse_old_buttons;
1131 int _sysmouse_new_buttons;
1134 #ifdef USE_TERM_DRIVER
1135 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1136 int _drv_mouse_head;
1137 int _drv_mouse_tail;
1138 int _drv_mouse_old_buttons;
1139 int _drv_mouse_new_buttons;
1142 * This supports automatic resizing
1145 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1149 * These are data that support the proper handling of the panel stack on an
1152 struct panelhook _panelHook;
1155 SCREEN *_next_screen;
1157 /* hashes for old and new lines */
1158 unsigned long *oldhash, *newhash;
1164 bool _cleanup; /* cleanup after int/quit signal */
1165 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1167 int _legacy_coding; /* see use_legacy_coding() */
1170 char _ttytype[NAMESIZE];
1177 const char *_tputs_trace;
1182 char tracechr_buf[40];
1183 char tracemse_buf[TRACEMSE_MAX];
1185 #ifdef USE_SP_WINDOWLIST
1186 WINDOWLIST* _windowlist;
1187 #define WindowList(sp) (sp)->_windowlist
1191 ripoff_t rippedoff[N_RIPS];
1195 * ncurses/ncursesw are the same up to this point.
1197 #if USE_WIDEC_SUPPORT
1198 /* recent versions of 'screen' have partially-working support for
1199 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1201 bool _screen_acs_fix;
1205 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1206 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1210 SCREEN *screen; /* screen containing the window */
1211 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1212 #if NCURSES_WIDECHAR
1213 char addch_work[(MB_LEN_MAX * 9) + 1];
1214 unsigned addch_used; /* number of bytes in addch_work[] */
1215 int addch_x; /* x-position for addch_work[] */
1216 int addch_y; /* y-position for addch_work[] */
1220 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1222 #define SP_PRE_INIT(sp) \
1223 sp->_cursrow = -1; \
1224 sp->_curscol = -1; \
1229 sp->_fifohead = -1; \
1230 sp->_endwin = TRUE; \
1232 WindowList(sp) = 0; \
1233 sp->_outch = NCURSES_SP_NAME(_nc_outch); \
1236 /* usually in <limits.h> */
1238 #define UCHAR_MAX 255
1241 /* The terminfo source is assumed to be 7-bit ASCII */
1242 #define is7bits(c) ((unsigned)(c) < 128)
1244 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1245 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1248 #define min(a,b) ((a) > (b) ? (b) : (a))
1252 #define max(a,b) ((a) < (b) ? (b) : (a))
1255 /* usually in <unistd.h> */
1256 #ifndef STDIN_FILENO
1257 #define STDIN_FILENO 0
1260 #ifndef STDOUT_FILENO
1261 #define STDOUT_FILENO 1
1264 #ifndef STDERR_FILENO
1265 #define STDERR_FILENO 2
1268 #ifndef EXIT_SUCCESS
1269 #define EXIT_SUCCESS 0
1272 #ifndef EXIT_FAILURE
1273 #define EXIT_FAILURE 1
1277 #define R_OK 4 /* Test for read permission. */
1280 #define W_OK 2 /* Test for write permission. */
1283 #define X_OK 1 /* Test for execute permission. */
1286 #define F_OK 0 /* Test for existence. */
1290 #include <fcntl.h> /* may define O_BINARY */
1299 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1301 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1304 #define COUNT_OUTCHARS(n) /* nothing */
1307 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1309 #define UChar(c) ((unsigned char)(c))
1310 #define UShort(c) ((unsigned short)(c))
1311 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
1312 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
1315 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1318 #if USE_WIDEC_SUPPORT /* { */
1319 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1321 #define init_mb(state) memset(&state, 0, sizeof(state))
1323 #if NCURSES_EXT_COLORS
1324 #define NulColor , 0
1326 #define NulColor /* nothing */
1329 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1330 #define CharOf(c) ((c).chars[0])
1331 #define AttrOf(c) ((c).attr)
1333 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1334 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1335 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1337 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1338 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1341 #define CharEq(a,b) (((a).attr == (b).attr) \
1342 && (a).chars[0] == (b).chars[0] \
1343 && (a).chars[1] == (b).chars[1] \
1344 && (a).chars[2] == (b).chars[2] \
1345 && (a).chars[3] == (b).chars[3] \
1346 && (a).chars[4] == (b).chars[4] \
1347 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1349 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1352 #define SetChar(ch,c,a) do { \
1353 NCURSES_CH_T *_cp = &ch; \
1354 memset(_cp, 0, sizeof(ch)); \
1355 _cp->chars[0] = (wchar_t) (c); \
1357 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1359 #define CHREF(wch) (&wch)
1360 #define CHDEREF(wch) (*wch)
1361 #define ARG_CH_T NCURSES_CH_T *
1362 #define CARG_CH_T const NCURSES_CH_T *
1363 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1364 mbstate_t PUT_st; wchar_t PUTC_ch
1365 #define PUTC_INIT init_mb (PUT_st)
1366 #define PUTC(ch,b) do { if(!isWidecExt(ch)) { \
1367 if (Charable(ch)) { \
1368 fputc(CharOf(ch), b); \
1369 COUNT_OUTCHARS(1); \
1372 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1373 PUTC_ch = (ch).chars[PUTC_i]; \
1374 if (PUTC_ch == L'\0') \
1376 PUTC_n = (int) wcrtomb(PUTC_buf, \
1377 (ch).chars[PUTC_i], &PUT_st); \
1378 if (PUTC_n <= 0) { \
1379 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1383 IGNORE_RC(fwrite(PUTC_buf, (size_t) PUTC_n, (size_t) 1, b)); \
1385 COUNT_OUTCHARS(PUTC_i); \
1388 #define BLANK NewChar2(' ', WA_NORMAL)
1389 #define ZEROS NewChar2('\0', WA_NORMAL)
1390 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1393 * Wide characters cannot be represented in the A_CHARTEXT mask of
1394 * attr_t's but an application might have set a narrow character there.
1395 * But even in that case, it would only be a printable character, or
1396 * zero. Otherwise we can use those bits to tell if a cell is the
1397 * first or extension part of a wide character.
1399 #define WidecExt(ch) (int) (AttrOf(ch) & A_CHARTEXT)
1400 #define isWidecBase(ch) (WidecExt(ch) == 1)
1401 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1402 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1403 AttrOf(dst) |= (attr_t) (ext + 1)
1405 #define if_WIDEC(code) code
1406 #define Charable(ch) ((SP_PARM != 0 && SP_PARM->_legacy_coding) \
1407 || (AttrOf(ch) & A_ALTCHARSET) \
1408 || (!isWidecExt(ch) && \
1409 (ch).chars[1] == L'\0' && \
1410 _nc_is_charable(CharOf(ch))))
1412 #define L(ch) L ## ch
1414 #define CharOf(c) ChCharOf(c)
1415 #define AttrOf(c) ChAttrOf(c)
1416 #define AddAttr(c,a) c |= (a)
1417 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1418 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1419 #define NewChar(ch) (ch)
1420 #define NewChar2(c,a) ((c) | (a))
1421 #define CharEq(a,b) ((a) == (b))
1422 #define SetChar(ch,c,a) ch = (c) | (a)
1423 #define CHREF(wch) wch
1424 #define CHDEREF(wch) wch
1425 #define ARG_CH_T NCURSES_CH_T
1426 #define CARG_CH_T NCURSES_CH_T
1427 #define PUTC_DATA int data = 0
1428 #define PUTC(ch,b) do { data = CharOf(ch); putc(data,b); } while (0)
1430 #define BLANK (' '|A_NORMAL)
1431 #define ZEROS ('\0'|A_NORMAL)
1432 #define ISBLANK(ch) (CharOf(ch) == ' ')
1434 #define isWidecExt(ch) (0)
1435 #define if_WIDEC(code) /* nothing */
1440 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1441 #define CharOfD(ch) CharOf(CHDEREF(ch))
1442 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1444 #define BLANK_ATTR A_NORMAL
1445 #define BLANK_TEXT L(' ')
1449 #define LEGALYX(w, y, x) \
1451 ((x) >= 0 && (x) <= (w)->_maxx && \
1452 (y) >= 0 && (y) <= (w)->_maxy))
1454 #define CHANGED_CELL(line,col) \
1455 if (line->firstchar == _NOCHANGE) \
1456 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1457 else if ((col) < line->firstchar) \
1458 line->firstchar = (NCURSES_SIZE_T) (col); \
1459 else if ((col) > line->lastchar) \
1460 line->lastchar = (NCURSES_SIZE_T) (col)
1462 #define CHANGED_RANGE(line,start,end) \
1463 if (line->firstchar == _NOCHANGE \
1464 || line->firstchar > (start)) \
1465 line->firstchar = (NCURSES_SIZE_T) (start); \
1466 if (line->lastchar == _NOCHANGE \
1467 || line->lastchar < (end)) \
1468 line->lastchar = (NCURSES_SIZE_T) (end)
1470 #define CHANGED_TO_EOL(line,start,end) \
1471 if (line->firstchar == _NOCHANGE \
1472 || line->firstchar > (start)) \
1473 line->firstchar = (NCURSES_SIZE_T) (start); \
1474 line->lastchar = (NCURSES_SIZE_T) (end)
1476 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1478 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1480 /* FreeAndNull() is not a comma-separated expression because some compilers
1481 * do not accept a mixture of void with values.
1483 #define FreeAndNull(p) free(p); p = 0
1485 #include <nc_alloc.h>
1488 * TTY bit definition for converting tabs to spaces.
1491 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1494 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1497 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1499 # define OFLAGS_TABS 0
1505 * Standardize/simplify common loops
1507 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1508 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1509 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1512 * Prefixes for call/return points of library function traces. We use these to
1513 * instrument the public functions so that the traces can be easily transformed
1514 * into regression scripts.
1516 #define T_CALLED(fmt) "called {" fmt
1517 #define T_CREATE(fmt) "create :" fmt
1518 #define T_RETURN(fmt) "return }" fmt
1523 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1525 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1528 #define START_TRACE() \
1529 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1530 int t = _nc_getenv_num("NCURSES_TRACE"); \
1532 trace((unsigned) t); \
1536 * Many of the _tracef() calls use static buffers; lock the trace state before
1537 * trying to fill them.
1540 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1541 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1542 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1544 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1545 #define _nc_locked_tracef _tracef
1548 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1549 #define T(a) TR(TRACE_CALLS, a)
1550 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1551 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1552 #define TRACE_RETURN_SP(value,type) return _nc_retrace_##type(SP_PARM, value)
1554 #define NonNull(s) ((s) != 0 ? s : "<null>")
1556 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1557 #define returnBits(code) TRACE_RETURN(code,unsigned)
1558 #define returnBool(code) TRACE_RETURN(code,bool)
1559 #define returnCPtr(code) TRACE_RETURN(code,cptr)
1560 #define returnCVoidPtr(code) TRACE_RETURN(code,cvoid_ptr)
1561 #define returnChar(code) TRACE_RETURN(code,char)
1562 #define returnChtype(code) TRACE_RETURN(code,chtype)
1563 #define returnCode(code) TRACE_RETURN(code,int)
1564 #define returnIntAttr(code) TRACE_RETURN2(code,int,attr_t)
1565 #define returnMMask(code) TRACE_RETURN_SP(code,mmask_t)
1566 #define returnPtr(code) TRACE_RETURN(code,ptr)
1567 #define returnSP(code) TRACE_RETURN(code,sp)
1568 #define returnVoid T((T_RETURN(""))); return
1569 #define returnVoidPtr(code) TRACE_RETURN(code,void_ptr)
1570 #define returnWin(code) TRACE_RETURN(code,win)
1572 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (int);
1573 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1574 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1575 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1576 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1577 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1578 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1579 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1580 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1581 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1582 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1583 extern NCURSES_EXPORT(char) _nc_retrace_char (int);
1584 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1585 extern NCURSES_EXPORT(int) _nc_retrace_int_attr_t (attr_t);
1586 extern NCURSES_EXPORT(mmask_t) _nc_retrace_mmask_t (SCREEN *, mmask_t);
1587 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1588 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1589 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1592 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1593 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1594 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1595 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1596 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1597 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1599 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1600 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1603 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1605 #if USE_WIDEC_SUPPORT
1606 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1607 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1610 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1611 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1615 #define START_TRACE() /* nothing */
1619 #define TPUTS_TRACE(s)
1621 #define returnAttr(code) return code
1622 #define returnBits(code) return code
1623 #define returnBool(code) return code
1624 #define returnCPtr(code) return code
1625 #define returnCVoidPtr(code) return code
1626 #define returnChar(code) return ((char) code)
1627 #define returnChtype(code) return code
1628 #define returnCode(code) return code
1629 #define returnIntAttr(code) return code
1630 #define returnMMask(code) return code
1631 #define returnPtr(code) return code
1632 #define returnSP(code) return code
1633 #define returnVoid return
1634 #define returnVoidPtr(code) return code
1635 #define returnWin(code) return code
1637 #endif /* TRACE/!TRACE */
1640 * Workaround for defective implementation of gcc attribute warn_unused_result
1642 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1643 #define IGNORE_RC(func) errno = (int) func
1645 #define IGNORE_RC(func) (void) func
1646 #endif /* gcc workarounds */
1649 * Return-codes for tgetent() and friends.
1651 #define TGETENT_YES 1 /* entry is found */
1652 #define TGETENT_NO 0 /* entry is not found */
1653 #define TGETENT_ERR -1 /* an error occurred */
1655 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1656 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1658 #define EMPTY_MODULE(name) \
1659 extern NCURSES_EXPORT(void) name (void); \
1660 NCURSES_EXPORT(void) name (void) { }
1662 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1663 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1664 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1666 #define toggle_attr_on(S,at) {\
1667 if (PairNumber(at) > 0) {\
1668 (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1670 (S) |= (attr_t) (at);\
1672 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1675 #define toggle_attr_off(S,at) {\
1676 if (PairNumber(at) > 0) {\
1677 (S) &= ~(at|A_COLOR);\
1681 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1683 #define DelCharCost(sp,count) \
1686 : ((delete_character != 0) \
1687 ? (sp->_dch1_cost * count) \
1690 #define InsCharCost(sp,count) \
1693 : ((enter_insert_mode && exit_insert_mode) \
1694 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1695 : ((insert_character != 0) \
1696 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1700 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1701 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1702 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1703 if (magic_cookie_glitch > 0 \
1704 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1705 T(("%s @%d before glitch %d,%d", \
1706 __FILE__, __LINE__, \
1709 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1713 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1714 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1719 * Macros to make additional parameter to implement wgetch_events()
1721 #ifdef NCURSES_WGETCH_EVENTS
1722 #define EVENTLIST_0th(param) param
1723 #define EVENTLIST_1st(param) param
1724 #define EVENTLIST_2nd(param) , param
1725 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1727 #define EVENTLIST_0th(param) void
1728 #define EVENTLIST_1st(param) /* nothing */
1729 #define EVENTLIST_2nd(param) /* nothing */
1730 #define TWAIT_MASK TW_ANY
1733 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1735 #undef toggle_attr_on
1736 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1737 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1739 #undef toggle_attr_off
1740 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1741 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1744 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1747 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1749 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1750 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1753 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1755 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1756 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1758 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1761 #if NCURSES_SP_FUNCS
1762 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1763 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1764 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1765 #endif /* NCURSES_SP_FUNCS */
1769 extern NCURSES_EXPORT(void) _nc_expanded (void);
1773 #if !NCURSES_EXT_FUNCS
1774 #define set_escdelay(value) ESCDELAY = value
1778 #define getcwd(buf,len) getwd(buf)
1782 #if USE_WIDEC_SUPPORT
1783 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1784 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1785 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1790 short nte_name; /* offset of name to hash on */
1791 int nte_type; /* BOOLEAN, NUMBER or STRING */
1792 short nte_index; /* index of associated variable in its array */
1793 short nte_link; /* index in table of next hash, or -1 */
1805 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1809 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1810 extern NCURSES_EXPORT(void) _nc_linedump (void);
1814 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1815 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1818 #if USE_WIDEC_SUPPORT
1819 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1823 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1824 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1828 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1831 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1834 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1837 #define INFINITY 1000000 /* cost: too high to use */
1839 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1840 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1841 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1843 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1845 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1846 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1847 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1850 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1853 #define INFINITY 1000000 /* cost: too high to use */
1854 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1857 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1858 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1859 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1860 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, int);
1861 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, int);
1863 /* lib_set_term.c */
1864 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1867 #define ret_error(code, fmt, arg) if (errret) {\
1871 fprintf(stderr, fmt, arg);\
1872 exit(EXIT_FAILURE);\
1875 #define ret_error1(code, fmt, arg) ret_error(code, "'%s': " fmt, arg)
1877 #define ret_error0(code, msg) if (errret) {\
1881 fprintf(stderr, msg);\
1882 exit(EXIT_FAILURE);\
1887 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1889 #define _nc_handle_sigwinch(a) /* nothing */
1893 #if USE_WIDEC_SUPPORT
1894 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1898 char *s_head; /* beginning of the string (may be null) */
1899 char *s_tail; /* end of the string (may be null) */
1900 size_t s_size; /* current remaining size available */
1901 size_t s_init; /* total size available */
1905 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1906 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1907 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1908 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1909 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1912 #define strstr _nc_strstr
1913 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1916 /* safe_sprintf.c */
1917 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1920 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1921 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1922 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1923 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1926 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
1927 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
1928 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
1929 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1930 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1931 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1932 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
1933 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
1934 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1935 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1936 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1937 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1938 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
1939 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1940 extern NCURSES_EXPORT(int) _nc_outch (int);
1941 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
1942 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
1943 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1944 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
1945 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
1946 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1947 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
1948 extern NCURSES_EXPORT(void) _nc_flush (void);
1949 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
1950 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
1951 extern NCURSES_EXPORT(void) _nc_freeall (void);
1952 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1953 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
1954 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1955 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1956 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1957 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1958 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
1959 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
1960 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1961 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1964 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1965 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1966 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
1967 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1968 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1969 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
1970 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1971 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
1972 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1975 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1976 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1977 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1978 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
1981 #if USE_WIDEC_SUPPORT
1982 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
1985 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1986 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1990 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
1994 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1996 #define _nc_resize_margins(wp) /* nothing */
1999 #ifdef NCURSES_WGETCH_EVENTS
2000 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2002 #define wgetch_events(win, evl) wgetch(win)
2003 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2007 * Wide-character macros to hide some platform-differences.
2009 #if USE_WIDEC_SUPPORT
2010 #if HAVE_MBTOWC && HAVE_MBLEN
2011 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2012 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2013 #define check_mbytes(wch,buffer,length,state) \
2014 (int) mbtowc(&wch, buffer, length)
2015 #define state_unused
2016 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2017 #define reset_mbytes(state) init_mb(state)
2018 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
2019 #define check_mbytes(wch,buffer,length,state) \
2020 (int) mbrtowc(&wch, buffer, length, &state)
2027 * Not everyone has vsscanf(), but we'd like to use it for scanw().
2030 extern int vsscanf(const char *str, const char *format, va_list __arg);
2033 /* scroll indices */
2034 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2036 #define USE_SETBUF_0 0
2038 #define NC_BUFFERED(sp,flag) NCURSES_SP_NAME(_nc_set_buffer)(NCURSES_SP_ARGx sp->_ofp, flag)
2040 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
2043 * On systems with a broken linker, define 'SP' as a function to force the
2044 * linker to pull in the data-only module with 'SP'.
2046 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2049 #define SP _nc_screen()
2050 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2051 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
2052 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
2053 #define CURRENT_SCREEN _nc_screen()
2055 /* current screen is private data; avoid possible linking conflicts too */
2056 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2057 #define CURRENT_SCREEN SP
2058 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
2059 #define _nc_set_screen(sp) SP = sp
2062 #if NCURSES_SP_FUNCS
2063 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2065 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
2069 * We don't want to use the lines or columns capabilities internally, because
2070 * if the application is running multiple screens under X, it's quite possible
2071 * they could all have type xterm but have different sizes! So...
2073 #define screen_lines(sp) (sp)->_lines
2074 #define screen_columns(sp) (sp)->_columns
2076 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2077 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2080 * Some constants related to SLK's
2082 #define MAX_SKEY_OLD 8 /* count of soft keys */
2083 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2084 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2085 #define MAX_SKEY_LEN_PC 5
2087 /* Macro to check whether or not we use a standard format */
2088 #define SLK_STDFMT(fmt) (fmt < 3)
2089 /* Macro to determine height of label window */
2090 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2092 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2093 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2096 * Common error messages
2098 #define MSG_NO_MEMORY "Out of memory"
2099 #define MSG_NO_INPUTS "Premature EOF"
2101 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2102 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2104 /* timed_wait flag definitions */
2108 #define TW_ANY (TW_INPUT | TW_MOUSE)
2111 #define SetSafeOutcWrapper(outc) \
2112 SCREEN* sp = CURRENT_SCREEN; \
2114 struct screen dummy; \
2116 memset(sp,0,sizeof(struct screen)); \
2117 sp->_outch = _nc_outc_wrapper; \
2121 #ifdef USE_TERM_DRIVER
2122 typedef void* TERM_HANDLE;
2124 typedef struct _termInfo
2143 const color_t* defaultPalette;
2146 typedef struct term_driver {
2148 bool (*CanHandle)(struct DriverTCB*, const char*, int*);
2149 void (*init)(struct DriverTCB*);
2150 void (*release)(struct DriverTCB*);
2151 int (*size)(struct DriverTCB*, int* Line, int *Cols);
2152 int (*sgmode)(struct DriverTCB*, int setFlag, TTY*);
2153 chtype (*conattr)(struct DriverTCB*);
2154 int (*hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2155 int (*mode)(struct DriverTCB*, int progFlag, int defFlag);
2156 bool (*rescol)(struct DriverTCB*);
2157 bool (*rescolors)(struct DriverTCB*);
2158 void (*color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2159 int (*doBeepOrFlash)(struct DriverTCB*, int);
2160 void (*initpair)(struct DriverTCB*, int, int, int);
2161 void (*initcolor)(struct DriverTCB*, int, int, int, int);
2162 void (*docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2163 void (*initmouse)(struct DriverTCB*);
2164 int (*testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2165 void (*setfilter)(struct DriverTCB*);
2166 void (*hwlabel)(struct DriverTCB*, int, char*);
2167 void (*hwlabelOnOff)(struct DriverTCB*, int);
2168 int (*update)(struct DriverTCB*);
2169 int (*defaultcolors)(struct DriverTCB*, int, int);
2170 int (*print)(struct DriverTCB*, char*, int);
2171 int (*getsize)(struct DriverTCB*, int*, int*);
2172 int (*setsize)(struct DriverTCB*, int, int);
2173 void (*initacs)(struct DriverTCB*, chtype*, chtype*);
2174 void (*scinit)(SCREEN *);
2175 void (*scexit)(SCREEN *);
2176 int (*twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2177 int (*read)(struct DriverTCB*, int*);
2178 int (*nap)(struct DriverTCB*, int);
2179 int (*kpad)(struct DriverTCB*, int);
2180 int (*kyOk)(struct DriverTCB*, int, int);
2181 bool (*kyExist)(struct DriverTCB*, int);
2184 typedef struct DriverTCB
2186 TERMINAL term; /* needs to be the first Element !!! */
2187 TERM_HANDLE inp; /* The input handle of the Terminal */
2188 TERM_HANDLE out; /* The output handle of the Terminal in shell mode */
2189 TERM_HANDLE hdl; /* The output handle of the Terminal in prog mode */
2190 TERM_DRIVER* drv; /* The driver for that Terminal */
2191 SCREEN* csp; /* The screen that owns that Terminal */
2192 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2193 void* prop; /* Driver dependent property storage to be used by the Driver */
2195 } TERMINAL_CONTROL_BLOCK;
2197 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2198 #define NCDRV_TINFO 0x01
2199 #define NCDRV_WINCONSOLE 0x02
2201 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2202 #define InfoOf(sp) TCBOf(sp)->info
2203 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2204 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2205 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2206 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2207 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2209 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2210 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2212 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2213 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2214 #endif /* USE_TERM_DRIVER */
2217 * Entrypoints which are actually provided in the terminal driver, which would
2218 * be an sp-name otherwise.
2220 #ifdef USE_TERM_DRIVER
2221 #define TINFO_HAS_KEY _nc_tinfo_has_key
2222 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2223 #define TINFO_MVCUR _nc_tinfo_mvcur
2224 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2225 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2226 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2228 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2229 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2230 #define TINFO_MVCUR NCURSES_SP_NAME(mvcur)
2234 * Entrypoints using an extra parameter with the terminal driver.
2236 #ifdef USE_TERM_DRIVER
2237 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2238 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, int);
2239 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2240 _nc_get_screensize(sp, tp, lp, cp)
2241 #define TINFO_SET_CURTERM(sp, tp) \
2242 NCURSES_SP_NAME(set_curterm)(sp, tp)
2243 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2244 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2245 #else /* !USE_TERM_DRIVER */
2246 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2247 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2248 _nc_get_screensize(sp, lp, cp)
2249 #define TINFO_SET_CURTERM(sp, tp) \
2251 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2252 _nc_setupterm(name, fd, err, reuse)
2253 #endif /* !USE_TERM_DRIVER */
2255 #ifdef USE_TERM_DRIVER
2257 #include <nc_mingw.h>
2258 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2260 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2263 #ifdef USE_TERM_DRIVER
2264 #define IsTermInfo(sp) (TCBOf(sp) && ((TCBOf(sp)->drv->isTerminfo)))
2266 #define IsTermInfo(sp) TRUE
2269 #define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2270 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2273 * Exported entrypoints beyond the published API
2275 #if NCURSES_SP_FUNCS
2276 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2277 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2278 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2279 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2282 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2283 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2286 #if NCURSES_EXT_FUNCS
2287 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2291 * We put the safe versions of various calls here as they are not published
2292 * part of the API up to now
2294 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2295 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2296 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2297 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2298 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2299 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2300 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2301 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2302 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2303 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2304 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2305 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2306 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2307 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2308 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2309 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2310 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2311 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2312 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2313 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2314 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2315 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2316 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2317 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, short, void *);
2318 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2319 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2320 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2321 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2322 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2323 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2324 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2325 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2326 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2327 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2328 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2329 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2330 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2331 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2332 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2333 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2334 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2335 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2337 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2339 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2340 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2343 #if USE_WIDEC_SUPPORT
2344 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2347 #endif /* NCURSES_SP_FUNCS */
2349 #if NCURSES_SP_FUNCS
2351 #define safe_keyname NCURSES_SP_NAME(keyname)
2352 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2353 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2357 #define safe_keyname _nc_keyname
2358 #define safe_unctrl _nc_unctrl
2359 #define safe_ungetch _nc_ungetch
2361 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2362 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2363 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2373 #endif /* CURSES_PRIV_H */