ncurses/curses.priv.h

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