ncurses/curses.priv.h

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