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