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