python/mozbuild/mozbuild/preprocessor.py and is typically invoked via
While used to preprocess CSS files, the directives are changed to begin with
% instead of
# to avoid conflict of the id selectors.
#define variable #define variable value
Defines a preprocessor variable.
Note that, unlike the C preprocessor, instances of this variable later in the source are not automatically replaced (see #filter). If value is not supplied, it defaults to
Note that whitespace is significant, so
"#define foo one" and
"#define foo one " is different (in the second case,
foo is defined to be a four-character string).
Undefines a preprocessor variable.
#if variable #if !variable #if variable==string #if variable!=string
Disables output if the conditional is false. This can be nested to arbitrary depths. Note that in the equality checks, the variable must come first, and the comparison operator must not be surrounded by any whitespace.
Reverses the state of the previous conditional block; for example, if the last
#if was true (output was enabled), an
#else makes it off (output gets disabled).
#else is relative to the last conditional block only, unlike the C preprocessor.
It does not matter whether any blocks before it were true. This behavior changed on trunk (Gecko 1.9) on 2006-12-07; see Bug 277122 for details.
#if 1 always included #elif 1 never included #else always included #endif
Ends the conditional block.
#ifdef variable #ifndef variable
#if conditional that is true only if the preprocessor variable variable is defined (in the case of
ifdef) or not defined (
#elif variable #elif !variable #elif variable == string #elif variable != string #elifdef variable #elifndef variable
A shorthand to mean an
#else combined with the relevant conditional. The following two blocks are equivalent:
#ifdef foo block 1 #elifdef bar block 2 #endif
#ifdef foo block 1 #else #ifdef bar block 2 #endif #endif
#elifndef is relative to the last conditional block only (as well as the condition it implies), unlike the C preprocessor. It does not matter whether any blocks before it were true. This behavior changed on trunk (Gecko 1.9) on 2006-12-07. See Bug 277122 for details.
The file specified by filename is processed as if the contents was placed at this position. This also means that preprocessor conditionals can even be started in one file and ended in another (but is highly discouraged). There is no limit on depth of inclusion, or repeated inclusion of the same file, or self inclusion; thus, care should be taken to avoid infinite loops.
Same as a
#include except that all instances of variable in the included file is also expanded as in
All variables wrapped in
__ are replaced with their value, for this line only. If the variable is not defined, it expands to an empty string. For example, if
foo has the value
baz is not defined, then:
#expand This <__foo__> <__baz__> gets expanded
Is expanded to:
This <bar> <> gets expanded
#filter filter1 filter2 ... filterN #unfilter filter1 filter2 ... filterN
#filter turns on the given filter.
Filters are run in alphabetical order on a per-line basis.
#unfilter turns off the given filter. Available filters are:
strips blank lines from the output
strips everything from the first two consecutive slash (
/) characters until the end of the line
collapses consecutive sequences of spaces into a single space, and strips leading and trailing spaces
all variables wrapped in @ are replaced with their value. If the variable is not defined, it is a fatal error. Similar to
all variables wrapped in
@ are replaced with their value, or an empty string if the variable is not defined. Similar to
Output the string (i.e. the rest of the line) literally, with no other fixups. This is useful to output lines starting with
#, or to temporarily disable filters.
Cause a fatal error at this point, with the error message being the given string.