ncurses/curses.priv.h

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