cond.c revision 1.123 1 /* $NetBSD: cond.c,v 1.123 2020/09/11 04:22:22 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.123 2020/09/11 04:22:22 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.123 2020/09/11 04:22:22 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 (CondE, CondF and CondT) return either
144 * 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 CondE(CondParser *par, Boolean);
158 static CondEvalResult do_Cond_EvalExpression(CondParser *par, Boolean *);
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 istoken(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 to the '(', upon successful return points
202 * beyond 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(Boolean doEval, const char **linePtr, char **out_arg,
212 const char *func) {
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 CondDoDefined(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 CondDoMake(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 CondDoExists(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 CondDoTarget(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 CondDoCommands(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 CondCvtArg(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 compares.
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 CondGetString(CondParser *par, Boolean doEval, Boolean *quoted, void **freeIt,
406 Boolean strictLHS)
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, CondDoDefined },
519 { "ndef", 4, TRUE, CondDoDefined },
520 { "make", 4, FALSE, CondDoMake },
521 { "nmake", 5, TRUE, CondDoMake },
522 { "", 0, FALSE, CondDoDefined },
523 { NULL, 0, FALSE, NULL }
524 };
525
526 static Token
527 compare_expression(CondParser *par, Boolean doEval)
528 {
529 Token t;
530 const char *lhs;
531 const char *rhs;
532 const char *op;
533 void *lhsFree;
534 void *rhsFree;
535 Boolean lhsQuoted;
536 Boolean rhsQuoted;
537 double left, right;
538
539 t = TOK_ERROR;
540 rhs = NULL;
541 lhsFree = rhsFree = NULL;
542 lhsQuoted = rhsQuoted = FALSE;
543
544 /*
545 * Parse the variable spec and skip over it, saving its
546 * value in lhs.
547 */
548 lhs = CondGetString(par, doEval, &lhsQuoted, &lhsFree, lhsStrict);
549 if (!lhs)
550 goto done;
551
552 CondParser_SkipWhitespace(par);
553
554 /*
555 * Make sure the operator is a valid one. If it isn't a
556 * known relational operator, pretend we got a
557 * != 0 comparison.
558 */
559 op = par->p;
560 switch (par->p[0]) {
561 case '!':
562 case '=':
563 case '<':
564 case '>':
565 if (par->p[1] == '=') {
566 par->p += 2;
567 } else {
568 par->p += 1;
569 }
570 break;
571 default:
572 if (!doEval) {
573 t = TOK_FALSE;
574 goto done;
575 }
576 /* For .ifxxx "..." check for non-empty string. */
577 if (lhsQuoted) {
578 t = lhs[0] != '\0';
579 goto done;
580 }
581 /* For .ifxxx <number> compare against zero */
582 if (CondCvtArg(lhs, &left)) {
583 t = left != 0.0;
584 goto done;
585 }
586 /* For .if ${...} check for non-empty string (defProc is ifdef). */
587 if (par->if_info->form[0] == '\0') {
588 t = lhs[0] != 0;
589 goto done;
590 }
591 /* Otherwise action default test ... */
592 t = par->if_info->defProc(strlen(lhs), lhs) != par->if_info->doNot;
593 goto done;
594 }
595
596 CondParser_SkipWhitespace(par);
597
598 if (par->p[0] == '\0') {
599 Parse_Error(PARSE_WARNING,
600 "Missing right-hand-side of operator");
601 goto done;
602 }
603
604 rhs = CondGetString(par, doEval, &rhsQuoted, &rhsFree, FALSE);
605 if (!rhs)
606 goto done;
607
608 if (!doEval) {
609 t = TOK_FALSE;
610 goto done;
611 }
612
613 if (rhsQuoted || lhsQuoted) {
614 do_string_compare:
615 if (((*op != '!') && (*op != '=')) || (op[1] != '=')) {
616 Parse_Error(PARSE_WARNING,
617 "String comparison operator should be either == or !=");
618 goto done;
619 }
620
621 if (DEBUG(COND)) {
622 fprintf(debug_file, "lhs = \"%s\", rhs = \"%s\", op = %.2s\n",
623 lhs, rhs, op);
624 }
625 /*
626 * Null-terminate rhs and perform the comparison.
627 * t is set to the result.
628 */
629 if (*op == '=') {
630 t = strcmp(lhs, rhs) == 0;
631 } else {
632 t = strcmp(lhs, rhs) != 0;
633 }
634 } else {
635 /*
636 * rhs is either a float or an integer. Convert both the
637 * lhs and the rhs to a double and compare the two.
638 */
639
640 if (!CondCvtArg(lhs, &left) || !CondCvtArg(rhs, &right))
641 goto do_string_compare;
642
643 if (DEBUG(COND)) {
644 fprintf(debug_file, "left = %f, right = %f, op = %.2s\n", left,
645 right, op);
646 }
647 switch (op[0]) {
648 case '!':
649 if (op[1] != '=') {
650 Parse_Error(PARSE_WARNING,
651 "Unknown operator");
652 goto done;
653 }
654 t = (left != right);
655 break;
656 case '=':
657 if (op[1] != '=') {
658 Parse_Error(PARSE_WARNING,
659 "Unknown operator");
660 goto done;
661 }
662 t = (left == right);
663 break;
664 case '<':
665 if (op[1] == '=') {
666 t = (left <= right);
667 } else {
668 t = (left < right);
669 }
670 break;
671 case '>':
672 if (op[1] == '=') {
673 t = (left >= right);
674 } else {
675 t = (left > right);
676 }
677 break;
678 }
679 }
680
681 done:
682 free(lhsFree);
683 free(rhsFree);
684 return t;
685 }
686
687 static int
688 ParseEmptyArg(Boolean doEval, const char **linePtr, char **argPtr,
689 const char *func MAKE_ATTR_UNUSED)
690 {
691 void *val_freeIt;
692 const char *val;
693 int magic_res;
694
695 /* We do all the work here and return the result as the length */
696 *argPtr = NULL;
697
698 (*linePtr)--; /* Make (*linePtr)[1] point to the '('. */
699 val = Var_ParsePP(linePtr, VAR_CMD, doEval ? VARE_WANTRES : 0, &val_freeIt);
700 /* If successful, *linePtr points beyond the closing ')' now. */
701
702 if (val == var_Error) {
703 free(val_freeIt);
704 return -1;
705 }
706
707 /* A variable is empty when it just contains spaces... 4/15/92, christos */
708 while (isspace((unsigned char)val[0]))
709 val++;
710
711 /*
712 * For consistency with the other functions we can't generate the
713 * true/false here.
714 */
715 magic_res = *val != '\0' ? 2 : 1;
716 free(val_freeIt);
717 return magic_res;
718 }
719
720 static Boolean
721 CondDoEmpty(int arglen, const char *arg MAKE_ATTR_UNUSED)
722 {
723 /* Magic values ahead, see ParseEmptyArg. */
724 return arglen == 1;
725 }
726
727 static Token
728 compare_function(CondParser *par, Boolean doEval)
729 {
730 static const struct fn_def {
731 const char *fn_name;
732 size_t fn_name_len;
733 int (*fn_getarg)(Boolean, const char **, char **, const char *);
734 Boolean (*fn_proc)(int, const char *);
735 } fn_defs[] = {
736 { "defined", 7, ParseFuncArg, CondDoDefined },
737 { "make", 4, ParseFuncArg, CondDoMake },
738 { "exists", 6, ParseFuncArg, CondDoExists },
739 { "empty", 5, ParseEmptyArg, CondDoEmpty },
740 { "target", 6, ParseFuncArg, CondDoTarget },
741 { "commands", 8, ParseFuncArg, CondDoCommands },
742 { NULL, 0, NULL, NULL },
743 };
744 const struct fn_def *fn_def;
745 Token t;
746 char *arg = NULL;
747 int arglen;
748 const char *cp = par->p;
749 const char *cp1;
750
751 for (fn_def = fn_defs; fn_def->fn_name != NULL; fn_def++) {
752 if (!istoken(cp, fn_def->fn_name, fn_def->fn_name_len))
753 continue;
754 cp += fn_def->fn_name_len;
755 /* There can only be whitespace before the '(' */
756 while (isspace((unsigned char)*cp))
757 cp++;
758 if (*cp != '(')
759 break;
760
761 arglen = fn_def->fn_getarg(doEval, &cp, &arg, fn_def->fn_name);
762 if (arglen <= 0) {
763 par->p = cp;
764 return arglen < 0 ? TOK_ERROR : TOK_FALSE;
765 }
766 /* Evaluate the argument using the required function. */
767 t = !doEval || fn_def->fn_proc(arglen, arg);
768 free(arg);
769 par->p = cp;
770 return t;
771 }
772
773 /* Push anything numeric through the compare expression */
774 cp = par->p;
775 if (isdigit((unsigned char)cp[0]) || strchr("+-", cp[0]))
776 return compare_expression(par, doEval);
777
778 /*
779 * Most likely we have a naked token to apply the default function to.
780 * However ".if a == b" gets here when the "a" is unquoted and doesn't
781 * start with a '$'. This surprises people.
782 * If what follows the function argument is a '=' or '!' then the syntax
783 * would be invalid if we did "defined(a)" - so instead treat as an
784 * expression.
785 */
786 arglen = ParseFuncArg(doEval, &cp, &arg, NULL);
787 for (cp1 = cp; isspace((unsigned char)*cp1); cp1++)
788 continue;
789 if (*cp1 == '=' || *cp1 == '!')
790 return compare_expression(par, doEval);
791 par->p = cp;
792
793 /*
794 * Evaluate the argument using the default function.
795 * This path always treats .if as .ifdef. To get here, the character
796 * after .if must have been taken literally, so the argument cannot
797 * be empty - even if it contained a variable expansion.
798 */
799 t = !doEval || par->if_info->defProc(arglen, arg) != par->if_info->doNot;
800 free(arg);
801 return t;
802 }
803
804 /* Return the next token or comparison result from the parser. */
805 static Token
806 CondToken(CondParser *par, Boolean doEval)
807 {
808 Token t;
809
810 t = par->curr;
811 if (t != TOK_NONE) {
812 par->curr = TOK_NONE;
813 return t;
814 }
815
816 while (par->p[0] == ' ' || par->p[0] == '\t') {
817 par->p++;
818 }
819
820 switch (par->p[0]) {
821
822 case '(':
823 par->p++;
824 return TOK_LPAREN;
825
826 case ')':
827 par->p++;
828 return TOK_RPAREN;
829
830 case '|':
831 par->p++;
832 if (par->p[0] == '|') {
833 par->p++;
834 }
835 return TOK_OR;
836
837 case '&':
838 par->p++;
839 if (par->p[0] == '&') {
840 par->p++;
841 }
842 return TOK_AND;
843
844 case '!':
845 par->p++;
846 return TOK_NOT;
847
848 case '#':
849 case '\n':
850 case '\0':
851 return TOK_EOF;
852
853 case '"':
854 case '$':
855 return compare_expression(par, doEval);
856
857 default:
858 return compare_function(par, doEval);
859 }
860 }
861
862 /* Parse a single term in the expression. This consists of a terminal symbol
863 * or TOK_NOT and a term (not including the binary operators):
864 *
865 * T -> defined(variable) | make(target) | exists(file) | symbol
866 * T -> ! T | ( E )
867 *
868 * Results:
869 * TOK_TRUE, TOK_FALSE or TOK_ERROR.
870 */
871 static Token
872 CondT(CondParser *par, Boolean doEval)
873 {
874 Token t;
875
876 t = CondToken(par, doEval);
877
878 if (t == TOK_EOF) {
879 /*
880 * If we reached the end of the expression, the expression
881 * is malformed...
882 */
883 t = TOK_ERROR;
884 } else if (t == TOK_LPAREN) {
885 /*
886 * T -> ( E )
887 */
888 t = CondE(par, doEval);
889 if (t != TOK_ERROR) {
890 if (CondToken(par, doEval) != TOK_RPAREN) {
891 t = TOK_ERROR;
892 }
893 }
894 } else if (t == TOK_NOT) {
895 t = CondT(par, doEval);
896 if (t == TOK_TRUE) {
897 t = TOK_FALSE;
898 } else if (t == TOK_FALSE) {
899 t = TOK_TRUE;
900 }
901 }
902 return t;
903 }
904
905 /* Parse a conjunctive factor (nice name, wot?)
906 *
907 * F -> T && F | T
908 *
909 * Results:
910 * TOK_TRUE, TOK_FALSE or TOK_ERROR
911 */
912 static Token
913 CondF(CondParser *par, Boolean doEval)
914 {
915 Token l, o;
916
917 l = CondT(par, doEval);
918 if (l != TOK_ERROR) {
919 o = CondToken(par, doEval);
920
921 if (o == TOK_AND) {
922 /*
923 * F -> T && F
924 *
925 * If T is TOK_FALSE, the whole thing will be TOK_FALSE, but we
926 * have to parse the r.h.s. anyway (to throw it away).
927 * If T is TOK_TRUE, the result is the r.h.s., be it a TOK_ERROR
928 * or not.
929 */
930 if (l == TOK_TRUE) {
931 l = CondF(par, doEval);
932 } else {
933 (void)CondF(par, FALSE);
934 }
935 } else {
936 /*
937 * F -> T
938 */
939 CondParser_PushBack(par, o);
940 }
941 }
942 return l;
943 }
944
945 /* Main expression production.
946 *
947 * E -> F || E | F
948 *
949 * Results:
950 * TOK_TRUE, TOK_FALSE or TOK_ERROR.
951 */
952 static Token
953 CondE(CondParser *par, Boolean doEval)
954 {
955 Token l, o;
956
957 l = CondF(par, doEval);
958 if (l != TOK_ERROR) {
959 o = CondToken(par, doEval);
960
961 if (o == TOK_OR) {
962 /*
963 * E -> F || E
964 *
965 * A similar thing occurs for ||, except that here we make sure
966 * the l.h.s. is TOK_FALSE before we bother to evaluate the r.h.s.
967 * Once again, if l is TOK_FALSE, the result is the r.h.s. and once
968 * again if l is TOK_TRUE, we parse the r.h.s. to throw it away.
969 */
970 if (l == TOK_FALSE) {
971 l = CondE(par, doEval);
972 } else {
973 (void)CondE(par, FALSE);
974 }
975 } else {
976 /*
977 * E -> F
978 */
979 CondParser_PushBack(par, o);
980 }
981 }
982 return l;
983 }
984
985 static CondEvalResult
986 do_Cond_EvalExpression(CondParser *par, Boolean *value)
987 {
988
989 switch (CondE(par, TRUE)) {
990 case TOK_TRUE:
991 if (CondToken(par, TRUE) == TOK_EOF) {
992 *value = TRUE;
993 return COND_PARSE;
994 }
995 break;
996 case TOK_FALSE:
997 if (CondToken(par, TRUE) == TOK_EOF) {
998 *value = FALSE;
999 return COND_PARSE;
1000 }
1001 break;
1002 default:
1003 case TOK_ERROR:
1004 break;
1005 }
1006
1007 return COND_INVALID;
1008 }
1009
1010 /* Evaluate the condition in the passed line, including any side effects from
1011 * the variable expressions in the condition. The condition consists of &&,
1012 * ||, !, function(arg), comparisons and parenthetical groupings thereof.
1013 *
1014 * Results:
1015 * COND_PARSE if the condition was valid grammatically
1016 * COND_INVALID if not a valid conditional.
1017 *
1018 * (*value) is set to the boolean value of the condition
1019 */
1020 CondEvalResult
1021 Cond_EvalExpression(const struct If *info, const char *line, Boolean *value,
1022 int eprint, Boolean strictLHS)
1023 {
1024 static const struct If *dflt_info;
1025 CondParser par;
1026 int rval;
1027
1028 lhsStrict = strictLHS;
1029
1030 while (*line == ' ' || *line == '\t')
1031 line++;
1032
1033 if (info == NULL && (info = dflt_info) == NULL) {
1034 /* Scan for the entry for .if - it can't be first */
1035 for (info = ifs;; info++)
1036 if (info->form[0] == 0)
1037 break;
1038 dflt_info = info;
1039 }
1040 assert(info != NULL);
1041
1042 par.if_info = info;
1043 par.p = line;
1044 par.curr = TOK_NONE;
1045
1046 rval = do_Cond_EvalExpression(&par, value);
1047
1048 if (rval == COND_INVALID && eprint)
1049 Parse_Error(PARSE_FATAL, "Malformed conditional (%s)", line);
1050
1051 return rval;
1052 }
1053
1054
1055 /* Evaluate the conditional in the passed line. The line looks like this:
1056 * .<cond-type> <expr>
1057 * In this line, <cond-type> is any of if, ifmake, ifnmake, ifdef, ifndef,
1058 * elif, elifmake, elifnmake, elifdef, elifndef.
1059 * In this line, <expr> consists of &&, ||, !, function(arg), comparisons
1060 * and parenthetical groupings thereof.
1061 *
1062 * Note that the states IF_ACTIVE and ELSE_ACTIVE are only different in order
1063 * to detect spurious .else lines (as are SKIP_TO_ELSE and SKIP_TO_ENDIF),
1064 * otherwise .else could be treated as '.elif 1'.
1065 *
1066 * Results:
1067 * COND_PARSE to continue parsing the lines after the conditional
1068 * (when .if or .else returns TRUE)
1069 * COND_SKIP to skip the lines after the conditional
1070 * (when .if or .elif returns FALSE, or when a previous
1071 * branch has already been taken)
1072 * COND_INVALID if the conditional was not valid, either because of
1073 * a syntax error or because some variable was undefined
1074 * or because the condition could not be evaluated
1075 */
1076 CondEvalResult
1077 Cond_Eval(const char *line)
1078 {
1079 enum { MAXIF = 128 }; /* maximum depth of .if'ing */
1080 enum { MAXIF_BUMP = 32 }; /* how much to grow by */
1081 enum if_states {
1082 IF_ACTIVE, /* .if or .elif part active */
1083 ELSE_ACTIVE, /* .else part active */
1084 SEARCH_FOR_ELIF, /* searching for .elif/else to execute */
1085 SKIP_TO_ELSE, /* has been true, but not seen '.else' */
1086 SKIP_TO_ENDIF /* nothing else to execute */
1087 };
1088 static enum if_states *cond_state = NULL;
1089 static unsigned int max_if_depth = MAXIF;
1090
1091 const struct If *ifp;
1092 Boolean isElif;
1093 Boolean value;
1094 int level; /* Level at which to report errors. */
1095 enum if_states state;
1096
1097 level = PARSE_FATAL;
1098 if (!cond_state) {
1099 cond_state = bmake_malloc(max_if_depth * sizeof(*cond_state));
1100 cond_state[0] = IF_ACTIVE;
1101 }
1102 /* skip leading character (the '.') and any whitespace */
1103 for (line++; *line == ' ' || *line == '\t'; line++)
1104 continue;
1105
1106 /* Find what type of if we're dealing with. */
1107 if (line[0] == 'e') {
1108 if (line[1] != 'l') {
1109 if (!istoken(line + 1, "ndif", 4))
1110 return COND_INVALID;
1111 /* End of conditional section */
1112 if (cond_depth == cond_min_depth) {
1113 Parse_Error(level, "if-less endif");
1114 return COND_PARSE;
1115 }
1116 /* Return state for previous conditional */
1117 cond_depth--;
1118 return cond_state[cond_depth] <= ELSE_ACTIVE
1119 ? COND_PARSE : COND_SKIP;
1120 }
1121
1122 /* Quite likely this is 'else' or 'elif' */
1123 line += 2;
1124 if (istoken(line, "se", 2)) {
1125 /* It is else... */
1126 if (cond_depth == cond_min_depth) {
1127 Parse_Error(level, "if-less else");
1128 return COND_PARSE;
1129 }
1130
1131 state = cond_state[cond_depth];
1132 switch (state) {
1133 case SEARCH_FOR_ELIF:
1134 state = ELSE_ACTIVE;
1135 break;
1136 case ELSE_ACTIVE:
1137 case SKIP_TO_ENDIF:
1138 Parse_Error(PARSE_WARNING, "extra else");
1139 /* FALLTHROUGH */
1140 default:
1141 case IF_ACTIVE:
1142 case SKIP_TO_ELSE:
1143 state = SKIP_TO_ENDIF;
1144 break;
1145 }
1146 cond_state[cond_depth] = state;
1147 return state <= ELSE_ACTIVE ? COND_PARSE : COND_SKIP;
1148 }
1149 /* Assume for now it is an elif */
1150 isElif = TRUE;
1151 } else
1152 isElif = FALSE;
1153
1154 if (line[0] != 'i' || line[1] != 'f')
1155 /* Not an ifxxx or elifxxx line */
1156 return COND_INVALID;
1157
1158 /*
1159 * Figure out what sort of conditional it is -- what its default
1160 * function is, etc. -- by looking in the table of valid "ifs"
1161 */
1162 line += 2;
1163 for (ifp = ifs;; ifp++) {
1164 if (ifp->form == NULL)
1165 return COND_INVALID;
1166 if (istoken(ifp->form, line, ifp->formlen)) {
1167 line += ifp->formlen;
1168 break;
1169 }
1170 }
1171
1172 /* Now we know what sort of 'if' it is... */
1173
1174 if (isElif) {
1175 if (cond_depth == cond_min_depth) {
1176 Parse_Error(level, "if-less elif");
1177 return COND_PARSE;
1178 }
1179 state = cond_state[cond_depth];
1180 if (state == SKIP_TO_ENDIF || state == ELSE_ACTIVE) {
1181 Parse_Error(PARSE_WARNING, "extra elif");
1182 cond_state[cond_depth] = SKIP_TO_ENDIF;
1183 return COND_SKIP;
1184 }
1185 if (state != SEARCH_FOR_ELIF) {
1186 /* Either just finished the 'true' block, or already SKIP_TO_ELSE */
1187 cond_state[cond_depth] = SKIP_TO_ELSE;
1188 return COND_SKIP;
1189 }
1190 } else {
1191 /* Normal .if */
1192 if (cond_depth + 1 >= max_if_depth) {
1193 /*
1194 * This is rare, but not impossible.
1195 * In meta mode, dirdeps.mk (only runs at level 0)
1196 * can need more than the default.
1197 */
1198 max_if_depth += MAXIF_BUMP;
1199 cond_state = bmake_realloc(cond_state,
1200 max_if_depth * sizeof(*cond_state));
1201 }
1202 state = cond_state[cond_depth];
1203 cond_depth++;
1204 if (state > ELSE_ACTIVE) {
1205 /* If we aren't parsing the data, treat as always false */
1206 cond_state[cond_depth] = SKIP_TO_ELSE;
1207 return COND_SKIP;
1208 }
1209 }
1210
1211 /* And evaluate the conditional expression */
1212 if (Cond_EvalExpression(ifp, line, &value, 1, TRUE) == COND_INVALID) {
1213 /* Syntax error in conditional, error message already output. */
1214 /* Skip everything to matching .endif */
1215 cond_state[cond_depth] = SKIP_TO_ELSE;
1216 return COND_SKIP;
1217 }
1218
1219 if (!value) {
1220 cond_state[cond_depth] = SEARCH_FOR_ELIF;
1221 return COND_SKIP;
1222 }
1223 cond_state[cond_depth] = IF_ACTIVE;
1224 return COND_PARSE;
1225 }
1226
1227 void
1228 Cond_restore_depth(unsigned int saved_depth)
1229 {
1230 int open_conds = cond_depth - cond_min_depth;
1231
1232 if (open_conds != 0 || saved_depth > cond_depth) {
1233 Parse_Error(PARSE_FATAL, "%d open conditional%s", open_conds,
1234 open_conds == 1 ? "" : "s");
1235 cond_depth = cond_min_depth;
1236 }
1237
1238 cond_min_depth = saved_depth;
1239 }
1240
1241 unsigned int
1242 Cond_save_depth(void)
1243 {
1244 int depth = cond_min_depth;
1245
1246 cond_min_depth = cond_depth;
1247 return depth;
1248 }
1249