cond.c revision 1.135 1 /* $NetBSD: cond.c,v 1.135 2020/09/12 10:38:52 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.135 2020/09/12 10:38:52 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.135 2020/09/12 10:38:52 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 && !ch_isalpha(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 (ch_isspace(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 /* The PARSE_FATAL is done as a follow-up by Cond_EvalExpression. */
285 return 0;
286 }
287
288 *linePtr = cp;
289 return argLen;
290 }
291
292 /* Test whether the given variable is defined. */
293 static Boolean
294 FuncDefined(int argLen MAKE_ATTR_UNUSED, const char *arg)
295 {
296 char *freeIt;
297 Boolean result = Var_Value(arg, VAR_CMD, &freeIt) != NULL;
298 bmake_free(freeIt);
299 return result;
300 }
301
302 /* Wrapper around Str_Match, to be used by Lst_Find. */
303 static Boolean
304 CondFindStrMatch(const void *string, const void *pattern)
305 {
306 return Str_Match(string, pattern);
307 }
308
309 /* See if the given target is being made. */
310 static Boolean
311 FuncMake(int argLen MAKE_ATTR_UNUSED, const char *arg)
312 {
313 return Lst_Find(create, CondFindStrMatch, arg) != NULL;
314 }
315
316 /* See if the given file exists. */
317 static Boolean
318 FuncExists(int argLen MAKE_ATTR_UNUSED, const char *arg)
319 {
320 Boolean result;
321 char *path;
322
323 path = Dir_FindFile(arg, dirSearchPath);
324 if (DEBUG(COND)) {
325 fprintf(debug_file, "exists(%s) result is \"%s\"\n",
326 arg, path ? path : "");
327 }
328 if (path != NULL) {
329 result = TRUE;
330 free(path);
331 } else {
332 result = FALSE;
333 }
334 return result;
335 }
336
337 /* See if the given node exists and is an actual target. */
338 static Boolean
339 FuncTarget(int argLen MAKE_ATTR_UNUSED, const char *arg)
340 {
341 GNode *gn;
342
343 gn = Targ_FindNode(arg, TARG_NOCREATE);
344 return gn != NULL && !OP_NOP(gn->type);
345 }
346
347 /* See if the given node exists and is an actual target with commands
348 * associated with it. */
349 static Boolean
350 FuncCommands(int argLen MAKE_ATTR_UNUSED, const char *arg)
351 {
352 GNode *gn;
353
354 gn = Targ_FindNode(arg, TARG_NOCREATE);
355 return gn != NULL && !OP_NOP(gn->type) && !Lst_IsEmpty(gn->commands);
356 }
357
358 /*-
359 * Convert the given number into a double.
360 * We try a base 10 or 16 integer conversion first, if that fails
361 * then we try a floating point conversion instead.
362 *
363 * Results:
364 * Sets 'value' to double value of string.
365 * Returns TRUE if the conversion succeeded.
366 */
367 static Boolean
368 TryParseNumber(const char *str, double *value)
369 {
370 char *eptr, ech;
371 unsigned long l_val;
372 double d_val;
373
374 errno = 0;
375 if (!*str) {
376 *value = (double)0;
377 return TRUE;
378 }
379 l_val = strtoul(str, &eptr, str[1] == 'x' ? 16 : 10);
380 ech = *eptr;
381 if (ech == 0 && errno != ERANGE) {
382 d_val = str[0] == '-' ? -(double)-l_val : (double)l_val;
383 } else {
384 if (ech != 0 && ech != '.' && ech != 'e' && ech != 'E')
385 return FALSE;
386 d_val = strtod(str, &eptr);
387 if (*eptr)
388 return FALSE;
389 }
390
391 *value = d_val;
392 return TRUE;
393 }
394
395 /*-
396 * Parse a string from a variable reference or an optionally quoted
397 * string. This is called for the lhs and rhs of string comparisons.
398 *
399 * Results:
400 * Returns the string, absent any quotes, or NULL on error.
401 * Sets quoted if the string was quoted.
402 * Sets freeIt if needed.
403 */
404 /* coverity:[+alloc : arg-*3] */
405 static const char *
406 CondParser_String(CondParser *par, Boolean doEval, Boolean strictLHS,
407 Boolean *quoted, void **freeIt)
408 {
409 Buffer buf;
410 const char *str;
411 int len;
412 Boolean qt;
413 const char *start;
414 VarEvalFlags eflags;
415
416 Buf_Init(&buf, 0);
417 str = NULL;
418 *freeIt = NULL;
419 *quoted = qt = par->p[0] == '"' ? 1 : 0;
420 if (qt)
421 par->p++;
422 for (start = par->p; par->p[0] && str == NULL;) {
423 switch (par->p[0]) {
424 case '\\':
425 par->p++;
426 if (par->p[0] != '\0') {
427 Buf_AddByte(&buf, par->p[0]);
428 par->p++;
429 }
430 continue;
431 case '"':
432 if (qt) {
433 par->p++; /* we don't want the quotes */
434 goto got_str;
435 }
436 Buf_AddByte(&buf, par->p[0]); /* likely? */
437 par->p++;
438 continue;
439 case ')':
440 case '!':
441 case '=':
442 case '>':
443 case '<':
444 case ' ':
445 case '\t':
446 if (!qt)
447 goto got_str;
448 Buf_AddByte(&buf, par->p[0]);
449 par->p++;
450 continue;
451 case '$':
452 /* if we are in quotes, then an undefined variable is ok */
453 eflags = ((!qt && doEval) ? VARE_UNDEFERR : 0) |
454 (doEval ? VARE_WANTRES : 0);
455 str = Var_Parse(par->p, VAR_CMD, eflags, &len, freeIt);
456 if (str == var_Error) {
457 if (*freeIt) {
458 free(*freeIt);
459 *freeIt = NULL;
460 }
461 /*
462 * Even if !doEval, we still report syntax errors, which
463 * is what getting var_Error back with !doEval means.
464 */
465 str = NULL;
466 goto cleanup;
467 }
468 par->p += len;
469 /*
470 * If the '$' was first char (no quotes), and we are
471 * followed by space, the operator or end of expression,
472 * we are done.
473 */
474 if ((par->p == start + len) &&
475 (par->p[0] == '\0' ||
476 ch_isspace(par->p[0]) ||
477 strchr("!=><)", par->p[0]))) {
478 goto cleanup;
479 }
480
481 Buf_AddStr(&buf, str);
482 if (*freeIt) {
483 free(*freeIt);
484 *freeIt = NULL;
485 }
486 str = NULL; /* not finished yet */
487 continue;
488 default:
489 if (strictLHS && !qt && *start != '$' && !ch_isdigit(*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 /* Evaluate a "comparison without operator", such as in ".if ${VAR}" or
527 * ".if 0". */
528 static Token
529 EvalNotEmpty(CondParser *par, const char *lhs, Boolean lhsQuoted)
530 {
531 double left;
532
533 /* For .ifxxx "..." check for non-empty string. */
534 if (lhsQuoted)
535 return lhs[0] != '\0';
536
537 /* For .ifxxx <number> compare against zero */
538 if (TryParseNumber(lhs, &left))
539 return left != 0.0;
540
541 /* For .if ${...} check for non-empty string (defProc is ifdef). */
542 if (par->if_info->form[0] == '\0')
543 return lhs[0] != 0;
544
545 /* Otherwise action default test ... */
546 return par->if_info->defProc(strlen(lhs), lhs) != par->if_info->doNot;
547 }
548
549 /* Evaluate a numerical comparison, such as in ".if ${VAR} >= 9". */
550 static Token
551 EvalCompareNum(double lhs, const char *op, double rhs)
552 {
553 if (DEBUG(COND))
554 fprintf(debug_file, "lhs = %f, rhs = %f, op = %.2s\n", lhs, rhs, op);
555
556 switch (op[0]) {
557 case '!':
558 if (op[1] != '=') {
559 Parse_Error(PARSE_WARNING, "Unknown operator");
560 /* The PARSE_FATAL is done as a follow-up by Cond_EvalExpression. */
561 return TOK_ERROR;
562 }
563 return lhs != rhs;
564 case '=':
565 if (op[1] != '=') {
566 Parse_Error(PARSE_WARNING, "Unknown operator");
567 /* The PARSE_FATAL is done as a follow-up by Cond_EvalExpression. */
568 return TOK_ERROR;
569 }
570 return lhs == rhs;
571 case '<':
572 return op[1] == '=' ? lhs <= rhs : lhs < rhs;
573 case '>':
574 return op[1] == '=' ? lhs >= rhs : lhs > rhs;
575 }
576 return TOK_ERROR;
577 }
578
579 static Token
580 EvalCompareStr(const char *lhs, const char *op, const char *rhs)
581 {
582 if (!((op[0] == '!' || op[0] == '=') && op[1] == '=')) {
583 Parse_Error(PARSE_WARNING,
584 "String comparison operator must be either == or !=");
585 /* The PARSE_FATAL is done as a follow-up by Cond_EvalExpression. */
586 return TOK_ERROR;
587 }
588
589 if (DEBUG(COND)) {
590 fprintf(debug_file, "lhs = \"%s\", rhs = \"%s\", op = %.2s\n",
591 lhs, rhs, op);
592 }
593 return (*op == '=') == (strcmp(lhs, rhs) == 0);
594 }
595
596 /* Evaluate a comparison, such as "${VAR} == 12345". */
597 static Token
598 EvalCompare(const char *lhs, Boolean lhsQuoted, const char *op,
599 const char *rhs, Boolean rhsQuoted)
600 {
601 double left, right;
602
603 if (!rhsQuoted && !lhsQuoted)
604 if (TryParseNumber(lhs, &left) && TryParseNumber(rhs, &right))
605 return EvalCompareNum(left, op, right);
606
607 return EvalCompareStr(lhs, op, rhs);
608 }
609
610 /* Parse a comparison condition such as:
611 *
612 * 0
613 * ${VAR:Mpattern}
614 * ${VAR} == value
615 * ${VAR:U0} < 12345
616 */
617 static Token
618 CondParser_Comparison(CondParser *par, Boolean doEval)
619 {
620 Token t = TOK_ERROR;
621 const char *lhs, *op, *rhs;
622 void *lhsFree, *rhsFree;
623 Boolean lhsQuoted, rhsQuoted;
624
625 rhs = NULL;
626 lhsFree = rhsFree = NULL;
627 lhsQuoted = rhsQuoted = FALSE;
628
629 /*
630 * Parse the variable spec and skip over it, saving its
631 * value in lhs.
632 */
633 lhs = CondParser_String(par, doEval, lhsStrict, &lhsQuoted, &lhsFree);
634 if (!lhs)
635 goto done;
636
637 CondParser_SkipWhitespace(par);
638
639 /*
640 * Make sure the operator is a valid one. If it isn't a
641 * known relational operator, pretend we got a
642 * != 0 comparison.
643 */
644 op = par->p;
645 switch (par->p[0]) {
646 case '!':
647 case '=':
648 case '<':
649 case '>':
650 if (par->p[1] == '=') {
651 par->p += 2;
652 } else {
653 par->p += 1;
654 }
655 break;
656 default:
657 t = doEval ? EvalNotEmpty(par, lhs, lhsQuoted) : TOK_FALSE;
658 goto done;
659 }
660
661 CondParser_SkipWhitespace(par);
662
663 if (par->p[0] == '\0') {
664 Parse_Error(PARSE_WARNING, "Missing right-hand-side of operator");
665 /* The PARSE_FATAL is done as a follow-up by Cond_EvalExpression. */
666 goto done;
667 }
668
669 rhs = CondParser_String(par, doEval, FALSE, &rhsQuoted, &rhsFree);
670 if (rhs == NULL)
671 goto done;
672
673 if (!doEval) {
674 t = TOK_FALSE;
675 goto done;
676 }
677
678 t = EvalCompare(lhs, lhsQuoted, op, rhs, rhsQuoted);
679
680 done:
681 free(lhsFree);
682 free(rhsFree);
683 return t;
684 }
685
686 static int
687 ParseEmptyArg(const char **linePtr, Boolean doEval,
688 const char *func MAKE_ATTR_UNUSED, char **argPtr)
689 {
690 void *val_freeIt;
691 const char *val;
692 int magic_res;
693
694 /* We do all the work here and return the result as the length */
695 *argPtr = NULL;
696
697 (*linePtr)--; /* Make (*linePtr)[1] point to the '('. */
698 val = Var_ParsePP(linePtr, VAR_CMD, doEval ? VARE_WANTRES : 0, &val_freeIt);
699 /* If successful, *linePtr points beyond the closing ')' now. */
700
701 if (val == var_Error) {
702 free(val_freeIt);
703 return -1;
704 }
705
706 /* A variable is empty when it just contains spaces... 4/15/92, christos */
707 while (ch_isspace(val[0]))
708 val++;
709
710 /*
711 * For consistency with the other functions we can't generate the
712 * true/false here.
713 */
714 magic_res = *val != '\0' ? 2 : 1;
715 free(val_freeIt);
716 return magic_res;
717 }
718
719 static Boolean
720 FuncEmpty(int arglen, const char *arg MAKE_ATTR_UNUSED)
721 {
722 /* Magic values ahead, see ParseEmptyArg. */
723 return arglen == 1;
724 }
725
726 static Token
727 CondParser_Func(CondParser *par, Boolean doEval)
728 {
729 static const struct fn_def {
730 const char *fn_name;
731 size_t fn_name_len;
732 int (*fn_parse)(const char **, Boolean, const char *, char **);
733 Boolean (*fn_eval)(int, const char *);
734 } fn_defs[] = {
735 { "defined", 7, ParseFuncArg, FuncDefined },
736 { "make", 4, ParseFuncArg, FuncMake },
737 { "exists", 6, ParseFuncArg, FuncExists },
738 { "empty", 5, ParseEmptyArg, FuncEmpty },
739 { "target", 6, ParseFuncArg, FuncTarget },
740 { "commands", 8, ParseFuncArg, FuncCommands },
741 { NULL, 0, NULL, NULL },
742 };
743 const struct fn_def *fn_def;
744 Token t;
745 char *arg = NULL;
746 int arglen;
747 const char *cp = par->p;
748 const char *cp1;
749
750 for (fn_def = fn_defs; fn_def->fn_name != NULL; fn_def++) {
751 if (!is_token(cp, fn_def->fn_name, fn_def->fn_name_len))
752 continue;
753 cp += fn_def->fn_name_len;
754 /* There can only be whitespace before the '(' */
755 while (ch_isspace(*cp))
756 cp++;
757 if (*cp != '(')
758 break;
759
760 arglen = fn_def->fn_parse(&cp, doEval, fn_def->fn_name, &arg);
761 if (arglen <= 0) {
762 par->p = cp;
763 return arglen < 0 ? TOK_ERROR : TOK_FALSE;
764 }
765 /* Evaluate the argument using the required function. */
766 t = !doEval || fn_def->fn_eval(arglen, arg);
767 free(arg);
768 par->p = cp;
769 return t;
770 }
771
772 /* Push anything numeric through the compare expression */
773 cp = par->p;
774 if (ch_isdigit(cp[0]) || strchr("+-", cp[0]))
775 return CondParser_Comparison(par, doEval);
776
777 /*
778 * Most likely we have a naked token to apply the default function to.
779 * However ".if a == b" gets here when the "a" is unquoted and doesn't
780 * start with a '$'. This surprises people.
781 * If what follows the function argument is a '=' or '!' then the syntax
782 * would be invalid if we did "defined(a)" - so instead treat as an
783 * expression.
784 */
785 arglen = ParseFuncArg(&cp, doEval, NULL, &arg);
786 for (cp1 = cp; ch_isspace(*cp1); cp1++)
787 continue;
788 if (*cp1 == '=' || *cp1 == '!')
789 return CondParser_Comparison(par, doEval);
790 par->p = cp;
791
792 /*
793 * Evaluate the argument using the default function.
794 * This path always treats .if as .ifdef. To get here, the character
795 * after .if must have been taken literally, so the argument cannot
796 * be empty - even if it contained a variable expansion.
797 */
798 t = !doEval || par->if_info->defProc(arglen, arg) != par->if_info->doNot;
799 free(arg);
800 return t;
801 }
802
803 /* Return the next token or comparison result from the parser. */
804 static Token
805 CondParser_Token(CondParser *par, Boolean doEval)
806 {
807 Token t;
808
809 t = par->curr;
810 if (t != TOK_NONE) {
811 par->curr = TOK_NONE;
812 return t;
813 }
814
815 while (par->p[0] == ' ' || par->p[0] == '\t') {
816 par->p++;
817 }
818
819 switch (par->p[0]) {
820
821 case '(':
822 par->p++;
823 return TOK_LPAREN;
824
825 case ')':
826 par->p++;
827 return TOK_RPAREN;
828
829 case '|':
830 par->p++;
831 if (par->p[0] == '|') {
832 par->p++;
833 }
834 return TOK_OR;
835
836 case '&':
837 par->p++;
838 if (par->p[0] == '&') {
839 par->p++;
840 }
841 return TOK_AND;
842
843 case '!':
844 par->p++;
845 return TOK_NOT;
846
847 case '#':
848 case '\n':
849 case '\0':
850 return TOK_EOF;
851
852 case '"':
853 case '$':
854 return CondParser_Comparison(par, doEval);
855
856 default:
857 return CondParser_Func(par, doEval);
858 }
859 }
860
861 /* Parse a single term in the expression. This consists of a terminal symbol
862 * or TOK_NOT and a term (not including the binary operators):
863 *
864 * T -> defined(variable) | make(target) | exists(file) | symbol
865 * T -> ! T | ( E )
866 *
867 * Results:
868 * TOK_TRUE, TOK_FALSE or TOK_ERROR.
869 */
870 static Token
871 CondParser_Term(CondParser *par, Boolean doEval)
872 {
873 Token t;
874
875 t = CondParser_Token(par, doEval);
876
877 if (t == TOK_EOF) {
878 /*
879 * If we reached the end of the expression, the expression
880 * is malformed...
881 */
882 t = TOK_ERROR;
883 } else if (t == TOK_LPAREN) {
884 /*
885 * T -> ( E )
886 */
887 t = CondParser_Expr(par, doEval);
888 if (t != TOK_ERROR) {
889 if (CondParser_Token(par, doEval) != TOK_RPAREN) {
890 t = TOK_ERROR;
891 }
892 }
893 } else if (t == TOK_NOT) {
894 t = CondParser_Term(par, doEval);
895 if (t == TOK_TRUE) {
896 t = TOK_FALSE;
897 } else if (t == TOK_FALSE) {
898 t = TOK_TRUE;
899 }
900 }
901 return t;
902 }
903
904 /* Parse a conjunctive factor (nice name, wot?)
905 *
906 * F -> T && F | T
907 *
908 * Results:
909 * TOK_TRUE, TOK_FALSE or TOK_ERROR
910 */
911 static Token
912 CondParser_Factor(CondParser *par, Boolean doEval)
913 {
914 Token l, o;
915
916 l = CondParser_Term(par, doEval);
917 if (l != TOK_ERROR) {
918 o = CondParser_Token(par, doEval);
919
920 if (o == TOK_AND) {
921 /*
922 * F -> T && F
923 *
924 * If T is TOK_FALSE, the whole thing will be TOK_FALSE, but we
925 * have to parse the r.h.s. anyway (to throw it away).
926 * If T is TOK_TRUE, the result is the r.h.s., be it a TOK_ERROR
927 * or not.
928 */
929 if (l == TOK_TRUE) {
930 l = CondParser_Factor(par, doEval);
931 } else {
932 (void)CondParser_Factor(par, FALSE);
933 }
934 } else {
935 /*
936 * F -> T
937 */
938 CondParser_PushBack(par, o);
939 }
940 }
941 return l;
942 }
943
944 /* Main expression production.
945 *
946 * E -> F || E | F
947 *
948 * Results:
949 * TOK_TRUE, TOK_FALSE or TOK_ERROR.
950 */
951 static Token
952 CondParser_Expr(CondParser *par, Boolean doEval)
953 {
954 Token l, o;
955
956 l = CondParser_Factor(par, doEval);
957 if (l != TOK_ERROR) {
958 o = CondParser_Token(par, doEval);
959
960 if (o == TOK_OR) {
961 /*
962 * E -> F || E
963 *
964 * A similar thing occurs for ||, except that here we make sure
965 * the l.h.s. is TOK_FALSE before we bother to evaluate the r.h.s.
966 * Once again, if l is TOK_FALSE, the result is the r.h.s. and once
967 * again if l is TOK_TRUE, we parse the r.h.s. to throw it away.
968 */
969 if (l == TOK_FALSE) {
970 l = CondParser_Expr(par, doEval);
971 } else {
972 (void)CondParser_Expr(par, FALSE);
973 }
974 } else {
975 /*
976 * E -> F
977 */
978 CondParser_PushBack(par, o);
979 }
980 }
981 return l;
982 }
983
984 static CondEvalResult
985 CondParser_Eval(CondParser *par, Boolean *value)
986 {
987 Token res;
988
989 if (DEBUG(COND))
990 fprintf(debug_file, "CondParser_Eval: %s\n", par->p);
991
992 res = CondParser_Expr(par, TRUE);
993 if (res != TOK_FALSE && res != TOK_TRUE)
994 return COND_INVALID;
995
996 if (CondParser_Token(par, TRUE /* XXX: Why TRUE? */) != TOK_EOF)
997 return COND_INVALID;
998
999 *value = res == TOK_TRUE;
1000 return COND_PARSE;
1001 }
1002
1003 /* Evaluate the condition, including any side effects from the variable
1004 * expressions in the condition. The condition consists of &&, ||, !,
1005 * function(arg), comparisons and parenthetical groupings thereof.
1006 *
1007 * Results:
1008 * COND_PARSE if the condition was valid grammatically
1009 * COND_INVALID if not a valid conditional.
1010 *
1011 * (*value) is set to the boolean value of the condition
1012 */
1013 CondEvalResult
1014 Cond_EvalExpression(const struct If *info, const char *cond, Boolean *value,
1015 int eprint, Boolean strictLHS)
1016 {
1017 static const struct If *dflt_info;
1018 CondParser par;
1019 int rval;
1020
1021 lhsStrict = strictLHS;
1022
1023 while (*cond == ' ' || *cond == '\t')
1024 cond++;
1025
1026 if (info == NULL && (info = dflt_info) == NULL) {
1027 /* Scan for the entry for .if - it can't be first */
1028 for (info = ifs;; info++)
1029 if (info->form[0] == 0)
1030 break;
1031 dflt_info = info;
1032 }
1033 assert(info != NULL);
1034
1035 par.if_info = info;
1036 par.p = cond;
1037 par.curr = TOK_NONE;
1038
1039 rval = CondParser_Eval(&par, value);
1040
1041 if (rval == COND_INVALID && eprint)
1042 Parse_Error(PARSE_FATAL, "Malformed conditional (%s)", cond);
1043
1044 return rval;
1045 }
1046
1047
1048 /* Evaluate the conditional in the passed line. The line looks like this:
1049 * .<cond-type> <expr>
1050 * In this line, <cond-type> is any of if, ifmake, ifnmake, ifdef, ifndef,
1051 * elif, elifmake, elifnmake, elifdef, elifndef.
1052 * In this line, <expr> consists of &&, ||, !, function(arg), comparisons
1053 * and parenthetical groupings thereof.
1054 *
1055 * Note that the states IF_ACTIVE and ELSE_ACTIVE are only different in order
1056 * to detect spurious .else lines (as are SKIP_TO_ELSE and SKIP_TO_ENDIF),
1057 * otherwise .else could be treated as '.elif 1'.
1058 *
1059 * Results:
1060 * COND_PARSE to continue parsing the lines after the conditional
1061 * (when .if or .else returns TRUE)
1062 * COND_SKIP to skip the lines after the conditional
1063 * (when .if or .elif returns FALSE, or when a previous
1064 * branch has already been taken)
1065 * COND_INVALID if the conditional was not valid, either because of
1066 * a syntax error or because some variable was undefined
1067 * or because the condition could not be evaluated
1068 */
1069 CondEvalResult
1070 Cond_Eval(const char *line)
1071 {
1072 enum { MAXIF = 128 }; /* maximum depth of .if'ing */
1073 enum { MAXIF_BUMP = 32 }; /* how much to grow by */
1074 enum if_states {
1075 IF_ACTIVE, /* .if or .elif part active */
1076 ELSE_ACTIVE, /* .else part active */
1077 SEARCH_FOR_ELIF, /* searching for .elif/else to execute */
1078 SKIP_TO_ELSE, /* has been true, but not seen '.else' */
1079 SKIP_TO_ENDIF /* nothing else to execute */
1080 };
1081 static enum if_states *cond_state = NULL;
1082 static unsigned int max_if_depth = MAXIF;
1083
1084 const struct If *ifp;
1085 Boolean isElif;
1086 Boolean value;
1087 int level; /* Level at which to report errors. */
1088 enum if_states state;
1089
1090 level = PARSE_FATAL;
1091 if (!cond_state) {
1092 cond_state = bmake_malloc(max_if_depth * sizeof(*cond_state));
1093 cond_state[0] = IF_ACTIVE;
1094 }
1095 /* skip leading character (the '.') and any whitespace */
1096 for (line++; *line == ' ' || *line == '\t'; line++)
1097 continue;
1098
1099 /* Find what type of if we're dealing with. */
1100 if (line[0] == 'e') {
1101 if (line[1] != 'l') {
1102 if (!is_token(line + 1, "ndif", 4))
1103 return COND_INVALID;
1104 /* End of conditional section */
1105 if (cond_depth == cond_min_depth) {
1106 Parse_Error(level, "if-less endif");
1107 return COND_PARSE;
1108 }
1109 /* Return state for previous conditional */
1110 cond_depth--;
1111 return cond_state[cond_depth] <= ELSE_ACTIVE
1112 ? COND_PARSE : COND_SKIP;
1113 }
1114
1115 /* Quite likely this is 'else' or 'elif' */
1116 line += 2;
1117 if (is_token(line, "se", 2)) {
1118 /* It is else... */
1119 if (cond_depth == cond_min_depth) {
1120 Parse_Error(level, "if-less else");
1121 return COND_PARSE;
1122 }
1123
1124 state = cond_state[cond_depth];
1125 switch (state) {
1126 case SEARCH_FOR_ELIF:
1127 state = ELSE_ACTIVE;
1128 break;
1129 case ELSE_ACTIVE:
1130 case SKIP_TO_ENDIF:
1131 Parse_Error(PARSE_WARNING, "extra else");
1132 /* FALLTHROUGH */
1133 default:
1134 case IF_ACTIVE:
1135 case SKIP_TO_ELSE:
1136 state = SKIP_TO_ENDIF;
1137 break;
1138 }
1139 cond_state[cond_depth] = state;
1140 return state <= ELSE_ACTIVE ? COND_PARSE : COND_SKIP;
1141 }
1142 /* Assume for now it is an elif */
1143 isElif = TRUE;
1144 } else
1145 isElif = FALSE;
1146
1147 if (line[0] != 'i' || line[1] != 'f')
1148 /* Not an ifxxx or elifxxx line */
1149 return COND_INVALID;
1150
1151 /*
1152 * Figure out what sort of conditional it is -- what its default
1153 * function is, etc. -- by looking in the table of valid "ifs"
1154 */
1155 line += 2;
1156 for (ifp = ifs;; ifp++) {
1157 if (ifp->form == NULL)
1158 return COND_INVALID;
1159 if (is_token(ifp->form, line, ifp->formlen)) {
1160 line += ifp->formlen;
1161 break;
1162 }
1163 }
1164
1165 /* Now we know what sort of 'if' it is... */
1166
1167 if (isElif) {
1168 if (cond_depth == cond_min_depth) {
1169 Parse_Error(level, "if-less elif");
1170 return COND_PARSE;
1171 }
1172 state = cond_state[cond_depth];
1173 if (state == SKIP_TO_ENDIF || state == ELSE_ACTIVE) {
1174 Parse_Error(PARSE_WARNING, "extra elif");
1175 cond_state[cond_depth] = SKIP_TO_ENDIF;
1176 return COND_SKIP;
1177 }
1178 if (state != SEARCH_FOR_ELIF) {
1179 /* Either just finished the 'true' block, or already SKIP_TO_ELSE */
1180 cond_state[cond_depth] = SKIP_TO_ELSE;
1181 return COND_SKIP;
1182 }
1183 } else {
1184 /* Normal .if */
1185 if (cond_depth + 1 >= max_if_depth) {
1186 /*
1187 * This is rare, but not impossible.
1188 * In meta mode, dirdeps.mk (only runs at level 0)
1189 * can need more than the default.
1190 */
1191 max_if_depth += MAXIF_BUMP;
1192 cond_state = bmake_realloc(cond_state,
1193 max_if_depth * sizeof(*cond_state));
1194 }
1195 state = cond_state[cond_depth];
1196 cond_depth++;
1197 if (state > ELSE_ACTIVE) {
1198 /* If we aren't parsing the data, treat as always false */
1199 cond_state[cond_depth] = SKIP_TO_ELSE;
1200 return COND_SKIP;
1201 }
1202 }
1203
1204 /* And evaluate the conditional expression */
1205 if (Cond_EvalExpression(ifp, line, &value, 1, TRUE) == COND_INVALID) {
1206 /* Syntax error in conditional, error message already output. */
1207 /* Skip everything to matching .endif */
1208 cond_state[cond_depth] = SKIP_TO_ELSE;
1209 return COND_SKIP;
1210 }
1211
1212 if (!value) {
1213 cond_state[cond_depth] = SEARCH_FOR_ELIF;
1214 return COND_SKIP;
1215 }
1216 cond_state[cond_depth] = IF_ACTIVE;
1217 return COND_PARSE;
1218 }
1219
1220 void
1221 Cond_restore_depth(unsigned int saved_depth)
1222 {
1223 int open_conds = cond_depth - cond_min_depth;
1224
1225 if (open_conds != 0 || saved_depth > cond_depth) {
1226 Parse_Error(PARSE_FATAL, "%d open conditional%s", open_conds,
1227 open_conds == 1 ? "" : "s");
1228 cond_depth = cond_min_depth;
1229 }
1230
1231 cond_min_depth = saved_depth;
1232 }
1233
1234 unsigned int
1235 Cond_save_depth(void)
1236 {
1237 int depth = cond_min_depth;
1238
1239 cond_min_depth = cond_depth;
1240 return depth;
1241 }
1242