3 # MKlib_gen.sh -- generate sources from curses.h macro definitions
5 # ($Id: MKlib_gen.sh,v 1.46 2011/06/04 19:14:08 tom Exp $)
7 ##############################################################################
8 # Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. #
10 # Permission is hereby granted, free of charge, to any person obtaining a #
11 # copy of this software and associated documentation files (the "Software"), #
12 # to deal in the Software without restriction, including without limitation #
13 # the rights to use, copy, modify, merge, publish, distribute, distribute #
14 # with modifications, sublicense, and/or sell copies of the Software, and to #
15 # permit persons to whom the Software is furnished to do so, subject to the #
16 # following conditions: #
18 # The above copyright notice and this permission notice shall be included in #
19 # all copies or substantial portions of the Software. #
21 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #
22 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, #
23 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL #
24 # THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER #
25 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING #
26 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER #
27 # DEALINGS IN THE SOFTWARE. #
29 # Except as contained in this notice, the name(s) of the above copyright #
30 # holders shall not be used in advertising or otherwise to promote the sale, #
31 # use or other dealings in this Software without prior written #
33 ##############################################################################
35 # The XSI Curses standard requires all curses entry points to exist as
36 # functions, even though many definitions would normally be shadowed
37 # by macros. Rather than hand-hack all that code, we actually
38 # generate functions from the macros.
40 # This script accepts a file of prototypes on standard input. It discards
41 # any that don't have a `generated' comment attached. It then parses each
42 # prototype (relying on the fact that none of the macros take function
43 # pointer or array arguments) and generates C source from it.
45 # Here is what the pipeline stages are doing:
47 # 1. sed: extract prototypes of generated functions
48 # 2. sed: decorate prototypes with generated arguments a1. a2,...z
49 # 3. awk: generate the calls with args matching the formals
50 # 4. sed: prefix function names in prototypes so the preprocessor won't expand
52 # 5. cpp: macro-expand the file so the macro calls turn into C calls
53 # 6. awk: strip the expansion junk off the front and add the new header
54 # 7. sed: squeeze spaces, strip off gen_ prefix.
57 # keep the editing independent of locale:
58 if test "${LANGUAGE+set}" = set; then LANGUAGE=C; export LANGUAGE; fi
59 if test "${LANG+set}" = set; then LANG=C; export LANG; fi
60 if test "${LC_ALL+set}" = set; then LC_ALL=C; export LC_ALL; fi
61 if test "${LC_MESSAGES+set}" = set; then LC_MESSAGES=C; export LC_MESSAGES; fi
62 if test "${LC_CTYPE+set}" = set; then LC_CTYPE=C; export LC_CTYPE; fi
63 if test "${LC_COLLATE+set}" = set; then LC_COLLATE=C; export LC_COLLATE; fi
65 preprocessor="$1 -DNCURSES_INTERNALS -I../include"
77 trap "rm -f $ED1 $ED2 $ED3 $ED4 $AW1 $AW2 $TMP" 0 1 2 5 15
80 if test "$USE" = implemented ; then
83 /^extern.*implemented/{
85 s/NCURSES_SP_NAME(\([^)]*\))/NCURSES_SP_NAME___\1/
87 s/^.*implemented:\([^ *]*\).*/P_POUNDCif_USE_\1_SUPPORT/p
89 s/^extern \([^;]*\);.*/\1/p
91 s/^.*implemented:\([^ *]*\).*/P_POUNDCendif/p
95 s/^.*generated:\([^ *]*\).*/P_POUNDCif_USE_\1_SUPPORT/p
97 s/^extern \([^;]*\);.*/\1/p
99 s/^.*generated:\([^ *]*\).*/P_POUNDCendif/p
107 s/^.*${ALL}:\([^ *]*\).*/P_POUNDCif_USE_\1_SUPPORT/p
109 s/^extern \([^;]*\);.*/\1/p
111 s/^.*${ALL}:\([^ *]*\).*/P_POUNDCendif/p
146 s/^P_POUNDCendif/#endif/
160 if test "$USE" = generated ; then
162 s/^\(.*\) \(.*\) (\(.*\))\$/NCURSES_EXPORT(\1) (\2) (\3)/
166 /^\(.*\) \(.*\) (\(.*\))\$/ {
168 s/^\(.*\) \(.*\) (\(.*\))\$/extern \1 call_\2 (\3);/
171 s/^\(.*\) \(.*\) (\(.*\))\$/\1 call_\2 (\3)/
173 s/\([^_]\)NCURSES_SP_NAME___\([a-zA-Z][a-zA-Z_]*\)/\1NCURSES_SP_NAME(\2)/g
196 for (i = 1; i <= NF; i++) {
197 if ( $i != "NCURSES_CONST" ) {
204 if ( $first == "chtype" ) {
205 returnType = "Chtype";
206 } else if ( $first == "SCREEN" ) {
208 } else if ( $first == "WINDOW" ) {
210 } else if ( $first == "attr_t" || $second == "attrset" || $second == "standout" || $second == "standend" || $second == "wattrset" || $second == "wstandout" || $second == "wstandend" ) {
211 returnType = "IntAttr";
212 returnCast = "(attr_t)";
213 } else if ( $first == "bool" || $first == "NCURSES_BOOL" ) {
215 } else if ( $second == "*" ) {
221 for (i = second; i <= NF; i++) {
231 if ($check == "void")
234 for (i = 1; i <= NF; i++)
239 # suppress trace-code for functions that we cannot do properly here,
240 # since they return data.
242 if ($myfunc ~ /innstr/)
244 if ($myfunc ~ /innwstr/)
247 # workaround functions that we do not parse properly
248 if ($myfunc ~ /ripoffline/) {
251 if ($myfunc ~ /NCURSES_SP_NAME/) {
255 if ($myfunc ~ /wunctrl/) {
259 call = "@@T((T_CALLED(\""
267 for (i = myfunc; i <= NF; i++) {
271 } else if ( ch == "va_list" ) {
273 } else if ( ch == "..." ) {
275 } else if ( ch == "char" ) {
277 } else if ( ch == "int" ) {
279 } else if ( ch == "short" ) {
281 } else if ( ch == "chtype" ) {
283 } else if ( ch == "attr_t" || ch == "NCURSES_ATTR_T" ) {
287 if ( ch == "," || ch == ")" ) {
291 } else if (varargs) {
293 } else if (pointer) {
294 if ( argtype == "char" ) {
296 comma = comma "_nc_visbuf2(" num ","
300 comma = comma "(const void *)"
302 } else if (argcount != 0) {
303 if ( argtype == "int" || argtype == "short" ) {
306 } else if ( argtype != "" ) {
308 comma = comma "_trace" argtype "2(" num ","
309 if (argtype == "attr") {
310 argcast = "(chtype)";
314 comma = comma "(long)"
318 args = args comma "a" ++num;
319 } else if ( argcount != 0 ) {
321 args = args comma "\"va_list\""
322 } else if ( varargs ) {
323 args = args comma "\"...\""
325 args = args comma argcast "z"
329 if (pointer == 0 && argcount != 0 && argtype != "" )
336 if ( i == myfunc || ch == "(" )
341 call = call ", " args
347 if (match($0, "^void")) {
349 } else if (dotrace) {
350 call = sprintf("return%s( ", returnType);
351 if (returnCast != "") {
352 call = call returnCast;
358 call = call $myfunc "(";
359 for (i = 1; i < argcount; i++) {
364 if ( argcount != 0 && $check != "..." ) {
369 if (!match($0, "^void"))
376 if (match($0, "^void"))
377 print "@@returnVoid;"
385 print " * DO NOT EDIT THIS FILE BY HAND!"
386 printf " * It is generated by $0 %s.\n", "$USE"
387 if ( "$USE" == "generated" ) {
389 print " * This is a file of trivial functions generated from macro"
390 print " * definitions in curses.h to satisfy the XSI Curses requirement"
391 print " * that every macro also exist as a callable function."
393 print " * It will never be linked unless you call one of the entry"
394 print " * points with its normal macro definition disabled. In that"
395 print " * case, if you have no shared libraries, it will indirectly"
396 print " * pull most of the rest of the library into your link image."
399 print "#define NCURSES_ATTR_T int"
400 print "#include <ncurses_cfg.h>"
402 print "#undef NCURSES_NOMACROS /* _this_ file uses macros */"
404 print "#include <curses.priv.h>"
406 print "#undef vw_scanw"
407 print "#undef vwscanw"
409 print "#undef vw_printw"
410 print "#undef vwprintw"
412 /^DECLARATIONS/ {start = 1; next;}
415 if ( "$USE" == "generated" ) {
417 } else if ( \$0 ~ /^[{}]?\$/ ) {
419 } else if ( \$0 ~ /;/ ) {
429 if ( "$USE" != "generated" ) {
430 print "int main(void)"
432 for (n = 1; n < start; ++n) {
434 if ( value !~ /P_POUNDC/ ) {
435 gsub(/[[:blank:]]+/," ",value);
436 sub(/^[[:alnum:]_]+ /,"",value);
437 sub(/^\* /,"",value);
438 gsub(/[[:alnum:]_]+ \* /,"",value);
439 gsub(/ (const) /," ",value);
440 gsub(/ (int|short|attr_t|chtype|wchar_t|NCURSES_BOOL|NCURSES_OUTC|NCURSES_OUTC_sp|va_list) /," ",value);
441 gsub(/ void /,"",value);
442 sub(/^/,"call_",value);
443 gsub(/ (a[[:digit:]]|z) /, " 0 ", value);
444 gsub(/ int[[:blank:]]*[(][^)]+[)][(][^)]+[)]/, "0", value);
445 printf "\t%s;\n", value;
457 #include <ncurses_cfg.h>
458 #undef NCURSES_NOMACROS
468 | sed -e 's/NCURSES_EXPORT(\(.*\)) \(.*\) (\(.*\))/\1 \2(\3)/' \
470 | $AWK -f $AW1 using=$USE \
473 -e 's/^\([a-zA-Z_][a-zA-Z_]*[ *]*\)/\1 gen_/' \
477 $preprocessor $TMP 2>/dev/null \
481 -e 's/_Bool/NCURSES_BOOL/g' \
485 -e 's/^.*T_CALLED.*returnCode( \([a-z].*) \));/ return \1;/' \
486 -e 's/^.*T_CALLED.*returnCode( \((wmove.*) \));/ return \1;/' \