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