2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1988, 1989 by Adam de Boor
5 * Copyright (c) 1989 by Berkeley Softworks
8 * This code is derived from software contributed to Berkeley by
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * @(#)cond.c 8.2 (Berkeley) 1/2/94
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
46 * Functions to handle conditionals in a makefile.
49 * Cond_Eval Evaluate the conditional in the passed line.
69 * The parsing of conditional expressions is based on this grammar:
74 * T -> defined(variable)
80 * T -> $(varspec) op value
81 * T -> $(varspec) == "string"
82 * T -> $(varspec) != "string"
85 * op -> == | != | > | < | >= | <=
87 * 'symbol' is some other symbol to which the default function (condDefProc)
90 * Tokens are scanned from the 'condExpr' string. The scanner (CondToken)
91 * will return And for '&' and '&&', Or for '|' and '||', Not for '!',
92 * LParen for '(', RParen for ')' and will evaluate the other terminal
93 * symbols, using either the default function or the function given in the
94 * terminal, and return the result as either True or False.
96 * All Non-Terminal functions (CondE, CondF and CondT) return Err on error.
111 typedef Boolean
CondProc(int, char *);
114 * Structures to handle elegantly the different forms of #if's. The
115 * last two fields are stored in condInvert and condDefProc, respectively.
117 static void CondPushBack(Token
);
118 static int CondGetArg(char **, char **, const char *, Boolean
);
119 static CondProc CondDoDefined
;
120 static CondProc CondDoMake
;
121 static CondProc CondDoExists
;
122 static CondProc CondDoTarget
;
123 static char *CondCvtArg(char *, double *);
124 static Token
CondToken(Boolean
);
125 static Token
CondT(Boolean
);
126 static Token
CondF(Boolean
);
127 static Token
CondE(Boolean
);
129 static const struct If
{
130 Boolean doNot
; /* TRUE if default function should be negated */
131 CondProc
*defProc
; /* Default function to apply */
132 Boolean isElse
; /* actually el<XXX> */
134 [COND_IF
] = { FALSE
, CondDoDefined
, FALSE
},
135 [COND_IFDEF
] = { FALSE
, CondDoDefined
, FALSE
},
136 [COND_IFNDEF
] = { TRUE
, CondDoDefined
, FALSE
},
137 [COND_IFMAKE
] = { FALSE
, CondDoMake
, FALSE
},
138 [COND_IFNMAKE
] = { TRUE
, CondDoMake
, FALSE
},
139 [COND_ELIF
] = { FALSE
, CondDoDefined
, TRUE
},
140 [COND_ELIFDEF
] = { FALSE
, CondDoDefined
, TRUE
},
141 [COND_ELIFNDEF
] = { TRUE
, CondDoDefined
, TRUE
},
142 [COND_ELIFMAKE
] = { FALSE
, CondDoMake
, TRUE
},
143 [COND_ELIFNMAKE
] = { TRUE
, CondDoMake
, TRUE
},
146 static Boolean condInvert
; /* Invert the default function */
147 static CondProc
*condDefProc
; /* default function to apply */
148 static char *condExpr
; /* The expression to parse */
149 static Token condPushBack
= None
; /* Single push-back token in parsing */
151 #define MAXIF 30 /* greatest depth of #if'ing */
153 static Boolean condStack
[MAXIF
]; /* Stack of conditionals's values */
154 static int condLineno
[MAXIF
]; /* Line numbers of the opening .if */
155 static int condTop
= MAXIF
; /* Top-most conditional */
156 static int skipIfLevel
= 0; /* Depth of skipped conditionals */
157 static int skipIfLineno
[MAXIF
]; /* Line numbers of skipped .ifs */
158 Boolean skipLine
= FALSE
; /* Whether the parse module is skipping
163 * Push back the most recent token read. We only need one level of
164 * this, so the thing is just stored in 'condPushback'.
167 * condPushback is overwritten.
170 CondPushBack(Token t
)
178 * Find the argument of a built-in function. parens is set to TRUE
179 * if the arguments are bounded by parens.
182 * The length of the argument and the address of the argument.
185 * The pointer is set to point to the closing parenthesis of the
189 CondGetArg(char **linePtr
, char **argPtr
, const char *func
, Boolean parens
)
197 while (*cp
!= '(' && *cp
!= '\0') {
207 * No arguments whatsoever. Because 'make' and 'defined'
208 * aren't really "reserved words", we don't print a message.
209 * I think this is better than hitting the user with a warning
210 * message every time s/he uses the word 'make' or 'defined'
211 * at the beginning of a symbol...
217 while (*cp
== ' ' || *cp
== '\t') {
222 * Create a buffer for the argument and start it out at 16 characters
223 * long. Why 16? Why not?
227 while ((strchr(" \t)&|", *cp
) == NULL
) && (*cp
!= '\0')) {
230 * Parse the variable spec and install it as part of
231 * the argument if it's valid. We tell Var_Parse to
232 * complain on an undefined variable, so we don't do
233 * it too. Nor do we return an error, though perhaps
240 cp2
= Var_Parse(cp
, VAR_CMD
, TRUE
, &len
, &doFree
);
242 Buf_Append(buf
, cp2
);
248 Buf_AddByte(buf
, (Byte
)*cp
);
253 Buf_AddByte(buf
, (Byte
)'\0');
254 *argPtr
= (char *)Buf_GetAll(buf
, &argLen
);
255 Buf_Destroy(buf
, FALSE
);
257 while (*cp
== ' ' || *cp
== '\t') {
260 if (parens
&& *cp
!= ')') {
261 Parse_Error(PARSE_WARNING
,
262 "Missing closing parenthesis for %s()", func
);
266 * Advance pointer past close parenthesis.
277 * Handle the 'defined' function for conditionals.
280 * TRUE if the given variable is defined.
283 CondDoDefined(int argLen
, char *arg
)
285 char savec
= arg
[argLen
];
289 if (Var_Value(arg
, VAR_CMD
) != NULL
) {
300 * Handle the 'make' function for conditionals.
303 * TRUE if the given target is being made.
306 CondDoMake(int argLen
, char *arg
)
308 char savec
= arg
[argLen
];
314 LST_FOREACH(ln
, &create
) {
315 if (Str_Match(Lst_Datum(ln
), arg
)) {
326 * See if the given file exists.
329 * TRUE if the file exists and FALSE if it does not.
332 CondDoExists(int argLen
, char *arg
)
334 char savec
= arg
[argLen
];
339 path
= Path_FindFile(arg
, &dirSearchPath
);
352 * See if the given node exists and is an actual target.
355 * TRUE if the node exists as a target and FALSE if it does not.
358 CondDoTarget(int argLen
, char *arg
)
360 char savec
= arg
[argLen
];
365 gn
= Targ_FindNode(arg
, TARG_NOCREATE
);
366 if ((gn
!= NULL
) && !OP_NOP(gn
->type
)) {
377 * Convert the given number into a double. If the number begins
378 * with 0x, it is interpreted as a hexadecimal integer
379 * and converted to a double from there. All other strings just have
380 * strtod called on them.
383 * Sets 'value' to double value of string.
384 * Returns address of the first character after the last valid
385 * character of the converted number.
388 * Can change 'value' even if string is not a valid number.
391 CondCvtArg(char *str
, double *value
)
394 if ((*str
== '0') && (str
[1] == 'x')) {
397 for (str
+= 2, i
= 0; ; str
++) {
400 if (isdigit((unsigned char)*str
))
402 else if (isxdigit((unsigned char)*str
))
404 isupper((unsigned char)*str
) ? 'A' : 'a';
415 *value
= strtod(str
, &eptr
);
422 * Return the next token from the input.
425 * A Token for the next lexical token in the stream.
428 * condPushback will be set back to None if it is used.
431 CondToken(Boolean doEval
)
435 if (condPushBack
!= None
) {
441 while (*condExpr
== ' ' || *condExpr
== '\t') {
454 if (condExpr
[1] == '|') {
461 if (condExpr
[1] == '&') {
480 size_t varSpecLen
= 0;
484 * Parse the variable spec and skip over it, saving its
488 lhs
= Var_Parse(condExpr
, VAR_CMD
, doEval
,
489 &varSpecLen
, &doFree
);
490 if (lhs
== var_Error
) {
492 * Even if !doEval, we still report syntax
493 * errors, which is what getting var_Error
494 * back with !doEval means.
498 condExpr
+= varSpecLen
;
500 if (!isspace((unsigned char)*condExpr
) &&
501 strchr("!=><", *condExpr
) == NULL
) {
506 Buf_Append(buf
, lhs
);
512 !isspace((unsigned char)*condExpr
);
514 Buf_AddByte(buf
, (Byte
)*condExpr
);
516 Buf_AddByte(buf
, (Byte
)'\0');
517 lhs
= (char *)Buf_GetAll(buf
, &varSpecLen
);
518 Buf_Destroy(buf
, FALSE
);
524 * Skip whitespace to get to the operator
526 while (isspace((unsigned char)*condExpr
))
530 * Make sure the operator is a valid one. If it isn't a
531 * known relational operator, pretend we got a
540 if (condExpr
[1] == '=') {
545 while (isspace((unsigned char)*condExpr
)) {
548 if (*condExpr
== '\0') {
549 Parse_Error(PARSE_WARNING
,
550 "Missing right-hand-side of operator");
563 * Doing a string comparison. Only allow == and
564 * != for * operators.
572 if (((*op
!= '!') && (*op
!= '=')) ||
574 Parse_Error(PARSE_WARNING
,
575 "String comparison operator should "
576 "be either == or !=");
581 qt
= *rhs
== '"' ? 1 : 0;
584 ((qt
&& (*cp
!= '"')) ||
585 (!qt
&& strchr(" \t)", *cp
) == NULL
)) &&
586 (*cp
!= '\0'); cp
++) {
587 if ((*cp
== '\\') && (cp
[1] != '\0')) {
589 * Backslash escapes things --
590 * skip over next character, * if it exists.
593 Buf_AddByte(buf
, (Byte
)*cp
);
595 } else if (*cp
== '$') {
599 cp2
= Var_Parse(cp
, VAR_CMD
,
600 doEval
, &len
, &freeIt
);
601 if (cp2
!= var_Error
) {
602 Buf_Append(buf
, cp2
);
612 Buf_AddByte(buf
, (Byte
)*cp
);
616 string
= Buf_Peel(buf
);
618 DEBUGF(COND
, ("lhs = \"%s\", rhs = \"%s\", "
619 "op = %.2s\n", lhs
, string
, op
));
621 * Null-terminate rhs and perform the
622 * comparison. t is set to the result.
625 t
= strcmp(lhs
, string
) ? False
: True
;
627 t
= strcmp(lhs
, string
) ? True
: False
;
630 if (rhs
== condExpr
) {
631 if (*cp
== '\0' || (!qt
&& *cp
== ')'))
638 * rhs is either a float or an integer.
639 * Convert both the lhs and the rhs to a
640 * double and compare the two.
645 if (*CondCvtArg(lhs
, &left
) != '\0')
646 goto do_string_compare
;
651 string
= Var_Parse(rhs
, VAR_CMD
, doEval
,
653 if (string
== var_Error
) {
656 if (*CondCvtArg(string
,
660 goto do_string_compare
;
668 char *c
= CondCvtArg(rhs
, &right
);
671 goto do_string_compare
;
672 if (rhs
== condExpr
) {
674 * Skip over the right-hand side
680 DEBUGF(COND
, ("left = %f, right = %f, "
681 "op = %.2s\n", left
, right
, op
));
685 Parse_Error(PARSE_WARNING
,
689 t
= (left
!= right
? True
: False
);
693 Parse_Error(PARSE_WARNING
,
697 t
= (left
== right
? True
: False
);
701 t
= (left
<= right
?True
:False
);
703 t
= (left
< right
?True
:False
);
708 t
= (left
>= right
?True
:False
);
710 t
= (left
> right
?True
:False
);
725 Boolean invert
= FALSE
;
729 if (strncmp(condExpr
, "defined", 7) == 0) {
731 * Use CondDoDefined to evaluate the argument
732 * and CondGetArg to extract the argument from
733 * the 'function call'.
735 evalProc
= CondDoDefined
;
737 arglen
= CondGetArg(&condExpr
, &arg
,
744 } else if (strncmp(condExpr
, "make", 4) == 0) {
746 * Use CondDoMake to evaluate the argument and
747 * CondGetArg to extract the argument from the
750 evalProc
= CondDoMake
;
752 arglen
= CondGetArg(&condExpr
, &arg
,
759 } else if (strncmp(condExpr
, "exists", 6) == 0) {
761 * Use CondDoExists to evaluate the argument and
762 * CondGetArg to extract the argument from the
765 evalProc
= CondDoExists
;
767 arglen
= CondGetArg(&condExpr
, &arg
,
774 } else if (strncmp(condExpr
, "empty", 5) == 0) {
776 * Use Var_Parse to parse the spec in parens and
777 * return True if the resulting string is empty.
786 condExpr
[arglen
] != '(' &&
787 condExpr
[arglen
] != '\0'; arglen
+= 1)
790 if (condExpr
[arglen
] != '\0') {
792 val
= Var_Parse(&condExpr
[arglen
- 1],
793 VAR_CMD
, FALSE
, &length
, &doFree
);
794 if (val
== var_Error
) {
798 * A variable is empty when it
799 * just contains spaces...
806 isspace((unsigned char)*p
);
809 t
= (*p
== '\0') ? True
: False
;
815 * Advance condExpr to beyond the
816 * closing ). Note that we subtract
817 * one from arglen + length b/c length
819 * condExpr[arglen - 1].
821 condExpr
+= arglen
+ length
- 1;
828 } else if (strncmp(condExpr
, "target", 6) == 0) {
830 * Use CondDoTarget to evaluate the argument and
831 * CondGetArg to extract the argument from the
834 evalProc
= CondDoTarget
;
836 arglen
= CondGetArg(&condExpr
, &arg
,
845 * The symbol is itself the argument to the
846 * default function. We advance condExpr to
847 * the end of the symbol by hand (the next
848 * whitespace, closing paren or binary operator)
849 * and set to invert the evaluation
850 * function if condInvert is TRUE.
854 evalProc
= condDefProc
;
855 arglen
= CondGetArg(&condExpr
, &arg
, "", FALSE
);
859 * Evaluate the argument using the set function. If
860 * invert is TRUE, we invert the sense of the function.
862 t
= (!doEval
|| (* evalProc
) (arglen
, arg
) ?
863 (invert
? False
: True
) :
864 (invert
? True
: False
));
874 * Parse a single term in the expression. This consists of a terminal
875 * symbol or Not and a terminal symbol (not including the binary
877 * T -> defined(variable) | make(target) | exists(file) | symbol
881 * True, False or Err.
884 * Tokens are consumed.
887 CondT(Boolean doEval
)
891 t
= CondToken(doEval
);
892 if (t
== EndOfFile
) {
894 * If we reached the end of the expression, the expression
898 } else if (t
== LParen
) {
904 if (CondToken(doEval
) != RParen
) {
908 } else if (t
== Not
) {
912 } else if (t
== False
) {
921 * Parse a conjunctive factor (nice name, wot?)
928 * Tokens are consumed.
931 CondF(Boolean doEval
)
937 o
= CondToken(doEval
);
943 * If T is False, the whole thing will be False, but
944 * we have to parse the r.h.s. anyway (to throw it
945 * away). If T is True, the result is the r.h.s.,
946 * be it an Err or no.
965 * Main expression production.
969 * True, False or Err.
972 * Tokens are, of course, consumed.
975 CondE(Boolean doEval
)
981 o
= CondToken(doEval
);
987 * A similar thing occurs for ||, except that here we
988 * make sure the l.h.s. is False before we bother to
989 * evaluate the r.h.s. Once again, if l is False, the
990 * result is the r.h.s. and once again if l is True,
991 * we parse the r.h.s. to throw it away.
1010 * Handle .if<X> and .elif<X> directives.
1011 * This function is called even when we're skipping.
1014 Cond_If(char *line
, int code
, int lineno
)
1016 const struct If
*ifp
;
1022 if (condTop
== MAXIF
) {
1023 Parse_Error(PARSE_FATAL
, "if-less elif");
1026 if (skipIfLevel
!= 0) {
1028 * If skipping this conditional, just ignore
1029 * the whole thing. If we don't, the user
1030 * might be employing a variable that's
1031 * undefined, for which there's an enclosing
1032 * ifdef that we're skipping...
1034 skipIfLineno
[skipIfLevel
- 1] = lineno
;
1038 } else if (skipLine
) {
1040 * Don't even try to evaluate a conditional that's
1041 * not an else if we're skipping things...
1043 skipIfLineno
[skipIfLevel
] = lineno
;
1049 * Initialize file-global variables for parsing
1051 condDefProc
= ifp
->defProc
;
1052 condInvert
= ifp
->doNot
;
1054 while (*line
== ' ' || *line
== '\t') {
1059 condPushBack
= None
;
1061 switch (CondE(TRUE
)) {
1063 if (CondToken(TRUE
) != EndOfFile
)
1069 if (CondToken(TRUE
) != EndOfFile
)
1075 err
: Parse_Error(PARSE_FATAL
, "Malformed conditional (%s)", line
);
1083 /* push this value */
1086 } else if (skipIfLevel
!= 0 || condStack
[condTop
]) {
1088 * If this is an else-type conditional, it should only take
1089 * effect if its corresponding if was evaluated and FALSE.
1090 * If its if was TRUE or skipped, we return COND_SKIP (and
1091 * start skipping in case we weren't already), leaving the
1092 * stack unmolested so later elif's don't screw up...
1100 * This is the one case where we can definitely proclaim a fatal
1101 * error. If we don't, we're hosed.
1103 Parse_Error(PARSE_FATAL
, "Too many nested if's. %d max.",MAXIF
);
1108 condStack
[condTop
] = value
;
1109 condLineno
[condTop
] = lineno
;
1115 * Handle .else statement.
1118 Cond_Else(char *line __unused
, int code __unused
, int lineno __unused
)
1121 while (isspace((u_char
)*line
))
1124 if (*line
!= '\0' && (warn_flags
& WARN_DIRSYNTAX
)) {
1125 Parse_Error(PARSE_WARNING
, "junk after .else ignored '%s'",
1129 if (condTop
== MAXIF
) {
1130 Parse_Error(PARSE_FATAL
, "if-less else");
1133 if (skipIfLevel
!= 0)
1136 if (skipIfLevel
!= 0 || condStack
[condTop
]) {
1138 * An else should only take effect if its corresponding if was
1139 * evaluated and FALSE.
1140 * If its if was TRUE or skipped, we return COND_SKIP (and
1141 * start skipping in case we weren't already), leaving the
1142 * stack unmolested so later elif's don't screw up...
1143 * XXX How does this work with two .else's?
1150 condStack
[condTop
] = !condStack
[condTop
];
1151 skipLine
= !condStack
[condTop
];
1156 * Handle .endif statement.
1159 Cond_Endif(char *line __unused
, int code __unused
, int lineno __unused
)
1162 while (isspace((u_char
)*line
))
1165 if (*line
!= '\0' && (warn_flags
& WARN_DIRSYNTAX
)) {
1166 Parse_Error(PARSE_WARNING
, "junk after .endif ignored '%s'",
1171 * End of a conditional section. If skipIfLevel is non-zero,
1172 * that conditional was skipped, so lines following it should
1173 * also be skipped. Hence, we return COND_SKIP. Otherwise,
1174 * the conditional was read so succeeding lines should be
1175 * parsed (think about it...) so we return COND_PARSE, unless
1176 * this endif isn't paired with a decent if.
1178 if (skipIfLevel
!= 0) {
1183 if (condTop
== MAXIF
) {
1184 Parse_Error(PARSE_FATAL
, "if-less endif");
1195 * Make sure everything's clean at the end of a makefile.
1198 * Parse_Error will be called if open conditionals are around.
1205 if (condTop
!= MAXIF
) {
1206 Parse_Error(PARSE_FATAL
, "%d open conditional%s:",
1207 MAXIF
- condTop
+ skipIfLevel
,
1208 MAXIF
- condTop
+ skipIfLevel
== 1 ? "" : "s");
1210 for (level
= skipIfLevel
; level
> 0; level
--)
1211 Parse_Error(PARSE_FATAL
, "\t%*sat line %d (skipped)",
1212 MAXIF
- condTop
+ level
+ 1, "",
1213 skipIfLineno
[level
- 1]);
1214 for (level
= condTop
; level
< MAXIF
; level
++)
1215 Parse_Error(PARSE_FATAL
, "\t%*sat line %d "
1216 "(evaluated to %s)", MAXIF
- level
+ skipIfLevel
,
1217 "", condLineno
[level
],
1218 condStack
[level
] ? "true" : "false");