cond.c revision 1.129 1 /* $NetBSD: cond.c,v 1.129 2020/09/11 07:09:40 rillig Exp $ */
2
3 /*
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35 /*
36 * Copyright (c) 1988, 1989 by Adam de Boor
37 * Copyright (c) 1989 by Berkeley Softworks
38 * All rights reserved.
39 *
40 * This code is derived from software contributed to Berkeley by
41 * Adam de Boor.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the University of
54 * California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 */
71
72 #ifndef MAKE_NATIVE
73 static char rcsid[] = "$NetBSD: cond.c,v 1.129 2020/09/11 07:09:40 rillig Exp $";
74 #else
75 #include <sys/cdefs.h>
76 #ifndef lint
77 #if 0
78 static char sccsid[] = "@(#)cond.c 8.2 (Berkeley) 1/2/94";
79 #else
80 __RCSID("$NetBSD: cond.c,v 1.129 2020/09/11 07:09:40 rillig Exp $");
81 #endif
82 #endif /* not lint */
83 #endif
84
85 /* Handling of conditionals in a makefile.
86 *
87 * Interface:
88 * Cond_Eval Evaluate the conditional in the passed line.
89 *
90 * Cond_EvalExpression
91 * Evaluate the conditional in the passed line, which
92 * is either the argument of one of the .if directives
93 * or the condition in a :?true:false variable modifier.
94 *
95 * Cond_save_depth
96 * Cond_restore_depth
97 * Save and restore the nesting of the conditions, at
98 * the start and end of including another makefile, to
99 * ensure that in each makefile the conditional
100 * directives are well-balanced.
101 */
102
103 #include <errno.h>
104
105 #include "make.h"
106 #include "dir.h"
107
108 /*
109 * The parsing of conditional expressions is based on this grammar:
110 * E -> F || E
111 * E -> F
112 * F -> T && F
113 * F -> T
114 * T -> defined(variable)
115 * T -> make(target)
116 * T -> exists(file)
117 * T -> empty(varspec)
118 * T -> target(name)
119 * T -> commands(name)
120 * T -> symbol
121 * T -> $(varspec) op value
122 * T -> $(varspec) == "string"
123 * T -> $(varspec) != "string"
124 * T -> "string"
125 * T -> ( E )
126 * T -> ! T
127 * op -> == | != | > | < | >= | <=
128 *
129 * 'symbol' is some other symbol to which the default function is applied.
130 *
131 * The tokens are scanned by CondToken, which returns:
132 * TOK_AND for '&' or '&&'
133 * TOK_OR for '|' or '||'
134 * TOK_NOT for '!'
135 * TOK_LPAREN for '('
136 * TOK_RPAREN for ')'
137 * Other terminal symbols are evaluated using either the default function or
138 * the function given in the terminal, they return either TOK_TRUE or
139 * TOK_FALSE.
140 *
141 * TOK_FALSE is 0 and TOK_TRUE 1 so we can directly assign C comparisons.
142 *
143 * All non-terminal functions (CondParser_Expr, CondParser_Factor and
144 * CondParser_Term) return either TOK_FALSE, TOK_TRUE, or TOK_ERROR on error.
145 */
146 typedef enum {
147 TOK_FALSE = 0, TOK_TRUE = 1, TOK_AND, TOK_OR, TOK_NOT,
148 TOK_LPAREN, TOK_RPAREN, TOK_EOF, TOK_NONE, TOK_ERROR
149 } Token;
150
151 typedef struct {
152 const struct If *if_info; /* Info for current statement */
153 const char *p; /* The remaining condition to parse */
154 Token curr; /* Single push-back token used in parsing */
155 } CondParser;
156
157 static Token CondParser_Expr(CondParser *par, Boolean);
158 static CondEvalResult CondParser_Eval(CondParser *par, Boolean *value);
159
160 static unsigned int cond_depth = 0; /* current .if nesting level */
161 static unsigned int cond_min_depth = 0; /* depth at makefile open */
162
163 /*
164 * Indicate when we should be strict about lhs of comparisons.
165 * In strict mode, the lhs must be a variable expression or a string literal
166 * in quotes. In non-strict mode it may also be an unquoted string literal.
167 *
168 * TRUE when Cond_EvalExpression is called from Cond_Eval (.if etc)
169 * FALSE when Cond_EvalExpression is called from var.c:ApplyModifiers
170 * since lhs is already expanded and we cannot tell if
171 * it was a variable reference or not.
172 */
173 static Boolean lhsStrict;
174
175 static int
176 is_token(const char *str, const char *tok, size_t len)
177 {
178 return strncmp(str, tok, len) == 0 && !isalpha((unsigned char)str[len]);
179 }
180
181 /* Push back the most recent token read. We only need one level of this. */
182 static void
183 CondParser_PushBack(CondParser *par, Token t)
184 {
185 assert(par->curr == TOK_NONE);
186 assert(t != TOK_NONE);
187
188 par->curr = t;
189 }
190
191 static void
192 CondParser_SkipWhitespace(CondParser *par)
193 {
194 while (isspace((unsigned char)par->p[0]))
195 par->p++;
196 }
197
198 /* Parse the argument of a built-in function.
199 *
200 * Arguments:
201 * *linePtr initially points at the '(', upon successful return points
202 * right after the ')'.
203 *
204 * *out_arg receives the argument as string.
205 *
206 * func says whether the argument belongs to an actual function, or
207 * whether the parsed argument is passed to the default function.
208 *
209 * Return the length of the argument. */
210 static int
211 ParseFuncArg(const char **linePtr, Boolean doEval, const char *func,
212 char **out_arg) {
213 const char *cp;
214 Buffer buf;
215 int paren_depth;
216 char ch;
217 size_t argLen;
218
219 cp = *linePtr;
220 if (func != NULL)
221 /* Skip opening '(' - verified by caller */
222 cp++;
223
224 if (*cp == '\0') {
225 /*
226 * No arguments whatsoever. Because 'make' and 'defined' aren't really
227 * "reserved words", we don't print a message. I think this is better
228 * than hitting the user with a warning message every time s/he uses
229 * the word 'make' or 'defined' at the beginning of a symbol...
230 */
231 *out_arg = NULL;
232 return 0;
233 }
234
235 while (*cp == ' ' || *cp == '\t') {
236 cp++;
237 }
238
239 /*
240 * Create a buffer for the argument and start it out at 16 characters
241 * long. Why 16? Why not?
242 */
243 Buf_Init(&buf, 16);
244
245 paren_depth = 0;
246 for (;;) {
247 ch = *cp;
248 if (ch == 0 || ch == ' ' || ch == '\t')
249 break;
250 if ((ch == '&' || ch == '|') && paren_depth == 0)
251 break;
252 if (*cp == '$') {
253 /*
254 * Parse the variable spec and install it as part of the argument
255 * if it's valid. We tell Var_Parse to complain on an undefined
256 * variable, so we don't need to do it. Nor do we return an error,
257 * though perhaps we should...
258 */
259 void *freeIt;
260 VarEvalFlags eflags = VARE_UNDEFERR | (doEval ? VARE_WANTRES : 0);
261 const char *cp2 = Var_ParsePP(&cp, VAR_CMD, eflags, &freeIt);
262 Buf_AddStr(&buf, cp2);
263 free(freeIt);
264 continue;
265 }
266 if (ch == '(')
267 paren_depth++;
268 else if (ch == ')' && --paren_depth < 0)
269 break;
270 Buf_AddByte(&buf, *cp);
271 cp++;
272 }
273
274 *out_arg = Buf_GetAll(&buf, &argLen);
275 Buf_Destroy(&buf, FALSE);
276
277 while (*cp == ' ' || *cp == '\t') {
278 cp++;
279 }
280
281 if (func != NULL && *cp++ != ')') {
282 Parse_Error(PARSE_WARNING, "Missing closing parenthesis for %s()",
283 func);
284 return 0;
285 }
286
287 *linePtr = cp;
288 return argLen;
289 }
290
291 /* Test whether the given variable is defined. */
292 static Boolean
293 FuncDefined(int argLen MAKE_ATTR_UNUSED, const char *arg)
294 {
295 char *freeIt;
296 Boolean result = Var_Value(arg, VAR_CMD, &freeIt) != NULL;
297 bmake_free(freeIt);
298 return result;
299 }
300
301 /* Wrapper around Str_Match, to be used by Lst_Find. */
302 static Boolean
303 CondFindStrMatch(const void *string, const void *pattern)
304 {
305 return Str_Match(string, pattern);
306 }
307
308 /* See if the given target is being made. */
309 static Boolean
310 FuncMake(int argLen MAKE_ATTR_UNUSED, const char *arg)
311 {
312 return Lst_Find(create, CondFindStrMatch, arg) != NULL;
313 }
314
315 /* See if the given file exists. */
316 static Boolean
317 FuncExists(int argLen MAKE_ATTR_UNUSED, const char *arg)
318 {
319 Boolean result;
320 char *path;
321
322 path = Dir_FindFile(arg, dirSearchPath);
323 if (DEBUG(COND)) {
324 fprintf(debug_file, "exists(%s) result is \"%s\"\n",
325 arg, path ? path : "");
326 }
327 if (path != NULL) {
328 result = TRUE;
329 free(path);
330 } else {
331 result = FALSE;
332 }
333 return result;
334 }
335
336 /* See if the given node exists and is an actual target. */
337 static Boolean
338 FuncTarget(int argLen MAKE_ATTR_UNUSED, const char *arg)
339 {
340 GNode *gn;
341
342 gn = Targ_FindNode(arg, TARG_NOCREATE);
343 return gn != NULL && !OP_NOP(gn->type);
344 }
345
346 /* See if the given node exists and is an actual target with commands
347 * associated with it. */
348 static Boolean
349 FuncCommands(int argLen MAKE_ATTR_UNUSED, const char *arg)
350 {
351 GNode *gn;
352
353 gn = Targ_FindNode(arg, TARG_NOCREATE);
354 return gn != NULL && !OP_NOP(gn->type) && !Lst_IsEmpty(gn->commands);
355 }
356
357 /*-
358 * Convert the given number into a double.
359 * We try a base 10 or 16 integer conversion first, if that fails
360 * then we try a floating point conversion instead.
361 *
362 * Results:
363 * Sets 'value' to double value of string.
364 * Returns TRUE if the conversion succeeded.
365 */
366 static Boolean
367 TryParseNumber(const char *str, double *value)
368 {
369 char *eptr, ech;
370 unsigned long l_val;
371 double d_val;
372
373 errno = 0;
374 if (!*str) {
375 *value = (double)0;
376 return TRUE;
377 }
378 l_val = strtoul(str, &eptr, str[1] == 'x' ? 16 : 10);
379 ech = *eptr;
380 if (ech == 0 && errno != ERANGE) {
381 d_val = str[0] == '-' ? -(double)-l_val : (double)l_val;
382 } else {
383 if (ech != 0 && ech != '.' && ech != 'e' && ech != 'E')
384 return FALSE;
385 d_val = strtod(str, &eptr);
386 if (*eptr)
387 return FALSE;
388 }
389
390 *value = d_val;
391 return TRUE;
392 }
393
394 /*-
395 * Parse a string from a variable reference or an optionally quoted
396 * string. This is called for the lhs and rhs of string comparisons.
397 *
398 * Results:
399 * Returns the string, absent any quotes, or NULL on error.
400 * Sets quoted if the string was quoted.
401 * Sets freeIt if needed.
402 */
403 /* coverity:[+alloc : arg-*3] */
404 static const char *
405 CondParser_String(CondParser *par, Boolean doEval, Boolean strictLHS,
406 Boolean *quoted, void **freeIt)
407 {
408 Buffer buf;
409 const char *str;
410 int len;
411 Boolean qt;
412 const char *start;
413 VarEvalFlags eflags;
414
415 Buf_Init(&buf, 0);
416 str = NULL;
417 *freeIt = NULL;
418 *quoted = qt = par->p[0] == '"' ? 1 : 0;
419 if (qt)
420 par->p++;
421 for (start = par->p; par->p[0] && str == NULL;) {
422 switch (par->p[0]) {
423 case '\\':
424 par->p++;
425 if (par->p[0] != '\0') {
426 Buf_AddByte(&buf, par->p[0]);
427 par->p++;
428 }
429 continue;
430 case '"':
431 if (qt) {
432 par->p++; /* we don't want the quotes */
433 goto got_str;
434 }
435 Buf_AddByte(&buf, par->p[0]); /* likely? */
436 par->p++;
437 continue;
438 case ')':
439 case '!':
440 case '=':
441 case '>':
442 case '<':
443 case ' ':
444 case '\t':
445 if (!qt)
446 goto got_str;
447 Buf_AddByte(&buf, par->p[0]);
448 par->p++;
449 continue;
450 case '$':
451 /* if we are in quotes, then an undefined variable is ok */
452 eflags = ((!qt && doEval) ? VARE_UNDEFERR : 0) |
453 (doEval ? VARE_WANTRES : 0);
454 str = Var_Parse(par->p, VAR_CMD, eflags, &len, freeIt);
455 if (str == var_Error) {
456 if (*freeIt) {
457 free(*freeIt);
458 *freeIt = NULL;
459 }
460 /*
461 * Even if !doEval, we still report syntax errors, which
462 * is what getting var_Error back with !doEval means.
463 */
464 str = NULL;
465 goto cleanup;
466 }
467 par->p += len;
468 /*
469 * If the '$' was first char (no quotes), and we are
470 * followed by space, the operator or end of expression,
471 * we are done.
472 */
473 if ((par->p == start + len) &&
474 (par->p[0] == '\0' ||
475 isspace((unsigned char)par->p[0]) ||
476 strchr("!=><)", par->p[0]))) {
477 goto cleanup;
478 }
479
480 Buf_AddStr(&buf, str);
481 if (*freeIt) {
482 free(*freeIt);
483 *freeIt = NULL;
484 }
485 str = NULL; /* not finished yet */
486 continue;
487 default:
488 if (strictLHS && !qt && *start != '$' &&
489 !isdigit((unsigned char)*start)) {
490 /* lhs must be quoted, a variable reference or number */
491 if (*freeIt) {
492 free(*freeIt);
493 *freeIt = NULL;
494 }
495 str = NULL;
496 goto cleanup;
497 }
498 Buf_AddByte(&buf, par->p[0]);
499 par->p++;
500 continue;
501 }
502 }
503 got_str:
504 *freeIt = Buf_GetAll(&buf, NULL);
505 str = *freeIt;
506 cleanup:
507 Buf_Destroy(&buf, FALSE);
508 return str;
509 }
510
511 /* The different forms of .if directives. */
512 static const struct If {
513 const char *form; /* Form of if */
514 size_t formlen; /* Length of form */
515 Boolean doNot; /* TRUE if default function should be negated */
516 Boolean (*defProc)(int, const char *); /* Default function to apply */
517 } ifs[] = {
518 { "def", 3, FALSE, FuncDefined },
519 { "ndef", 4, TRUE, FuncDefined },
520 { "make", 4, FALSE, FuncMake },
521 { "nmake", 5, TRUE, FuncMake },
522 { "", 0, FALSE, FuncDefined },
523 { NULL, 0, FALSE, NULL }
524 };
525
526 /* Parse a comparison condition such as:
527 *
528 * 0
529 * ${VAR:Mpattern}
530 * ${VAR} == value
531 * ${VAR:U0} < 12345
532 */
533 static Token
534 CondParser_Comparison(CondParser *par, Boolean doEval)
535 {
536 Token t;
537 const char *lhs;
538 const char *rhs;
539 const char *op;
540 void *lhsFree;
541 void *rhsFree;
542 Boolean lhsQuoted;
543 Boolean rhsQuoted;
544 double left, right;
545
546 t = TOK_ERROR;
547 rhs = NULL;
548 lhsFree = rhsFree = NULL;
549 lhsQuoted = rhsQuoted = FALSE;
550
551 /*
552 * Parse the variable spec and skip over it, saving its
553 * value in lhs.
554 */
555 lhs = CondParser_String(par, doEval, lhsStrict, &lhsQuoted, &lhsFree);
556 if (!lhs)
557 goto done;
558
559 CondParser_SkipWhitespace(par);
560
561 /*
562 * Make sure the operator is a valid one. If it isn't a
563 * known relational operator, pretend we got a
564 * != 0 comparison.
565 */
566 op = par->p;
567 switch (par->p[0]) {
568 case '!':
569 case '=':
570 case '<':
571 case '>':
572 if (par->p[1] == '=') {
573 par->p += 2;
574 } else {
575 par->p += 1;
576 }
577 break;
578 default:
579 if (!doEval) {
580 t = TOK_FALSE;
581 goto done;
582 }
583 /* For .ifxxx "..." check for non-empty string. */
584 if (lhsQuoted) {
585 t = lhs[0] != '\0';
586 goto done;
587 }
588 /* For .ifxxx <number> compare against zero */
589 if (TryParseNumber(lhs, &left)) {
590 t = left != 0.0;
591 goto done;
592 }
593 /* For .if ${...} check for non-empty string (defProc is ifdef). */
594 if (par->if_info->form[0] == '\0') {
595 t = lhs[0] != 0;
596 goto done;
597 }
598 /* Otherwise action default test ... */
599 t = par->if_info->defProc(strlen(lhs), lhs) != par->if_info->doNot;
600 goto done;
601 }
602
603 CondParser_SkipWhitespace(par);
604
605 if (par->p[0] == '\0') {
606 Parse_Error(PARSE_WARNING,
607 "Missing right-hand-side of operator");
608 goto done;
609 }
610
611 rhs = CondParser_String(par, doEval, FALSE, &rhsQuoted, &rhsFree);
612 if (!rhs)
613 goto done;
614
615 if (!doEval) {
616 t = TOK_FALSE;
617 goto done;
618 }
619
620 if (rhsQuoted || lhsQuoted) {
621 do_string_compare:
622 if (((*op != '!') && (*op != '=')) || (op[1] != '=')) {
623 Parse_Error(PARSE_WARNING,
624 "String comparison operator should be either == or !=");
625 goto done;
626 }
627
628 if (DEBUG(COND)) {
629 fprintf(debug_file, "lhs = \"%s\", rhs = \"%s\", op = %.2s\n",
630 lhs, rhs, op);
631 }
632 /*
633 * Null-terminate rhs and perform the comparison.
634 * t is set to the result.
635 */
636 if (*op == '=') {
637 t = strcmp(lhs, rhs) == 0;
638 } else {
639 t = strcmp(lhs, rhs) != 0;
640 }
641 } else {
642 /*
643 * rhs is either a float or an integer. Convert both the
644 * lhs and the rhs to a double and compare the two.
645 */
646
647 if (!TryParseNumber(lhs, &left) || !TryParseNumber(rhs, &right))
648 goto do_string_compare;
649
650 if (DEBUG(COND)) {
651 fprintf(debug_file, "left = %f, right = %f, op = %.2s\n", left,
652 right, op);
653 }
654 switch (op[0]) {
655 case '!':
656 if (op[1] != '=') {
657 Parse_Error(PARSE_WARNING,
658 "Unknown operator");
659 goto done;
660 }
661 t = (left != right);
662 break;
663 case '=':
664 if (op[1] != '=') {
665 Parse_Error(PARSE_WARNING,
666 "Unknown operator");
667 goto done;
668 }
669 t = (left == right);
670 break;
671 case '<':
672 if (op[1] == '=') {
673 t = (left <= right);
674 } else {
675 t = (left < right);
676 }
677 break;
678 case '>':
679 if (op[1] == '=') {
680 t = (left >= right);
681 } else {
682 t = (left > right);
683 }
684 break;
685 }
686 }
687
688 done:
689 free(lhsFree);
690 free(rhsFree);
691 return t;
692 }
693
694 static int
695 ParseEmptyArg(const char **linePtr, Boolean doEval,
696 const char *func MAKE_ATTR_UNUSED, char **argPtr)
697 {
698 void *val_freeIt;
699 const char *val;
700 int magic_res;
701
702 /* We do all the work here and return the result as the length */
703 *argPtr = NULL;
704
705 (*linePtr)--; /* Make (*linePtr)[1] point to the '('. */
706 val = Var_ParsePP(linePtr, VAR_CMD, doEval ? VARE_WANTRES : 0, &val_freeIt);
707 /* If successful, *linePtr points beyond the closing ')' now. */
708
709 if (val == var_Error) {
710 free(val_freeIt);
711 return -1;
712 }
713
714 /* A variable is empty when it just contains spaces... 4/15/92, christos */
715 while (isspace((unsigned char)val[0]))
716 val++;
717
718 /*
719 * For consistency with the other functions we can't generate the
720 * true/false here.
721 */
722 magic_res = *val != '\0' ? 2 : 1;
723 free(val_freeIt);
724 return magic_res;
725 }
726
727 static Boolean
728 FuncEmpty(int arglen, const char *arg MAKE_ATTR_UNUSED)
729 {
730 /* Magic values ahead, see ParseEmptyArg. */
731 return arglen == 1;
732 }
733
734 static Token
735 CondParser_Func(CondParser *par, Boolean doEval)
736 {
737 static const struct fn_def {
738 const char *fn_name;
739 size_t fn_name_len;
740 int (*fn_parse)(const char **, Boolean, const char *, char **);
741 Boolean (*fn_eval)(int, const char *);
742 } fn_defs[] = {
743 { "defined", 7, ParseFuncArg, FuncDefined },
744 { "make", 4, ParseFuncArg, FuncMake },
745 { "exists", 6, ParseFuncArg, FuncExists },
746 { "empty", 5, ParseEmptyArg, FuncEmpty },
747 { "target", 6, ParseFuncArg, FuncTarget },
748 { "commands", 8, ParseFuncArg, FuncCommands },
749 { NULL, 0, NULL, NULL },
750 };
751 const struct fn_def *fn_def;
752 Token t;
753 char *arg = NULL;
754 int arglen;
755 const char *cp = par->p;
756 const char *cp1;
757
758 for (fn_def = fn_defs; fn_def->fn_name != NULL; fn_def++) {
759 if (!is_token(cp, fn_def->fn_name, fn_def->fn_name_len))
760 continue;
761 cp += fn_def->fn_name_len;
762 /* There can only be whitespace before the '(' */
763 while (isspace((unsigned char)*cp))
764 cp++;
765 if (*cp != '(')
766 break;
767
768 arglen = fn_def->fn_parse(&cp, doEval, fn_def->fn_name, &arg);
769 if (arglen <= 0) {
770 par->p = cp;
771 return arglen < 0 ? TOK_ERROR : TOK_FALSE;
772 }
773 /* Evaluate the argument using the required function. */
774 t = !doEval || fn_def->fn_eval(arglen, arg);
775 free(arg);
776 par->p = cp;
777 return t;
778 }
779
780 /* Push anything numeric through the compare expression */
781 cp = par->p;
782 if (isdigit((unsigned char)cp[0]) || strchr("+-", cp[0]))
783 return CondParser_Comparison(par, doEval);
784
785 /*
786 * Most likely we have a naked token to apply the default function to.
787 * However ".if a == b" gets here when the "a" is unquoted and doesn't
788 * start with a '$'. This surprises people.
789 * If what follows the function argument is a '=' or '!' then the syntax
790 * would be invalid if we did "defined(a)" - so instead treat as an
791 * expression.
792 */
793 arglen = ParseFuncArg(&cp, doEval, NULL, &arg);
794 for (cp1 = cp; isspace((unsigned char)*cp1); cp1++)
795 continue;
796 if (*cp1 == '=' || *cp1 == '!')
797 return CondParser_Comparison(par, doEval);
798 par->p = cp;
799
800 /*
801 * Evaluate the argument using the default function.
802 * This path always treats .if as .ifdef. To get here, the character
803 * after .if must have been taken literally, so the argument cannot
804 * be empty - even if it contained a variable expansion.
805 */
806 t = !doEval || par->if_info->defProc(arglen, arg) != par->if_info->doNot;
807 free(arg);
808 return t;
809 }
810
811 /* Return the next token or comparison result from the parser. */
812 static Token
813 CondParser_Token(CondParser *par, Boolean doEval)
814 {
815 Token t;
816
817 t = par->curr;
818 if (t != TOK_NONE) {
819 par->curr = TOK_NONE;
820 return t;
821 }
822
823 while (par->p[0] == ' ' || par->p[0] == '\t') {
824 par->p++;
825 }
826
827 switch (par->p[0]) {
828
829 case '(':
830 par->p++;
831 return TOK_LPAREN;
832
833 case ')':
834 par->p++;
835 return TOK_RPAREN;
836
837 case '|':
838 par->p++;
839 if (par->p[0] == '|') {
840 par->p++;
841 }
842 return TOK_OR;
843
844 case '&':
845 par->p++;
846 if (par->p[0] == '&') {
847 par->p++;
848 }
849 return TOK_AND;
850
851 case '!':
852 par->p++;
853 return TOK_NOT;
854
855 case '#':
856 case '\n':
857 case '\0':
858 return TOK_EOF;
859
860 case '"':
861 case '$':
862 return CondParser_Comparison(par, doEval);
863
864 default:
865 return CondParser_Func(par, doEval);
866 }
867 }
868
869 /* Parse a single term in the expression. This consists of a terminal symbol
870 * or TOK_NOT and a term (not including the binary operators):
871 *
872 * T -> defined(variable) | make(target) | exists(file) | symbol
873 * T -> ! T | ( E )
874 *
875 * Results:
876 * TOK_TRUE, TOK_FALSE or TOK_ERROR.
877 */
878 static Token
879 CondParser_Term(CondParser *par, Boolean doEval)
880 {
881 Token t;
882
883 t = CondParser_Token(par, doEval);
884
885 if (t == TOK_EOF) {
886 /*
887 * If we reached the end of the expression, the expression
888 * is malformed...
889 */
890 t = TOK_ERROR;
891 } else if (t == TOK_LPAREN) {
892 /*
893 * T -> ( E )
894 */
895 t = CondParser_Expr(par, doEval);
896 if (t != TOK_ERROR) {
897 if (CondParser_Token(par, doEval) != TOK_RPAREN) {
898 t = TOK_ERROR;
899 }
900 }
901 } else if (t == TOK_NOT) {
902 t = CondParser_Term(par, doEval);
903 if (t == TOK_TRUE) {
904 t = TOK_FALSE;
905 } else if (t == TOK_FALSE) {
906 t = TOK_TRUE;
907 }
908 }
909 return t;
910 }
911
912 /* Parse a conjunctive factor (nice name, wot?)
913 *
914 * F -> T && F | T
915 *
916 * Results:
917 * TOK_TRUE, TOK_FALSE or TOK_ERROR
918 */
919 static Token
920 CondParser_Factor(CondParser *par, Boolean doEval)
921 {
922 Token l, o;
923
924 l = CondParser_Term(par, doEval);
925 if (l != TOK_ERROR) {
926 o = CondParser_Token(par, doEval);
927
928 if (o == TOK_AND) {
929 /*
930 * F -> T && F
931 *
932 * If T is TOK_FALSE, the whole thing will be TOK_FALSE, but we
933 * have to parse the r.h.s. anyway (to throw it away).
934 * If T is TOK_TRUE, the result is the r.h.s., be it a TOK_ERROR
935 * or not.
936 */
937 if (l == TOK_TRUE) {
938 l = CondParser_Factor(par, doEval);
939 } else {
940 (void)CondParser_Factor(par, FALSE);
941 }
942 } else {
943 /*
944 * F -> T
945 */
946 CondParser_PushBack(par, o);
947 }
948 }
949 return l;
950 }
951
952 /* Main expression production.
953 *
954 * E -> F || E | F
955 *
956 * Results:
957 * TOK_TRUE, TOK_FALSE or TOK_ERROR.
958 */
959 static Token
960 CondParser_Expr(CondParser *par, Boolean doEval)
961 {
962 Token l, o;
963
964 l = CondParser_Factor(par, doEval);
965 if (l != TOK_ERROR) {
966 o = CondParser_Token(par, doEval);
967
968 if (o == TOK_OR) {
969 /*
970 * E -> F || E
971 *
972 * A similar thing occurs for ||, except that here we make sure
973 * the l.h.s. is TOK_FALSE before we bother to evaluate the r.h.s.
974 * Once again, if l is TOK_FALSE, the result is the r.h.s. and once
975 * again if l is TOK_TRUE, we parse the r.h.s. to throw it away.
976 */
977 if (l == TOK_FALSE) {
978 l = CondParser_Expr(par, doEval);
979 } else {
980 (void)CondParser_Expr(par, FALSE);
981 }
982 } else {
983 /*
984 * E -> F
985 */
986 CondParser_PushBack(par, o);
987 }
988 }
989 return l;
990 }
991
992 static CondEvalResult
993 CondParser_Eval(CondParser *par, Boolean *value)
994 {
995 Token res;
996
997 if (DEBUG(COND))
998 fprintf(debug_file, "CondParser_Eval: %s\n", par->p);
999
1000 res = CondParser_Expr(par, TRUE);
1001 if (res != TOK_FALSE && res != TOK_TRUE)
1002 return COND_INVALID;
1003
1004 if (CondParser_Token(par, TRUE /* XXX: Why TRUE? */) != TOK_EOF)
1005 return COND_INVALID;
1006
1007 *value = res == TOK_TRUE;
1008 return COND_PARSE;
1009 }
1010
1011 /* Evaluate the condition, including any side effects from the variable
1012 * expressions in the condition. The condition consists of &&, ||, !,
1013 * function(arg), comparisons and parenthetical groupings thereof.
1014 *
1015 * Results:
1016 * COND_PARSE if the condition was valid grammatically
1017 * COND_INVALID if not a valid conditional.
1018 *
1019 * (*value) is set to the boolean value of the condition
1020 */
1021 CondEvalResult
1022 Cond_EvalExpression(const struct If *info, const char *cond, Boolean *value,
1023 int eprint, Boolean strictLHS)
1024 {
1025 static const struct If *dflt_info;
1026 CondParser par;
1027 int rval;
1028
1029 lhsStrict = strictLHS;
1030
1031 while (*cond == ' ' || *cond == '\t')
1032 cond++;
1033
1034 if (info == NULL && (info = dflt_info) == NULL) {
1035 /* Scan for the entry for .if - it can't be first */
1036 for (info = ifs;; info++)
1037 if (info->form[0] == 0)
1038 break;
1039 dflt_info = info;
1040 }
1041 assert(info != NULL);
1042
1043 par.if_info = info;
1044 par.p = cond;
1045 par.curr = TOK_NONE;
1046
1047 rval = CondParser_Eval(&par, value);
1048
1049 if (rval == COND_INVALID && eprint)
1050 Parse_Error(PARSE_FATAL, "Malformed conditional (%s)", cond);
1051
1052 return rval;
1053 }
1054
1055
1056 /* Evaluate the conditional in the passed line. The line looks like this:
1057 * .<cond-type> <expr>
1058 * In this line, <cond-type> is any of if, ifmake, ifnmake, ifdef, ifndef,
1059 * elif, elifmake, elifnmake, elifdef, elifndef.
1060 * In this line, <expr> consists of &&, ||, !, function(arg), comparisons
1061 * and parenthetical groupings thereof.
1062 *
1063 * Note that the states IF_ACTIVE and ELSE_ACTIVE are only different in order
1064 * to detect spurious .else lines (as are SKIP_TO_ELSE and SKIP_TO_ENDIF),
1065 * otherwise .else could be treated as '.elif 1'.
1066 *
1067 * Results:
1068 * COND_PARSE to continue parsing the lines after the conditional
1069 * (when .if or .else returns TRUE)
1070 * COND_SKIP to skip the lines after the conditional
1071 * (when .if or .elif returns FALSE, or when a previous
1072 * branch has already been taken)
1073 * COND_INVALID if the conditional was not valid, either because of
1074 * a syntax error or because some variable was undefined
1075 * or because the condition could not be evaluated
1076 */
1077 CondEvalResult
1078 Cond_Eval(const char *line)
1079 {
1080 enum { MAXIF = 128 }; /* maximum depth of .if'ing */
1081 enum { MAXIF_BUMP = 32 }; /* how much to grow by */
1082 enum if_states {
1083 IF_ACTIVE, /* .if or .elif part active */
1084 ELSE_ACTIVE, /* .else part active */
1085 SEARCH_FOR_ELIF, /* searching for .elif/else to execute */
1086 SKIP_TO_ELSE, /* has been true, but not seen '.else' */
1087 SKIP_TO_ENDIF /* nothing else to execute */
1088 };
1089 static enum if_states *cond_state = NULL;
1090 static unsigned int max_if_depth = MAXIF;
1091
1092 const struct If *ifp;
1093 Boolean isElif;
1094 Boolean value;
1095 int level; /* Level at which to report errors. */
1096 enum if_states state;
1097
1098 level = PARSE_FATAL;
1099 if (!cond_state) {
1100 cond_state = bmake_malloc(max_if_depth * sizeof(*cond_state));
1101 cond_state[0] = IF_ACTIVE;
1102 }
1103 /* skip leading character (the '.') and any whitespace */
1104 for (line++; *line == ' ' || *line == '\t'; line++)
1105 continue;
1106
1107 /* Find what type of if we're dealing with. */
1108 if (line[0] == 'e') {
1109 if (line[1] != 'l') {
1110 if (!is_token(line + 1, "ndif", 4))
1111 return COND_INVALID;
1112 /* End of conditional section */
1113 if (cond_depth == cond_min_depth) {
1114 Parse_Error(level, "if-less endif");
1115 return COND_PARSE;
1116 }
1117 /* Return state for previous conditional */
1118 cond_depth--;
1119 return cond_state[cond_depth] <= ELSE_ACTIVE
1120 ? COND_PARSE : COND_SKIP;
1121 }
1122
1123 /* Quite likely this is 'else' or 'elif' */
1124 line += 2;
1125 if (is_token(line, "se", 2)) {
1126 /* It is else... */
1127 if (cond_depth == cond_min_depth) {
1128 Parse_Error(level, "if-less else");
1129 return COND_PARSE;
1130 }
1131
1132 state = cond_state[cond_depth];
1133 switch (state) {
1134 case SEARCH_FOR_ELIF:
1135 state = ELSE_ACTIVE;
1136 break;
1137 case ELSE_ACTIVE:
1138 case SKIP_TO_ENDIF:
1139 Parse_Error(PARSE_WARNING, "extra else");
1140 /* FALLTHROUGH */
1141 default:
1142 case IF_ACTIVE:
1143 case SKIP_TO_ELSE:
1144 state = SKIP_TO_ENDIF;
1145 break;
1146 }
1147 cond_state[cond_depth] = state;
1148 return state <= ELSE_ACTIVE ? COND_PARSE : COND_SKIP;
1149 }
1150 /* Assume for now it is an elif */
1151 isElif = TRUE;
1152 } else
1153 isElif = FALSE;
1154
1155 if (line[0] != 'i' || line[1] != 'f')
1156 /* Not an ifxxx or elifxxx line */
1157 return COND_INVALID;
1158
1159 /*
1160 * Figure out what sort of conditional it is -- what its default
1161 * function is, etc. -- by looking in the table of valid "ifs"
1162 */
1163 line += 2;
1164 for (ifp = ifs;; ifp++) {
1165 if (ifp->form == NULL)
1166 return COND_INVALID;
1167 if (is_token(ifp->form, line, ifp->formlen)) {
1168 line += ifp->formlen;
1169 break;
1170 }
1171 }
1172
1173 /* Now we know what sort of 'if' it is... */
1174
1175 if (isElif) {
1176 if (cond_depth == cond_min_depth) {
1177 Parse_Error(level, "if-less elif");
1178 return COND_PARSE;
1179 }
1180 state = cond_state[cond_depth];
1181 if (state == SKIP_TO_ENDIF || state == ELSE_ACTIVE) {
1182 Parse_Error(PARSE_WARNING, "extra elif");
1183 cond_state[cond_depth] = SKIP_TO_ENDIF;
1184 return COND_SKIP;
1185 }
1186 if (state != SEARCH_FOR_ELIF) {
1187 /* Either just finished the 'true' block, or already SKIP_TO_ELSE */
1188 cond_state[cond_depth] = SKIP_TO_ELSE;
1189 return COND_SKIP;
1190 }
1191 } else {
1192 /* Normal .if */
1193 if (cond_depth + 1 >= max_if_depth) {
1194 /*
1195 * This is rare, but not impossible.
1196 * In meta mode, dirdeps.mk (only runs at level 0)
1197 * can need more than the default.
1198 */
1199 max_if_depth += MAXIF_BUMP;
1200 cond_state = bmake_realloc(cond_state,
1201 max_if_depth * sizeof(*cond_state));
1202 }
1203 state = cond_state[cond_depth];
1204 cond_depth++;
1205 if (state > ELSE_ACTIVE) {
1206 /* If we aren't parsing the data, treat as always false */
1207 cond_state[cond_depth] = SKIP_TO_ELSE;
1208 return COND_SKIP;
1209 }
1210 }
1211
1212 /* And evaluate the conditional expression */
1213 if (Cond_EvalExpression(ifp, line, &value, 1, TRUE) == COND_INVALID) {
1214 /* Syntax error in conditional, error message already output. */
1215 /* Skip everything to matching .endif */
1216 cond_state[cond_depth] = SKIP_TO_ELSE;
1217 return COND_SKIP;
1218 }
1219
1220 if (!value) {
1221 cond_state[cond_depth] = SEARCH_FOR_ELIF;
1222 return COND_SKIP;
1223 }
1224 cond_state[cond_depth] = IF_ACTIVE;
1225 return COND_PARSE;
1226 }
1227
1228 void
1229 Cond_restore_depth(unsigned int saved_depth)
1230 {
1231 int open_conds = cond_depth - cond_min_depth;
1232
1233 if (open_conds != 0 || saved_depth > cond_depth) {
1234 Parse_Error(PARSE_FATAL, "%d open conditional%s", open_conds,
1235 open_conds == 1 ? "" : "s");
1236 cond_depth = cond_min_depth;
1237 }
1238
1239 cond_min_depth = saved_depth;
1240 }
1241
1242 unsigned int
1243 Cond_save_depth(void)
1244 {
1245 int depth = cond_min_depth;
1246
1247 cond_min_depth = cond_depth;
1248 return depth;
1249 }
1250