]>
git.saurik.com Git - wxWidgets.git/blob - src/png/scripts/options.awk
2 # scripts/options.awk - library build configuration control
4 # last changed in libpng version 1.5.7 - December 15, 2011
6 # Copyright (c) 1998-2011 Glenn Randers-Pehrson
8 # This code is released under the libpng license.
9 # For conditions of distribution and use, see the disclaimer
10 # and license in png.h
12 # The output of this script is written to the file given by
13 # the variable 'out'. The script is run twice, once with
14 # an intermediate output file, 'options.tmp' then again on
15 # that file to produce the final output:
17 # awk -f scripts/options.awk out=options.tmp scripts/options.dfa 1>&2
18 # awk -f scripts/options.awk out=options.dfn options.tmp 1>&2
20 # Some options may be specified on the command line:
22 # deb=1 Causes debugging to be output
23 # logunsupported=1 Causes all options to be recorded in the output
24 # everything=off Causes all options to be disabled by default
25 # everything=on Causes all options to be enabled by default
27 # If awk fails on your platform, try nawk instead.
29 # These options may also be specified in the original input file (and
30 # are copied to the preprocessed file).
33 out=
"/dev/null" # intermediate, preprocessed, file
34 pre=
-1 # preprocess (first line)
35 version=
"libpng version unknown" # version information
36 version_file=
"" # where to find the version
37 err=
0 # in-line exit sets this
38 start=
"PNG_DEFN_MAGIC-" # Arbitrary start
39 end=
"-PNG_DEFN_END" # Arbitrary end
40 ct=
"PNG_JOIN" # Join two tokens
41 cx=
"/" ct
"*" # Open C comment for output file
42 comment=start cx
# Comment start
43 cend=
"*/" end # Comment end
44 def=start
"#define PNG_" ct
# Arbitrary define
45 sup=ct
"_SUPPORTED" end # end supported option
46 und=comment
"#undef PNG_" ct
# Unsupported option
47 une=ct
"_SUPPORTED" cend
# end unsupported option
48 error=start
"ERROR:" # error message
51 deb=
0 # debug - set on command line
52 everything=
"" # do not override defaults
53 logunsupported=
0 # write unsupported options too
56 option
[""] =
"" # list of all options: default enabled/disabled
57 done
[""] =
1 # marks option as having been output
58 requires
[""] =
"" # requires by option
59 iffs
[""] =
"" # if by option
60 enabledby
[""] =
"" # options that enable it by option
61 setting
[""] =
"" # requires by setting
62 defaults
[""] =
"" # used for a defaulted value
63 doneset
[""] =
1 # marks setting as having been output
64 r
[""] =
"" # Temporary array
66 # For decorating the output file
70 # The output file must be specified before any input:
72 print "out=output.file must be given on the command line"
77 # The very first line indicates whether we are reading pre-processed
78 # input or not, this must come *first* because 'PREPROCESSED' needs
79 # to be the very first line in the temporary file.
81 if ($0 ==
"PREPROCESSED") {
86 print "PREPROCESSED" >out
87 # And fall through to continue processing
91 # While pre-processing if version is set to "search" look for a version string
92 # in the following file.
93 pre
&& version ==
"search" && version_file ==
""{
94 version_file =
FILENAME
97 pre
&& version ==
"search" && version_file
!= FILENAME{
98 print "version string not found in", version_file
103 pre
&& version ==
"search" && $0 ~
/^ \
* libpng version
/{
104 version =
substr($0, 4)
105 print "version =", version
>out
109 pre
&& FILENAME == version_file
{
114 # Sets the given variable to the given value (the syntax is fairly
115 # free form, except for deb (you are expected to understand how to
116 # set the debug variable...)
118 # This happens before the check on 'pre' below skips most of the
119 # rest of the actions, so the variable settings happen during
120 # preprocessing but are recorded in the END action too. This
121 # allows them to be set on the command line too.
122 $0 ~
/^
[ ]*version
[ ]*=
/{
123 sub(/^
[ ]*version
[ ]*=
[ ]*/, "")
127 $0 ~
/^
[ ]*everything
[ =
]*off
[ ]*$
/{
131 $0 ~
/^
[ ]*everything
[ =
]*on
[ ]*$
/{
135 $0 ~
/^
[ ]*logunsupported
[ =
]*0[ ]*$
/{
139 $0 ~
/^
[ ]*logunsupported
[ =
]*1[ ]*$
/{
143 $1 ==
"deb" && $2 ==
"=" && NF ==
3{
148 # Preprocessing - this just copies the input file with lines
149 # that need preprocessing (just chunk at present) expanded
150 # The bare "pre" instead of "pre != 0" crashes under Sunos awk
151 pre
&& $1 != "chunk"{
156 # The first characters of the line determine how it is processed,
157 # leading spaces are ignored. In general tokens that are not
158 # keywords are the names of options. An option 'name' is
159 # controlled by the definition of the corresponding macros:
161 # PNG_name_SUPPORTED The option is turned on
163 # PNG_NO_name_SUPPORTED If the first macro is not defined
164 # either of these will turn the option off
166 # If none of these macros are defined the option is turned on, unless
167 # the keyword 'off' is given in a line relating to the option. The
168 # keyword 'on' can also be given, but it will be ignored (since it is
171 # In the syntax below a 'name' is indicated by "NAME", other macro
172 # values are indicated by "MACRO", as with "NAME" the leading "PNG_"
173 # is omitted, but in this case the "NO_" prefix and the "_SUPPORTED"
174 # suffix are never used.
176 # Each line is introduced by a keyword - the first non-space characters
177 # on the line. A line starting with a '#' is a comment - it is totally
178 # ignored. Keywords are as follows, a NAME, is simply a macro name
179 # without the leading PNG_, PNG_NO_ or the trailing _SUPPORTED.
181 $1 ~
/^
#/ || $0 ~ /^[ ]*$/{
186 # The whole line is placed in the output file as a comment with
187 # the preceding 'com' removed
190 # sub(/^[ ]*com[ ]*/, "")
192 print comment
, $0, cend
>out
199 # Inserts a version comment
200 $1 ==
"version" && NF ==
1{
202 print "ERROR: no version string set"
203 err =
1 # prevent END{} running
207 print comment
, version
, cend
>out
211 # file output input protect
212 # Informational: the official name of the input file (without
213 # make generated local directories), the official name of the
214 # output file and, if required, a name to use in a protection
215 # macro for the contents.
216 $1 ==
"file" && NF >=
2{
217 print comment
, $2, cend
>out
218 print comment
, "Machine generated file: DO NOT EDIT", cend
>out
220 print comment
, "Derived from:", $3, cend
>out
223 print start
"#ifndef", protect
end >out
224 print start
"#define", protect
end >out
229 # option NAME ( (requires|enables|if) NAME* | on | off | disabled )*
230 # Declares an option 'NAME' and describes its default setting (disabled)
231 # and its relationship to other options. The option is disabled
232 # unless *all* the options listed after 'requires' are set and at
233 # least one of the options listed after 'if' is set. If the
234 # option is set then it turns on all the options listed after 'enables'.
236 # Note that "enables" takes priority over the required/if/disabled/off
237 # setting of the target option.
239 # The definition file may list an option as 'disabled': off by default,
240 # otherwise the option is enabled: on by default. A later (and it must
241 # be later) entry may turn an option on or off explicitly.
243 $1 ==
"option" && NF >=
2{
244 onoff = option
[$2] # records current (and the default is "", enabled)
246 for (i=
3; i
<=
NF; ++i
) {
247 if ($
(i
) ==
"on" || $
(i
) ==
"off" || $
(i
) ==
"disabled") {
250 # on or off can zap disabled or enabled:
251 if (onoff ==
"" || (onoff ==
"disabled" || onoff ==
"enabled") && ($
(i
) ==
"on" || $
(i
) ==
"off")) {
252 # It's easy to mis-spell the option when turning it
253 # on or off, so warn about it here:
254 if (onoff ==
"" && ($
(i
) ==
"on" || $
(i
) ==
"off")) {
255 print $2 ": ERROR: turning unrecognized option", $
(i
)
256 # For the moment error out - it is safer
257 err =
1 # prevent END{} running
262 # Print a message, otherwise the error
263 # below is incomprehensible
264 print $2 ": currently", onoff
": attempt to turn", $
(i
)
268 } else if ($
(i
) ==
"requires" || $
(i
) ==
"if" || $
(i
) ==
"enables") {
270 } else if (key ==
"requires") {
271 requires
[$2] = requires
[$2] " " $
(i
)
272 } else if (key ==
"if") {
273 iffs
[$2] = iffs
[$2] " " $
(i
)
274 } else if (key ==
"enables") {
275 enabledby
[$
(i
)] = enabledby
[$
(i
)] " " $2
277 break # bad line format
281 # Set the option, defaulting to 'enabled'
282 if (onoff ==
"") onoff =
"enabled"
286 # Else fall through to the error handler
289 # chunk NAME [requires OPT] [on|off|disabled]
290 # Expands to the 'option' settings appropriate to the reading and
291 # writing of an ancilliary PNG chunk 'NAME':
293 # option READ_NAME requires READ_ANCILLARY_CHUNKS [READ_OPT]
294 # option READ_NAME enables NAME
295 # [option READ_NAME off]
296 # option WRITE_NAME requires WRITE_ANCILLARY_CHUNKS [WRITE_OPT]
297 # option WRITE_NAME enables NAME
298 # [option WRITE_NAME off]
300 pre
!= 0 && $1 ==
"chunk" && NF >=
2{
301 # 'chunk' is handled on the first pass by writing appropriate
302 # 'option' lines into the intermediate file.
306 i =
3 # indicates format error
308 # read the keywords/additional OPTS
310 for (i=
3; i
<=
NF; ++i
) {
311 if ($
(i
) ==
"on" || $
(i
) ==
"off" || $
(i
) ==
"disabled") {
316 break # on/off conflict
318 } else if ($
(i
) ==
"requires")
321 break # bad line: handled below
323 reqread = reqread
" READ_" $
(i
)
324 reqwrite = reqwrite
" WRITE_" $
(i
)
330 # Output new 'option' lines to the intermediate file (out)
331 print "option READ_" $2, "requires READ_ANCILLARY_CHUNKS" reqread
, "enables", $2, onoff
>out
332 print "option WRITE_" $2, "requires WRITE_ANCILLARY_CHUNKS" reqwrite
, "enables", $2, onoff
>out
335 # Else hit the error handler below - bad line format!
338 # setting MACRO ( requires MACRO* )* [ default VALUE ]
339 # Behaves in a similar way to 'option' without looking for NO_ or
340 # _SUPPORTED; the macro is enabled if it is defined so long as all
341 # the 'requires' macros are also defined. The definitions may be
342 # empty, an error will be issued if the 'requires' macros are
343 # *not* defined. If given the 'default' value is used if the
344 # macro is not defined. The default value will be re-tokenised.
345 # (BTW: this is somewhat restrictive, it mainly exists for the
346 # support of non-standard configurations and numeric parameters,
347 # see the uses in scripts/options.dat
349 $1 ==
"setting" && (NF ==
2 || NF >=
3 && ($3 ==
"requires" || $3 ==
"default")){
354 for (i=
3; i
<=
NF; ++i
)
355 if ($
(i
) ==
"requires" || $
(i
) ==
"default") {
357 if (key ==
"default") isdef =
1
358 } else if (key ==
"requires")
360 else if (key ==
"default")
361 deflt = deflt
" " $
(i
)
363 break # Format error, handled below
366 # NOTE: this overwrites a previous value silently
367 if (isdef
&& deflt ==
"")
368 deflt =
" " # as a flag to force output
373 # The order of the dependency lines (option, chunk, setting) is irrelevant
374 # - the 'enables', 'requires' and 'if' settings will be used to determine
375 # the correct order in the output and the final values in pnglibconf.h are
376 # not order dependent. 'requires' and 'if' entries take precedence over
377 # 'enables' from other options; if an option requires another option it
378 # won't be set regardless of any options that enable it unless the other
379 # option is also enabled.
381 # Similarly 'enables' trumps a NO_ definition in CFLAGS or pngusr.h
383 # For simplicity cycles in the definitions are regarded as errors,
384 # even if they are not ambiguous.
385 # A given NAME can be specified in as many 'option' lines as required, the
386 # definitions are additive.
388 # For backwards compatibility equivalent macros may be listed thus:
391 # Makes -DMACRO equivalent to -DPNG_NO_NAME or -DPNG_NAME_SUPPORTED
394 # The definition is injected into the C compiler input when encountered
395 # in the second pass (so all these definitions appear *after* the @
398 # 'NAME' is as above, but 'MACRO' is the full text of the equivalent
399 # old, deprecated, macro.
401 $1 ==
"=" && NF ==
3{
402 print "#ifdef PNG_" $3 >out
404 print "# define PNG_" $2 >out
406 print "# define PNG_" $2 "_SUPPORTED" >out
411 # Lines may be injected into the C compiler input by preceding them
412 # with an "@" character. The line is copied with just the leading
422 # Check for unreognized lines, because of the preprocessing chunk
423 # format errors will be detected on the first pass independent of
424 # any other format errors.
426 print "options.awk: bad line (" NR "):", $0
427 err =
1 # prevent END{} running
431 # For checking purposes names that start with "ok_" or "fail_" are
432 # not output to pnglibconf.h and must be either enabled or disabled
433 # respectively for the build to succeed. This allows interdependencies
434 # between options of the form "at least one of" or "at most one of"
435 # to be checked. For example:
437 # option FLOATING_POINT enables ok_math
438 # option FIXED_POINT enables ok_math
439 # This ensures that at least one of FLOATING_POINT and FIXED_POINT
440 # must be set for the build to succeed.
442 # option fail_math requires FLOATING_POINT FIXED_POINT
443 # This means the build will fail if *both* FLOATING_POINT and
444 # FIXED_POINT are set (this is an example; in fact both are allowed.)
446 # If all these options were given the build would require exactly one
447 # of the names to be enabled.
450 # END{} gets run on an exit (a traditional awk feature)
454 # Record the final value of the variables
455 print "deb =", deb
>out
456 if (everything
!= "") {
457 print "everything =", everything
>out
459 print "logunsupported =", logunsupported
>out
463 # Do the 'setting' values first, the algorithm the standard
464 # tree walk (O(1)) done in an O(2) while/for loop; interations
465 # settings x depth, outputing the deepest required macros
468 print "/* SETTINGS */" >out
469 print comment
, "settings", cend
>out
473 movement =
0 # done nothing
474 for (i in setting
) if (!doneset
[i
]) {
475 nreqs =
split(setting
[i
], r
)
477 for (j=
1; j
<=nreqs
; ++j
) if (!doneset
[r
[j
]]) {
482 continue # try a different setting
486 # All the requirements have been processed, output
488 if (deb
) print "setting", i
490 print "/* setting: ", i
>out
491 print " * requires:" setting
[i
] >out
492 print " * default: ", defaults
[i
], "*/" >out
493 if (defaults
[i
] ==
"") { # no default, only check if defined
494 print "#ifdef PNG_" i
>out
496 for (j=
1; j
<=nreqs
; ++j
) {
497 print "# ifndef PNG_" r
[j
] >out
498 print error
, i
, "requires", r
[j
] end >out
501 if (defaults
[i
] != "") { # default handling
502 print "#ifdef PNG_" i
>out
504 print def i
, "PNG_" i
end >out
505 if (defaults
[i
] != "") {
506 print "#else /*default*/" >out
507 # And add the default definition for the benefit
508 # of later settings an options test:
509 print "# define PNG_" i defaults
[i
] >out
510 print def i defaults
[i
] end >out
518 if (!finished
&& !movement
) {
519 print "setting: loop or missing setting in 'requires', cannot process:"
520 for (i in setting
) if (!doneset
[i
]) {
521 print " setting", i
, "requires" setting
[i
]
526 print comment
, "end of settings", cend
>out
528 # Now do the options - somewhat more complex. The dependency
534 # name enabledby name
536 # First build a list 'tree' by option of all the things on which
539 print "/* OPTIONS */" >out
540 print comment
, "options", cend
>out
541 for (opt in enabledby
) tree
[opt
] =
1 # may not be explicit options
542 for (opt in option
) if (opt
!= "") {
544 # option should always be one of the following values
545 if (o
!= "on" && o
!= "off" && o
!= "disabled" && o
!= "enabled") {
546 print "internal option error (" o
")"
549 tree
[opt
] =
"" # so unlisted options marked
551 for (opt in tree
) if (opt
!= "") {
552 if (tree
[opt
] ==
1) {
554 if (option
[opt
] != "") {
555 print "internal error (1)"
558 # Macros only listed in 'enables' remain off unless
559 # one of the enabling macros is on.
560 option
[opt
] =
"disabled"
563 split("", list
) # clear 'list'
564 # Now add every requires, iffs or enabledby entry to 'list'
565 # so that we can add a unique list of requirements to tree[i]
566 split(requires
[opt
] iffs
[opt
] enabledby
[opt
], r
)
567 for (i in r
) list
[r
[i
]] =
1
568 for (i in list
) tree
[opt
] = tree
[opt
] " " i
571 # print the tree for extreme debugging
572 if (deb
> 2) for (i in tree
) if (i
!= "") print i
, "depends-on" tree
[i
]
574 # Ok, now check all options marked explicitly 'on' or 'off':
576 # If an option[opt] is 'on' then turn on all requires[opt]
577 # If an option[opt] is 'off' then turn off all enabledby[opt]
579 # Error out if we have to turn 'on' an 'off' option or vice versa.
581 for (opt in option
) if (opt
!= "") {
582 if (option
[opt
] ==
"on" || option
[opt
] ==
"off") {
583 pending
[++npending
] = opt
587 err =
0 # set on error
588 while (npending
> 0) {
589 opt = pending
[npending
--]
590 if (option
[opt
] ==
"on") {
591 nreqs =
split(requires
[opt
], r
)
592 for (j=
1; j
<=nreqs
; ++j
) {
593 if (option
[r
[j
]] ==
"off") {
594 print "option", opt
, "turned on, but requirement", r
[j
], "is turned off"
596 } else if (option
[r
[j
]] != "on") {
598 pending
[++npending
] = r
[j
]
602 if (option
[opt
] != "off") {
603 print "internal error (2)"
606 nreqs =
split(enabledby
[opt
], r
)
607 for (j=
1; j
<=nreqs
; ++j
) {
608 if (option
[r
[j
]] ==
"on") {
609 print "option", opt
, "turned off, but enabled by", r
[j
], "which is turned on"
611 } else if (option
[r
[j
]] != "off") {
613 pending
[++npending
] = r
[j
]
620 # option[i] is now the complete list of all the tokens we may
621 # need to output, go through it as above, depth first.
625 movement =
0 # done nothing
626 for (i in option
) if (!done
[i
]) {
627 nreqs =
split(tree
[i
], r
)
629 for (j=
1; j
<=nreqs
; ++j
) if (!done
[r
[j
]]) {
634 continue # next option
638 # All the requirements have been processed, output
639 # this option. An option is _SUPPORTED if:
641 # all 'requires' are _SUPPORTED AND
642 # at least one of the 'if' options are _SUPPORTED AND
644 # The name is _SUPPORTED (on the command line)
646 # an 'enabledby' is _SUPPORTED
648 # NO_name is not defined AND
649 # the option is not disabled; an option is disabled if:
651 # option == disabled && everything != on
652 # option == "" && everything == off
653 if (deb
) print "option", i
655 print "/* option:", i
, option
[i
] >out
656 print " * requires: " requires
[i
] >out
657 print " * if: " iffs
[i
] >out
658 print " * enabled-by:" enabledby
[i
], "*/" >out
659 print "#undef PNG_on" >out
660 print "#define PNG_on 1" >out
663 nreqs =
split(requires
[i
], r
)
664 for (j=
1; j
<=nreqs
; ++j
) {
665 print "#ifndef PNG_" r
[j
] "_SUPPORTED" >out
666 print "# undef PNG_on /*!" r
[j
] "*/" >out
667 # this error appears in the final output if something
668 # was switched 'on' but the processing above to force
669 # the requires did not work
670 if (option
[i
] ==
"on") {
671 print error
, i
, "requires", r
[j
] end >out
677 nreqs =
split(iffs
[i
], r
)
678 print "#undef PNG_no_if" >out
680 print "/* if" iffs
[i
], "*/" >out
681 print "#define PNG_no_if 1" >out
682 for (j=
1; j
<=nreqs
; ++j
) {
683 print "#ifdef PNG_" r
[j
] "_SUPPORTED" >out
684 print "# undef PNG_no_if /*" r
[j
] "*/" >out
687 print "#ifdef PNG_no_if /*missing if*/" >out
688 print "# undef PNG_on" >out
689 # There is no checking above for this, because we
690 # don't know which 'if' to choose, so whine about
692 if (option
[i
] ==
"on") {
693 print error
, i
, "needs one of:", iffs
[i
] end >out
698 print "#ifdef PNG_on /*requires, if*/" >out
700 print "# undef PNG_not_enabled" >out
701 print "# define PNG_not_enabled 1" >out
702 print " /* enabled by" enabledby
[i
], "*/" >out
703 nreqs =
split(enabledby
[i
], r
)
704 for (j=
1; j
<=nreqs
; ++j
) {
705 print "#ifdef PNG_" r
[j
] "_SUPPORTED" >out
706 print "# undef PNG_not_enabled /*" r
[j
] "*/" >out
707 # Oops, probably not intended (should be factored
708 # out by the checks above).
709 if (option
[i
] ==
"off") {
710 print error
, i
, "enabled by:", r
[j
] end >out
715 print "# ifndef PNG_" i
"_SUPPORTED /*!command line*/" >out
716 print "# ifdef PNG_not_enabled /*!enabled*/" >out
717 if (option
[i
] ==
"off" || option
[i
] ==
"disabled" && everything
!= "on" || option
[i
] ==
"enabled" && everything ==
"off") {
718 print "# undef PNG_on /*default off*/" >out
720 print "# ifdef PNG_NO_" i
>out
721 print "# undef PNG_on /*turned off*/" >out
723 print "# ifdef PNG_NO_" i
"_SUPPORTED" >out
724 print "# undef PNG_on /*turned off*/" >out
727 print "# endif /*!enabled*/" >out
728 print "# ifdef PNG_on" >out
729 # The _SUPPORTED macro must be defined so that dependent
730 # options output later work.
731 print "# define PNG_" i
"_SUPPORTED" >out
733 print "# endif /*!command line*/" >out
734 # If PNG_on is still set the option should be defined in
736 print "# ifdef PNG_on" >out
738 print error
, i
, "is on: enabled by:" iffs
[i
] enabledby
[i
] ", requires" requires
[i
] end >out
739 } else if (i !~
/^ok_
/) {
742 print "# endif /* definition */" >out
743 print "#endif /*requires, if*/" >out
744 if (logunsupported
|| i ~
/^ok_
/) {
745 print "#ifndef PNG_on" >out
746 if (logunsupported
) {
750 print error
, i
, "not enabled: requires:" requires
[i
] ", enabled by:" iffs
[i
] enabledby
[i
] end >out
759 if (!finished
&& !movement
) {
760 print "option: loop or missing option in dependency tree, cannot process:"
761 for (i in option
) if (!done
[i
]) {
762 print " option", i
, "depends on" tree
[i
], "needs:"
763 nreqs =
split(tree
[i
], r
)
764 if (nreqs
> 0) for (j=
1; j
<=nreqs
; ++j
) if (!done
[r
[j
]]) {
771 print comment
, "end of options", cend
>out
773 # Regular end - everything looks ok
775 print start
"#endif", cx
, protect
, "*/" end >out