libncurses: updated to 6.0
[tomato.git] / release / src / router / libncurses / ncurses / curses.priv.h
blobec17d884c071c2d1db99ad6585856cbfcf94960c
1 /****************************************************************************
2 * Copyright (c) 1998-2014,2015 Free Software Foundation, Inc. *
3 * *
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: *
11 * *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
14 * *
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. *
22 * *
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 *
26 * authorization. *
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.547 2015/06/27 01:22:16 tom Exp $
39 * curses.priv.h
41 * Header file for curses library objects which are private to
42 * the library.
46 #ifndef CURSES_PRIV_H
47 #define CURSES_PRIV_H 1
48 /* *INDENT-OFF* */
50 #include <ncurses_dll.h>
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
56 #include <ncurses_cfg.h>
58 #if USE_RCS_IDS
59 #define MODULE_ID(id) static const char Ident[] = id;
60 #else
61 #define MODULE_ID(id) /*nothing*/
62 #endif
64 #include <stddef.h> /* for offsetof */
65 #include <stdlib.h>
66 #include <string.h>
67 #include <sys/types.h>
68 #include <sys/stat.h>
70 #if HAVE_UNISTD_H
71 #include <unistd.h>
72 #endif
74 #if HAVE_SYS_BSDTYPES_H
75 #include <sys/bsdtypes.h> /* needed for ISC */
76 #endif
78 #if HAVE_LIMITS_H
79 # include <limits.h>
80 #elif HAVE_SYS_PARAM_H
81 # include <sys/param.h>
82 #endif
84 #include <assert.h>
85 #include <stdio.h>
87 #include <errno.h>
89 #if defined __hpux
90 # ifndef EILSEQ
91 # define EILSEQ 47
92 # endif
93 #endif
95 #ifndef PATH_MAX
96 # if defined(_POSIX_PATH_MAX)
97 # define PATH_MAX _POSIX_PATH_MAX
98 # elif defined(MAXPATHLEN)
99 # define PATH_MAX MAXPATHLEN
100 # else
101 # define PATH_MAX 255 /* the Posix minimum path-size */
102 # endif
103 #endif
105 #if DECL_ERRNO
106 extern int errno;
107 #endif
109 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
110 #if HAVE_WORKING_POLL
111 #define USE_FUNC_POLL 1
112 #if HAVE_POLL_H
113 #include <poll.h>
114 #else
115 #include <sys/poll.h>
116 #endif
117 #else
118 #define USE_FUNC_POLL 0
119 #endif
121 #if HAVE_INTTYPES_H
122 # include <inttypes.h>
123 #else
124 # if HAVE_STDINT_H
125 # include <stdint.h>
126 # endif
127 #endif
129 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
130 #include <signal.h>
132 /* Alessandro Rubini's GPM (general-purpose mouse) */
133 #if HAVE_LIBGPM && HAVE_GPM_H
134 #define USE_GPM_SUPPORT 1
135 #else
136 #define USE_GPM_SUPPORT 0
137 #endif
139 /* QNX mouse support */
140 #if defined(__QNX__) && !defined(__QNXNTO__)
141 #define USE_QNX_MOUSE 1
142 #else
143 #define USE_QNX_MOUSE 0
144 #endif
146 /* EMX mouse support */
147 #ifdef __EMX__
148 #define USE_EMX_MOUSE 1
149 #else
150 #define USE_EMX_MOUSE 0
151 #endif
153 /* kLIBC keyboard/mouse support */
154 #if defined(__OS2__) && defined(__KLIBC__)
155 #define USE_KLIBC_KBD 1
156 #define USE_KLIBC_MOUSE 1
157 #else
158 #define USE_KLIBC_KBD 0
159 #define USE_KLIBC_MOUSE 0
160 #endif
162 #define DEFAULT_MAXCLICK 166
163 #define EV_MAX 8 /* size of mouse circular event queue */
166 * If we don't have signals to support it, don't add a sigwinch handler.
167 * In any case, resizing is an extended feature. Use it if we've got it.
169 #if !NCURSES_EXT_FUNCS
170 #undef HAVE_SIZECHANGE
171 #define HAVE_SIZECHANGE 0
172 #endif
174 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
175 #define USE_SIZECHANGE 1
176 #else
177 #define USE_SIZECHANGE 0
178 #undef USE_SIGWINCH
179 #define USE_SIGWINCH 0
180 #endif
183 * When building in the MSYS2 environment, the automatic discovery of
184 * the path separator in configure doesn't work properly. So, if building
185 * for MinGW, we enforce the correct Windows PATH separator
187 #ifdef __MINGW32__
188 # ifdef NCURSES_PATHSEP
189 # undef NCURSES_PATHSEP
190 # endif
191 # define NCURSES_PATHSEP ';'
192 #endif
195 * If desired, one can configure this, disabling environment variables that
196 * point to custom terminfo/termcap locations.
198 #ifdef USE_ROOT_ENVIRON
199 #define use_terminfo_vars() 1
200 #else
201 #define use_terminfo_vars() _nc_env_access()
202 extern NCURSES_EXPORT(int) _nc_env_access (void);
203 #endif
206 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
207 * have neither).
209 #if USE_OK_BCOPY
210 #define memmove(d,s,n) bcopy(s,d,n)
211 #elif USE_MY_MEMMOVE
212 #define memmove(d,s,n) _nc_memmove(d,s,n)
213 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
214 #endif
217 * If we have va_copy(), use it for assigning va_list's.
219 #if defined(HAVE___VA_COPY)
220 #define begin_va_copy(dst,src) __va_copy(dst, src)
221 #define end_va_copy(dst) va_end(dst)
222 #elif defined(va_copy) || defined(HAVE_VA_COPY)
223 #define begin_va_copy(dst,src) va_copy(dst, src)
224 #define end_va_copy(dst) va_end(dst)
225 #else
226 #define begin_va_copy(dst,src) (dst) = (src)
227 #define end_va_copy(dst) /* nothing */
228 #endif
231 * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
232 * lack one or the other.
234 #ifndef S_ISDIR
235 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
236 #endif
238 #ifndef S_ISREG
239 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
240 #endif
243 * Scroll hints are useless when hashmap is used
245 #if !USE_SCROLL_HINTS
246 #if !USE_HASHMAP
247 #define USE_SCROLL_HINTS 1
248 #else
249 #define USE_SCROLL_HINTS 0
250 #endif
251 #endif
253 #if USE_SCROLL_HINTS
254 #define if_USE_SCROLL_HINTS(stmt) stmt
255 #else
256 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
257 #endif
259 #include <nc_string.h>
262 * Options for terminal drivers, etc...
264 #ifdef USE_TERM_DRIVER
265 #define USE_SP_RIPOFF 1
266 #define USE_SP_TERMTYPE 1
267 #define USE_SP_WINDOWLIST 1
268 #endif
271 * Note: ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
272 * when we're throwing control codes at the screen at high volume. To see
273 * this, re-enable USE_HARD_TABS and run worm for a while. Other systems
274 * probably don't want to define this either due to uncertainties about tab
275 * delays and expansion in raw mode.
278 #define TRIES struct tries
279 typedef TRIES {
280 TRIES *child; /* ptr to child. NULL if none */
281 TRIES *sibling; /* ptr to sibling. NULL if none */
282 unsigned char ch; /* character at this node */
283 unsigned short value; /* code of string so far. 0 if none. */
284 #undef TRIES
285 } TRIES;
288 * Common/troublesome character definitions
290 #define StringOf(ch) {ch, 0}
292 #define L_BRACE '{'
293 #define R_BRACE '}'
294 #define S_QUOTE '\''
295 #define D_QUOTE '"'
297 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
300 * Structure for palette tables
303 #define MAXCOLUMNS 135
304 #define MAXLINES 66
305 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
307 #define ACS_LEN 128
309 #define WINDOWLIST struct _win_list
311 #if USE_WIDEC_SUPPORT
312 #define _nc_bkgd _bkgrnd
313 #else
314 #undef _XOPEN_SOURCE_EXTENDED
315 #undef _XPG5
316 #define _nc_bkgd _bkgd
317 #define wgetbkgrnd(win, wch) ((*wch = win->_bkgd) != 0 ? OK : ERR)
318 #define wbkgrnd wbkgd
319 #endif
321 #undef NCURSES_OPAQUE
322 #define NCURSES_INTERNALS 1
323 #define NCURSES_OPAQUE 0
325 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
327 typedef struct
329 NCURSES_COLOR_T red, green, blue; /* what color_content() returns */
330 NCURSES_COLOR_T r, g, b; /* params to init_color() */
331 int init; /* true if we called init_color() */
333 color_t;
336 * If curses.h did not expose the SCREEN-functions, then we do not need the
337 * parameter in the corresponding unextended functions.
340 #define USE_SP_FUNC_SUPPORT NCURSES_SP_FUNCS
341 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
343 #if NCURSES_SP_FUNCS
344 #define SP_PARM sp /* use parameter */
345 #define NCURSES_SP_ARG SP_PARM
346 #define NCURSES_SP_DCL SCREEN *NCURSES_SP_ARG
347 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
348 #define NCURSES_SP_ARGx NCURSES_SP_ARG,
349 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
350 #else
351 #define SP_PARM SP /* use global variable */
352 #define NCURSES_SP_ARG
353 #define NCURSES_SP_DCL
354 #define NCURSES_SP_DCL0 void
355 #define NCURSES_SP_ARGx
356 #define NCURSES_SP_DCLx
357 #endif
359 #include <nc_panel.h>
361 #define IsPreScreen(sp) (((sp) != 0) && sp->_prescreen)
362 #define HasTerminal(sp) (((sp) != 0) && (0 != ((sp)->_term)))
363 #define IsValidScreen(sp) (HasTerminal(sp) && !IsPreScreen(sp))
365 #if USE_REENTRANT
366 #define CurTerm _nc_prescreen._cur_term
367 #else
368 #define CurTerm cur_term
369 #endif
371 #if NCURSES_SP_FUNCS
372 #define TerminalOf(sp) ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
373 #else
374 #define TerminalOf(sp) CurTerm
375 #endif
377 #include <term.h>
378 #include <nc_termios.h>
381 * Reduce dependency on cur_term global by using terminfo data from SCREEN's
382 * pointer to this data.
384 #ifdef USE_SP_TERMTYPE
385 #undef CUR
386 #endif
388 #define SP_TERMTYPE TerminalOf(sp)->type.
390 #include <term_entry.h>
392 #include <nc_tparm.h>
395 * Simplify ifdef's for the "*_ATTR" macros in case italics are not configured.
397 #ifdef A_ITALIC
398 #define USE_ITALIC 1
399 #else
400 #define USE_ITALIC 0
401 #define A_ITALIC 0
402 #endif
405 * Use these macros internally, to make tracing less verbose. But leave the
406 * option for compiling the tracing into the library.
408 #if 1
409 #define ColorPair(n) NCURSES_BITS(n, 0)
410 #define PairNumber(a) (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
411 #else
412 #define ColorPair(pair) COLOR_PAIR(pair)
413 #define PairNumber(attr) PAIR_NUMBER(attr)
414 #endif
416 #define unColor(n) unColor2(AttrOf(n))
417 #define unColor2(a) ((a) & ALL_BUT_COLOR)
420 * Extended-colors stores the color pair in a separate struct-member than the
421 * attributes. But for compatibility, we handle most cases where a program
422 * written for non-extended colors stores the color in the attributes by
423 * checking for a color pair in both places.
425 #if NCURSES_EXT_COLORS
426 #define if_EXT_COLORS(stmt) stmt
427 #define SetPair(value,p) SetPair2((value).ext_color, AttrOf(value), p)
428 #define SetPair2(c,a,p) c = (p), \
429 a = (unColor2(a) | (A_COLOR & (unsigned) ColorPair(oldColor(c))))
430 #define GetPair(value) GetPair2((value).ext_color, AttrOf(value))
431 #define GetPair2(c,a) ((c) ? (c) : PairNumber(a))
432 #define oldColor(p) (((p) > 255) ? 255 : (p))
433 #define GET_WINDOW_PAIR(w) GetPair2((w)->_color, (w)->_attrs)
434 #define SET_WINDOW_PAIR(w,p) (w)->_color = (p)
435 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
437 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vid_puts)(NCURSES_SP_ARGx attr, (short) pair, 0, NCURSES_OUTC_FUNC)
439 #else /* !NCURSES_EXT_COLORS */
441 #define if_EXT_COLORS(stmt) /* nothing */
442 #define SetPair(value,p) RemAttr(value, A_COLOR), \
443 SetAttr(value, AttrOf(value) | (A_COLOR & (attr_t) ColorPair(p)))
444 #define GetPair(value) PairNumber(AttrOf(value))
445 #define GET_WINDOW_PAIR(w) PairNumber(WINDOW_ATTRS(w))
446 #define SET_WINDOW_PAIR(w,p) WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
447 WINDOW_ATTRS(w) |= (A_COLOR & (attr_t) ColorPair(p))
448 #define SameAttrOf(a,b) (AttrOf(a) == AttrOf(b))
450 #define VIDATTR(sp,attr,pair) NCURSES_SP_NAME(vidputs)(NCURSES_SP_ARGx attr, NCURSES_OUTC_FUNC)
452 #endif /* NCURSES_EXT_COLORS */
454 #define NCURSES_OUTC_FUNC NCURSES_SP_NAME(_nc_outch)
455 #define NCURSES_PUTP2(name,value) NCURSES_SP_NAME(_nc_putp)(NCURSES_SP_ARGx name, value)
456 #define NCURSES_PUTP2_FLUSH(name,value) NCURSES_SP_NAME(_nc_putp_flush)(NCURSES_SP_ARGx name, value)
458 #if NCURSES_NO_PADDING
459 #define GetNoPadding(sp) ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
460 #define SetNoPadding(sp) _nc_set_no_padding(sp)
461 extern NCURSES_EXPORT(void) _nc_set_no_padding(SCREEN *);
462 #else
463 #define GetNoPadding(sp) FALSE
464 #define SetNoPadding(sp) /*nothing*/
465 #endif
467 #define WINDOW_ATTRS(w) ((w)->_attrs)
469 #define SCREEN_ATTRS(s) (*((s)->_current_attr))
470 #define GET_SCREEN_PAIR(s) GetPair(SCREEN_ATTRS(s))
471 #define SET_SCREEN_PAIR(s,p) SetPair(SCREEN_ATTRS(s), p)
473 #if USE_REENTRANT || NCURSES_SP_FUNCS
474 NCURSES_EXPORT(int *) _nc_ptr_Lines (SCREEN *);
475 NCURSES_EXPORT(int *) _nc_ptr_Cols (SCREEN *);
476 NCURSES_EXPORT(int *) _nc_ptr_Tabsize (SCREEN *);
477 NCURSES_EXPORT(int *) _nc_ptr_Escdelay (SCREEN *);
478 #endif
480 #if USE_REENTRANT
482 #define ptrLines(sp) (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
483 #define ptrCols(sp) (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
484 #define ptrTabsize(sp) (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
485 #define ptrEscdelay(sp) (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
487 #define SET_LINES(value) *_nc_ptr_Lines(SP_PARM) = value
488 #define SET_COLS(value) *_nc_ptr_Cols(SP_PARM) = value
489 #define SET_TABSIZE(value) *_nc_ptr_Tabsize(SP_PARM) = value
490 #define SET_ESCDELAY(value) *_nc_ptr_Escdelay(SP_PARM) = value
492 #else
494 #define ptrLines(sp) &LINES
495 #define ptrCols(sp) &COLS
496 #define ptrTabsize(sp) &TABSIZE
497 #define ptrEscdelay(sp) &ESCDELAY
499 #define SET_LINES(value) LINES = value
500 #define SET_COLS(value) COLS = value
501 #define SET_TABSIZE(value) TABSIZE = value
502 #define SET_ESCDELAY(value) ESCDELAY = value
504 #endif
506 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
507 __FILE__, __LINE__, \
508 (unsigned long) (pthread_self()), \
509 data.__data.__lock, \
510 data.__data.__count, \
511 data.__data.__owner, \
512 data.__data.__kind, \
513 (data.__data.__nusers > 5) ? " OOPS " : "", \
514 data.__data.__nusers)
515 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
517 #if USE_WEAK_SYMBOLS
518 #if defined(__GNUC__)
519 # if defined __USE_ISOC99
520 # define _cat_pragma(exp) _Pragma(#exp)
521 # define _weak_pragma(exp) _cat_pragma(weak name)
522 # else
523 # define _weak_pragma(exp)
524 # endif
525 # define _declare(name) __extension__ extern __typeof__(name) name
526 # define weak_symbol(name) _weak_pragma(name) _declare(name) __attribute__((weak))
527 #else
528 # undef USE_WEAK_SYMBOLS
529 # define USE_WEAK_SYMBOLS 0
530 #endif
531 #endif
533 #ifdef USE_PTHREADS
535 #if USE_REENTRANT
536 #include <pthread.h>
537 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
538 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
539 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
540 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
541 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
542 #define _nc_lock_global(name) _nc_mutex_lock(&_nc_globals.mutex_##name)
543 #define _nc_try_global(name) _nc_mutex_trylock(&_nc_globals.mutex_##name)
544 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
546 #else
547 #error POSIX threads requires --enable-reentrant option
548 #endif
550 #ifdef USE_PTHREADS
551 # if USE_WEAK_SYMBOLS
552 weak_symbol(pthread_sigmask);
553 weak_symbol(pthread_kill);
554 weak_symbol(pthread_self);
555 weak_symbol(pthread_equal);
556 weak_symbol(pthread_mutex_init);
557 weak_symbol(pthread_mutex_lock);
558 weak_symbol(pthread_mutex_unlock);
559 weak_symbol(pthread_mutex_trylock);
560 weak_symbol(pthread_mutexattr_settype);
561 weak_symbol(pthread_mutexattr_init);
562 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
563 # undef sigprocmask
564 # define sigprocmask _nc_sigprocmask
565 # endif
566 #endif
568 #if HAVE_NANOSLEEP
569 #undef HAVE_NANOSLEEP
570 #define HAVE_NANOSLEEP 0 /* nanosleep suspends all threads */
571 #endif
573 #else /* !USE_PTHREADS */
575 #if USE_PTHREADS_EINTR
576 # if USE_WEAK_SYMBOLS
577 #include <pthread.h>
578 weak_symbol(pthread_sigmask);
579 weak_symbol(pthread_kill);
580 weak_symbol(pthread_self);
581 weak_symbol(pthread_equal);
582 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
583 # undef sigprocmask
584 # define sigprocmask _nc_sigprocmask
585 # endif
586 #endif /* USE_PTHREADS_EINTR */
588 #define _nc_init_pthreads() /* nothing */
589 #define _nc_mutex_init(obj) /* nothing */
591 #define _nc_lock_global(name) /* nothing */
592 #define _nc_try_global(name) 0
593 #define _nc_unlock_global(name) /* nothing */
595 #endif /* USE_PTHREADS */
598 * When using sp-funcs, locks are targeted to SCREEN-level granularity.
599 * So the locking is done in the non-sp-func (which calls the sp-func) rather
600 * than in the sp-func itself.
602 * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
603 * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
605 #if NCURSES_SP_FUNCS
607 #define _nc_nonsp_lock_global(name) /* nothing */
608 #define _nc_nonsp_try_global(name) 0
609 #define _nc_nonsp_unlock_global(name) /* nothing */
611 #define _nc_sp_lock_global(name) _nc_lock_global(name)
612 #define _nc_sp_try_global(name) _nc_try_global(name)
613 #define _nc_sp_unlock_global(name) _nc_unlock_global(name)
615 #else
617 #define _nc_nonsp_lock_global(name) _nc_lock_global(name)
618 #define _nc_nonsp_try_global(name) _nc_try_global(name)
619 #define _nc_nonsp_unlock_global(name) _nc_unlock_global(name)
621 #define _nc_sp_lock_global(name) /* nothing */
622 #define _nc_sp_try_global(name) 0
623 #define _nc_sp_unlock_global(name) /* nothing */
625 #endif
627 #if HAVE_GETTIMEOFDAY
628 # define PRECISE_GETTIME 1
629 # define TimeType struct timeval
630 #else
631 # define PRECISE_GETTIME 0
632 # define TimeType time_t
633 #endif
636 * Definitions for color pairs
638 typedef unsigned colorpair_t; /* type big enough to store PAIR_OF() */
639 #define C_SHIFT 9 /* we need more bits than there are colors */
640 #define C_MASK ((1 << C_SHIFT) - 1)
641 #define PAIR_OF(fg, bg) (colorpair_t) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
642 #define FORE_OF(c) (((c) >> C_SHIFT) & C_MASK)
643 #define BACK_OF(c) ((c) & C_MASK)
644 #define isDefaultColor(c) ((c) >= COLOR_DEFAULT || (c) < 0)
646 #define COLOR_DEFAULT C_MASK
648 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
650 #undef NCURSES_CH_T /* this is not a termlib feature */
651 #define NCURSES_CH_T void /* ...but we need a pointer in SCREEN */
653 #endif /* USE_TERMLIB */
655 #ifndef USE_TERMLIB
656 struct ldat
658 NCURSES_CH_T *text; /* text of the line */
659 NCURSES_SIZE_T firstchar; /* first changed character in the line */
660 NCURSES_SIZE_T lastchar; /* last changed character in the line */
661 NCURSES_SIZE_T oldindex; /* index of the line at last update */
663 #endif /* USE_TERMLIB */
665 typedef enum {
666 M_XTERM = -1 /* use xterm's mouse tracking? */
667 ,M_NONE = 0 /* no mouse device */
668 #if USE_GPM_SUPPORT
669 ,M_GPM /* use GPM */
670 #endif
671 #if USE_SYSMOUSE
672 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
673 #endif
674 #ifdef USE_TERM_DRIVER
675 ,M_TERM_DRIVER /* Win32 console, etc */
676 #endif
677 } MouseType;
679 typedef enum {
680 MF_X10 = 0 /* conventional 3-byte format */
681 , MF_SGR1006 /* xterm private mode 1006, SGR-style */
682 #ifdef EXP_XTERM_1005
683 , MF_XTERM_1005 /* xterm UTF-8 private mode 1005 */
684 #endif
685 } MouseFormat;
688 * Structures for scrolling.
691 typedef struct {
692 unsigned long hashval;
693 int oldcount, newcount;
694 int oldindex, newindex;
695 } HASHMAP;
698 * Structures for soft labels.
701 struct _SLK;
703 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
705 typedef struct
707 char *ent_text; /* text for the label */
708 char *form_text; /* formatted text (left/center/...) */
709 int ent_x; /* x coordinate of this field */
710 char dirty; /* this label has changed */
711 char visible; /* field is visible */
712 } slk_ent;
714 typedef struct _SLK {
715 bool dirty; /* all labels have changed */
716 bool hidden; /* soft labels are hidden */
717 WINDOW *win;
718 slk_ent *ent;
719 short maxlab; /* number of available labels */
720 short labcnt; /* number of allocated labels */
721 short maxlen; /* length of labels */
722 NCURSES_CH_T attr; /* soft label attribute */
723 } SLK;
725 #endif /* USE_TERMLIB */
727 typedef struct {
728 WINDOW *win; /* the window used in the hook */
729 int line; /* lines to take, < 0 => from bottom*/
730 int (*hook)(WINDOW *, int); /* callback for user */
731 } ripoff_t;
733 #if USE_GPM_SUPPORT
734 #undef buttons /* term.h defines this, and gpm uses it! */
735 #include <gpm.h>
736 #if USE_WEAK_SYMBOLS
737 weak_symbol(Gpm_Wgetch);
738 #endif
740 #ifdef HAVE_LIBDL
741 /* link dynamically to GPM */
742 typedef int *TYPE_gpm_fd;
743 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
744 typedef int (*TYPE_Gpm_Close) (void);
745 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
747 #define my_gpm_fd SP_PARM->_mouse_gpm_fd
748 #define my_Gpm_Open SP_PARM->_mouse_Gpm_Open
749 #define my_Gpm_Close SP_PARM->_mouse_Gpm_Close
750 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
751 #else
752 /* link statically to GPM */
753 #define my_gpm_fd &gpm_fd
754 #define my_Gpm_Open Gpm_Open
755 #define my_Gpm_Close Gpm_Close
756 #define my_Gpm_GetEvent Gpm_GetEvent
757 #endif /* HAVE_LIBDL */
758 #endif /* USE_GPM_SUPPORT */
760 typedef struct {
761 long sequence;
762 bool last_used;
763 char *fix_sgr0; /* this holds the filtered sgr0 string */
764 char *last_bufp; /* help with fix_sgr0 leak */
765 TERMINAL *last_term;
766 } TGETENT_CACHE;
768 #define TGETENT_MAX 4
771 * State of tparm().
773 #define STACKSIZE 20
775 typedef struct {
776 union {
777 int num;
778 char *str;
779 } data;
780 bool num_type;
781 } STACK_FRAME;
783 #define NUM_VARS 26
785 typedef struct {
786 #ifdef TRACE
787 const char *tname;
788 #endif
789 const char *tparam_base;
791 STACK_FRAME stack[STACKSIZE];
792 int stack_ptr;
794 char *out_buff;
795 size_t out_size;
796 size_t out_used;
798 char *fmt_buff;
799 size_t fmt_size;
801 int dynamic_var[NUM_VARS];
802 int static_vars[NUM_VARS];
803 } TPARM_STATE;
805 typedef struct {
806 char *text;
807 size_t size;
808 } TRACEBUF;
811 * The filesystem database normally uses a single-letter for the lower level
812 * of directories. Use a hexadecimal code for filesystems which do not
813 * preserve mixed-case names.
815 #if MIXEDCASE_FILENAMES
816 #define LEAF_FMT "%c"
817 #define LEAF_LEN 1
818 #else
819 #define LEAF_FMT "%02x"
820 #define LEAF_LEN 2
821 #endif
824 * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
825 * could at most have 10 digits, and the mask contains no more than 32 bits
826 * with each bit representing less than 15 characters. Usually the whole
827 * string is less than 80 columns, but this buffer size is an absolute
828 * limit.
830 #define TRACEMSE_MAX (80 + (5 * 10) + (32 * 15))
831 #define TRACEMSE_FMT "id %2d at (%2d, %2d, %2d) state %4lx = {" /* } */
833 #ifdef USE_TERM_DRIVER
834 struct DriverTCB; /* Terminal Control Block forward declaration */
835 #define INIT_TERM_DRIVER() _nc_globals.term_driver = _nc_get_driver
836 #else
837 #define INIT_TERM_DRIVER() /* nothing */
838 #endif
840 typedef struct {
841 const char *name;
842 char *value;
843 } ITERATOR_VARS;
846 * Global data which is not specific to a screen.
848 typedef struct {
849 SIG_ATOMIC_T have_sigtstp;
850 SIG_ATOMIC_T have_sigwinch;
851 SIG_ATOMIC_T cleanup_nested;
853 bool init_signals;
854 bool init_screen;
856 char *comp_sourcename;
857 char *comp_termtype;
859 bool have_tic_directory;
860 bool keep_tic_directory;
861 const char *tic_directory;
863 char *dbi_list;
864 int dbi_size;
866 char *first_name;
867 char **keyname_table;
868 int init_keyname;
870 int slk_format;
872 char *safeprint_buf;
873 size_t safeprint_used;
875 TGETENT_CACHE tgetent_cache[TGETENT_MAX];
876 int tgetent_index;
877 long tgetent_sequence;
879 char *dbd_blob; /* string-heap for dbd_list[] */
880 char **dbd_list; /* distinct places to look for data */
881 int dbd_size; /* length of dbd_list[] */
882 time_t dbd_time; /* cache last updated */
883 ITERATOR_VARS dbd_vars[dbdLAST];
885 #ifndef USE_SP_WINDOWLIST
886 WINDOWLIST *_nc_windowlist;
887 #define WindowList(sp) _nc_globals._nc_windowlist
888 #endif
890 #if USE_HOME_TERMINFO
891 char *home_terminfo;
892 #endif
894 #if !USE_SAFE_SPRINTF
895 int safeprint_cols;
896 int safeprint_rows;
897 #endif
899 #ifdef USE_TERM_DRIVER
900 int (*term_driver)(struct DriverTCB*, const char*, int*);
901 #endif
903 #ifdef TRACE
904 bool init_trace;
905 char trace_fname[PATH_MAX];
906 int trace_level;
907 FILE *trace_fp;
909 char *tracearg_buf;
910 size_t tracearg_used;
912 TRACEBUF *tracebuf_ptr;
913 size_t tracebuf_used;
915 char tracechr_buf[40];
917 char *tracedmp_buf;
918 size_t tracedmp_used;
920 unsigned char *tracetry_buf;
921 size_t tracetry_used;
923 char traceatr_color_buf[2][80];
924 int traceatr_color_sel;
925 int traceatr_color_last;
926 #if !defined(USE_PTHREADS) && USE_REENTRANT
927 int nested_tracef;
928 #endif
929 #endif /* TRACE */
931 #ifdef USE_PTHREADS
932 pthread_mutex_t mutex_curses;
933 pthread_mutex_t mutex_tst_tracef;
934 pthread_mutex_t mutex_tracef;
935 int nested_tracef;
936 int use_pthreads;
937 #define _nc_use_pthreads _nc_globals.use_pthreads
938 #endif
939 #if USE_PTHREADS_EINTR
940 pthread_t read_thread; /* The reading thread */
941 #endif
942 } NCURSES_GLOBALS;
944 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
946 #define N_RIPS 5
949 * Global data which can be swept up into a SCREEN when one is created.
950 * It may be modified before the next SCREEN is created.
952 typedef struct {
953 bool use_env;
954 bool filter_mode;
955 attr_t previous_attr;
956 #ifndef USE_SP_RIPOFF
957 ripoff_t rippedoff[N_RIPS];
958 ripoff_t *rsp;
959 #endif
960 TPARM_STATE tparm_state;
961 TTY *saved_tty; /* savetty/resetty information */
962 #if NCURSES_NO_PADDING
963 bool _no_padding; /* flag to set if padding disabled */
964 #endif
965 NCURSES_SP_OUTC _outch; /* output handler if not putc */
966 #if BROKEN_LINKER || USE_REENTRANT
967 chtype *real_acs_map;
968 int _LINES;
969 int _COLS;
970 int _TABSIZE;
971 int _ESCDELAY;
972 TERMINAL *_cur_term;
973 #ifdef TRACE
974 long _outchars;
975 const char *_tputs_trace;
976 #endif
977 #endif
978 bool use_tioctl;
979 } NCURSES_PRESCREEN;
982 * Use screen-specific ripoff data (for softkeys) rather than global.
984 #ifdef USE_SP_RIPOFF
985 #define safe_ripoff_sp (sp)->rsp
986 #define safe_ripoff_stack (sp)->rippedoff
987 #else
988 #define safe_ripoff_sp _nc_prescreen.rsp
989 #define safe_ripoff_stack _nc_prescreen.rippedoff
990 #endif
992 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
995 * The SCREEN structure.
998 struct screen {
999 int _ifd; /* input file descriptor for screen */
1000 int _ofd; /* output file descriptor for screen */
1001 FILE *_ofp; /* output file ptr for screen */
1002 char *out_buffer; /* output buffer */
1003 size_t out_limit; /* output buffer size */
1004 size_t out_inuse; /* output buffer current use */
1005 bool _filtered; /* filter() was called */
1006 bool _prescreen; /* is in prescreen phase */
1007 bool _use_env; /* LINES & COLS from environment? */
1008 int _checkfd; /* filedesc for typeahead check */
1009 TERMINAL *_term; /* terminal type information */
1010 TTY _saved_tty; /* savetty/resetty information */
1011 NCURSES_SIZE_T _lines; /* screen lines */
1012 NCURSES_SIZE_T _columns; /* screen columns */
1014 NCURSES_SIZE_T _lines_avail; /* lines available for stdscr */
1015 NCURSES_SIZE_T _topstolen; /* lines stolen from top */
1017 WINDOW *_curscr; /* current screen */
1018 WINDOW *_newscr; /* virtual screen to be updated to */
1019 WINDOW *_stdscr; /* screen's full-window context */
1021 #define CurScreen(sp) (sp)->_curscr
1022 #define NewScreen(sp) (sp)->_newscr
1023 #define StdScreen(sp) (sp)->_stdscr
1025 TRIES *_keytry; /* "Try" for use with keypad mode */
1026 TRIES *_key_ok; /* Disabled keys via keyok(,FALSE) */
1027 bool _tried; /* keypad mode was initialized */
1028 bool _keypad_on; /* keypad mode is currently on */
1030 bool _called_wgetch; /* check for recursion in wgetch() */
1031 int _fifo[FIFO_SIZE]; /* input push-back buffer */
1032 short _fifohead, /* head of fifo queue */
1033 _fifotail, /* tail of fifo queue */
1034 _fifopeek, /* where to peek for next char */
1035 _fifohold; /* set if breakout marked */
1037 int _endwin; /* are we out of window mode? */
1038 NCURSES_CH_T *_current_attr; /* holds current attributes set */
1039 int _coloron; /* is color enabled? */
1040 int _color_defs; /* are colors modified */
1041 int _cursor; /* visibility of the cursor */
1042 int _cursrow; /* physical cursor row */
1043 int _curscol; /* physical cursor column */
1044 bool _notty; /* true if we cannot switch non-tty */
1045 int _nl; /* True if NL -> CR/NL is on */
1046 int _raw; /* True if in raw mode */
1047 int _cbreak; /* 1 if in cbreak mode */
1048 /* > 1 if in halfdelay mode */
1049 int _echo; /* True if echo on */
1050 int _use_meta; /* use the meta key? */
1051 struct _SLK *_slk; /* ptr to soft key struct / NULL */
1052 int slk_format; /* selected format for this screen */
1053 /* cursor movement costs; units are 10ths of milliseconds */
1054 #if NCURSES_NO_PADDING
1055 bool _no_padding; /* flag to set if padding disabled */
1056 #endif
1057 int _char_padding; /* cost of character put */
1058 int _cr_cost; /* cost of (carriage_return) */
1059 int _cup_cost; /* cost of (cursor_address) */
1060 int _home_cost; /* cost of (cursor_home) */
1061 int _ll_cost; /* cost of (cursor_to_ll) */
1062 #if USE_HARD_TABS
1063 int _ht_cost; /* cost of (tab) */
1064 int _cbt_cost; /* cost of (backtab) */
1065 #endif /* USE_HARD_TABS */
1066 int _cub1_cost; /* cost of (cursor_left) */
1067 int _cuf1_cost; /* cost of (cursor_right) */
1068 int _cud1_cost; /* cost of (cursor_down) */
1069 int _cuu1_cost; /* cost of (cursor_up) */
1070 int _cub_cost; /* cost of (parm_cursor_left) */
1071 int _cuf_cost; /* cost of (parm_cursor_right) */
1072 int _cud_cost; /* cost of (parm_cursor_down) */
1073 int _cuu_cost; /* cost of (parm_cursor_up) */
1074 int _hpa_cost; /* cost of (column_address) */
1075 int _vpa_cost; /* cost of (row_address) */
1076 /* used in tty_update.c, must be chars */
1077 int _ed_cost; /* cost of (clr_eos) */
1078 int _el_cost; /* cost of (clr_eol) */
1079 int _el1_cost; /* cost of (clr_bol) */
1080 int _dch1_cost; /* cost of (delete_character) */
1081 int _ich1_cost; /* cost of (insert_character) */
1082 int _dch_cost; /* cost of (parm_dch) */
1083 int _ich_cost; /* cost of (parm_ich) */
1084 int _ech_cost; /* cost of (erase_chars) */
1085 int _rep_cost; /* cost of (repeat_char) */
1086 int _hpa_ch_cost; /* cost of (column_address) */
1087 int _cup_ch_cost; /* cost of (cursor_address) */
1088 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
1089 int _inline_cost; /* cost of inline-move */
1090 int _smir_cost; /* cost of (enter_insert_mode) */
1091 int _rmir_cost; /* cost of (exit_insert_mode) */
1092 int _ip_cost; /* cost of (insert_padding) */
1093 /* used in lib_mvcur.c */
1094 char * _address_cursor;
1095 /* used in tty_update.c */
1096 int _scrolling; /* 1 if terminal's smart enough to */
1098 /* used in lib_color.c */
1099 color_t *_color_table; /* screen's color palette */
1100 int _color_count; /* count of colors in palette */
1101 colorpair_t *_color_pairs; /* screen's color pair list */
1102 int _pair_count; /* count of color pairs */
1103 int _pair_limit; /* actual limit of color-pairs */
1104 #if NCURSES_EXT_FUNCS
1105 bool _assumed_color; /* use assumed colors */
1106 bool _default_color; /* use default colors */
1107 bool _has_sgr_39_49; /* has ECMA default color support */
1108 int _default_fg; /* assumed default foreground */
1109 int _default_bg; /* assumed default background */
1110 int _default_pairs; /* count pairs using default color */
1111 #endif
1112 chtype _ok_attributes; /* valid attributes for terminal */
1113 chtype _xmc_suppress; /* attributes to suppress if xmc */
1114 chtype _xmc_triggers; /* attributes to process if xmc */
1115 chtype * _acs_map; /* the real alternate-charset map */
1116 bool * _screen_acs_map;
1119 /* used in lib_vidattr.c */
1120 bool _use_rmso; /* true if we may use 'rmso' */
1121 bool _use_rmul; /* true if we may use 'rmul' */
1122 #if USE_ITALIC
1123 bool _use_ritm; /* true if we may use 'ritm' */
1124 #endif
1126 #if USE_KLIBC_KBD
1127 bool _extended_key; /* true if an extended key */
1128 #endif
1131 * These data correspond to the state of the idcok() and idlok()
1132 * functions. A caveat is in order here: the XSI and SVr4
1133 * documentation specify that these functions apply to the window which
1134 * is given as an argument. However, ncurses implements this logic
1135 * only for the newscr/curscr update process, _not_ per-window.
1137 bool _nc_sp_idlok;
1138 bool _nc_sp_idcok;
1141 * These are the data that support the mouse interface.
1143 bool _mouse_initialized;
1144 MouseType _mouse_type;
1145 int _maxclick;
1146 bool (*_mouse_event) (SCREEN *);
1147 bool (*_mouse_inline)(SCREEN *);
1148 bool (*_mouse_parse) (SCREEN *, int);
1149 void (*_mouse_resume)(SCREEN *);
1150 void (*_mouse_wrap) (SCREEN *);
1151 int _mouse_fd; /* file-descriptor, if any */
1152 bool _mouse_active; /* true if initialized */
1153 mmask_t _mouse_mask; /* set via mousemask() */
1154 mmask_t _mouse_mask2; /* OR's in press/release bits */
1155 mmask_t _mouse_bstate;
1156 MouseFormat _mouse_format; /* type of xterm mouse protocol */
1157 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1158 MEVENT _mouse_events[EV_MAX]; /* hold the last mouse event seen */
1159 MEVENT *_mouse_eventp; /* next free slot in event queue */
1161 #if USE_GPM_SUPPORT
1162 bool _mouse_gpm_loaded;
1163 bool _mouse_gpm_found;
1164 #ifdef HAVE_LIBDL
1165 void *_dlopen_gpm;
1166 TYPE_gpm_fd _mouse_gpm_fd;
1167 TYPE_Gpm_Open _mouse_Gpm_Open;
1168 TYPE_Gpm_Close _mouse_Gpm_Close;
1169 TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1170 #endif
1171 Gpm_Connect _mouse_gpm_connect;
1172 #endif /* USE_GPM_SUPPORT */
1174 #if USE_EMX_MOUSE
1175 int _emxmouse_wfd;
1176 int _emxmouse_thread;
1177 int _emxmouse_activated;
1178 char _emxmouse_buttons[4];
1179 #endif
1181 #if USE_SYSMOUSE
1182 MEVENT _sysmouse_fifo[FIFO_SIZE];
1183 int _sysmouse_head;
1184 int _sysmouse_tail;
1185 int _sysmouse_char_width; /* character width */
1186 int _sysmouse_char_height; /* character height */
1187 int _sysmouse_old_buttons;
1188 int _sysmouse_new_buttons;
1189 #endif
1191 #ifdef USE_TERM_DRIVER
1192 MEVENT _drv_mouse_fifo[FIFO_SIZE];
1193 int _drv_mouse_head;
1194 int _drv_mouse_tail;
1195 int _drv_mouse_old_buttons;
1196 int _drv_mouse_new_buttons;
1197 #endif
1199 * This supports automatic resizing
1201 #if USE_SIZECHANGE
1202 int (*_resize)(NCURSES_SP_DCLx int y, int x);
1203 int (*_ungetch)(SCREEN *, int);
1204 #endif
1207 * These are data that support the proper handling of the panel stack on an
1208 * per screen basis.
1210 struct panelhook _panelHook;
1212 bool _sig_winch;
1213 SCREEN *_next_screen;
1215 /* hashes for old and new lines */
1216 unsigned long *oldhash, *newhash;
1217 HASHMAP *hashtab;
1218 int hashtab_len;
1219 int *_oldnum_list;
1220 int _oldnum_size;
1222 NCURSES_SP_OUTC _outch; /* output handler if not putc */
1224 int _legacy_coding; /* see use_legacy_coding() */
1226 #if USE_REENTRANT
1227 char _ttytype[NAMESIZE];
1228 int _ESCDELAY;
1229 int _TABSIZE;
1230 int _LINES;
1231 int _COLS;
1232 #ifdef TRACE
1233 long _outchars;
1234 const char *_tputs_trace;
1235 #endif
1236 #endif
1238 #ifdef TRACE
1239 char tracechr_buf[40];
1240 char tracemse_buf[TRACEMSE_MAX];
1241 #endif
1242 #ifdef USE_SP_WINDOWLIST
1243 WINDOWLIST* _windowlist;
1244 #define WindowList(sp) (sp)->_windowlist
1245 #endif
1246 NCURSES_OUTC jump;
1248 ripoff_t rippedoff[N_RIPS];
1249 ripoff_t *rsp;
1252 * ncurses/ncursesw are the same up to this point.
1254 #if USE_WIDEC_SUPPORT
1255 /* recent versions of 'screen' have partially-working support for
1256 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1258 bool _screen_acs_fix;
1259 bool _screen_unicode;
1260 #endif
1262 bool _use_tioctl;
1265 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1266 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1268 WINDOWLIST {
1269 WINDOWLIST *next;
1270 SCREEN *screen; /* screen containing the window */
1271 WINDOW win; /* WINDOW_EXT() needs to account for offset */
1272 #if NCURSES_WIDECHAR
1273 char addch_work[(MB_LEN_MAX * 9) + 1];
1274 unsigned addch_used; /* number of bytes in addch_work[] */
1275 int addch_x; /* x-position for addch_work[] */
1276 int addch_y; /* y-position for addch_work[] */
1277 #endif
1280 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1282 #define SP_PRE_INIT(sp) \
1283 sp->_cursrow = -1; \
1284 sp->_curscol = -1; \
1285 sp->_nl = TRUE; \
1286 sp->_raw = FALSE; \
1287 sp->_cbreak = 0; \
1288 sp->_echo = TRUE; \
1289 sp->_fifohead = -1; \
1290 sp->_endwin = TRUE; \
1291 sp->_cursor = -1; \
1292 WindowList(sp) = 0; \
1293 sp->_outch = NCURSES_OUTC_FUNC; \
1294 sp->jump = 0 \
1296 /* usually in <limits.h> */
1297 #ifndef UCHAR_MAX
1298 #define UCHAR_MAX 255
1299 #endif
1301 /* The terminfo source is assumed to be 7-bit ASCII */
1302 #define is7bits(c) ((unsigned)(c) < 128)
1304 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1305 #define is8bits(c) ((unsigned)(c) <= UCHAR_MAX)
1307 #ifndef min
1308 #define min(a,b) ((a) > (b) ? (b) : (a))
1309 #endif
1311 #ifndef max
1312 #define max(a,b) ((a) < (b) ? (b) : (a))
1313 #endif
1315 /* usually in <unistd.h> */
1316 #ifndef STDIN_FILENO
1317 #define STDIN_FILENO 0
1318 #endif
1320 #ifndef STDOUT_FILENO
1321 #define STDOUT_FILENO 1
1322 #endif
1324 #ifndef STDERR_FILENO
1325 #define STDERR_FILENO 2
1326 #endif
1328 #ifndef EXIT_SUCCESS
1329 #define EXIT_SUCCESS 0
1330 #endif
1332 #ifndef EXIT_FAILURE
1333 #define EXIT_FAILURE 1
1334 #endif
1336 #ifndef R_OK
1337 #define R_OK 4 /* Test for read permission. */
1338 #endif
1339 #ifndef W_OK
1340 #define W_OK 2 /* Test for write permission. */
1341 #endif
1342 #ifndef X_OK
1343 #define X_OK 1 /* Test for execute permission. */
1344 #endif
1345 #ifndef F_OK
1346 #define F_OK 0 /* Test for existence. */
1347 #endif
1349 #if HAVE_FCNTL_H
1350 #include <fcntl.h> /* may define O_BINARY */
1351 #endif
1353 #ifndef O_BINARY
1354 #define O_BINARY 0
1355 #endif
1357 #ifdef TRACE
1358 #if USE_REENTRANT
1359 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1360 #else
1361 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1362 #endif
1363 #else
1364 #define COUNT_OUTCHARS(n) /* nothing */
1365 #endif
1367 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1369 #define UChar(c) ((unsigned char)(c))
1370 #define UShort(c) ((unsigned short)(c))
1371 #define ChCharOf(c) ((chtype)(c) & (chtype)A_CHARTEXT)
1372 #define ChAttrOf(c) ((chtype)(c) & (chtype)A_ATTRIBUTES)
1374 #ifndef MB_LEN_MAX
1375 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
1376 #endif
1378 #if USE_WIDEC_SUPPORT /* { */
1379 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1381 #define init_mb(state) memset(&state, 0, sizeof(state))
1383 #if NCURSES_EXT_COLORS
1384 #define NulColor , 0
1385 #else
1386 #define NulColor /* nothing */
1387 #endif
1389 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
1390 #define CharOf(c) ((c).chars[0])
1391 #define AttrOf(c) ((c).attr)
1393 #define AddAttr(c,a) AttrOf(c) |= ((a) & A_ATTRIBUTES)
1394 #define RemAttr(c,a) AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1395 #define SetAttr(c,a) AttrOf(c) = ((a) & A_ATTRIBUTES) | WidecExt(c)
1397 #define NewChar2(c,a) { a, { c, NulChar } NulColor }
1398 #define NewChar(ch) NewChar2(ChCharOf(ch), ChAttrOf(ch))
1400 #if CCHARW_MAX == 5
1401 #define CharEq(a,b) (((a).attr == (b).attr) \
1402 && (a).chars[0] == (b).chars[0] \
1403 && (a).chars[1] == (b).chars[1] \
1404 && (a).chars[2] == (b).chars[2] \
1405 && (a).chars[3] == (b).chars[3] \
1406 && (a).chars[4] == (b).chars[4] \
1407 if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1408 #else
1409 #define CharEq(a,b) (!memcmp(&(a), &(b), sizeof(a)))
1410 #endif
1412 #define SetChar(ch,c,a) do { \
1413 NCURSES_CH_T *_cp = &ch; \
1414 memset(_cp, 0, sizeof(ch)); \
1415 _cp->chars[0] = (wchar_t) (c); \
1416 _cp->attr = (a); \
1417 if_EXT_COLORS(SetPair(ch, PairNumber(a))); \
1418 } while (0)
1419 #define CHREF(wch) (&wch)
1420 #define CHDEREF(wch) (*wch)
1421 #define ARG_CH_T NCURSES_CH_T *
1422 #define CARG_CH_T const NCURSES_CH_T *
1423 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1424 mbstate_t PUT_st; wchar_t PUTC_ch
1425 #define PUTC_INIT init_mb (PUT_st)
1426 #define PUTC(ch) do { if(!isWidecExt(ch)) { \
1427 if (Charable(ch)) { \
1428 NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1429 COUNT_OUTCHARS(1); \
1430 } else { \
1431 PUTC_INIT; \
1432 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) { \
1433 PUTC_ch = (ch).chars[PUTC_i]; \
1434 if (PUTC_ch == L'\0') \
1435 break; \
1436 PUTC_n = (int) wcrtomb(PUTC_buf, \
1437 (ch).chars[PUTC_i], &PUT_st); \
1438 if (PUTC_n <= 0) { \
1439 if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
1440 NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1441 break; \
1442 } else { \
1443 int PUTC_j; \
1444 for (PUTC_j = 0; PUTC_j < PUTC_n; ++PUTC_j) { \
1445 NCURSES_OUTC_FUNC (NCURSES_SP_ARGx PUTC_buf[PUTC_j]); \
1449 COUNT_OUTCHARS(PUTC_i); \
1450 } } } while (0)
1452 #define BLANK NewChar2(' ', WA_NORMAL)
1453 #define ZEROS NewChar2('\0', WA_NORMAL)
1454 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1457 * Wide characters cannot be represented in the A_CHARTEXT mask of
1458 * attr_t's but an application might have set a narrow character there.
1459 * But even in that case, it would only be a printable character, or
1460 * zero. Otherwise we can use those bits to tell if a cell is the
1461 * first or extension part of a wide character.
1463 #define WidecExt(ch) (int) (AttrOf(ch) & A_CHARTEXT)
1464 #define isWidecBase(ch) (WidecExt(ch) == 1)
1465 #define isWidecExt(ch) (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1466 #define SetWidecExt(dst, ext) AttrOf(dst) &= ~A_CHARTEXT, \
1467 AttrOf(dst) |= (attr_t) (ext + 1)
1469 #define if_WIDEC(code) code
1470 #define Charable(ch) (((SP_PARM->_legacy_coding) \
1471 || (AttrOf(ch) & A_ALTCHARSET) \
1472 || (!isWidecExt(ch))) && \
1473 (ch).chars[1] == L'\0' && \
1474 _nc_is_charable(CharOf(ch)))
1476 #define L(ch) L ## ch
1477 #else /* }{ */
1478 #define CharOf(c) ChCharOf(c)
1479 #define AttrOf(c) ChAttrOf(c)
1480 #define AddAttr(c,a) c |= (a)
1481 #define RemAttr(c,a) c &= ~((a) & A_ATTRIBUTES)
1482 #define SetAttr(c,a) c = ((c) & ~A_ATTRIBUTES) | (a)
1483 #define NewChar(ch) (ch)
1484 #define NewChar2(c,a) ((c) | (a))
1485 #define CharEq(a,b) ((a) == (b))
1486 #define SetChar(ch,c,a) ch = (c) | (a)
1487 #define CHREF(wch) wch
1488 #define CHDEREF(wch) wch
1489 #define ARG_CH_T NCURSES_CH_T
1490 #define CARG_CH_T NCURSES_CH_T
1491 #define PUTC_DATA /* nothing */
1492 #define PUTC(ch) NCURSES_OUTC_FUNC (NCURSES_SP_ARGx (int) ch)
1494 #define BLANK (' '|A_NORMAL)
1495 #define ZEROS ('\0'|A_NORMAL)
1496 #define ISBLANK(ch) (CharOf(ch) == ' ')
1498 #define isWidecExt(ch) (0)
1499 #define if_WIDEC(code) /* nothing */
1501 #define L(ch) ch
1502 #endif /* } */
1504 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
1505 #define CharOfD(ch) CharOf(CHDEREF(ch))
1506 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1508 #define BLANK_ATTR A_NORMAL
1509 #define BLANK_TEXT L(' ')
1511 #define CHANGED -1
1513 #define LEGALYX(w, y, x) \
1514 ((w) != 0 && \
1515 ((x) >= 0 && (x) <= (w)->_maxx && \
1516 (y) >= 0 && (y) <= (w)->_maxy))
1518 #define CHANGED_CELL(line,col) \
1519 if (line->firstchar == _NOCHANGE) \
1520 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1521 else if ((col) < line->firstchar) \
1522 line->firstchar = (NCURSES_SIZE_T) (col); \
1523 else if ((col) > line->lastchar) \
1524 line->lastchar = (NCURSES_SIZE_T) (col)
1526 #define CHANGED_RANGE(line,start,end) \
1527 if (line->firstchar == _NOCHANGE \
1528 || line->firstchar > (start)) \
1529 line->firstchar = (NCURSES_SIZE_T) (start); \
1530 if (line->lastchar == _NOCHANGE \
1531 || line->lastchar < (end)) \
1532 line->lastchar = (NCURSES_SIZE_T) (end)
1534 #define CHANGED_TO_EOL(line,start,end) \
1535 if (line->firstchar == _NOCHANGE \
1536 || line->firstchar > (start)) \
1537 line->firstchar = (NCURSES_SIZE_T) (start); \
1538 line->lastchar = (NCURSES_SIZE_T) (end)
1540 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1542 #define FreeIfNeeded(p) if ((p) != 0) free(p)
1544 /* FreeAndNull() is not a comma-separated expression because some compilers
1545 * do not accept a mixture of void with values.
1547 #define FreeAndNull(p) free(p); p = 0
1549 #include <nc_alloc.h>
1552 * Use these for tic/infocmp malloc failures. Generally the ncurses library
1553 * tries to limp along after a failure.
1555 #define TYPE_MALLOC(type, size, name) \
1556 name = typeMalloc(type, size); \
1557 if (name == 0) \
1558 _nc_err_abort(MSG_NO_MEMORY)
1560 #define TYPE_REALLOC(type, size, name) \
1561 name = typeRealloc(type, size, name); \
1562 if (name == 0) \
1563 _nc_err_abort(MSG_NO_MEMORY)
1566 * TTY bit definition for converting tabs to spaces.
1568 #ifdef TAB3
1569 # define OFLAGS_TABS TAB3 /* POSIX specifies TAB3 */
1570 #else
1571 # ifdef XTABS
1572 # define OFLAGS_TABS XTABS /* XTABS is usually the "same" */
1573 # else
1574 # ifdef OXTABS
1575 # define OFLAGS_TABS OXTABS /* the traditional BSD equivalent */
1576 # else
1577 # define OFLAGS_TABS 0
1578 # endif
1579 # endif
1580 #endif
1583 * Standardize/simplify common loops
1585 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1586 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1587 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1590 * Prefixes for call/return points of library function traces. We use these to
1591 * instrument the public functions so that the traces can be easily transformed
1592 * into regression scripts.
1594 #define T_CALLED(fmt) "called {" fmt
1595 #define T_CREATE(fmt) "create :" fmt
1596 #define T_RETURN(fmt) "return }" fmt
1598 #ifdef TRACE
1600 #if USE_REENTRANT
1601 #define TPUTS_TRACE(s) _nc_set_tputs_trace(s);
1602 #else
1603 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
1604 #endif
1606 #define START_TRACE() \
1607 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1608 int t = _nc_getenv_num("NCURSES_TRACE"); \
1609 if (t >= 0) \
1610 trace((unsigned) t); \
1614 * Many of the _tracef() calls use static buffers; lock the trace state before
1615 * trying to fill them.
1617 #if USE_REENTRANT
1618 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1619 extern NCURSES_EXPORT(int) _nc_use_tracef (unsigned);
1620 extern NCURSES_EXPORT(void) _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1621 #else
1622 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1623 #define _nc_locked_tracef _tracef
1624 #endif
1626 #define TR(n, a) if (USE_TRACEF(n)) _nc_locked_tracef a
1627 #define T(a) TR(TRACE_CALLS, a)
1628 #define TRACE_RETURN(value,type) return _nc_retrace_##type((type)(value))
1629 #define TRACE_RETURN1(value,dst) return _nc_retrace_##dst(value)
1630 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1631 #define TRACE_RETURN_SP(value,type) return _nc_retrace_##type(SP_PARM, value)
1633 #define NonNull(s) ((s) != 0 ? s : "<null>")
1635 #define returnAttr(code) TRACE_RETURN(code,attr_t)
1636 #define returnBits(code) TRACE_RETURN(code,unsigned)
1637 #define returnBool(code) TRACE_RETURN(code,bool)
1638 #define returnCPtr(code) TRACE_RETURN1(code,cptr)
1639 #define returnCVoidPtr(code) TRACE_RETURN1(code,cvoid_ptr)
1640 #define returnChar(code) TRACE_RETURN(code,char)
1641 #define returnChtype(code) TRACE_RETURN(code,chtype)
1642 #define returnCode(code) TRACE_RETURN(code,int)
1643 #define returnIntAttr(code) TRACE_RETURN2(code,int,attr_t)
1644 #define returnMMask(code) TRACE_RETURN_SP(code,mmask_t)
1645 #define returnPtr(code) TRACE_RETURN1(code,ptr)
1646 #define returnSP(code) TRACE_RETURN1(code,sp)
1647 #define returnVoid T((T_RETURN(""))); return
1648 #define returnVoidPtr(code) TRACE_RETURN1(code,void_ptr)
1649 #define returnWin(code) TRACE_RETURN1(code,win)
1651 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (int);
1652 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1653 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
1654 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
1655 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
1656 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
1657 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
1658 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
1659 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
1660 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
1661 extern NCURSES_EXPORT(const char *) _nc_retrace_cptr (const char *);
1662 extern NCURSES_EXPORT(char) _nc_retrace_char (int);
1663 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
1664 extern NCURSES_EXPORT(int) _nc_retrace_int_attr_t (attr_t);
1665 extern NCURSES_EXPORT(mmask_t) _nc_retrace_mmask_t (SCREEN *, mmask_t);
1666 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
1667 extern NCURSES_EXPORT(void *) _nc_retrace_void_ptr (void *);
1668 extern NCURSES_EXPORT(void) _nc_fifo_dump (SCREEN *);
1670 #if USE_REENTRANT
1671 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1672 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1673 #define _nc_outchars NCURSES_PUBLIC_VAR(_nc_outchars())
1674 #define _nc_tputs_trace NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1675 extern NCURSES_EXPORT(void) _nc_set_tputs_trace (const char *);
1676 extern NCURSES_EXPORT(void) _nc_count_outchars (long);
1677 #else
1678 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1679 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
1680 #endif
1682 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
1684 #if USE_WIDEC_SUPPORT
1685 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1686 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1687 #endif
1689 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1690 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1692 #else /* !TRACE */
1694 #define START_TRACE() /* nothing */
1696 #define T(a)
1697 #define TR(n, a)
1698 #define TPUTS_TRACE(s)
1700 #define returnAttr(code) return code
1701 #define returnBits(code) return code
1702 #define returnBool(code) return code
1703 #define returnCPtr(code) return code
1704 #define returnCVoidPtr(code) return code
1705 #define returnChar(code) return ((char) code)
1706 #define returnChtype(code) return code
1707 #define returnCode(code) return code
1708 #define returnIntAttr(code) return code
1709 #define returnMMask(code) return code
1710 #define returnPtr(code) return code
1711 #define returnSP(code) return code
1712 #define returnVoid return
1713 #define returnVoidPtr(code) return code
1714 #define returnWin(code) return code
1716 #endif /* TRACE/!TRACE */
1719 * Workaround for defective implementation of gcc attribute warn_unused_result
1721 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1722 #define IGNORE_RC(func) errno = (int) func
1723 #else
1724 #define IGNORE_RC(func) (void) func
1725 #endif /* gcc workarounds */
1728 * Return-codes for tgetent() and friends.
1730 #define TGETENT_YES 1 /* entry is found */
1731 #define TGETENT_NO 0 /* entry is not found */
1732 #define TGETENT_ERR -1 /* an error occurred */
1734 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1735 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1737 #define EMPTY_MODULE(name) \
1738 extern NCURSES_EXPORT(void) name (void); \
1739 NCURSES_EXPORT(void) name (void) { }
1741 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1742 #define NONBLANK_ATTR (A_BOLD | A_DIM | A_BLINK | A_ITALIC)
1743 #define TPARM_ATTR (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_ALTCHARSET | A_INVIS | A_PROTECT)
1744 #define XMC_CONFLICT (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_INVIS | A_PROTECT | A_ITALIC)
1745 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1747 #define toggle_attr_on(S,at) {\
1748 if (PairNumber(at) > 0) {\
1749 (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1750 } else {\
1751 (S) |= (attr_t) (at);\
1753 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1756 #define toggle_attr_off(S,at) {\
1757 if (PairNumber(at) > 0) {\
1758 (S) &= ~(at|A_COLOR);\
1759 } else {\
1760 (S) &= ~(at);\
1762 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1764 #define DelCharCost(sp,count) \
1765 ((parm_dch != 0) \
1766 ? sp->_dch_cost \
1767 : ((delete_character != 0) \
1768 ? (sp->_dch1_cost * count) \
1769 : INFINITY))
1771 #define InsCharCost(sp,count) \
1772 ((parm_ich != 0) \
1773 ? sp->_ich_cost \
1774 : ((enter_insert_mode && exit_insert_mode) \
1775 ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1776 : ((insert_character != 0) \
1777 ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1778 : INFINITY)))
1780 #if USE_XMC_SUPPORT
1781 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1782 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1783 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1784 if (magic_cookie_glitch > 0 \
1785 && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1786 T(("%s @%d before glitch %d,%d", \
1787 __FILE__, __LINE__, \
1788 sp->_cursrow, \
1789 sp->_curscol)); \
1790 NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1793 #else
1794 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1795 VIDATTR(sp, AttrOf(c), GetPair(c)); \
1797 #endif
1800 * Macros to make additional parameter to implement wgetch_events()
1802 #ifdef NCURSES_WGETCH_EVENTS
1803 #define EVENTLIST_0th(param) param
1804 #define EVENTLIST_1st(param) param
1805 #define EVENTLIST_2nd(param) , param
1806 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1807 #else
1808 #define EVENTLIST_0th(param) void
1809 #define EVENTLIST_1st(param) /* nothing */
1810 #define EVENTLIST_2nd(param) /* nothing */
1811 #define TWAIT_MASK TW_ANY
1812 #endif
1814 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1816 #undef toggle_attr_on
1817 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1818 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1820 #undef toggle_attr_off
1821 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1822 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1824 #undef DelCharCost
1825 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1827 #undef InsCharCost
1828 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1830 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1831 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1833 #undef UpdateAttrs
1834 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1836 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1837 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1838 #else
1839 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1840 #endif
1842 #if NCURSES_SP_FUNCS
1843 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1844 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1845 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1846 #endif /* NCURSES_SP_FUNCS */
1848 #else
1850 extern NCURSES_EXPORT(void) _nc_expanded (void);
1852 #endif
1854 #if !NCURSES_EXT_FUNCS
1855 #define set_escdelay(value) ESCDELAY = value
1856 #endif
1858 #if !HAVE_GETCWD
1859 #define getcwd(buf,len) getwd(buf)
1860 #endif
1862 /* charable.c */
1863 #if USE_WIDEC_SUPPORT
1864 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1865 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1866 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1867 #endif
1869 /* comp_captab.c */
1870 typedef struct {
1871 short nte_name; /* offset of name to hash on */
1872 int nte_type; /* BOOLEAN, NUMBER or STRING */
1873 short nte_index; /* index of associated variable in its array */
1874 short nte_link; /* index in table of next hash, or -1 */
1875 } name_table_data;
1877 typedef struct
1879 short from;
1880 short to;
1881 short source;
1882 } alias_table_data;
1884 /* doupdate.c */
1885 #if USE_XMC_SUPPORT
1886 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1887 #endif
1889 /* hardscroll.c */
1890 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1891 extern NCURSES_EXPORT(void) _nc_linedump (void);
1892 #endif
1894 /* lib_acs.c */
1895 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1896 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
1898 /* lib_addch.c */
1899 #if USE_WIDEC_SUPPORT
1900 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1901 #endif
1903 /* lib_addstr.c */
1904 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1905 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1906 #endif
1908 /* lib_color.c */
1909 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1911 /* lib_getch.c */
1912 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
1914 /* lib_insch.c */
1915 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
1917 /* lib_mvcur.c */
1918 #define INFINITY 1000000 /* cost: too high to use */
1920 extern NCURSES_EXPORT(int) _nc_mvcur(int yold, int xold, int ynew, int xnew);
1922 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1923 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1924 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1926 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1928 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1929 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1930 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1932 /* lib_mouse.c */
1933 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
1935 /* lib_mvcur.c */
1936 #define INFINITY 1000000 /* cost: too high to use */
1937 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
1939 /* lib_setup.c */
1940 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1941 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1942 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(TERMINAL *);
1943 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, int);
1944 extern NCURSES_EXPORT(void) _nc_tinfo_cmdch(TERMINAL *, int);
1946 /* lib_set_term.c */
1947 extern NCURSES_EXPORT(int) _nc_ripoffline(int, int(*)(WINDOW*, int));
1949 /* lib_setup.c */
1950 #define SETUP_FAIL ERR
1951 #define ret_error(code, fmt, arg) if (errret) {\
1952 *errret = code;\
1953 returnCode(SETUP_FAIL);\
1954 } else {\
1955 fprintf(stderr, fmt, arg);\
1956 exit(EXIT_FAILURE);\
1959 #define ret_error1(code, fmt, arg) ret_error(code, "'%s': " fmt, arg)
1961 #define ret_error0(code, msg) if (errret) {\
1962 *errret = code;\
1963 returnCode(SETUP_FAIL);\
1964 } else {\
1965 fprintf(stderr, msg);\
1966 exit(EXIT_FAILURE);\
1969 /* lib_tstp.c */
1970 #if USE_SIGWINCH
1971 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
1972 #else
1973 #define _nc_handle_sigwinch(a) /* nothing */
1974 #endif
1976 /* lib_wacs.c */
1977 #if USE_WIDEC_SUPPORT
1978 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1979 #endif
1981 typedef struct {
1982 char *s_head; /* beginning of the string (may be null) */
1983 char *s_tail; /* end of the string (may be null) */
1984 size_t s_size; /* current remaining size available */
1985 size_t s_init; /* total size available */
1986 } string_desc;
1988 /* strings.c */
1989 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1990 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1991 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1992 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1993 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1995 #if !HAVE_STRSTR
1996 #define strstr _nc_strstr
1997 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1998 #endif
2000 /* safe_sprintf.c */
2001 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
2003 /* tries.c */
2004 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
2005 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
2006 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
2007 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
2009 /* elsewhere ... */
2010 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry (ENTRY *, TERMTYPE *);
2011 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
2012 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
2013 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
2014 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
2015 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
2016 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
2017 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
2018 extern NCURSES_EXPORT(char *) _nc_trace_mmask_t (SCREEN *, mmask_t);
2019 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
2020 extern NCURSES_EXPORT(int) _nc_baudrate (int);
2021 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
2022 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
2023 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
2024 extern NCURSES_EXPORT(int) _nc_ospeed (int);
2025 extern NCURSES_EXPORT(int) _nc_outch (int);
2026 extern NCURSES_EXPORT(int) _nc_putchar (int);
2027 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
2028 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
2029 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
2030 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE *);
2031 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
2032 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
2033 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
2034 extern NCURSES_EXPORT(void) _nc_flush (void);
2035 extern NCURSES_EXPORT(void) _nc_free_and_exit (int) GCC_NORETURN;
2036 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE *);
2037 extern NCURSES_EXPORT(void) _nc_freeall (void);
2038 extern NCURSES_EXPORT(void) _nc_hash_map (void);
2039 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
2040 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
2041 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
2042 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
2043 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
2044 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
2045 extern NCURSES_EXPORT(void) _nc_setenv_num (const char *, int);
2046 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
2047 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
2048 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
2050 #if NO_LEAKS
2051 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
2052 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
2053 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
2054 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
2055 extern NCURSES_EXPORT(void) _nc_comp_error_leaks(void);
2056 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
2057 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
2058 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
2059 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
2060 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
2061 #endif
2063 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2064 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
2065 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
2066 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
2067 #endif
2069 #if USE_WIDEC_SUPPORT
2070 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
2071 #endif
2073 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2074 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
2075 #endif
2077 #if USE_SIZECHANGE
2078 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
2079 #endif
2081 #if HAVE_RESIZETERM
2082 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
2083 #else
2084 #define _nc_resize_margins(wp) /* nothing */
2085 #endif
2087 #ifdef NCURSES_WGETCH_EVENTS
2088 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2089 #else
2090 #define wgetch_events(win, evl) wgetch(win)
2091 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2092 #endif
2095 * Wide-character macros to hide some platform-differences.
2097 #if USE_WIDEC_SUPPORT
2099 #if defined(__MINGW32__)
2101 * MinGW has wide-character functions, but they do not work correctly.
2104 extern int __MINGW_NOTHROW _nc_wctomb(char *, wchar_t);
2105 #define wctomb(s,wc) _nc_wctomb(s,wc)
2106 #define wcrtomb(s,wc,n) _nc_wctomb(s,wc)
2108 extern int __MINGW_NOTHROW _nc_mbtowc(wchar_t *, const char *, size_t);
2109 #define mbtowc(pwc,s,n) _nc_mbtowc(pwc,s,n)
2111 extern int __MINGW_NOTHROW _nc_mblen(const char *, size_t);
2112 #define mblen(s,n) _nc_mblen(s, n)
2114 #endif /* __MINGW32__ */
2116 #if HAVE_MBTOWC && HAVE_MBLEN
2117 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2118 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2119 #define check_mbytes(wch,buffer,length,state) \
2120 (int) mbtowc(&wch, buffer, length)
2121 #define state_unused
2122 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2123 #define reset_mbytes(state) init_mb(state)
2124 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&state)
2125 #define check_mbytes(wch,buffer,length,state) \
2126 (int) mbrtowc(&wch, buffer, length, &state)
2127 #else
2128 make an error
2129 #endif
2131 #endif /* USE_WIDEC_SUPPORT */
2134 * Not everyone has vsscanf(), but we'd like to use it for scanw().
2136 #if !HAVE_VSSCANF
2137 extern int vsscanf(const char *str, const char *format, va_list __arg);
2138 #endif
2140 /* scroll indices */
2141 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2143 #define USE_SETBUF_0 0
2145 #define NC_OUTPUT(sp) ((sp != 0) ? sp->_ofp : stdout)
2148 * On systems with a broken linker, define 'SP' as a function to force the
2149 * linker to pull in the data-only module with 'SP'.
2151 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2153 #if BROKEN_LINKER
2154 #define SP _nc_screen()
2155 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2156 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
2157 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
2158 #define CURRENT_SCREEN _nc_screen()
2159 #else
2160 /* current screen is private data; avoid possible linking conflicts too */
2161 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2162 #define CURRENT_SCREEN SP
2163 #define _nc_alloc_screen() ((SP = _nc_alloc_screen_sp()) != 0)
2164 #define _nc_set_screen(sp) SP = sp
2165 #endif
2167 #if NCURSES_SP_FUNCS
2168 #define CURRENT_SCREEN_PRE (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2169 #else
2170 #define CURRENT_SCREEN_PRE CURRENT_SCREEN
2171 #endif
2174 * We don't want to use the lines or columns capabilities internally, because
2175 * if the application is running multiple screens under X, it's quite possible
2176 * they could all have type xterm but have different sizes! So...
2178 #define screen_lines(sp) (sp)->_lines
2179 #define screen_columns(sp) (sp)->_columns
2181 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2182 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2185 * Some constants related to SLK's
2187 #define MAX_SKEY_OLD 8 /* count of soft keys */
2188 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
2189 #define MAX_SKEY_PC 12 /* This is what most PC's have */
2190 #define MAX_SKEY_LEN_PC 5
2192 /* Macro to check whether or not we use a standard format */
2193 #define SLK_STDFMT(fmt) (fmt < 3)
2194 /* Macro to determine height of label window */
2195 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2197 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2198 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2201 * Common error messages
2203 #define MSG_NO_MEMORY "Out of memory"
2204 #define MSG_NO_INPUTS "Premature EOF"
2206 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2207 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2209 /* timed_wait flag definitions */
2210 #define TW_NONE 0
2211 #define TW_INPUT 1
2212 #define TW_MOUSE 2
2213 #define TW_ANY (TW_INPUT | TW_MOUSE)
2214 #define TW_EVENT 4
2216 #define SetSafeOutcWrapper(outc) \
2217 SCREEN* sp = CURRENT_SCREEN; \
2218 struct screen outc_wrapper; \
2219 if (sp==0) { \
2220 sp = &outc_wrapper; \
2221 memset(sp,0,sizeof(struct screen)); \
2222 sp->_outch = _nc_outc_wrapper; \
2224 sp->jump = outc
2226 #ifdef USE_TERM_DRIVER
2228 typedef struct _termInfo
2230 bool caninit;
2232 bool hascolor;
2233 bool initcolor;
2234 bool canchange;
2236 int tabsize;
2238 int maxcolors;
2239 int maxpairs;
2240 int nocolorvideo;
2242 int numbuttons;
2243 int numlabels;
2244 int labelwidth;
2245 int labelheight;
2247 const color_t* defaultPalette;
2248 } TerminalInfo;
2250 typedef struct term_driver {
2251 bool isTerminfo;
2252 const char* (*td_name)(struct DriverTCB*);
2253 bool (*td_CanHandle)(struct DriverTCB*, const char*, int*);
2254 void (*td_init)(struct DriverTCB*);
2255 void (*td_release)(struct DriverTCB*);
2256 int (*td_size)(struct DriverTCB*, int* Line, int *Cols);
2257 int (*td_sgmode)(struct DriverTCB*, int setFlag, TTY*);
2258 chtype (*td_conattr)(struct DriverTCB*);
2259 int (*td_hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2260 int (*td_mode)(struct DriverTCB*, int progFlag, int defFlag);
2261 bool (*td_rescol)(struct DriverTCB*);
2262 bool (*td_rescolors)(struct DriverTCB*);
2263 void (*td_color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2264 int (*td_doBeepOrFlash)(struct DriverTCB*, int);
2265 void (*td_initpair)(struct DriverTCB*, int, int, int);
2266 void (*td_initcolor)(struct DriverTCB*, int, int, int, int);
2267 void (*td_docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2268 void (*td_initmouse)(struct DriverTCB*);
2269 int (*td_testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2270 void (*td_setfilter)(struct DriverTCB*);
2271 void (*td_hwlabel)(struct DriverTCB*, int, char*);
2272 void (*td_hwlabelOnOff)(struct DriverTCB*, int);
2273 int (*td_update)(struct DriverTCB*);
2274 int (*td_defaultcolors)(struct DriverTCB*, int, int);
2275 int (*td_print)(struct DriverTCB*, char*, int);
2276 int (*td_getsize)(struct DriverTCB*, int*, int*);
2277 int (*td_setsize)(struct DriverTCB*, int, int);
2278 void (*td_initacs)(struct DriverTCB*, chtype*, chtype*);
2279 void (*td_scinit)(SCREEN *);
2280 void (*td_scexit)(SCREEN *);
2281 int (*td_twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2282 int (*td_read)(struct DriverTCB*, int*);
2283 int (*td_nap)(struct DriverTCB*, int);
2284 int (*td_kpad)(struct DriverTCB*, int);
2285 int (*td_kyOk)(struct DriverTCB*, int, int);
2286 bool (*td_kyExist)(struct DriverTCB*, int);
2287 int (*td_cursorSet)(struct DriverTCB*, int);
2288 } TERM_DRIVER;
2290 typedef struct DriverTCB
2292 TERMINAL term; /* needs to be the first Element !!! */
2293 TERM_DRIVER* drv; /* The driver for that Terminal */
2294 SCREEN* csp; /* The screen that owns that Terminal */
2295 TerminalInfo info; /* Driver independent core capabilities of the Terminal */
2296 void* prop; /* Driver dependent property storage to be used by the Driver */
2297 long magic;
2298 } TERMINAL_CONTROL_BLOCK;
2300 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2301 #define NCDRV_TINFO 0x01
2302 #define NCDRV_WINCONSOLE 0x02
2304 #define TCBOf(sp) ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2305 #define InfoOf(sp) TCBOf(sp)->info
2306 #define CallDriver(sp,method) TCBOf(sp)->drv->method(TCBOf(sp))
2307 #define CallDriver_1(sp,method,arg1) TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2308 #define CallDriver_2(sp,method,arg1,arg2) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2309 #define CallDriver_3(sp,method,arg1,arg2,arg3) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2310 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4) TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2312 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2313 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2315 extern NCURSES_EXPORT(int) _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2316 extern NCURSES_EXPORT(void) _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2317 #endif /* USE_TERM_DRIVER */
2320 * Entrypoints which are actually provided in the terminal driver, which would
2321 * be an sp-name otherwise.
2323 #ifdef USE_TERM_DRIVER
2324 #define TINFO_HAS_KEY _nc_tinfo_has_key
2325 #define TINFO_DOUPDATE _nc_tinfo_doupdate
2326 #define TINFO_MVCUR _nc_tinfo_mvcur
2327 extern NCURSES_EXPORT(int) TINFO_HAS_KEY(SCREEN*, int);
2328 extern NCURSES_EXPORT(int) TINFO_DOUPDATE(SCREEN *);
2329 extern NCURSES_EXPORT(int) TINFO_MVCUR(SCREEN*, int, int, int, int);
2330 #else
2331 #define TINFO_HAS_KEY NCURSES_SP_NAME(has_key)
2332 #define TINFO_DOUPDATE NCURSES_SP_NAME(doupdate)
2333 #define TINFO_MVCUR NCURSES_SP_NAME(_nc_mvcur)
2334 #endif
2337 * Entrypoints using an extra parameter with the terminal driver.
2339 #ifdef USE_TERM_DRIVER
2340 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2341 extern NCURSES_EXPORT(int) _nc_setupterm_ex(TERMINAL **, NCURSES_CONST char *, int , int *, int);
2342 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2343 _nc_get_screensize(sp, tp, lp, cp)
2344 #define TINFO_SET_CURTERM(sp, tp) \
2345 NCURSES_SP_NAME(set_curterm)(sp, tp)
2346 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2347 _nc_setupterm_ex(tpp, name, fd, err, reuse)
2348 #else /* !USE_TERM_DRIVER */
2349 extern NCURSES_EXPORT(void) _nc_get_screensize(SCREEN *, int *, int *);
2350 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2351 _nc_get_screensize(sp, lp, cp)
2352 #define TINFO_SET_CURTERM(sp, tp) \
2353 set_curterm(tp)
2354 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2355 _nc_setupterm(name, fd, err, reuse)
2356 #endif /* !USE_TERM_DRIVER */
2358 #ifdef USE_TERM_DRIVER
2359 #if defined(USE_WIN32CON_DRIVER)
2360 #include <nc_mingw.h>
2361 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2362 extern NCURSES_EXPORT(int) _nc_mingw_isatty(int fd);
2363 extern NCURSES_EXPORT(int) _nc_mingw_isconsole(int fd);
2364 extern NCURSES_EXPORT(int) _nc_mingw_console_read(
2365 SCREEN *sp,
2366 HANDLE fd,
2367 int *buf);
2368 extern NCURSES_EXPORT(int) _nc_mingw_testmouse(
2369 SCREEN * sp,
2370 HANDLE fd,
2371 int delay);
2372 #else
2373 #endif
2374 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2375 #endif
2377 #if defined(USE_TERM_DRIVER) && defined(USE_WIN32CON_DRIVER)
2378 #define NC_ISATTY(fd) _nc_mingw_isatty(fd)
2379 #else
2380 #define NC_ISATTY(fd) isatty(fd)
2381 #endif
2383 #ifdef USE_TERM_DRIVER
2384 # define IsTermInfo(sp) ((TCBOf(sp) != 0) && ((TCBOf(sp)->drv->isTerminfo)))
2385 # define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2386 # if defined(USE_WIN32CON_DRIVER)
2387 # define IsTermInfoOnConsole(sp) (IsTermInfo(sp)&&_nc_mingw_isconsole(TerminalOf(sp)->Filedes))
2388 #else
2389 # define IsTermInfoOnConsole(sp) FALSE
2390 # endif
2391 #else
2392 # define IsTermInfo(sp) TRUE
2393 # define HasTInfoTerminal(sp) (0 != TerminalOf(sp))
2394 # define IsTermInfoOnConsole(sp) FALSE
2395 #endif
2397 #define IsValidTIScreen(sp) (HasTInfoTerminal(sp))
2400 * Exported entrypoints beyond the published API
2402 #if NCURSES_SP_FUNCS
2403 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2404 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2405 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2406 extern NCURSES_EXPORT(int) _nc_outc_wrapper(SCREEN*,int);
2408 #if USE_REENTRANT
2409 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2410 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(longname)(SCREEN*);
2411 #endif
2413 #if NCURSES_EXT_FUNCS
2414 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2415 #endif
2418 * We put the safe versions of various calls here as they are not published
2419 * part of the API up to now
2421 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2422 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2423 extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2424 extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2425 extern NCURSES_EXPORT(chtype) NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2426 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_curs_set)(SCREEN*,int);
2427 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2428 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2429 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2430 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_mvcur)(SCREEN*, int, int, int, int);
2431 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2432 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putchar)(SCREEN*, int);
2433 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2434 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2435 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resetty)(SCREEN*);
2436 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_resize_term)(SCREEN*,int,int);
2437 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2438 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_savetty)(SCREEN*);
2439 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_init)(SCREEN*,const char*);
2440 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scr_restore)(SCREEN*, const char*);
2441 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2442 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2443 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2444 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2445 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_tigetnum)(SCREEN*,NCURSES_CONST char*);
2446 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vid_attr)(SCREEN *, attr_t, NCURSES_COLOR_T, void *);
2447 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_vidputs)(SCREEN*,chtype,int(*) (SCREEN*, int));
2448 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2449 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2450 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2451 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int) GCC_NORETURN;
2452 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2453 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2454 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2455 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2456 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2457 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2458 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2459 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2460 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2461 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2462 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2463 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2464 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2466 extern NCURSES_EXPORT(void) _nc_cookie_init(SCREEN *sp);
2468 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2469 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2470 #endif
2472 #if USE_WIDEC_SUPPORT
2473 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2474 #endif
2476 #endif /* NCURSES_SP_FUNCS */
2478 #if NCURSES_SP_FUNCS
2480 #define safe_keyname NCURSES_SP_NAME(keyname)
2481 #define safe_unctrl NCURSES_SP_NAME(unctrl)
2482 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2484 #else
2486 #define safe_keyname _nc_keyname
2487 #define safe_unctrl _nc_unctrl
2488 #define safe_ungetch _nc_ungetch
2490 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2491 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2492 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2494 #endif
2496 #ifdef EXP_XTERM_1005
2497 NCURSES_EXPORT(int) _nc_conv_to_utf8(unsigned char *, unsigned, unsigned);
2498 NCURSES_EXPORT(int) _nc_conv_to_utf32(unsigned *, const char *, unsigned);
2499 #endif
2501 #ifdef __cplusplus
2503 #endif
2505 /* *INDENT-ON* */
2507 #endif /* CURSES_PRIV_H */