ncurses 5.6 - patch 20070929
[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.343 2007/09/29 21:33:24 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        pthread_mutex_t  mutex_tst_tracef;
564        pthread_mutex_t  mutex_tracef;
565        int              nested_tracef;
566 #endif
567 } NCURSES_GLOBALS;
568
569 extern NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals;
570
571 #define N_RIPS 5
572
573 /*
574  * Global data which is swept up into a SCREEN when one is created.
575  * It may be modified before the next SCREEN is created.
576  */
577 typedef struct {
578         bool            use_env;
579         bool            filter_mode;
580         attr_t          previous_attr;
581         ripoff_t        rippedoff[N_RIPS];
582         ripoff_t        *rsp;
583         TPARM_STATE     tparm_state;
584         TTY             *saved_tty;     /* savetty/resetty information      */
585 #if BROKEN_LINKER || USE_REENTRANT
586         chtype          *real_acs_map;
587         int             _LINES;
588         int             _COLS;
589 #ifdef TRACE
590         long            _outchars;
591         const char      *_tputs_trace;
592 #endif
593 #endif
594 } NCURSES_PRESCREEN;
595
596 extern NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen;
597
598 /*
599  * The SCREEN structure.
600  */
601
602 struct screen {
603         int             _ifd;           /* input file ptr for screen        */
604         FILE            *_ofp;          /* output file ptr for screen       */
605         char            *_setbuf;       /* buffered I/O for output          */
606         bool            _filtered;      /* filter() was called              */
607         bool            _buffered;      /* setvbuf uses _setbuf data        */
608         int             _checkfd;       /* filedesc for typeahead check     */
609         TERMINAL        *_term;         /* terminal type information        */
610         TTY             _saved_tty;     /* savetty/resetty information      */
611         NCURSES_SIZE_T  _lines;         /* screen lines                     */
612         NCURSES_SIZE_T  _columns;       /* screen columns                   */
613
614         NCURSES_SIZE_T  _lines_avail;   /* lines available for stdscr       */
615         NCURSES_SIZE_T  _topstolen;     /* lines stolen from top            */
616
617         WINDOW          *_curscr;       /* current screen                   */
618         WINDOW          *_newscr;       /* virtual screen to be updated to  */
619         WINDOW          *_stdscr;       /* screen's full-window context     */
620
621         TRIES           *_keytry;       /* "Try" for use with keypad mode   */
622         TRIES           *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
623         bool            _tried;         /* keypad mode was initialized      */
624         bool            _keypad_on;     /* keypad mode is currently on      */
625
626         bool            _called_wgetch; /* check for recursion in wgetch()  */
627         int             _fifo[FIFO_SIZE];       /* input push-back buffer   */
628         short           _fifohead,      /* head of fifo queue               */
629                         _fifotail,      /* tail of fifo queue               */
630                         _fifopeek,      /* where to peek for next char      */
631                         _fifohold;      /* set if breakout marked           */
632
633         int             _endwin;        /* are we out of window mode?       */
634         NCURSES_CH_T    *_current_attr; /* holds current attributes set     */
635         int             _coloron;       /* is color enabled?                */
636         int             _color_defs;    /* are colors modified              */
637         int             _cursor;        /* visibility of the cursor         */
638         int             _cursrow;       /* physical cursor row              */
639         int             _curscol;       /* physical cursor column           */
640         bool            _notty;         /* true if we cannot switch non-tty */
641         int             _nl;            /* True if NL -> CR/NL is on        */
642         int             _raw;           /* True if in raw mode              */
643         int             _cbreak;        /* 1 if in cbreak mode              */
644                                         /* > 1 if in halfdelay mode         */
645         int             _echo;          /* True if echo on                  */
646         int             _use_meta;      /* use the meta key?                */
647         struct _SLK     *_slk;          /* ptr to soft key struct / NULL    */
648         int             slk_format;     /* selected format for this screen  */
649         /* cursor movement costs; units are 10ths of milliseconds */
650 #if NCURSES_NO_PADDING
651         int             _no_padding;    /* flag to set if padding disabled  */
652 #endif
653         int             _char_padding;  /* cost of character put            */
654         int             _cr_cost;       /* cost of (carriage_return)        */
655         int             _cup_cost;      /* cost of (cursor_address)         */
656         int             _home_cost;     /* cost of (cursor_home)            */
657         int             _ll_cost;       /* cost of (cursor_to_ll)           */
658 #if USE_HARD_TABS
659         int             _ht_cost;       /* cost of (tab)                    */
660         int             _cbt_cost;      /* cost of (backtab)                */
661 #endif /* USE_HARD_TABS */
662         int             _cub1_cost;     /* cost of (cursor_left)            */
663         int             _cuf1_cost;     /* cost of (cursor_right)           */
664         int             _cud1_cost;     /* cost of (cursor_down)            */
665         int             _cuu1_cost;     /* cost of (cursor_up)              */
666         int             _cub_cost;      /* cost of (parm_cursor_left)       */
667         int             _cuf_cost;      /* cost of (parm_cursor_right)      */
668         int             _cud_cost;      /* cost of (parm_cursor_down)       */
669         int             _cuu_cost;      /* cost of (parm_cursor_up)         */
670         int             _hpa_cost;      /* cost of (column_address)         */
671         int             _vpa_cost;      /* cost of (row_address)            */
672         /* used in tty_update.c, must be chars */
673         int             _ed_cost;       /* cost of (clr_eos)                */
674         int             _el_cost;       /* cost of (clr_eol)                */
675         int             _el1_cost;      /* cost of (clr_bol)                */
676         int             _dch1_cost;     /* cost of (delete_character)       */
677         int             _ich1_cost;     /* cost of (insert_character)       */
678         int             _dch_cost;      /* cost of (parm_dch)               */
679         int             _ich_cost;      /* cost of (parm_ich)               */
680         int             _ech_cost;      /* cost of (erase_chars)            */
681         int             _rep_cost;      /* cost of (repeat_char)            */
682         int             _hpa_ch_cost;   /* cost of (column_address)         */
683         int             _cup_ch_cost;   /* cost of (cursor_address)         */
684         int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
685         int             _inline_cost;   /* cost of inline-move              */
686         int             _smir_cost;     /* cost of (enter_insert_mode)      */
687         int             _rmir_cost;     /* cost of (exit_insert_mode)       */
688         int             _ip_cost;       /* cost of (insert_padding)         */
689         /* used in lib_mvcur.c */
690         char *          _address_cursor;
691         /* used in tty_update.c */
692         int             _scrolling;     /* 1 if terminal's smart enough to  */
693
694         /* used in lib_color.c */
695         color_t         *_color_table;  /* screen's color palette            */
696         int             _color_count;   /* count of colors in palette        */
697         colorpair_t     *_color_pairs;  /* screen's color pair list          */
698         int             _pair_count;    /* count of color pairs              */
699 #if NCURSES_EXT_FUNCS
700         bool            _default_color; /* use default colors                */
701         bool            _has_sgr_39_49; /* has ECMA default color support    */
702         int             _default_fg;    /* assumed default foreground        */
703         int             _default_bg;    /* assumed default background        */
704 #endif
705         chtype          _ok_attributes; /* valid attributes for terminal     */
706         chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
707         chtype          _xmc_triggers;  /* attributes to process if xmc      */
708         chtype *        _acs_map;       /* the real alternate-charset map    */
709         bool *          _screen_acs_map;
710
711
712         /* used in lib_vidattr.c */
713         bool            _use_rmso;      /* true if we may use 'rmso'         */
714         bool            _use_rmul;      /* true if we may use 'rmul'         */
715
716         /*
717          * These data correspond to the state of the idcok() and idlok()
718          * functions.  A caveat is in order here:  the XSI and SVr4
719          * documentation specify that these functions apply to the window which
720          * is given as an argument.  However, ncurses implements this logic
721          * only for the newscr/curscr update process, _not_ per-window.
722          */
723         bool            _nc_sp_idlok;
724         bool            _nc_sp_idcok;
725 #define _nc_idlok SP->_nc_sp_idlok
726 #define _nc_idcok SP->_nc_sp_idcok
727
728         /*
729          * These are the data that support the mouse interface.
730          */
731         bool            _mouse_initialized;
732         MouseType       _mouse_type;
733         int             _maxclick;
734         bool            (*_mouse_event) (SCREEN *);
735         bool            (*_mouse_inline)(SCREEN *);
736         bool            (*_mouse_parse) (int);
737         void            (*_mouse_resume)(SCREEN *);
738         void            (*_mouse_wrap)  (SCREEN *);
739         int             _mouse_fd;      /* file-descriptor, if any */
740         bool            _mouse_active;  /* true if initialized */
741         mmask_t         _mouse_mask;
742         NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
743         MEVENT          _mouse_events[EV_MAX];  /* hold the last mouse event seen */
744         MEVENT          *_mouse_eventp; /* next free slot in event queue */
745
746 #if USE_GPM_SUPPORT
747         bool            _mouse_gpm_loaded;
748         bool            _mouse_gpm_found;
749 #ifdef HAVE_LIBDL
750         TYPE_gpm_fd     _mouse_gpm_fd;
751         TYPE_Gpm_Open   _mouse_Gpm_Open;
752         TYPE_Gpm_Close  _mouse_Gpm_Close;
753         TYPE_Gpm_GetEvent _mouse_Gpm_GetEvent;
754 #endif
755         Gpm_Connect     _mouse_gpm_connect;
756 #endif /* USE_GPM_SUPPORT */
757
758 #if USE_EMX_MOUSE
759         int             _emxmouse_wfd;
760         int             _emxmouse_thread;
761         int             _emxmouse_activated;
762         char            _emxmouse_buttons[4];
763 #endif
764
765 #if USE_SYSMOUSE
766         MEVENT          _sysmouse_fifo[FIFO_SIZE];
767         int             _sysmouse_head;
768         int             _sysmouse_tail;
769         int             _sysmouse_char_width;   /* character width */
770         int             _sysmouse_char_height;  /* character height */
771         int             _sysmouse_old_buttons;
772         int             _sysmouse_new_buttons;
773 #endif
774
775         /*
776          * This supports automatic resizing
777          */
778 #if USE_SIZECHANGE
779         int             (*_resize)(int,int);
780 #endif
781
782         /*
783          * These are data that support the proper handling of the panel stack on an
784          * per screen basis.
785          */
786         struct panelhook _panelHook;
787         /*
788          * Linked-list of all windows, to support '_nc_resizeall()' and
789          * '_nc_freeall()'
790          */
791         WINDOWLIST      *_nc_sp_windows;
792 #define _nc_windows SP->_nc_sp_windows
793
794         bool            _sig_winch;
795         SCREEN          *_next_screen;
796
797         /* hashes for old and new lines */
798         unsigned long   *oldhash, *newhash;
799         HASHMAP         *hashtab;
800         int             hashtab_len;
801         int             *_oldnum_list;
802         int             _oldnum_size;
803
804         bool            _cleanup;       /* cleanup after int/quit signal */
805         int             (*_outch)(int); /* output handler if not putc */
806
807         int             _legacy_coding; /* see use_legacy_coding() */
808
809 #if USE_REENTRANT
810         char            _ttytype[NAMESIZE];
811         int             _ESCDELAY;
812         int             _TABSIZE;
813         int             _LINES;
814         int             _COLS;
815 #ifdef TRACE
816         int             _outchars;
817         const char      *_tputs_trace;
818 #endif
819 #endif
820         /*
821          * ncurses/ncursesw are the same up to this point.
822          */
823 #if USE_WIDEC_SUPPORT
824         /* recent versions of 'screen' have partially-working support for
825          * UTF-8, but do not permit ACS at the same time (see tty_update.c).
826          */
827         bool            _screen_acs_fix;
828 #endif
829 };
830
831 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
832 extern NCURSES_EXPORT_VAR(SIG_ATOMIC_T) _nc_have_sigwinch;
833
834         WINDOWLIST {
835         WINDOW  win;    /* first, so WINDOW_EXT() works */
836         WINDOWLIST *next;
837 #ifdef _XOPEN_SOURCE_EXTENDED
838         char addch_work[(MB_LEN_MAX * 9) + 1];
839         unsigned addch_used;    /* number of bytes in addch_work[] */
840         int addch_x;            /* x-position for addch_work[] */
841         int addch_y;            /* y-position for addch_work[] */
842 #endif
843 };
844
845 #define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)
846
847 /* usually in <limits.h> */
848 #ifndef UCHAR_MAX
849 #define UCHAR_MAX 255
850 #endif
851
852 /* The terminfo source is assumed to be 7-bit ASCII */
853 #define is7bits(c)      ((unsigned)(c) < 128)
854
855 /* Checks for isprint() should be done on 8-bit characters (non-wide) */
856 #define is8bits(c)      ((unsigned)(c) <= UCHAR_MAX)
857
858 #ifndef min
859 #define min(a,b)        ((a) > (b)  ?  (b)  :  (a))
860 #endif
861
862 #ifndef max
863 #define max(a,b)        ((a) < (b)  ?  (b)  :  (a))
864 #endif
865
866 /* usually in <unistd.h> */
867 #ifndef STDIN_FILENO
868 #define STDIN_FILENO 0
869 #endif
870
871 #ifndef STDOUT_FILENO
872 #define STDOUT_FILENO 1
873 #endif
874
875 #ifndef STDERR_FILENO
876 #define STDERR_FILENO 2
877 #endif
878
879 #ifndef EXIT_SUCCESS
880 #define EXIT_SUCCESS 0
881 #endif
882
883 #ifndef EXIT_FAILURE
884 #define EXIT_FAILURE 1
885 #endif
886
887 #ifndef R_OK
888 #define R_OK    4               /* Test for read permission.  */
889 #endif
890 #ifndef W_OK
891 #define W_OK    2               /* Test for write permission.  */
892 #endif
893 #ifndef X_OK
894 #define X_OK    1               /* Test for execute permission.  */
895 #endif
896 #ifndef F_OK
897 #define F_OK    0               /* Test for existence.  */
898 #endif
899
900 #if HAVE_FCNTL_H
901 #include <fcntl.h>              /* may define O_BINARY  */
902 #endif
903
904 #ifndef O_BINARY
905 #define O_BINARY 0
906 #endif
907
908 #ifdef TRACE
909 #if USE_REENTRANT
910 #define COUNT_OUTCHARS(n) _nc_count_outchars(n);
911 #else
912 #define COUNT_OUTCHARS(n) _nc_outchars += (n);
913 #endif
914 #else
915 #define COUNT_OUTCHARS(n) /* nothing */
916 #endif
917
918 #define RESET_OUTCHARS() COUNT_OUTCHARS(-_nc_outchars)
919
920 #define UChar(c)        ((unsigned char)(c))
921 #define ChCharOf(c)     ((c) & (chtype)A_CHARTEXT)
922 #define ChAttrOf(c)     ((c) & (chtype)A_ATTRIBUTES)
923
924 #ifndef MB_LEN_MAX
925 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
926 #endif
927
928 #if USE_WIDEC_SUPPORT /* { */
929 #define isEILSEQ(status) ((status == (size_t)-1) && (errno == EILSEQ))
930
931 #define init_mb(state)  memset(&state, 0, sizeof(state))
932
933 #if NCURSES_EXT_COLORS
934 #define NulColor        , 0
935 #else
936 #define NulColor        /* nothing */
937 #endif
938
939 #define NulChar         0,0,0,0 /* FIXME: see CCHARW_MAX */
940 #define CharOf(c)       ((c).chars[0])
941 #define AttrOf(c)       ((c).attr)
942 #define AddAttr(c,a)    AttrOf(c) |=  ((a) & A_ATTRIBUTES)
943 #define RemAttr(c,a)    AttrOf(c) &= ~((a) & A_ATTRIBUTES)
944 #define SetAttr(c,a)    AttrOf(c) =   ((a) & A_ATTRIBUTES) | WidecExt(c)
945 #define NewChar2(c,a)   { a, { c, NulChar } NulColor }
946 #define NewChar(ch)     NewChar2(ChCharOf(ch), ChAttrOf(ch))
947 #define CharEq(a,b)     (!memcmp(&(a), &(b), sizeof(a)))
948 #define SetChar(ch,c,a) do {                                                        \
949                             NCURSES_CH_T *_cp = &ch;                                \
950                             memset(_cp, 0, sizeof(ch));                             \
951                             _cp->chars[0] = (c);                                            \
952                             _cp->attr = (a);                                        \
953                             if_EXT_COLORS(SetPair(ch, PAIR_NUMBER(a)));             \
954                         } while (0)
955 #define CHREF(wch)      (&wch)
956 #define CHDEREF(wch)    (*wch)
957 #define ARG_CH_T        NCURSES_CH_T *
958 #define CARG_CH_T       const NCURSES_CH_T *
959 #define PUTC_DATA       char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
960                         mbstate_t PUT_st; wchar_t PUTC_ch
961 #define PUTC_INIT       init_mb (PUT_st)
962 #define PUTC(ch,b)      do { if(!isWidecExt(ch)) {                                  \
963                         if (Charable(ch)) {                                         \
964                             fputc(CharOf(ch), b);                                   \
965                             COUNT_OUTCHARS(1);                                      \
966                         } else {                                                    \
967                             PUTC_INIT;                                              \
968                             for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {       \
969                                 PUTC_ch = (ch).chars[PUTC_i];                       \
970                                 if (PUTC_ch == L'\0')                               \
971                                     break;                                          \
972                                 PUTC_n = wcrtomb(PUTC_buf,                          \
973                                                  (ch).chars[PUTC_i], &PUT_st);      \
974                                 if (PUTC_n <= 0) {                                  \
975                                     if (PUTC_ch && is8bits(PUTC_ch) && PUTC_i == 0) \
976                                         putc(PUTC_ch,b);                            \
977                                     break;                                          \
978                                 }                                                   \
979                                 fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b);          \
980                             }                                                       \
981                             COUNT_OUTCHARS(PUTC_i);                                 \
982                         } } } while (0)
983
984 #define BLANK           { WA_NORMAL, {' '} NulColor }
985 #define ZEROS           { WA_NORMAL, {'\0'} NulColor }
986 #define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
987
988         /*
989          * Wide characters cannot be represented in the A_CHARTEXT mask of
990          * attr_t's but an application might have set a narrow character there.
991          * But even in that case, it would only be a printable character, or
992          * zero.  Otherwise we can use those bits to tell if a cell is the
993          * first or extension part of a wide character.
994          */
995 #define WidecExt(ch)    (AttrOf(ch) & A_CHARTEXT)
996 #define isWidecBase(ch) (WidecExt(ch) == 1)
997 #define isWidecExt(ch)  (WidecExt(ch) > 1 && WidecExt(ch) < 32)
998 #define SetWidecExt(dst, ext)   AttrOf(dst) &= ~A_CHARTEXT,             \
999                                 AttrOf(dst) |= (ext + 1)
1000
1001 #define if_WIDEC(code)  code
1002 #define Charable(ch)    ((SP != 0 && SP->_legacy_coding)                \
1003                          || (AttrOf(ch) & A_ALTCHARSET)                 \
1004                          || (!isWidecExt(ch) &&                         \
1005                              (ch).chars[1] == L'\0' &&                  \
1006                              _nc_is_charable(CharOf(ch))))
1007
1008 #define L(ch)           L ## ch
1009 #else /* }{ */
1010 #define CharOf(c)       ChCharOf(c)
1011 #define AttrOf(c)       ChAttrOf(c)
1012 #define AddAttr(c,a)    c |= (a)
1013 #define RemAttr(c,a)    c &= ~((a) & A_ATTRIBUTES)
1014 #define SetAttr(c,a)    c = ((c) & ~A_ATTRIBUTES) | (a)
1015 #define NewChar(ch)     (ch)
1016 #define NewChar2(c,a)   ((c) | (a))
1017 #define CharEq(a,b)     ((a) == (b))
1018 #define SetChar(ch,c,a) ch = (c) | (a)
1019 #define CHREF(wch)      wch
1020 #define CHDEREF(wch)    wch
1021 #define ARG_CH_T        NCURSES_CH_T
1022 #define CARG_CH_T       NCURSES_CH_T
1023 #define PUTC_DATA       int data = 0
1024 #define PUTC(ch,b)      do { data = CharOf(ch); putc(data,b); } while (0)
1025
1026 #define BLANK           (' '|A_NORMAL)
1027 #define ZEROS           ('\0'|A_NORMAL)
1028 #define ISBLANK(ch)     (CharOf(ch) == ' ')
1029
1030 #define isWidecExt(ch)  (0)
1031 #define if_WIDEC(code) /* nothing */
1032
1033 #define L(ch)           ch
1034 #endif /* } */
1035
1036 #define AttrOfD(ch)     AttrOf(CHDEREF(ch))
1037 #define CharOfD(ch)     CharOf(CHDEREF(ch))
1038 #define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
1039
1040 #define BLANK_ATTR      A_NORMAL
1041 #define BLANK_TEXT      L(' ')
1042
1043 #define CHANGED     -1
1044
1045 #define LEGALYX(w, y, x) \
1046               ((w) != 0 && \
1047                 ((x) >= 0 && (x) <= (w)->_maxx && \
1048                  (y) >= 0 && (y) <= (w)->_maxy))
1049
1050 #define CHANGED_CELL(line,col) \
1051         if (line->firstchar == _NOCHANGE) \
1052                 line->firstchar = line->lastchar = col; \
1053         else if ((col) < line->firstchar) \
1054                 line->firstchar = col; \
1055         else if ((col) > line->lastchar) \
1056                 line->lastchar = col
1057
1058 #define CHANGED_RANGE(line,start,end) \
1059         if (line->firstchar == _NOCHANGE \
1060          || line->firstchar > (start)) \
1061                 line->firstchar = start; \
1062         if (line->lastchar == _NOCHANGE \
1063          || line->lastchar < (end)) \
1064                 line->lastchar = end
1065
1066 #define CHANGED_TO_EOL(line,start,end) \
1067         if (line->firstchar == _NOCHANGE \
1068          || line->firstchar > (start)) \
1069                 line->firstchar = start; \
1070         line->lastchar = end
1071
1072 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
1073
1074 #define FreeIfNeeded(p)  if ((p) != 0) free(p)
1075
1076 /* FreeAndNull() is not a comma-separated expression because some compilers
1077  * do not accept a mixture of void with values.
1078  */
1079 #define FreeAndNull(p)   free(p); p = 0
1080
1081 #include <nc_alloc.h>
1082
1083 /*
1084  * TTY bit definition for converting tabs to spaces.
1085  */
1086 #ifdef TAB3
1087 # define OFLAGS_TABS TAB3       /* POSIX specifies TAB3 */
1088 #else
1089 # ifdef XTABS
1090 #  define OFLAGS_TABS XTABS     /* XTABS is usually the "same" */
1091 # else
1092 #  ifdef OXTABS
1093 #   define OFLAGS_TABS OXTABS   /* the traditional BSD equivalent */
1094 #  else
1095 #   define OFLAGS_TABS 0
1096 #  endif
1097 # endif
1098 #endif
1099
1100 /*
1101  * Prefixes for call/return points of library function traces.  We use these to
1102  * instrument the public functions so that the traces can be easily transformed
1103  * into regression scripts.
1104  */
1105 #define T_CALLED(fmt) "called {" fmt
1106 #define T_CREATE(fmt) "create :" fmt
1107 #define T_RETURN(fmt) "return }" fmt
1108
1109 #ifdef TRACE
1110
1111 #if USE_REENTRANT
1112 #define TPUTS_TRACE(s)  _nc_set_tputs_trace(s);
1113 #else
1114 #define TPUTS_TRACE(s)  _nc_tputs_trace = s;
1115 #endif
1116
1117 #define START_TRACE() \
1118         if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
1119             int t = _nc_getenv_num("NCURSES_TRACE"); \
1120             if (t >= 0) \
1121                 trace((unsigned) t); \
1122         }
1123
1124 /*
1125  * Many of the _tracef() calls use static buffers; lock the trace state before
1126  * trying to fill them.
1127  */
1128 #if USE_REENTRANT
1129 #define USE_TRACEF(mask) _nc_use_tracef(mask)
1130 extern NCURSES_EXPORT(int)      _nc_use_tracef (unsigned);
1131 extern NCURSES_EXPORT(void)     _nc_locked_tracef (const char *, ...) GCC_PRINTFLIKE(1,2);
1132 #else
1133 #define USE_TRACEF(mask) (_nc_tracing & (mask))
1134 #define _nc_locked_tracef _tracef
1135 #endif
1136
1137 #define TR(n, a)        if (USE_TRACEF(n)) _nc_locked_tracef a
1138 #define T(a)            TR(TRACE_CALLS, a)
1139 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
1140
1141 #define returnAttr(code)        TRACE_RETURN(code,attr_t)
1142 #define returnBits(code)        TRACE_RETURN(code,unsigned)
1143 #define returnBool(code)        TRACE_RETURN(code,bool)
1144 #define returnCPtr(code)        TRACE_RETURN(code,cptr)
1145 #define returnCVoidPtr(code)    TRACE_RETURN(code,cvoid_ptr)
1146 #define returnChar(code)        TRACE_RETURN(code,chtype)
1147 #define returnCode(code)        TRACE_RETURN(code,int)
1148 #define returnPtr(code)         TRACE_RETURN(code,ptr)
1149 #define returnSP(code)          TRACE_RETURN(code,sp)
1150 #define returnVoid              T((T_RETURN(""))); return
1151 #define returnVoidPtr(code)     TRACE_RETURN(code,void_ptr)
1152 #define returnWin(code)         TRACE_RETURN(code,win)
1153
1154 extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (NCURSES_BOOL);
1155 extern NCURSES_EXPORT(NCURSES_CONST void *) _nc_retrace_cvoid_ptr (NCURSES_CONST void *);
1156 extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
1157 extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
1158 extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
1159 extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
1160 extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(TTY *tty);
1161 extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
1162 extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
1163 extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
1164 extern NCURSES_EXPORT(const char *)     _nc_retrace_cptr (const char *);
1165 extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
1166 extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
1167 extern NCURSES_EXPORT(void *)           _nc_retrace_void_ptr (void *);
1168 extern NCURSES_EXPORT(void)             _nc_fifo_dump (void);
1169
1170 #if USE_REENTRANT
1171 NCURSES_WRAPPED_VAR(long, _nc_outchars);
1172 NCURSES_WRAPPED_VAR(const char *, _nc_tputs_trace);
1173 #define _nc_outchars       NCURSES_PUBLIC_VAR(_nc_outchars())
1174 #define _nc_tputs_trace    NCURSES_PUBLIC_VAR(_nc_tputs_trace())
1175 extern NCURSES_EXPORT(void)             _nc_set_tputs_trace (const char *);
1176 extern NCURSES_EXPORT(void)             _nc_count_outchars (long);
1177 #else
1178 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
1179 extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
1180 #endif
1181
1182 extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;
1183
1184 #if USE_WIDEC_SUPPORT
1185 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
1186 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
1187 #endif
1188
1189 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const NCURSES_CH_T *, int);
1190 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const NCURSES_CH_T *, int);
1191
1192 #else /* !TRACE */
1193
1194 #define START_TRACE() /* nothing */
1195
1196 #define T(a)
1197 #define TR(n, a)
1198 #define TPUTS_TRACE(s)
1199
1200 #define returnAttr(code)        return code
1201 #define returnBits(code)        return code
1202 #define returnBool(code)        return code
1203 #define returnCPtr(code)        return code
1204 #define returnCVoidPtr(code)    return code
1205 #define returnChar(code)        return code
1206 #define returnCode(code)        return code
1207 #define returnPtr(code)         return code
1208 #define returnSP(code)          return code
1209 #define returnVoid              return
1210 #define returnVoidPtr(code)     return code
1211 #define returnWin(code)         return code
1212
1213 #endif /* TRACE/!TRACE */
1214
1215 /*
1216  * Return-codes for tgetent() and friends.
1217  */
1218 #define TGETENT_YES  1          /* entry is found */
1219 #define TGETENT_NO   0          /* entry is not found */
1220 #define TGETENT_ERR -1          /* an error occurred */
1221
1222 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
1223 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
1224
1225 #define empty_module(name) \
1226 extern  NCURSES_EXPORT(void) name (void); \
1227         NCURSES_EXPORT(void) name (void) { }
1228
1229 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
1230 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
1231 #define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)
1232
1233 #define toggle_attr_on(S,at) {\
1234    if (PAIR_NUMBER(at) > 0) {\
1235       (S) = ((S) & ALL_BUT_COLOR) | (at);\
1236    } else {\
1237       (S) |= (at);\
1238    }\
1239    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1240
1241
1242 #define toggle_attr_off(S,at) {\
1243    if (PAIR_NUMBER(at) > 0) {\
1244       (S) &= ~(at|A_COLOR);\
1245    } else {\
1246       (S) &= ~(at);\
1247    }\
1248    TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
1249
1250 #define DelCharCost(count) \
1251                 ((parm_dch != 0) \
1252                 ? SP->_dch_cost \
1253                 : ((delete_character != 0) \
1254                         ? (SP->_dch1_cost * count) \
1255                         : INFINITY))
1256
1257 #define InsCharCost(count) \
1258                 ((parm_ich != 0) \
1259                 ? SP->_ich_cost \
1260                 : ((enter_insert_mode && exit_insert_mode) \
1261                   ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
1262                   : ((insert_character != 0) \
1263                     ? ((SP->_ich1_cost + SP->_ip_cost) * count) \
1264                     : INFINITY)))
1265
1266 #if USE_XMC_SUPPORT
1267 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) { \
1268                                 attr_t chg = AttrOf(SCREEN_ATTRS(SP)); \
1269                                 VIDATTR(AttrOf(c), GetPair(c)); \
1270                                 if (magic_cookie_glitch > 0 \
1271                                  && XMC_CHANGES((chg ^ AttrOf(SCREEN_ATTRS(SP))))) { \
1272                                         T(("%s @%d before glitch %d,%d", \
1273                                                 __FILE__, __LINE__, \
1274                                                 SP->_cursrow, \
1275                                                 SP->_curscol)); \
1276                                         _nc_do_xmc_glitch(chg); \
1277                                 } \
1278                         }
1279 #else
1280 #define UpdateAttrs(c)  if (!SameAttrOf(SCREEN_ATTRS(SP), c)) \
1281                                 VIDATTR(AttrOf(c), GetPair(c));
1282 #endif
1283
1284 /*
1285  * Macros to make additional parameter to implement wgetch_events()
1286  */
1287 #ifdef NCURSES_WGETCH_EVENTS
1288 #define EVENTLIST_0th(param) param
1289 #define EVENTLIST_1st(param) param
1290 #define EVENTLIST_2nd(param) , param
1291 #else
1292 #define EVENTLIST_0th(param) void
1293 #define EVENTLIST_1st(param) /* nothing */
1294 #define EVENTLIST_2nd(param) /* nothing */
1295 #endif
1296
1297 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
1298
1299 #undef  toggle_attr_on
1300 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
1301 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
1302
1303 #undef  toggle_attr_off
1304 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
1305 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
1306
1307 #undef  DelCharCost
1308 #define DelCharCost(count) _nc_DelCharCost(count)
1309 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
1310
1311 #undef  InsCharCost
1312 #define InsCharCost(count) _nc_InsCharCost(count)
1313 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
1314
1315 #undef  UpdateAttrs
1316 #define UpdateAttrs(c) _nc_UpdateAttrs(c)
1317 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (NCURSES_CH_T);
1318
1319 #else
1320
1321 extern NCURSES_EXPORT(void) _nc_expanded (void);
1322
1323 #endif
1324
1325 #if !HAVE_GETCWD
1326 #define getcwd(buf,len) getwd(buf)
1327 #endif
1328
1329 /* charable.c */
1330 #if USE_WIDEC_SUPPORT
1331 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
1332 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
1333 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
1334 #endif
1335
1336 /* comp_captab.c */
1337 typedef struct {
1338         short   nte_name;       /* offset of name to hash on */
1339         int     nte_type;       /* BOOLEAN, NUMBER or STRING */
1340         short   nte_index;      /* index of associated variable in its array */
1341         short   nte_link;       /* index in table of next hash, or -1 */
1342 } name_table_data;
1343
1344 typedef struct
1345 {
1346         short   from;
1347         short   to;
1348         short   source;
1349 } alias_table_data;
1350
1351 /* doupdate.c */
1352 #if USE_XMC_SUPPORT
1353 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
1354 #endif
1355
1356 /* hardscroll.c */
1357 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
1358 extern NCURSES_EXPORT(void) _nc_linedump (void);
1359 #endif
1360
1361 /* lib_acs.c */
1362 extern NCURSES_EXPORT(void) _nc_init_acs (void);        /* corresponds to traditional 'init_acs()' */
1363 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int);  /* used by 'tack' program */
1364
1365 /* lib_addch.c */
1366 #if USE_WIDEC_SUPPORT
1367 NCURSES_EXPORT(int) _nc_build_wch(WINDOW *win, ARG_CH_T ch);
1368 #endif
1369
1370 /* lib_addstr.c */
1371 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1372 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
1373 #endif
1374
1375 /* lib_color.c */
1376 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
1377
1378 /* lib_getch.c */
1379 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
1380
1381 /* lib_insch.c */
1382 extern NCURSES_EXPORT(int) _nc_insert_ch(WINDOW *, chtype);
1383
1384 /* lib_mvcur.c */
1385 #define INFINITY        1000000 /* cost: too high to use */
1386
1387 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
1388 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
1389 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
1390
1391 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
1392
1393 extern NCURSES_EXPORT(void) _nc_screen_init (void);
1394 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
1395 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
1396
1397 /* lib_mouse.c */
1398 extern NCURSES_EXPORT(int) _nc_has_mouse (void);
1399
1400 /* lib_mvcur.c */
1401 #define INFINITY        1000000 /* cost: too high to use */
1402 #define BAUDBYTE        9       /* 9 = 7 bits + 1 parity + 1 stop */
1403
1404 /* lib_setup.c */
1405 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
1406 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
1407 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(void);
1408 extern NCURSES_EXPORT(int) _nc_setupterm(NCURSES_CONST char *, int, int *, bool);
1409 extern NCURSES_EXPORT(void) _nc_get_screensize(int *, int *);
1410
1411 /* lib_tstp.c */
1412 #if USE_SIGWINCH
1413 extern NCURSES_EXPORT(int) _nc_handle_sigwinch(int);
1414 #else
1415 #define _nc_handle_sigwinch(a) /* nothing */
1416 #endif
1417
1418 /* lib_wacs.c */
1419 #if USE_WIDEC_SUPPORT
1420 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
1421 #endif
1422
1423 typedef struct {
1424     char *s_head;       /* beginning of the string (may be null) */
1425     char *s_tail;       /* end of the string (may be null) */
1426     size_t s_size;      /* current remaining size available */
1427     size_t s_init;      /* total size available */
1428 } string_desc;
1429
1430 /* strings.c */
1431 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
1432 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
1433 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
1434 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
1435 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
1436
1437 #if !HAVE_STRSTR
1438 #define strstr _nc_strstr
1439 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
1440 #endif
1441
1442 /* safe_sprintf.c */
1443 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
1444
1445 /* tries.c */
1446 extern NCURSES_EXPORT(int) _nc_add_to_try (TRIES **, const char *, unsigned);
1447 extern NCURSES_EXPORT(char *) _nc_expand_try (TRIES *, unsigned, int *, size_t);
1448 extern NCURSES_EXPORT(int) _nc_remove_key (TRIES **, unsigned);
1449 extern NCURSES_EXPORT(int) _nc_remove_string (TRIES **, const char *);
1450
1451 /* elsewhere ... */
1452 extern NCURSES_EXPORT(ENTRY *) _nc_delink_entry(ENTRY *, TERMTYPE *);
1453 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1454 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1455 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1456 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1457 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1458 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1459 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1460 extern NCURSES_EXPORT(int) _nc_keypad (bool);
1461 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1462 extern NCURSES_EXPORT(int) _nc_outch (int);
1463 extern NCURSES_EXPORT(int) _nc_read_termcap_entry (const char *const, TERMTYPE *const);
1464 extern NCURSES_EXPORT(int) _nc_setupscreen (int, int, FILE *, bool, int);
1465 extern NCURSES_EXPORT(int) _nc_timed_wait(int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1466 extern NCURSES_EXPORT(void) _nc_do_color (short, short, bool, int (*)(int));
1467 extern NCURSES_EXPORT(void) _nc_flush (void);
1468 extern NCURSES_EXPORT(void) _nc_free_entry(ENTRY *, TERMTYPE *);
1469 extern NCURSES_EXPORT(void) _nc_freeall (void);
1470 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1471 extern NCURSES_EXPORT(void) _nc_init_keytry (void);
1472 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1473 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1474 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1475 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1476 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1477 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1478 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1479 extern NCURSES_EXPORT(void) _nc_trace_tries (TRIES *);
1480
1481 #if NO_LEAKS
1482 extern NCURSES_EXPORT(void) _nc_alloc_entry_leaks(void);
1483 extern NCURSES_EXPORT(void) _nc_captoinfo_leaks(void);
1484 extern NCURSES_EXPORT(void) _nc_comp_captab_leaks(void);
1485 extern NCURSES_EXPORT(void) _nc_comp_scan_leaks(void);
1486 extern NCURSES_EXPORT(void) _nc_keyname_leaks(void);
1487 extern NCURSES_EXPORT(void) _nc_tgetent_leaks(void);
1488 #endif
1489
1490 #ifndef USE_TERMLIB
1491 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1492 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1493 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, NCURSES_SIZE_T const, NCURSES_SIZE_T const, NCURSES_CH_T);
1494 #endif
1495
1496 #if USE_WIDEC_SUPPORT && !defined(USE_TERMLIB)
1497 #ifdef linux
1498 extern NCURSES_EXPORT(size_t) _nc_wcrtomb (char *, wchar_t, mbstate_t *);
1499 #else
1500 #define _nc_wcrtomb(s,wc,ps) wcrtomb(s,wc,ps)
1501 #endif
1502 #endif
1503
1504 #if USE_SIZECHANGE
1505 extern NCURSES_EXPORT(void) _nc_update_screensize (void);
1506 #endif
1507
1508 #if HAVE_RESIZETERM
1509 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1510 #else
1511 #define _nc_resize_margins(wp) /* nothing */
1512 #endif
1513
1514 #ifdef NCURSES_WGETCH_EVENTS
1515 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1516 #else
1517 #define wgetch_events(win, evl) wgetch(win)
1518 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1519 #endif
1520
1521 /*
1522  * Not everyone has vsscanf(), but we'd like to use it for scanw().
1523  */
1524 #if !HAVE_VSSCANF
1525 extern int vsscanf(const char *str, const char *format, va_list __arg);
1526 #endif
1527
1528 /* scroll indices */
1529 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1530
1531 #define USE_SETBUF_0 0
1532
1533 #define NC_BUFFERED(flag) _nc_set_buffer(SP->_ofp, flag)
1534
1535 #define NC_OUTPUT ((SP != 0) ? SP->_ofp : stdout)
1536
1537 /*
1538  * On systems with a broken linker, define 'SP' as a function to force the
1539  * linker to pull in the data-only module with 'SP'.
1540  */
1541 #if BROKEN_LINKER
1542 #define SP _nc_screen()
1543 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1544 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1545 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1546 #else
1547 /* current screen is private data; avoid possible linking conflicts too */
1548 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1549 #define _nc_alloc_screen() ((SP = typeCalloc(SCREEN, 1)) != 0)
1550 #define _nc_set_screen(sp) SP = sp
1551 #endif
1552
1553 /*
1554  * We don't want to use the lines or columns capabilities internally, because
1555  * if the application is running multiple screens under X, it's quite possible
1556  * they could all have type xterm but have different sizes!  So...
1557  */
1558 #define screen_lines    SP->_lines
1559 #define screen_columns  SP->_columns
1560
1561 extern NCURSES_EXPORT_VAR(int) _nc_slk_format;  /* != 0 if slk_init() called */
1562 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1563
1564 /*
1565  * Some constants related to SLK's
1566  */
1567 #define MAX_SKEY_OLD       8    /* count of soft keys */
1568 #define MAX_SKEY_LEN_OLD   8    /* max length of soft key text */
1569 #define MAX_SKEY_PC       12    /* This is what most PC's have */
1570 #define MAX_SKEY_LEN_PC    5
1571
1572 /* Macro to check whether or not we use a standard format */
1573 #define SLK_STDFMT(fmt) (fmt < 3)
1574 /* Macro to determine height of label window */
1575 #define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1576
1577 #define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1578 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1579
1580 extern NCURSES_EXPORT(int) _nc_ripoffline (int line, int (*init)(WINDOW *,int));
1581
1582 /*
1583  * Common error messages
1584  */
1585 #define MSG_NO_MEMORY "Out of memory"
1586 #define MSG_NO_INPUTS "Premature EOF"
1587
1588 #ifdef __cplusplus
1589 }
1590 #endif
1591
1592 #endif /* CURSES_PRIV_H */