ncurses/curses.priv.h

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