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