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.670 2023/06/24 13:00:26 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)(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)(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  * When converting from terminfo to termcap, check for cases where we can trim
 880  * octal escapes down to 2-character form.  It is useful for terminfo format
 881  * also, but not as important.
 882  */
 883 #define MAX_TC_FIXUPS   10
 884 #define MIN_TC_FIXUPS   4
 885
 886 #define isoctal(c) ((c) >= '0' && (c) <= '7')
 887
 888 /*
 889  * The filesystem database normally uses a single-letter for the lower level
 890  * of directories.  Use a hexadecimal code for filesystems which do not
 891  * preserve mixed-case names.
 892  */
 893 #if MIXEDCASE_FILENAMES
 894 #define LEAF_FMT "%c"
 895 #define LEAF_LEN 1
 896 #else
 897 #define LEAF_FMT "%02x"
 898 #define LEAF_LEN 2
 899 #endif
 900
 901 /*
 902  * TRACEMSE_FMT is no longer than 80 columns, there are 5 numbers that
 903  * could at most have 10 digits, and the mask contains no more than 32 bits
 904  * with each bit representing less than 15 characters.  Usually the whole
 905  * string is less than 80 columns, but this buffer size is an absolute
 906  * limit.
 907  */
 908 #define TRACEMSE_MAX    (80 + (5 * 10) + (32 * 15))
 909 #define TRACEMSE_FMT    "id %2d  at (%2d, %2d, %2d) state %4lx = {" /* } */
 910
 911 #ifdef USE_TERM_DRIVER
 912 struct DriverTCB; /* Terminal Control Block forward declaration */
 913 #define INIT_TERM_DRIVER()      _nc_globals.term_driver = _nc_get_driver
 914 #else
 915 #define INIT_TERM_DRIVER()      /* nothing */
 916 #endif
 917
 918 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
 919
 920 /* The limit reserves one byte for a terminating NUL */
 921 #define my_getstr_limit (_nc_globals.getstr_limit - 1)
 922 #define _nc_getstr_limit(n) \
 923         (((n) < 0) \
 924          ? my_getstr_limit \
 925          : (((n) > my_getstr_limit) \
 926             ? my_getstr_limit \
 927             : (n)))
 928
 929 /*
 930  * Use screen-specific ripoff data (for softkeys) rather than global.
 931  */
 932 #ifdef USE_SP_RIPOFF
 933 #define safe_ripoff_sp     (sp)->rsp
 934 #define safe_ripoff_stack  (sp)->rippedoff
 935 #else
 936 #define safe_ripoff_sp     _nc_prescreen.rsp
 937 #define safe_ripoff_stack  _nc_prescreen.rippedoff
 938 #endif
 939
 940 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
 941
 942 typedef enum {
 943     ewInitial = 0,
 944     ewRunning,
 945     ewSuspend
 946 } ENDWIN;
 947
 948 typedef struct {
 949         int             _nl;            /* True if NL -> CR/NL is on        */
 950         int             _raw;           /* True if in raw mode              */
 951         int             _cbreak;        /* 1 if in cbreak mode              */
 952                                         /* > 1 if in halfdelay mode         */
 953         int             _echo;          /* True if echo on                  */
 954 } TTY_FLAGS;
 955
 956 #define IsNl(sp)        (sp)->_tty_flags._nl
 957 #define IsRaw(sp)       (sp)->_tty_flags._raw
 958 #define IsCbreak(sp)    (sp)->_tty_flags._cbreak
 959 #define IsEcho(sp)      (sp)->_tty_flags._echo
 960
 961 /*
 962  * The SCREEN structure.
 963  */
 964 typedef struct screen {
 965         int             _ifd;           /* input file descriptor for screen */
 966         int             _ofd;           /* output file descriptor for screen */
 967         FILE            *_ofp;          /* output file ptr for screen       */
 968         char            *out_buffer;    /* output buffer                    */
 969         size_t          out_limit;      /* output buffer size               */
 970         size_t          out_inuse;      /* output buffer current use        */
 971         bool            _filtered;      /* filter() was called              */
 972         bool            _prescreen;     /* is in prescreen phase            */
 973         bool            _use_env;       /* LINES & COLS from environment?   */
 974         int             _checkfd;       /* filedesc for typeahead check     */
 975         TERMINAL        *_term;         /* terminal type information        */
 976         TTY             _saved_tty;     /* savetty/resetty information      */
 977         NCURSES_SIZE_T  _lines;         /* screen lines                     */
 978         NCURSES_SIZE_T  _columns;       /* screen columns                   */
 979
 980         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
 981         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
 982
 983         WINDOW          *_curscr;       /* current screen                   */
 984         WINDOW          *_newscr;       /* virtual screen to be updated to  */
 985         WINDOW          *_stdscr;       /* screen's full-window context     */
 986
 987 #define CurScreen(sp)  (sp)->_curscr
 988 #define NewScreen(sp)  (sp)->_newscr
 989 #define StdScreen(sp)  (sp)->_stdscr
 990
 991         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
 992         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
 993         bool            _tried;         /* keypad mode was initialized      */
 994         bool            _keypad_on;     /* keypad mode is currently on      */
 995
 996         bool            _called_wgetch; /* check for recursion in wgetch()  */
 997         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
 998         short           _fifohead,      /* head of fifo queue               */
 999                         _fifotail,      /* tail of fifo queue               */
1000                         _fifopeek,      /* where to peek for next char      */
1001                         _fifohold;      /* set if breakout marked           */
1002
1003         int             _endwin;        /* are we out of window mode?       */
1004         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
1005         int             _coloron;       /* is color enabled?                */
1006         int             _color_defs;    /* are colors modified              */
1007         int             _cursor;        /* visibility of the cursor         */
1008         int             _cursrow;       /* physical cursor row              */
1009         int             _curscol;       /* physical cursor column           */
1010         bool            _notty;         /* true if we cannot switch non-tty */
1011         TTY_FLAGS       _tty_flags;
1012         int             _use_meta;      /* use the meta key?                */
1013         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
1014         int             slk_format;     /* selected format for this screen  */
1015         /* cursor movement costs; units are 10ths of milliseconds */
1016         int             _char_padding;  /* cost of character put            */
1017         int             _cr_cost;       /* cost of (carriage_return)        */
1018         int             _cup_cost;      /* cost of (cursor_address)         */
1019         int             _home_cost;     /* cost of (cursor_home)            */
1020         int             _ll_cost;       /* cost of (cursor_to_ll)           */
1021         int             _cub1_cost;     /* cost of (cursor_left)            */
1022         int             _cuf1_cost;     /* cost of (cursor_right)           */
1023         int             _cud1_cost;     /* cost of (cursor_down)            */
1024         int             _cuu1_cost;     /* cost of (cursor_up)              */
1025         int             _cub_cost;      /* cost of (parm_cursor_left)       */
1026         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
1027         int             _cud_cost;      /* cost of (parm_cursor_down)       */
1028         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
1029         int             _hpa_cost;      /* cost of (column_address)         */
1030         int             _vpa_cost;      /* cost of (row_address)            */
1031         /* used in tty_update.c, must be chars */
1032         int             _ed_cost;       /* cost of (clr_eos)                */
1033         int             _el_cost;       /* cost of (clr_eol)                */
1034         int             _el1_cost;      /* cost of (clr_bol)                */
1035         int             _dch1_cost;     /* cost of (delete_character)       */
1036         int             _ich1_cost;     /* cost of (insert_character)       */
1037         int             _dch_cost;      /* cost of (parm_dch)               */
1038         int             _ich_cost;      /* cost of (parm_ich)               */
1039         int             _ech_cost;      /* cost of (erase_chars)            */
1040         int             _rep_cost;      /* cost of (repeat_char)            */
1041         int             _hpa_ch_cost;   /* cost of (column_address)         */
1042         int             _cup_ch_cost;   /* cost of (cursor_address)         */
1043         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
1044         int             _inline_cost;   /* cost of inline-move              */
1045         int             _smir_cost;     /* cost of (enter_insert_mode)      */
1046         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
1047         int             _ip_cost;       /* cost of (insert_padding)         */
1048         /* used in lib_mvcur.c */
1049         char *          _address_cursor;
1050         /* used in tty_update.c */
1051         int             _scrolling;     /* 1 if terminal's smart enough to  */
1052
1053         /* used in lib_color.c */
1054         rgb_bits_t      _direct_color;  /* RGB overrides color-table         */
1055         color_t         *_color_table;  /* screen's color palette            */
1056         int             _color_count;   /* count of colors in palette        */
1057         colorpair_t     *_color_pairs;  /* screen's color pair list          */
1058         int             _pair_count;    /* same as COLOR_PAIRS               */
1059         int             _pair_limit;    /* actual limit of color-pairs       */
1060         int             _pair_alloc;    /* current table-size of color-pairs */
1061         chtype          _ok_attributes; /* valid attributes for terminal     */
1062         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
1063         chtype          _xmc_triggers;  /* attributes to process if xmc      */
1064         chtype *        _acs_map;       /* the real alternate-charset map    */
1065         bool *          _screen_acs_map;
1066
1067
1068         /* used in lib_vidattr.c */
1069         bool            _use_rmso;      /* true if we may use 'rmso'         */
1070         bool            _use_rmul;      /* true if we may use 'rmul'         */
1071
1072         /*
1073          * These data correspond to the state of the idcok() and idlok()
1074          * functions.  A caveat is in order here:  the XSI and SVr4
1075          * documentation specify that these functions apply to the window which
1076          * is given as an argument.  However, ncurses implements this logic
1077          * only for the newscr/curscr update process, _not_ per-window.
1078          */
1079         bool            _nc_sp_idlok;
1080         bool            _nc_sp_idcok;
1081
1082         /*
1083          * These are the data that support the mouse interface.
1084          */
1085         bool            _mouse_initialized;
1086         MouseType       _mouse_type;
1087         int             _maxclick;
1088         bool            (*_mouse_event) (SCREEN *);
1089         bool            (*_mouse_inline)(SCREEN *);
1090         bool            (*_mouse_parse) (SCREEN *, int);
1091         void            (*_mouse_resume)(SCREEN *);
1092         void            (*_mouse_wrap)  (SCREEN *);
1093         int             _mouse_fd;      /* file-descriptor, if any */
1094         bool            _mouse_active;  /* true if initialized */
1095         mmask_t         _mouse_mask;    /* set via mousemask() */
1096         mmask_t         _mouse_mask2;   /* OR's in press/release bits */
1097         mmask_t         _mouse_bstate;
1098         MouseFormat     _mouse_format;  /* type of xterm mouse protocol */
1099         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
1100         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
1101         MEVENT          *_mouse_eventp; /* next free slot in event queue */
1102
1103         /*
1104          * These are data that support the proper handling of the panel stack on an
1105          * per screen basis.
1106          */
1107         struct panelhook _panelHook;
1108
1109         bool            _sig_winch;
1110         SCREEN          *_next_screen;
1111
1112         /* hashes for old and new lines */
1113         unsigned long   *oldhash, *newhash;
1114         HASHMAP         *hashtab;
1115         int             hashtab_len;
1116         int             *_oldnum_list;
1117         int             _oldnum_size;
1118
1119         NCURSES_SP_OUTC _outch;         /* output handler if not putc */
1120         NCURSES_OUTC    jump;
1121
1122         ripoff_t        rippedoff[N_RIPS];
1123         ripoff_t        *rsp;
1124
1125         int             _legacy_coding; /* see use_legacy_coding() */
1126
1127 #if NCURSES_NO_PADDING
1128         bool            _no_padding;    /* flag to set if padding disabled  */
1129 #endif
1130
1131 #if USE_HARD_TABS
1132         int             _ht_cost;       /* cost of (tab)                    */
1133         int             _cbt_cost;      /* cost of (backtab)                */
1134 #endif /* USE_HARD_TABS */
1135
1136         /* used in lib_vidattr.c */
1137 #if USE_ITALIC
1138         bool            _use_ritm;      /* true if we may use 'ritm'         */
1139 #endif
1140
1141         /* used in getch/twait */
1142 #if USE_KLIBC_KBD
1143         bool            _extended_key;  /* true if an extended key           */
1144 #endif
1145
1146         /* used in lib_color.c */
1147 #if NCURSES_EXT_FUNCS
1148         bool            _assumed_color; /* use assumed colors                */
1149         bool            _default_color; /* use default colors                */
1150         bool            _has_sgr_39_49; /* has ECMA default color support    */
1151         int             _default_fg;    /* assumed default foreground        */
1152         int             _default_bg;    /* assumed default background        */
1153         int             _default_pairs; /* count pairs using default color   */
1154 #endif
1155
1156         /* system-dependent mouse data */
1157 #if USE_GPM_SUPPORT
1158         bool            _mouse_gpm_loaded;
1159         bool            _mouse_gpm_found;
1160 #ifdef HAVE_LIBDL
1161         void            *_dlopen_gpm;
1162         TYPE_gpm_fd     _mouse_gpm_fd;
1163         TYPE_Gpm_Open   _mouse_Gpm_Open;
1164         TYPE_Gpm_Close  _mouse_Gpm_Close;
1165         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
1166 #endif
1167         Gpm_Connect     _mouse_gpm_connect;
1168 #endif /* USE_GPM_SUPPORT */
1169
1170 #if USE_EMX_MOUSE
1171         int             _emxmouse_wfd;
1172         int             _emxmouse_thread;
1173         int             _emxmouse_activated;
1174         char            _emxmouse_buttons[4];
1175 #endif
1176
1177 #if USE_SYSMOUSE
1178         MEVENT          _sysmouse_fifo[FIFO_SIZE];
1179         int             _sysmouse_head;
1180         int             _sysmouse_tail;
1181         int             _sysmouse_char_width;   /* character width */
1182         int             _sysmouse_char_height;  /* character height */
1183         int             _sysmouse_old_buttons;
1184         int             _sysmouse_new_buttons;
1185 #endif
1186
1187 #if defined(USE_TERM_DRIVER) || defined(EXP_WIN32_DRIVER)
1188         MEVENT          _drv_mouse_fifo[FIFO_SIZE];
1189         int             _drv_mouse_head;
1190         int             _drv_mouse_tail;
1191         int             _drv_mouse_old_buttons;
1192         int             _drv_mouse_new_buttons;
1193 #endif
1194         /*
1195          * This supports automatic resizing
1196          */
1197 #if USE_SIZECHANGE
1198         int             (*_resize)(NCURSES_SP_DCLx int y, int x);
1199         int             (*_ungetch)(SCREEN *, int);
1200 #endif
1201
1202 #ifdef USE_SP_WINDOWLIST
1203         WINDOWLIST*     _windowlist;
1204 #define WindowList(sp)  (sp)->_windowlist
1205 #endif
1206
1207 #if USE_REENTRANT
1208         char            _ttytype[NAMESIZE];
1209         int             _ESCDELAY;
1210         int             _TABSIZE;
1211         int             _LINES;
1212         int             _COLS;
1213 #endif
1214
1215 #if NCURSES_SP_FUNCS
1216         bool            use_tioctl;
1217 #endif
1218
1219         /*
1220          * ncurses/ncursesw are the same up to this point.
1221          */
1222 #if USE_WIDEC_SUPPORT
1223         /* recent versions of 'screen' have partially-working support for
1224          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
1225          */
1226         bool            _screen_acs_fix;
1227         bool            _screen_unicode;
1228 #endif
1229
1230 #if NCURSES_EXT_FUNCS && NCURSES_EXT_COLORS
1231         void            *_ordered_pairs; /* index used by alloc_pair()       */
1232         int             _pairs_used;    /* actual number of color-pairs used */
1233         int             _recent_pair;   /* number for most recent free-pair  */
1234 #endif
1235
1236 #ifdef TRACE
1237         char            tracechr_buf[40];
1238         char            tracemse_buf[TRACEMSE_MAX];
1239 #if USE_REENTRANT
1240         long            _outchars;
1241         const char      *_tputs_trace;
1242 #endif
1243 #endif
1244 #undef SCREEN
1245 } SCREEN;
1246
1247 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
1248 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
1249
1250         WINDOWLIST {
1251         WINDOWLIST *next;
1252         SCREEN *screen;         /* screen containing the window */
1253         WINDOW  win;            /* WINDOW_EXT() needs to account for offset */
1254 #if NCURSES_WIDECHAR
1255         char addch_work[(MB_LEN_MAX * 9) + 1];
1256         unsigned addch_used;    /* number of bytes in addch_work[] */
1257         int addch_x;            /* x-position for addch_work[] */
1258         int addch_y;            /* y-position for addch_work[] */
1259 #endif
1260 };
1261
1262 #define WINDOW_EXT(w,m) (((WINDOWLIST *)((void *)((char *)(w) - offsetof(WINDOWLIST, win))))->m)
1263
1264 #ifdef USE_SP_WINDOWLIST
1265 #define SP_INIT_WINDOWLIST(sp)  WindowList(sp) = 0
1266 #else
1267 #define SP_INIT_WINDOWLIST(sp)  /* nothing */
1268 #endif
1269
1270 #define SP_PRE_INIT(sp)                         \
1271     sp->_cursrow           = -1;                \
1272     sp->_curscol           = -1;                \
1273     IsNl(sp)               = TRUE;              \
1274     IsRaw(sp)              = FALSE;             \
1275     IsCbreak(sp)           = 0;                 \
1276     IsEcho(sp)             = TRUE;              \
1277     sp->_fifohead          = -1;                \
1278     sp->_endwin            = ewSuspend;         \
1279     sp->_cursor            = -1;                \
1280     SP_INIT_WINDOWLIST(sp);                     \
1281     sp->_outch             = NCURSES_OUTC_FUNC; \
1282     sp->jump               = 0                  \
1283
1284 /* usually in <limits.h> */
1285 #ifndef UCHAR_MAX
1286 #define UCHAR_MAX 255
1287 #endif
1288
1289 /* The terminfo source is assumed to be 7-bit ASCII */
1290 #define is7bits(c)      ((unsigned)(c) < 128)
1291
1292 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
1293 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
1294
1295 #ifndef min
1296 #define min(a,b)        ((a) > (b)  ?  (b)  :  (a))
1297 #endif
1298
1299 #ifndef max
1300 #define max(a,b)        ((a) < (b)  ?  (b)  :  (a))
1301 #endif
1302
1303 /* usually in <unistd.h> */
1304 #ifndef STDIN_FILENO
1305 #define STDIN_FILENO 0
1306 #endif
1307
1308 #ifndef STDOUT_FILENO
1309 #define STDOUT_FILENO 1
1310 #endif
1311
1312 #ifndef STDERR_FILENO
1313 #define STDERR_FILENO 2
1314 #endif
1315
1316 #ifndef EXIT_SUCCESS
1317 #define EXIT_SUCCESS 0
1318 #endif
1319
1320 #ifndef EXIT_FAILURE
1321 #define EXIT_FAILURE 1
1322 #endif
1323
1324 #ifndef R_OK
1325 #define R_OK    4               /* Test for read permission.  */
1326 #endif
1327 #ifndef W_OK
1328 #define W_OK    2               /* Test for write permission.  */
1329 #endif
1330 #ifndef X_OK
1331 #define X_OK    1               /* Test for execute permission.  */
1332 #endif
1333 #ifndef F_OK
1334 #define F_OK    0               /* Test for existence.  */
1335 #endif
1336
1337 #if HAVE_FCNTL_H
1338 #include <fcntl.h>              /* may define O_BINARY  */
1339 #endif
1340
1341 #ifndef O_BINARY
1342 #define O_BINARY 0
1343 #endif
1344
1345 #ifdef TRACE
1346 #if USE_REENTRANT
1347 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
1348 #else
1349 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
1350 #endif
1351 #else
1352 #define COUNT_OUTCHARS(n) /* nothing */
1353 #endif
1354
1355 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
1356
1357 #define UChar(c)        ((unsigned char)(c))
1358 #define UShort(c)       ((unsigned short)(c))
1359 #define ChCharOf(c)     ((chtype)(c) & (chtype)A_CHARTEXT)
1360 #define ChAttrOf(c)     ((chtype)(c) & (chtype)A_ATTRIBUTES)
1361
1362 #define TR_PUTC(c)      TR(TRACE_CHARPUT, ("PUTC %#x", UChar(c)))
1363
1364 #ifndef MB_LEN_MAX
1365 #define MB_LEN_MAX 16   /* should be >= MB_CUR_MAX, but that may be a function */
1366 #endif
1367
1368 #if USE_WIDEC_SUPPORT /* { */
1369 /* true if the status/errno indicate an illegal multibyte sequence */
1370 #define isEILSEQ(status) (((size_t)status == (size_t)-1) && (errno == EILSEQ))
1371
1372 #define init_mb(state)  memset(&(state), 0, sizeof(state))
1373
1374 #if NCURSES_EXT_COLORS
1375 #define NulColor        , 0
1376 #else
1377 #define NulColor        /* nothing */
1378 #endif
1379
1380 #define NulChar         0,0,0,0 /* FIXME: see CCHARW_MAX */
1381 #define CharOf(c)       ((c).chars[0])
1382 #define AttrOf(c)       ((c).attr)
1383
1384 #define AddAttr(c,a)    AttrOf(c) |=  ((a) & A_ATTRIBUTES)
1385 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
1386 #define SetAttr(c,a)    AttrOf(c) =   ((a) & A_ATTRIBUTES) | WidecExt(c)
1387
1388 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
1389 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
1390
1391 #if CCHARW_MAX == 5
1392 #define CharEq(a,b)     (((a).attr == (b).attr) \
1393                        && (a).chars[0] == (b).chars[0] \
1394                        && (a).chars[1] == (b).chars[1] \
1395                        && (a).chars[2] == (b).chars[2] \
1396                        && (a).chars[3] == (b).chars[3] \
1397                        && (a).chars[4] == (b).chars[4] \
1398                         if_EXT_COLORS(&& (a).ext_color == (b).ext_color))
1399 #elif CCHARW_MAX > 0
1400 #error Inconsistent values for CCHARW_MAX
1401 #else
1402 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
1403 #endif
1404
1405 #define SetChar(ch,c,a) do {                                                        \
1406                             NCURSES_CH_T *_cp = &(ch);                              \
1407                             memset(_cp, 0, sizeof(ch));                             \
1408                             _cp->chars[0] = (wchar_t) (c);                          \
1409                             _cp->attr = (a);                                        \
1410                             if_EXT_COLORS(SetPair(ch, PairNumber(a)));              \
1411                         } while (0)
1412 #define CHREF(wch)      (&(wch))
1413 #define CHDEREF(wch)    (*(wch))
1414 #define ARG_CH_T        NCURSES_CH_T *
1415 #define CARG_CH_T       const NCURSES_CH_T *
1416 #define PUTC_DATA       char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
1417                         mbstate_t PUT_st; wchar_t PUTC_ch
1418 #define PUTC_INIT       init_mb (PUT_st)
1419 #define PUTC(ch)        do { if(!isWidecExt(ch)) {                                  \
1420                         if (Charable(ch)) {                                         \
1421                             TR_PUTC(CharOf(ch));                                    \
1422                             NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch));         \
1423                             COUNT_OUTCHARS(1);                                      \
1424                         } else {                                                    \
1425                             for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {       \
1426                                 PUTC_ch = (ch).chars[PUTC_i];                       \
1427                                 if (PUTC_ch == L'\0')                               \
1428                                     break;                                          \
1429                                 PUTC_INIT;                                          \
1430                                 PUTC_n = (int) wcrtomb(PUTC_buf,                    \
1431                                                        (ch).chars[PUTC_i], &PUT_st); \
1432                                 if (PUTC_n <= 0) {                                  \
1433                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) { \
1434                                         TR_PUTC(CharOf(ch));                        \
1435                                         NCURSES_OUTC_FUNC (NCURSES_SP_ARGx CharOf(ch)); \
1436                                     }                                               \
1437                                     break;                                          \
1438                                 } else {                                            \
1439                                     int PUTC_j;                                     \
1440                                     for (PUTC_j = 0; PUTC_j < PUTC_n; ++PUTC_j) {   \
1441                                         TR_PUTC(PUTC_buf[PUTC_j]);                  \
1442                                         NCURSES_OUTC_FUNC (NCURSES_SP_ARGx PUTC_buf[PUTC_j]); \
1443                                     }                                               \
1444                                 }                                                   \
1445                             }                                                       \
1446                             COUNT_OUTCHARS(PUTC_i);                                 \
1447                         } } } while (0)
1448
1449 #define BLANK           NewChar2(' ', WA_NORMAL)
1450 #define ZEROS           NewChar2('\0', WA_NORMAL)
1451 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
1452
1453         /*
1454          * Wide characters cannot be represented in the A_CHARTEXT mask of
1455          * attr_t's but an application might have set a narrow character there.
1456          * But even in that case, it would only be a printable character, or
1457          * zero.  Otherwise we can use those bits to tell if a cell is the
1458          * first or extension part of a wide character.
1459          */
1460 #define WidecExt(ch)    (int) (AttrOf(ch) & A_CHARTEXT)
1461 #define isWidecBase(ch) (WidecExt(ch) == 1)
1462 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
1463 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
1464                                 AttrOf(dst) |= (attr_t) (ext + 1)
1465
1466 #define if_WIDEC(code)  code
1467 #define Charable(ch)    (((SP_PARM->_legacy_coding)                     \
1468                          || (AttrOf(ch) & A_ALTCHARSET)                 \
1469                          || (!isWidecExt(ch))) &&                       \
1470                              (ch).chars[1] == L'\0' &&                  \
1471                              _nc_is_charable(CharOf(ch)))
1472
1473 #define L(ch)           L ## ch
1474 #else /* }{ */
1475 #define CharOf(c)       ChCharOf(c)
1476 #define AttrOf(c)       ChAttrOf(c)
1477 #define AddAttr(c,a)    c |= (a)
1478 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
1479 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
1480 #define NewChar(ch)     (ch)
1481 #define NewChar2(c,a)   ((c) | (a))
1482 #define CharEq(a,b)     ((a) == (b))
1483 #define SetChar(ch,c,a) ch = (c) | (a)
1484 #define CHREF(wch)      wch
1485 #define CHDEREF(wch)    wch
1486 #define ARG_CH_T        NCURSES_CH_T
1487 #define CARG_CH_T       NCURSES_CH_T
1488 #define PUTC_DATA       /* nothing */
1489 #define PUTC(ch)        { \
1490                             TR_PUTC(ch); \
1491                             NCURSES_OUTC_FUNC (NCURSES_SP_ARGx (int) ch); \
1492                         }
1493
1494 #define BLANK           (' '|A_NORMAL)
1495 #define ZEROS           ('\0'|A_NORMAL)
1496 #define ISBLANK(ch)     (CharOf(ch) == ' ')
1497
1498 #define isWidecExt(ch)  (0)
1499 #define if_WIDEC(code) /* nothing */
1500
1501 #define Charable(ch)    (CharOf(ch) >= ' ' && CharOf(ch) <= '~')
1502 #define L(ch)           ch
1503 #endif /* } */
1504
1505 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
1506 #define CharOfD(ch)     CharOf(CHDEREF(ch))
1507 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1508
1509 #define BLANK_ATTR      A_NORMAL
1510 #define BLANK_TEXT      L(' ')
1511
1512 #define CHANGED     -1
1513
1514 #define LEGALYX(w, y, x) \
1515               ((w) != 0 && \
1516                 ((x) >= 0 && (x) <= (w)->_maxx && \
1517                  (y) >= 0 && (y) <= (w)->_maxy))
1518
1519 #define CHANGED_CELL(line,col) \
1520         if (line->firstchar == _NOCHANGE) \
1521                 line->firstchar = line->lastchar = (NCURSES_SIZE_T) (col); \
1522         else if ((col) < line->firstchar) \
1523                 line->firstchar = (NCURSES_SIZE_T) (col); \
1524         else if ((col) > line->lastchar) \
1525                 line->lastchar = (NCURSES_SIZE_T) (col)
1526
1527 #define CHANGED_RANGE(line,start,end) \
1528         if (line->firstchar == _NOCHANGE \
1529          || line->firstchar > (start)) \
1530                 line->firstchar = (NCURSES_SIZE_T) (start); \
1531         if (line->lastchar == _NOCHANGE \
1532          || line->lastchar < (end)) \
1533                 line->lastchar = (NCURSES_SIZE_T) (end)
1534
1535 #define CHANGED_TO_EOL(line,start,end) \
1536         if (line->firstchar == _NOCHANGE \
1537          || line->firstchar > (start)) \
1538                 line->firstchar = (NCURSES_SIZE_T) (start); \
1539         line->lastchar = (NCURSES_SIZE_T) (end)
1540
1541 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1542
1543 #include <nc_alloc.h>
1544 #include <nc_access.h>
1545
1546 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
1547
1548 /* FreeAndNull() is not a comma-separated expression because some compilers
1549  * do not accept a mixture of void with values.
1550  */
1551 #define FreeAndNull(p)   do { free(p); p = 0; } while (0)
1552
1553 #ifdef EXP_OOM_TESTING
1554 extern NCURSES_EXPORT(void *)   _nc_oom_malloc(size_t size);
1555 extern NCURSES_EXPORT(void *)   _nc_oom_calloc(size_t nmemb, size_t size);
1556 extern NCURSES_EXPORT(void *)   _nc_oom_realloc(void *ptr, size_t size);
1557 extern NCURSES_EXPORT(void)     _nc_oom_free(void *ptr);
1558 extern NCURSES_EXPORT(char *)   _nc_oom_strdup(const char *ptr);
1559 #define malloc(size)            _nc_oom_malloc(size)
1560 #define calloc(nmemb, size)     _nc_oom_calloc(nmemb, size)
1561 #define realloc(ptr, size)      _nc_oom_realloc(ptr, size)
1562 #define free(ptr)               _nc_oom_free(ptr)
1563 #define strdup(ptr)             _nc_oom_strdup(ptr)
1564 #endif
1565
1566 /*
1567  * Use these for tic/infocmp malloc failures.  Generally the ncurses library
1568  * tries to limp along after a failure.
1569  */
1570 #define TYPE_MALLOC(type, size, name) \
1571         do { \
1572             name = typeMalloc(type, size); \
1573             if (name == 0) \
1574                 _nc_err_abort(MSG_NO_MEMORY); \
1575         } while (0)
1576
1577 #define TYPE_CALLOC(type, size, name) \
1578         do { \
1579             name = typeCalloc(type, size); \
1580             if (name == 0) \
1581                 _nc_err_abort(MSG_NO_MEMORY); \
1582         } while (0)
1583
1584 #define TYPE_REALLOC(type, size, name) \
1585         do { \
1586             name = typeRealloc(type, size, name); \
1587             if (name == 0) \
1588                 _nc_err_abort(MSG_NO_MEMORY); \
1589         } while (0)
1590
1591 /*
1592  * TTY bit definition for converting tabs to spaces.
1593  */
1594 #ifdef TAB3
1595 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
1596 #else
1597 # ifdef XTABS
1598 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
1599 # else
1600 #  ifdef OXTABS
1601 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
1602 #  else
1603 #   define OFLAGS_TABS 0
1604 #  endif
1605 # endif
1606 #endif
1607
1608 #ifdef __TANDEM
1609 #define ROOT_UID 65535
1610 #endif
1611
1612 #ifndef ROOT_UID
1613 #define ROOT_UID 0
1614 #endif
1615
1616 /*
1617  * Standardize/simplify common loops
1618  */
1619 #define each_screen(p) p = _nc_screen_chain; p != 0; p = (p)->_next_screen
1620 #define each_window(sp,p) p = WindowList(sp); p != 0; p = (p)->next
1621 #define each_ripoff(p) p = safe_ripoff_stack; (p - safe_ripoff_stack) < N_RIPS; ++p
1622
1623 /*
1624  * Prefixes for call/return points of library function traces.  We use these to
1625  * instrument the public functions so that the traces can be easily transformed
1626  * into regression scripts.
1627  */
1628 #define T_CALLED(fmt) "called {" fmt
1629 #define T_CREATE(fmt) "create :" fmt
1630 #define T_RETURN(fmt) "return }" fmt
1631
1632 #define NonNull(s)              ((s) != 0 ? s : "<null>")
1633 #define NonEmpty(s)             ((s) != 0 && *(s) != '\0')
1634
1635 #ifdef TRACE
1636
1637 #if USE_REENTRANT
1638 #define TPUTS_TRACE(s)  _nc_set_tputs_trace(s);
1639 #else
1640 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
1641 #endif
1642
1643 #ifdef HAVE_CONSISTENT_GETENV
1644 #define START_TRACE() \
1645         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1646             int t = _nc_getenv_num("NCURSES_TRACE"); \
1647             if (t >= 0) \
1648                 curses_trace((unsigned) t); \
1649         }
1650 #else
1651 #define START_TRACE() /* nothing */
1652 #endif
1653
1654 /*
1655  * Many of the _tracef() calls use static buffers; lock the trace state before
1656  * trying to fill them.
1657  */
1658 #if USE_REENTRANT
1659 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1660 extern NCURSES_EXPORT(int)      _nc_use_tracef (unsigned);
1661 extern NCURSES_EXPORT(void)     _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1662 #else
1663 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1664 #define _nc_locked_tracef _tracef
1665 #endif
1666
1667 #define TR(n, a)        if (USE_TRACEF(n)) _nc_locked_tracef a
1668 #define T(a)            TR(TRACE_CALLS, a)
1669 #define TRACE_RETURN(value,type)     return _nc_retrace_##type((type)(value))
1670 #define TRACE_RETURN1(value,dst)     return _nc_retrace_##dst(value)
1671 #define TRACE_RETURN2(value,dst,src) return _nc_retrace_##dst##_##src(value)
1672 #define TRACE_RETURN_SP(value,type)  return _nc_retrace_##type(SP_PARM, value)
1673
1674 typedef void VoidFunc(void);
1675
1676 #define TR_FUNC_LEN             ((sizeof(void *) + sizeof(void (*)(void))) * 2 + 4)
1677 #define TR_FUNC_BFR(max)        char tr_func_data[max][TR_FUNC_LEN]
1678 #define TR_FUNC_ARG(num,func)   _nc_fmt_funcptr(&tr_func_data[num][0], (const char *)&(func), sizeof((func)))
1679
1680 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
1681 #define returnBits(code)        TRACE_RETURN(code,unsigned)
1682 #define returnBool(code)        TRACE_RETURN(code,bool)
1683 #define returnCPtr(code)        TRACE_RETURN1(code,cptr)
1684 #define returnCVoidPtr(code)    TRACE_RETURN1(code,cvoid_ptr)
1685 #define returnChar(code)        TRACE_RETURN(code,char)
1686 #define returnChtype(code)      TRACE_RETURN(code,chtype)
1687 #define returnCode(code)        TRACE_RETURN(code,int)
1688 #define returnIntAttr(code)     TRACE_RETURN2(code,int,attr_t)
1689 #define returnMMask(code)       TRACE_RETURN_SP(code,mmask_t)
1690 #define returnPtr(code)         TRACE_RETURN1(code,ptr)
1691 #define returnSP(code)          TRACE_RETURN1(code,sp)
1692 #define returnVoid              { T((T_RETURN(""))); return; }
1693 #define returnVoidPtr(code)     TRACE_RETURN1(code,void_ptr)
1694 #define returnWin(code)         TRACE_RETURN1(code,win)
1695
1696 #define returnDB(rc)            do { TR(TRACE_DATABASE,(T_RETURN("code %d"), (rc))); return (rc); } while (0)
1697 #define returnPtrDB(rc)         do { TR(TRACE_DATABASE,(T_RETURN("%p"), (rc))); return (rc); } while (0)
1698 #define returnVoidDB            do { TR(TRACE_DATABASE,(T_RETURN(""))); return; } while (0)
1699
1700 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (int);
1701 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1702 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
1703 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
1704 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
1705 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
1706 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(const TTY *tty);
1707 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
1708 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
1709 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
1710 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
1711 extern NCURSES_EXPORT(char)             _nc_retrace_char (int);
1712 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
1713 extern NCURSES_EXPORT(int)              _nc_retrace_int_attr_t (attr_t);
1714 extern NCURSES_EXPORT(mmask_t)          _nc_retrace_mmask_t (SCREEN *, mmask_t);
1715 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
1716 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
1717 extern NCURSES_EXPORT(void)             _nc_fifo_dump (SCREEN *);
1718
1719 extern NCURSES_EXPORT(char *)           _nc_fmt_funcptr(char *, const char *, size_t);
1720
1721 #if USE_REENTRANT
1722 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1723 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1724 #define _nc_outchars       NCURSES_PUBLIC_VAR(_nc_outchars())
1725 #define _nc_tputs_trace    NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1726 extern NCURSES_EXPORT(void)             _nc_set_tputs_trace (const char *);
1727 extern NCURSES_EXPORT(void)             _nc_count_outchars (long);
1728 #else
1729 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1730 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
1731 #endif
1732
1733 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
1734
1735 extern NCURSES_EXPORT(char *) _nc_tracebits (void);
1736 extern NCURSES_EXPORT(char *) _tracemouse (const MEVENT *);
1737 extern NCURSES_EXPORT(void) _tracedump (const char *, WINDOW *);
1738
1739 #if USE_WIDEC_SUPPORT
1740 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1741 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1742 #endif
1743
1744 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1745 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1746
1747 #else /* !TRACE */
1748
1749 #define START_TRACE() /* nothing */
1750
1751 #define T(a)
1752 #define TR(n, a)
1753 #define TPUTS_TRACE(s)
1754 #define TR_FUNC_BFR(max)
1755
1756 #define returnAttr(code)        return code
1757 #define returnBits(code)        return code
1758 #define returnBool(code)        return code
1759 #define returnCPtr(code)        return code
1760 #define returnCVoidPtr(code)    return code
1761 #define returnChar(code)        return ((char) code)
1762 #define returnChtype(code)      return code
1763 #define returnCode(code)        return code
1764 #define returnIntAttr(code)     return code
1765 #define returnMMask(code)       return code
1766 #define returnPtr(code)         return code
1767 #define returnSP(code)          return code
1768 #define returnVoid              return
1769 #define returnVoidPtr(code)     return code
1770 #define returnWin(code)         return code
1771
1772 #define returnDB(code)          return code
1773 #define returnPtrDB(rc)         return rc
1774 #define returnVoidDB            return
1775
1776 #endif /* TRACE/!TRACE */
1777
1778 /*
1779  * Workaround for defective implementation of gcc attribute warn_unused_result
1780  */
1781 #if defined(__GNUC__) && defined(_FORTIFY_SOURCE)
1782 #define IGNORE_RC(func) errno = (int) func
1783 #else
1784 #define IGNORE_RC(func) (void) func
1785 #endif /* gcc workarounds */
1786
1787 /*
1788  * Return-codes for tgetent() and friends.
1789  */
1790 #define TGETENT_YES  1          /* entry is found */
1791 #define TGETENT_NO   0          /* entry is not found */
1792 #define TGETENT_ERR -1          /* an error occurred */
1793
1794 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1795 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1796
1797 #define EMPTY_MODULE(name) \
1798 extern  NCURSES_EXPORT(void) name (void); \
1799         NCURSES_EXPORT(void) name (void) { }
1800
1801 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1802 #define NONBLANK_ATTR (A_BOLD | A_DIM | A_BLINK | A_ITALIC)
1803 #define TPARM_ATTR    (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_ALTCHARSET | A_INVIS | A_PROTECT)
1804 #define XMC_CONFLICT  (A_STANDOUT | A_UNDERLINE | A_REVERSE | A_BLINK | A_DIM | A_BOLD | A_INVIS | A_PROTECT | A_ITALIC)
1805 #define XMC_CHANGES(c) ((c) & SP_PARM->_xmc_suppress)
1806
1807 #define toggle_attr_on(S,at) {\
1808    if (PairNumber(at) > 0) {\
1809       (S) = ((S) & ALL_BUT_COLOR) | (attr_t) (at);\
1810    } else {\
1811       (S) |= (attr_t) (at);\
1812    }\
1813    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1814
1815
1816 #define toggle_attr_off(S,at) {\
1817    if (PairNumber(at) > 0) {\
1818       (S) &= ~(at|A_COLOR);\
1819    } else {\
1820       (S) &= ~(at);\
1821    }\
1822    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1823
1824 #define DelCharCost(sp,count) \
1825                 ((parm_dch != 0) \
1826                 ? sp->_dch_cost \
1827                 : ((delete_character != 0) \
1828                         ? (sp->_dch1_cost * count) \
1829                         : INFINITY))
1830
1831 #define InsCharCost(sp,count) \
1832                 ((parm_ich != 0) \
1833                 ? sp->_ich_cost \
1834                 : ((enter_insert_mode && exit_insert_mode) \
1835                   ? sp->_smir_cost + sp->_rmir_cost + (sp->_ip_cost * count) \
1836                   : ((insert_character != 0) \
1837                     ? ((sp->_ich1_cost + sp->_ip_cost) * count) \
1838                     : INFINITY)))
1839
1840 #if USE_XMC_SUPPORT
1841 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1842                                 attr_t chg = AttrOf(SCREEN_ATTRS(sp)); \
1843                                 VIDPUTS(sp, AttrOf(c), GetPair(c)); \
1844                                 if (magic_cookie_glitch > 0 \
1845                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(sp))))) { \
1846                                         T(("%s @%d before glitch %d,%d", \
1847                                                 __FILE__, __LINE__, \
1848                                                 sp->_cursrow, \
1849                                                 sp->_curscol)); \
1850                                         NCURSES_SP_NAME(_nc_do_xmc_glitch)(NCURSES_SP_ARGx chg); \
1851                                 } \
1852                         }
1853 #else
1854 #define UpdateAttrs(sp,c) if (!SameAttrOf(SCREEN_ATTRS(sp), c)) { \
1855                                     VIDPUTS(sp, AttrOf(c), GetPair(c)); \
1856                         }
1857 #endif
1858
1859 /*
1860  * Macros to make additional parameter to implement wgetch_events()
1861  */
1862 #ifdef NCURSES_WGETCH_EVENTS
1863 #define EVENTLIST_0th(param) param
1864 #define EVENTLIST_1st(param) param
1865 #define EVENTLIST_2nd(param) , param
1866 #define TWAIT_MASK (TW_ANY | TW_EVENT)
1867 #else
1868 #define EVENTLIST_0th(param) void
1869 #define EVENTLIST_1st(param) /* nothing */
1870 #define EVENTLIST_2nd(param) /* nothing */
1871 #define TWAIT_MASK TW_ANY
1872 #endif
1873
1874 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1875
1876 #undef  toggle_attr_on
1877 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1878 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1879
1880 #undef  toggle_attr_off
1881 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1882 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1883
1884 #undef  DelCharCost
1885 #define DelCharCost(sp, count) NCURSES_SP_NAME(_nc_DelCharCost)(NCURSES_SP_ARGx count)
1886
1887 #undef  InsCharCost
1888 #define InsCharCost(sp, count) NCURSES_SP_NAME(_nc_InsCharCost)(NCURSES_SP_ARGx count)
1889
1890 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_DelCharCost) (NCURSES_SP_DCLx int _c);
1891 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(_nc_InsCharCost) (NCURSES_SP_DCLx int _c);
1892
1893 #undef  UpdateAttrs
1894 #define UpdateAttrs(sp,c) NCURSES_SP_NAME(_nc_UpdateAttrs)(NCURSES_SP_ARGx CHREF(c))
1895
1896 #if USE_WIDEC_SUPPORT || defined(NEED_NCURSES_CH_T)
1897 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx CARG_CH_T _c);
1898 #else
1899 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_UpdateAttrs) (NCURSES_SP_DCLx chtype c);
1900 #endif
1901
1902 #if NCURSES_SP_FUNCS
1903 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1904 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1905 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (CARG_CH_T);
1906 #endif /* NCURSES_SP_FUNCS */
1907
1908 #else
1909
1910 extern NCURSES_EXPORT(void) _nc_expanded (void);
1911
1912 #endif
1913
1914 #if !NCURSES_EXT_FUNCS
1915 #define set_escdelay(value) ESCDELAY = value
1916 #endif
1917
1918 #if !HAVE_GETCWD
1919 #define getcwd(buf,len) getwd(buf)
1920 #endif
1921
1922 #define save_ttytype(termp) \
1923         if (TerminalType(termp).term_names != 0) { \
1924             _nc_STRNCPY(ttytype, \
1925                         TerminalType(termp).term_names, \
1926                         NAMESIZE - 1); \
1927             ttytype[NAMESIZE - 1] = '\0'; \
1928         }
1929
1930 #if !NCURSES_WCWIDTH_GRAPHICS
1931 extern NCURSES_EXPORT(int) _nc_wacs_width(unsigned);
1932 #else
1933 #define _nc_wacs_width(ch) wcwidth(ch)
1934 #endif
1935
1936 /* charable.c */
1937 #if USE_WIDEC_SUPPORT
1938 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1939 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1940 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1941 #endif
1942
1943 /* comp_captab.c */
1944 typedef struct {
1945         short   nte_name;       /* offset of name to hash on */
1946         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
1947         short   nte_index;      /* index of associated variable in its array */
1948         short   nte_link;       /* index in table of next hash, or -1 */
1949 } name_table_data;
1950
1951 typedef struct
1952 {
1953         short   from;
1954         short   to;
1955         short   source;
1956 } alias_table_data;
1957
1958 /* comp_userdefs.c */
1959 typedef struct {
1960         short   ute_name;       /* offset of name to hash on */
1961         unsigned ute_type;      /* mask (BOOLEAN, NUMBER, STRING) */
1962         unsigned ute_argc;      /* number of parameters */
1963         unsigned ute_args;      /* bit-mask for string parameters */
1964         short   ute_index;      /* index of associated variable in its array */
1965         short   ute_link;       /* index in table of next hash, or -1 */
1966 } user_table_data;
1967
1968 /* doupdate.c */
1969 #if USE_XMC_SUPPORT
1970 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1971 #endif
1972
1973 /* hardscroll.c */
1974 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1975 extern NCURSES_EXPORT(void) _nc_linedump (void);
1976 #endif
1977
1978 /* lib_acs.c */
1979 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
1980 extern NCURSES_EXPORT(int)  _nc_msec_cost (const char *const, int);
1981
1982 /* lib_addch.c */
1983 #if USE_WIDEC_SUPPORT
1984 extern NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1985 #endif
1986
1987 /* lib_addstr.c */
1988 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
1989 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1990 #endif
1991
1992 /* lib_color.c */
1993 extern NCURSES_EXPORT(int) _nc_init_color(SCREEN *, int, int, int, int);
1994 extern NCURSES_EXPORT(int) _nc_init_pair(SCREEN *, int, int, int);
1995 extern NCURSES_EXPORT(int) _nc_pair_content(SCREEN *, int, int *, int *);
1996 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1997 extern NCURSES_EXPORT(void) _nc_reserve_pairs(SCREEN *, int);
1998 extern NCURSES_EXPORT(void) _nc_change_pair(SCREEN *, int);
1999
2000 #define ReservePairs(sp,want) \
2001             if ((sp->_color_pairs == 0) || (want >= sp->_pair_alloc)) \
2002                 _nc_reserve_pairs(sp, want)
2003
2004 /* lib_getch.c */
2005 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, int *, int EVENTLIST_2nd(_nc_eventlist *));
2006
2007 /* lib_insch.c */
2008 extern NCURSES_EXPORT(int) _nc_insert_ch(SCREEN *, WINDOW *, chtype);
2009
2010 /* lib_mvcur.c */
2011 #define INFINITY        1000000 /* cost: too high to use */
2012
2013 extern NCURSES_EXPORT(int) _nc_mvcur(int yold, int xold, int ynew, int xnew);
2014
2015 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
2016 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
2017 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
2018
2019 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
2020
2021 extern NCURSES_EXPORT(void) _nc_screen_init (void);
2022 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
2023 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
2024
2025 /* lib_mouse.c */
2026 extern NCURSES_EXPORT(bool) _nc_has_mouse (SCREEN *);
2027
2028 /* lib_mvcur.c */
2029 #define INFINITY        1000000 /* cost: too high to use */
2030 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
2031
2032 /* lib_setup.c */
2033 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
2034 extern NCURSES_EXPORT(int)    _nc_unicode_locale(void);
2035 extern NCURSES_EXPORT(int)    _nc_locale_breaks_acs(TERMINAL *);
2036 extern NCURSES_EXPORT(int)    _nc_setupterm(const char *, int, int *, int);
2037 extern NCURSES_EXPORT(void)   _nc_tinfo_cmdch(TERMINAL *, int);
2038
2039 #ifdef USE_PTHREADS
2040 extern NCURSES_EXPORT(SCREEN *) _nc_find_prescr(void);
2041 extern NCURSES_EXPORT(void)   _nc_forget_prescr(void);
2042 #else
2043 #define _nc_find_prescr()     _nc_prescreen.allocated
2044 #define _nc_forget_prescr()   _nc_prescreen.allocated = 0
2045 #endif
2046
2047 /* lib_set_term.c */
2048 extern NCURSES_EXPORT(int)    _nc_ripoffline(int, int(*)(WINDOW*, int));
2049
2050 /* lib_setup.c */
2051 #define ExitTerminfo(code)    exit_terminfo(code)
2052
2053 #define SETUP_FAIL ERR
2054
2055 #define ret_error(rc, fmt, p, q)        if (errret) {\
2056                                             *errret = rc;\
2057                                             q;\
2058                                             returnCode(SETUP_FAIL);\
2059                                         } else {\
2060                                             fprintf(stderr, fmt, p);\
2061                                             q;\
2062                                             ExitTerminfo(EXIT_FAILURE);\
2063                                         }
2064
2065 #define ret_error1(rc, fmt, p, q)       ret_error(rc, "'%s': " fmt, p, q)
2066
2067 #define ret_error0(rc, msg)             if (errret) {\
2068                                             *errret = rc;\
2069                                             returnCode(SETUP_FAIL);\
2070                                         } else {\
2071                                             fprintf(stderr, msg);\
2072                                             ExitTerminfo(EXIT_FAILURE);\
2073                                         }
2074
2075 /* lib_tstp.c */
2076 #if USE_SIGWINCH
2077 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(SCREEN *);
2078 #else
2079 #define _nc_handle_sigwinch(a) /* nothing */
2080 #endif
2081
2082 /* lib_wacs.c */
2083 #if USE_WIDEC_SUPPORT
2084 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
2085 #endif
2086
2087 typedef struct {
2088     char *s_head;       /* beginning of the string (may be null) */
2089     char *s_tail;       /* end of the string (may be null) */
2090     size_t s_size;      /* current remaining size available */
2091     size_t s_init;      /* total size available */
2092 } string_desc;
2093
2094 /* strings.c */
2095 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
2096 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
2097 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, const string_desc *);
2098 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
2099 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
2100
2101 #if !HAVE_STRSTR
2102 #define strstr _nc_strstr
2103 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
2104 #endif
2105
2106 /* safe_sprintf.c */
2107 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
2108
2109 /* tries.c */
2110 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
2111 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
2112 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
2113 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
2114
2115 /* elsewhere ... */
2116 extern NCURSES_EXPORT(SCREEN *) _nc_screen_of (WINDOW *);
2117 extern NCURSES_EXPORT(TERMINAL*) _nc_get_cur_term (void);
2118 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
2119 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
2120 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
2121 extern NCURSES_EXPORT(char *) _nc_tracechar (SCREEN *, int);
2122 extern NCURSES_EXPORT(char *) _nc_tracemouse (SCREEN *, MEVENT const *);
2123 extern NCURSES_EXPORT(char *) _nc_trace_mmask_t (SCREEN *, mmask_t);
2124 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
2125 extern NCURSES_EXPORT(int) _nc_baudrate (int);
2126 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
2127 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
2128 extern NCURSES_EXPORT(int) _nc_keypad (SCREEN *, int);
2129 extern NCURSES_EXPORT(int) _nc_ospeed (int);
2130 extern NCURSES_EXPORT(int) _nc_outch (int);
2131 extern NCURSES_EXPORT(int) _nc_putchar (int);
2132 extern NCURSES_EXPORT(int) _nc_putp(const char *, const char *);
2133 extern NCURSES_EXPORT(int) _nc_putp_flush(const char *, const char *);
2134 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE2 *const);
2135 extern NCURSES_EXPORT(int) _nc_setup_tinfo(const char *, TERMTYPE2 *);
2136 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, int, int);
2137 extern NCURSES_EXPORT(int) _nc_timed_wait (SCREEN *, int, int, int * EVENTLIST_2nd(_nc_eventlist *));
2138 extern NCURSES_EXPORT(int) _nc_trans_string (char *, const char *);
2139 extern NCURSES_EXPORT(void) _nc_init_termtype (TERMTYPE2 *const);
2140 extern NCURSES_EXPORT(void) _nc_do_color (int, int, int, NCURSES_OUTC);
2141 extern NCURSES_EXPORT(void) _nc_flush (void);
2142 extern NCURSES_EXPORT(void) _nc_free_entry (ENTRY *, TERMTYPE2 *);
2143 extern NCURSES_EXPORT(void) _nc_freeall (void);
2144 extern NCURSES_EXPORT(void) _nc_hash_map (void);
2145 extern NCURSES_EXPORT(void) _nc_init_keytry (SCREEN *);
2146 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
2147 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
2148 extern NCURSES_EXPORT(void) _nc_reset_input (FILE *, char *);
2149 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
2150 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
2151 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, int);
2152 extern NCURSES_EXPORT(void) _nc_setenv_num (const char *, int);
2153 extern NCURSES_EXPORT(void) _nc_signal_handler (int);
2154 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
2155 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
2156
2157 #if NCURSES_EXT_NUMBERS
2158 extern NCURSES_EXPORT(const TERMTYPE2 *) _nc_fallback2 (const char *);
2159 #else
2160 #define _nc_fallback2(tp) _nc_fallback(tp)
2161 #endif
2162
2163 extern NCURSES_EXPORT(void) _nc_copy_termtype(TERMTYPE *, const TERMTYPE *);
2164
2165 #if NCURSES_EXT_NUMBERS
2166 extern NCURSES_EXPORT(void) _nc_copy_termtype2 (TERMTYPE2 *, const TERMTYPE2 *);
2167 extern NCURSES_EXPORT(void) _nc_export_termtype2(TERMTYPE *, const TERMTYPE2 *);
2168 #else
2169 #define _nc_copy_termtype2(dst,src) _nc_copy_termtype((dst),(src))
2170 #define _nc_export_termtype2(dst,src) /* nothing */
2171 #define _nc_free_termtype2(t) _nc_free_termtype(t)
2172 /* also... */
2173 #define _nc_read_entry2 _nc_read_entry
2174 #endif
2175
2176 #if NO_LEAKS
2177 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
2178 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
2179 extern NCURSES_EXPORT(void) _nc_codes_leaks(void);
2180 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
2181 extern NCURSES_EXPORT(void) _nc_comp_error_leaks(void);
2182 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
2183 extern NCURSES_EXPORT(void) _nc_comp_userdefs_leaks(void);
2184 extern NCURSES_EXPORT(void) _nc_db_iterator_leaks(void);
2185 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
2186 extern NCURSES_EXPORT(void) _nc_names_leaks(void);
2187 extern NCURSES_EXPORT(void) _nc_tgetent_leak(const TERMINAL *);
2188 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
2189 #endif
2190
2191 #if !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2192 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
2193 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
2194 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, int const, int const, NCURSES_CH_T);
2195 #endif
2196
2197 #if USE_WIDEC_SUPPORT
2198 extern NCURSES_EXPORT(int) _nc_insert_wch(WINDOW *, const cchar_t *);
2199 #endif
2200
2201 #if USE_WIDEC_SUPPORT && !(defined(USE_TERMLIB) || defined(USE_BUILD_CC))
2202 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
2203 #endif
2204
2205 #if USE_SIZECHANGE
2206 extern NCURSES_EXPORT(void) _nc_update_screensize (SCREEN *);
2207 #endif
2208
2209 #if HAVE_RESIZETERM
2210 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
2211 #else
2212 #define _nc_resize_margins(wp) /* nothing */
2213 #endif
2214
2215 #ifdef NCURSES_WGETCH_EVENTS
2216 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
2217 #else
2218 #define wgetch_events(win, evl) wgetch(win)
2219 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
2220 #endif
2221
2222 /*
2223  * Wide-character macros to hide some platform-differences.
2224  */
2225 #if USE_WIDEC_SUPPORT
2226
2227 #if defined(_NC_WINDOWS) && !defined(_NC_MSC) && !defined(EXP_WIN32_DRIVER)
2228 /*
2229  * MinGW has wide-character functions, but they do not work correctly.
2230  */
2231 extern int __MINGW_NOTHROW _nc_wctomb(char *, wchar_t);
2232 #define wctomb(s,wc) _nc_wctomb(s,wc)
2233 #define wcrtomb(s,wc,n) _nc_wctomb(s,wc)
2234
2235 extern int __MINGW_NOTHROW _nc_mbtowc(wchar_t *, const char *, size_t);
2236 #define mbtowc(pwc,s,n) _nc_mbtowc(pwc,s,n)
2237
2238 extern int __MINGW_NOTHROW _nc_mblen(const char *, size_t);
2239 #define mblen(s,n) _nc_mblen(s, n)
2240
2241 #endif /* _NC_WINDOWS && !_NC_MSC */
2242
2243 #if defined(_NC_WINDOWS) || defined(_NC_MINGW)
2244 /* see wcwidth.c */
2245 extern NCURSES_EXPORT(int) mk_wcwidth(wchar_t);
2246 #define wcwidth(ucs) _nc_wcwidth(ucs)
2247 #endif
2248
2249 #if HAVE_MBTOWC && HAVE_MBLEN
2250 #define reset_mbytes(state) IGNORE_RC(mblen(NULL, (size_t) 0)), IGNORE_RC(mbtowc(NULL, NULL, (size_t) 0))
2251 #define count_mbytes(buffer,length,state) mblen(buffer,length)
2252 #define check_mbytes(wch,buffer,length,state) \
2253         (int) mbtowc(&(wch), buffer, length)
2254 #define state_unused
2255 #elif HAVE_MBRTOWC && HAVE_MBRLEN
2256 #define reset_mbytes(state) init_mb(state)
2257 #define count_mbytes(buffer,length,state) mbrlen(buffer,length,&(state))
2258 #define check_mbytes(wch,buffer,length,state) \
2259         (int) mbrtowc(&(wch), buffer, length, &(state))
2260 #else
2261 make an error
2262 #endif
2263
2264 #endif /* USE_WIDEC_SUPPORT */
2265
2266 /*
2267  * Not everyone has vsscanf(), but we'd like to use it for scanw().
2268  */
2269 #if !HAVE_VSSCANF
2270 extern int vsscanf(const char *str, const char *format, va_list __arg);
2271 #endif
2272
2273 /* scroll indices */
2274 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
2275
2276 #define USE_SETBUF_0 0
2277
2278 #define NC_OUTPUT(sp) ((sp != 0 && sp->_ofp != 0) ? sp->_ofp : stdout)
2279
2280 /*
2281  * On systems with a broken linker, define 'SP' as a function to force the
2282  * linker to pull in the data-only module with 'SP'.
2283  */
2284 #define _nc_alloc_screen_sp() typeCalloc(SCREEN, 1)
2285
2286 #if BROKEN_LINKER
2287 #define SP _nc_screen()
2288 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
2289 extern NCURSES_EXPORT(int)      _nc_alloc_screen (void);
2290 extern NCURSES_EXPORT(void)     _nc_set_screen (SCREEN *);
2291 #define CURRENT_SCREEN          _nc_screen()
2292 #else
2293 /* current screen is private data; avoid possible linking conflicts too */
2294 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
2295 #define CURRENT_SCREEN SP
2296 #define _nc_alloc_screen()      ((SP = _nc_alloc_screen_sp()) != 0)
2297 #define _nc_set_screen(sp)      SP = sp
2298 #endif
2299
2300 #if NCURSES_SP_FUNCS
2301 #define CURRENT_SCREEN_PRE      (IsPreScreen(CURRENT_SCREEN) ? CURRENT_SCREEN : new_prescr())
2302 #else
2303 #define CURRENT_SCREEN_PRE      CURRENT_SCREEN
2304 #endif
2305
2306 /*
2307  * We don't want to use the lines or columns capabilities internally, because
2308  * if the application is running multiple screens under X, it is quite possible
2309  * they could all have type xterm but have different sizes!  So...
2310  */
2311 #define screen_lines(sp)        (sp)->_lines
2312 #define screen_columns(sp)      (sp)->_columns
2313
2314 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
2315 extern NCURSES_EXPORT(int) _nc_format_slks (NCURSES_SP_DCLx int _c);
2316
2317 /*
2318  * Some constants related to SLK's
2319  */
2320 #define MAX_SKEY_OLD       8    /* count of soft keys */
2321 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
2322 #define MAX_SKEY_PC       12    /* This is what most PC's have */
2323 #define MAX_SKEY_LEN_PC    5
2324
2325 /* Macro to check whether or not we use a standard format */
2326 #define SLK_STDFMT(fmt) (fmt < 3)
2327 /* Macro to determine height of label window */
2328 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
2329
2330 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
2331 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
2332
2333 /*
2334  * Common error messages
2335  */
2336 #define MSG_NO_MEMORY "Out of memory"
2337 #define MSG_NO_INPUTS "Premature EOF"
2338
2339 extern NCURSES_EXPORT(int) _nc_set_tty_mode(TTY *);
2340 extern NCURSES_EXPORT(int) _nc_get_tty_mode(TTY *);
2341
2342 /* timed_wait flag definitions */
2343 #define TW_NONE    0
2344 #define TW_INPUT   1
2345 #define TW_MOUSE   2
2346 #define TW_ANY     (TW_INPUT | TW_MOUSE)
2347 #define TW_EVENT   4
2348
2349 #define SetSafeOutcWrapper(outc)            \
2350     SCREEN* sp = CURRENT_SCREEN;            \
2351     struct screen outc_wrapper;             \
2352     if (sp==0) {                            \
2353         sp = &outc_wrapper;                 \
2354         memset(sp,0,sizeof(struct screen)); \
2355         sp->_outch = _nc_outc_wrapper;      \
2356     }\
2357     sp->jump = outc
2358
2359 #ifdef USE_TERM_DRIVER
2360
2361 typedef struct _termInfo
2362 {
2363     bool caninit;
2364
2365     bool hascolor;
2366     bool initcolor;
2367     bool canchange;
2368
2369     int  tabsize;
2370
2371     int  maxcolors;
2372     int  maxpairs;
2373     int  nocolorvideo;
2374
2375     int  numbuttons;
2376     int  numlabels;
2377     int  labelwidth;
2378     int  labelheight;
2379
2380     const color_t* defaultPalette;
2381 } TerminalInfo;
2382
2383 typedef struct term_driver {
2384     bool   isTerminfo;
2385     const char* (*td_name)(struct DriverTCB*);
2386     bool   (*td_CanHandle)(struct DriverTCB*, const char*, int*);
2387     void   (*td_init)(struct DriverTCB*);
2388     void   (*td_release)(struct DriverTCB*);
2389     int    (*td_size)(struct DriverTCB*, int* Line, int *Cols);
2390     int    (*td_sgmode)(struct DriverTCB*, int setFlag, TTY*);
2391     chtype (*td_conattr)(struct DriverTCB*);
2392     int    (*td_hwcur)(struct DriverTCB*, int yold, int xold, int y, int x);
2393     int    (*td_mode)(struct DriverTCB*, int progFlag, int defFlag);
2394     bool   (*td_rescol)(struct DriverTCB*);
2395     bool   (*td_rescolors)(struct DriverTCB*);
2396     void   (*td_color)(struct DriverTCB*, int fore, int color, int(*)(SCREEN*, int));
2397     int    (*td_doBeepOrFlash)(struct DriverTCB*, int);
2398     void   (*td_initpair)(struct DriverTCB*, int, int, int);
2399     void   (*td_initcolor)(struct DriverTCB*, int, int, int, int);
2400     void   (*td_docolor)(struct DriverTCB*, int, int, int, int(*)(SCREEN*, int));
2401     void   (*td_initmouse)(struct DriverTCB*);
2402     int    (*td_testmouse)(struct DriverTCB*, int EVENTLIST_2nd(_nc_eventlist*));
2403     void   (*td_setfilter)(struct DriverTCB*);
2404     void   (*td_hwlabel)(struct DriverTCB*, int, char*);
2405     void   (*td_hwlabelOnOff)(struct DriverTCB*, int);
2406     int    (*td_update)(struct DriverTCB*);
2407     int    (*td_defaultcolors)(struct DriverTCB*, int, int);
2408     int    (*td_print)(struct DriverTCB*, char*, int);
2409     int    (*td_getsize)(struct DriverTCB*, int*, int*);
2410     int    (*td_setsize)(struct DriverTCB*, int, int);
2411     void   (*td_initacs)(struct DriverTCB*, chtype*, chtype*);
2412     void   (*td_scinit)(SCREEN *);
2413     void   (*td_scexit)(SCREEN *);
2414     int    (*td_twait)(struct DriverTCB*, int, int, int* EVENTLIST_2nd(_nc_eventlist*));
2415     int    (*td_read)(struct DriverTCB*, int*);
2416     int    (*td_nap)(struct DriverTCB*, int);
2417     int    (*td_kpad)(struct DriverTCB*, int);
2418     int    (*td_kyOk)(struct DriverTCB*, int, int);
2419     bool   (*td_kyExist)(struct DriverTCB*, int);
2420     int    (*td_cursorSet)(struct DriverTCB*, int);
2421 } TERM_DRIVER;
2422
2423 typedef struct DriverTCB
2424 {
2425     TERMINAL      term;   /* needs to be the first Element !!! */
2426     TERM_DRIVER*  drv;    /* The driver for that Terminal */
2427     SCREEN*       csp;    /* The screen that owns that Terminal */
2428     TerminalInfo  info;   /* Driver independent core capabilities of the Terminal */
2429     void*         prop;   /* Driver dependent property storage to be used by the Driver */
2430     long          magic;
2431 } TERMINAL_CONTROL_BLOCK;
2432
2433 #define NCDRV_MAGIC(id) (0x47110000 | (id&0xffff))
2434 #define NCDRV_TINFO      0x01
2435 #define NCDRV_WINCONSOLE 0x02
2436
2437 #define TCBOf(sp)    ((TERMINAL_CONTROL_BLOCK*)(TerminalOf(sp)))
2438 #define InfoOf(sp)   TCBOf(sp)->info
2439 #define CallDriver(sp,method)                        TCBOf(sp)->drv->method(TCBOf(sp))
2440 #define CallDriver_1(sp,method,arg1)                 TCBOf(sp)->drv->method(TCBOf(sp),arg1)
2441 #define CallDriver_2(sp,method,arg1,arg2)            TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2)
2442 #define CallDriver_3(sp,method,arg1,arg2,arg3)       TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3)
2443 #define CallDriver_4(sp,method,arg1,arg2,arg3,arg4)  TCBOf(sp)->drv->method(TCBOf(sp),arg1,arg2,arg3,arg4)
2444
2445 extern NCURSES_EXPORT_VAR(const color_t*) _nc_cga_palette;
2446 extern NCURSES_EXPORT_VAR(const color_t*) _nc_hls_palette;
2447
2448 extern NCURSES_EXPORT(int)      _nc_get_driver(TERMINAL_CONTROL_BLOCK*, const char*, int*);
2449 extern NCURSES_EXPORT(void)     _nc_get_screensize_ex(SCREEN *, TERMINAL *, int *, int *);
2450 #endif /* USE_TERM_DRIVER */
2451
2452 /*
2453  * Entrypoints which are actually provided in the terminal driver, which would
2454  * be an sp-name otherwise.
2455  */
2456 #ifdef USE_TERM_DRIVER
2457 #define TINFO_HAS_KEY           _nc_tinfo_has_key
2458 #define TINFO_DOUPDATE          _nc_tinfo_doupdate
2459 #define TINFO_MVCUR             _nc_tinfo_mvcur
2460 extern NCURSES_EXPORT(int)      TINFO_HAS_KEY(SCREEN*, int);
2461 extern NCURSES_EXPORT(int)      TINFO_DOUPDATE(SCREEN *);
2462 extern NCURSES_EXPORT(int)      TINFO_MVCUR(SCREEN*, int, int, int, int);
2463 #else
2464 #define TINFO_HAS_KEY           NCURSES_SP_NAME(has_key)
2465 #define TINFO_DOUPDATE          NCURSES_SP_NAME(doupdate)
2466 #define TINFO_MVCUR             NCURSES_SP_NAME(_nc_mvcur)
2467 #endif
2468
2469 #if defined(EXP_WIN32_DRIVER)
2470 #include <nc_win32.h>
2471 #endif
2472
2473 /*
2474  * Entrypoints using an extra parameter with the terminal driver.
2475  */
2476 #ifdef USE_TERM_DRIVER
2477 extern NCURSES_EXPORT(void)   _nc_get_screensize(SCREEN *, TERMINAL *, int *, int *);
2478 extern NCURSES_EXPORT(int)    _nc_setupterm_ex(TERMINAL **, const char *, int , int *, int);
2479 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2480         _nc_get_screensize(sp, tp, lp, cp)
2481 #define TINFO_SET_CURTERM(sp, tp) \
2482         NCURSES_SP_NAME(set_curterm)(sp, tp)
2483 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2484         _nc_setupterm_ex(tpp, name, fd, err, reuse)
2485 #else /* !USE_TERM_DRIVER */
2486 extern NCURSES_EXPORT(void)   _nc_get_screensize(SCREEN *, int *, int *);
2487 #define TINFO_GET_SIZE(sp, tp, lp, cp) \
2488         _nc_get_screensize(sp, lp, cp)
2489 #define TINFO_SET_CURTERM(sp, tp) \
2490         set_curterm(tp)
2491 #define TINFO_SETUP_TERM(tpp, name, fd, err, reuse) \
2492         _nc_setupterm(name, fd, err, reuse)
2493 #endif /* !USE_TERM_DRIVER */
2494
2495 #ifdef EXP_WIN32_DRIVER
2496 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2497 #else
2498 #ifdef USE_TERM_DRIVER
2499 #if defined(USE_WIN32CON_DRIVER)
2500 #include <nc_mingw.h>
2501 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_WIN_DRIVER;
2502 extern NCURSES_EXPORT(int)  _nc_mingw_isatty(int fd);
2503 extern NCURSES_EXPORT(int)  _nc_mingw_isconsole(int fd);
2504 extern NCURSES_EXPORT(int) _nc_mingw_console_read(
2505     SCREEN *sp,
2506     HANDLE  fd,
2507     int *buf);
2508 extern NCURSES_EXPORT(int) _nc_mingw_testmouse(
2509     SCREEN * sp,
2510     HANDLE fd,
2511     int delay EVENTLIST_2nd(_nc_eventlist*));
2512 #else
2513 #endif
2514 extern NCURSES_EXPORT_VAR(TERM_DRIVER) _nc_TINFO_DRIVER;
2515 #endif /* USE_TERM_DRIVER */
2516 #endif /* EXP_WIN32_DRIVER */
2517
2518 #if defined(USE_TERM_DRIVER) && defined(EXP_WIN32_DRIVER)
2519 #define NC_ISATTY(fd) (0 != _nc_console_isatty(fd))
2520 #elif defined(USE_TERM_DRIVER) && defined(USE_WIN32CON_DRIVER)
2521 #define NC_ISATTY(fd) _nc_mingw_isatty(fd)
2522 #else
2523 #define NC_ISATTY(fd) isatty(fd)
2524 #endif
2525
2526 #ifdef USE_TERM_DRIVER
2527 #  define IsTermInfo(sp)       ((TCBOf(sp) != 0) && ((TCBOf(sp)->drv->isTerminfo)))
2528 #  define HasTInfoTerminal(sp) ((0 != TerminalOf(sp)) && IsTermInfo(sp))
2529 #  if defined(EXP_WIN32_DRIVER)
2530 #    define IsTermInfoOnConsole(sp) (IsTermInfo(sp) && _nc_console_test(TerminalOf(sp)->Filedes))
2531 #  elif defined(USE_WIN32CON_DRIVER)
2532 #    define IsTermInfoOnConsole(sp) (IsTermInfo(sp) && _nc_mingw_isconsole(TerminalOf(sp)->Filedes))
2533 #  else
2534 #    define IsTermInfoOnConsole(sp) FALSE
2535 #  endif
2536 #else
2537 #  define IsTermInfo(sp)       TRUE
2538 #  define HasTInfoTerminal(sp) (0 != TerminalOf(sp))
2539 #  if defined(EXP_WIN32_DRIVER)
2540 #    define IsTermInfoOnConsole(sp) _nc_console_test(TerminalOf(sp)->Filedes)
2541 #  else
2542 #    define IsTermInfoOnConsole(sp) FALSE
2543 #  endif
2544 #endif
2545
2546 #define IsValidTIScreen(sp)  (HasTInfoTerminal(sp))
2547
2548 /*
2549  * Exported entrypoints beyond the published API
2550  */
2551 #if NCURSES_SP_FUNCS
2552 extern NCURSES_EXPORT(WINDOW *) _nc_curscr_of(SCREEN*);
2553 extern NCURSES_EXPORT(WINDOW *) _nc_newscr_of(SCREEN*);
2554 extern NCURSES_EXPORT(WINDOW *) _nc_stdscr_of(SCREEN*);
2555 extern NCURSES_EXPORT(int)      _nc_outc_wrapper(SCREEN*,int);
2556
2557 #if USE_REENTRANT
2558 extern NCURSES_EXPORT(int)       NCURSES_SP_NAME(_nc_TABSIZE)(SCREEN*);
2559 extern NCURSES_EXPORT(char *)    NCURSES_SP_NAME(longname)(SCREEN*);
2560 #endif
2561
2562 #if NCURSES_EXT_FUNCS
2563 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_set_tabsize)(SCREEN*, int);
2564 #endif
2565
2566 /*
2567  * We put the safe versions of various calls here as they are not published
2568  * part of the API up to now
2569  */
2570 extern NCURSES_EXPORT(TERMINAL*) NCURSES_SP_NAME(_nc_get_cur_term) (SCREEN *sp);
2571 extern NCURSES_EXPORT(WINDOW *) NCURSES_SP_NAME(_nc_makenew) (SCREEN*, int, int, int, int, int);
2572 extern NCURSES_EXPORT(bool)     NCURSES_SP_NAME(_nc_reset_colors)(SCREEN*);
2573 extern NCURSES_EXPORT(char *)   NCURSES_SP_NAME(_nc_printf_string)(SCREEN*, const char *, va_list);
2574 extern NCURSES_EXPORT(chtype)   NCURSES_SP_NAME(_nc_acs_char)(SCREEN*,int);
2575 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_get_tty_mode)(SCREEN*,TTY*);
2576 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_mcprint)(SCREEN*,char*, int);
2577 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_msec_cost)(SCREEN*, const char *, int);
2578 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_mvcur)(SCREEN*, int, int, int, int);
2579 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_outch)(SCREEN*, int);
2580 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putchar)(SCREEN*, int);
2581 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putp)(SCREEN*, const char *, const char*);
2582 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_putp_flush)(SCREEN*, const char *, const char *);
2583 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_ripoffline)(SCREEN*, int, int (*)(WINDOW *,int));
2584 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_scrolln)(SCREEN*, int, int, int, int);
2585 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_set_tty_mode)(SCREEN*, TTY*);
2586 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_setupscreen)(SCREEN**, int, int, FILE *, int, int);
2587 extern NCURSES_EXPORT(int)      NCURSES_SP_NAME(_nc_tgetent)(SCREEN*,char*,const char *);
2588 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_do_color)(SCREEN*, int, int, int, NCURSES_SP_OUTC);
2589 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_do_xmc_glitch)(SCREEN*, attr_t);
2590 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_flush)(SCREEN*);
2591 extern GCC_NORETURN NCURSES_EXPORT(void) NCURSES_SP_NAME(_nc_free_and_exit)(SCREEN*, int);
2592 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_freeall)(SCREEN*);
2593 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_hash_map)(SCREEN*);
2594 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_init_acs)(SCREEN*);
2595 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_make_oldhash)(SCREEN*, int i);
2596 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_init)(SCREEN*);
2597 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_resume)(SCREEN*);
2598 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_mvcur_wrap)(SCREEN*);
2599 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_init)(SCREEN*);
2600 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_resume)(SCREEN*);
2601 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_screen_wrap)(SCREEN*);
2602 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_scroll_oldhash)(SCREEN*, int n, int top, int bot);
2603 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_scroll_optimize)(SCREEN*);
2604 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_set_buffer)(SCREEN*, FILE *, int);
2605
2606 extern NCURSES_EXPORT(void)     _nc_cookie_init(SCREEN *sp);
2607
2608 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
2609 extern NCURSES_EXPORT(void)     NCURSES_SP_NAME(_nc_linedump)(SCREEN*);
2610 #endif
2611
2612 #if USE_WIDEC_SUPPORT
2613 extern NCURSES_EXPORT(wchar_t *) NCURSES_SP_NAME(_nc_wunctrl)(SCREEN*, cchar_t *);
2614 #endif
2615
2616 #endif /* NCURSES_SP_FUNCS */
2617
2618 #if NCURSES_SP_FUNCS
2619
2620 #define safe_keyname NCURSES_SP_NAME(keyname)
2621 #define safe_unctrl  NCURSES_SP_NAME(unctrl)
2622 #define safe_ungetch NCURSES_SP_NAME(ungetch)
2623
2624 #else
2625
2626 #define safe_keyname _nc_keyname
2627 #define safe_unctrl  _nc_unctrl
2628 #define safe_ungetch _nc_ungetch
2629
2630 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_keyname (SCREEN *, int);
2631 extern NCURSES_EXPORT(int) _nc_ungetch (SCREEN *, int);
2632 extern NCURSES_EXPORT(NCURSES_CONST char *) _nc_unctrl (SCREEN *, chtype);
2633
2634 #endif
2635
2636 #ifdef EXP_XTERM_1005
2637 extern NCURSES_EXPORT(int) _nc_conv_to_utf8(unsigned char *, unsigned, unsigned);
2638 extern NCURSES_EXPORT(int) _nc_conv_to_utf32(unsigned *, const char *, unsigned);
2639 #endif
2640
2641 #ifdef __cplusplus
2642 }
2643 #endif
2644
2645 /* *INDENT-ON* */
2646
2647 #endif /* CURSES_PRIV_H */