ncurses/curses.priv.h

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