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.325 2007/03/10 23:43:50 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         WINDOW *w;              /* maybe we need this for cleanup   */
 384 } ripoff_t;
 385
 386 #if USE_GPM_SUPPORT
 387 #undef buttons                  /* term.h defines this, and gpm uses it! */
 388 #include <gpm.h>
 389
 390 #ifdef HAVE_LIBDL
 391 /* link dynamically to GPM */
 392 typedef int *TYPE_gpm_fd;
 393 typedef int (*TYPE_Gpm_Open) (Gpm_Connect *, int);
 394 typedef int (*TYPE_Gpm_Close) (void);
 395 typedef int (*TYPE_Gpm_GetEvent) (Gpm_Event *);
 396
 397 #define my_gpm_fd       SP->_mouse_gpm_fd
 398 #define my_Gpm_Open     SP->_mouse_Gpm_Open
 399 #define my_Gpm_Close    SP->_mouse_Gpm_Close
 400 #define my_Gpm_GetEvent SP->_mouse_Gpm_GetEvent
 401 #else
 402 /* link statically to GPM */
 403 #define my_gpm_fd       &gpm_fd
 404 #define my_Gpm_Open     Gpm_Open
 405 #define my_Gpm_Close    Gpm_Close
 406 #define my_Gpm_GetEvent Gpm_GetEvent
 407 #endif /* HAVE_LIBDL */
 408 #endif /* USE_GPM_SUPPORT */
 409
 410 /*
 411  * The SCREEN structure.
 412  */
 413
 414 struct screen {
 415         int             _ifd;           /* input file ptr for screen        */
 416         FILE            *_ofp;          /* output file ptr for screen       */
 417         char            *_setbuf;       /* buffered I/O for output          */
 418         bool            _filtered;      /* filter() was called              */
 419         bool            _buffered;      /* setvbuf uses _setbuf data        */
 420         int             _checkfd;       /* filedesc for typeahead check     */
 421         TERMINAL        *_term;         /* terminal type information        */
 422         TTY             _saved_tty;     /* savetty/resetty information      */
 423         NCURSES_SIZE_T  _lines;         /* screen lines                     */
 424         NCURSES_SIZE_T  _columns;       /* screen columns                   */
 425
 426         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
 427         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
 428         ripoff_t        _rippedoff[5];  /* list of lines stolen             */
 429         int             _rip_count;     /* ...and total lines stolen        */
 430
 431         WINDOW          *_curscr;       /* current screen                   */
 432         WINDOW          *_newscr;       /* virtual screen to be updated to  */
 433         WINDOW          *_stdscr;       /* screen's full-window context     */
 434
 435         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
 436         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
 437         bool            _tried;         /* keypad mode was initialized      */
 438         bool            _keypad_on;     /* keypad mode is currently on      */
 439
 440         bool            _called_wgetch; /* check for recursion in wgetch()  */
 441         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
 442         short           _fifohead,      /* head of fifo queue               */
 443                         _fifotail,      /* tail of fifo queue               */
 444                         _fifopeek,      /* where to peek for next char      */
 445                         _fifohold;      /* set if breakout marked           */
 446
 447         int             _endwin;        /* are we out of window mode?       */
 448         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
 449         int             _coloron;       /* is color enabled?                */
 450         int             _color_defs;    /* are colors modified              */
 451         int             _cursor;        /* visibility of the cursor         */
 452         int             _cursrow;       /* physical cursor row              */
 453         int             _curscol;       /* physical cursor column           */
 454         bool            _notty;         /* true if we cannot switch non-tty */
 455         int             _nl;            /* True if NL -> CR/NL is on        */
 456         int             _raw;           /* True if in raw mode              */
 457         int             _cbreak;        /* 1 if in cbreak mode              */
 458                                         /* > 1 if in halfdelay mode         */
 459         int             _echo;          /* True if echo on                  */
 460         int             _use_meta;      /* use the meta key?                */
 461         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
 462         int             slk_format;     /* selected format for this screen  */
 463         /* cursor movement costs; units are 10ths of milliseconds */
 464 #if NCURSES_NO_PADDING
 465         int             _no_padding;    /* flag to set if padding disabled  */
 466 #endif
 467         int             _char_padding;  /* cost of character put            */
 468         int             _cr_cost;       /* cost of (carriage_return)        */
 469         int             _cup_cost;      /* cost of (cursor_address)         */
 470         int             _home_cost;     /* cost of (cursor_home)            */
 471         int             _ll_cost;       /* cost of (cursor_to_ll)           */
 472 #if USE_HARD_TABS
 473         int             _ht_cost;       /* cost of (tab)                    */
 474         int             _cbt_cost;      /* cost of (backtab)                */
 475 #endif /* USE_HARD_TABS */
 476         int             _cub1_cost;     /* cost of (cursor_left)            */
 477         int             _cuf1_cost;     /* cost of (cursor_right)           */
 478         int             _cud1_cost;     /* cost of (cursor_down)            */
 479         int             _cuu1_cost;     /* cost of (cursor_up)              */
 480         int             _cub_cost;      /* cost of (parm_cursor_left)       */
 481         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
 482         int             _cud_cost;      /* cost of (parm_cursor_down)       */
 483         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
 484         int             _hpa_cost;      /* cost of (column_address)         */
 485         int             _vpa_cost;      /* cost of (row_address)            */
 486         /* used in tty_update.c, must be chars */
 487         int             _ed_cost;       /* cost of (clr_eos)                */
 488         int             _el_cost;       /* cost of (clr_eol)                */
 489         int             _el1_cost;      /* cost of (clr_bol)                */
 490         int             _dch1_cost;     /* cost of (delete_character)       */
 491         int             _ich1_cost;     /* cost of (insert_character)       */
 492         int             _dch_cost;      /* cost of (parm_dch)               */
 493         int             _ich_cost;      /* cost of (parm_ich)               */
 494         int             _ech_cost;      /* cost of (erase_chars)            */
 495         int             _rep_cost;      /* cost of (repeat_char)            */
 496         int             _hpa_ch_cost;   /* cost of (column_address)         */
 497         int             _cup_ch_cost;   /* cost of (cursor_address)         */
 498         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
 499         int             _inline_cost;   /* cost of inline-move              */
 500         int             _smir_cost;     /* cost of (enter_insert_mode)      */
 501         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
 502         int             _ip_cost;       /* cost of (insert_padding)         */
 503         /* used in lib_mvcur.c */
 504         char *          _address_cursor;
 505         /* used in tty_update.c */
 506         int             _scrolling;     /* 1 if terminal's smart enough to  */
 507
 508         /* used in lib_color.c */
 509         color_t         *_color_table;  /* screen's color palette            */
 510         int             _color_count;   /* count of colors in palette        */
 511         colorpair_t     *_color_pairs;  /* screen's color pair list          */
 512         int             _pair_count;    /* count of color pairs              */
 513 #if NCURSES_EXT_FUNCS
 514         bool            _default_color; /* use default colors                */
 515         bool            _has_sgr_39_49; /* has ECMA default color support    */
 516         int             _default_fg;    /* assumed default foreground        */
 517         int             _default_bg;    /* assumed default background        */
 518 #endif
 519         chtype          _ok_attributes; /* valid attributes for terminal     */
 520         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
 521         chtype          _xmc_triggers;  /* attributes to process if xmc      */
 522         chtype *        _acs_map;       /* the real alternate-charset map    */
 523         bool *          _screen_acs_map;
 524
 525
 526         /* used in lib_vidattr.c */
 527         bool            _use_rmso;      /* true if we may use 'rmso'         */
 528         bool            _use_rmul;      /* true if we may use 'rmul'         */
 529
 530         /*
 531          * These data correspond to the state of the idcok() and idlok()
 532          * functions.  A caveat is in order here:  the XSI and SVr4
 533          * documentation specify that these functions apply to the window which
 534          * is given as an argument.  However, ncurses implements this logic
 535          * only for the newscr/curscr update process, _not_ per-window.
 536          */
 537         bool            _nc_sp_idlok;
 538         bool            _nc_sp_idcok;
 539 #define _nc_idlok SP->_nc_sp_idlok
 540 #define _nc_idcok SP->_nc_sp_idcok
 541
 542         /*
 543          * These are the data that support the mouse interface.
 544          */
 545         bool            _mouse_initialized;
 546         MouseType       _mouse_type;
 547         int             _maxclick;
 548         bool            (*_mouse_event) (SCREEN *);
 549         bool            (*_mouse_inline)(SCREEN *);
 550         bool            (*_mouse_parse) (int);
 551         void            (*_mouse_resume)(SCREEN *);
 552         void            (*_mouse_wrap)  (SCREEN *);
 553         int             _mouse_fd;      /* file-descriptor, if any */
 554         bool            _mouse_active;  /* true if initialized */
 555         mmask_t         _mouse_mask;
 556         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
 557         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
 558         MEVENT          *_mouse_eventp; /* next free slot in event queue */
 559
 560 #if USE_GPM_SUPPORT
 561         bool            _mouse_gpm_loaded;
 562         bool            _mouse_gpm_found;
 563 #ifdef HAVE_LIBDL
 564         TYPE_gpm_fd     _mouse_gpm_fd;
 565         TYPE_Gpm_Open   _mouse_Gpm_Open;
 566         TYPE_Gpm_Close  _mouse_Gpm_Close;
 567         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
 568 #endif
 569         Gpm_Connect     _mouse_gpm_connect;
 570 #endif /* USE_GPM_SUPPORT */
 571
 572 #if USE_EMX_MOUSE
 573         int             _emxmouse_wfd;
 574         int             _emxmouse_thread;
 575         int             _emxmouse_activated;
 576         char            _emxmouse_buttons[4];
 577 #endif
 578
 579 #if USE_SYSMOUSE
 580         MEVENT          _sysmouse_fifo[FIFO_SIZE];
 581         int             _sysmouse_head;
 582         int             _sysmouse_tail;
 583         int             _sysmouse_char_width;   /* character width */
 584         int             _sysmouse_char_height;  /* character height */
 585         int             _sysmouse_old_buttons;
 586         int             _sysmouse_new_buttons;
 587 #endif
 588
 589         /*
 590          * This supports automatic resizing
 591          */
 592 #if USE_SIZECHANGE
 593         int             (*_resize)(int,int);
 594 #endif
 595
 596         /*
 597          * These are data that support the proper handling of the panel stack on an
 598          * per screen basis.
 599          */
 600         struct panelhook _panelHook;
 601         /*
 602          * Linked-list of all windows, to support '_nc_resizeall()' and
 603          * '_nc_freeall()'
 604          */
 605         WINDOWLIST      *_nc_sp_windows;
 606 #define _nc_windows SP->_nc_sp_windows
 607
 608         bool            _sig_winch;
 609         SCREEN          *_next_screen;
 610
 611         /* hashes for old and new lines */
 612         unsigned long   *oldhash, *newhash;
 613         HASHMAP         *hashtab;
 614         int             hashtab_len;
 615         int             *_oldnum_list;
 616         int             _oldnum_size;
 617
 618         bool            _cleanup;       /* cleanup after int/quit signal */
 619         int             (*_outch)(int); /* output handler if not putc */
 620
 621         int             _legacy_coding; /* see use_legacy_coding() */
 622
 623 #if USE_REENTRANT
 624         char            _ttytype[NAMESIZE];
 625         int             _ESCDELAY;
 626         int             _TABSIZE;
 627         int             _LINES;
 628         int             _COLS;
 629 #endif
 630         /*
 631          * ncurses/ncursesw are the same up to this point.
 632          */
 633 #if USE_WIDEC_SUPPORT
 634         /* recent versions of 'screen' have partially-working support for
 635          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
 636          */
 637         bool            _screen_acs_fix;
 638 #endif
 639 };
 640
 641 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
 642
 643         WINDOWLIST {
 644         WINDOW  win;    /* first, so WINDOW_EXT() works */
 645         WINDOWLIST *next;
 646 #ifdef _XOPEN_SOURCE_EXTENDED
 647         char addch_work[(MB_LEN_MAX * 9) + 1];
 648         unsigned addch_used;    /* number of bytes in addch_work[] */
 649         int addch_x;            /* x-position for addch_work[] */
 650         int addch_y;            /* y-position for addch_work[] */
 651 #endif
 652 };
 653
 654 #define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)
 655
 656 /* usually in <limits.h> */
 657 #ifndef UCHAR_MAX
 658 #define UCHAR_MAX 255
 659 #endif
 660
 661 /* The terminfo source is assumed to be 7-bit ASCII */
 662 #define is7bits(c)      ((unsigned)(c) < 128)
 663
 664 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
 665 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
 666
 667 #ifndef min
 668 #define min(a,b)        ((a) > (b)  ?  (b)  :  (a))
 669 #endif
 670
 671 #ifndef max
 672 #define max(a,b)        ((a) < (b)  ?  (b)  :  (a))
 673 #endif
 674
 675 /* usually in <unistd.h> */
 676 #ifndef STDIN_FILENO
 677 #define STDIN_FILENO 0
 678 #endif
 679
 680 #ifndef STDOUT_FILENO
 681 #define STDOUT_FILENO 1
 682 #endif
 683
 684 #ifndef STDERR_FILENO
 685 #define STDERR_FILENO 2
 686 #endif
 687
 688 #ifndef EXIT_SUCCESS
 689 #define EXIT_SUCCESS 0
 690 #endif
 691
 692 #ifndef EXIT_FAILURE
 693 #define EXIT_FAILURE 1
 694 #endif
 695
 696 #ifndef R_OK
 697 #define R_OK    4               /* Test for read permission.  */
 698 #endif
 699 #ifndef W_OK
 700 #define W_OK    2               /* Test for write permission.  */
 701 #endif
 702 #ifndef X_OK
 703 #define X_OK    1               /* Test for execute permission.  */
 704 #endif
 705 #ifndef F_OK
 706 #define F_OK    0               /* Test for existence.  */
 707 #endif
 708
 709 #if HAVE_FCNTL_H
 710 #include <fcntl.h>              /* may define O_BINARY  */
 711 #endif
 712
 713 #ifndef O_BINARY
 714 #define O_BINARY 0
 715 #endif
 716
 717 #ifdef TRACE
 718 #define TRACE_OUTCHARS(n) _nc_outchars += (n);
 719 #else
 720 #define TRACE_OUTCHARS(n) /* nothing */
 721 #endif
 722
 723 #define UChar(c)        ((unsigned char)(c))
 724 #define ChCharOf(c)     ((c) & (chtype)A_CHARTEXT)
 725 #define ChAttrOf(c)     ((c) & (chtype)A_ATTRIBUTES)
 726
 727 #ifndef MB_LEN_MAX
 728 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
 729 #endif
 730
 731 #if USE_WIDEC_SUPPORT /* { */
 732 #define isEILSEQ(status) ((status == (size_t)-1) && (errno == EILSEQ))
 733
 734 #define init_mb(state)  memset(&state, 0, sizeof(state))
 735
 736 #if NCURSES_EXT_COLORS
 737 #define NulColor        , 0
 738 #else
 739 #define NulColor        /* nothing */
 740 #endif
 741
 742 #define NulChar         0,0,0,0 /* FIXME: see CCHARW_MAX */
 743 #define CharOf(c)       ((c).chars[0])
 744 #define AttrOf(c)       ((c).attr)
 745 #define AddAttr(c,a)    AttrOf(c) |= ((a) & A_ATTRIBUTES)
 746 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
 747 #define SetAttr(c,a)    AttrOf(c) = ((a) & A_ATTRIBUTES)
 748 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
 749 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
 750 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
 751 #define SetChar(ch,c,a) do {                                                        \
 752                             NCURSES_CH_T *_cp = &ch;                                \
 753                             memset(_cp, 0, sizeof(ch));                             \
 754                             _cp->chars[0] = (c);                                            \
 755                             _cp->attr = (a);                                        \
 756                             if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a)));             \
 757                         } while (0)
 758 #define CHREF(wch)      (&wch)
 759 #define CHDEREF(wch)    (*wch)
 760 #define ARG_CH_T        NCURSES_CH_T *
 761 #define CARG_CH_T       const NCURSES_CH_T *
 762 #define PUTC_DATA       char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
 763                         mbstate_t PUT_st; wchar_t PUTC_ch
 764 #define PUTC_INIT       init_mb (PUT_st)
 765 #define PUTC(ch,b)      do { if(!isWidecExt(ch)) {                                  \
 766                         if (Charable(ch)) {                                         \
 767                             fputc(CharOf(ch), b);                                   \
 768                             TRACE_OUTCHARS(1);                                      \
 769                         } else {                                                    \
 770                             PUTC_INIT;                                              \
 771                             for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {       \
 772                                 PUTC_ch = (ch).chars[PUTC_i];                       \
 773                                 if (PUTC_ch == L'\0')                               \
 774                                     break;                                          \
 775                                 PUTC_n = wcrtomb(PUTC_buf,                          \
 776                                                  (ch).chars[PUTC_i], &PUT_st);      \
 777                                 if (PUTC_n <= 0) {                                  \
 778                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
 779                                         putc(PUTC_ch,b);                            \
 780                                     break;                                          \
 781                                 }                                                   \
 782                                 fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b);          \
 783                             }                                                       \
 784                             TRACE_OUTCHARS(PUTC_i);                                 \
 785                         } } } while (0)
 786
 787 #define BLANK           { WA_NORMAL, {' '} NulColor }
 788 #define ZEROS           { WA_NORMAL, {'\0'} NulColor }
 789 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
 790
 791         /*
 792          * Wide characters cannot be represented in the A_CHARTEXT mask of
 793          * attr_t's but an application might have set a narrow character there.
 794          * But even in that case, it would only be a printable character, or
 795          * zero.  Otherwise we can use those bits to tell if a cell is the
 796          * first or extension part of a wide character.
 797          */
 798 #define WidecExt(ch)    (AttrOf(ch) & A_CHARTEXT)
 799 #define isWidecBase(ch) (WidecExt(ch) == 1)
 800 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
 801 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
 802                                 AttrOf(dst) |= (ext + 1)
 803
 804 #define if_WIDEC(code)  code
 805 #define Charable(ch)    ((SP != 0 && SP->_legacy_coding)                \
 806                          || (AttrOf(ch) & A_ALTCHARSET)                 \
 807                          || (!isWidecExt(ch) &&                         \
 808                              (ch).chars[1] == L'\0' &&                  \
 809                              _nc_is_charable(CharOf(ch))))
 810
 811 #define L(ch)           L ## ch
 812 #else /* }{ */
 813 #define CharOf(c)       ChCharOf(c)
 814 #define AttrOf(c)       ChAttrOf(c)
 815 #define AddAttr(c,a)    c |= (a)
 816 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
 817 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
 818 #define NewChar(ch)     (ch)
 819 #define NewChar2(c,a)   ((c) | (a))
 820 #define CharEq(a,b)     ((a) == (b))
 821 #define SetChar(ch,c,a) ch = (c) | (a)
 822 #define CHREF(wch)      wch
 823 #define CHDEREF(wch)    wch
 824 #define ARG_CH_T        NCURSES_CH_T
 825 #define CARG_CH_T       NCURSES_CH_T
 826 #define PUTC_DATA       int data = 0
 827 #define PUTC(ch,b)      do { data = CharOf(ch); putc(data,b); } while (0)
 828
 829 #define BLANK           (' '|A_NORMAL)
 830 #define ZEROS           ('\0'|A_NORMAL)
 831 #define ISBLANK(ch)     (CharOf(ch) == ' ')
 832
 833 #define isWidecExt(ch)  (0)
 834 #define if_WIDEC(code) /* nothing */
 835
 836 #define L(ch)           ch
 837 #endif /* } */
 838
 839 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
 840 #define CharOfD(ch)     CharOf(CHDEREF(ch))
 841 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
 842
 843 #define BLANK_ATTR      A_NORMAL
 844 #define BLANK_TEXT      L(' ')
 845
 846 #define CHANGED     -1
 847
 848 #define LEGALYX(w, y, x) \
 849               ((w) != 0 && \
 850                 ((x) >= 0 && (x) <= (w)->_maxx && \
 851                  (y) >= 0 && (y) <= (w)->_maxy))
 852
 853 #define CHANGED_CELL(line,col) \
 854         if (line->firstchar == _NOCHANGE) \
 855                 line->firstchar = line->lastchar = col; \
 856         else if ((col) < line->firstchar) \
 857                 line->firstchar = col; \
 858         else if ((col) > line->lastchar) \
 859                 line->lastchar = col
 860
 861 #define CHANGED_RANGE(line,start,end) \
 862         if (line->firstchar == _NOCHANGE \
 863          || line->firstchar > (start)) \
 864                 line->firstchar = start; \
 865         if (line->lastchar == _NOCHANGE \
 866          || line->lastchar < (end)) \
 867                 line->lastchar = end
 868
 869 #define CHANGED_TO_EOL(line,start,end) \
 870         if (line->firstchar == _NOCHANGE \
 871          || line->firstchar > (start)) \
 872                 line->firstchar = start; \
 873         line->lastchar = end
 874
 875 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
 876
 877 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
 878
 879 /* FreeAndNull() is not a comma-separated expression because some compilers
 880  * do not accept a mixture of void with values.
 881  */
 882 #define FreeAndNull(p)   free(p); p = 0
 883
 884 #include <nc_alloc.h>
 885
 886 /*
 887  * TTY bit definition for converting tabs to spaces.
 888  */
 889 #ifdef TAB3
 890 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
 891 #else
 892 # ifdef XTABS
 893 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
 894 # else
 895 #  ifdef OXTABS
 896 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
 897 #  else
 898 #   define OFLAGS_TABS 0
 899 #  endif
 900 # endif
 901 #endif
 902
 903 /*
 904  * Prefixes for call/return points of library function traces.  We use these to
 905  * instrument the public functions so that the traces can be easily transformed
 906  * into regression scripts.
 907  */
 908 #define T_CALLED(fmt) "called {" fmt
 909 #define T_CREATE(fmt) "create :" fmt
 910 #define T_RETURN(fmt) "return }" fmt
 911
 912 #ifdef TRACE
 913
 914 #define START_TRACE() \
 915         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
 916             int t = _nc_getenv_num("NCURSES_TRACE"); \
 917             if (t >= 0) \
 918                 trace((unsigned) t); \
 919         }
 920
 921 #define TR(n, a)        if (_nc_tracing & (n)) _tracef a
 922 #define T(a)            TR(TRACE_CALLS, a)
 923 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
 924 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
 925
 926 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
 927 #define returnBits(code)        TRACE_RETURN(code,unsigned)
 928 #define returnBool(code)        TRACE_RETURN(code,bool)
 929 #define returnCPtr(code)        TRACE_RETURN(code,cptr)
 930 #define returnCVoidPtr(code)    TRACE_RETURN(code,cvoid_ptr)
 931 #define returnChar(code)        TRACE_RETURN(code,chtype)
 932 #define returnCode(code)        TRACE_RETURN(code,int)
 933 #define returnPtr(code)         TRACE_RETURN(code,ptr)
 934 #define returnSP(code)          TRACE_RETURN(code,sp)
 935 #define returnVoid              T((T_RETURN(""))); return
 936 #define returnVoidPtr(code)     TRACE_RETURN(code,void_ptr)
 937 #define returnWin(code)         TRACE_RETURN(code,win)
 938
 939 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (NCURSES_BOOL);
 940 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
 941 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
 942 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
 943 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
 944 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
 945 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(TTY *tty);
 946 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
 947 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
 948 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
 949 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
 950 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
 951 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
 952 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
 953 extern NCURSES_EXPORT(void)             _nc_fifo_dump (void);
 954 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
 955 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
 956 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
 957
 958 #if USE_WIDEC_SUPPORT
 959 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
 960 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
 961 #endif
 962
 963 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
 964 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
 965
 966 #else /* !TRACE */
 967
 968 #define START_TRACE() /* nothing */
 969
 970 #define T(a)
 971 #define TR(n, a)
 972 #define TPUTS_TRACE(s)
 973
 974 #define returnAttr(code)        return code
 975 #define returnBits(code)        return code
 976 #define returnBool(code)        return code
 977 #define returnCPtr(code)        return code
 978 #define returnCVoidPtr(code)    return code
 979 #define returnChar(code)        return code
 980 #define returnCode(code)        return code
 981 #define returnPtr(code)         return code
 982 #define returnSP(code)          return code
 983 #define returnVoid              return
 984 #define returnVoidPtr(code)     return code
 985 #define returnWin(code)         return code
 986
 987 #endif /* TRACE/!TRACE */
 988
 989 /*
 990  * Return-codes for tgetent() and friends.
 991  */
 992 #define TGETENT_YES  1          /* entry is found */
 993 #define TGETENT_NO   0          /* entry is not found */
 994 #define TGETENT_ERR -1          /* an error occurred */
 995
 996 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
 997 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
 998
 999 #define empty_module(name) \
