ncurses/curses.priv.h

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