ncurses 6.2 - patch 20200308
[ncurses.git] / include / MKterm.h.awk.in
1 # vile:awkmode
2 function declare_termtype(number,suffix) {
3         printf "typedef struct termtype%s {     /* in-core form of terminfo data */\n", suffix;
4         print  "    char  *term_names;          /* str_table offset of term names */"
5         print  "    char  *str_table;           /* pointer to string table */"
6         print  "    NCURSES_SBOOL  *Booleans;   /* array of boolean values */"
7         printf "    %-5s *Numbers;              /* array of integer values */\n", number;
8         print  "    char  **Strings;            /* array of string offsets */"
9         print  ""
10         print  "#if NCURSES_XNAMES"
11         print  "    char  *ext_str_table;       /* pointer to extended string table */"
12         print  "    char  **ext_Names;          /* corresponding names */"
13         print  ""
14         print  "    unsigned short num_Booleans;/* count total Booleans */";
15         print  "    unsigned short num_Numbers; /* count total Numbers */";
16         print  "    unsigned short num_Strings; /* count total Strings */";
17         print  ""
18         print  "    unsigned short ext_Booleans;/* count extensions to Booleans */";
19         print  "    unsigned short ext_Numbers; /* count extensions to Numbers */";
20         print  "    unsigned short ext_Strings; /* count extensions to Strings */";
21         print  "#endif /* NCURSES_XNAMES */"
22         print  ""
23         printf "} TERMTYPE%s;\n", suffix;
24 }
25 BEGIN {
26         lcurl = "{";
27         rcurl = "}";
28         print  "/****************************************************************************"
29         print  " * Copyright 2018-2019,2020 Thomas E. Dickey                                *"
30         print  " * Copyright 1998-2013,2017 Free Software Foundation, Inc.                  *"
31         print  " *                                                                          *"
32         print  " * Permission is hereby granted, free of charge, to any person obtaining a  *"
33         print  " * copy of this software and associated documentation files (the            *"
34         print  " * \"Software\"), to deal in the Software without restriction, including      *"
35         print  " * without limitation the rights to use, copy, modify, merge, publish,      *"
36         print  " * distribute, distribute with modifications, sublicense, and/or sell       *"
37         print  " * copies of the Software, and to permit persons to whom the Software is    *"
38         print  " * furnished to do so, subject to the following conditions:                 *"
39         print  " *                                                                          *"
40         print  " * The above copyright notice and this permission notice shall be included  *"
41         print  " * in all copies or substantial portions of the Software.                   *"
42         print  " *                                                                          *"
43         print  " * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *"
44         print  " * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *"
45         print  " * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *"
46         print  " * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *"
47         print  " * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *"
48         print  " * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *"
49         print  " * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *"
50         print  " *                                                                          *"
51         print  " * Except as contained in this notice, the name(s) of the above copyright   *"
52         print  " * holders shall not be used in advertising or otherwise to promote the     *"
53         print  " * sale, use or other dealings in this Software without prior written       *"
54         print  " * authorization.                                                           *"
55         print  " ****************************************************************************/"
56         print  ""
57         print  "/****************************************************************************/"
58         print  "/* Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995                */"
59         print  "/*    and: Eric S. Raymond <esr@snark.thyrsus.com>                          */"
60         print  "/*    and: Thomas E. Dickey                        1995-on                  */"
61         print  "/****************************************************************************/"
62         print  ""
63         print  "/* $Id: MKterm.h.awk.in,v 1.74 2020/02/02 23:34:34 tom Exp $ */"
64         print  ""
65         print  "/*"
66         print  "**      term.h -- Definition of struct term"
67         print  "*/"
68         print  ""
69         print  "#ifndef NCURSES_TERM_H_incl"
70         print  "#define NCURSES_TERM_H_incl 1"
71         print  ""
72         print  "#undef  NCURSES_VERSION"
73         print  "#define NCURSES_VERSION \"@NCURSES_MAJOR@.@NCURSES_MINOR@\""
74         print  ""
75         print  "#include <ncurses_dll.h>"
76         print  ""
77         print  "#ifdef __cplusplus"
78         printf "extern \"C\" %s\n", lcurl;
79         print  "#endif"
80         print  ""
81         print  "/* Make this file self-contained by providing defaults for the HAVE_TERMIO[S]_H"
82         print  " * definition (based on the system for which this was configured)."
83         print  " */"
84         print  ""
85         print  "#undef  NCURSES_CONST"
86         print  "#define NCURSES_CONST @NCURSES_CONST@"
87         print  ""
88         print  "#undef  NCURSES_SBOOL"
89         print  "#define NCURSES_SBOOL @NCURSES_SBOOL@"
90         print  ""
91         print  "#undef  NCURSES_USE_DATABASE"
92         print  "#define NCURSES_USE_DATABASE @NCURSES_USE_DATABASE@"
93         print  ""
94         print  "#undef  NCURSES_USE_TERMCAP"
95         print  "#define NCURSES_USE_TERMCAP @NCURSES_USE_TERMCAP@"
96         print  ""
97         print  "#undef  NCURSES_XNAMES"
98         print  "#define NCURSES_XNAMES @NCURSES_XNAMES@"
99         print  ""
100         print  "/* We will use these symbols to hide differences between"
101         print  " * termios/termio/sgttyb interfaces."
102         print  " */"
103         print  "#undef  TTY"
104         print  "#undef  SET_TTY"
105         print  "#undef  GET_TTY"
106         print  ""
107         print  "/* Assume POSIX termio if we have the header and function */"
108         print  "/* #if HAVE_TERMIOS_H && HAVE_TCGETATTR */"
109         print  "#if @HAVE_TERMIOS_H@ && @HAVE_TCGETATTR@"
110         print  ""
111         print  "#undef  TERMIOS"
112         print  "#define TERMIOS 1"
113         print  ""
114         print  "#include <termios.h>"
115         print  "#define TTY struct termios"
116         print  ""
117         print  "#else /* !HAVE_TERMIOS_H */"
118         print  ""
119         print  "/* #if HAVE_TERMIO_H */"
120         print  "#if @HAVE_TERMIO_H@"
121         print  ""
122         print  "#undef  TERMIOS"
123         print  "#define TERMIOS 1"
124         print  ""
125         print  "#include <termio.h>"
126         print  "#define TTY struct termio"
127         print  ""
128         print  "#else /* !HAVE_TERMIO_H */"
129         print  ""
130         print  "#if _WIN32"
131         print  "#  include <ncurses_mingw.h>"
132         print  "#  define TTY struct termios"
133         print  "#else"
134         print  "#undef TERMIOS"
135         print  "#include <sgtty.h>"
136         print  "#include <sys/ioctl.h>"
137         print  "#define TTY struct sgttyb"
138         print  "#endif /* MINGW32 */"
139         print  "#endif /* HAVE_TERMIO_H */"
140         print  ""
141         print  "#endif /* HAVE_TERMIOS_H */"
142         print  ""
143         print  "#ifdef TERMIOS"
144         print  "#define GET_TTY(fd, buf) tcgetattr(fd, buf)"
145         print  "#define SET_TTY(fd, buf) tcsetattr(fd, TCSADRAIN, buf)"
146         print  "#else"
147         print  "#define GET_TTY(fd, buf) gtty(fd, buf)"
148         print  "#define SET_TTY(fd, buf) stty(fd, buf)"
149         print  "#endif"
150         print  ""
151         print  "#ifndef GCC_NORETURN"
152         print  "#define GCC_NORETURN /* nothing */"
153         print  "#endif"
154         print  ""
155         print  "#define NAMESIZE 256"
156         print  ""
157         print  "/* The cast works because TERMTYPE is the first data in TERMINAL */"
158         print  "#define CUR ((TERMTYPE *)(cur_term))->"
159         print  ""
160 }
161
162 $2 == "%%-STOP-HERE-%%" {
163         print  ""
164         printf "#define BOOLWRITE %d\n", BoolCount
165         printf "#define NUMWRITE  %d\n", NumberCount
166         printf "#define STRWRITE  %d\n", StringCount
167         print  ""
168         print  "/* older synonyms for some capabilities */"
169         print  "#define beehive_glitch  no_esc_ctlc"
170         print  "#define teleray_glitch  dest_tabs_magic_smso"
171         print  ""
172         print  "/* HPUX-11 uses this name rather than the standard one */"
173         print  "#ifndef micro_char_size"
174         print  "#define micro_char_size micro_col_size"
175         print  "#endif"
176         print  ""
177         print  "#ifdef __INTERNAL_CAPS_VISIBLE"
178 }
179
180 /^#/ { next; }
181
182 /^used_by/ { next ; }
183 /^userdef/ { next ; }
184
185 $1 == "acs_chars" {
186         acsindex = StringCount;
187 }
188
189 $3 == "bool" {
190         printf "#define %-30s CUR Booleans[%d]\n", $1, BoolCount++
191 }
192
193 $3 == "num" {
194         printf "#define %-30s CUR Numbers[%d]\n", $1, NumberCount++
195 }
196
197 $3 == "str" {
198         printf "#define %-30s CUR Strings[%d]\n", $1, StringCount++
199 }
200
201 END {
202         print  "#endif /* __INTERNAL_CAPS_VISIBLE */"
203         print  ""
204         print  ""
205         print  "/*"
206         print  " * Predefined terminfo array sizes"
207         print  " */"
208         printf "#define BOOLCOUNT %d\n", BoolCount
209         printf "#define NUMCOUNT  %d\n", NumberCount
210         printf "#define STRCOUNT  %d\n", StringCount
211         print  ""
212         print  "/* used by code for comparing entries */"
213         print  "#define acs_chars_index ", acsindex
214         print  ""
215         declare_termtype("short","");
216         print  ""
217         print  "/*"
218         print  " * The only reason these structures are visible is for read-only use."
219         print  " * Programs which modify the data are not, never were, portable across"
220         print  " * curses implementations."
221         print  " */"
222         print  "#ifdef NCURSES_INTERNALS"
223         print  ""
224         if (@NCURSES_EXT_COLORS@) {
225         declare_termtype("int","2");
226         } else {
227         print  "typedef TERMTYPE TERMTYPE2;"
228         }
229         print  ""
230         print  "typedef struct term {           /* describe an actual terminal */"
231         print  "    TERMTYPE    type;           /* terminal type description */"
232         print  "    short       Filedes;        /* file description being written to */"
233         print  "    TTY         Ottyb;          /* original state of the terminal */"
234         print  "    TTY         Nttyb;          /* current state of the terminal */"
235         print  "    int         _baudrate;      /* used to compute padding */"
236         print  "    char *      _termname;      /* used for termname() */"
237         if (@NCURSES_EXT_COLORS@) {
238         print  "    TERMTYPE2   type2;          /* extended terminal type description */"
239         }
240         print  "} TERMINAL;"
241         print  "#else"
242         print  "typedef struct term TERMINAL;"
243         print  "#endif /* NCURSES_INTERNALS */"
244         print  ""
245         print  ""
246         print  "#if @BROKEN_LINKER@ && !@cf_cv_enable_reentrant@"
247         print  "extern NCURSES_EXPORT_VAR(TERMINAL *) cur_term;"
248         print  "#elif @cf_cv_enable_reentrant@"
249         print  "NCURSES_WRAPPED_VAR(TERMINAL *, cur_term);"
250         print  "#define cur_term   NCURSES_PUBLIC_VAR(cur_term())"
251         print  "#else"
252         print  "extern NCURSES_EXPORT_VAR(TERMINAL *) cur_term;"
253         print  "#endif"
254         print  ""
255         print  "#if @BROKEN_LINKER@ || @cf_cv_enable_reentrant@"
256         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, boolnames);"
257         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, boolcodes);"
258         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, boolfnames);"
259         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, numnames);"
260         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, numcodes);"
261         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, numfnames);"
262         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, strnames);"
263         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, strcodes);"
264         print  "NCURSES_WRAPPED_VAR(NCURSES_CONST char * const *, strfnames);"
265         print  ""
266         print  "#define boolnames  NCURSES_PUBLIC_VAR(boolnames())"
267         print  "#define boolcodes  NCURSES_PUBLIC_VAR(boolcodes())"
268         print  "#define boolfnames NCURSES_PUBLIC_VAR(boolfnames())"
269         print  "#define numnames   NCURSES_PUBLIC_VAR(numnames())"
270         print  "#define numcodes   NCURSES_PUBLIC_VAR(numcodes())"
271         print  "#define numfnames  NCURSES_PUBLIC_VAR(numfnames())"
272         print  "#define strnames   NCURSES_PUBLIC_VAR(strnames())"
273         print  "#define strcodes   NCURSES_PUBLIC_VAR(strcodes())"
274         print  "#define strfnames  NCURSES_PUBLIC_VAR(strfnames())"
275         print  ""
276         print  "#else"
277         print  ""
278         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) boolnames[];"
279         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) boolcodes[];"
280         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) boolfnames[];"
281         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) numnames[];"
282         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) numcodes[];"
283         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) numfnames[];"
284         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) strnames[];"
285         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) strcodes[];"
286         print  "extern NCURSES_EXPORT_VAR(NCURSES_CONST char * const ) strfnames[];"
287         print  ""
288         print  "#endif"
289         print  ""
290         print  "/*"
291         print  " * These entrypoints are used only by the ncurses utilities such as tic."
292         print  " */"
293         print  "#ifdef NCURSES_INTERNALS"
294         print  ""
295         print  "extern NCURSES_EXPORT(int) _nc_set_tty_mode (TTY *buf);"
296         print  "extern NCURSES_EXPORT(int) _nc_read_entry2 (const char * const, char * const, TERMTYPE2 *const);"
297         print  "extern NCURSES_EXPORT(int) _nc_read_file_entry (const char *const, TERMTYPE2 *);"
298         print  "extern NCURSES_EXPORT(int) _nc_read_termtype (TERMTYPE2 *, char *, int);"
299         print  "extern NCURSES_EXPORT(char *) _nc_first_name (const char *const);"
300         print  "extern NCURSES_EXPORT(int) _nc_name_match (const char *const, const char *const, const char *const);"
301         print  ""
302         print  "#endif /* NCURSES_INTERNALS */"
303         print  ""
304         print  ""
305         print  "/*"
306         print  " * These entrypoints are used by tack 1.07."
307         print  " */"
308         print  "extern NCURSES_EXPORT(const TERMTYPE *) _nc_fallback (const char *);"
309         print  "extern NCURSES_EXPORT(int) _nc_read_entry (const char * const, char * const, TERMTYPE *const);"
310         print  ""
311         print  "/*"
312         print  " * Normal entry points"
313         print  " */"
314         print  "extern NCURSES_EXPORT(TERMINAL *) set_curterm (TERMINAL *);"
315         print  "extern NCURSES_EXPORT(int) del_curterm (TERMINAL *);"
316         print  ""
317         print  "/* miscellaneous entry points */"
318         print  "extern NCURSES_EXPORT(int) restartterm (NCURSES_CONST char *, int, int *);"
319         print  "extern NCURSES_EXPORT(int) setupterm (const char *,int,int *);"
320         print  ""
321         print  "/* terminfo entry points, also declared in curses.h */"
322         print  "#if !defined(__NCURSES_H)"
323         print  "extern NCURSES_EXPORT(char *) tigetstr (const char *);"
324         print  "extern NCURSES_EXPORT_VAR(char) ttytype[];"
325         print  "extern NCURSES_EXPORT(int) putp (const char *);"
326         print  "extern NCURSES_EXPORT(int) tigetflag (const char *);"
327         print  "extern NCURSES_EXPORT(int) tigetnum (const char *);"
328         print  ""
329         print  "#if @NCURSES_TPARM_VARARGS@ /* NCURSES_TPARM_VARARGS */"
330         print  "extern NCURSES_EXPORT(char *) tparm (const char *, ...);        /* special */"
331         print  "#else"
332         print  "extern NCURSES_EXPORT(char *) tparm (const char *, long,long,long,long,long,long,long,long,long);       /* special */"
333         print  "extern NCURSES_EXPORT(char *) tparm_varargs (const char *, ...);        /* special */"
334         print  "#endif"
335         print  ""
336         print  "extern NCURSES_EXPORT(char *) tiparm (const char *, ...);               /* special */"
337         print  ""
338         print  "#endif /* __NCURSES_H */"
339         print  ""
340         print  "/* termcap database emulation (XPG4 uses const only for 2nd param of tgetent) */"
341         print  "#if !defined(NCURSES_TERMCAP_H_incl)"
342         print  "extern NCURSES_EXPORT(char *) tgetstr (const char *, char **);"
343         print  "extern NCURSES_EXPORT(char *) tgoto (const char *, int, int);"
344         print  "extern NCURSES_EXPORT(int) tgetent (char *, const char *);"
345         print  "extern NCURSES_EXPORT(int) tgetflag (const char *);"
346         print  "extern NCURSES_EXPORT(int) tgetnum (const char *);"
347         print  "extern NCURSES_EXPORT(int) tputs (const char *, int, int (*)(int));"
348         print  "#endif /* NCURSES_TERMCAP_H_incl */"
349         print  ""
350         print  "/*"
351         print  " * Include curses.h before term.h to enable these extensions."
352         print  " */"
353         print  "#if defined(NCURSES_SP_FUNCS) && (NCURSES_SP_FUNCS != 0)"
354         print  ""
355         print  "extern NCURSES_EXPORT(char *)  NCURSES_SP_NAME(tigetstr) (SCREEN*, const char *);"
356         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(putp) (SCREEN*, const char *);"
357         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(tigetflag) (SCREEN*, const char *);"
358         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(tigetnum) (SCREEN*, const char *);"
359         print  ""
360         print  "#if @NCURSES_TPARM_VARARGS@ /* NCURSES_TPARM_VARARGS */"
361         print  "extern NCURSES_EXPORT(char *)  NCURSES_SP_NAME(tparm) (SCREEN*, const char *, ...);     /* special */"
362         print  "#else"
363         print  "extern NCURSES_EXPORT(char *)  NCURSES_SP_NAME(tparm) (SCREEN*, const char *, long,long,long,long,long,long,long,long,long);    /* special */"
364         print  "extern NCURSES_EXPORT(char *)  NCURSES_SP_NAME(tparm_varargs) (SCREEN*, const char *, ...);     /* special */"
365         print  "#endif"
366         print  ""
367         print  "/* termcap database emulation (XPG4 uses const only for 2nd param of tgetent) */"
368         print  "extern NCURSES_EXPORT(char *)  NCURSES_SP_NAME(tgetstr) (SCREEN*, const char *, char **);"
369         print  "extern NCURSES_EXPORT(char *)  NCURSES_SP_NAME(tgoto) (SCREEN*, const char *, int, int);"
370         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(tgetent) (SCREEN*, char *, const char *);"
371         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(tgetflag) (SCREEN*, const char *);"
372         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(tgetnum) (SCREEN*, const char *);"
373         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(tputs) (SCREEN*, const char *, int, NCURSES_SP_OUTC);"
374         print  ""
375         print  "extern NCURSES_EXPORT(TERMINAL *) NCURSES_SP_NAME(set_curterm) (SCREEN*, TERMINAL *);"
376         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(del_curterm) (SCREEN*, TERMINAL *);"
377         print  ""
378         print  "extern NCURSES_EXPORT(int)     NCURSES_SP_NAME(restartterm) (SCREEN*, NCURSES_CONST char *, int, int *);"
379         print  "#endif /* NCURSES_SP_FUNCS */"
380         print  ""
381         print  "/*"
382         print  " * Debugging features."
383         print  " */"
384         print  "extern NCURSES_EXPORT(void)    exit_terminfo(int) GCC_NORETURN;"
385         print  ""
386         print  "#ifdef __cplusplus"
387         printf "%s\n", rcurl;
388         print  "#endif"
389         print  ""
390         print  "#endif /* NCURSES_TERM_H_incl */"
391 }