ncurses 6.0 - patch 20171125
[ncurses.git] / ncurses / base / MKlib_gen.sh
1 #!/bin/sh
2 #
3 # MKlib_gen.sh -- generate sources from curses.h macro definitions
4 #
5 # ($Id: MKlib_gen.sh,v 1.59 2017/11/25 23:05:56 tom Exp $)
6 #
7 ##############################################################################
8 # Copyright (c) 1998-2017,2017 Free Software Foundation, Inc.                #
9 #                                                                            #
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:                                                      #
17 #                                                                            #
18 # The above copyright notice and this permission notice shall be included in #
19 # all copies or substantial portions of the Software.                        #
20 #                                                                            #
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.                                                  #
28 #                                                                            #
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               #
32 # authorization.                                                             #
33 ##############################################################################
34 #
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.
39 #
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.
44 #
45 # Here is what the pipeline stages are doing:
46 #
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
51 #         them.
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.
55 #
56
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
64
65 preprocessor="$1 -DNCURSES_WATTR_MACROS -DNCURSES_INTERNALS -I../include"
66 AWK="$2"
67 USE="$3"
68
69 # A patch discussed here:
70 #       https://gcc.gnu.org/ml/gcc-patches/2014-06/msg02185.html
71 # introduces spurious #line markers into the preprocessor output.  The result
72 # appears in gcc 5.0 and (with modification) in 5.1, making it necessary to
73 # determine if we are using gcc, and if so, what version because the proposed
74 # solution uses a nonstandard option.
75 PRG=`echo "$1" | $AWK '{ sub(/^[        ]*/,""); sub(/[         ].*$/, ""); print; }' || exit 0`
76 FSF=`"$PRG" --version 2>/dev/null || exit 0 | fgrep "Free Software Foundation" | head -n 1`
77 ALL=`"$PRG" -dumpversion 2>/dev/null || exit 0`
78 ONE=`echo "$ALL" | sed -e 's/\..*$//'`
79 if test -n "$FSF" && test -n "$ALL" && test -n "$ONE" ; then
80         if test $ONE -ge 5 ; then
81                 echo ".. adding -P option to work around $PRG $ALL" >&2
82                 preprocessor="$preprocessor -P"
83         fi
84 fi
85
86 PID=$$
87 ED1=sed1_${PID}.sed
88 ED2=sed2_${PID}.sed
89 ED3=sed3_${PID}.sed
90 ED4=sed4_${PID}.sed
91 AW1=awk1_${PID}.awk
92 AW2=awk2_${PID}.awk
93 TMP=gen__${PID}.c
94 trap "rm -f $ED1 $ED2 $ED3 $ED4 $AW1 $AW2 $TMP" 0 1 2 3 15
95
96 ALL=$USE
97 if test "$USE" = implemented ; then
98         CALL="call_"
99         cat >$ED1 <<EOF1
100 /^extern.*implemented/{
101         h
102         s/NCURSES_SP_NAME(\([^)]*\))/NCURSES_SP_NAME___\1/
103         h
104         s/^.*implemented:\([^   *]*\).*/P_POUNDCif_USE_\1_SUPPORT/p
105         g
106         s/^extern \([^;]*\);.*/\1/p
107         g
108         s/^.*implemented:\([^   *]*\).*/P_POUNDCendif/p
109 }
110 /^extern.*generated/{
111         h
112         s/^.*generated:\([^     *]*\).*/P_POUNDCif_USE_\1_SUPPORT/p
113         g
114         s/^extern \([^;]*\);.*/\1/p
115         g
116         s/^.*generated:\([^     *]*\).*/P_POUNDCendif/p
117 }
118 EOF1
119 else
120         CALL=""
121         cat >$ED1 <<EOF1
122 /^extern.*${ALL}/{
123         h
124         s/^.*${ALL}:\([^        *]*\).*/P_POUNDCif_USE_\1_SUPPORT/p
125         g
126         s/^extern \([^;]*\);.*/\1/p
127         g
128         s/^.*${ALL}:\([^        *]*\).*/P_POUNDCendif/p
129 }
130 EOF1
131 fi
132
133 cat >$ED2 <<EOF2
134 /^P_/b nc
135 /(void)/b nc
136         s/,/ a1% /
137         s/,/ a2% /
138         s/,/ a3% /
139         s/,/ a4% /
140         s/,/ a5% /
141         s/,/ a6% /
142         s/,/ a7% /
143         s/,/ a8% /
144         s/,/ a9% /
145         s/,/ a10% /
146         s/,/ a11% /
147         s/,/ a12% /
148         s/,/ a13% /
149         s/,/ a14% /
150         s/,/ a15% /
151         s/*/ * /g
152         s/%/ , /g
153         s/)/ z)/
154         s/\.\.\. z)/...)/
155 :nc
156         s/(/ ( /
157         s/)/ )/
158 EOF2
159
160 cat >$ED3 <<EOF3
161 /^P_/{
162         s/^P_POUNDCif_/#if /
163         s/^P_POUNDCendif/#endif/
164         s/^P_//
165         b done
166 }
167         s/              */ /g
168         s/  */ /g
169         s/ ,/,/g
170         s/( /(/g
171         s/ )/)/g
172         s/ gen_/ /
173         s/^[    ]*@[    ]*@[    ]*/     /
174 :done
175 EOF3
176
177 if test "$USE" = generated ; then
178 cat >$ED4 <<EOF
179         s/^\(.*\) \(.*\) (\(.*\))\$/NCURSES_EXPORT(\1) (\2) (\3)/
180         /attr_[sg]et.* z)/s,z),z GCC_UNUSED),
181 EOF
182 else
183 cat >$ED4 <<EOF
184 /^\(.*\) \(.*\) (\(.*\))\$/ {
185         h
186         s/^\(.*\) \(.*\) (\(.*\))\$/extern \1 call_\2 (\3);/
187         p
188         g
189         s/^\(.*\) \(.*\) (\(.*\))\$/\1 call_\2 (\3)/
190         }
191 s/\([^_]\)NCURSES_SP_NAME___\([a-zA-Z][a-zA-Z_]*\)/\1NCURSES_SP_NAME(\2)/g
192 EOF
193 fi
194
195 cat >$AW1 <<\EOF1
196 BEGIN   {
197                 skip=0;
198         }
199 /^P_POUNDCif/ {
200                 print "\n"
201                 print $0
202                 skip=0;
203 }
204 /^P_POUNDCendif/ {
205                 print $0
206                 skip=1;
207 }
208 $0 !~ /^P_/ {
209         if (skip)
210                 print "\n"
211         skip=1;
212
213         first=$1
214         for (i = 1; i <= NF; i++) {
215                 if ( $i != "NCURSES_CONST" ) {
216                         first = i;
217                         break;
218                 }
219         }
220         second = first + 1;
221         returnCast = "";
222         if ( $first == "chtype" ) {
223                 returnType = "Chtype";
224         } else if ( $first == "SCREEN" ) {
225                 returnType = "SP";
226         } else if ( $first == "WINDOW" ) {
227                 returnType = "Win";
228         } else if ( $first == "attr_t" || $second == "attrset" || $second == "standout" || $second == "standend" || $second == "wattrset" || $second == "wstandout" || $second == "wstandend" ) {
229                 returnType = "IntAttr";
230                 returnCast = "(attr_t)";
231         } else if ( $first == "bool" || $first == "NCURSES_BOOL" ) {
232                 returnType = "Bool";
233         } else if ( $second == "*" ) {
234                 returnType = ($1 == "NCURSES_CONST") ? "CPtr" : "Ptr";
235         } else {
236                 returnType = "Code";
237         }
238         myfunc = second;
239         for (i = second; i <= NF; i++) {
240                 if ($i != "*") {
241                         myfunc = i;
242                         break;
243                 }
244         }
245         print $0;
246         print "{";
247         argcount = 1;
248         check = NF - 1;
249         if ($check == "void")
250                 argcount = 0;
251         if (argcount != 0) {
252                 for (i = 1; i <= NF; i++)
253                         if ($i == ",")
254                                 argcount++;
255         }
256
257         # suppress trace-code for functions that we cannot do properly here,
258         # since they return data.
259         dotrace = 1;
260         if ($myfunc ~ /innstr/)
261                 dotrace = 0;
262         if ($myfunc ~ /innwstr/)
263                 dotrace = 0;
264
265         # workaround functions that we do not parse properly
266         if ($myfunc ~ /ripoffline/) {
267                 dotrace = 0;
268                 argcount = 2;
269                 if ($myfunc ~ /NCURSES_SP_NAME/) {
270                         argcount = 3;
271                 }
272         }
273         if ($myfunc ~ /wunctrl/) {
274                 dotrace = 0;
275         }
276
277         do_getstr = 0;
278         if ($myfunc ~ /get[n]?str/) {
279                 do_getstr = 1;
280         }
281
282         call = "@@T((T_CALLED(\""
283         args = ""
284         comma = ""
285         num = 0;
286         pointer = 0;
287         va_list = 0;
288         varargs = 0;
289         argtype = ""
290         for (i = myfunc; i <= NF; i++) {
291                 ch = $i;
292                 if ( ch == "*" ) {
293                         pointer = 1;
294                 } else if ( ch == "va_list" ) {
295                         va_list = 1;
296                 } else if ( ch == "..." ) {
297                         varargs = 1;
298                 } else if ( ch == "char" ) {
299                         argtype = "char";
300                 } else if ( ch == "int" ) {
301                         argtype = "int";
302                 } else if ( ch == "short" ) {
303                         argtype = "short";
304                 } else if ( ch == "chtype" ) {
305                         argtype = "chtype";
306                 } else if ( ch == "attr_t" || ch == "NCURSES_ATTR_T" ) {
307                         argtype = "attr";
308                 }
309
310                 if ( ch == "," || ch == ")" ) {
311                         argcast = "";
312                         if (va_list) {
313                                 call = call "%s"
314                         } else if (varargs) {
315                                 call = call "%s"
316                         } else if (pointer) {
317                                 if ( argtype == "char" ) {
318                                         if (do_getstr) {
319                                                 call = call "%p"
320                                         } else {
321                                                 call = call "%s"
322                                         }
323                                         comma = comma "_nc_visbuf2(" num ","
324                                         pointer = 0;
325                                 } else {
326                                         call = call "%p"
327                                         comma = comma "(const void *)"
328                                 }
329                         } else if (argcount != 0) {
330                                 if ( argtype == "int" || argtype == "short" ) {
331                                         call = call "%d"
332                                         argtype = ""
333                                 } else if ( argtype != "" ) {
334                                         call = call "%s"
335                                         comma = comma "_trace" argtype "2(" num ","
336                                         if (argtype == "attr") {
337                                                 argcast = "(chtype)";
338                                         }
339                                 } else {
340                                         call = call "%#lx"
341                                         comma = comma "(long)"
342                                 }
343                         }
344                         if (ch == ",") {
345                                 args = args comma "a" ++num;
346                         } else if ( argcount != 0 ) {
347                                 if ( va_list ) {
348                                         args = args comma "\"va_list\""
349                                 } else if ( varargs ) {
350                                         args = args comma "\"...\""
351                                 } else {
352                                         args = args comma argcast "z"
353                                 }
354                         }
355                         call = call ch
356                         if (pointer == 0 && argcount != 0 && argtype != "" )
357                                 args = args ")"
358                         if (args != "")
359                                 comma = ", "
360                         pointer = 0;
361                         argtype = ""
362                 }
363                 if ( i == myfunc || ch == "(" )
364                         call = call ch
365         }
366         call = call "\")"
367         if (args != "")
368                 call = call ", " args
369         call = call ")); "
370
371         if (dotrace)
372                 printf "%s\n\t@@", call
373
374         if (match($0, "^void")) {
375                 call = ""
376         } else if (dotrace) {
377                 call = sprintf("return%s( ", returnType);
378                 if (returnCast != "") {
379                         call = call returnCast;
380                 }
381         } else {
382                 call = "@@return ";
383         }
384
385         call = call $myfunc "(";
386         for (i = 1; i < argcount; i++) {
387                 if (i != 1)
388                         call = call ", ";
389                 call = call "a" i;
390         }
391         if ( argcount != 0 && $check != "..." ) {
392                 if (argcount != 1)
393                         call = call ", ";
394                 call = call "z";
395         }
396         if (!match($0, "^void"))
397                 call = call ") ";
398         if (dotrace) {
399                 call = call ")";
400         }
401         print call ";"
402
403         if (match($0, "^void"))
404                 print "@@returnVoid;"
405         print "}";
406 }
407 EOF1
408
409 cat >$AW2 <<EOF1
410 BEGIN           {
411                 printf "/* This file was generated by $0 */\n"
412                 print ""
413                 print "/*"
414                 print " * DO NOT EDIT THIS FILE BY HAND!"
415                 if ( "$USE" == "generated" ) {
416                         print " *"
417                         print " * This is a file of trivial functions generated from macro"
418                         print " * definitions in curses.h to satisfy the XSI Curses requirement"
419                         print " * that every macro also exist as a callable function."
420                         print " *"
421                         print " * It will never be linked unless you call one of the entry"
422                         print " * points with its normal macro definition disabled.  In that"
423                         print " * case, if you have no shared libraries, it will indirectly"
424                         print " * pull most of the rest of the library into your link image."
425                 }
426                 print " */"
427                 print "#define NCURSES_ATTR_T int"
428                 print "#include <ncurses_cfg.h>"
429                 print ""
430                 print "#undef NCURSES_NOMACROS  /* _this_ file uses macros */"
431                 print ""
432                 print "#include <curses.priv.h>"
433                 print ""
434                 print "#undef vw_scanw"
435                 print "#undef vwscanw"
436                 print ""
437                 print "#undef vw_printw"
438                 print "#undef vwprintw"
439                 }
440 /^DECLARATIONS/ {start = 1; next;}
441                 {
442                 if (start) {
443                         if ( "$USE" == "generated" ) {
444                                 print \$0;
445                         } else if ( \$0 ~ /^[{}]?\$/ ) {
446                                 print \$0;
447                         } else if ( \$0 ~ /;/ ) {
448                                 print \$0;
449                         } else {
450                                 calls[start] = \$0;
451                                 print \$0;
452                                 start++;
453                         }
454                 }
455                 }
456 END             {
457                 if ( "$USE" != "generated" ) {
458                         print "int main(void)"
459                         print "{"
460                         for (n = 1; n < start; ++n) {
461                                 value = calls[n];
462                                 if ( value !~ /P_POUNDC/ ) {
463                                         gsub(/[ \t]+/," ",value);
464                                         sub(/^[0-9a-zA-Z_]+ /,"",value);
465                                         sub(/^\* /,"",value);
466                                         gsub(/[0-9a-zA-Z_]+ \* /,"",value);
467                                         gsub(/ (const) /," ",value);
468                                         gsub(/ (int|short|attr_t|chtype|wchar_t|NCURSES_BOOL|NCURSES_OUTC|NCURSES_OUTC_sp|va_list) /," ",value);
469                                         gsub(/ void /,"",value);
470                                         sub(/^/,"call_",value);
471                                         gsub(/ (a[0-9]|z) /, " 0 ", value);
472                                         gsub(/ int[ \t]*[(][^)]+[)][(][^)]+[)]/, "0", value);
473                                         printf "\t%s;\n", value;
474                                 } else {
475                                         print value;
476                                 }
477                         }
478                         print " return 0;"
479                         print "}"
480                 }
481                 }
482 EOF1
483
484 cat >$TMP <<EOF
485 #include <ncurses_cfg.h>
486 #undef NCURSES_NOMACROS
487 #include <curses.h>
488 #include <term.h>
489 #include <unctrl.h>
490
491 DECLARATIONS
492
493 EOF
494
495 sed -n -f $ED1 \
496 | sed -e 's/NCURSES_EXPORT(\(.*\)) \(.*\) (\(.*\))/\1 \2(\3)/' \
497 | sed -f $ED2 \
498 | $AWK -f $AW1 using=$USE \
499 | sed \
500         -e 's/ [ ]*$//g' \
501         -e 's/^\([a-zA-Z_][a-zA-Z_]*[ *]*\)/\1 gen_/' \
502         -e 's/gen_$//' \
503         -e 's/  / /g' >>$TMP
504
505 $preprocessor $TMP 2>/dev/null \
506 | sed \
507         -e 's/  / /g' \
508         -e 's/^ //' \
509         -e 's/_Bool/NCURSES_BOOL/g' \
510 | $AWK -f $AW2 \
511 | sed -f $ED3 \
512 | sed \
513         -e 's/^.*T_CALLED.*returnCode( \([a-z].*) \));/ return \1;/' \
514         -e 's/^.*T_CALLED.*returnCode( \((wmove.*) \));/        return \1;/' \
515         -e 's/gen_//' \
516         -e 's/^[        ]*#/#/' \
517         -e '/#ident/d' \
518         -e '/#line/d' \
519 | sed -f $ED4