ncurses/curses.priv.h

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