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