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