ncurses/curses.priv.h

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