ncurses 5.7 - patch 20090906
[ncurses.git] / include / curses.wide
1 /* $Id: curses.wide,v 1.39 2009/05/09 15:43:00 tom Exp $ */
2 /*
3  * vile:cmode:
4  * This file is part of ncurses, designed to be appended after curses.h.in
5  * (see that file for the relevant copyright).
6  */
7 #define _XOPEN_CURSES 1
8
9 #ifdef _XOPEN_SOURCE_EXTENDED
10
11 extern NCURSES_EXPORT_VAR(cchar_t *) _nc_wacs;
12
13 #define NCURSES_WACS(c) (&_nc_wacs[(unsigned char)c])
14
15 #define WACS_BSSB       NCURSES_WACS('l')
16 #define WACS_SSBB       NCURSES_WACS('m')
17 #define WACS_BBSS       NCURSES_WACS('k')
18 #define WACS_SBBS       NCURSES_WACS('j')
19 #define WACS_SBSS       NCURSES_WACS('u')
20 #define WACS_SSSB       NCURSES_WACS('t')
21 #define WACS_SSBS       NCURSES_WACS('v')
22 #define WACS_BSSS       NCURSES_WACS('w')
23 #define WACS_BSBS       NCURSES_WACS('q')
24 #define WACS_SBSB       NCURSES_WACS('x')
25 #define WACS_SSSS       NCURSES_WACS('n')
26
27 #define WACS_ULCORNER   WACS_BSSB
28 #define WACS_LLCORNER   WACS_SSBB
29 #define WACS_URCORNER   WACS_BBSS
30 #define WACS_LRCORNER   WACS_SBBS
31 #define WACS_RTEE       WACS_SBSS
32 #define WACS_LTEE       WACS_SSSB
33 #define WACS_BTEE       WACS_SSBS
34 #define WACS_TTEE       WACS_BSSS
35 #define WACS_HLINE      WACS_BSBS
36 #define WACS_VLINE      WACS_SBSB
37 #define WACS_PLUS       WACS_SSSS
38
39 #define WACS_S1         NCURSES_WACS('o') /* scan line 1 */
40 #define WACS_S9         NCURSES_WACS('s') /* scan line 9 */
41 #define WACS_DIAMOND    NCURSES_WACS('`') /* diamond */
42 #define WACS_CKBOARD    NCURSES_WACS('a') /* checker board */
43 #define WACS_DEGREE     NCURSES_WACS('f') /* degree symbol */
44 #define WACS_PLMINUS    NCURSES_WACS('g') /* plus/minus */
45 #define WACS_BULLET     NCURSES_WACS('~') /* bullet */
46
47         /* Teletype 5410v1 symbols */
48 #define WACS_LARROW     NCURSES_WACS(',') /* arrow left */
49 #define WACS_RARROW     NCURSES_WACS('+') /* arrow right */
50 #define WACS_DARROW     NCURSES_WACS('.') /* arrow down */
51 #define WACS_UARROW     NCURSES_WACS('-') /* arrow up */
52 #define WACS_BOARD      NCURSES_WACS('h') /* board of squares */
53 #define WACS_LANTERN    NCURSES_WACS('i') /* lantern symbol */
54 #define WACS_BLOCK      NCURSES_WACS('0') /* solid square block */
55
56         /* ncurses extensions */
57 #define WACS_S3         NCURSES_WACS('p') /* scan line 3 */
58 #define WACS_S7         NCURSES_WACS('r') /* scan line 7 */
59 #define WACS_LEQUAL     NCURSES_WACS('y') /* less/equal */
60 #define WACS_GEQUAL     NCURSES_WACS('z') /* greater/equal */
61 #define WACS_PI         NCURSES_WACS('{') /* Pi */
62 #define WACS_NEQUAL     NCURSES_WACS('|') /* not equal */
63 #define WACS_STERLING   NCURSES_WACS('}') /* UK pound sign */
64
65 /*
66  * Function prototypes for wide-character operations.
67  *
68  * "generated" comments should include ":WIDEC" to make the corresponding
69  * functions ifdef'd in lib_gen.c
70  *
71  * "implemented" comments do not need this marker.
72  */
73
74 extern NCURSES_EXPORT(int) add_wch (const cchar_t *);                   /* generated:WIDEC */
75 extern NCURSES_EXPORT(int) add_wchnstr (const cchar_t *, int);          /* generated:WIDEC */
76 extern NCURSES_EXPORT(int) add_wchstr (const cchar_t *);                /* generated:WIDEC */
77 extern NCURSES_EXPORT(int) addnwstr (const wchar_t *, int);             /* generated:WIDEC */
78 extern NCURSES_EXPORT(int) addwstr (const wchar_t *);                   /* generated:WIDEC */
79 extern NCURSES_EXPORT(int) bkgrnd (const cchar_t *);                    /* generated:WIDEC */
80 extern NCURSES_EXPORT(void) bkgrndset (const cchar_t *);                /* generated:WIDEC */
81 extern NCURSES_EXPORT(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*); /* generated:WIDEC */
82 extern NCURSES_EXPORT(int) box_set (WINDOW *, const cchar_t *, const cchar_t *);        /* generated:WIDEC */
83 extern NCURSES_EXPORT(int) echo_wchar (const cchar_t *);                /* generated:WIDEC */
84 extern NCURSES_EXPORT(int) erasewchar (wchar_t*);                       /* implemented */
85 extern NCURSES_EXPORT(int) get_wch (wint_t *);                          /* generated:WIDEC */
86 extern NCURSES_EXPORT(int) get_wstr (wint_t *);                         /* generated:WIDEC */
87 extern NCURSES_EXPORT(int) getbkgrnd (cchar_t *);                       /* generated:WIDEC */
88 extern NCURSES_EXPORT(int) getcchar (const cchar_t *, wchar_t*, attr_t*, short*, void*);        /* implemented */
89 extern NCURSES_EXPORT(int) getn_wstr (wint_t *, int);                   /* generated:WIDEC */
90 extern NCURSES_EXPORT(int) hline_set (const cchar_t *, int);            /* generated:WIDEC */
91 extern NCURSES_EXPORT(int) in_wch (cchar_t *);                          /* generated:WIDEC */
92 extern NCURSES_EXPORT(int) in_wchnstr (cchar_t *, int);                 /* generated:WIDEC */
93 extern NCURSES_EXPORT(int) in_wchstr (cchar_t *);                       /* generated:WIDEC */
94 extern NCURSES_EXPORT(int) innwstr (wchar_t *, int);                    /* generated:WIDEC */
95 extern NCURSES_EXPORT(int) ins_nwstr (const wchar_t *, int);            /* generated:WIDEC */
96 extern NCURSES_EXPORT(int) ins_wch (const cchar_t *);                   /* generated:WIDEC */
97 extern NCURSES_EXPORT(int) ins_wstr (const wchar_t *);                  /* generated:WIDEC */
98 extern NCURSES_EXPORT(int) inwstr (wchar_t *);                          /* generated:WIDEC */
99 extern NCURSES_EXPORT(NCURSES_CONST char*) key_name (wchar_t);          /* implemented */
100 extern NCURSES_EXPORT(int) killwchar (wchar_t *);                       /* implemented */
101 extern NCURSES_EXPORT(int) mvadd_wch (int, int, const cchar_t *);       /* generated:WIDEC */
102 extern NCURSES_EXPORT(int) mvadd_wchnstr (int, int, const cchar_t *, int);/* generated:WIDEC */
103 extern NCURSES_EXPORT(int) mvadd_wchstr (int, int, const cchar_t *);    /* generated:WIDEC */
104 extern NCURSES_EXPORT(int) mvaddnwstr (int, int, const wchar_t *, int); /* generated:WIDEC */
105 extern NCURSES_EXPORT(int) mvaddwstr (int, int, const wchar_t *);       /* generated:WIDEC */
106 extern NCURSES_EXPORT(int) mvget_wch (int, int, wint_t *);              /* generated:WIDEC */
107 extern NCURSES_EXPORT(int) mvget_wstr (int, int, wint_t *);             /* generated:WIDEC */
108 extern NCURSES_EXPORT(int) mvgetn_wstr (int, int, wint_t *, int);       /* generated:WIDEC */
109 extern NCURSES_EXPORT(int) mvhline_set (int, int, const cchar_t *, int);        /* generated:WIDEC */
110 extern NCURSES_EXPORT(int) mvin_wch (int, int, cchar_t *);              /* generated:WIDEC */
111 extern NCURSES_EXPORT(int) mvin_wchnstr (int, int, cchar_t *, int);     /* generated:WIDEC */
112 extern NCURSES_EXPORT(int) mvin_wchstr (int, int, cchar_t *);           /* generated:WIDEC */
113 extern NCURSES_EXPORT(int) mvinnwstr (int, int, wchar_t *, int);        /* generated:WIDEC */
114 extern NCURSES_EXPORT(int) mvins_nwstr (int, int, const wchar_t *, int);        /* generated:WIDEC */
115 extern NCURSES_EXPORT(int) mvins_wch (int, int, const cchar_t *);       /* generated:WIDEC */
116 extern NCURSES_EXPORT(int) mvins_wstr (int, int, const wchar_t *);      /* generated:WIDEC */
117 extern NCURSES_EXPORT(int) mvinwstr (int, int, wchar_t *);              /* generated:WIDEC */
118 extern NCURSES_EXPORT(int) mvvline_set (int, int, const cchar_t *, int);        /* generated:WIDEC */
119 extern NCURSES_EXPORT(int) mvwadd_wch (WINDOW *, int, int, const cchar_t *);    /* generated:WIDEC */
120 extern NCURSES_EXPORT(int) mvwadd_wchnstr (WINDOW *, int, int, const cchar_t *, int); /* generated:WIDEC */
121 extern NCURSES_EXPORT(int) mvwadd_wchstr (WINDOW *, int, int, const cchar_t *); /* generated:WIDEC */
122 extern NCURSES_EXPORT(int) mvwaddnwstr (WINDOW *, int, int, const wchar_t *, int);/* generated:WIDEC */
123 extern NCURSES_EXPORT(int) mvwaddwstr (WINDOW *, int, int, const wchar_t *);    /* generated:WIDEC */
124 extern NCURSES_EXPORT(int) mvwget_wch (WINDOW *, int, int, wint_t *);   /* generated:WIDEC */
125 extern NCURSES_EXPORT(int) mvwget_wstr (WINDOW *, int, int, wint_t *);  /* generated:WIDEC */
126 extern NCURSES_EXPORT(int) mvwgetn_wstr (WINDOW *, int, int, wint_t *, int);/* generated:WIDEC */
127 extern NCURSES_EXPORT(int) mvwhline_set (WINDOW *, int, int, const cchar_t *, int);/* generated:WIDEC */
128 extern NCURSES_EXPORT(int) mvwin_wch (WINDOW *, int, int, cchar_t *);   /* generated:WIDEC */
129 extern NCURSES_EXPORT(int) mvwin_wchnstr (WINDOW *, int,int, cchar_t *,int);    /* generated:WIDEC */
130 extern NCURSES_EXPORT(int) mvwin_wchstr (WINDOW *, int, int, cchar_t *);        /* generated:WIDEC */
131 extern NCURSES_EXPORT(int) mvwinnwstr (WINDOW *, int, int, wchar_t *, int);     /* generated:WIDEC */
132 extern NCURSES_EXPORT(int) mvwins_nwstr (WINDOW *, int,int, const wchar_t *,int); /* generated:WIDEC */
133 extern NCURSES_EXPORT(int) mvwins_wch (WINDOW *, int, int, const cchar_t *);    /* generated:WIDEC */
134 extern NCURSES_EXPORT(int) mvwins_wstr (WINDOW *, int, int, const wchar_t *);   /* generated:WIDEC */
135 extern NCURSES_EXPORT(int) mvwinwstr (WINDOW *, int, int, wchar_t *);           /* generated:WIDEC */
136 extern NCURSES_EXPORT(int) mvwvline_set (WINDOW *, int,int, const cchar_t *,int); /* generated:WIDEC */
137 extern NCURSES_EXPORT(int) pecho_wchar (WINDOW *, const cchar_t *);     /* implemented */
138 extern NCURSES_EXPORT(int) setcchar (cchar_t *, const wchar_t *, const attr_t, short, const void *);    /* implemented */
139 extern NCURSES_EXPORT(int) slk_wset (int, const wchar_t *, int);        /* implemented */
140 extern NCURSES_EXPORT(attr_t) term_attrs (void);                        /* implemented */
141 extern NCURSES_EXPORT(int) unget_wch (const wchar_t);                   /* implemented */
142 extern NCURSES_EXPORT(int) vid_attr (attr_t, short, void *);            /* implemented */
143 extern NCURSES_EXPORT(int) vid_puts (attr_t, short, void *, NCURSES_OUTC); /* implemented */
144 extern NCURSES_EXPORT(int) vline_set (const cchar_t *, int);            /* generated:WIDEC */
145 extern NCURSES_EXPORT(int) wadd_wch (WINDOW *,const cchar_t *);         /* implemented */
146 extern NCURSES_EXPORT(int) wadd_wchnstr (WINDOW *,const cchar_t *,int); /* implemented */
147 extern NCURSES_EXPORT(int) wadd_wchstr (WINDOW *,const cchar_t *);      /* generated:WIDEC */
148 extern NCURSES_EXPORT(int) waddnwstr (WINDOW *,const wchar_t *,int);    /* implemented */
149 extern NCURSES_EXPORT(int) waddwstr (WINDOW *,const wchar_t *);         /* generated:WIDEC */
150 extern NCURSES_EXPORT(int) wbkgrnd (WINDOW *,const cchar_t *);          /* implemented */
151 extern NCURSES_EXPORT(void) wbkgrndset (WINDOW *,const cchar_t *);      /* implemented */
152 extern NCURSES_EXPORT(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*);      /* implemented */
153 extern NCURSES_EXPORT(int) wecho_wchar (WINDOW *, const cchar_t *);     /* implemented */
154 extern NCURSES_EXPORT(int) wget_wch (WINDOW *, wint_t *);               /* implemented */
155 extern NCURSES_EXPORT(int) wget_wstr (WINDOW *, wint_t *);              /* generated:WIDEC */
156 extern NCURSES_EXPORT(int) wgetbkgrnd (WINDOW *, cchar_t *);            /* generated:WIDEC */
157 extern NCURSES_EXPORT(int) wgetn_wstr (WINDOW *,wint_t *, int);         /* implemented */
158 extern NCURSES_EXPORT(int) whline_set (WINDOW *, const cchar_t *, int); /* implemented */
159 extern NCURSES_EXPORT(int) win_wch (WINDOW *, cchar_t *);               /* implemented */
160 extern NCURSES_EXPORT(int) win_wchnstr (WINDOW *, cchar_t *, int);      /* implemented */
161 extern NCURSES_EXPORT(int) win_wchstr (WINDOW *, cchar_t *);            /* generated:WIDEC */
162 extern NCURSES_EXPORT(int) winnwstr (WINDOW *, wchar_t *, int);         /* implemented */
163 extern NCURSES_EXPORT(int) wins_nwstr (WINDOW *, const wchar_t *, int); /* implemented */
164 extern NCURSES_EXPORT(int) wins_wch (WINDOW *, const cchar_t *);        /* implemented */
165 extern NCURSES_EXPORT(int) wins_wstr (WINDOW *, const wchar_t *);       /* generated:WIDEC */
166 extern NCURSES_EXPORT(int) winwstr (WINDOW *, wchar_t *);               /* implemented */
167 extern NCURSES_EXPORT(wchar_t*) wunctrl (cchar_t *);                    /* implemented */
168 extern NCURSES_EXPORT(int) wvline_set (WINDOW *, const cchar_t *, int); /* implemented */
169
170 #if NCURSES_SP_FUNCS
171 extern NCURSES_EXPORT(attr_t) NCURSES_SP_NAME(term_attrs) (SCREEN*);            /* implemented */
172 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(unget_wch) (SCREEN*, const wchar_t); /* implemented */
173 extern NCURSES_EXPORT(wchar_t*) NCURSES_SP_NAME(wunctrl) (SCREEN*, cchar_t *);  /* implemented */
174 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vid_attr) (SCREEN*, attr_t, short, void *);
175 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vid_puts) (SCREEN*, attr_t, short, void *, NCURSES_SP_OUTC);
176 #endif
177
178 #ifndef NCURSES_NOMACROS
179
180 /*
181  * XSI curses macros for XPG4 conformance.
182  */
183 #define add_wch(c)                      wadd_wch(stdscr,c)
184 #define add_wchnstr(str,n)              wadd_wchnstr(stdscr,str,n)
185 #define add_wchstr(str)                 wadd_wchstr(stdscr,str)
186 #define addnwstr(wstr,n)                waddnwstr(stdscr,wstr,n)
187 #define addwstr(wstr)                   waddwstr(stdscr,wstr)
188 #define bkgrnd(c)                       wbkgrnd(stdscr,c)
189 #define bkgrndset(c)                    wbkgrndset(stdscr,c)
190 #define border_set(l,r,t,b,tl,tr,bl,br) wborder_set(stdscr,l,r,t,b,tl,tr,bl,br)
191 #define box_set(w,v,h)                  wborder_set(w,v,v,h,h,0,0,0,0)
192 #define echo_wchar(c)                   wecho_wchar(stdscr,c)
193 #define get_wch(c)                      wget_wch(stdscr,c)
194 #define get_wstr(t)                     wget_wstr(stdscr,t)
195 #define getbkgrnd(wch)                  wgetbkgrnd(stdscr,wch)
196 #define getn_wstr(t,n)                  wgetn_wstr(stdscr,t,n)
197 #define hline_set(c,n)                  whline_set(stdscr,c,n)
198 #define in_wch(c)                       win_wch(stdscr,c)
199 #define in_wchnstr(c,n)                 win_wchnstr(stdscr,c,n)
200 #define in_wchstr(c)                    win_wchstr(stdscr,c)
201 #define innwstr(c,n)                    winnwstr(stdscr,c,n)
202 #define ins_nwstr(t,n)                  wins_nwstr(stdscr,t,n)
203 #define ins_wch(c)                      wins_wch(stdscr,c)
204 #define ins_wstr(t)                     wins_wstr(stdscr,t)
205 #define inwstr(c)                       winwstr(stdscr,c)
206 #define vline_set(c,n)                  wvline_set(stdscr,c,n)
207 #define wadd_wchstr(win,str)            wadd_wchnstr(win,str,-1)
208 #define waddwstr(win,wstr)              waddnwstr(win,wstr,-1)
209 #define wget_wstr(w,t)                  wgetn_wstr(w,t,-1)
210 #define win_wchstr(w,c)                 win_wchnstr(w,c,-1)
211 #define wins_wstr(w,t)                  wins_nwstr(w,t,-1)
212
213 #if !NCURSES_OPAQUE
214 #define wgetbkgrnd(win,wch)             (*wch = win->_bkgrnd, OK)
215 #endif
216
217 #define mvadd_wch(y,x,c)                mvwadd_wch(stdscr,y,x,c)
218 #define mvadd_wchnstr(y,x,s,n)          mvwadd_wchnstr(stdscr,y,x,s,n)
219 #define mvadd_wchstr(y,x,s)             mvwadd_wchstr(stdscr,y,x,s)
220 #define mvaddnwstr(y,x,wstr,n)          mvwaddnwstr(stdscr,y,x,wstr,n)
221 #define mvaddwstr(y,x,wstr)             mvwaddwstr(stdscr,y,x,wstr)
222 #define mvget_wch(y,x,c)                mvwget_wch(stdscr,y,x,c)
223 #define mvget_wstr(y,x,t)               mvwget_wstr(stdscr,y,x,t)
224 #define mvgetn_wstr(y,x,t,n)            mvwgetn_wstr(stdscr,y,x,t,n)
225 #define mvhline_set(y,x,c,n)            mvwhline_set(stdscr,y,x,c,n)
226 #define mvin_wch(y,x,c)                 mvwin_wch(stdscr,y,x,c)
227 #define mvin_wchnstr(y,x,c,n)           mvwin_wchnstr(stdscr,y,x,c,n)
228 #define mvin_wchstr(y,x,c)              mvwin_wchstr(stdscr,y,x,c)
229 #define mvinnwstr(y,x,c,n)              mvwinnwstr(stdscr,y,x,c,n)
230 #define mvins_nwstr(y,x,t,n)            mvwins_nwstr(stdscr,y,x,t,n)
231 #define mvins_wch(y,x,c)                mvwins_wch(stdscr,y,x,c)
232 #define mvins_wstr(y,x,t)               mvwins_wstr(stdscr,y,x,t)
233 #define mvinwstr(y,x,c)                 mvwinwstr(stdscr,y,x,c)
234 #define mvvline_set(y,x,c,n)            mvwvline_set(stdscr,y,x,c,n)
235
236 #define mvwadd_wch(win,y,x,c)           (wmove(win,y,x) == ERR ? ERR : wadd_wch(win,c))
237 #define mvwadd_wchnstr(win,y,x,s,n)     (wmove(win,y,x) == ERR ? ERR : wadd_wchnstr(win,s,n))
238 #define mvwadd_wchstr(win,y,x,s)        (wmove(win,y,x) == ERR ? ERR : wadd_wchstr(win,s))
239 #define mvwaddnwstr(win,y,x,wstr,n)     (wmove(win,y,x) == ERR ? ERR : waddnwstr(win,wstr,n))
240 #define mvwaddwstr(win,y,x,wstr)        (wmove(win,y,x) == ERR ? ERR : waddwstr(win,wstr))
241 #define mvwget_wch(win,y,x,c)           (wmove(win,y,x) == ERR ? ERR : wget_wch(win,c))
242 #define mvwget_wstr(win,y,x,t)          (wmove(win,y,x) == ERR ? ERR : wget_wstr(win,t))
243 #define mvwgetn_wstr(win,y,x,t,n)       (wmove(win,y,x) == ERR ? ERR : wgetn_wstr(win,t,n))
244 #define mvwhline_set(win,y,x,c,n)       (wmove(win,y,x) == ERR ? ERR : whline_set(win,c,n))
245 #define mvwin_wch(win,y,x,c)            (wmove(win,y,x) == ERR ? ERR : win_wch(win,c))
246 #define mvwin_wchnstr(win,y,x,c,n)      (wmove(win,y,x) == ERR ? ERR : win_wchnstr(win,c,n))
247 #define mvwin_wchstr(win,y,x,c)         (wmove(win,y,x) == ERR ? ERR : win_wchstr(win,c))
248 #define mvwinnwstr(win,y,x,c,n)         (wmove(win,y,x) == ERR ? ERR : winnwstr(win,c,n))
249 #define mvwins_nwstr(win,y,x,t,n)       (wmove(win,y,x) == ERR ? ERR : wins_nwstr(win,t,n))
250 #define mvwins_wch(win,y,x,c)           (wmove(win,y,x) == ERR ? ERR : wins_wch(win,c))
251 #define mvwins_wstr(win,y,x,t)          (wmove(win,y,x) == ERR ? ERR : wins_wstr(win,t))
252 #define mvwinwstr(win,y,x,c)            (wmove(win,y,x) == ERR ? ERR : winwstr(win,c))
253 #define mvwvline_set(win,y,x,c,n)       (wmove(win,y,x) == ERR ? ERR : wvline_set(win,c,n))
254
255 #endif /* NCURSES_NOMACROS */
256
257 #if defined(TRACE) || defined(NCURSES_TEST)
258 extern NCURSES_EXPORT(const char *) _nc_viswbuf(const wchar_t *);
259 extern NCURSES_EXPORT(const char *) _nc_viswibuf(const wint_t *);
260 #endif
261
262 #endif /* _XOPEN_SOURCE_EXTENDED */