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