ncurses/curses.priv.h

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