xref: /freebsd/contrib/ncurses/include/curses.h.in (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1/****************************************************************************
2 * Copyright (c) 1998 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 ****************************************************************************/
33
34/* $Id: curses.h.in,v 1.85 1999/10/23 12:33:54 tom Exp $ */
35
36#ifndef __NCURSES_H
37#define __NCURSES_H
38
39#define CURSES 1
40#define CURSES_H 1
41
42/* This should be defined for the enhanced functionality to be visible.
43 * However, none of the wide-character (enhanced) functionality is implemented.
44 * So we do not define it (yet).
45#define _XOPEN_CURSES 1
46 */
47
48/* These are defined only in curses.h, and are used for conditional compiles */
49#define NCURSES_VERSION_MAJOR @NCURSES_MAJOR@
50#define NCURSES_VERSION_MINOR @NCURSES_MINOR@
51#define NCURSES_VERSION_PATCH @NCURSES_PATCH@
52
53/* This is defined in more than one ncurses header, for identification */
54#undef  NCURSES_VERSION
55#define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
56
57#ifdef NCURSES_NOMACROS
58#define NCURSES_ATTR_T attr_t
59#endif
60
61#ifndef NCURSES_ATTR_T
62#define NCURSES_ATTR_T int
63#endif
64
65#undef  NCURSES_CONST
66#define NCURSES_CONST @NCURSES_CONST@
67
68typedef unsigned @cf_cv_typeof_chtype@ chtype;
69
70#include <stdio.h>
71#include <unctrl.h>
72#include <stdarg.h>	/* we need va_list */
73#ifdef _XOPEN_SOURCE_EXTENDED
74#include <stddef.h>	/* we want wchar_t */
75#endif /* _XOPEN_SOURCE_EXTENDED */
76
77/* XSI and SVr4 specify that curses implements 'bool'.  However, C++ may also
78 * implement it.  If so, we must use the C++ compiler's type to avoid conflict
79 * with other interfaces.
80 */
81
82#undef TRUE
83#define TRUE    1
84
85#undef FALSE
86#define FALSE   0
87
88#if (!defined(__cplusplus) || !@cf_cv_builtin_bool@) && (!@cf_cv_cc_bool_type@)
89#undef bool
90typedef @cf_cv_type_of_bool@ bool;
91#endif
92
93#ifdef __cplusplus
94extern "C" {
95#endif
96
97/*
98 * XSI attributes.  In the ncurses implementation, they are identical to the
99 * A_ attributes.
100 */
101#define WA_ATTRIBUTES	A_ATTRIBUTES
102#define WA_NORMAL	A_NORMAL
103#define WA_STANDOUT	A_STANDOUT
104#define WA_UNDERLINE	A_UNDERLINE
105#define WA_REVERSE	A_REVERSE
106#define WA_BLINK	A_BLINK
107#define WA_DIM		A_DIM
108#define WA_BOLD		A_BOLD
109#define WA_ALTCHARSET	A_ALTCHARSET
110#define WA_INVIS	A_INVIS
111#define WA_PROTECT	A_PROTECT
112#define WA_HORIZONTAL	A_HORIZONTAL
113#define WA_LEFT		A_LEFT
114#define WA_LOW		A_LOW
115#define WA_RIGHT	A_RIGHT
116#define WA_TOP		A_TOP
117#define WA_VERTICAL	A_VERTICAL
118
119/* colors */
120extern int COLORS;
121extern int COLOR_PAIRS;
122
123#define COLOR_BLACK	0
124#define COLOR_RED	1
125#define COLOR_GREEN	2
126#define COLOR_YELLOW	3
127#define COLOR_BLUE	4
128#define COLOR_MAGENTA	5
129#define COLOR_CYAN	6
130#define COLOR_WHITE	7
131
132/* line graphics */
133
134extern	chtype acs_map[];
135
136/* VT100 symbols begin here */
137#define ACS_ULCORNER	(acs_map['l'])	/* upper left corner */
138#define ACS_LLCORNER	(acs_map['m'])	/* lower left corner */
139#define ACS_URCORNER	(acs_map['k'])	/* upper right corner */
140#define ACS_LRCORNER	(acs_map['j'])	/* lower right corner */
141#define ACS_LTEE	(acs_map['t'])	/* tee pointing right */
142#define ACS_RTEE	(acs_map['u'])	/* tee pointing left */
143#define ACS_BTEE	(acs_map['v'])	/* tee pointing up */
144#define ACS_TTEE	(acs_map['w'])	/* tee pointing down */
145#define ACS_HLINE	(acs_map['q'])	/* horizontal line */
146#define ACS_VLINE	(acs_map['x'])	/* vertical line */
147#define ACS_PLUS	(acs_map['n'])	/* large plus or crossover */
148#define ACS_S1		(acs_map['o'])	/* scan line 1 */
149#define ACS_S9		(acs_map['s'])	/* scan line 9 */
150#define ACS_DIAMOND	(acs_map['`'])	/* diamond */
151#define ACS_CKBOARD	(acs_map['a'])	/* checker board (stipple) */
152#define ACS_DEGREE	(acs_map['f'])	/* degree symbol */
153#define ACS_PLMINUS	(acs_map['g'])	/* plus/minus */
154#define ACS_BULLET	(acs_map['~'])	/* bullet */
155/* Teletype 5410v1 symbols begin here */
156#define ACS_LARROW	(acs_map[','])	/* arrow pointing left */
157#define ACS_RARROW	(acs_map['+'])	/* arrow pointing right */
158#define ACS_DARROW	(acs_map['.'])	/* arrow pointing down */
159#define ACS_UARROW	(acs_map['-'])	/* arrow pointing up */
160#define ACS_BOARD	(acs_map['h'])	/* board of squares */
161#define ACS_LANTERN	(acs_map['i'])	/* lantern symbol */
162#define ACS_BLOCK	(acs_map['0'])	/* solid square block */
163/*
164 * These aren't documented, but a lot of System Vs have them anyway
165 * (you can spot pprryyzz{{||}} in a lot of AT&T terminfo strings).
166 * The ACS_names may not match AT&T's, our source didn't know them.
167 */
168#define ACS_S3		(acs_map['p'])	/* scan line 3 */
169#define ACS_S7		(acs_map['r'])	/* scan line 7 */
170#define ACS_LEQUAL	(acs_map['y'])	/* less/equal */
171#define ACS_GEQUAL	(acs_map['z'])	/* greater/equal */
172#define ACS_PI		(acs_map['{'])	/* Pi */
173#define ACS_NEQUAL	(acs_map['|'])	/* not equal */
174#define ACS_STERLING	(acs_map['}'])	/* UK pound sign */
175
176/*
177 * Line drawing ACS names are of the form ACS_trbl, where t is the top, r
178 * is the right, b is the bottom, and l is the left.  t, r, b, and l might
179 * be B (blank), S (single), D (double), or T (thick).  The subset defined
180 * here only uses B and S.
181 */
182#define ACS_BSSB	ACS_ULCORNER
183#define ACS_SSBB	ACS_LLCORNER
184#define ACS_BBSS	ACS_URCORNER
185#define ACS_SBBS	ACS_LRCORNER
186#define ACS_SBSS	ACS_RTEE
187#define ACS_SSSB	ACS_LTEE
188#define ACS_SSBS	ACS_BTEE
189#define ACS_BSSS	ACS_TTEE
190#define ACS_BSBS	ACS_HLINE
191#define ACS_SBSB	ACS_VLINE
192#define ACS_SSSS	ACS_PLUS
193
194#if	!defined(ERR) || ((ERR) != -1)
195#define ERR     (-1)
196#endif
197
198#if	!defined(OK) || ((OK) != 0)
199#define OK      (0)
200#endif
201
202/* values for the _flags member */
203#define _SUBWIN         0x01	/* is this a sub-window? */
204#define _ENDLINE        0x02	/* is the window flush right? */
205#define _FULLWIN        0x04	/* is the window full-screen? */
206#define _SCROLLWIN      0x08	/* bottom edge is at screen bottom? */
207#define _ISPAD	        0x10	/* is this window a pad? */
208#define _HASMOVED       0x20	/* has cursor moved since last refresh? */
209#define _WRAPPED        0x40	/* cursor was just wrappped */
210
211/*
212 * this value is used in the firstchar and lastchar fields to mark
213 * unchanged lines
214 */
215#define _NOCHANGE       -1
216
217/*
218 * this value is used in the oldindex field to mark lines created by insertions
219 * and scrolls.
220 */
221#define _NEWINDEX	-1
222
223typedef struct screen  SCREEN;
224typedef struct _win_st WINDOW;
225
226typedef	chtype	attr_t;		/* ...must be at least as wide as chtype */
227
228#ifdef _XOPEN_SOURCE_EXTENDED
229#ifndef _WCHAR_T
230typedef unsigned long wchar_t;
231#endif /* _WCHAR_T */
232#ifndef _WINT_T
233typedef long int wint_t;
234#endif /* _WINT_T */
235
236#define CCHARW_MAX	5
237typedef struct
238{
239    attr_t	attr;
240    wchar_t	chars[CCHARW_MAX];
241}
242cchar_t;
243#endif /* _XOPEN_SOURCE_EXTENDED */
244
245struct ldat
246{
247	chtype  *text;		/* text of the line */
248	short   firstchar;	/* first changed character in the line */
249	short   lastchar;	/* last changed character in the line */
250	short   oldindex;	/* index of the line at last update */
251};
252
253struct _win_st
254{
255	short   _cury, _curx;	/* current cursor position */
256
257	/* window location and size */
258	short   _maxy, _maxx;	/* maximums of x and y, NOT window size */
259	short   _begy, _begx;	/* screen coords of upper-left-hand corner */
260
261	short   _flags;		/* window state flags */
262
263	/* attribute tracking */
264	attr_t  _attrs;		/* current attribute for non-space character */
265	chtype  _bkgd;		/* current background char/attribute pair */
266
267	/* option values set by user */
268	bool	_notimeout;	/* no time out on function-key entry? */
269	bool    _clear;		/* consider all data in the window invalid? */
270	bool    _leaveok;	/* OK to not reset cursor on exit? */
271	bool    _scroll;	/* OK to scroll this window? */
272	bool    _idlok;		/* OK to use insert/delete line? */
273	bool    _idcok;		/* OK to use insert/delete char? */
274	bool	_immed;		/* window in immed mode? (not yet used) */
275	bool	_sync;		/* window in sync mode? */
276	bool    _use_keypad;    /* process function keys into KEY_ symbols? */
277	int	_delay;		/* 0 = nodelay, <0 = blocking, >0 = delay */
278
279	struct ldat *_line;	/* the actual line data */
280
281	/* global screen state */
282	short	_regtop;	/* top line of scrolling region */
283	short	_regbottom;	/* bottom line of scrolling region */
284
285	/* these are used only if this is a sub-window */
286	int	_parx;		/* x coordinate of this window in parent */
287	int	_pary;		/* y coordinate of this window in parent */
288	WINDOW	*_parent;	/* pointer to parent if a sub-window */
289
290	/* these are used only if this is a pad */
291	struct pdat
292	{
293	    short _pad_y,      _pad_x;
294	    short _pad_top,    _pad_left;
295	    short _pad_bottom, _pad_right;
296	} _pad;
297
298	short   _yoffset;	/* real begy is _begy + _yoffset */
299};
300
301extern WINDOW   *stdscr;
302extern WINDOW   *curscr;
303extern WINDOW   *newscr;
304
305extern int	LINES;
306extern int	COLS;
307extern int	TABSIZE;
308
309/*
310 * This global was an undocumented feature under AIX curses.
311 */
312extern int ESCDELAY;	/* ESC expire time in milliseconds */
313
314extern char *keybound (int, int);
315extern const char *curses_version (void);
316extern int define_key (char *, int);
317extern int keyok (int, bool);
318extern int resizeterm (int, int);
319extern int use_default_colors (void);
320extern int use_extended_names (bool);
321extern int wresize (WINDOW *, int, int);
322
323extern char ttytype[];		/* needed for backward compatibility */
324
325/*
326 * GCC (and some other compilers) define '__attribute__'; we're using this
327 * macro to alert the compiler to flag inconsistencies in printf/scanf-like
328 * function calls.  Just in case '__attribute__' isn't defined, make a dummy.
329 * G++ doesn't accept it anyway.
330 */
331#if !defined(__GNUC__) && !defined(__attribute__)
332#define __attribute__(p) /* nothing */
333#endif
334
335/*
336 * For g++, turn off our macros that use __attribute__ (g++ recognizes some
337 * of them, but not at the same version levels as gcc).
338 */
339#ifdef __cplusplus
340#undef GCC_NORETURN
341#undef GCC_PRINTF
342#undef GCC_SCANF
343#undef GCC_UNUSED
344#endif
345
346/*
347 * We cannot define these in ncurses_cfg.h, since they require parameters to be
348 * passed (that's non-portable).
349 */
350#if	GCC_PRINTF
351#define GCC_PRINTFLIKE(fmt,var) __attribute__((format(printf,fmt,var)))
352#else
353#define GCC_PRINTFLIKE(fmt,var) /*nothing*/
354#endif
355
356#if	GCC_SCANF
357#define GCC_SCANFLIKE(fmt,var)  __attribute__((format(scanf,fmt,var)))
358#else
359#define GCC_SCANFLIKE(fmt,var)  /*nothing*/
360#endif
361
362#ifndef	GCC_NORETURN
363#define	GCC_NORETURN /* nothing */
364#endif
365
366#ifndef	GCC_UNUSED
367#define	GCC_UNUSED /* nothing */
368#endif
369
370/*
371 * Function prototypes.  This is the complete XSI Curses list of required
372 * functions.  Those marked `generated' will have sources generated from the
373 * macro definitions later in this file, in order to satisfy XPG4.2
374 * requirements.
375 */
376
377extern int addch(const chtype);				/* generated */
378extern int addchnstr(const chtype *, int);		/* generated */
379extern int addchstr(const chtype *);			/* generated */
380extern int addnstr(const char *, int);			/* generated */
381extern int addstr(const char *);			/* generated */
382#ifdef _XOPEN_SOURCE_EXTENDED
383extern int addnwstr(const wchar_t *, int);		/* missing */
384extern int addwstr(const wchar_t *);			/* missing */
385extern int add_wch(const cchar_t *);			/* missing */
386extern int add_wchnstr(const cchar_t *, int);		/* missing */
387extern int add_wchstr(const cchar_t *);			/* missing */
388#endif /* _XOPEN_SOURCE_EXTENDED */
389extern int attroff(NCURSES_ATTR_T);			/* generated */
390extern int attron(NCURSES_ATTR_T);			/* generated */
391extern int attrset(NCURSES_ATTR_T);			/* generated */
392extern int attr_get(attr_t *, short *, void *);		/* generated */
393extern int attr_off(attr_t, void *);			/* generated */
394extern int attr_on(attr_t, void *);			/* generated */
395extern int attr_set(attr_t, short, void *);		/* generated */
396extern int baudrate(void);				/* implemented */
397extern int beep(void);					/* implemented */
398extern int bkgd(chtype);				/* generated */
399extern void bkgdset(chtype);				/* generated */
400#ifdef _XOPEN_SOURCE_EXTENDED
401extern void bkgrndset(const cchar_t *);			/* missing */
402extern int bkgrnd(const cchar_t *);			/* missing */
403#endif /* _XOPEN_SOURCE_EXTENDED */
404extern int border(chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype);	/* generated */
405#ifdef _XOPEN_SOURCE_EXTENDED
406extern int border_set(const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*);	/* missing */
407#endif /* _XOPEN_SOURCE_EXTENDED */
408extern int box(WINDOW *, chtype, chtype);		/* generated */
409#ifdef _XOPEN_SOURCE_EXTENDED
410extern int box_set(WINDOW *, const cchar_t *, const cchar_t *);	/* missing */
411#endif /* _XOPEN_SOURCE_EXTENDED */
412extern bool can_change_color(void);			/* implemented */
413extern int cbreak(void);				/* implemented */
414extern int chgat(int, attr_t, short, const void *);	/* generated */
415extern int clear(void);					/* generated */
416extern int clearok(WINDOW *,bool);			/* implemented */
417extern int clrtobot(void);				/* generated */
418extern int clrtoeol(void);				/* generated */
419extern int color_content(short,short*,short*,short*);	/* implemented */
420extern int color_set(short,void*);			/* generated */
421extern int COLOR_PAIR(int);				/* generated */
422extern int copywin(const WINDOW*,WINDOW*,int,int,int,int,int,int,int);	/* implemented */
423extern int curs_set(int);				/* implemented */
424extern int def_prog_mode(void);				/* implemented */
425extern int def_shell_mode(void);			/* implemented */
426extern int delay_output(int);				/* implemented */
427extern int delch(void);					/* generated */
428extern void delscreen(SCREEN *);			/* implemented */
429extern int delwin(WINDOW *);				/* implemented */
430extern int deleteln(void);				/* generated */
431extern WINDOW *derwin(WINDOW *,int,int,int,int);	/* implemented */
432extern int doupdate(void);				/* implemented */
433extern WINDOW *dupwin(WINDOW *);			/* implemented */
434extern int echo(void);					/* implemented */
435extern int echochar(const chtype);			/* generated */
436#ifdef _XOPEN_SOURCE_EXTENDED
437extern int echo_wchar(const cchar_t *);			/* missing */
438extern int erasewchar(wchar_t*);			/* missing */
439#endif /* _XOPEN_SOURCE_EXTENDED */
440extern int endwin(void);				/* implemented */
441extern char erasechar(void);				/* implemented */
442extern void filter(void);				/* implemented */
443extern int flash(void);					/* implemented */
444extern int flushinp(void);				/* implemented */
445extern chtype getbkgd(WINDOW *);			/* generated */
446#ifdef _XOPEN_SOURCE_EXTENDED
447extern int getbkgrnd(cchar_t *);			/* missing */
448extern int getcchar(const cchar_t *, wchar_t*, attr_t*, short*, void*);	/* missing */
449#endif /* _XOPEN_SOURCE_EXTENDED */
450extern int getch(void);					/* generated */
451extern int getnstr(char *, int);			/* generated */
452#ifdef _XOPEN_SOURCE_EXTENDED
453extern int getn_wstr(wint_t *, int);			/* missing */
454#endif /* _XOPEN_SOURCE_EXTENDED */
455extern int getstr(char *);				/* generated */
456#ifdef _XOPEN_SOURCE_EXTENDED
457extern int get_wch(wint_t *);				/* missing */
458#endif /* _XOPEN_SOURCE_EXTENDED */
459extern WINDOW *getwin(FILE *);				/* implemented */
460#ifdef _XOPEN_SOURCE_EXTENDED
461extern int get_wstr(wint_t *);				/* missing */
462#endif /* _XOPEN_SOURCE_EXTENDED */
463extern int halfdelay(int);				/* implemented */
464extern bool has_colors(void);				/* implemented */
465extern bool has_ic(void);				/* implemented */
466extern bool has_il(void);				/* implemented */
467extern int hline(chtype, int);				/* generated */
468#ifdef _XOPEN_SOURCE_EXTENDED
469extern int hline_set(const cchar_t *, int);		/* missing */
470#endif /* _XOPEN_SOURCE_EXTENDED */
471extern void idcok(WINDOW *, bool);			/* implemented */
472extern int idlok(WINDOW *, bool);			/* implemented */
473extern void immedok(WINDOW *, bool);			/* implemented */
474extern chtype inch(void);				/* generated */
475extern int inchnstr(chtype *, int);			/* generated */
476extern int inchstr(chtype *);				/* generated */
477extern WINDOW *initscr(void);				/* implemented */
478extern int init_color(short,short,short,short);		/* implemented */
479extern int init_pair(short,short,short);		/* implemented */
480extern int innstr(char *, int);				/* generated */
481#ifdef _XOPEN_SOURCE_EXTENDED
482extern int innwstr(wchar_t *, int);			/* missing */
483#endif /* _XOPEN_SOURCE_EXTENDED */
484extern int insch(chtype);				/* generated */
485extern int insdelln(int);				/* generated */
486extern int insertln(void);				/* generated */
487extern int insnstr(const char *, int);			/* generated */
488extern int insstr(const char *);			/* generated */
489extern int instr(char *);				/* generated */
490#ifdef _XOPEN_SOURCE_EXTENDED
491extern int ins_nwstr(const wchar_t *, int);		/* missing */
492extern int ins_wch(const cchar_t *);			/* missing */
493extern int ins_wstr(const wchar_t *);			/* missing */
494#endif /* _XOPEN_SOURCE_EXTENDED */
495extern int intrflush(WINDOW *,bool);			/* implemented */
496#ifdef _XOPEN_SOURCE_EXTENDED
497extern int inwstr(wchar_t *);				/* missing */
498extern int in_wch(NCURSES_CONST cchar_t *);		/* missing */
499extern int in_wchstr(NCURSES_CONST cchar_t *);		/* missing */
500extern int in_wchnstr(NCURSES_CONST cchar_t *, int);	/* missing */
501#endif /* _XOPEN_SOURCE_EXTENDED */
502extern bool isendwin(void);				/* implemented */
503extern bool is_linetouched(WINDOW *,int);		/* implemented */
504extern bool is_wintouched(WINDOW *);			/* implemented */
505extern NCURSES_CONST char *keyname(int);		/* implemented */
506#ifdef _XOPEN_SOURCE_EXTENDED
507extern char *key_name(wchar_t);				/* missing */
508#endif /* _XOPEN_SOURCE_EXTENDED */
509extern int keypad(WINDOW *,bool);			/* implemented */
510extern char killchar(void);				/* implemented */
511#ifdef _XOPEN_SOURCE_EXTENDED
512extern int killwchar(wchar_t *);			/* missing */
513#endif /* _XOPEN_SOURCE_EXTENDED */
514extern int leaveok(WINDOW *,bool);			/* implemented */
515extern char *longname(void);				/* implemented */
516extern int meta(WINDOW *,bool);				/* implemented */
517extern int move(int, int);				/* generated */
518extern int mvaddch(int, int, const chtype);		/* generated */
519extern int mvaddchnstr(int, int, const chtype *, int);	/* generated */
520extern int mvaddchstr(int, int, const chtype *);	/* generated */
521extern int mvaddnstr(int, int, const char *, int);	/* generated */
522extern int mvaddstr(int, int, const char *);		/* generated */
523#ifdef _XOPEN_SOURCE_EXTENDED
524extern int mvaddnwstr(int, int, const wchar_t *, int);	/* missing */
525extern int mvaddwstr(int, int, const wchar_t *);	/* missing */
526extern int mvadd_wch(int, int, const cchar_t *);	/* missing */
527extern int mvadd_wchnstr(int, int, const cchar_t *, int);/* missing */
528extern int mvadd_wchstr(int, int, const cchar_t *);	/* missing */
529#endif /* _XOPEN_SOURCE_EXTENDED */
530extern int mvchgat(int, int, int, attr_t, short, const void *);	/* generated */
531extern int mvcur(int,int,int,int);			/* implemented */
532extern int mvdelch(int, int);				/* generated */
533extern int mvderwin(WINDOW *, int, int);		/* implemented */
534extern int mvgetch(int, int);				/* generated */
535extern int mvgetnstr(int, int, char *, int);		/* generated */
536#ifdef _XOPEN_SOURCE_EXTENDED
537extern int mvgetn_wstr(int, int, wint_t *, int);	/* missing */
538#endif /* _XOPEN_SOURCE_EXTENDED */
539extern int mvgetstr(int, int, char *);			/* generated */
540#ifdef _XOPEN_SOURCE_EXTENDED
541extern int mvget_wch(int, int, wint_t *);		/* missing */
542#endif /* _XOPEN_SOURCE_EXTENDED */
543#ifdef _XOPEN_SOURCE_EXTENDED
544extern int mvget_wstr(int, int, wint_t *);		/* missing */
545#endif /* _XOPEN_SOURCE_EXTENDED */
546extern int mvhline(int, int, chtype, int);		/* generated */
547#ifdef _XOPEN_SOURCE_EXTENDED
548extern int mvhline_set(int, int, const cchar_t *, int);	/* missing */
549#endif /* _XOPEN_SOURCE_EXTENDED */
550extern chtype mvinch(int, int);				/* generated */
551extern int mvinchnstr(int, int, chtype *, int);		/* generated */
552extern int mvinchstr(int, int, chtype *);		/* generated */
553extern int mvinnstr(int, int, char *, int);		/* generated */
554#ifdef _XOPEN_SOURCE_EXTENDED
555extern int mvinnwstr(int, int, wchar_t *, int);		/* missing */
556#endif /* _XOPEN_SOURCE_EXTENDED */
557extern int mvinsch(int, int, chtype);			/* generated */
558extern int mvinsnstr(int, int, const char *, int);	/* generated */
559extern int mvinsstr(int, int, const char *);		/* generated */
560extern int mvinstr(int, int, char *);			/* generated */
561#ifdef _XOPEN_SOURCE_EXTENDED
562extern int mvins_nwstr(int, int, const wchar_t *, int);	/* missing */
563extern int mvins_wch(int, int, const cchar_t *);	/* missing */
564extern int mvins_wstr(int, int, const wchar_t *);	/* missing */
565extern int mvinwstr(int, int, wchar_t *);		/* missing */
566extern int mvin_wch(int, int, NCURSES_CONST cchar_t *);	/* missing */
567extern int mvin_wchstr(int, int, NCURSES_CONST cchar_t *);	/* missing */
568extern int mvin_wchnstr(int, int, NCURSES_CONST cchar_t *, int);	/* missing */
569#endif /* _XOPEN_SOURCE_EXTENDED */
570extern int mvprintw(int,int, NCURSES_CONST char *,...)	/* implemented */
571		GCC_PRINTFLIKE(3,4);
572extern int mvscanw(int,int, NCURSES_CONST char *,...)	/* implemented */
573		GCC_SCANFLIKE(3,4);
574extern int mvvline(int, int, chtype, int);		/* generated */
575#ifdef _XOPEN_SOURCE_EXTENDED
576extern int mvvline_set(int, int, const cchar_t *, int);	/* missing */
577#endif /* _XOPEN_SOURCE_EXTENDED */
578extern int mvwaddch(WINDOW *, int, int, const chtype);	/* generated */
579extern int mvwaddchnstr(WINDOW *, int, int, const chtype *, int);/* generated */
580extern int mvwaddchstr(WINDOW *, int, int, const chtype *);	/* generated */
581extern int mvwaddnstr(WINDOW *, int, int, const char *, int);	/* generated */
582extern int mvwaddstr(WINDOW *, int, int, const char *);	/* generated */
583#ifdef _XOPEN_SOURCE_EXTENDED
584extern int mvwaddnwstr(WINDOW *, int, int, const wchar_t *, int);/* missing */
585extern int mvwaddwstr(WINDOW *, int, int, const wchar_t *);	/* missing */
586extern int mvwadd_wch(WINDOW *, int, int, const cchar_t *);	/* missing */
587extern int mvwadd_wchnstr(WINDOW *, int, int, const cchar_t *, int); /* missing */
588extern int mvwadd_wchstr(WINDOW *, int, int, const cchar_t *);	/* missing */
589#endif /* _XOPEN_SOURCE_EXTENDED */
590extern int mvwchgat(WINDOW *, int, int, int, attr_t, short, const void *);/* generated */
591extern int mvwdelch(WINDOW *, int, int);		/* generated */
592extern int mvwgetch(WINDOW *, int, int);		/* generated */
593extern int mvwgetnstr(WINDOW *, int, int, char *, int);	/* generated */
594#ifdef _XOPEN_SOURCE_EXTENDED
595extern int mvwgetn_wstr(WINDOW *, int, int, wint_t *, int);/* missing */
596#endif /* _XOPEN_SOURCE_EXTENDED */
597extern int mvwgetstr(WINDOW *, int, int, char *);	/* generated */
598#ifdef _XOPEN_SOURCE_EXTENDED
599extern int mvwget_wch(WINDOW *, int, int, wint_t *);	/* missing */
600#endif /* _XOPEN_SOURCE_EXTENDED */
601#ifdef _XOPEN_SOURCE_EXTENDED
602extern int mvwget_wstr(WINDOW *, int, int, wint_t *);	/* missing */
603#endif /* _XOPEN_SOURCE_EXTENDED */
604extern int mvwhline(WINDOW *, int, int, chtype, int);	/* generated */
605#ifdef _XOPEN_SOURCE_EXTENDED
606extern int mvwhline_set(WINDOW *, int, int, const cchar_t *, int);/* missing */
607#endif /* _XOPEN_SOURCE_EXTENDED */
608extern int mvwin(WINDOW *,int,int);			/* implemented */
609extern chtype mvwinch(WINDOW *, int, int);			/* generated */
610extern int mvwinchnstr(WINDOW *, int, int, chtype *, int);	/* generated */
611extern int mvwinchstr(WINDOW *, int, int, chtype *);		/* generated */
612extern int mvwinnstr(WINDOW *, int, int, char *, int);		/* generated */
613#ifdef _XOPEN_SOURCE_EXTENDED
614extern int mvwinnwstr(WINDOW *, int, int, wchar_t *, int);	/* missing */
615#endif /* _XOPEN_SOURCE_EXTENDED */
616extern int mvwinsch(WINDOW *, int, int, chtype);		/* generated */
617extern int mvwinsnstr(WINDOW *, int, int, const char *, int);	/* generated */
618extern int mvwinsstr(WINDOW *, int, int, const char *);		/* generated */
619extern int mvwinstr(WINDOW *, int, int, char *);		/* generated */
620#ifdef _XOPEN_SOURCE_EXTENDED
621extern int mvwins_nwstr(WINDOW *, int,int, const wchar_t *,int); /* missing */
622extern int mvwins_wch(WINDOW *, int, int, const cchar_t *);	/* missing */
623extern int mvwins_wstr(WINDOW *, int, int, const wchar_t *);	/* missing */
624extern int mvwinwstr(WINDOW *, int, int, wchar_t *);		/* missing */
625extern int mvwin_wch(WINDOW *, int, int, NCURSES_CONST cchar_t *);	/* missing */
626extern int mvwin_wchnstr(WINDOW *, int,int, NCURSES_CONST cchar_t *,int); /* missing */
627extern int mvwin_wchstr(WINDOW *, int, int, NCURSES_CONST cchar_t *);	/* missing */
628#endif /* _XOPEN_SOURCE_EXTENDED */
629extern int mvwprintw(WINDOW*,int,int, NCURSES_CONST char *,...)	/* implemented */
630		GCC_PRINTFLIKE(4,5);
631extern int mvwscanw(WINDOW *,int,int, NCURSES_CONST char *,...)	/* implemented */
632		GCC_SCANFLIKE(4,5);
633extern int mvwvline(WINDOW *,int, int, chtype, int);	/* generated */
634#ifdef _XOPEN_SOURCE_EXTENDED
635extern int mvwvline_set(WINDOW *, int,int, const cchar_t *,int); /* missing */
636#endif /* _XOPEN_SOURCE_EXTENDED */
637extern int napms(int);					/* implemented */
638extern WINDOW *newpad(int,int);				/* implemented */
639extern SCREEN *newterm(NCURSES_CONST char *,FILE *,FILE *);	/* implemented */
640extern WINDOW *newwin(int,int,int,int);			/* implemented */
641extern int nl(void);					/* implemented */
642extern int nocbreak(void);				/* implemented */
643extern int nodelay(WINDOW *,bool);			/* implemented */
644extern int noecho(void);				/* implemented */
645extern int nonl(void);					/* implemented */
646extern void noqiflush(void);				/* implemented */
647extern int noraw(void);					/* implemented */
648extern int notimeout(WINDOW *,bool);			/* implemented */
649extern int overlay(const WINDOW*,WINDOW *);		/* implemented */
650extern int overwrite(const WINDOW*,WINDOW *);		/* implemented */
651extern int pair_content(short,short*,short*);		/* implemented */
652extern int PAIR_NUMBER(int);				/* generated */
653extern int pechochar(WINDOW *, const chtype);		/* implemented */
654#ifdef _XOPEN_SOURCE_EXTENDED
655extern int pecho_wchar(WINDOW *, const cchar_t *);	/* missing */
656#endif /* _XOPEN_SOURCE_EXTENDED */
657extern int pnoutrefresh(WINDOW*,int,int,int,int,int,int);/* implemented */
658extern int prefresh(WINDOW *,int,int,int,int,int,int);	/* implemented */
659extern int printw(NCURSES_CONST char *,...)		/* implemented */
660		GCC_PRINTFLIKE(1,2);
661extern int putp(const char *);				/* implemented */
662extern int putwin(WINDOW *, FILE *);			/* implemented */
663extern void qiflush(void);				/* implemented */
664extern int raw(void);					/* implemented */
665extern int redrawwin(WINDOW *);				/* generated */
666extern int refresh(void);				/* generated */
667extern int resetty(void);				/* implemented */
668extern int reset_prog_mode(void);			/* implemented */
669extern int reset_shell_mode(void);			/* implemented */
670extern int ripoffline(int, int (*init)(WINDOW *, int));	/* implemented */
671extern int savetty(void);				/* implemented */
672extern int scanw(NCURSES_CONST char *,...)		/* implemented */
673		GCC_SCANFLIKE(1,2);
674extern int scr_dump(const char *);			/* implemented */
675extern int scr_init(const char *);			/* implemented */
676extern int scrl(int);					/* generated */
677extern int scroll(WINDOW *);				/* generated */
678extern int scrollok(WINDOW *,bool);			/* implemented */
679extern int scr_restore(const char *);			/* implemented */
680extern int scr_set(const char *);			/* implemented */
681#ifdef _XOPEN_SOURCE_EXTENDED
682extern int setcchar(cchar_t *, const wchar_t *, const attr_t, short, const void *);	/* missing */
683#endif /* _XOPEN_SOURCE_EXTENDED */
684extern int setscrreg(int,int);				/* generated */
685extern SCREEN *set_term(SCREEN *);			/* implemented */
686extern int slk_attroff(const chtype);			/* implemented */
687extern int slk_attr_off(const attr_t, void *);		/* generated:WIDEC */
688extern int slk_attron(const chtype);			/* implemented */
689extern int slk_attr_on(attr_t,void*);			/* generated:WIDEC */
690extern int slk_attrset(const chtype);			/* implemented */
691extern attr_t slk_attr(void);				/* implemented */
692extern int slk_attr_set(const attr_t,short,void*);	/* implemented */
693extern int slk_clear(void);				/* implemented */
694extern int slk_color(short);				/* implemented */
695extern int slk_init(int);				/* implemented */
696extern char *slk_label(int);				/* implemented */
697extern int slk_noutrefresh(void);			/* implemented */
698extern int slk_refresh(void);				/* implemented */
699extern int slk_restore(void);				/* implemented */
700extern int slk_set(int,const char *,int);		/* implemented */
701extern int slk_touch(void);				/* implemented */
702#ifdef _XOPEN_SOURCE_EXTENDED
703extern int slk_wset(int, const wchar_t *, int);		/* missing */
704#endif /* _XOPEN_SOURCE_EXTENDED */
705extern int standout(void);				/* generated */
706extern int standend(void);				/* generated */
707extern int start_color(void);				/* implemented */
708extern WINDOW *subpad(WINDOW *, int, int, int, int);	/* implemented */
709extern WINDOW *subwin(WINDOW *,int,int,int,int);	/* implemented */
710extern int syncok(WINDOW *, bool);			/* implemented */
711extern chtype termattrs(void);				/* implemented */
712extern attr_t term_attrs(void);				/* missing */
713extern char *termname(void);				/* implemented */
714extern int tigetflag(NCURSES_CONST char *);		/* implemented */
715extern int tigetnum(NCURSES_CONST char *);		/* implemented */
716extern char *tigetstr(NCURSES_CONST char *);		/* implemented */
717extern void timeout(int);				/* generated */
718extern char *tparm(NCURSES_CONST char *, ...);		/* implemented */
719extern int typeahead(int);				/* implemented */
720extern int ungetch(int);				/* implemented */
721#ifdef _XOPEN_SOURCE_EXTENDED
722extern int unget_wch(const wchar_t);			/* missing */
723#endif /* _XOPEN_SOURCE_EXTENDED */
724extern int untouchwin(WINDOW *);			/* generated */
725extern void use_env(bool);				/* implemented */
726extern int vidattr(chtype);				/* implemented */
727extern int vid_attr(attr_t, short, void *);		/* generated:WIDEC */
728extern int vidputs(chtype, int (*)(int));		/* implemented */
729#ifdef _XOPEN_SOURCE_EXTENDED
730extern int vid_puts(attr_t, short, void *, int (*)(int)); /* missing */
731#endif /* _XOPEN_SOURCE_EXTENDED */
732extern int vline(chtype, int);				/* generated */
733#ifdef _XOPEN_SOURCE_EXTENDED
734extern int vline_set(const cchar_t *, int);		/* missing */
735#endif /* _XOPEN_SOURCE_EXTENDED */
736extern int vwprintw(WINDOW *, NCURSES_CONST char *,va_list);	/* implemented */
737extern int vw_printw(WINDOW *, NCURSES_CONST char *,va_list);	/* generated */
738extern int vwscanw(WINDOW *, NCURSES_CONST char *,va_list);	/* implemented */
739extern int vw_scanw(WINDOW *, NCURSES_CONST char *,va_list);	/* generated */
740extern int waddch(WINDOW *, const chtype);		/* implemented */
741extern int waddchnstr(WINDOW *,const chtype *const,int); /* implemented */
742extern int waddchstr(WINDOW *,const chtype *);		/* generated */
743extern int waddnstr(WINDOW *,const char *const,int);	/* implemented */
744extern int waddstr(WINDOW *,const char *);		/* generated */
745#ifdef _XOPEN_SOURCE_EXTENDED
746extern int waddwstr(WINDOW *,const wchar_t *);		/* missing */
747extern int waddnwstr(WINDOW *,const wchar_t *,int);	/* missing */
748extern int wadd_wch(WINDOW *,const cchar_t *);		/* missing */
749extern int wadd_wchnstr(WINDOW *,const cchar_t *,int);	/* missing */
750extern int wadd_wchstr(WINDOW *,const cchar_t *);	/* missing */
751#endif /* _XOPEN_SOURCE_EXTENDED */
752extern int wattron(WINDOW *, int);			/* generated */
753extern int wattroff(WINDOW *, int);			/* generated */
754extern int wattrset(WINDOW *, int);			/* generated */
755extern int wattr_get(WINDOW *, attr_t *, short *, void *);	/* generated */
756extern int wattr_on(WINDOW *, NCURSES_CONST attr_t, void *);	/* implemented */
757extern int wattr_off(WINDOW *, NCURSES_CONST attr_t, void *);	/* implemented */
758extern int wattr_set(WINDOW *, attr_t, short, void *);		/* generated */
759extern int wbkgd(WINDOW *,const chtype);		/* implemented */
760extern void wbkgdset(WINDOW *,chtype);			/* implemented */
761#ifdef _XOPEN_SOURCE_EXTENDED
762extern void wbkgrndset(WINDOW *,const cchar_t *);	/* missing */
763extern int wbkgrnd(WINDOW *,const cchar_t *);		/* missing */
764#endif /* _XOPEN_SOURCE_EXTENDED */
765extern int wborder(WINDOW *,chtype,chtype,chtype,chtype,chtype,chtype,chtype,chtype);	/* implemented */
766#ifdef _XOPEN_SOURCE_EXTENDED
767extern int wborder_set(WINDOW *,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*,const cchar_t*);	/* missing */
768#endif /* _XOPEN_SOURCE_EXTENDED */
769extern int wchgat(WINDOW *, int, attr_t, short, const void *);/* implemented */
770extern int wclear(WINDOW *);				/* implemented */
771extern int wclrtobot(WINDOW *);				/* implemented */
772extern int wclrtoeol(WINDOW *);				/* implemented */
773extern int wcolor_set(WINDOW*,short,void*);		/* implemented */
774extern void wcursyncup(WINDOW *);			/* implemented */
775extern int wdelch(WINDOW *);				/* implemented */
776extern int wdeleteln(WINDOW *);				/* generated */
777extern int wechochar(WINDOW *, const chtype);		/* implemented */
778#ifdef _XOPEN_SOURCE_EXTENDED
779extern int wecho_wchar(WINDOW *, const cchar_t *);	/* missing */
780#endif /* _XOPEN_SOURCE_EXTENDED */
781extern int werase(WINDOW *);				/* implemented */
782#ifdef _XOPEN_SOURCE_EXTENDED
783extern int wgetbkgrnd(WINDOW *, cchar_t *);		/* missing */
784#endif /* _XOPEN_SOURCE_EXTENDED */
785extern int wgetch(WINDOW *);				/* implemented */
786extern int wgetnstr(WINDOW *,char *,int);		/* implemented */
787#ifdef _XOPEN_SOURCE_EXTENDED
788extern int wgetn_wstr(WINDOW *,wint_t *, int);		/* missing */
789#endif /* _XOPEN_SOURCE_EXTENDED */
790extern int wgetstr(WINDOW *, char *);			/* generated */
791#ifdef _XOPEN_SOURCE_EXTENDED
792extern int wget_wch(WINDOW *, wint_t *);		/* missing */
793extern int wget_wstr(WINDOW *, wint_t *);		/* missing */
794#endif /* _XOPEN_SOURCE_EXTENDED */
795extern int whline(WINDOW *, chtype, int);		/* implemented */
796#ifdef _XOPEN_SOURCE_EXTENDED
797extern int whline_set(WINDOW *, const cchar_t *, int);	/* missing */
798#endif /* _XOPEN_SOURCE_EXTENDED */
799extern chtype winch(WINDOW *);				/* implemented */
800extern int winchnstr(WINDOW *, chtype *, int);		/* implemented */
801extern int winchstr(WINDOW *, chtype *);		/* generated */
802extern int winnstr(WINDOW *, char *, int);		/* implemented */
803#ifdef _XOPEN_SOURCE_EXTENDED
804extern int winnwstr(WINDOW *, wchar_t *, int);		/* missing */
805#endif /* _XOPEN_SOURCE_EXTENDED */
806extern int winsch(WINDOW *, chtype);			/* implemented */
807extern int winsdelln(WINDOW *,int);			/* implemented */
808extern int winsertln(WINDOW *);				/* generated */
809extern int winsnstr(WINDOW *, const char *,int);	/* implemented */
810extern int winsstr(WINDOW *, const char *);		/* generated */
811extern int winstr(WINDOW *, char *);			/* generated */
812#ifdef _XOPEN_SOURCE_EXTENDED
813extern int wins_nwstr(WINDOW *, const wchar_t *, int);	/* missing */
814extern int wins_wch(WINDOW *, const cchar_t *);		/* missing */
815extern int wins_wstr(WINDOW *, const wchar_t *);	/* missing */
816extern int winwstr(WINDOW *, wchar_t *);		/* missing */
817extern int win_wch(WINDOW *, NCURSES_CONST cchar_t *);	/* missing */
818extern int win_wchnstr(WINDOW *, NCURSES_CONST cchar_t *, int);	/* missing */
819extern int win_wchstr(WINDOW *, NCURSES_CONST cchar_t *);	/* missing */
820#endif /* _XOPEN_SOURCE_EXTENDED */
821extern int wmove(WINDOW *,int,int);			/* implemented */
822extern int wnoutrefresh(WINDOW *);			/* implemented */
823extern int wprintw(WINDOW *, NCURSES_CONST char *,...)	/* implemented */
824		GCC_PRINTFLIKE(2,3);
825extern int wredrawln(WINDOW *,int,int);			/* implemented */
826extern int wrefresh(WINDOW *);				/* implemented */
827extern int wscanw(WINDOW *, NCURSES_CONST char *,...)	/* implemented */
828		GCC_SCANFLIKE(2,3);
829extern int wscrl(WINDOW *,int);				/* implemented */
830extern int wsetscrreg(WINDOW *,int,int);		/* implemented */
831extern int wstandout(WINDOW *);				/* generated */
832extern int wstandend(WINDOW *);				/* generated */
833extern void wsyncdown(WINDOW *);			/* implemented */
834extern void wsyncup(WINDOW *);				/* implemented */
835extern void wtimeout(WINDOW *,int);			/* implemented */
836extern int wtouchln(WINDOW *,int,int,int);		/* implemented */
837#ifdef _XOPEN_SOURCE_EXTENDED
838extern wchar_t *wunctrl(cchar_t *);			/* missing */
839#endif /* _XOPEN_SOURCE_EXTENDED */
840extern int wvline(WINDOW *,chtype,int);			/* implemented */
841#ifdef _XOPEN_SOURCE_EXTENDED
842extern int wvline_set(WINDOW *, const cchar_t *, int);	/* missing */
843#endif /* _XOPEN_SOURCE_EXTENDED */
844
845extern bool mouse_trafo(int*, int*, bool);              /* generated */
846
847/* attributes */
848
849#define NCURSES_BITS(mask,shift) ((mask) << ((shift) + @cf_cv_widec_shift@))
850
851#define A_NORMAL	0L
852#define A_ATTRIBUTES	NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
853#define A_CHARTEXT	(NCURSES_BITS(@cf_cv_1UL@,0) - @cf_cv_1UL@)
854#define A_COLOR		NCURSES_BITS(((@cf_cv_1UL@) << 8) - @cf_cv_1UL@,0)
855#define A_STANDOUT	NCURSES_BITS(@cf_cv_1UL@,8)
856#define A_UNDERLINE	NCURSES_BITS(@cf_cv_1UL@,9)
857#define A_REVERSE	NCURSES_BITS(@cf_cv_1UL@,10)
858#define A_BLINK		NCURSES_BITS(@cf_cv_1UL@,11)
859#define A_DIM		NCURSES_BITS(@cf_cv_1UL@,12)
860#define A_BOLD		NCURSES_BITS(@cf_cv_1UL@,13)
861#define A_ALTCHARSET	NCURSES_BITS(@cf_cv_1UL@,14)
862#define A_INVIS		NCURSES_BITS(@cf_cv_1UL@,15)
863
864/* Tradeoff on 32-bit machines ('protect' vs widec).  The others (e.g., left
865 * highlight are not implemented in any terminal descriptions, anyway.
866 */
867#if ((16 + @cf_cv_widec_shift@) < @cf_cv_shift_limit@)
868#define A_PROTECT	NCURSES_BITS(@cf_cv_1UL@,16)
869#define A_HORIZONTAL	NCURSES_BITS(@cf_cv_1UL@,17)
870#define A_LEFT		NCURSES_BITS(@cf_cv_1UL@,18)
871#define A_LOW		NCURSES_BITS(@cf_cv_1UL@,19)
872#define A_RIGHT		NCURSES_BITS(@cf_cv_1UL@,20)
873#define A_TOP		NCURSES_BITS(@cf_cv_1UL@,21)
874#define A_VERTICAL	NCURSES_BITS(@cf_cv_1UL@,22)
875#else
876#define A_PROTECT	0L
877#define A_HORIZONTAL	0L
878#define A_LEFT		0L
879#define A_LOW		0L
880#define A_RIGHT		0L
881#define A_TOP		0L
882#define A_VERTICAL	0L
883#endif
884
885#define COLOR_PAIR(n)	NCURSES_BITS(n, 0)
886#define PAIR_NUMBER(a)	(((a) & A_COLOR) >> @cf_cv_widec_shift@)
887
888/*
889 * pseudo functions
890 */
891#define wgetstr(w, s)		wgetnstr(w, s, -1)
892#define getnstr(s, n)		wgetnstr(stdscr, s, n)
893
894#define setterm(term)		setupterm(term, 1, (int *)0)
895
896#define fixterm()		reset_prog_mode()
897#define resetterm()		reset_shell_mode()
898#define saveterm()		def_prog_mode()
899#define crmode()		cbreak()
900#define nocrmode()		nocbreak()
901#define gettmode()
902
903#define getyx(win,y,x)   	(y = (win)?(win)->_cury:ERR, x = (win)?(win)->_curx:ERR)
904#define getbegyx(win,y,x)	(y = (win)?(win)->_begy:ERR, x = (win)?(win)->_begx:ERR)
905#define getmaxyx(win,y,x)	(y = (win)?((win)->_maxy + 1):ERR, x = (win)?((win)->_maxx + 1):ERR)
906#define getparyx(win,y,x)	(y = (win)?(win)->_pary:ERR, x = (win)?(win)->_parx:ERR)
907#define getsyx(y,x) do { if(newscr->_leaveok) (y)=(x)=-1; \
908			 else getyx(newscr,(y),(x)); \
909		    } while(0)
910#define setsyx(y,x) do { if((y)==-1 && (x)==-1) newscr->_leaveok=TRUE; \
911			 else {newscr->_leaveok=FALSE;wmove(newscr,(y),(x));} \
912		    } while(0)
913
914/* It seems older SYSV curses versions define these */
915#define getattrs(win)		((win)?(win)->_attrs:A_NORMAL)
916#define getcurx(win)		((win)?(win)->_curx:ERR)
917#define getcury(win)		((win)?(win)->_cury:ERR)
918#define getbegx(win)		((win)?(win)->_begx:ERR)
919#define getbegy(win)		((win)?(win)->_begy:ERR)
920#define getmaxx(win)		((win)?((win)->_maxx + 1):ERR)
921#define getmaxy(win)		((win)?((win)->_maxy + 1):ERR)
922#define getparx(win)		((win)?(win)->_parx:ERR)
923#define getpary(win)		((win)?(win)->_pary:ERR)
924
925#define wstandout(win)      	(wattrset(win,A_STANDOUT))
926#define wstandend(win)      	(wattrset(win,A_NORMAL))
927#define wattr_set(win,a,p,opts) ((win)->_attrs = (((a) & ~A_COLOR) | COLOR_PAIR(p)), OK)
928
929#define wattron(win,at)		wattr_on(win, at, (void *)0)
930#define wattroff(win,at)	wattr_off(win, at, (void *)0)
931#define wattrset(win,at)    	((win)->_attrs = (at))
932
933#define scroll(win)		wscrl(win,1)
934
935#define touchwin(win)		wtouchln((win), 0, getmaxy(win), 1)
936#define touchline(win, s, c)	wtouchln((win), s, c, 1)
937#define untouchwin(win)		wtouchln((win), 0, getmaxy(win), 0)
938
939#define box(win, v, h)		wborder(win, v, v, h, h, 0, 0, 0, 0)
940#define border(ls, rs, ts, bs, tl, tr, bl, br)	wborder(stdscr, ls, rs, ts, bs, tl, tr, bl, br)
941#define hline(ch, n)		whline(stdscr, ch, n)
942#define vline(ch, n)		wvline(stdscr, ch, n)
943
944#define winstr(w, s)		winnstr(w, s, -1)
945#define winchstr(w, s)		winchnstr(w, s, -1)
946#define winsstr(w, s)		winsnstr(w, s, -1)
947
948#define redrawwin(w)		wredrawln(w, 0, w->_maxy+1)
949#define waddstr(win,str)	waddnstr(win,str,-1)
950#define waddchstr(win,str)	waddchnstr(win,str,-1)
951
952/*
953 * pseudo functions for standard screen
954 */
955
956#define addch(ch)      		waddch(stdscr,ch)
957#define addchnstr(str,n)	waddchnstr(stdscr,str,n)
958#define addchstr(str)		waddchstr(stdscr,str)
959#define addnstr(str,n)		waddnstr(stdscr,str,n)
960#define addstr(str)    		waddnstr(stdscr,str,-1)
961#define attroff(at)    		wattroff(stdscr,at)
962#define attron(at)     		wattron(stdscr,at)
963#define attrset(at)    		wattrset(stdscr,at)
964#define bkgd(ch)		wbkgd(stdscr,ch)
965#define bkgdset(ch)		wbkgdset(stdscr,ch)
966#define clear()        		wclear(stdscr)
967#define clrtobot()     		wclrtobot(stdscr)
968#define clrtoeol()     		wclrtoeol(stdscr)
969#define color_set(c,o)		wcolor_set(stdscr,c,o)
970#define delch()        		wdelch(stdscr)
971#define deleteln()     		winsdelln(stdscr,-1)
972#define echochar(c)		wechochar(stdscr,c)
973#define erase()        		werase(stdscr)
974#define getch()        		wgetch(stdscr)
975#define getstr(str)    		wgetstr(stdscr,str)
976#define inch()       		winch(stdscr)
977#define inchnstr(s,n)		winchnstr(stdscr,s,n)
978#define inchstr(s)		winchstr(stdscr,s)
979#define innstr(s,n)		winnstr(stdscr,s,n)
980#define insch(c)       		winsch(stdscr,c)
981#define insdelln(n)		winsdelln(stdscr,n)
982#define insertln()     		winsdelln(stdscr,1)
983#define insnstr(s,n)		winsnstr(stdscr,s,n)
984#define insstr(s)		winsstr(stdscr,s)
985#define instr(s)		winstr(stdscr,s)
986#define move(y,x)     		wmove(stdscr,y,x)
987#define refresh()      		wrefresh(stdscr)
988#define scrl(n)			wscrl(stdscr,n)
989#define setscrreg(t,b) 		wsetscrreg(stdscr,t,b)
990#define standend()     		wstandend(stdscr)
991#define standout()     		wstandout(stdscr)
992#define timeout(delay)		wtimeout(stdscr,delay)
993#define wdeleteln(win)     	winsdelln(win,-1)
994#define winsertln(win)     	winsdelln(win,1)
995
996/*
997 * mv functions
998 */
999
1000#define mvwaddch(win,y,x,ch)    	(wmove(win,y,x) == ERR ? ERR : waddch(win,ch))
1001#define mvwaddchnstr(win,y,x,str,n)	(wmove(win,y,x) == ERR ? ERR : waddchnstr(win,str,n))
1002#define mvwaddchstr(win,y,x,str)  	(wmove(win,y,x) == ERR ? ERR : waddchnstr(win,str,-1))
1003#define mvwaddnstr(win,y,x,str,n)	(wmove(win,y,x) == ERR ? ERR : waddnstr(win,str,n))
1004#define mvwaddstr(win,y,x,str)  	(wmove(win,y,x) == ERR ? ERR : waddnstr(win,str,-1))
1005#define mvwdelch(win,y,x)       	(wmove(win,y,x) == ERR ? ERR : wdelch(win))
1006#define mvwgetch(win,y,x)       	(wmove(win,y,x) == ERR ? ERR : wgetch(win))
1007#define mvwgetnstr(win,y,x,str,n)    	(wmove(win,y,x) == ERR ? ERR : wgetnstr(win,str,n))
1008#define mvwgetstr(win,y,x,str)      	(wmove(win,y,x) == ERR ? ERR : wgetstr(win,str))
1009#define mvwhline(win,y,x,c,n)     	(wmove(win,y,x) == ERR ? ERR : whline(win,c,n))
1010#define mvwinch(win,y,x)        	(wmove(win,y,x) == ERR ? (chtype)ERR : winch(win))
1011#define mvwinchnstr(win,y,x,s,n)	(wmove(win,y,x) == ERR ? ERR : winchnstr(win,s,n))
1012#define mvwinchstr(win,y,x,s)		(wmove(win,y,x) == ERR ? ERR : winchstr(win,s))
1013#define mvwinnstr(win,y,x,s,n)		(wmove(win,y,x) == ERR ? ERR : winnstr(win,s,n))
1014#define mvwinsch(win,y,x,c)     	(wmove(win,y,x) == ERR ? ERR : winsch(win,c))
1015#define mvwinsnstr(win,y,x,s,n)		(wmove(win,y,x) == ERR ? ERR : winsnstr(win,s,n))
1016#define mvwinsstr(win,y,x,s)		(wmove(win,y,x) == ERR ? ERR : winsstr(win,s))
1017#define mvwinstr(win,y,x,s)		(wmove(win,y,x) == ERR ? ERR : winstr(win,s))
1018#define mvwvline(win,y,x,c,n)     	(wmove(win,y,x) == ERR ? ERR : wvline(win,c,n))
1019
1020#define mvaddch(y,x,ch)         	mvwaddch(stdscr,y,x,ch)
1021#define mvaddchnstr(y,x,str,n)		mvwaddchnstr(stdscr,y,x,str,n)
1022#define mvaddchstr(y,x,str)		mvwaddchstr(stdscr,y,x,str)
1023#define mvaddnstr(y,x,str,n)		mvwaddnstr(stdscr,y,x,str,n)
1024#define mvaddstr(y,x,str)       	mvwaddstr(stdscr,y,x,str)
1025#define mvdelch(y,x)            	mvwdelch(stdscr,y,x)
1026#define mvgetch(y,x)            	mvwgetch(stdscr,y,x)
1027#define mvgetnstr(y,x,str,n)		mvwgetnstr(stdscr,y,x,str,n)
1028#define mvgetstr(y,x,str)           	mvwgetstr(stdscr,y,x,str)
1029#define mvhline(y,x,c,n)		mvwhline(stdscr,y,x,c,n)
1030#define mvinch(y,x)             	mvwinch(stdscr,y,x)
1031#define mvinchnstr(y,x,s,n)		mvwinchnstr(stdscr,y,x,s,n)
1032#define mvinchstr(y,x,s)		mvwinchstr(stdscr,y,x,s)
1033#define mvinnstr(y,x,s,n)		mvwinnstr(stdscr,y,x,s,n)
1034#define mvinsch(y,x,c)          	mvwinsch(stdscr,y,x,c)
1035#define mvinsnstr(y,x,s,n)		mvwinsnstr(stdscr,y,x,s,n)
1036#define mvinsstr(y,x,s)			mvwinsstr(stdscr,y,x,s)
1037#define mvinstr(y,x,s)			mvwinstr(stdscr,y,x,s)
1038#define mvvline(y,x,c,n)		mvwvline(stdscr,y,x,c,n)
1039
1040/*
1041 * XSI curses macros for XPG4 conformance.
1042 * The underlying functions needed to make these work are:
1043 * waddnwstr(), waddchnwstr(), wadd_wch(), wborder_set(), wchgat(),
1044 * wecho_wchar(), wgetn_wstr(), wget_wch(), whline_set(), vhline_set(),
1045 * winnwstr(), wins_nwstr(), wins_wch(), win_wch(), win_wchnstr().
1046 * Except for wchgat(), these are not yet implemented.  They will be someday.
1047 */
1048#define add_wch(c)			wadd_wch(stdscr,c)
1049#define addnwstr(wstr,n)		waddnwstr(stdscr,wstr,n)
1050#define addwstr(wstr,n)			waddnwstr(stdscr,wstr,-1)
1051#define attr_get(a,pair,opts)		wattr_get(stdscr,a,pair,opts)
1052#define attr_off(a,opts)		wattr_off(stdscr,a,opts)
1053#define attr_on(a,opts)			wattr_on(stdscr,a,opts)
1054#define attr_set(a,pair,opts)		wattr_set(stdscr,a,pair,opts)
1055#define box_set(w,v,h)			wborder_set(w,v,v,h,h,0,0,0,0)
1056#define chgat(n,a,c,o)			wchgat(stdscr,n,a,c,o)
1057#define echo_wchar(c)			wecho_wchar(stdscr,c)
1058#define getbkgd(win)			((win)->_bkgd)
1059#define get_wch(c)			wget_wch(stdscr,c)
1060#define get_wstr(t)			wgetn_wstr(stdscr,t,-1)
1061#define getn_wstr(t,n)			wgetn_wstr(stdscr,t,n)
1062#define hline_set(c,n)			whline_set(stdscr,c,n)
1063#define in_wch(c)			win_wch(stdscr,c)
1064#define in_wchnstr(c,n)			win_wchnstr(stdscr,c,n)
1065#define in_wchstr(c)			win_wchnstr(stdscr,c,-1)
1066#define innwstr(c,n)			winnwstr(stdscr,c,n)
1067#define ins_nwstr(t,n)			wins_nwstr(stdscr,t,n)
1068#define ins_wch(c)			wins_wch(stdscr,c)
1069#define ins_wstr(t)			wins_nwstr(stdscr,t,-1)
1070#define inwstr(c)			winnwstr(stdscr,c,-1)
1071
1072#define mvadd_wch(y,x,c)		mvwadd_wch(stdscr,y,x,c)
1073#define mvaddnwstr(y,x,wstr,n)		mvwaddnwstr(stdscr,y,x,wstr,n)
1074#define mvaddwstr(y,x,wstr,n)		mvwaddnwstr(stdscr,y,x,wstr,-1)
1075#define mvchgat(y,x,n,a,c,o)		mvwchgat(stdscr,y,x,n,a,c,o)
1076#define mvget_wch(y,x,c)		mvwget_wch(stdscr,y,x,c)
1077#define mvget_wstr(y,x,t)		mvwgetn_wstr(stdscr,y,x,t,-1)
1078#define mvgetn_wstr(y,x,t,n)		mvwgetn_wstr(stdscr,y,x,t,n)
1079#define mvhline_set(y,x,c,n)		mvwhline_set(stdscr,y,x,c,n)
1080#define mvin_wch(y,x,c)			mvwin_wch(stdscr,y,x,c)
1081#define mvin_wchnstr(y,x,c,n)		mvwin_wchnstr(stdscr,y,x,c,n)
1082#define mvin_wchstr(y,x,c)		mvwin_wchnstr(stdscr,y,x,c,-1)
1083#define mvinnwstr(y,x,c,n)		mvwinnwstr(stdscr,y,x,c,n)
1084#define mvins_nwstr(y,x,t,n)		mvwins_nwstr(stdscr,y,x,t,n)
1085#define mvins_wch(y,x,c)		mvwins_wch(stdscr,y,x,c)
1086#define mvins_wstr(y,x,t)		mvwins_nwstr(stdscr,y,x,t,-1)
1087#define mvinwstr(y,x,c)			mvwinnwstr(stdscr,y,x,c,-1)
1088#define mvvline_set(y,x,c,n)		mvwvline_set(stdscr,y,x,c,n)
1089
1090#define mvwadd_wch(win,y,x,c)		(wmove(win,y,x) == ERR ? ERR : wadd_wch(stdscr,c))
1091#define mvwaddnwstr(win,y,x,wstr,n)	(wmove(win,y,x) == ERR ? ERR : waddnwstr(stdscr,wstr,n))
1092#define mvwaddwstr(win,y,x,wstr,n)	(wmove(win,y,x) == ERR ? ERR : waddnwstr(stdscr,wstr,-1))
1093#define mvwchgat(win,y,x,n,a,c,o)	(wmove(win,y,x) == ERR ? ERR : wchgat(win,n,a,c,o))
1094#define mvwget_wch(win,y,x,c)		(wmove(win,y,x) == ERR ? ERR : wget_wch(win,c))
1095#define mvwget_wstr(win,y,x,t)		(wmove(win,y,x) == ERR ? ERR : wgetn_wstr(win,t,-1))
1096#define mvwgetn_wstr(win,y,x,t,n)	(wmove(win,y,x) == ERR ? ERR : wgetn_wstr(win,t,n))
1097#define mvwhline_set(win,y,x,c,n)	(wmove(win,y,x) == ERR ? ERR : whline_set(win,c,n))
1098#define mvwin_wch(win,y,x,c)		(wmove(win,y,x) == ERR ? ERR : win_wch(win,c))
1099#define mvwin_wchnstr(win,y,x,c,n)	(wmove(win,y,x) == ERR ? ERR : win_wchnstr(stdscr,c,n))
1100#define mvwin_wchstr(win,y,x,c)		(wmove(win,y,x) == ERR ? ERR : win_wchnstr(stdscr,c,-1))
1101#define mvwinnwstr(win,y,x,c,n)		(wmove(win,y,x) == ERR ? ERR : winnwstr(stdscr,c,n))
1102#define mvwins_nwstr(win,y,x,t,n)	(wmove(win,y,x) == ERR ? ERR : wins_nwstr(stdscr,t,n))
1103#define mvwins_wch(win,y,x,c)		(wmove(win,y,x) == ERR ? ERR : wins_wch(stdscr,c))
1104#define mvwins_wstr(win,y,x,t)		(wmove(win,y,x) == ERR ? ERR : wins_nwstr(stdscr,t,-1))
1105#define mvwinwstr(win,y,x,c)		(wmove(win,y,x) == ERR ? ERR : winnwstr(stdscr,c,-1))
1106#define mvwvline_set(win,y,x,c,n)	(wmove(win,y,x) == ERR ? ERR : wvline_set(win,c,n))
1107
1108#define slk_attr_off(a,v)		((v) ? ERR : slk_attroff(a))
1109#define slk_attr_on(a,v)		((v) ? ERR : slk_attron(a))
1110
1111#define vid_attr(a,pair,opts)		vidattr(a)
1112#define vline_set(c,n)			wvline_set(stdscr,c,n)
1113#define waddwstr(win,wstr,n)		waddnwstr(win,wstr,-1)
1114#define wattr_get(win,a,p,opts)		((void)((a) != 0 && (*(a) = (win)->_attrs)), \
1115					 (void)((p) != 0 && (*(p) = PAIR_NUMBER((win)->_attrs))), \
1116					 OK)
1117#define wget_wstr(w,t)			wgetn_wstr(w,t,-1)
1118#define win_wchstr(w,c)			win_wchnstr(w,c,-1)
1119#define wins_wstr(w,t)			wins_nwstr(w,t,-1)
1120#define winwstr(w,c)			winnwstr(w,c,-1)
1121
1122
1123/*
1124 * XSI curses deprecates SVr4 vwprintw/vwscanw, which are supposed to use
1125 * varargs.h.  It adds new calls vw_printw/vw_scanw, which are supposed to
1126 * use POSIX stdarg.h.  The ncurses versions of vwprintw/vwscanw already
1127 * use stdarg.h, so...
1128 */
1129#define vw_printw		vwprintw
1130#define vw_scanw		vwscanw
1131
1132/*
1133 * Pseudo-character tokens outside ASCII range.  The curses wgetch() function
1134 * will return any given one of these only if the corresponding k- capability
1135 * is defined in your terminal's terminfo entry.
1136 */
1137#define KEY_CODE_YES	0400		/* A wchar_t contains a key code */
1138#define KEY_MIN		0401		/* Minimum curses key */
1139#define KEY_BREAK       0401            /* Break key (unreliable) */
1140#define KEY_DOWN        0402            /* Down-arrow */
1141#define KEY_UP          0403		/* Up-arrow */
1142#define KEY_LEFT        0404		/* Left-arrow */
1143#define KEY_RIGHT       0405            /* Right-arrow */
1144#define KEY_HOME        0406            /* Home key (upward+left arrow) */
1145#define KEY_BACKSPACE   0407            /* Backspace (unreliable) */
1146#define KEY_F0          0410            /* Function keys.  Space for 64 */
1147#define KEY_F(n)        (KEY_F0+(n))    /* Value of function key n */
1148#define KEY_DL          0510            /* Delete line */
1149#define KEY_IL          0511            /* Insert line */
1150#define KEY_DC          0512            /* Delete character */
1151#define KEY_IC          0513            /* Insert char or enter insert mode */
1152#define KEY_EIC         0514            /* Exit insert char mode */
1153#define KEY_CLEAR       0515            /* Clear screen */
1154#define KEY_EOS         0516            /* Clear to end of screen */
1155#define KEY_EOL         0517            /* Clear to end of line */
1156#define KEY_SF          0520            /* Scroll 1 line forward */
1157#define KEY_SR          0521            /* Scroll 1 line backward (reverse) */
1158#define KEY_NPAGE       0522            /* Next page */
1159#define KEY_PPAGE       0523            /* Previous page */
1160#define KEY_STAB        0524            /* Set tab */
1161#define KEY_CTAB        0525            /* Clear tab */
1162#define KEY_CATAB       0526            /* Clear all tabs */
1163#define KEY_ENTER       0527            /* Enter or send (unreliable) */
1164#define KEY_SRESET      0530            /* Soft (partial) reset (unreliable) */
1165#define KEY_RESET       0531            /* Reset or hard reset (unreliable) */
1166#define KEY_PRINT       0532            /* Print */
1167#define KEY_LL          0533            /* Home down or bottom (lower left) */
1168
1169/* The keypad is arranged like this: */
1170/* a1    up    a3   */
1171/* left   b2  right  */
1172/* c1   down   c3   */
1173
1174#define KEY_A1		0534		/* Upper left of keypad */
1175#define KEY_A3		0535		/* Upper right of keypad */
1176#define KEY_B2		0536		/* Center of keypad */
1177#define KEY_C1		0537		/* Lower left of keypad */
1178#define KEY_C3		0540		/* Lower right of keypad */
1179#define KEY_BTAB	0541		/* Back tab */
1180#define KEY_BEG		0542		/* Beg (beginning) */
1181#define KEY_CANCEL	0543		/* Cancel */
1182#define KEY_CLOSE	0544		/* Close */
1183#define KEY_COMMAND	0545		/* Cmd (command) */
1184#define KEY_COPY	0546		/* Copy */
1185#define KEY_CREATE	0547		/* Create */
1186#define KEY_END		0550		/* End */
1187#define KEY_EXIT	0551		/* Exit */
1188#define KEY_FIND	0552		/* Find */
1189#define KEY_HELP	0553		/* Help */
1190#define KEY_MARK	0554		/* Mark */
1191#define KEY_MESSAGE	0555		/* Message */
1192#define KEY_MOVE	0556		/* Move */
1193#define KEY_NEXT	0557		/* Next */
1194#define KEY_OPEN	0560		/* Open */
1195#define KEY_OPTIONS	0561		/* Options */
1196#define KEY_PREVIOUS	0562		/* Prev (previous) */
1197#define KEY_REDO	0563		/* Redo */
1198#define KEY_REFERENCE	0564		/* Ref (reference) */
1199#define KEY_REFRESH	0565		/* Refresh */
1200#define KEY_REPLACE	0566		/* Replace */
1201#define KEY_RESTART	0567		/* Restart */
1202#define KEY_RESUME	0570		/* Resume */
1203#define KEY_SAVE	0571		/* Save */
1204#define KEY_SBEG	0572		/* Shifted Beg (beginning) */
1205#define KEY_SCANCEL	0573		/* Shifted Cancel */
1206#define KEY_SCOMMAND	0574		/* Shifted Command */
1207#define KEY_SCOPY	0575		/* Shifted Copy */
1208#define KEY_SCREATE	0576		/* Shifted Create */
1209#define KEY_SDC		0577		/* Shifted Delete char */
1210#define KEY_SDL		0600		/* Shifted Delete line */
1211#define KEY_SELECT	0601		/* Select */
1212#define KEY_SEND	0602		/* Shifted End */
1213#define KEY_SEOL	0603		/* Shifted Clear line */
1214#define KEY_SEXIT	0604		/* Shifted Dxit */
1215#define KEY_SFIND	0605		/* Shifted Find */
1216#define KEY_SHELP	0606		/* Shifted Help */
1217#define KEY_SHOME	0607		/* Shifted Home */
1218#define KEY_SIC		0610		/* Shifted Input */
1219#define KEY_SLEFT	0611		/* Shifted Left arrow */
1220#define KEY_SMESSAGE	0612		/* Shifted Message */
1221#define KEY_SMOVE	0613		/* Shifted Move */
1222#define KEY_SNEXT	0614		/* Shifted Next */
1223#define KEY_SOPTIONS	0615		/* Shifted Options */
1224#define KEY_SPREVIOUS	0616		/* Shifted Prev */
1225#define KEY_SPRINT	0617		/* Shifted Print */
1226#define KEY_SREDO	0620		/* Shifted Redo */
1227#define KEY_SREPLACE	0621		/* Shifted Replace */
1228#define KEY_SRIGHT	0622		/* Shifted Right arrow */
1229#define KEY_SRSUME	0623		/* Shifted Resume */
1230#define KEY_SSAVE	0624		/* Shifted Save */
1231#define KEY_SSUSPEND	0625		/* Shifted Suspend */
1232#define KEY_SUNDO	0626		/* Shifted Undo */
1233#define KEY_SUSPEND	0627		/* Suspend */
1234#define KEY_UNDO	0630		/* Undo */
1235#define KEY_MOUSE	0631		/* Mouse event has occurred */
1236#define KEY_RESIZE	0632		/* Terminal resize event */
1237#define KEY_MAX		0777		/* Maximum key value */
1238
1239/* mouse interface */
1240#define NCURSES_MOUSE_VERSION	1
1241
1242/* event masks */
1243#define	BUTTON1_RELEASED	000000000001L
1244#define	BUTTON1_PRESSED		000000000002L
1245#define	BUTTON1_CLICKED		000000000004L
1246#define	BUTTON1_DOUBLE_CLICKED	000000000010L
1247#define	BUTTON1_TRIPLE_CLICKED	000000000020L
1248#define BUTTON1_RESERVED_EVENT	000000000040L
1249#define	BUTTON2_RELEASED	000000000100L
1250#define	BUTTON2_PRESSED		000000000200L
1251#define	BUTTON2_CLICKED		000000000400L
1252#define	BUTTON2_DOUBLE_CLICKED	000000001000L
1253#define	BUTTON2_TRIPLE_CLICKED	000000002000L
1254#define BUTTON2_RESERVED_EVENT	000000004000L
1255#define	BUTTON3_RELEASED	000000010000L
1256#define	BUTTON3_PRESSED		000000020000L
1257#define	BUTTON3_CLICKED		000000040000L
1258#define	BUTTON3_DOUBLE_CLICKED	000000100000L
1259#define	BUTTON3_TRIPLE_CLICKED	000000200000L
1260#define BUTTON3_RESERVED_EVENT	000000400000L
1261#define	BUTTON4_RELEASED	000001000000L
1262#define	BUTTON4_PRESSED		000002000000L
1263#define	BUTTON4_CLICKED		000004000000L
1264#define	BUTTON4_DOUBLE_CLICKED	000010000000L
1265#define	BUTTON4_TRIPLE_CLICKED	000020000000L
1266#define BUTTON4_RESERVED_EVENT	000040000000L
1267#define BUTTON_CTRL		000100000000L
1268#define BUTTON_SHIFT		000200000000L
1269#define BUTTON_ALT		000400000000L
1270#define	ALL_MOUSE_EVENTS	000777777777L
1271#define	REPORT_MOUSE_POSITION	001000000000L
1272
1273/* macros to extract single event-bits from masks */
1274#define	BUTTON_RELEASE(e, x)		((e) & (001 << (6 * ((x) - 1))))
1275#define	BUTTON_PRESS(e, x)		((e) & (002 << (6 * ((x) - 1))))
1276#define	BUTTON_CLICK(e, x)		((e) & (004 << (6 * ((x) - 1))))
1277#define	BUTTON_DOUBLE_CLICK(e, x)	((e) & (010 << (6 * ((x) - 1))))
1278#define	BUTTON_TRIPLE_CLICK(e, x)	((e) & (020 << (6 * ((x) - 1))))
1279#define	BUTTON_RESERVED_EVENT(e, x)	((e) & (040 << (6 * ((x) - 1))))
1280
1281typedef unsigned long mmask_t;
1282
1283typedef struct
1284{
1285    short id;		/* ID to distinguish multiple devices */
1286    int x, y, z;	/* event coordinates (character-cell) */
1287    mmask_t bstate;	/* button state bits */
1288}
1289MEVENT;
1290
1291extern int getmouse(MEVENT *);
1292extern int ungetmouse(MEVENT *);
1293extern mmask_t mousemask(mmask_t, mmask_t *);
1294extern bool wenclose(const WINDOW *, int, int);
1295extern int mouseinterval(int);
1296extern bool wmouse_trafo(const WINDOW* win,int* y, int* x, bool to_screen);
1297
1298#define mouse_trafo(y,x,to_screen) wmouse_trafo(stdscr,y,x,to_screen)
1299
1300/* other non-XSI functions */
1301
1302extern int mcprint(char *, int);	/* direct data to printer */
1303extern int has_key(int);		/* do we have given key? */
1304
1305/* Debugging : use with libncurses_g.a */
1306
1307extern void _tracef(const char *, ...) GCC_PRINTFLIKE(1,2);
1308extern void _tracedump(const char *, WINDOW *);
1309extern char *_traceattr(attr_t);
1310extern char *_traceattr2(int, chtype);
1311extern char *_nc_tracebits(void);
1312extern char *_tracechar(const unsigned char);
1313extern char *_tracechtype(chtype);
1314extern char *_tracechtype2(int, chtype);
1315extern char *_tracemouse(const MEVENT *);
1316extern void trace(const unsigned int);
1317
1318/* trace masks */
1319#define TRACE_DISABLE	0x0000	/* turn off tracing */
1320#define TRACE_TIMES	0x0001	/* trace user and system times of updates */
1321#define TRACE_TPUTS	0x0002	/* trace tputs calls */
1322#define TRACE_UPDATE	0x0004	/* trace update actions, old & new screens */
1323#define TRACE_MOVE	0x0008	/* trace cursor moves and scrolls */
1324#define TRACE_CHARPUT	0x0010	/* trace all character outputs */
1325#define TRACE_ORDINARY	0x001F	/* trace all update actions */
1326#define TRACE_CALLS	0x0020	/* trace all curses calls */
1327#define TRACE_VIRTPUT	0x0040	/* trace virtual character puts */
1328#define TRACE_IEVENT	0x0080	/* trace low-level input processing */
1329#define TRACE_BITS	0x0100	/* trace state of TTY control bits */
1330#define TRACE_ICALLS	0x0200	/* trace internal/nested calls */
1331#define TRACE_CCALLS	0x0400	/* trace per-character calls */
1332#define TRACE_MAXIMUM	0xffff	/* maximum trace level */
1333
1334#if defined(TRACE) || defined(NCURSES_TEST)
1335extern int _nc_optimize_enable;		/* enable optimizations */
1336extern const char *_nc_visbuf(const char *);
1337#define OPTIMIZE_MVCUR		0x01	/* cursor movement optimization */
1338#define OPTIMIZE_HASHMAP	0x02	/* diff hashing to detect scrolls */
1339#define OPTIMIZE_SCROLL		0x04	/* scroll optimization */
1340#define OPTIMIZE_ALL		0xff	/* enable all optimizations (dflt) */
1341#endif
1342
1343#ifdef __cplusplus
1344}
1345#endif
1346
1347#endif /* __NCURSES_H */
1348