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