ncurses/curses.priv.h

   1 /****************************************************************************
   2  * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3  * Copyright 1998-2017,2018 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29
  30 /****************************************************************************
  31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  33  *     and: Thomas E. Dickey                        1996-on                 *
  34  *     and: Juergen Pfeifer                                                 *
  35  ****************************************************************************/
  36
  37 /*
  38  * $Id: curses.priv.h,v 1.685 2024/02/24 18:46:40 tom Exp $
  39  *
  40  *      curses.priv.h
  41  *
  42  *      Header file for curses library objects which are private to
  43  *      the library.
  44  *
  45  */
  46
  47 #ifndef CURSES_PRIV_H
  48 #define CURSES_PRIV_H 1
  49 /* *INDENT-OFF* */
  50
  51 #include <ncurses_dll.h>
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 #include <ncurses_cfg.h>
  58
  59 #if USE_RCS_IDS
  60 #define MODULE_ID(id) static const char Ident[] = id;
  61 #else
  62 #define MODULE_ID(id) /*nothing*/
  63 #endif
  64
  65 #include <stddef.h>             /* for offsetof */
  66 #include <stdlib.h>
  67 #include <string.h>
  68 #include <sys/types.h>
  69 #include <sys/stat.h>
  70
  71 #if HAVE_UNISTD_H
  72 #include <unistd.h>
  73 #endif
  74
  75 #include <assert.h>
  76 #include <stdio.h>
  77
  78 #include <errno.h>
  79
  80 #if defined __hpux
  81 #  ifndef EILSEQ
  82 #    define EILSEQ 47
  83 #  endif
  84 #endif
  85
  86 #if DECL_ERRNO
  87 extern int errno;
  88 #endif
  89
  90 /* Some Windows related defines */
  91 #undef _NC_WINDOWS
  92 #if (defined(_WIN32) || defined(_WIN64))
  93 #define _NC_WINDOWS
  94 #else
  95 #undef EXP_WIN32_DRIVER
  96 #endif
  97
  98 #undef _NC_MINGW
  99 #if (defined(__MINGW32__) || defined(__MINGW64__))
 100 #define _NC_MINGW
 101 #endif
 102
 103 #undef _NC_MSC
 104 #ifdef _MSC_VER
 105 #define _NC_MSC
 106 #endif
 107
 108 /* Some systems have a broken 'select()', but workable 'poll()'.  Use that */
 109 #if HAVE_WORKING_POLL
 110 #define USE_FUNC_POLL 1
 111 #if HAVE_POLL_H
 112 #include <poll.h>
 113 #else
 114 #include <sys/poll.h>
 115 #endif
 116 #else
 117 #define USE_FUNC_POLL 0
 118 #endif
 119
 120 #if HAVE_INTTYPES_H
 121 # include <inttypes.h>
 122 #else
 123 # if HAVE_STDINT_H
 124 #  include <stdint.h>
 125 # endif
 126 #endif
 127
 128 #if (defined(__USE_MINGW_ANSI_STDIO) && __USE_MINGW_ANSI_STDIO != 0) && (defined(__GNUC__) && (__GNUC__ < 12))
 129 # undef PRIxPTR         /* gcc bug fixed in 12.x */
 130 # define PRIxPTR        "lX"
 131 # define CASTxPTR(n)    (unsigned long)(intptr_t)(void*)(n)
 132 #else
 133 # define CASTxPTR(n)    (intptr_t)(n)
 134 #endif
 135
 136 #ifndef PRIxPTR
 137 # define PRIxPTR        "lx"
 138 # define CASTxPTR(n)    (long)(void*)(n)
 139 #endif
 140
 141 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
 142 #include <signal.h>
 143
 144 /* Alessandro Rubini's GPM (general-purpose mouse) */
 145 #if HAVE_LIBGPM && HAVE_GPM_H
 146 #define USE_GPM_SUPPORT 1
 147 #else
 148 #define USE_GPM_SUPPORT 0
 149 #endif
 150
 151 /* QNX mouse support */
 152 #if defined(__QNX__) && !defined(__QNXNTO__)
 153 #define USE_QNX_MOUSE 1
 154 #else
 155 #define USE_QNX_MOUSE 0
 156 #endif
 157
 158 /* EMX mouse support */
 159 #ifdef __EMX__
 160 #define USE_EMX_MOUSE 1
 161 #else
 162 #define USE_EMX_MOUSE 0
 163 #endif
 164
 165 /* kLIBC keyboard/mouse support */
 166 #if defined(__OS2__) && defined(__KLIBC__)
 167 #define USE_KLIBC_KBD   1
 168 #define USE_KLIBC_MOUSE 1
 169 #else
 170 #define USE_KLIBC_KBD   0
 171 #define USE_KLIBC_MOUSE 0
 172 #endif
 173
 174 #define DEFAULT_MAXCLICK 166
 175 #define EV_MAX          8       /* size of mouse circular event queue */
 176
 177 /*
 178  * If we don't have signals to support it, don't add a sigwinch handler.
 179  * In any case, resizing is an extended feature.  Use it if we've got it.
 180  */
 181 #if !NCURSES_EXT_FUNCS
 182 #undef HAVE_SIZECHANGE
 183 #define HAVE_SIZECHANGE 0
 184 #endif
 185
 186 #if HAVE_SIZECHANGE && USE_SIGWINCH && defined(SIGWINCH)
 187 #define USE_SIZECHANGE 1
 188 #else
 189 #define USE_SIZECHANGE 0
 190 #undef USE_SIGWINCH
 191 #define USE_SIGWINCH 0
 192 #endif
 193
 194 /*
 195  * When building in the MSYS2 environment, the automatic discovery of
 196  * the path separator in configure doesn't work properly. So, if building
 197  * for MinGW, we enforce the correct Windows PATH separator
 198  */
 199 #if defined(_NC_WINDOWS)
 200 #  ifdef NCURSES_PATHSEP
 201 #    undef NCURSES_PATHSEP
 202 #  endif
 203 #  define NCURSES_PATHSEP ';'
 204 #endif
 205
 206 /*
 207  * When the standard handles have been redirected (such as inside a text editor
 208  * or the less utility), keystrokes must be read from the console rather than
 209  * the redirected handle.  The standard output handle suffers from a similar
 210  * problem.  Both handles are not closed once opened.  The console shall be
 211  * considered reachable throughout the process.
 212  */
 213 #if defined(_NC_WINDOWS)
 214 #define GetDirectHandle(fileName, shareMode) \
 215         CreateFile(TEXT(fileName), \
 216                    GENERIC_READ | GENERIC_WRITE, \
 217                    shareMode, \
 218                    0, \
 219                    OPEN_EXISTING, \
 220                    0, \
 221                    0)
 222 #endif
 223
 224 /*
 225  * Not all platforms have memmove; some have an equivalent bcopy.  (Some may
 226  * have neither).
 227  */
 228 #if USE_OK_BCOPY
 229 #define memmove(d,s,n) bcopy(s,d,n)
 230 #elif USE_MY_MEMMOVE
 231 #define memmove(d,s,n) _nc_memmove(d,s,n)
 232 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
 233 #endif
 234
 235 /*
 236  * If we have va_copy(), use it for assigning va_list's.
 237  */
 238 #if defined(HAVE___VA_COPY)
 239 #define begin_va_copy(dst,src)  __va_copy(dst, src)
 240 #define end_va_copy(dst)        va_end(dst)
 241 #elif defined(va_copy) || defined(HAVE_VA_COPY)
 242 #define begin_va_copy(dst,src)  va_copy(dst, src)
 243 #define end_va_copy(dst)        va_end(dst)
 244 #else
 245 #define begin_va_copy(dst,src) (dst) = (src)
 246 #define end_va_copy(dst)        /* nothing */
 247 #endif
 248
 249 /*
 250  * Either/both S_ISxxx and/or S_IFxxx are defined in sys/types.h; some systems
 251  * lack one or the other.
 252  */
 253 #ifndef S_ISDIR
 254 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
 255 #endif
 256
 257 #ifndef S_ISREG
 258 #define S_ISREG(mode) ((mode & S_IFMT) == S_IFREG)
 259 #endif
 260
 261 /*
 262  * POSIX ignores the "b", which c89 specified.  Some very old systems do not
 263  * accept it.
 264  */
 265 #if USE_FOPEN_BIN_R
 266 #define BIN_R   "rb"
 267 #define BIN_W   "wb"
 268 #else
 269 #define BIN_R   "r"
 270 #define BIN_W   "w"
 271 #endif
 272
 273 /*
 274  * Scroll hints are useless when hashmap is used
 275  */
 276 #if !USE_SCROLL_HINTS
 277 #if !USE_HASHMAP
 278 #define USE_SCROLL_HINTS 1
 279 #else
 280 #define USE_SCROLL_HINTS 0
 281 #endif
 282 #endif
 283
 284 #if USE_SCROLL_HINTS
 285 #define if_USE_SCROLL_HINTS(stmt) stmt
 286 #else
 287 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
 288 #endif
 289
 290 #include <nc_string.h>
 291
 292 /*
 293  * Options for terminal drivers, etc...
 294  */
 295 #ifdef USE_TERM_DRIVER
 296 #define NO_TERMINAL "unknown"
 297 #define USE_SP_RIPOFF     1
 298 #define USE_SP_TERMTYPE   1
 299 #else
 300 #define NO_TERMINAL 0
 301 #endif
 302
 303 #define VALID_TERM_ENV(term_env, no_terminal) \
 304         (term_env = (NonEmpty(term_env) \
 305                      ? term_env \
 306                      : no_terminal), \
 307          NonEmpty(term_env))
 308
 309 /*
 310  * Originally a terminal-driver option, the window-list is per-screen to allow
 311  * freeing memory used for windows when a screen is deleted.
 312  */
 313 #define USE_SP_WINDOWLIST 1
 314
 315 /*
 316  * Note:  ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
 317  * when we're throwing control codes at the screen at high volume.  To see
 318  * this, re-enable USE_HARD_TABS and run worm for a while.  Other systems
 319  * probably don't want to define this either due to uncertainties about tab
 320  * delays and expansion in raw mode.
 321  */
 322
 323 #define TRIES struct tries
 324 typedef TRIES {
 325         TRIES    *child;            /* ptr to child.  NULL if none          */
 326         TRIES    *sibling;          /* ptr to sibling.  NULL if none        */
 327         unsigned char    ch;        /* character at this node               */
 328         unsigned short   value;     /* code of string so far.  0 if none.   */
 329 #undef TRIES
 330 } TRIES;
 331
 332 /*
 333  * Common/troublesome character definitions
 334  */
 335 #define StringOf(ch) {ch, 0}
 336
 337 #define CSI_CHR 0x9b
 338 #define ESC_CHR 0x1b
 339
 340 #define L_BLOCK '['
 341 #define R_BLOCK ']'
 342 #define L_BRACE '{'
 343 #define R_BRACE '}'
 344 #define S_QUOTE '\''
 345 #define D_QUOTE '"'
 346
 347 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
 348
 349 /*
 350  * Structure for palette tables
 351  */
 352
 353 #define MAXCOLUMNS    135
 354 #define MAXLINES      66
 355 #define FIFO_SIZE     MAXCOLUMNS+2  /* for nocbreak mode input */
 356
 357 #define ACS_LEN       128
 358
 359 #define WINDOWLIST struct _win_list
 360
 361 #if USE_WIDEC_SUPPORT
 362 #define _nc_bkgd    _bkgrnd
 363 #else
 364 #undef _XOPEN_SOURCE_EXTENDED
 365 #undef _XPG5
 366 #define _nc_bkgd    _bkgd
 367 #define wgetbkgrnd(win, wch)    ((*wch = win->_bkgd) != 0 ? OK : ERR)
 368 #define wbkgrnd     wbkgd
 369 #endif
 370
 371 #undef NCURSES_OPAQUE
 372 #define NCURSES_INTERNALS 1
 373 #define NCURSES_OPAQUE 0
 374
 375 #include <curses.h>     /* we'll use -Ipath directive to get the right one! */
 376
 377 #if !(defined(NCURSES_WGETCH_EVENTS) && defined(NEED_KEY_EVENT))
 378 #undef KEY_EVENT                /* reduce compiler-warnings with Visual C++ */
 379 #endif
 380
 381 typedef struct
 382 {
 383     int red, green, blue;       /* what color_content() returns */
 384     int r, g, b;                /* params to init_color() */
 385     int init;                   /* true if we called init_color() */
 386 }
 387 color_t;
 388
 389 typedef union {
 390     struct {
 391         unsigned char red;
 392         unsigned char green;
 393         unsigned char blue;
 394     } bits;                     /* bits per color-value in RGB */
 395     unsigned value;
 396 } rgb_bits_t;
 397
 398 /*
 399  * If curses.h did not expose the SCREEN-functions, then we do not need the
 400  * parameter in the corresponding unextended functions.
 401  */
 402
 403 #define USE_SP_FUNC_SUPPORT     NCURSES_SP_FUNCS
 404 #define USE_EXT_SP_FUNC_SUPPORT (NCURSES_SP_FUNCS && NCURSES_EXT_FUNCS)
 405
 406 #if NCURSES_SP_FUNCS
 407 #define SP_PARM         sp      /* use parameter */
 408 #define NCURSES_SP_ARG          SP_PARM
 409 #define NCURSES_SP_DCL  SCREEN *NCURSES_SP_ARG
 410 #define NCURSES_SP_DCL0 NCURSES_SP_DCL
 411 #define NCURSES_SP_ARGx         NCURSES_SP_ARG,
 412 #define NCURSES_SP_DCLx SCREEN *NCURSES_SP_ARGx
 413 #else
 414 #define SP_PARM         SP      /* use global variable */
 415 #define NCURSES_SP_ARG
 416 #define NCURSES_SP_DCL
 417 #define NCURSES_SP_DCL0 void
 418 #define NCURSES_SP_ARGx
 419 #define NCURSES_SP_DCLx
 420 #endif
 421
 422 #include <nc_panel.h>
 423
 424 #include <term.priv.h>
 425 #include <nc_termios.h>
 426
 427 #define IsPreScreen(sp)      (((sp) != 0) && sp->_prescreen)
 428 #define HasTerminal(sp)      (((sp) != 0) && (0 != ((sp)->_term)))
 429 #define IsValidScreen(sp)    (HasTerminal(sp) && !IsPreScreen(sp))
 430
 431 #if USE_REENTRANT
 432 #define CurTerm              _nc_prescreen._cur_term
 433 #else
 434 #define CurTerm              cur_term
 435 #endif
 436
 437 #if NCURSES_SP_FUNCS
 438 #define TerminalOf(sp)       ((sp) ? ((sp)->_term ? (sp)->_term : CurTerm) : CurTerm)
 439 #else
 440 #define TerminalOf(sp)       CurTerm
 441 #endif
 442
 443 /*
 444  * The legacy layout for TERMTYPE uses "short" for all of the numbers.  Moving
 445  * past that, numeric capabilities can be "int" by using a TERMTYPE2 structure
 446  * in TERMINAL, and doing most of the internal work using TERMTYPE2.  There are
 447  * a few places (mostly to expose the legacy layout) where the distinction
 448  * needs attention.
 449  */
 450 #if NCURSES_EXT_COLORS && HAVE_INIT_EXTENDED_COLOR
 451 #define NCURSES_EXT_NUMBERS  1
 452 #define NCURSES_INT2         int
 453 #define SIZEOF_INT2          4
 454 #define TerminalType(tp)     (tp)->type2
 455 #else
 456 #define NCURSES_EXT_NUMBERS  0
 457 #define NCURSES_INT2         short
 458 #define SIZEOF_INT2          2
 459 #define TerminalType(tp)     (tp)->type
 460 #endif
 461
 462 #define SIZEOF_SHORT         2
 463
 464 #ifdef CUR
 465 #undef CUR
 466 #define CUR TerminalType(cur_term).
 467 #endif
 468
 469 /*
 470  * Reduce dependency on cur_term global by using terminfo data from SCREEN's
 471  * pointer to this data.
 472  */
 473 #ifdef USE_SP_TERMTYPE
 474 #undef CUR
 475 #endif
 476
 477 #define SP_TERMTYPE TerminalType(TerminalOf(sp)).
 478
 479 #include <term_entry.h>
 480
 481 #include <nc_tparm.h>
 482
 483 /*
 484  * Simplify ifdef's for the "*_ATTR" macros in case italics are not configured.
 485  */
 486 #if defined(A_ITALIC) && defined(exit_italics_mode)
 487 #define USE_ITALIC 1
 488 #else
 489 #define USE_ITALIC 0
 490 #undef  A_ITALIC
 491 #define A_ITALIC 0
 492 #endif
 493
 494 /*
 495  * Use these macros internally, to make tracing less verbose.  But leave the
 496  * option for compiling the tracing into the library.
 497  */
 498 #if 1
 499 #define ColorPair(n)            (NCURSES_BITS(n, 0) & A_COLOR)
 500 #define PairNumber(a)           (NCURSES_CAST(int,(((unsigned long)(a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
 501 #else
 502 #define ColorPair(pair)         COLOR_PAIR(pair)
 503 #define PairNumber(attr)        PAIR_NUMBER(attr)
 504 #endif
 505
 506 #define unColor(n)              unColor2(AttrOf(n))
 507 #define unColor2(a)             ((a) & ALL_BUT_COLOR)
 508
 509 /*
 510  * Extended-colors stores the color pair in a separate struct-member than the
 511  * attributes.  But for compatibility, we handle most cases where a program
 512  * written for non-extended colors stores the color in the attributes by
 513  * checking for a color pair in both places.
 514  */
 515 #if NCURSES_EXT_COLORS
 516 #define if_EXT_COLORS(stmt)     stmt
 517 #define SetPair(value,p)        SetPair2((value).ext_color, AttrOf(value), p)
 518 #define SetPair2(c,a,p)         c = (p), \
 519                                 a = (unColor2(a) | ColorPair(oldColor(c)))
 520 #define GetPair(value)          GetPair2((value).ext_color, AttrOf(value))
 521 #define GetPair2(c,a)           ((c) ? (c) : PairNumber(a))
 522 #define oldColor(p)             (((p) > 255) ? 255 : (p))
 523 #define GET_WINDOW_PAIR(w)      GetPair2((w)->_color, (w)->_attrs)
 524 #define SET_WINDOW_PAIR(w,p)    (w)->_color = (p)
 525 #define SameAttrOf(a,b)         (AttrOf(a) == AttrOf(b) && GetPair(a) == GetPair(b))
 526
 527 #define VIDPUTS(sp,attr,pair)   do { \
 528                                     int vid_pair = pair; \
 529                                     NCURSES_SP_NAME(vid_puts)( \
 530                                         NCURSES_SP_ARGx attr, \
 531                                         (NCURSES_PAIRS_T) pair, \
 532                                         &vid_pair, \
 533                                         NCURSES_OUTC_FUNC); \
 534                                 } while (0)
 535
 536 #else /* !NCURSES_EXT_COLORS */
 537
 538 #define if_EXT_COLORS(stmt)     /* nothing */
 539 #define SetPair(value,p)        RemAttr(value, A_COLOR), \
 540                                 SetAttr(value, AttrOf(value) | ColorPair(p))
 541 #define GetPair(value)          PairNumber(AttrOf(value))
 542 #define GET_WINDOW_PAIR(w)      PairNumber(WINDOW_ATTRS(w))
 543 #define SET_WINDOW_PAIR(w,p)    WINDOW_ATTRS(w) &= ALL_BUT_COLOR, \
 544                                 WINDOW_ATTRS(w) |= ColorPair(p)
 545 #define SameAttrOf(a,b)         (AttrOf(a) == AttrOf(b))
 546
 547 #define VIDPUTS(sp,attr,pair)   NCURSES_SP_NAME(vidputs)(NCURSES_SP_ARGx attr, NCURSES_OUTC_FUNC)
 548
 549 #endif /* NCURSES_EXT_COLORS */
 550
 551 #define NCURSES_OUTC_FUNC       NCURSES_SP_NAME(_nc_outch)
 552 #define NCURSES_PUTP2(name,value)    NCURSES_SP_NAME(_nc_putp)(NCURSES_SP_ARGx name, value)
 553 #define NCURSES_PUTP2_FLUSH(name,value)    NCURSES_SP_NAME(_nc_putp_flush)(NCURSES_SP_ARGx name, value)
 554
 555 #if NCURSES_NO_PADDING
 556 #define GetNoPadding(sp)        ((sp) ? (sp)->_no_padding : _nc_prescreen._no_padding)
 557 #define SetNoPadding(sp)        _nc_set_no_padding(sp)
 558 extern NCURSES_EXPORT(void)     _nc_set_no_padding(SCREEN *);
 559 #else
 560 #define GetNoPadding(sp)        FALSE
 561 #define SetNoPadding(sp)        /*nothing*/
 562 #endif
 563
 564 #define WINDOW_ATTRS(w)         ((w)->_attrs)
 565
 566 #define SCREEN_ATTRS(s)         (*((s)->_current_attr))
 567 #define GET_SCREEN_PAIR(s)      GetPair(SCREEN_ATTRS(s))
 568 #define SET_SCREEN_PAIR(s,p)    SetPair(SCREEN_ATTRS(s), p)
 569
 570 #if USE_REENTRANT || NCURSES_SP_FUNCS
 571 extern NCURSES_EXPORT(int *)    _nc_ptr_Lines (SCREEN *);
 572 extern NCURSES_EXPORT(int *)    _nc_ptr_Cols (SCREEN *);
 573 extern NCURSES_EXPORT(int *)    _nc_ptr_Tabsize (SCREEN *);
 574 extern NCURSES_EXPORT(int *)    _nc_ptr_Escdelay (SCREEN *);
 575 #endif
 576
 577 #if USE_REENTRANT
 578
 579 #define ptrLines(sp)         (sp ? &(sp->_LINES) : &(_nc_prescreen._LINES))
 580 #define ptrCols(sp)          (sp ? &(sp->_COLS) : &(_nc_prescreen._COLS))
 581 #define ptrTabsize(sp)       (sp ? &(sp->_TABSIZE) : &(_nc_prescreen._TABSIZE))
 582 #define ptrEscdelay(sp)      (sp ? &(sp->_ESCDELAY) : &(_nc_prescreen._ESCDELAY))
 583
 584 #define SET_LINES(value)     *_nc_ptr_Lines(SP_PARM) = value
 585 #define SET_COLS(value)      *_nc_ptr_Cols(SP_PARM) = value
 586 #define SET_TABSIZE(value)   *_nc_ptr_Tabsize(SP_PARM) = value
 587 #define SET_ESCDELAY(value)  *_nc_ptr_Escdelay(SP_PARM) = value
 588
 589 #else
 590
 591 #define ptrLines(sp)         &LINES
 592 #define ptrCols(sp)          &COLS
 593 #define ptrTabsize(sp)       &TABSIZE
 594 #define ptrEscdelay(sp)      &ESCDELAY
 595
 596 #define SET_LINES(value)     LINES = value
 597 #define SET_COLS(value)      COLS = value
 598 #define SET_TABSIZE(value)   TABSIZE = value
 599 #define SET_ESCDELAY(value)  ESCDELAY = value
 600
 601 #endif
 602
 603 #define IS_SUBWIN(w)         ((w)->_flags & _SUBWIN)
 604 #define IS_PAD(w)            ((w)->_flags & _ISPAD)
 605 #define IS_WRAPPED(w)        ((w)->_flags & _WRAPPED)
 606
 607 #define HasHardTabs()   (NonEmpty(clear_all_tabs) && NonEmpty(set_tab))
 608
 609 #define TR_MUTEX(data) _tracef("%s@%d: me:%08lX COUNT:%2u/%2d/%6d/%2d/%s%9u: " #data, \
 610             __FILE__, __LINE__, \
 611             (unsigned long) (pthread_self()), \
 612             data.__data.__lock, \
 613             data.__data.__count, \
 614             data.__data.__owner, \
 615             data.__data.__kind, \
 616             (data.__data.__nusers > 5) ? " OOPS " : "", \
 617             data.__data.__nusers)
 618 #define TR_GLOBAL_MUTEX(name) TR_MUTEX(_nc_globals.mutex_##name)
 619
 620 #if USE_WEAK_SYMBOLS
 621 #if defined(__GNUC__)
 622 #  if defined __USE_ISOC99
 623 #    define _cat_pragma(exp)    _Pragma(#exp)
 624 #    define _weak_pragma(exp)   _cat_pragma(weak name)
 625 #  else
 626 #    define _weak_pragma(exp)
 627 #  endif
 628 #  define _declare(name)        __extension__ extern __typeof__(name) name
 629 #  define weak_symbol(name)     _weak_pragma(name) _declare(name) __attribute__((weak))
 630 #else
 631 #  undef USE_WEAK_SYMBOLS
 632 #  define USE_WEAK_SYMBOLS 0
 633 #endif
 634 #endif
 635
 636 #ifdef USE_PTHREADS
 637
 638 #if USE_REENTRANT
 639 #include <pthread.h>
 640 extern NCURSES_EXPORT(void) _nc_init_pthreads(void);
 641 extern NCURSES_EXPORT(void) _nc_mutex_init(pthread_mutex_t *);
 642 extern NCURSES_EXPORT(int) _nc_mutex_lock(pthread_mutex_t *);
 643 extern NCURSES_EXPORT(int) _nc_mutex_trylock(pthread_mutex_t *);
 644 extern NCURSES_EXPORT(int) _nc_mutex_unlock(pthread_mutex_t *);
 645 #define _nc_lock_global(name)   _nc_mutex_lock(&_nc_globals.mutex_##name)
 646 #define _nc_try_global(name)    _nc_mutex_trylock(&_nc_globals.mutex_##name)
 647 #define _nc_unlock_global(name) _nc_mutex_unlock(&_nc_globals.mutex_##name)
 648
 649 #else
 650 #error POSIX threads requires --enable-reentrant option
 651 #endif
 652
 653 #ifdef USE_PTHREADS
 654 #  if USE_WEAK_SYMBOLS
 655 weak_symbol(pthread_sigmask);
 656 weak_symbol(pthread_kill);
 657 weak_symbol(pthread_self);
 658 weak_symbol(pthread_equal);
 659 weak_symbol(pthread_mutex_init);
 660 weak_symbol(pthread_mutex_lock);
 661 weak_symbol(pthread_mutex_unlock);
 662 weak_symbol(pthread_mutex_trylock);
 663 weak_symbol(pthread_mutexattr_settype);
 664 weak_symbol(pthread_mutexattr_init);
 665 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
 666 #    undef  sigprocmask
 667 #    define sigprocmask(a, b, c) _nc_sigprocmask(a, b, c)
 668 #    define GetThreadID() (((pthread_self)) ? pthread_self() : (pthread_t) getpid())
 669 #  else
 670 #    define GetThreadID() pthread_self()
 671 #  endif
 672 #endif
 673
 674 #if HAVE_NANOSLEEP
 675 #undef HAVE_NANOSLEEP
 676 #define HAVE_NANOSLEEP 0        /* nanosleep suspends all threads */
 677 #endif
 678
 679 #else /* !USE_PTHREADS */
 680
 681 #if USE_PTHREADS_EINTR
 682 #  if USE_WEAK_SYMBOLS
 683 #include <pthread.h>
 684 weak_symbol(pthread_sigmask);
 685 weak_symbol(pthread_kill);
 686 weak_symbol(pthread_self);
 687 weak_symbol(pthread_equal);
 688 extern NCURSES_EXPORT(int) _nc_sigprocmask(int, const sigset_t *, sigset_t *);
 689 #    undef  sigprocmask
 690 #    define sigprocmask(a, b, c) _nc_sigprocmask(a, b, c)
 691 #  endif
 692 #endif /* USE_PTHREADS_EINTR */
 693
 694 #define _nc_init_pthreads()     /* nothing */
 695 #define _nc_mutex_init(obj)     /* nothing */
 696
 697 #define _nc_lock_global(name)   /* nothing */
 698 #define _nc_try_global(name)    0
 699 #define _nc_unlock_global(name) /* nothing */
 700 #endif /* USE_PTHREADS */
 701
 702 #if USE_PTHREADS_EINTR
 703 extern NCURSES_EXPORT(void) _nc_set_read_thread(bool);
 704 #else
 705 #define _nc_set_read_thread(enable)     /* nothing */
 706 #endif
 707
 708 /*
 709  * When using sp-funcs, locks are targeted to SCREEN-level granularity.
 710  * So the locking is done in the non-sp-func (which calls the sp-func) rather
 711  * than in the sp-func itself.
 712  *
 713  * Use the _nc_nonsp_XXX functions in the function using "NCURSES_SP_NAME()".
 714  * Use the _nc_sp_XXX functions in the function using "#if NCURSES_SP_FUNCS".
 715  */
 716 #if NCURSES_SP_FUNCS
 717
 718 #define _nc_nonsp_lock_global(name)     /* nothing */
 719 #define _nc_nonsp_try_global(name)    0
 720 #define _nc_nonsp_unlock_global(name)   /* nothing */
 721
 722 #define _nc_sp_lock_global(name)        _nc_lock_global(name)
 723 #define _nc_sp_try_global(name)         _nc_try_global(name)
 724 #define _nc_sp_unlock_global(name)      _nc_unlock_global(name)
 725
 726 #else
 727
 728 #define _nc_nonsp_lock_global(name)     _nc_lock_global(name)
 729 #define _nc_nonsp_try_global(name)      _nc_try_global(name)
 730 #define _nc_nonsp_unlock_global(name)   _nc_unlock_global(name)
 731
 732 #define _nc_sp_lock_global(name)        /* nothing */
 733 #define _nc_sp_try_global(name)    0
 734 #define _nc_sp_unlock_global(name)      /* nothing */
 735
 736 #endif
 737
 738 #if HAVE_CLOCK_GETTIME
 739 # define PRECISE_GETTIME 1
 740 # define GetClockTime(t) clock_gettime(CLOCK_REALTIME, t)
 741 # define TimeType struct timespec
 742 # define TimeScale 1000000000L          /* 1e9 */
 743 # define sub_secs tv_nsec
 744 #elif HAVE_GETTIMEOFDAY
 745 # define PRECISE_GETTIME 1
 746 # define GetClockTime(t) gettimeofday(t, 0)
 747 # define TimeType struct timeval
 748 # define TimeScale 1000000L             /* 1e6 */
 749 # define sub_secs tv_usec
 750 #else
 751 # define PRECISE_GETTIME 0
 752 # define TimeType time_t
 753 #endif
 754
 755 /*
 756  * Definitions for color pairs
 757  */
 758
 759 #define MAX_OF_TYPE(t)   (int)(((unsigned t)(~0))>>1)
 760
 761 #include <new_pair.h>
 762
 763 #define isDefaultColor(c)       ((c) < 0)
 764 #define COLOR_DEFAULT           -1
 765
 766 #if defined(USE_BUILD_CC) || (defined(USE_TERMLIB) && !defined(NEED_NCURSES_CH_T))
 767
 768 #undef NCURSES_CH_T             /* this is not a termlib feature */
 769 #define NCURSES_CH_T void       /* ...but we need a pointer in SCREEN */
 770
 771 #endif  /* USE_TERMLIB */
 772
 773 #ifndef USE_TERMLIB
 774 struct ldat
 775 {
 776         NCURSES_CH_T    *text;          /* text of the line */
 777         NCURSES_SIZE_T  firstchar;      /* first changed character in the line */
 778         NCURSES_SIZE_T  lastchar;       /* last changed character in the line */
 779         NCURSES_SIZE_T  oldindex;       /* index of the line at last update */
 780 };
 781 #endif  /* USE_TERMLIB */
 782
 783 typedef enum {
 784         M_XTERM = -1            /* use xterm's mouse tracking? */
 785         ,M_NONE = 0             /* no mouse device */
 786 #if USE_GPM_SUPPORT
 787         ,M_GPM                  /* use GPM */
 788 #endif
 789 #if USE_SYSMOUSE
 790         ,M_SYSMOUSE             /* FreeBSD sysmouse on console */
 791 #endif
 792 #ifdef USE_TERM_DRIVER
 793         ,M_TERM_DRIVER          /* Win32 console, etc */
 794 #endif
 795 } MouseType;
 796
 797 typedef enum {
 798         MF_X10 = 0              /* conventional 3-byte format */
 799         , MF_SGR1006            /* xterm private mode 1006, SGR-style */
 800 #ifdef EXP_XTERM_1005
 801         , MF_XTERM_1005         /* xterm UTF-8 private mode 1005 */
 802 #endif
 803 } MouseFormat;
 804
 805 /*
 806  * Structures for scrolling.
 807  */
 808
 809 typedef struct {
 810         unsigned long hashval;
 811         int oldcount, newcount;
 812         int oldindex, newindex;
 813 } HASHMAP;
 814
 815 /*
 816  * Structures for soft labels.
 817  */
 818
 819 struct _SLK;
 820
 821 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
 822
 823 typedef struct
 824 {
 825         char *ent_text;         /* text for the label */
 826         char *form_text;        /* formatted text (left/center/...) */
 827         int ent_x;              /* x coordinate of this field */
 828         char dirty;             /* this label has changed */
 829         char visible;           /* field is visible */
 830 } slk_ent;
 831
 832 typedef struct _SLK {
 833         bool    dirty;          /* all labels have changed */
 834         bool    hidden;         /* soft labels are hidden */
 835         WINDOW  *win;
 836         slk_ent *ent;
 837         short   maxlab;         /* number of available labels */
 838         short   labcnt;         /* number of allocated labels */
 839         short   maxlen;         /* length of labels */
 840         NCURSES_CH_T attr;      /* soft label attribute */
 841 } SLK;
 842
 843 #endif  /* USE_TERMLIB */
 844
 845 #if USE_GPM_SUPPORT
 846 #undef buttons                  /* term.h defines this, and gpm uses it! */
 847 #include <gpm.h>
 848 #if USE_WEAK_SYMBOLS
 849 weak_symbol(Gpm_Wgetch);
 850 #endif
 851
 852 #ifdef HAVE_LIBDL
 853 /* link dynamically to GPM */
 854 typedef int *TYPE_gpm_fd;
 855 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
 856 typedef int (*TYPE_Gpm_Close) (void);
 857 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
 858
 859 #define my_gpm_fd       SP_PARM->_mouse_gpm_fd
 860 #define my_Gpm_Open     SP_PARM->_mouse_Gpm_Open
 861 #define my_Gpm_Close    SP_PARM->_mouse_Gpm_Close
 862 #define my_Gpm_GetEvent SP_PARM->_mouse_Gpm_GetEvent
 863 #else
 864 /* link statically to GPM */
 865 #define my_gpm_fd       &gpm_fd
 866 #define my_Gpm_Open     Gpm_Open
 867 #define my_Gpm_Close    Gpm_Close
 868 #define my_Gpm_GetEvent Gpm_GetEvent
 869 #endif /* HAVE_LIBDL */
 870 #endif /* USE_GPM_SUPPORT */
 871
 872 /*
 873  * Limit delay-times to 30 seconds, which is consistent with signed 16-bit
 874  * numbers in legacy terminfo.
 875  */
 876 #define MAX_DELAY_MSECS 30000
 877
 878 /*
 879  * When converting from terminfo to termcap, check for cases where we can trim
 880  * octal escapes down to 2-character form.  It is useful for terminfo format
 881  * also, but not as important.
 882  */
 883 #define MAX_TC_FIXUPS   10
 884 #define MIN_TC_FIXUPS   4
 885
 886 #define isoctal(c) ((c) >= '0' && (c) <= '7')
 887
 888 /*
 889  * The filesystem database normally uses a single-letter for the lower level
 890  * of directories.  Use a hexadecimal code for filesystems which do not
 891  * preserve mixed-case names.
 892  */
 893 #if MIXEDCASE_FILENAMES
 894 #define LEAF_FMT "%c"
 895 #define LEAF_LEN 1
 896 #else
 897 #define LEAF_FMT "%02x"
 898 #define LEAF_LEN 2
 899 #endif
 900
 901 /*
 902  * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
 903  * could at most have 10 digits, and the mask contains no more than 32 bits
 904  * with each bit representing less than 15 characters.  Usually the whole
 905  * string is less than 80 columns, but this buffer size is an absolute
 906  * limit.
 907  */
 908 #define TRACECHR_BUF    40
 909 #define TRACEMSE_MAX    (80 + (5 * 10) + (32 * 15))
 910 #define TRACEMSE_FMT    "id %2d  at (%2d, %2d, %2d) state %4lx = {" /* } */
 911
 912 #ifdef USE_TERM_DRIVER
 913 struct DriverTCB; /* Terminal Control Block forward declaration */
 914 #define INIT_TERM_DRIVER()      _nc_globals.term_driver = _nc_get_driver
 915 #else
 916 #define INIT_TERM_DRIVER()      /* nothing */
 917 #endif
 918
 919 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
 920
 921 /* The limit reserves one byte for a terminating NUL */
 922 #define my_getstr_limit (_nc_globals.getstr_limit - 1)
 923 #define _nc_getstr_limit(n) \
 924         (((n) < 0) \
 925          ? my_getstr_limit \
 926          : (((n) > my_getstr_limit) \
 927             ? my_getstr_limit \
 928             : (n)))
 929
 930 /*
 931  * Use screen-specific ripoff data (for softkeys) rather than global.
 932  */
 933 #ifdef USE_SP_RIPOFF
 934 #define safe_ripoff_sp     (sp)->rsp
 935 #define safe_ripoff_stack  (sp)->rippedoff
 936 #else
 937 #define safe_ripoff_sp     _nc_prescreen.rsp
 938 #define safe_ripoff_stack  _nc_prescreen.rippedoff
 939 #endif
 940
 941 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
 942
 943 typedef enum {
 944     ewUnknown = 0,
 945     ewInitial,
 946     ewRunning,
 947     ewSuspend
 948 } ENDWIN;
 949
 950 typedef struct {
 951         int             _nl;            /* True if NL -> CR/NL is on        */
 952         int             _raw;           /* True if in raw mode              */
 953         int             _cbreak;        /* 1 if in cbreak mode              */
 954                                         /* > 1 if in halfdelay mode         */
 955         int             _echo;          /* True if echo on                  */
 956 } TTY_FLAGS;
 957
 958 #define IsNl(sp)        (sp)->_tty_flags._nl
 959 #define IsRaw(sp)       (sp)->_tty_flags._raw
 960 #define IsCbreak(sp)    (sp)->_tty_flags._cbreak
 961 #define IsEcho(sp)      (sp)->_tty_flags._echo
 962
 963 /*
 964  * The SCREEN structure.
 965  */
 966 typedef struct screen {
 967         int             _ifd;           /* input file descriptor for screen */
 968         int             _ofd;           /* output file descriptor for screen */
 969         FILE            *_ofp;          /* output file ptr for screen       */
 970         char            *out_buffer;    /* output buffer                    */
 971         size_t          out_limit;      /* output buffer size               */
 972         size_t          out_inuse;      /* output buffer current use        */
 973         bool            _filtered;      /* filter() was called              */
 974         bool            _prescreen;     /* is in prescreen phase            */
 975         bool            _use_env;       /* LINES & COLS from environment?   */
 976         int             _checkfd;       /* filedesc for typeahead check     */
 977         TERMINAL        *_term;         /* terminal type information        */
 978         TTY             _saved_tty;     /* savetty/resetty information      */
 979         NCURSES_SIZE_T  _lines;         /* screen lines                     */
 980         NCURSES_SIZE_T  _columns;       /* screen columns                   */
 981
 982         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
 983         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
 984
 985         WINDOW          *_curscr;       /* current screen                   */
 986         WINDOW          *_newscr;       /* virtual screen to be updated to  */
 987         WINDOW          *_stdscr;       /* screen's full-window context     */
 988
 989 #define CurScreen(sp)  (sp)->_curscr
 990 #define NewScreen(sp)  (sp)->_newscr
 991 #define StdScreen(sp)  (sp)->_stdscr
 992
 993         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
 994         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
 995         bool            _tried;         /* keypad mode was initialized      */
 996         bool            _keypad_on;     /* keypad mode is currently on      */
 997
 998         bool            _called_wgetch; /* check for recursion in wgetch()  */
 999         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
1000         short           _fifohead,      /* head of fifo queue               */
1001                         _fifotail,      /* tail of fifo queue               */
1002                         _fifopeek,      /* where to peek for next char      */
1003                         _fifohold;      /* set if breakout marked           */
1004
1005         int             _endwin;        /* are we out of window mode?       */
1006         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
1007         int             _coloron;       /* is color enabled?                */
1008         int             _color_defs;    /* are colors modified              */
1009         int             _cursor;        /* visibility of the cursor         */
1010         int             _cursrow;       /* physical cursor row              */
1011         int             _curscol;       /* physical cursor column           */
1012         bool            _notty;         /* true if we cannot switch non-tty */
1013         TTY_FLAGS       _tty_flags;
1014         int             _use_meta;      /* use the meta key?                */
1015         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
1016         int             slk_format;     /* selected format for this screen  */
1017         /* cursor movement costs; units are 10ths of milliseconds */
1018         int             _char_padding;  /* cost of character put            */
1019         int             _cr_cost;       /* cost of (carriage_return)        */
1020         int             _cup_cost;      /* cost of (cursor_address)         */
1021         int             _home_cost;     /* cost of (cursor_home)            */
1022         int             _ll_cost;       /* cost of (cursor_to_ll)           */
1023         int             _cub1_cost;     /* cost of (cursor_left)            */
1024         int             _cuf1_cost;     /* cost of (cursor_right)           */
1025         int             _cud1_cost;     /* cost of (cursor_down)            */
1026         int             _cuu1_cost;     /* cost of (cursor_up)              */
1027         int             _cub_cost;      /* cost of (parm_cursor_left)       */
1028         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
1029         int             _cud_cost;      /* cost of (parm_cursor_down)       */
1030         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
1031         int             _hpa_cost;      /* cost of (column_address)         */
1032         int             _vpa_cost;      /* cost of (row_address)            */
1033         /* used in tty_update.c, must be chars */
1034         int             _ed_cost;       /* cost of (clr_eos)                */
1035         int             _el_cost;       /* cost of (clr_eol)                */
1036         int             _el1_cost;      /* cost of (clr_bol)                */
1037         int             _dch1_cost;     /* cost of (delete_character)       */
1038         int             _ich1_cost;     /* cost of (insert_character)       */
1039         int             _dch_cost;      /* cost of (parm_dch)               */
1040         int             _ich_cost;      /* cost of (parm_ich)               */
1041         int             _ech_cost;      /* cost of (erase_chars)            */
1042         int             _rep_cost;      /* cost of (repeat_char)            */
1043         int             _hpa_ch_cost;   /* cost of (column_address)         */
1044         int             _cup_ch_cost;   /* cost of (cursor_address)         */
1045         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
1046         int             _inline_cost;   /* cost of inline-move              */
1047         int             _smir_cost;     /* cost of (enter_insert_mode)      */
1048         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
1049         int             _ip_cost;       /* cost of (insert_padding)         */
1050         /* used in lib_mvcur.c */
1051         char *          _address_cursor;
1052         /* used in tty_update.c */
1053         int             _scrolling;     /* 1 if terminal's smart enough to  */
1054
1055         /* used in lib_color.c */
1056         rgb_bits_t      _direct_color;  /* RGB overrides color-table         */
1057         color_t         *_color_table;  /* screen's color palette            */
1058         int             _color_count;   /* count of colors in palette        */
1059         colorpair_t     *_color_pairs;  /* screen's color pair list          */
1060         int             _pair_count;    /* same as COLOR_PAIRS               */
1061         int             _pair_limit;    /* actual limit of color-pairs       */
1062         int             _pair_alloc;    /* current table-size of color-pairs */
1063         chtype          _ok_attributes; /* valid attributes for terminal     */
1064         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
1065         chtype          _xmc_triggers;  /* attributes to process if xmc      */
1066         chtype *        _acs_map;       /* the real alternate-charset map    */
1067         bool *          _screen_acs_map;
1068
1069
1070         /* used in lib_vidattr.c */
1071         bool            _use_rmso;      /* true if we may use 'rmso'         */
1072         bool            _use_rmul;      /* true if we may use 'rmul'         */
1073
1074         /*
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.
1080          */
1081         bool            _nc_sp_idlok;
1082         bool            _nc_sp_idcok;
1083
1084         /*
1085          * These are the data that support the mouse interface.
1086          */
1087         bool            _mouse_initialized;
1088         MouseType       _mouse_type;
1089         int             _maxclick;
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         MouseFormat     _mouse_format;  /* type of xterm mouse protocol */
1101         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1102         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
1103         MEVENT          *_mouse_eventp; /* next free slot in event queue */
1104
1105         /*
1106          * These are data that support the proper handling of the panel stack on an
1107          * per screen basis.
1108          */
1109         struct panelhook _panelHook;
1110
1111         bool            _sig_winch;
1112         SCREEN          *_next_screen;
1113
1114         /* hashes for old and new lines */
1115         unsigned long   *oldhash, *newhash;
1116         HASHMAP         *hashtab;
1117         int             hashtab_len;
1118         int             *_oldnum_list;
1119         int             _oldnum_size;
1120
1121         NCURSES_SP_OUTC _outch;         /* output handler if not putc */
1122         NCURSES_OUTC    jump;
1123
1124         ripoff_t        rippedoff[N_RIPS];
1125         ripoff_t        *rsp;
1126
1127         int             _legacy_coding; /* see use_legacy_coding() */
1128
1129 #if NCURSES_NO_PADDING
1130         bool            _no_padding;    /* flag to set if padding disabled  */
1131 #endif
1132
1133 #if USE_HARD_TABS
1134         int             _ht_cost;       /* cost of (tab)                    */
1135         int             _cbt_cost;      /* cost of (backtab)                */
1136 #endif /* USE_HARD_TABS */
1137
1138         /* used in lib_vidattr.c */
1139 #if USE_ITALIC
1140         bool            _use_ritm;      /* true if we may use 'ritm'         */
1141 #endif
1142
1143         /* used in getch/twait */
1144 #if USE_KLIBC_KBD
1145         bool            _extended_key;  /* true if an extended key           */
1146 #endif
1147
1148         /* used in lib_color.c */
1149 #if NCURSES_EXT_FUNCS
1150         bool            _assumed_color; /* use assumed colors                */
1151         bool            _default_color; /* use default colors                */
1152         bool            _has_sgr_39_49; /* has ECMA default color support    */
1153         int             _default_fg;    /* assumed default foreground        */
1154         int             _default_bg;    /* assumed default background        */
1155         int             _default_pairs; /* count pairs using default color   */
1156 #endif
1157
1158         /* system-dependent mouse data */
1159 #if USE_GPM_SUPPORT
1160         bool            _mouse_gpm_loaded;
1161         bool            _mouse_gpm_found;
1162 #ifdef HAVE_LIBDL
1163         void            *_dlopen_gpm;
1164         TYPE_gpm_fd     _mouse_gpm_fd;
1165         TYPE_Gpm_Open   _mouse_Gpm_Open;
1166         TYPE_Gpm_Close  _mouse_Gpm_Close;
1167         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1168 #endif
1169         Gpm_Connect     _mouse_gpm_connect;
1170 #endif /* USE_GPM_SUPPORT */
1171
1172 #if USE_EMX_MOUSE
1173         int             _emxmouse_wfd;
1174         int             _emxmouse_thread;
1175         int             _emxmouse_activated;
1176         char            _emxmouse_buttons[4];
1177 #endif
1178
1179 #if USE_SYSMOUSE
1180         MEVENT          _sysmouse_fifo[FIFO_SIZE];
1181         int             _sysmouse_head;
1182         int             _sysmouse_tail;
1183         int             _sysmouse_char_width;   /* character width */
1184         int             _sysmouse_char_height;  /* character height */
1185         int             _sysmouse_old_buttons;
1186         int             _sysmouse_new_buttons;
1187 #endif
1188
1189 #if defined(USE_TERM_DRIVER) || defined(EXP_WIN32_DRIVER)
1190         MEVENT          _drv_mouse_fifo[FIFO_SIZE];
1191         int             _drv_mouse_head;
1192         int             _drv_mouse_tail;
1193         int             _drv_mouse_old_buttons;
1194         int             _drv_mouse_new_buttons;
1195 #endif
1196         /*
1197          * This supports automatic resizing
1198          */
1199 #if USE_SIZECHANGE
1200         int             (*_resize)(NCURSES_SP_DCLx int y, int x);
1201         int             (*_ungetch)(SCREEN *, int);
1202 #endif
1203
1204 #ifdef USE_SP_WINDOWLIST
1205         WINDOWLIST*     _windowlist;
1206 #define WindowList(sp)  (sp)->_windowlist
1207 #endif
1208
1209 #if USE_REENTRANT
1210         char            _ttytype[NAMESIZE];
1211         int             _ESCDELAY;
1212         int             _TABSIZE;
1213         int             _LINES;
1214         int             _COLS;
1215 #endif
1216
1217 #if NCURSES_SP_FUNCS
1218         bool            use_tioctl;
1219 #endif
1220
1221         /*
1222          * ncurses/ncursesw are the same up to this point.
1223          */
1224 #if USE_WIDEC_SUPPORT
1225         /* recent versions of 'screen' have partially-working support for
1226          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1227          */
1228         bool            _screen_acs_fix;
1229         bool            _screen_unicode;
1230 #endif
1231
1232 #if NCURSES_EXT_FUNCS && NCURSES_EXT_COLORS
1233         void            *_ordered_pairs; /* index used by alloc_pair()       */
1234         int             _pairs_used;    /* actual number of color-pairs used */
1235         int             _recent_pair;   /* number for most recent free-pair  */
1236 #endif
1237
1238 #ifdef TRACE
1239         char            tracechr_buf[TRACECHR_BUF];
1240         char            tracemse_buf[TRACEMSE_MAX];
1241 #if USE_REENTRANT
1242         long            _outchars;
1243         const char      *_tputs_trace;
1244 #endif
1245 #endif
1246 #undef SCREEN
1247 } SCREEN;
1248
1249 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1250 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1251
1252         WINDOWLIST {
1253         WINDOWLIST *next;
1254         SCREEN *screen;         /* screen containing the window */
1255         WINDOW  win;            /* WINDOW_EXT() needs to account for offset */
1256 #if NCURSES_WIDECHAR
1257         char addch_work[(MB_LEN_MAX * 9) + 1];
1258         unsigned addch_used;    /* number of bytes in addch_work[] */
1259         int addch_x;            /* x-position for addch_work[] */
1260         int addch_y;            /* y-position for addch_work[] */
1261 #endif
1262 };
1263
1264 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1265
1266 #ifdef USE_SP_WINDOWLIST
1267 #define SP_INIT_WINDOWLIST(sp)  WindowList(sp) = 0
1268 #else
1269 #define SP_INIT_WINDOWLIST(sp)  /* nothing */
1270 #endif
1271
1272 #define SP_PRE_INIT(sp)                         \
1273     sp->_cursrow           = -1;                \
1274     sp->_curscol           = -1;                \
1275     IsNl(sp)               = TRUE;              \
1276     IsRaw(sp)              = FALSE;             \
1277     IsCbreak(sp)           = 0;                 \
1278     IsEcho(sp)             = TRUE;              \
1279     sp->_fifohead          = -1;                \
1280     sp->_endwin            = ewSuspend;         \
1281     sp->_cursor            = -1;                \
1282     SP_INIT_WINDOWLIST(sp);                     \
1283     sp->_outch             = NCURSES_OUTC_FUNC; \
1284     sp->jump               = 0                  \
1285
1286 /* usually in <limits.h> */
1287 #ifndef UCHAR_MAX
1288 #define UCHAR_MAX 255
1289 #endif
1290
1291 /* The terminfo source is assumed to be 7-bit ASCII */
1292 #define is7bits(c)      ((unsigned)(c) < 128)
1293
1294 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1295 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
1296
1297 #ifndef Min
1298 #define Min(a,b)        ((a) > (b)  ?  (b)  :  (a))
1299 #endif
1300
1301 #ifndef Max
1302 #define Max(a,b)        ((a) < (b)  ?  (b)  :  (a))
1303 #endif
1304
1305 /* usually in <unistd.h> */
1306 #ifndef STDIN_FILENO
1307 #define STDIN_FILENO 0
1308 #endif
1309
1310 #ifndef STDOUT_FILENO
1311 #define STDOUT_FILENO 1
1312 #endif
1313
1314 #ifndef STDERR_FILENO
1315 #define STDERR_FILENO 2
1316 #endif
1317
1318 #ifndef EXIT_SUCCESS
1319 #define EXIT_SUCCESS 0
1320 #endif
1321
1322 #ifndef EXIT_FAILURE
1323 #define EXIT_FAILURE 1
1324 #endif
1325
1326 #ifndef R_OK
1327 #define R_OK    4               /* Test for read permission.  */
1328 #endif
1329 #ifndef W_OK
1330 #define W_OK    2               /* Test for write permission.  */
1331 #endif
1332 #ifndef X_OK
1333 #define X_OK    1               /* Test for execute permission.  */
1334 #endif
1335 #ifndef F_OK
1336 #define F_OK    0               /* Test for existence.  */
1337 #endif
1338
1339 #if HAVE_FCNTL_H
1340 #include <fcntl.h>              /* may define O_BINARY  */
1341 #endif
1342
1343 #ifndef O_BINARY
1344 #define O_BINARY 0
1345 #endif
1346
1347 #ifdef TRACE
1348 #if USE_REENTRANT
1349 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1350 #else
1351 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1352 #endif
1353 #else
1354 #define COUNT_OUTCHARS(n) /* nothing */
1355 #endif
1356
1357 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1358
1359 #define UChar(c)        ((unsigned char)(c))
1360 #define UShort(c)       ((unsigned short)(c))
1361 #define ChCharOf(c)     ((chtype)(c) & (chtype)A_CHARTEXT)
1362 #define ChAttrOf(c)     ((chtype)(c) & (chtype)A_ATTRIBUTES)
1363
1364 #define TR_PUTC(c)      TR(TRACE_CHARPUT, ("PUTC %#x", UChar(c)))
1365
1366 #if USE_WIDEC_SUPPORT /* { */
1367 /* true if the status/errno indicate an illegal multibyte sequence */
1368 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1369
1370 #define init_mb(state)  memset(&(state), 0, sizeof(state))
1371
1372 #if NCURSES_EXT_COLORS
1373 #define NulColor        , 0
1374 #else
1375 #define NulColor        /* nothing */
1376 #endif
1377
1378 #if CCHARW_MAX > 6
1379 #define NulChar         0,0,0,0,0
1380 #elif CCHARW_MAX > 5
1381 #define NulChar         0,0,0,0         /* ncurses7 */
1382 #elif CCHARW_MAX > 4
1383 #define NulChar         0,0,0           /* ncurses6 */
1384 #elif CCHARW_MAX > 3
1385 #define NulChar         0,0
1386 #elif CCHARW_MAX > 2
1387 #define NulChar         0
1388 #else
1389 #define NulChar         /* nothing */
1390 #endif
1391
1392 #define CharOf(c)       ((c).chars[0])
1393 #define AttrOf(c)       ((c).attr)
1394
1395 #define AddAttr(c,a)    AttrOf(c) |=  ((a) & A_ATTRIBUTES)
1396 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1397 #define SetAttr(c,a)    AttrOf(c) =   ((a) & A_ATTRIBUTES) | WidecExt(c)
1398
1399 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
1400 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
1401
1402 #if CCHARW_MAX > 1
1403 #define CharEq(a,b)     (((a).attr == (b).attr) \
1404                          && !memcmp((a).chars, \
1405                                     (b).chars, \
1406                                     CCHARW_MAX * sizeof((b).chars[0])) \
1407                         if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1408 #else
1409 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
1410 #endif
1411
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                             TR_PUTC(CharOf(ch));                                    \
1429                             NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch));         \
1430                             COUNT_OUTCHARS(1);                                      \
1431                         } else {                                                    \
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_INIT;                                          \
1437                                 PUTC_n = (int) wcrtomb(PUTC_buf,                    \
1438                                                        (ch).chars[PUTC_i], &PUT_st); \
1439                                 if (PUTC_n <= 0) {                                  \
1440                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) { \
1441                                         TR_PUTC(CharOf(ch));                        \
1442                                         NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1443                                     }                                               \
1444                                     break;                                          \
1445                                 } else {                                            \
1446                                     int PUTC_j;                                     \
1447                                     for (PUTC_j = 0; PUTC_j < PUTC_n; ++PUTC_j) {   \
1448                                         TR_PUTC(PUTC_buf[PUTC_j]);                  \
1449                                         NCURSES_OUTC_FUNC (NCURSES_SP_ARGx PUTC_buf[PUTC_j]); \
1450                                     }                                               \
1451                                 }                                                   \
1452                             }                                                       \
1453                             COUNT_OUTCHARS(PUTC_i);                                 \
1454                         } } } while (0)
1455
1456 #define BLANK           NewChar2(' ', WA_NORMAL)
1457 #define ZEROS           NewChar2('\0', WA_NORMAL)
1458 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1459
1460         /*
1461          * Wide characters cannot be represented in the A_CHARTEXT mask of
1462          * attr_t's but an application might have set a narrow character there.
1463          * But even in that case, it would only be a printable character, or
1464          * zero.  Otherwise we can use those bits to tell if a cell is the
1465          * first or extension part of a wide character.
1466          */
1467 #define WidecExt(ch)    (int) (AttrOf(ch) & A_CHARTEXT)
1468 #define isWidecBase(ch) (WidecExt(ch) == 1)
1469 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1470 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
1471                                 AttrOf(dst) |= (attr_t) (ext + 1)
1472
1473 #define if_WIDEC(code)  code
1474 #define Charable(ch)    (((SP_PARM->_legacy_coding)                     \
1475                          || (AttrOf(ch) & A_ALTCHARSET)                 \
1476                          || (!isWidecExt(ch))) &&                       \
1477                              (ch).chars[1] == L'\0' &&                  \
1478                              _nc_is_charable(CharOf(ch)))
1479
1480 #define L(ch)           L ## ch
1481 #else /* }{ */
1482 #define CharOf(c)       ChCharOf(c)
1483 #define AttrOf(c)       ChAttrOf(c)
1484 #define AddAttr(c,a)    c |= (a)
1485 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
1486 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
1487 #define NewChar(ch)     (ch)
1488 #define NewChar2(c,a)   ((c) | (a))
1489 #define CharEq(a,b)     ((a) == (b))
1490 #define SetChar(ch,c,a) ch = (c) | (a)
1491 #define CHREF(wch)      wch
1492 #define CHDEREF(wch)    wch
1493 #define ARG_CH_T        NCURSES_CH_T
1494 #define CARG_CH_T       NCURSES_CH_T
1495 #define PUTC_DATA       /* nothing */
1496 #define PUTC(ch)        { \
1497                             TR_PUTC(ch); \
1498                             NCURSES_OUTC_FUNC (NCURSES_SP_ARGx (int) ch); \
1499                         }
1500
1501 #define BLANK           (' '|A_NORMAL)
1502 #define ZEROS           ('\0'|A_NORMAL)
1503 #define ISBLANK(ch)     (CharOf(ch) == ' ')
1504
1505 #define isWidecExt(ch)  (0)
1506 #define if_WIDEC(code) /* nothing */
1507
1508 #define Charable(ch)    (CharOf(ch) >= ' ' && CharOf(ch) <= '~')
1509 #define L(ch)           ch
1510 #endif /* } */
1511
1512 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
1513 #define CharOfD(ch)     CharOf(CHDEREF(ch))
1514 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1515
1516 #define BLANK_ATTR      A_NORMAL
1517 #define BLANK_TEXT      L(' ')
1518
1519 #define CHANGED     -1
1520
1521 #define LEGALYX(w, y, x) \
1522               ((w) != 0 && \
1523                 ((x) >= 0 && (x) <= (w)->_maxx && \
1524                  (y) >= 0 && (y) <= (w)->_maxy))
1525
1526 #define CHANGED_CELL(line,col) \
1527         if (line->firstchar == _NOCHANGE) \
1528                 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1529         else if ((col) < line->firstchar) \
1530                 line->firstchar = (NCURSES_SIZE_T) (col); \
1531         else if ((col) > line->lastchar) \
1532                 line->lastchar = (NCURSES_SIZE_T) (col)
1533
1534 #define CHANGED_RANGE(line,start,end) \
1535         if (line->firstchar == _NOCHANGE \
1536          || line->firstchar > (start)) \
1537                 line->firstchar = (NCURSES_SIZE_T) (start); \
1538         if (line->lastchar == _NOCHANGE \
1539          || line->lastchar < (end)) \
1540                 line->lastchar = (NCURSES_SIZE_T) (end)
1541
1542 #define CHANGED_TO_EOL(line,start,end) \
1543         if (line->firstchar == _NOCHANGE \
1544          || line->firstchar > (start)) \
1545                 line->firstchar = (NCURSES_SIZE_T) (start); \
1546         line->lastchar = (NCURSES_SIZE_T) (end)
1547
1548 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1549
1550 #include <nc_alloc.h>
1551 #include <nc_access.h>
1552
1553 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
1554
1555 /* FreeAndNull() is not a comma-separated expression because some compilers
1556  * do not accept a mixture of void with values.
1557  */
1558 #define FreeAndNull(p)   do { free(p); p = 0; } while (0)
1559
1560 #ifdef EXP_OOM_TESTING
1561 extern NCURSES_EXPORT(void *)   _nc_oom_malloc(size_t size);
1562 extern NCURSES_EXPORT(void *)   _nc_oom_calloc(size_t nmemb, size_t size);
1563 extern NCURSES_EXPORT(void *)   _nc_oom_realloc(void *ptr, size_t size);
1564 extern NCURSES_EXPORT(void)     _nc_oom_free(void *ptr);
1565 extern NCURSES_EXPORT(char *)   _nc_oom_strdup(const char *ptr);
1566 #define malloc(size)            _nc_oom_malloc(size)
1567 #define calloc(nmemb, size)     _nc_oom_calloc(nmemb, size)
1568 #define realloc(ptr, size)      _nc_oom_realloc(ptr, size)
1569 #define free(ptr)               _nc_oom_free(ptr)
1570 #define strdup(ptr)             _nc_oom_strdup(ptr)
1571 #endif
1572
1573 /*
1574  * Use these for tic/infocmp malloc failures.  Generally the ncurses library
1575  * tries to limp along after a failure.
1576  */
1577 #define TYPE_MALLOC(type, size, name) \
1578         do { \
1579             name = typeMalloc(type, size); \
1580             if (name == 0) \
1581                 _nc_err_abort(MSG_NO_MEMORY); \
1582         } while (0)
1583
1584 #define TYPE_CALLOC(type, size, name) \
1585         do { \
1586             name = typeCalloc(type, size); \
1587             if (name == 0) \
1588                 _nc_err_abort(MSG_NO_MEMORY); \
1589         } while (0)
1590
1591 #define TYPE_REALLOC(type, size, name) \
1592         do { \
1593             name = typeRealloc(type, size, name); \
1594             if (name == 0) \
1595                 _nc_err_abort(MSG_NO_MEMORY); \
1596         } while (0)
1597
1598 /*
1599  * TTY bit definition for converting tabs to spaces.
1600  */
1601 #ifdef TAB3
1602 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
1603 #else
1604 # ifdef XTABS
1605 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
1606 # else
1607 #  ifdef OXTABS
1608 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
1609 #  else
1610 #   define OFLAGS_TABS 0
1611 #  endif
1612 # endif
1613 #endif
1614
1615 #ifdef __TANDEM
1616 #define ROOT_UID 65535
1617 #endif
1618
1619 #ifndef ROOT_UID
1620 #define ROOT_UID 0
1621 #endif
1622
1623 /*
1624  * Standardize/simplify common loops
1625  */
1626 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1627 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1628 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1629
1630 /*
1631  * Prefixes for call/return points of library function traces.  We use these to
1632  * instrument the public functions so that the traces can be easily transformed
1633  * into regression scripts.
1634  */
1635 #define T_CALLED(fmt) "called {" fmt
1636 #define T_CREATE(fmt) "create :" fmt
1637 #define T_RETURN(fmt) "return }" fmt
1638
1639 #define NonNull(s)              ((s) != 0 ? s : "<null>")
1640 #define NonEmpty(s)             ((s) != 0 && *(s) != '\0')
1641
1642 #ifdef TRACE
1643
1644 #if USE_REENTRANT
1645 #define TPUTS_TRACE(s)  _nc_set_tputs_trace(s);
1646 #else
1647 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
1648 #endif
1649
1650 #ifdef HAVE_CONSISTENT_GETENV
1651 #define START_TRACE() \
1652         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1653             int t = _nc_getenv_num("NCURSES_TRACE"); \
1654             if (t >= 0) \
1655                 curses_trace((unsigned) t); \
1656         }
1657 #else
1658 #define START_TRACE() /* nothing */
1659 #endif
1660
1661 /*
1662  * Many of the _tracef() calls use static buffers; lock the trace state before
1663  * trying to fill them.
1664  */
1665 #if USE_REENTRANT
1666 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1667 extern NCURSES_EXPORT(int)      _nc_use_tracef (unsigned);
1668 extern NCURSES_EXPORT(void)     _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1669 #else
1670 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1671 #define _nc_locked_tracef _tracef
1672 #endif
1673
1674 #define TR(n, a)        if (USE_TRACEF(n)) _nc_locked_tracef a
1675 #define T(a)            TR(TRACE_CALLS, a)
1676 #define TRACE_RETURN(value,type)     return _nc_retrace_##type((type)(value))
1677 #define TRACE_RETURN1(value,dst)     return _nc_retrace_##dst(value)
1678 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1679 #define TRACE_RETURN_SP(value,type)  return _nc_retrace_##type(SP_PARM, value)
1680
1681 typedef void VoidFunc(void);
1682
1683 #define TR_FUNC_LEN             ((sizeof(void *) + sizeof(void (*)(void))) * 2 + 4)
1684 #define TR_FUNC_BFR(max)        char tr_func_data[max][TR_FUNC_LEN]
1685 #define TR_FUNC_ARG(num,func)   _nc_fmt_funcptr(&tr_func_data[num][0], (const char *)&(func), sizeof((func)))
1686
1687 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
1688 #define returnBits(code)        TRACE_RETURN(code,unsigned)
1689 #define returnBool(code)        TRACE_RETURN(code,bool)
1690 #define returnCPtr(code)        TRACE_RETURN1(code,cptr)
1691 #define returnCVoidPtr(code)    TRACE_RETURN1(code,cvoid_ptr)
1692 #define returnChar(code)        TRACE_RETURN(code,char)
1693 #define returnChtype(code)      TRACE_RETURN(code,chtype)
1694 #define returnCode(code)        TRACE_RETURN(code,int)
1695 #define returnIntAttr(code)     TRACE_RETURN2(code,int,attr_t)
1696 #define returnMMask(code)       TRACE_RETURN_SP(code,mmask_t)
1697 #define returnPtr(code)         TRACE_RETURN1(code,ptr)
1698 #define returnSP(code)          TRACE_RETURN1(code,sp)
1699 #define returnVoid              { T((T_RETURN(""))); return; }
1700 #define returnVoidPtr(code)     TRACE_RETURN1(code,void_ptr)
1701 #define returnWin(code)         TRACE_RETURN1(code,win)
1702
1703 #define returnDB(rc)            do { TR(TRACE_DATABASE,(T_RETURN("code %d"), (rc))); return (rc); } while (0)
1704 #define returnPtrDB(rc)         do { TR(TRACE_DATABASE,(T_RETURN("%p"), (rc))); return (rc); } while (0)
1705 #define returnVoidDB            do { TR(TRACE_DATABASE,(T_RETURN(""))); return; } while (0)
1706
1707 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (int);
1708 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1709 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
1710 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
1711 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
1712 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
1713 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(const TTY *tty);
1714 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
1715 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
1716 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
1717 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
1718 extern NCURSES_EXPORT(char)             _nc_retrace_char (int);
1719 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
1720 extern NCURSES_EXPORT(int)              _nc_retrace_int_attr_t (attr_t);
1721 extern NCURSES_EXPORT(mmask_t)          _nc_retrace_mmask_t (SCREEN *, mmask_t);
1722 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
1723 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
1724 extern NCURSES_EXPORT(void)             _nc_fifo_dump (SCREEN *);
1725
1726 extern NCURSES_EXPORT(char *)           _nc_fmt_funcptr(char *, const char *, size_t);
1727
1728 #if USE_REENTRANT
1729 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1730 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1731 #define _nc_outchars       NCURSES_PUBLIC_VAR(_nc_outchars())
1732 #define _nc_tputs_trace    NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1733 extern NCURSES_EXPORT(void)             _nc_set_tputs_trace (const char *);
1734 extern NCURSES_EXPORT(void)             _nc_count_outchars (long);
1735 #else
1736 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1737 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
1738 #endif
1739
1740 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
1741
1742 extern NCURSES_EXPORT(char *) _nc_tracebits (void);
1743 extern NCURSES_EXPORT(char *) _tracemouse (const MEVENT *);
1744 extern NCURSES_EXPORT(void) _tracedump (const char *, WINDOW *);
1745
1746 #if USE_WIDEC_SUPPORT
1747 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1748 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1749 #endif
1750
1751 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1752 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1753
1754 #else /* !TRACE */
1755
1756 #define START_TRACE() /* nothing */
1757
1758 #define T(a)
1759 #define TR(n, a)
1760 #define TPUTS_TRACE(s)
1761 #define TR_FUNC_BFR(max)
1762
1763 #define returnAttr(code)        return code
1764 #define returnBits(code)        return code
1765 #define returnBool(code)        return code
1766 #define returnCPtr(code)        return code
1767 #define returnCVoidPtr(code)    return code
1768 #define returnChar(code)        return ((char) code)
1769 #define returnChtype(code)      return code
1770 #define returnCode(code)        return code
1771 #define returnIntAttr(code)     return code
1772 #define returnMMask(code)       return code
1773 #define returnPtr(code)         return code
1774 #define returnSP(code)          return code
1775 #define returnVoid              return
1776 #define returnVoidPtr(code)     return code
1777 #define returnWin(code)         return code
1778
1779 #define returnDB(code)          return code
1780 #define returnPtrDB(rc)         return rc
1781 #define returnVoidDB            return
1782
1783 #endif /* TRACE/!TRACE */
1784
1785 /*
1786  * Workaround for defective implementation of gcc attribute warn_unused_result
1787  */
1788 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1789 #define IGNORE_RC(func) errno = (int) func
1790 #else
1791 #define IGNORE_RC(func) (void) func
1792 #endif /* gcc workarounds */
1793
1794 /*
1795  * Return-codes for tgetent() and friends.
1796  */
1797 #define TGETENT_YES  1          /* entry is found */
1798 #define TGETENT_NO   0          /* entry is not found */
1799 #define TGETENT_ERR -1          /* an error occurred */
1800
1801 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1802 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1803
1804 #define EMPTY_MODULE(name) \
1805 extern  NCURSES_EXPORT(void) name (void); \
1806         NCURSES_EXPORT(void) name (void) { }
1807
1808 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1809 #define NONBLANK_ATTR (A_BOLD | A_DIM | A_BLINK | A_ITALIC)
1810 #define TPARM_ATTR    (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_ALTCHARSET | A_INVIS | A_PROTECT)
1811 #define XMC_CONFLICT  (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_INVIS | A_PROTECT | A_ITALIC)
1812 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1813
1814 #define toggle_attr_on(S,at) {\
1815    if (PairNumber(at) > 0) {\
1816       (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1817    } else {\
1818       (S) |= (attr_t) (at);\
1819    }\
1820    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1821
1822
1823 #define toggle_attr_off(S,at) {\
1824    if (PairNumber(at) > 0) {\
1825       (S) &= ~(at|A_COLOR);\
1826    } else {\
1827       (S) &= ~(at);\
1828    }\
1829    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1830
1831 #define DelCharCost(sp,count) \
1832                 ((parm_dch != 0) \
1833                 ? sp->_dch_cost \
1834                 : ((delete_character != 0) \
1835                         ? (sp->_dch1_cost * count) \
1836                         : INFINITY))
1837
1838 #define InsCharCost(sp,count) \
1839                 ((parm_ich != 0) \
1840                 ? sp->_ich_cost \
1841                 : ((enter_insert_mode && exit_insert_mode) \
1842                   ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1843                   : ((insert_character != 0) \
1844                     ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1845                     : INFINITY)))
1846
1847 #if USE_XMC_SUPPORT
1848 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1849                                 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1850                                 VIDPUTS(sp, AttrOf(c), GetPair(c)); \
1851                                 if (magic_cookie_glitch > 0 \
1852                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1853                                         T(("%s @%d before glitch %d,%d", \
1854                                                 __FILE__, __LINE__, \
1855                                                 sp->_cursrow, \
1856                                                 sp->_curscol)); \
1857                                         NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1858                                 } \
1859                         }
1860 #else
1861 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1862                                     VIDPUTS(sp, AttrOf(c), GetPair(c)); \
1863                         }
1864 #endif
1865
1866 /*
1867  * Macros to make additional parameter to implement wgetch_events()
1868  */
1869 #ifdef NCURSES_WGETCH_EVENTS
1870 #define EVENTLIST_0th(param) param
1871 #define EVENTLIST_1st(param) param
1872 #define EVENTLIST_2nd(param) , param
1873 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1874 #else
1875 #define EVENTLIST_0th(param) void
1876 #define EVENTLIST_1st(param) /* nothing */
1877 #define EVENTLIST_2nd(param) /* nothing */
1878 #define TWAIT_MASK TW_ANY
1879 #endif
1880
1881 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1882
1883 #undef  toggle_attr_on
1884 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1885 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1886
1887 #undef  toggle_attr_off
1888 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1889 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1890
1891 #undef  DelCharCost
1892 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1893
1894 #undef  InsCharCost
1895 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1896
1897 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1898 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1899
1900 #undef  UpdateAttrs
1901 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1902
1903 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1904 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1905 #else
1906 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1907 #endif
1908
1909 #if NCURSES_SP_FUNCS
1910 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1911 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1912 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1913 #endif /* NCURSES_SP_FUNCS */
1914
1915 #else
1916
1917 extern NCURSES_EXPORT(void) _nc_expanded (void);
1918
1919 #endif
1920
1921 #if !NCURSES_EXT_FUNCS
1922 #define set_escdelay(value) ESCDELAY = value
1923 #endif
1924
1925 #if !HAVE_GETCWD
1926 #define getcwd(buf,len) getwd(buf)
1927 #endif
1928
1929 #define save_ttytype(termp) \
1930         if (TerminalType(termp).term_names != 0) { \
1931             _nc_STRNCPY(ttytype, \
1932                         TerminalType(termp).term_names, \
1933                         NAMESIZE - 1); \
1934             ttytype[NAMESIZE - 1] = '\0'; \
1935         }
1936
1937 #if !NCURSES_WCWIDTH_GRAPHICS
1938 extern NCURSES_EXPORT(int) _nc_wacs_width(unsigned);
1939 #else
1940 #define _nc_wacs_width(ch) wcwidth(ch)
1941 #endif
1942
1943 /* charable.c */
1944 #if USE_WIDEC_SUPPORT
1945 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1946 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1947 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1948 #endif
1949
1950 /* comp_captab.c */
1951 typedef struct {
1952         short   nte_name;       /* offset of name to hash on */
1953         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
1954         short   nte_index;      /* index of associated variable in its array */
1955         short   nte_link;       /* index in table of next hash, or -1 */
1956 } name_table_data;
1957
1958 typedef struct
1959 {
1960         short   from;
1961         short   to;
1962         short   source;
1963 } alias_table_data;
1964
1965 /* comp_userdefs.c */
1966 typedef struct {
1967         short   ute_name;       /* offset of name to hash on */
1968         unsigned ute_type;      /* mask (BOOLEAN, NUMBER, STRING) */
1969         unsigned ute_argc;      /* number of parameters */
1970         unsigned ute_args;      /* bit-mask for string parameters */
1971         short   ute_index;      /* index of associated variable in its array */
1972         short   ute_link;       /* index in table of next hash, or -1 */
1973 } user_table_data;
1974
1975 /* doupdate.c */
1976 #if USE_XMC_SUPPORT
1977 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1978 #endif
1979
1980 /* hardscroll.c */
1981 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1982 extern NCURSES_EXPORT(void) _nc_linedump (void);
1983 #endif
1984
1985 /* lib_acs.c */
1986 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1987 extern NCURSES_EXPORT(int)  _nc_msec_cost (const char *const, int);
1988
1989 /* lib_addch.c */
1990 #if USE_WIDEC_SUPPORT
1991 extern NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1992 #endif
1993
1994 /* lib_addstr.c */
1995 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1996 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1997 #endif
1998
1999 /* lib_color.c */
2000 extern NCURSES_EXPORT(int) _nc_init_color(SCREEN *, int, int, int, int);
2001 extern NCURSES_EXPORT(int) _nc_init_pair(SCREEN *, int, int, int);
2002 extern NCURSES_EXPORT(int) _nc_pair_content(SCREEN *, int, int *, int *);
2003 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
2004 extern NCURSES_EXPORT(void) _nc_reserve_pairs(SCREEN *, int);
2005 extern NCURSES_EXPORT(void) _nc_change_pair(SCREEN *, int);
2006
2007 #define ReservePairs(sp,want) \
2008             if ((sp->_color_pairs == 0) || (want >= sp->_pair_alloc)) \
2009                 _nc_reserve_pairs(sp, want)
2010
2011 /* lib_getch.c */
2012 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
2013
2014 /* lib_insch.c */
2015 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
2016
2017 /* lib_mvcur.c */
2018 #define INFINITY        1000000 /* cost: too high to use */
2019
2020 extern NCURSES_EXPORT(int) _nc_mvcur(int yold, int xold, int ynew, int xnew);
2021
2022 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
2023 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
2024 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
2025
2026 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
2027
2028 extern NCURSES_EXPORT(void) _nc_screen_init (void);
2029 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
2030 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
2031
2032 /* lib_mouse.c */
2033 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
2034
2035 /* lib_mvcur.c */
2036 #define INFINITY        1000000 /* cost: too high to use */
2037 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
2038
2039 /* lib_setup.c */
2040 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
2041 extern NCURSES_EXPORT(int)    _nc_unicode_locale(void);
2042 extern NCURSES_EXPORT(int)    _nc_locale_breaks_acs(TERMINAL *);
2043 extern NCURSES_EXPORT(int)    _nc_setupterm(const char *, int, int *, int);
2044 extern NCURSES_EXPORT(void)   _nc_tinfo_cmdch(TERMINAL *, int);
2045
2046 #ifdef USE_PTHREADS
2047 extern NCURSES_EXPORT(SCREEN *) _nc_find_prescr(void);
2048 extern NCURSES_EXPORT(void)   _nc_forget_prescr(void);
2049 #else
2050 #define _nc_find_prescr()     _nc_prescreen.allocated
2051 #define _nc_forget_prescr()   _nc_prescreen.allocated = 0
2052 #endif
2053
2054 /* lib_set_term.c */
2055 extern NCURSES_EXPORT(int)    _nc_ripoffline(int, int(*)(WINDOW*, int));
2056
2057 /* lib_setup.c */
2058 #define ExitTerminfo(code)    exit_terminfo(code)
2059
2060 #define SETUP_FAIL ERR
2061
2062 #define ret_error(rc, fmt, p, q)        if (errret) {\
2063                                             *errret = rc;\
2064                                             q;\
2065                                             returnCode(SETUP_FAIL);\
2066                                         } else {\
2067                                             fprintf(stderr, fmt, p);\
2068                                             q;\
2069                                             ExitTerminfo(EXIT_FAILURE);\
2070                                         }
2071
2072 #define ret_error1(rc, fmt, p, q)       ret_error(rc, "'%s': " fmt, p, q)
2073
2074 #define ret_error0(rc, msg)             if (errret) {\
2075                                             *errret = rc;\
2076                                             returnCode(SETUP_FAIL);\
2077                                         } else {\
2078                                             fprintf(stderr, msg);\
2079                                             ExitTerminfo(EXIT_FAILURE);\
2080                                         }
2081
2082 /* lib_tstp.c */
2083 #if USE_SIGWINCH
2084 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
2085 #else
2086 #define _nc_handle_sigwinch(a) /* nothing */
2087 #endif
2088
2089 /* lib_wacs.c */
2090 #if USE_WIDEC_SUPPORT
2091 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
2092 #endif
2093
2094 typedef struct {
2095     char *s_head;       /* beginning of the string (may be null) */
2096     char *s_tail;       /* end of the string (may be null) */
2097     size_t s_size;      /* current remaining size available */
2098     size_t s_init;      /* total size available */
2099 } string_desc;
2100
2101 /* strings.c */
2102 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
2103 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
2104 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, const string_desc *);
2105 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
2106 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
2107
2108 #if !HAVE_STRSTR
2109 #define strstr _nc_strstr
2110 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
2111 #endif
2112
2113 /* safe_sprintf.c */
2114 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
2115
2116 /* tries.c */
2117 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
2118 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
2119 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
2120 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
2121
2122 /* elsewhere ... */
2123 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
2124 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
2125 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
2126 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
2127 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
2128 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
2129 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
2130 extern NCURSES_EXPORT(char *) _nc_trace_mmask_t (SCREEN *, mmask_t);
2131 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
2132 extern NCURSES_EXPORT(int) _nc_baudrate (int);
2133 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
2134 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
2135 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
2136 extern NCURSES_EXPORT(int) _nc_ospeed (int);
2137 extern NCURSES_EXPORT(int) _nc_outch (int);
2138 extern NCURSES_EXPORT(int) _nc_putchar (int);
2139 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
2140 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
2141 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE2 *const);
2142 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE2 *);
2143 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
2144 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
2145 extern NCURSES_EXPORT(int) _nc_trans_string (char *, const char *);
2146 extern NCURSES_EXPORT(void) _nc_init_termtype (TERMTYPE2 *const);
2147 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
2148 extern NCURSES_EXPORT(void) _nc_flush (void);
2149 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE2 *);
2150 extern NCURSES_EXPORT(void) _nc_freeall (void);
2151 extern NCURSES_EXPORT(void) _nc_hash_map (void);
2152 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
2153 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
2154 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
2155 extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *);
2156 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
2157 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
2158 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
2159 extern NCURSES_EXPORT(void) _nc_setenv_num (const char *, int);
2160 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
2161 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
2162 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
2163
2164 #if NCURSES_EXT_NUMBERS
2165 extern NCURSES_EXPORT(const TERMTYPE2 *) _nc_fallback2 (const char *);
2166 #else
2167 #define _nc_fallback2(tp) _nc_fallback(tp)
2168 #endif
2169
2170 extern NCURSES_EXPORT(void) _nc_copy_termtype(TERMTYPE *, const TERMTYPE *);
2171
2172 #if NCURSES_EXT_NUMBERS
2173 extern NCURSES_EXPORT(void) _nc_copy_termtype2 (TERMTYPE2 *, const TERMTYPE2 *);
2174 extern NCURSES_EXPORT(void) _nc_export_termtype2(TERMTYPE *, const TERMTYPE2 *);
2175 #else
2176 #define _nc_copy_termtype2(dst,src) _nc_copy_termtype((dst),(src))
2177 #define _nc_export_termtype2(dst,src) /* nothing */
2178 #define _nc_free_termtype2(t) _nc_free_termtype(t)
2179 /* also... */
2180 #define _nc_read_entry2 _nc_read_entry
2181 #endif
2182
2183 #if NO_LEAKS
2184 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
2185 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
2186 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
2187 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
2188 extern NCURSES_EXPORT(void) _nc_comp_error_leaks(void);
2189 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
2190 extern NCURSES_EXPORT(void) _nc_comp_userdefs_leaks(void);
2191 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
2192 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
2193 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
2194 extern NCURSES_EXPORT(void) _nc_tgetent_leak(const TERMINAL *);
2195 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
2196 #endif
2197
2198 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2199 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
2200 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
2201 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
2202 #endif
2203
2204 #if USE_WIDEC_SUPPORT
2205 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
2206 #endif
2207
2208 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2209 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
2210 #endif
2211
2212 #if USE_SIZECHANGE
2213 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
2214 #endif
2215
2216 #if HAVE_RESIZETERM
2217 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
2218 #else
2219 #define _nc_resize_margins(wp) /* nothing */
2220 #endif
2221
2222 #ifdef NCURSES_WGETCH_EVENTS
2223 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2224 #else
2225 #define wgetch_events(win, evl) wgetch(win)
2226 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2227 #endif
2228
2229 /*
2230  * Wide-character macros to hide some platform-differences.
2231  */
2232 #if USE_WIDEC_SUPPORT
2233
2234 #if defined(_NC_WINDOWS) && !defined(_NC_MSC) && !defined(EXP_WIN32_DRIVER)
2235 /*
2236  * MinGW has wide-character functions, but they do not work correctly.
2237  */
2238 extern int __MINGW_NOTHROW _nc_wctomb(char *, wchar_t);
2239 #define wctomb(s,wc) _nc_wctomb(s,wc)
2240 #define wcrtomb(s,wc,n) _nc_wctomb(s,wc)
2241
2242 extern int __MINGW_NOTHROW _nc_mbtowc(wchar_t *, const char *, size_t);
2243 #define mbtowc(pwc,s,n) _nc_mbtowc(pwc,s,n)
2244
2245 extern int __MINGW_NOTHROW _nc_mblen(const char *, size_t);
2246 #define mblen(s,n) _nc_mblen(s, n)
2247
2248 #endif /* _NC_WINDOWS && !_NC_MSC */
2249
2250 #if defined(_NC_WINDOWS) || defined(_NC_MINGW)
2251 /* see wcwidth.c */
2252 extern NCURSES_EXPORT(int) mk_wcwidth(wchar_t);
2253 #define wcwidth(ucs) _nc_wcwidth(ucs)
2254 #endif
2255
2256 #if HAVE_MBTOWC && HAVE_MBLEN
2257 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2258 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2259 #define check_mbytes(wch,buffer,length,state) \
2260         (int) mbtowc(&(wch), buffer, length)
2261 #define state_unused
2262 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2263 #define reset_mbytes(state) init_mb(state)
2264 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&(state))
2265 #define check_mbytes(wch,buffer,length,state) \
2266         (int) mbrtowc(&(wch), buffer, length, &(state))
2267 #else
2268 make an error
2269 #endif
2270
2271 #endif /* USE_WIDEC_SUPPORT */
2272
2273 /*
2274  * Not everyone has vsscanf(), but we'd like to use it for scanw().
2275  */
2276 #if !HAVE_VSSCANF
2277 extern int vsscanf(const char *str, const char *format, va_list __arg);
2278 #endif
2279
2280 /* scroll indices */
2281 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2282
2283 #define USE_SETBUF_0 0
2284
2285 #define NC_OUTPUT(sp) ((sp != 0 && sp->_ofp != 0) ? sp->_ofp : stdout)
2286
2287 /*
2288  * On systems with a broken linker, define 'SP' as a function to force the
2289  * linker to pull in the data-only module with 'SP'.
2290  */
2291 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2292
2293 #if BROKEN_LINKER
2294 #define SP _nc_screen()
2295 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2296 extern NCURSES_EXPORT(int)      _nc_alloc_screen (void);
2297 extern NCURSES_EXPORT(void)     _nc_set_screen (SCREEN *);
2298 #define CURRENT_SCREEN          _nc_screen()
2299 #else
2300 /* current screen is private data; avoid possible linking conflicts too */
2301 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2302 #define CURRENT_SCREEN SP
2303 #define _nc_alloc_screen()      ((SP = _nc_alloc_screen_sp()) != 0)
2304 #define _nc_set_screen(sp)      SP = sp
2305 #endif
2306
2307 #if NCURSES_SP_FUNCS
2308 #define CURRENT_SCREEN_PRE      (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2309 #else
2310 #define CURRENT_SCREEN_PRE      CURRENT_SCREEN
2311 #endif
2312
2313 /*
2314  * We don't want to use the lines or columns capabilities internally, because
2315  * if the application is running multiple screens under X, it is quite possible
2316  * they could all have type xterm but have different sizes!  So...
2317  */
2318 #define screen_lines(sp)        (sp)->_lines
2319 #define screen_columns(sp)      (sp)->_columns
2320
2321 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2322 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2323
2324 /*
2325  * Some constants related to SLK's
2326  */
2327 #define MAX_SKEY_OLD       8    /* count of soft keys */
2328 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
2329 #define MAX_SKEY_PC       12    /* This is what most PC's have */
2330 #define MAX_SKEY_LEN_PC    5
2331
2332 /* Macro to check whether or not we use a standard format */
2333 #define SLK_STDFMT(fmt) (fmt < 3)
2334 /* Macro to determine height of label window */
2335 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2336
2337 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2338 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2339
2340 /*
2341  * Common error messages
2342  */
2343 #define MSG_NO_MEMORY "Out of memory"
2344 #define MSG_NO_INPUTS "Premature EOF"
2345
2346 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2347 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2348
2349 /* timed_wait flag definitions */
2350 #define TW_NONE    0
2351 #define TW_INPUT   1
2352 #define TW_MOUSE   2
2353 #define TW_ANY     (TW_INPUT | TW_MOUSE)
2354 #define TW_EVENT   4
2355
2356 #define SetSafeOutcWrapper(outc)            \
2357     SCREEN* sp = CURRENT_SCREEN;            \
2358     struct screen outc_wrapper;             \
2359     if (sp==0) {                            \
2360         sp = &outc_wrapper;                 \
2361         memset(sp,0,sizeof(struct screen)); \
2362         sp->_outch = _nc_outc_wrapper;      \
2363     }\
2364     sp->jump = outc
2365
2366 #ifdef USE_TERM_DRIVER
2367
2368 typedef struct _termInfo
2369 {
2370     bool caninit;
2371
2372     bool hascolor;
2373     bool initcolor;
2374     bool canchange;
2375
2376     int  tabsize;
2377
2378     int  maxcolors;
2379     int  maxpairs;
2380     int  nocolorvideo;
2381
2382     int  numbuttons;
2383     int  numlabels;
2384     int  labelwidth;
2385     int  labelheight;
2386
2387     const color_t* defaultPalette;
2388 } TerminalInfo;
2389
2390 typedef struct term_driver {
2391     bool   isTerminfo;
2392     const char* (*td_name)(struct DriverTCB*);
2393     bool   (*td_CanHandle)(struct DriverTCB*, const char*, int*);
2394     void   (*td_init)(struct DriverTCB*);
2395     void   (*td_release)(struct DriverTCB*);
2396     int    (*td_size)(struct DriverTCB*, int* Line, int *Cols);
2397     int    (*td_sgmode)(struct DriverTCB*, int setFlag, TTY*);
2398     chtype (*td_conattr)(struct DriverTCB*);
2399     int    (*td_hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2400     int    (*td_mode)(struct DriverTCB*, int progFlag, int defFlag);
2401     bool   (*td_rescol)(struct DriverTCB*);
2402     bool   (*td_rescolors)(struct DriverTCB*);
2403     void   (*td_color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2404     int    (*td_doBeepOrFlash)(struct DriverTCB*, int);
2405     void   (*td_initpair)(struct DriverTCB*, int, int, int);
2406     void   (*td_initcolor)(struct DriverTCB*, int, int, int, int);
2407     void   (*td_docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2408     void   (*td_initmouse)(struct DriverTCB*);
2409     int    (*td_testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2410     void   (*td_setfilter)(struct DriverTCB*);
2411     void   (*td_hwlabel)(struct DriverTCB*, int, char*);
2412     void   (*td_hwlabelOnOff)(struct DriverTCB*, int);
2413     int    (*td_update)(struct DriverTCB*);
2414     int    (*td_defaultcolors)(struct DriverTCB*, int, int);
2415     int    (*td_print)(struct DriverTCB*, char*, int);
2416     int    (*td_getsize)(struct DriverTCB*, int*, int*);
2417     int    (*td_setsize)(struct DriverTCB*, int, int);
2418     void   (*td_initacs)(struct DriverTCB*, chtype*, chtype*);
2419     void   (*td_scinit)(SCREEN *);
2420     void   (*td_scexit)(SCREEN *);
2421     int    (*td_twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2422     int    (*td_read)(struct DriverTCB*, int*);
2423     int    (*td_nap)(struct DriverTCB*, int);
2424     int    (*td_kpad)(struct DriverTCB*, int);
2425     int    (*td_kyOk)(struct DriverTCB*, int, int);
2426     bool   (*td_kyExist)(struct DriverTCB*, int);
2427     int    (*td_cursorSet)(struct DriverTCB*, int);
2428 } TERM_DRIVER;
2429
2430 typedef struct DriverTCB
2431 {
2432     TERMINAL      term;   /* needs to be the first Element !!! */
2433     TERM_DRIVER*  drv;    /* The driver for that Terminal */
2434     SCREEN*       csp;    /* The screen that owns that Terminal */
2435     TerminalInfo  info;   /* Driver independent core capabilities of the Terminal */
2436     void*         prop;   /* Driver dependent property storage to be used by the Driver */
2437     long          magic;
2438 } TERMINAL_CONTROL_BLOCK;
2439
2440 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2441 #define NCDRV_TINFO      0x01
2442 #define NCDRV_WINCONSOLE 0x02
2443
2444 #define TCBOf(sp)    ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2445 #define InfoOf(sp)   TCBOf(sp)->info
2446 #define CallDriver(sp,method)                        TCBOf(sp)->drv->method(TCBOf(sp))
2447 #define CallDriver_1(sp,method,arg1)                 TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2448 #define CallDriver_2(sp,method,arg1,arg2)            TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2449 #define CallDriver_3(sp,method,arg1,arg2,arg3)       TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2450 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4)  TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2451
2452 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2453 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2454
2455 extern NCURSES_EXPORT(int)      _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2456 extern NCURSES_EXPORT(void)     _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2457 #endif /* USE_TERM_DRIVER */
2458
2459 /*
2460  * Entrypoints which are actually provided in the terminal driver, which would
2461  * be an sp-name otherwise.
2462  */
2463 #ifdef USE_TERM_DRIVER
2464 #define TINFO_HAS_KEY           _nc_tinfo_has_key
2465 #define TINFO_DOUPDATE          _nc_tinfo_doupdate
2466 #define TINFO_MVCUR             _nc_tinfo_mvcur
2467 extern NCURSES_EXPORT(int)      TINFO_HAS_KEY(SCREEN*, int);
2468 extern NCURSES_EXPORT(int)      TINFO_DOUPDATE(SCREEN *);
2469 extern NCURSES_EXPORT(int)      TINFO_MVCUR(SCREEN*, int, int, int, int);
2470 #else
2471 #define TINFO_HAS_KEY           NCURSES_SP_NAME(has_key)
2472 #define TINFO_DOUPDATE          NCURSES_SP_NAME(doupdate)
2473 #define TINFO_MVCUR             NCURSES_SP_NAME(_nc_mvcur)
2474 #endif
2475
2476 #if defined(EXP_WIN32_DRIVER)
2477 #include <nc_win32.h>
2478 #endif
2479
2480 /*
2481  * Entrypoints using an extra parameter with the terminal driver.
2482  */
2483 #ifdef USE_TERM_DRIVER
2484 extern NCURSES_EXPORT(void)   _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2485 extern NCURSES_EXPORT(int)    _nc_setupterm_ex(TERMINAL **, const char *, int , int *, int);
2486 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2487         _nc_get_screensize(sp, tp, lp, cp)
2488 #define TINFO_SET_CURTERM(sp, tp) \
2489         NCURSES_SP_NAME(set_curterm)(sp, tp)
2490 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2491         _nc_setupterm_ex(tpp, name, fd, err, reuse)
2492 #else /* !USE_TERM_DRIVER */
2493 extern NCURSES_EXPORT(void)   _nc_get_screensize(SCREEN *, int *, int *);
2494 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2495         _nc_get_screensize(sp, lp, cp)
2496 #define TINFO_SET_CURTERM(sp, tp) \
2497         set_curterm(tp)
2498 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2499         _nc_setupterm(name, fd, err, reuse)
2500 #endif /* !USE_TERM_DRIVER */
2501
2502 #ifdef EXP_WIN32_DRIVER
2503 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2504 #else
2505 #ifdef USE_TERM_DRIVER
2506 #if defined(USE_WIN32CON_DRIVER)
2507 #include <nc_mingw.h>
2508 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2509 extern NCURSES_EXPORT(int)  _nc_mingw_isatty(int fd);
2510 extern NCURSES_EXPORT(int)  _nc_mingw_isconsole(int fd);
2511 extern NCURSES_EXPORT(int) _nc_mingw_console_read(
2512     SCREEN *sp,
2513     HANDLE  fd,
2514     int *buf);
2515 extern NCURSES_EXPORT(int) _nc_mingw_testmouse(
2516     SCREEN * sp,
2517     HANDLE fd,
2518     int delay EVENTLIST_2nd(_nc_eventlist*));
2519 #else
2520 #endif
2521 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2522 #endif /* USE_TERM_DRIVER */
2523 #endif /* EXP_WIN32_DRIVER */
2524
2525 #if defined(USE_TERM_DRIVER) && defined(EXP_WIN32_DRIVER)
2526 #define NC_ISATTY(fd) (0 != _nc_console_isatty(fd))
2527 #elif defined(USE_TERM_DRIVER) && defined(USE_WIN32CON_DRIVER)
2528 #define NC_ISATTY(fd) _nc_mingw_isatty(fd)
2529 #else
2530 #define NC_ISATTY(fd) isatty(fd)
2531 #endif
2532
2533 #ifdef USE_TERM_DRIVER
2534 #  define IsTermInfo(sp)       ((TCBOf(sp) != 0) && ((TCBOf(sp)->drv->isTerminfo)))
2535 #  define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2536 #  if defined(EXP_WIN32_DRIVER)
2537 #    define IsTermInfoOnConsole(sp) (IsTermInfo(sp) && _nc_console_test(TerminalOf(sp)->Filedes))
2538 #  elif defined(USE_WIN32CON_DRIVER)
2539 #    define IsTermInfoOnConsole(sp) (IsTermInfo(sp) && _nc_mingw_isconsole(TerminalOf(sp)->Filedes))
2540 #  else
2541 #    define IsTermInfoOnConsole(sp) FALSE
2542 #  endif
2543 #else
2544 #  define IsTermInfo(sp)       TRUE
2545 #  define HasTInfoTerminal(sp) (0 != TerminalOf(sp))
2546 #  if defined(EXP_WIN32_DRIVER)
2547 #    define IsTermInfoOnConsole(sp) _nc_console_test(TerminalOf(sp)->Filedes)
2548 #  else
2549 #    define IsTermInfoOnConsole(sp) FALSE
2550 #  endif
2551 #endif
2552
2553 #define IsValidTIScreen(sp)  (HasTInfoTerminal(sp))
2554
2555 /*
2556  * Exported entrypoints beyond the published API
2557  */
2558 #if NCURSES_SP_FUNCS
2559 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2560 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2561 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2562 extern NCURSES_EXPORT(int)      _nc_outc_wrapper(SCREEN*,int);
2563
2564 #if USE_REENTRANT
2565 extern NCURSES_EXPORT(int)       NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2566 extern NCURSES_EXPORT(char *)    NCURSES_SP_NAME(longname)(SCREEN*);
2567 #endif
2568
2569 #if NCURSES_EXT_FUNCS
2570 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2571 #endif
2572
2573 /*
2574  * We put the safe versions of various calls here as they are not published
2575  * part of the API up to now
2576  */
2577 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2578 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2579 extern NCURSES_EXPORT(bool)     NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2580 extern NCURSES_EXPORT(char *)   NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2581 extern NCURSES_EXPORT(chtype)   NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2582 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2583 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2584 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2585 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_mvcur)(SCREEN*, int, int, int, int);
2586 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2587 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putchar)(SCREEN*, int);
2588 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2589 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2590 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2591 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2592 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2593 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2594 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2595 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2596 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2597 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2598 extern GCC_NORETURN NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int);
2599 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2600 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2601 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2602 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2603 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2604 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2605 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2606 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2607 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2608 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2609 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2610 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2611 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2612
2613 extern NCURSES_EXPORT(void)     _nc_cookie_init(SCREEN *sp);
2614
2615 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2616 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2617 #endif
2618
2619 #if USE_WIDEC_SUPPORT
2620 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2621 #endif
2622
2623 #endif /* NCURSES_SP_FUNCS */
2624
2625 #if NCURSES_SP_FUNCS
2626
2627 #define safe_keyname NCURSES_SP_NAME(keyname)
2628 #define safe_unctrl  NCURSES_SP_NAME(unctrl)
2629 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2630
2631 #else
2632
2633 #define safe_keyname _nc_keyname
2634 #define safe_unctrl  _nc_unctrl
2635 #define safe_ungetch _nc_ungetch
2636
2637 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2638 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2639 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2640
2641 #endif
2642
2643 #ifdef EXP_XTERM_1005
2644 extern NCURSES_EXPORT(int) _nc_conv_to_utf8(unsigned char *, unsigned, unsigned);
2645 extern NCURSES_EXPORT(int) _nc_conv_to_utf32(unsigned *, const char *, unsigned);
2646 #endif
2647
2648 #ifdef __cplusplus
2649 }
2650 #endif
2651
2652 /* *INDENT-ON* */
2653
2654 #endif /* CURSES_PRIV_H */