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