1 /****************************************************************************
2 * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
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-2002 *
33 ****************************************************************************/
37 * $Id: curses.priv.h,v 1.255 2004/02/01 01:05:58 Stanislav.Ievlev Exp $
41 * Header file for curses library objects which are private to
47 #define CURSES_PRIV_H 1
49 #include <ncurses_dll.h>
55 #include <ncurses_cfg.h>
58 #define MODULE_ID(id) static const char Ident[] = id;
60 #define MODULE_ID(id) /*nothing*/
65 #include <sys/types.h>
71 #if HAVE_SYS_BSDTYPES_H
72 #include <sys/bsdtypes.h> /* needed for ISC */
77 #elif HAVE_SYS_PARAM_H
78 # include <sys/param.h>
82 # if defined(_POSIX_PATH_MAX)
83 # define PATH_MAX _POSIX_PATH_MAX
84 # elif defined(MAXPATHLEN)
85 # define PATH_MAX MAXPATHLEN
87 # define PATH_MAX 255 /* the Posix minimum path-size */
100 #include <nc_panel.h>
102 /* Some systems have a broken 'select()', but workable 'poll()'. Use that */
103 #if HAVE_WORKING_POLL
104 #define USE_FUNC_POLL 1
108 #include <sys/poll.h>
111 #define USE_FUNC_POLL 0
114 /* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
117 /* Alessandro Rubini's GPM (general-purpose mouse) */
118 #if HAVE_LIBGPM && HAVE_GPM_H
119 #define USE_GPM_SUPPORT 1
121 #define USE_GPM_SUPPORT 0
124 /* QNX mouse support */
125 #if defined(__QNX__) && !defined(__QNXNTO__)
126 #define USE_QNX_MOUSE 1
128 #define USE_QNX_MOUSE 0
131 /* EMX mouse support */
133 #define USE_EMX_MOUSE 1
135 #define USE_EMX_MOUSE 0
138 #define DEFAULT_MAXCLICK 166
139 #define EV_MAX 8 /* size of mouse circular event queue */
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.
145 #if !NCURSES_EXT_FUNCS
146 #undef HAVE_SIZECHANGE
147 #define HAVE_SIZECHANGE 0
150 #if HAVE_SIZECHANGE && defined(SIGWINCH)
151 #define USE_SIZECHANGE 1
153 #define USE_SIZECHANGE 0
155 #define USE_SIGWINCH 0
159 * If desired, one can configure this, disabling environment variables that
160 * point to custom terminfo/termcap locations.
162 #ifdef USE_ROOT_ENVIRON
163 #define use_terminfo_vars() 1
165 #define use_terminfo_vars() _nc_env_access()
166 extern NCURSES_EXPORT(int) _nc_env_access (void);
170 * Not all platforms have memmove; some have an equivalent bcopy. (Some may
174 #define memmove(d,s,n) bcopy(s,d,n)
176 #define memmove(d,s,n) _nc_memmove(d,s,n)
177 extern NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
181 * Scroll hints are useless when hashmap is used
183 #if !USE_SCROLL_HINTS
185 #define USE_SCROLL_HINTS 1
187 #define USE_SCROLL_HINTS 0
192 #define if_USE_SCROLL_HINTS(stmt) stmt
194 #define if_USE_SCROLL_HINTS(stmt) /*nothing*/
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.
206 struct tries *child; /* ptr to child. NULL if none */
207 struct tries *sibling; /* ptr to sibling. NULL if none */
208 unsigned char ch; /* character at this node */
209 unsigned short value; /* code of string so far. 0 if none. */
213 * Definitions for color pairs
215 #define C_SHIFT 8 /* we need more bits than there are colors */
216 #define C_MASK ((1 << C_SHIFT) - 1)
218 #define PAIR_OF(fg, bg) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
221 * Common/troublesome character definitions
228 #define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"
231 * Structure for palette tables
236 short red, green, blue; /* what color_content() returns */
237 short r, g, b; /* params to init_color() */
238 int init; /* true if we called init_color() */
242 #define MAXCOLUMNS 135
244 #define FIFO_SIZE MAXCOLUMNS+2 /* for nocbreak mode input */
248 #define WINDOWLIST struct _win_list
250 #if USE_WIDEC_SUPPORT
251 #define _nc_bkgd _bkgrnd
253 #undef _XOPEN_SOURCE_EXTENDED
254 #define _nc_bkgd _bkgd
255 #define wgetbkgrnd(win, wch) *wch = win->_bkgd
256 #define wbkgrnd wbkgd
259 #include <curses.h> /* we'll use -Ipath directive to get the right one! */
264 NCURSES_CH_T *text; /* text of the line */
265 NCURSES_SIZE_T firstchar; /* first changed character in the line */
266 NCURSES_SIZE_T lastchar; /* last changed character in the line */
267 NCURSES_SIZE_T oldindex; /* index of the line at last update */
271 M_XTERM = -1 /* use xterm's mouse tracking? */
272 ,M_NONE = 0 /* no mouse device */
277 ,M_SYSMOUSE /* FreeBSD sysmouse on console */
282 * Structure for soft labels.
287 char *ent_text; /* text for the label */
288 char *form_text; /* formatted text (left/center/...) */
289 int ent_x; /* x coordinate of this field */
290 char dirty; /* this label has changed */
291 char visible; /* field is visible */
295 char dirty; /* all labels have changed */
296 char hidden; /* soft labels are hidden */
299 short maxlab; /* number of available labels */
300 short labcnt; /* number of allocated labels */
301 short maxlen; /* length of labels */
302 chtype attr; /* soft label attribute */
306 unsigned long hashval;
307 int oldcount, newcount;
308 int oldindex, newindex;
312 int line; /* lines to take, < 0 => from bottom*/
313 int (*hook)(WINDOW *, int); /* callback for user */
314 WINDOW *w; /* maybe we need this for cleanup */
318 int _ifd; /* input file ptr for screen */
319 FILE *_ofp; /* output file ptr for screen */
320 char *_setbuf; /* buffered I/O for output */
321 int _buffered; /* setvbuf uses _setbuf data */
322 int _checkfd; /* filedesc for typeahead check */
323 TERMINAL *_term; /* terminal type information */
324 short _lines; /* screen lines */
325 short _columns; /* screen columns */
327 short _lines_avail; /* lines available for stdscr */
328 short _topstolen; /* lines stolen from top */
329 ripoff_t _rippedoff[5]; /* list of lines stolen */
330 int _rip_count; /* ...and total lines stolen */
332 WINDOW *_curscr; /* current screen */
333 WINDOW *_newscr; /* virtual screen to be updated to */
334 WINDOW *_stdscr; /* screen's full-window context */
336 struct tries *_keytry; /* "Try" for use with keypad mode */
337 struct tries *_key_ok; /* Disabled keys via keyok(,FALSE) */
338 bool _tried; /* keypad mode was initialized */
339 bool _keypad_on; /* keypad mode is currently on */
341 bool _called_wgetch; /* check for recursion in wgetch() */
342 int _fifo[FIFO_SIZE]; /* input push-back buffer */
343 short _fifohead, /* head of fifo queue */
344 _fifotail, /* tail of fifo queue */
345 _fifopeek, /* where to peek for next char */
346 _fifohold; /* set if breakout marked */
348 int _endwin; /* are we out of window mode? */
349 attr_t _current_attr; /* terminal attribute current set */
350 int _coloron; /* is color enabled? */
351 int _color_defs; /* are colors modified */
352 int _cursor; /* visibility of the cursor */
353 int _cursrow; /* physical cursor row */
354 int _curscol; /* physical cursor column */
355 bool _notty; /* true if we cannot switch non-tty */
356 int _nl; /* True if NL -> CR/NL is on */
357 int _raw; /* True if in raw mode */
358 int _cbreak; /* 1 if in cbreak mode */
359 /* > 1 if in halfdelay mode */
360 int _echo; /* True if echo on */
361 int _use_meta; /* use the meta key? */
362 SLK *_slk; /* ptr to soft key struct / NULL */
363 int slk_format; /* selected format for this screen */
364 /* cursor movement costs; units are 10ths of milliseconds */
365 #if NCURSES_NO_PADDING
366 int _no_padding; /* flag to set if padding disabled */
368 int _char_padding; /* cost of character put */
369 int _cr_cost; /* cost of (carriage_return) */
370 int _cup_cost; /* cost of (cursor_address) */
371 int _home_cost; /* cost of (cursor_home) */
372 int _ll_cost; /* cost of (cursor_to_ll) */
374 int _ht_cost; /* cost of (tab) */
375 int _cbt_cost; /* cost of (backtab) */
376 #endif /* USE_HARD_TABS */
377 int _cub1_cost; /* cost of (cursor_left) */
378 int _cuf1_cost; /* cost of (cursor_right) */
379 int _cud1_cost; /* cost of (cursor_down) */
380 int _cuu1_cost; /* cost of (cursor_up) */
381 int _cub_cost; /* cost of (parm_cursor_left) */
382 int _cuf_cost; /* cost of (parm_cursor_right) */
383 int _cud_cost; /* cost of (parm_cursor_down) */
384 int _cuu_cost; /* cost of (parm_cursor_up) */
385 int _hpa_cost; /* cost of (column_address) */
386 int _vpa_cost; /* cost of (row_address) */
387 /* used in tty_update.c, must be chars */
388 int _ed_cost; /* cost of (clr_eos) */
389 int _el_cost; /* cost of (clr_eol) */
390 int _el1_cost; /* cost of (clr_bol) */
391 int _dch1_cost; /* cost of (delete_character) */
392 int _ich1_cost; /* cost of (insert_character) */
393 int _dch_cost; /* cost of (parm_dch) */
394 int _ich_cost; /* cost of (parm_ich) */
395 int _ech_cost; /* cost of (erase_chars) */
396 int _rep_cost; /* cost of (repeat_char) */
397 int _hpa_ch_cost; /* cost of (column_address) */
398 int _cup_ch_cost; /* cost of (cursor_address) */
399 int _cuf_ch_cost; /* cost of (parm_cursor_right) */
400 int _inline_cost; /* cost of inline-move */
401 int _smir_cost; /* cost of (enter_insert_mode) */
402 int _rmir_cost; /* cost of (exit_insert_mode) */
403 int _ip_cost; /* cost of (insert_padding) */
404 /* used in lib_mvcur.c */
405 char * _address_cursor;
406 /* used in tty_update.c */
407 int _scrolling; /* 1 if terminal's smart enough to */
409 /* used in lib_color.c */
410 color_t *_color_table; /* screen's color palette */
411 int _color_count; /* count of colors in palette */
412 unsigned short *_color_pairs; /* screen's color pair list */
413 int _pair_count; /* count of color pairs */
414 #if NCURSES_EXT_FUNCS
415 bool _default_color; /* use default colors */
416 bool _has_sgr_39_49; /* has ECMA default color support */
417 int _default_fg; /* assumed default foreground */
418 int _default_bg; /* assumed default background */
420 chtype _xmc_suppress; /* attributes to suppress if xmc */
421 chtype _xmc_triggers; /* attributes to process if xmc */
422 chtype _acs_map[ACS_LEN]; /* the real alternate-charset map */
424 /* used in lib_vidattr.c */
425 bool _use_rmso; /* true if we may use 'rmso' */
426 bool _use_rmul; /* true if we may use 'rmul' */
429 * These data correspond to the state of the idcok() and idlok()
430 * functions. A caveat is in order here: the XSI and SVr4
431 * documentation specify that these functions apply to the window which
432 * is given as an argument. However, ncurses implements this logic
433 * only for the newscr/curscr update process, _not_ per-window.
437 #define _nc_idlok SP->_nc_sp_idlok
438 #define _nc_idcok SP->_nc_sp_idcok
441 * These are the data that support the mouse interface.
443 MouseType _mouse_type;
445 bool (*_mouse_event) (SCREEN *);
446 bool (*_mouse_inline)(SCREEN *);
447 bool (*_mouse_parse) (int);
448 void (*_mouse_resume)(SCREEN *);
449 void (*_mouse_wrap) (SCREEN *);
450 int _mouse_fd; /* file-descriptor, if any */
451 NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
453 MEVENT _sysmouse_fifo[FIFO_SIZE];
456 int _sysmouse_char_width; /* character width */
457 int _sysmouse_char_height; /* character height */
458 int _sysmouse_old_buttons;
459 int _sysmouse_new_buttons;
463 * This supports automatic resizing
466 int (*_resize)(int,int);
470 * These are data that support the proper handling of the panel stack on an
473 struct panelhook _panelHook;
475 * Linked-list of all windows, to support '_nc_resizeall()' and
478 WINDOWLIST *_nc_sp_windows;
479 #define _nc_windows SP->_nc_sp_windows
482 SCREEN *_next_screen;
484 /* hashes for old and new lines */
485 unsigned long *oldhash, *newhash;
489 bool _cleanup; /* cleanup after int/quit signal */
490 int (*_outch)(int); /* output handler if not putc */
492 /* recent versions of 'screen' have partially-working support for
493 * UTF-8, but do not permit ACS at the same time (see tty_update.c).
495 #if USE_WIDEC_SUPPORT
497 bool _screen_acs_fix;
501 extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;
504 #include <nomacros.h>
508 WINDOW win; /* first, so WINDOW_EXT() works */
510 #ifdef _XOPEN_SOURCE_EXTENDED
511 char addch_work[(MB_LEN_MAX * 9) + 1];
518 #define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)
520 /* The terminfo source is assumed to be 7-bit ASCII */
521 #define is7bits(c) ((unsigned)(c) < 128)
524 #define min(a,b) ((a) > (b) ? (b) : (a))
528 #define max(a,b) ((a) < (b) ? (b) : (a))
531 /* usually in <unistd.h> */
533 #define STDIN_FILENO 0
536 #ifndef STDOUT_FILENO
537 #define STDOUT_FILENO 1
540 #ifndef STDERR_FILENO
541 #define STDERR_FILENO 2
545 #define EXIT_SUCCESS 0
549 #define EXIT_FAILURE 1
553 #define R_OK 4 /* Test for read permission. */
556 #define W_OK 2 /* Test for write permission. */
559 #define X_OK 1 /* Test for execute permission. */
562 #define F_OK 0 /* Test for existence. */
566 #include <fcntl.h> /* may define O_BINARY */
574 #define TRACE_OUTCHARS(n) _nc_outchars += (n);
576 #define TRACE_OUTCHARS(n) /* nothing */
579 #define UChar(c) ((unsigned char)(c))
580 #define ChCharOf(c) ((c) & (chtype)A_CHARTEXT)
581 #define ChAttrOf(c) ((c) & (chtype)A_ATTRIBUTES)
584 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
587 #if USE_WIDEC_SUPPORT /* { */
588 #define NulChar 0,0,0,0 /* FIXME: see CCHARW_MAX */
589 #define CharOf(c) ((c).chars[0])
590 #define AttrOf(c) ((c).attr)
591 #define AddAttr(c,a) (c).attr |= a
592 #define RemAttr(c,a) (c).attr &= ~(a)
593 #define SetAttr(c,a) (c).attr = a
594 #define NewChar(ch) { ChAttrOf(ch), { ChCharOf(ch), NulChar } }
595 #define NewChar2(c,a) { a, { c, NulChar } }
596 #define CharEq(a,b) (!memcmp(&a, &b, sizeof(a)))
597 #define SetChar(ch,c,a) do { \
598 NCURSES_CH_T *_cp = &ch; \
599 memset(_cp,0,sizeof(ch)); _cp->chars[0] = c; _cp->attr = a; \
601 #define CHREF(wch) (&wch)
602 #define CHDEREF(wch) (*wch)
603 #define ARG_CH_T NCURSES_CH_T *
604 #define CARG_CH_T const NCURSES_CH_T *
605 #define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
606 mbstate_t PUT_st; wchar_t PUTC_ch
607 #define PUTC_INIT memset (&PUT_st, '\0', sizeof (PUT_st)); \
609 #define PUTC(ch,b) do { if(!isnac(ch)) { \
610 if (Charable(ch)) { \
611 fputc(CharOf(ch), b); \
616 PUTC_ch = PUTC_i < CCHARW_MAX ? \
617 (ch).chars[PUTC_i] : L'\0'; \
618 PUTC_n = wcrtomb(PUTC_buf, \
619 (ch).chars[PUTC_i], &PUT_st); \
620 if (PUTC_ch == L'\0') \
624 fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b); \
626 } while (PUTC_ch != L'\0'); \
627 TRACE_OUTCHARS(PUTC_i); \
630 #define BLANK { WA_NORMAL, ' ' }
631 #define ISBLANK(ch) ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')
634 #define isnac(ch) (AttrOf(ch) & WA_NAC)
635 #define if_WIDEC(code) code
636 #define Charable(ch) ((SP != 0 && SP->_posix_locale) \
638 (ch).chars[1] == L'\0' && \
639 _nc_is_charable(CharOf(ch))))
641 #define L(ch) L ## ch
643 #define CharOf(c) ChCharOf(c)
644 #define AttrOf(c) ChAttrOf(c)
645 #define AddAttr(c,a) c |= a
646 #define RemAttr(c,a) c &= ~(a & A_ATTRIBUTES)
647 #define SetAttr(c,a) c = (c & ~A_ATTRIBUTES) | a
648 #define NewChar(ch) (ch)
649 #define NewChar2(c,a) (c | a)
650 #define CharEq(a,b) (a == b)
651 #define SetChar(ch,c,a) ch = c | a
652 #define CHREF(wch) wch
653 #define CHDEREF(wch) wch
654 #define ARG_CH_T NCURSES_CH_T
655 #define CARG_CH_T NCURSES_CH_T
656 #define PUTC_DATA int data = 0
657 #define PUTC(a,b) do { data = CharOf(ch); putc(data,b); } while (0)
659 #define BLANK (' '|A_NORMAL)
660 #define ISBLANK(ch) (CharOf(ch) == ' ')
662 #define isnac(ch) (0)
663 #define if_WIDEC(code) /* nothing */
668 #define AttrOfD(ch) AttrOf(CHDEREF(ch))
669 #define CharOfD(ch) CharOf(CHDEREF(ch))
670 #define SetChar2(wch,ch) SetChar(wch,ChCharOf(ch),ChAttrOf(ch))
672 #define BLANK_ATTR A_NORMAL
673 #define BLANK_TEXT L(' ')
677 #define CHANGED_CELL(line,col) \
678 if (line->firstchar == _NOCHANGE) \
679 line->firstchar = line->lastchar = col; \
680 else if ((col) < line->firstchar) \
681 line->firstchar = col; \
682 else if ((col) > line->lastchar) \
685 #define CHANGED_RANGE(line,start,end) \
686 if (line->firstchar == _NOCHANGE \
687 || line->firstchar > (start)) \
688 line->firstchar = start; \
689 if (line->lastchar == _NOCHANGE \
690 || line->lastchar < (end)) \
693 #define CHANGED_TO_EOL(line,start,end) \
694 if (line->firstchar == _NOCHANGE \
695 || line->firstchar > (start)) \
696 line->firstchar = start; \
699 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
701 #define FreeIfNeeded(p) if ((p) != 0) free(p)
703 /* FreeAndNull() is not a comma-separated expression because some compilers
704 * do not accept a mixture of void with values.
706 #define FreeAndNull(p) free(p); p = 0
708 #include <nc_alloc.h>
711 * Prefixes for call/return points of library function traces. We use these to
712 * instrument the public functions so that the traces can be easily transformed
713 * into regression scripts.
715 #define T_CALLED(fmt) "called {" fmt
716 #define T_CREATE(fmt) "create :" fmt
717 #define T_RETURN(fmt) "return }" fmt
721 #define START_TRACE() \
722 if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
723 int t = _nc_getenv_num("NCURSES_TRACE"); \
725 trace((unsigned) t); \
728 #define TR(n, a) if (_nc_tracing & (n)) _tracef a
729 #define T(a) TR(TRACE_CALLS, a)
730 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
731 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
733 #define returnAttr(code) TRACE_RETURN(code,attr_t)
734 #define returnChar(code) TRACE_RETURN(code,chtype)
735 #define returnBool(code) TRACE_RETURN(code,bool)
736 #define returnBits(code) TRACE_RETURN(code,unsigned)
737 #define returnCode(code) TRACE_RETURN(code,int)
738 #define returnPtr(code) TRACE_RETURN(code,ptr)
739 #define returnSP(code) TRACE_RETURN(code,sp)
740 #define returnVoid T((T_RETURN(""))); return
741 #define returnWin(code) TRACE_RETURN(code,win)
743 extern NCURSES_EXPORT(NCURSES_BOOL) _nc_retrace_bool (NCURSES_BOOL);
744 extern NCURSES_EXPORT(SCREEN *) _nc_retrace_sp (SCREEN *);
745 extern NCURSES_EXPORT(WINDOW *) _nc_retrace_win (WINDOW *);
746 extern NCURSES_EXPORT(attr_t) _nc_retrace_attr_t (attr_t);
747 extern NCURSES_EXPORT(char *) _nc_retrace_ptr (char *);
748 extern NCURSES_EXPORT(char *) _nc_trace_ttymode(TTY *tty);
749 extern NCURSES_EXPORT(char *) _nc_varargs (const char *, va_list);
750 extern NCURSES_EXPORT(chtype) _nc_retrace_chtype (chtype);
751 extern NCURSES_EXPORT(const char *) _nc_altcharset_name(attr_t, chtype);
752 extern NCURSES_EXPORT(int) _nc_retrace_int (int);
753 extern NCURSES_EXPORT(unsigned) _nc_retrace_unsigned (unsigned);
754 extern NCURSES_EXPORT(void) _nc_fifo_dump (void);
755 extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
756 extern NCURSES_EXPORT_VAR(long) _nc_outchars;
757 extern NCURSES_EXPORT_VAR(unsigned) _nc_tracing;
759 #if USE_WIDEC_SUPPORT
760 extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
761 extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
762 extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const cchar_t *, int);
763 extern NCURSES_EXPORT(const char *) _nc_viscbuf (const cchar_t *, int);
768 #define START_TRACE() /* nothing */
772 #define TPUTS_TRACE(s)
774 #define returnAttr(code) return code
775 #define returnBits(code) return code
776 #define returnBool(code) return code
777 #define returnChar(code) return code
778 #define returnCode(code) return code
779 #define returnPtr(code) return code
780 #define returnSP(code) return code
781 #define returnVoid return
782 #define returnWin(code) return code
784 #endif /* TRACE/!TRACE */
786 extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
787 extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);
789 #define empty_module(name) \
790 extern NCURSES_EXPORT(void) name (void); \
791 NCURSES_EXPORT(void) name (void) { }
793 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
794 #define IGNORE_COLOR_OFF FALSE
795 #define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
796 #define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)
798 #define toggle_attr_on(S,at) {\
799 if (PAIR_NUMBER(at) > 0)\
800 (S) = ((S) & ALL_BUT_COLOR) | (at);\
803 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
806 #define toggle_attr_off(S,at) {\
807 if (IGNORE_COLOR_OFF == TRUE) {\
808 if (PAIR_NUMBER(at) == 0xff) /* turn off color */\
810 else /* leave color alone */\
811 (S) &= ~((at)&ALL_BUT_COLOR);\
813 if (PAIR_NUMBER(at) > 0x00) /* turn off color */\
814 (S) &= ~(at|A_COLOR);\
815 else /* leave color alone */\
818 TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
820 #define DelCharCost(count) \
823 : ((delete_character != 0) \
824 ? (SP->_dch1_cost * count) \
827 #define InsCharCost(count) \
830 : ((enter_insert_mode && exit_insert_mode) \
831 ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
832 : ((insert_character != 0) \
833 ? ((SP->_ich1_cost + SP->_ip_cost) * count) \
837 #define UpdateAttrs(a) if (SP->_current_attr != (a)) { \
838 attr_t chg = SP->_current_attr; \
840 if (magic_cookie_glitch > 0 \
841 && XMC_CHANGES((chg ^ SP->_current_attr))) { \
842 T(("%s @%d before glitch %d,%d", \
843 __FILE__, __LINE__, \
846 _nc_do_xmc_glitch(chg); \
850 #define UpdateAttrs(a) if (SP->_current_attr != (a)) \
855 * Macros to make additional parameter to implement wgetch_events()
857 #ifdef NCURSES_WGETCH_EVENTS
858 #define EVENTLIST_0th(param) param
859 #define EVENTLIST_1st(param) param
860 #define EVENTLIST_2nd(param) , param
862 #define EVENTLIST_0th(param) void
863 #define EVENTLIST_1st(param) /* nothing */
864 #define EVENTLIST_2nd(param) /* nothing */
867 #if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
869 #undef toggle_attr_on
870 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
871 extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);
873 #undef toggle_attr_off
874 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
875 extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);
878 #define DelCharCost(count) _nc_DelCharCost(count)
879 extern NCURSES_EXPORT(int) _nc_DelCharCost (int);
882 #define InsCharCost(count) _nc_InsCharCost(count)
883 extern NCURSES_EXPORT(int) _nc_InsCharCost (int);
886 #define UpdateAttrs(c) _nc_UpdateAttrs(c)
887 extern NCURSES_EXPORT(void) _nc_UpdateAttrs (chtype);
891 extern NCURSES_EXPORT(void) _nc_expanded (void);
896 #define getcwd(buf,len) getwd(buf)
900 #if USE_WIDEC_SUPPORT
901 extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
902 extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
903 extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
908 extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
912 #if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
913 extern NCURSES_EXPORT(void) _nc_linedump (void);
917 extern NCURSES_EXPORT(void) _nc_init_acs (void); /* corresponds to traditional 'init_acs()' */
918 extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int); /* used by 'tack' program */
921 #if USE_WIDEC_SUPPORT
922 extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
926 extern NCURSES_EXPORT(bool) _nc_reset_colors(void);
929 extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));
932 extern NCURSES_EXPORT(void) _nc_insert_ch(WINDOW *, chtype);
935 #define INFINITY 1000000 /* cost: too high to use */
937 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
938 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
939 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
941 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
943 extern NCURSES_EXPORT(void) _nc_screen_init (void);
944 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
945 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
948 extern NCURSES_EXPORT(int) _nc_has_mouse (void);
951 #define INFINITY 1000000 /* cost: too high to use */
952 #define BAUDBYTE 9 /* 9 = 7 bits + 1 parity + 1 stop */
955 extern NCURSES_EXPORT(char *) _nc_get_locale(void);
956 extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
957 extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(void);
960 #if USE_WIDEC_SUPPORT
961 extern NCURSES_EXPORT(void) _nc_init_wacs(void);
965 char *s_head; /* beginning of the string (may be null) */
966 char *s_tail; /* end of the string (may be null) */
967 size_t s_size; /* current remaining size available */
968 size_t s_init; /* total size available */
972 extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
973 extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
974 extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
975 extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
976 extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);
978 extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
979 extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
980 extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);
982 extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);
984 extern NCURSES_EXPORT(void) _nc_screen_init (void);
985 extern NCURSES_EXPORT(void) _nc_screen_resume (void);
986 extern NCURSES_EXPORT(void) _nc_screen_wrap (void);
989 #define strstr _nc_strstr
990 extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
994 extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);
997 extern NCURSES_EXPORT(void) _nc_add_to_try (struct tries **, const char *, unsigned short);
998 extern NCURSES_EXPORT(char *) _nc_expand_try (struct tries *, unsigned short, int *, size_t);
999 extern NCURSES_EXPORT(int) _nc_remove_key (struct tries **, unsigned short);
1000 extern NCURSES_EXPORT(int) _nc_remove_string (struct tries **, const char *);
1003 extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
1004 extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
1005 extern NCURSES_EXPORT(char *) _nc_home_terminfo (void);
1006 extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
1007 extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
1008 extern NCURSES_EXPORT(int) _nc_access (const char *, int);
1009 extern NCURSES_EXPORT(int) _nc_baudrate (int);
1010 extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
1011 extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
1012 extern NCURSES_EXPORT(int) _nc_keypad (bool);
1013 extern NCURSES_EXPORT(int) _nc_ospeed (int);
1014 extern NCURSES_EXPORT(int) _nc_outch (int);
1015 extern NCURSES_EXPORT(int) _nc_setupscreen (short, short const, FILE *);
1016 extern NCURSES_EXPORT(int) _nc_timed_wait(int, int, int * EVENTLIST_2nd(_nc_eventlist *));
1017 extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
1018 extern NCURSES_EXPORT(void) _nc_do_color (int, int, bool, int (*)(int));
1019 extern NCURSES_EXPORT(void) _nc_flush (void);
1020 extern NCURSES_EXPORT(void) _nc_freeall (void);
1021 extern NCURSES_EXPORT(void) _nc_hash_map (void);
1022 extern NCURSES_EXPORT(void) _nc_init_keytry (void);
1023 extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
1024 extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
1025 extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
1026 extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
1027 extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, short const, short const, NCURSES_CH_T);
1028 extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
1029 extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
1030 extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
1031 extern NCURSES_EXPORT(void) _nc_trace_tries (struct tries *);
1034 extern NCURSES_EXPORT(void) _nc_update_screensize (void);
1038 extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
1040 #define _nc_resize_margins(wp) /* nothing */
1043 #ifdef NCURSES_WGETCH_EVENTS
1044 extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
1046 #define wgetch_events(win, evl) wgetch(win)
1047 #define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
1051 * Not everyone has vsscanf(), but we'd like to use it for scanw().
1054 extern int vsscanf(const char *str, const char *format, va_list __arg);
1057 /* scroll indices */
1058 extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;
1060 #define USE_SETBUF_0 0
1062 #define NC_BUFFERED(flag) _nc_set_buffer(SP->_ofp, flag)
1064 #define NC_OUTPUT ((SP != 0) ? SP->_ofp : stdout)
1067 * On systems with a broken linker, define 'SP' as a function to force the
1068 * linker to pull in the data-only module with 'SP'.
1071 #define SP _nc_screen()
1072 extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
1073 extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
1074 extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
1076 /* current screen is private data; avoid possible linking conflicts too */
1077 extern NCURSES_EXPORT_VAR(SCREEN *) SP;
1078 #define _nc_alloc_screen() ((SP = typeCalloc(SCREEN, 1)) != 0)
1079 #define _nc_set_screen(sp) SP = sp
1083 * We don't want to use the lines or columns capabilities internally, because
1084 * if the application is running multiple screens under X, it's quite possible
1085 * they could all have type xterm but have different sizes! So...
1087 #define screen_lines SP->_lines
1088 #define screen_columns SP->_columns
1090 extern NCURSES_EXPORT_VAR(int) _nc_slk_format; /* != 0 if slk_init() called */
1091 extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);
1094 * Some constants related to SLK's
1096 #define MAX_SKEY_OLD 8 /* count of soft keys */
1097 #define MAX_SKEY_LEN_OLD 8 /* max length of soft key text */
1098 #define MAX_SKEY_PC 12 /* This is what most PC's have */
1099 #define MAX_SKEY_LEN_PC 5
1101 /* Macro to check whether or not we use a standard format */
1102 #define SLK_STDFMT(fmt) (fmt < 3)
1103 /* Macro to determine height of label window */
1104 #define SLK_LINES(fmt) (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
1106 #define MAX_SKEY(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
1107 #define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
1109 extern NCURSES_EXPORT(int) _nc_ripoffline (int line, int (*init)(WINDOW *,int));
1112 * Common error messages
1114 #define MSG_NO_MEMORY "Out of memory"
1115 #define MSG_NO_INPUTS "Premature EOF"
1121 #endif /* CURSES_PRIV_H */