1000 extern  NCURSES_EXPORT(void) name (void); \
1001         NCURSES_EXPORT(void) name (void) { }
1002
1003 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1004 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1005 #define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)
1006
1007 #define toggle_attr_on(S,at) {\
1008    if (PAIR_NUMBER(at) > 0) {\
1009       (S) = ((S) & ALL_BUT_COLOR) | (at);\
1010    } else {\
1011       (S) |= (at);\
1012    }\
1013    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1014
1015
1016 #define toggle_attr_off(S,at) {\
1017    if (PAIR_NUMBER(at) > 0) {\
1018       (S) &= ~(at|A_COLOR);\
1019    } else {\
1020       (S) &= ~(at);\
1021    }\
1022    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1023
1024 #define DelCharCost(count) \
1025                 ((parm_dch != 0) \
1026                 ? SP->_dch_cost \
1027                 : ((delete_character != 0) \
1028                         ? (SP->_dch1_cost * count) \
1029                         : INFINITY))
1030
1031 #define InsCharCost(count) \
1032                 ((parm_ich != 0) \
1033                 ? SP->_ich_cost \
1034                 : ((enter_insert_mode && exit_insert_mode) \
1035                   ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
1036                   : ((insert_character != 0) \
1037                     ? ((SP->_ich1_cost + SP->_ip_cost) * count) \
1038                     : INFINITY)))
1039
1040 #if USE_XMC_SUPPORT
1041 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) { \
1042                                 attr_t chg = AttrOf(SCREEN_ATTRS(SP)); \
1043                                 VIDATTR(AttrOf(c), GetPair(c)); \
1044                                 if (magic_cookie_glitch > 0 \
1045                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(SP))))) { \
1046                                         T(("%s @%d before glitch %d,%d", \
1047                                                 __FILE__, __LINE__, \
1048                                                 SP->_cursrow, \
1049                                                 SP->_curscol)); \
1050                                         _nc_do_xmc_glitch(chg); \
1051                                 } \
1052                         }
1053 #else
1054 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) \
1055                                 VIDATTR(AttrOf(c), GetPair(c));
1056 #endif
1057
1058 /*
1059  * Macros to make additional parameter to implement wgetch_events()
1060  */
1061 #ifdef NCURSES_WGETCH_EVENTS
1062 #define EVENTLIST_0th(param) param
1063 #define EVENTLIST_1st(param) param
1064 #define EVENTLIST_2nd(param) , param
1065 #else
1066 #define EVENTLIST_0th(param) void
1067 #define EVENTLIST_1st(param) /* nothing */
1068 #define EVENTLIST_2nd(param) /* nothing */
1069 #endif
1070
1071 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1072
1073 #undef  toggle_attr_on
1074 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1075 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1076
1077 #undef  toggle_attr_off
1078 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1079 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1080
1081 #undef  DelCharCost
1082 #define DelCharCost(count) _nc_DelCharCost(count)
1083 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1084
1085 #undef  InsCharCost
1086 #define InsCharCost(count) _nc_InsCharCost(count)
1087 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1088
1089 #undef  UpdateAttrs
1090 #define UpdateAttrs(c) _nc_UpdateAttrs(c)
1091 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (NCURSES_CH_T);
1092
1093 #else
1094
1095 extern NCURSES_EXPORT(void) _nc_expanded (void);
1096
1097 #endif
1098
1099 #if !HAVE_GETCWD
1100 #define getcwd(buf,len) getwd(buf)
1101 #endif
1102
1103 /* charable.c */
1104 #if USE_WIDEC_SUPPORT
1105 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1106 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1107 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1108 #endif
1109
1110 /* doupdate.c */
1111 #if USE_XMC_SUPPORT
1112 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1113 #endif
1114
1115 /* hardscroll.c */
1116 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1117 extern NCURSES_EXPORT(void) _nc_linedump (void);
1118 #endif
1119
1120 /* lib_acs.c */
1121 extern NCURSES_EXPORT(void) _nc_init_acs (void);        /* corresponds to traditional 'init_acs()' */
1122 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int);  /* used by 'tack' program */
1123
1124 /* lib_addch.c */
1125 #if USE_WIDEC_SUPPORT
1126 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1127 #endif
1128
1129 /* lib_addstr.c */
1130 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1131 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1132 #endif
1133
1134 /* lib_color.c */
1135 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1136
1137 /* lib_getch.c */
1138 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1139
1140 /* lib_insch.c */
1141 extern NCURSES_EXPORT(int) _nc_insert_ch(WINDOW *, chtype);
1142
1143 /* lib_mvcur.c */
1144 #define INFINITY        1000000 /* cost: too high to use */
1145
1146 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1147 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1148 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1149
1150 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1151
1152 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1153 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1154 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1155
1156 /* lib_mouse.c */
1157 extern NCURSES_EXPORT(int) _nc_has_mouse (void);
1158
1159 /* lib_mvcur.c */
1160 #define INFINITY        1000000 /* cost: too high to use */
1161 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
1162
1163 /* lib_setup.c */
1164 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1165 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1166 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(void);
1167 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1168 extern NCURSES_EXPORT(void) _nc_get_screensize(int *, int *);
1169
1170 /* lib_tstp.c */
1171 #if USE_SIGWINCH
1172 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(int);
1173 #else
1174 #define _nc_handle_sigwinch(a) /* nothing */
1175 #endif
1176
1177 /* lib_wacs.c */
1178 #if USE_WIDEC_SUPPORT
1179 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1180 #endif
1181
1182 typedef struct {
1183     char *s_head;       /* beginning of the string (may be null) */
1184     char *s_tail;       /* end of the string (may be null) */
1185     size_t s_size;      /* current remaining size available */
1186     size_t s_init;      /* total size available */
1187 } string_desc;
1188
1189 /* strings.c */
1190 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1191 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1192 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1193 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1194 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1195
1196 #if !HAVE_STRSTR
1197 #define strstr _nc_strstr
1198 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1199 #endif
1200
1201 /* safe_sprintf.c */
1202 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1203
1204 /* tries.c */
1205 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1206 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1207 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1208 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1209
1210 /* elsewhere ... */
1211 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry(ENTRY *, TERMTYPE *);
1212 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1213 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1214 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1215 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1216 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1217 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1218 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1219 extern NCURSES_EXPORT(int) _nc_keypad (bool);
1220 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1221 extern NCURSES_EXPORT(int) _nc_outch (int);
1222 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1223 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1224 extern NCURSES_EXPORT(int) _nc_timed_wait(int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1225 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, int (*)(int));
1226 extern NCURSES_EXPORT(void) _nc_flush (void);
1227 extern NCURSES_EXPORT(void) _nc_free_entry(ENTRY *, TERMTYPE *);
1228 extern NCURSES_EXPORT(void) _nc_freeall (void);
1229 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1230 extern NCURSES_EXPORT(void) _nc_init_keytry (void);
1231 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1232 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1233 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1234 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1235 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1236 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1237 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1238 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1239
1240 #if NO_LEAKS
1241 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1242 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1243 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1244 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1245 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1246 #endif
1247
1248 #ifndef USE_TERMLIB
1249 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1250 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1251 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1252 #endif
1253
1254 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1255 #ifdef linux
1256 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1257 #else
1258 #define _nc_wcrtomb(s,wc,ps) wcrtomb(s,wc,ps)
1259 #endif
1260 #endif
1261
1262 #if USE_SIZECHANGE
1263 extern NCURSES_EXPORT(void) _nc_update_screensize (void);
1264 #endif
1265
1266 #if HAVE_RESIZETERM
1267 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1268 #else
1269 #define _nc_resize_margins(wp) /* nothing */
1270 #endif
1271
1272 #ifdef NCURSES_WGETCH_EVENTS
1273 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1274 #else
1275 #define wgetch_events(win, evl) wgetch(win)
1276 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1277 #endif
1278
1279 /*
1280  * Not everyone has vsscanf(), but we'd like to use it for scanw().
1281  */
1282 #if !HAVE_VSSCANF
1283 extern int vsscanf(const char *str, const char *format, va_list __arg);
1284 #endif
1285
1286 /* scroll indices */
1287 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1288
1289 #define USE_SETBUF_0 0
1290
1291 #define NC_BUFFERED(flag) _nc_set_buffer(SP->_ofp, flag)
1292
1293 #define NC_OUTPUT ((SP != 0) ? SP->_ofp : stdout)
1294
1295 /*
1296  * On systems with a broken linker, define 'SP' as a function to force the
1297  * linker to pull in the data-only module with 'SP'.
1298  */
1299 #if BROKEN_LINKER
1300 #define SP _nc_screen()
1301 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1302 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1303 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1304 #else
1305 /* current screen is private data; avoid possible linking conflicts too */
1306 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1307 #define _nc_alloc_screen() ((SP = typeCalloc(SCREEN, 1)) != 0)
1308 #define _nc_set_screen(sp) SP = sp
1309 #endif
1310
1311 /*
1312  * We don't want to use the lines or columns capabilities internally, because
1313  * if the application is running multiple screens under X, it's quite possible
1314  * they could all have type xterm but have different sizes!  So...
1315  */
1316 #define screen_lines    SP->_lines
1317 #define screen_columns  SP->_columns
1318
1319 extern NCURSES_EXPORT_VAR(int) _nc_slk_format;  /* != 0 if slk_init() called */
1320 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1321
1322 /*
1323  * Some constants related to SLK's
1324  */
1325 #define MAX_SKEY_OLD       8    /* count of soft keys */
1326 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
1327 #define MAX_SKEY_PC       12    /* This is what most PC's have */
1328 #define MAX_SKEY_LEN_PC    5
1329
1330 /* Macro to check whether or not we use a standard format */
1331 #define SLK_STDFMT(fmt) (fmt < 3)
1332 /* Macro to determine height of label window */
1333 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1334
1335 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1336 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1337
1338 extern NCURSES_EXPORT(int) _nc_ripoffline (int line, int (*init)(WINDOW *,int));
1339
1340 /*
1341  * Common error messages
1342  */
1343 #define MSG_NO_MEMORY "Out of memory"
1344 #define MSG_NO_INPUTS "Premature EOF"
1345
1346 #ifdef __cplusplus
1347 }
1348 #endif
1349
1350 #endif /* CURSES_PRIV_H */