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