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