ncurses/curses.priv.h

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