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