2 * Copyright 1993-2002 Christopher Seiwald and Perforce Software, Inc.
4 * This file is part of Jam - see jam.c for Copyright information.
7 * compile.c - compile parsed jam statements
11 * compile_append() - append list results of two statements
12 * compile_break() - compile 'break/continue/return' rule
13 * compile_eval() - evaluate if to determine which leg to compile
14 * compile_foreach() - compile the "for x in y" statement
15 * compile_if() - compile 'if' rule
16 * compile_include() - support for 'include' - call include() on file
17 * compile_list() - expand and return a list
18 * compile_local() - declare (and set) local variables
19 * compile_null() - do nothing -- a stub for parsing
20 * compile_on() - run rule under influence of on-target variables
21 * compile_rule() - compile a single user defined rule
22 * compile_rules() - compile a chain of rules
23 * compile_set() - compile the "set variable" statement
24 * compile_setcomp() - support for `rule` - save parse tree
25 * compile_setexec() - support for `actions` - save execution string
26 * compile_settings() - compile the "on =" (set variable on exec) statement
27 * compile_switch() - compile 'switch' rule
31 * debug_compile() - printf with indent to show rule expansion.
32 * evaluate_rule() - execute a rule invocation
34 * 02/03/94 (seiwald) - Changed trace output to read "setting" instead of
35 * the awkward sounding "settings".
36 * 04/12/94 (seiwald) - Combined build_depends() with build_includes().
37 * 04/12/94 (seiwald) - actionlist() now just appends a single action.
38 * 04/13/94 (seiwald) - added shorthand L0 for null list pointer
39 * 05/13/94 (seiwald) - include files are now bound as targets, and thus
40 * can make use of $(SEARCH)
41 * 06/01/94 (seiwald) - new 'actions existing' does existing sources
42 * 08/23/94 (seiwald) - Support for '+=' (append to variable)
43 * 12/20/94 (seiwald) - NOTIME renamed NOTFILE.
44 * 01/22/95 (seiwald) - Exit rule.
45 * 02/02/95 (seiwald) - Always rule; LEAVES rule.
46 * 02/14/95 (seiwald) - NoUpdate rule.
47 * 01/20/00 (seiwald) - Upgraded from K&R to ANSI C
48 * 09/07/00 (seiwald) - stop crashing when a rule redefines itself
49 * 09/11/00 (seiwald) - new evaluate_rule() for headers().
50 * 09/11/00 (seiwald) - rules now return values, accessed via [ rule arg ... ]
51 * 09/12/00 (seiwald) - don't complain about rules invoked without targets
52 * 01/13/01 (seiwald) - fix case where rule is defined within another
53 * 01/10/01 (seiwald) - built-ins split out to builtin.c.
54 * 01/11/01 (seiwald) - optimize compile_rules() for tail recursion
55 * 01/21/01 (seiwald) - replace evaluate_if() with compile_eval()
56 * 01/24/01 (seiwald) - 'while' statement
57 * 03/23/01 (seiwald) - "[ on target rule ]" support
58 * 02/28/02 (seiwald) - merge EXEC_xxx flags in with RULE_xxx
59 * 03/02/02 (seiwald) - rules can be invoked via variable names
60 * 03/12/02 (seiwald) - &&,&,||,|,in now short-circuit again
61 * 03/25/02 (seiwald) - if ( "" a b ) one again returns true
62 * 06/21/02 (seiwald) - support for named parameters
63 * 10/22/02 (seiwald) - list_new() now does its own newstr()/copystr()
64 * 10/22/02 (seiwald) - working return/break/continue statements
65 * 11/04/02 (seiwald) - const-ing for string literals
66 * 11/18/02 (seiwald) - remove bogus search() in 'on' statement.
67 * 12/17/02 (seiwald) - new copysettings() to protect target-specific vars
81 static const char *set_names
[] = { "=", "+=", "-=", "?=" };
82 static void debug_compile (int which
, const char *s
);
83 int glob (const char *s
, const char *c
);
87 * compile_append() - append list results of two statements
89 * parse->left more compile_append() by left-recursion
90 * parse->right single rule
92 LIST
*compile_append (PARSE
*parse
, LOL
*args
, int *jmp
) {
93 /* Append right to left. */
95 (*parse
->left
->func
)(parse
->left
, args
, jmp
),
96 (*parse
->right
->func
)(parse
->right
, args
, jmp
)
102 * compile_break() - compile 'break/continue/return' rule
104 * parse->left results
105 * parse->num JMP_BREAK/CONTINUE/RETURN
107 LIST
*compile_break (PARSE
*parse
, LOL
*args
, int *jmp
) {
108 LIST
*lv
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
115 * compile_eval() - evaluate if to determine which leg to compile
118 * list if expression true - compile 'then' clause
119 * L0 if expression false - compile 'else' clause
121 static int lcmp (LIST
*t
, LIST
*s
) {
124 while (!status
&& (t
|| s
)) {
125 const char *st
= t
?t
->string
:"";
126 const char *ss
= s
?s
->string
:"";
128 status
= strcmp(st
, ss
);
129 t
= t
?list_next(t
):t
;
130 s
= s
?list_next(s
):s
;
136 LIST
*compile_eval (PARSE
*parse
, LOL
*args
, int *jmp
) {
137 LIST
*ll
, *lr
, *s
, *t
;
140 /* short circuit lr eval for &&, ||, and 'in' */
141 ll
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
143 switch (parse
->num
) {
152 eval
: lr
= (*parse
->right
->func
)(parse
->right
, args
, jmp
);
156 switch (parse
->num
) {
161 if (ll
&& lr
) status
= 1;
164 if (ll
|| lr
) status
= 1;
167 /* "a in b": make sure each of ll is equal to something in lr */
168 for (t
= ll
; t
; t
= list_next(t
)) {
169 for (s
= lr
; s
; s
= list_next(s
)) if (strcmp(t
->string
, s
->string
) == 0) break;
172 /* No more ll? success */
176 if (lcmp(ll
, L0
) != 0) status
= 1;
179 if (lcmp(ll
, lr
) == 0) status
= 1;
182 if (lcmp(ll
, lr
) != 0) status
= 1;
185 if (lcmp(ll
, lr
) < 0) status
= 1;
188 if (lcmp(ll
, lr
) <= 0) status
= 1;
191 if (lcmp(ll
, lr
) > 0) status
= 1;
194 if (lcmp(ll
, lr
) >= 0) status
= 1;
198 debug_compile(0, "if");
200 printf("(%d) ", status
);
204 /* find something to return */
205 /* in odd circumstances (like "" = "") we'll have to return a new string */
207 else if (ll
) t
= ll
, ll
= 0;
208 else if (lr
) t
= lr
, lr
= 0;
209 else t
= list_new(L0
, "1", 0);
210 if (ll
) list_free(ll
);
211 if (lr
) list_free(lr
);
217 * compile_foreach() - compile the "for x in y" statement
219 * Compile_foreach() resets the given variable name to each specified
220 * value, executing the commands enclosed in braces for each iteration.
222 * parse->string index variable
223 * parse->left variable values
224 * parse->right rule to compile
226 LIST
*compile_foreach (PARSE
*p
, LOL
*args
, int *jmp
) {
227 LIST
*nv
= (*p
->left
->func
)(p
->left
, args
, jmp
);
231 /* for each value for var */
232 for (l
= nv
; l
&& *jmp
== JMP_NONE
; l
= list_next(l
)) {
233 /* reset $(p->string) for each val */
234 var_set(p
->string
, list_new(L0
, l
->string
, 1), VAR_SET
);
235 /* keep only last result */
237 result
= (*p
->right
->func
)(p
->right
, args
, jmp
);
239 if (*jmp
== JMP_CONTINUE
) *jmp
= JMP_NONE
;
241 /* here by break/continue? */
242 if (*jmp
== JMP_BREAK
|| *jmp
== JMP_CONTINUE
) *jmp
= JMP_NONE
;
244 /* returns result of last loop */
250 * compile_if() - compile 'if' rule
252 * parse->left condition tree
253 * parse->right then tree
254 * parse->third else tree
256 LIST
*compile_if (PARSE
*p
, LOL
*args
, int *jmp
) {
257 LIST
*l
= (*p
->left
->func
)(p
->left
, args
, jmp
);
259 p
= l
?p
->right
:p
->third
;
261 return (*p
->func
)(p
, args
, jmp
);
266 * compile_include() - support for 'include' - call include() on file
268 * parse->left list of files to include (can only do 1)
270 LIST
*compile_include (PARSE
*parse
, LOL
*args
, int *jmp
) {
271 LIST
*nt
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
274 debug_compile(0, "include");
279 TARGET
*t
= bindtarget(nt
->string
);
280 /* bind the include file under the influence of "on-target" variables */
281 /* though they are targets, include files are not built with make() */
282 /* needn't copysettings(), as search sets no vars */
283 pushsettings(t
->settings
);
284 t
->boundname
= search(t
->name
, &t
->time
);
285 popsettings(t
->settings
);
286 /* don't parse missing file if NOCARE set */
287 if (t
->time
|| !(t
->flags
& T_FLAG_NOCARE
)) parse_file(t
->boundname
);
295 * compile_list() - expand and return a list
297 * parse->string - character string to expand
299 LIST
*compile_list (PARSE
*parse
, LOL
*args
, int *jmp
) {
300 /* voodoo 1 means: s is a copyable string */
301 const char *s
= parse
->string
;
302 return var_expand(L0
, s
, s
+strlen(s
), args
, 1);
307 * compile_local() - declare (and set) local variables
309 * parse->left list of variables
310 * parse->right list of values
311 * parse->third rules to execute
313 LIST
*compile_local (PARSE
*parse
, LOL
*args
, int *jmp
) {
316 LIST
*nt
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
317 LIST
*ns
= (*parse
->right
->func
)(parse
->right
, args
, jmp
);
321 debug_compile(0, "local");
327 /* initial value is ns */
328 for (l
= nt
; l
; l
= list_next(l
)) s
= addsettings(s
, 0, l
->string
, list_copy((LIST
*)0, ns
));
331 /* note that callees of the current context get this "local" */
332 /* variable, making it not so much local as layered */
334 result
= (*parse
->third
->func
)(parse
->third
, args
, jmp
);
342 * compile_null() - do nothing -- a stub for parsing
344 LIST
*compile_null (PARSE
*parse
, LOL
*args
, int *jmp
) {
350 * compile_on() - run rule under influence of on-target variables
352 * parse->left target list; only first used
353 * parse->right rule to run
355 LIST
*compile_on (PARSE
*parse
, LOL
*args
, int *jmp
) {
356 LIST
*nt
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
360 debug_compile(0, "on");
364 /* copy settings, so that 'on target var on target = val' doesn't set var globally */
366 TARGET
*t
= bindtarget(nt
->string
);
367 SETTINGS
*s
= copysettings(t
->settings
);
370 result
= (*parse
->right
->func
)(parse
->right
, args
, jmp
);
380 * compile_rule() - compile a single user defined rule
382 * parse->left list of rules to run
383 * parse->right parameters (list of lists) to rule, recursing left
385 * Wrapped around evaluate_rule() so that headers() can share it.
387 LIST
*compile_rule (PARSE
*parse
, LOL
*args
, int *jmp
) {
393 /* list of rules to run -- normally 1! */
394 ll
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
395 /* build up the list of arg lists */
397 for (p
= parse
->right
; p
; p
= p
->left
) lol_add(nargs
, (*p
->right
->func
)(p
->right
, args
, jmp
));
398 /* run rules, appending results from each */
399 for (l
= ll
; l
; l
= list_next(l
)) result
= evaluate_rule(l
->string
, nargs
, result
);
407 * evaluate_rule() - execute a rule invocation
409 LIST
*evaluate_rule (const char *rulename
, LOL
*args
, LIST
*result
) {
410 RULE
*rule
= bindrule(rulename
);
413 debug_compile(1, rulename
);
417 /* check traditional targets $(<) and sources $(>) */
418 if (!rule
->actions
&& !rule
->procedure
) printf("warning: unknown rule %s\n", rule
->name
);
419 /* if this rule will be executed for updating the targets then construct the action for make() */
424 /* the action is associated with this instance of this rule */
425 action
= (ACTION
*)malloc(sizeof(ACTION
));
426 memset((char *)action
, '\0', sizeof(*action
));
428 action
->targets
= targetlist((TARGETS
*)0, lol_get(args
, 0));
429 action
->sources
= targetlist((TARGETS
*)0, lol_get(args
, 1));
430 /* append this action to the actions of each target */
431 for (t
= action
->targets
; t
; t
= t
->next
) t
->target
->actions
= actionlist(t
->target
->actions
, action
);
433 /* now recursively compile any parse tree associated with this rule */
434 if (rule
->procedure
) {
435 PARSE
*parse
= rule
->procedure
;
441 /* build parameters as local vars */
442 for (l
= rule
->params
, i
= 0; l
; l
= l
->next
, i
++) s
= addsettings(s
, 0, l
->string
, list_copy(L0
, lol_get(args
, i
)));
444 /* bring in local params */
445 /* refer/free to ensure rule not freed during use */
448 result
= list_append(result
, (*parse
->func
)(parse
, args
, &jmp
));
453 if (DEBUG_COMPILE
) debug_compile(-1, 0);
459 * compile_rules() - compile a chain of rules
461 * parse->left single rule
462 * parse->right more compile_rules() by right-recursion
464 LIST
*compile_rules (PARSE
*parse
, LOL
*args
, int *jmp
) {
465 /* ignore result from first statement; return the 2nd */
466 /* optimize recursion on the right by looping */
469 while (*jmp
== JMP_NONE
&& parse
->func
== compile_rules
) {
471 result
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
472 parse
= parse
->right
;
474 if (*jmp
== JMP_NONE
) {
476 result
= (*parse
->func
)(parse
, args
, jmp
);
483 * compile_set() - compile the "set variable" statement
485 * parse->left variable names
486 * parse->right variable values
487 * parse->num VAR_SET/APPEND/DEFAULT
489 LIST
*compile_set (PARSE
*parse
, LOL
*args
, int *jmp
) {
490 LIST
*nt
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
491 LIST
*ns
= (*parse
->right
->func
)(parse
->right
, args
, jmp
);
495 debug_compile(0, "set");
497 printf(" %s ", set_names
[parse
->num
]);
501 /* call var_set to set variable */
502 /* var_set keeps ns, so need to copy it */
503 for (l
= nt
; l
; l
= list_next(l
)) var_set(l
->string
, list_copy(L0
, ns
), parse
->num
);
510 * compile_setcomp() - support for `rule` - save parse tree
512 * parse->string rule name
513 * parse->left list of argument names
514 * parse->right rules for rule
516 LIST
*compile_setcomp (PARSE
*parse
, LOL
*args
, int *jmp
) {
517 RULE
*rule
= bindrule(parse
->string
);
521 /* build param list */
522 for (p
= parse
->left
; p
; p
= p
->left
) params
= list_new(params
, p
->string
, 1);
524 debug_compile(0, "rule");
525 printf("%s ", parse
->string
);
529 /* free old one, if present */
530 if (rule
->procedure
) parse_free(rule
->procedure
);
531 if (rule
->params
) list_free(rule
->params
);
532 rule
->procedure
= parse
->right
;
533 rule
->params
= params
;
534 /* we now own this parse tree */
535 /* don't let parse_free() release it */
536 parse_refer(parse
->right
);
542 * compile_setexec() - support for `actions` - save execution string
544 * parse->string rule name
545 * parse->string1 OS command string
547 * parse->left `bind` variables
549 * Note that the parse flags (as defined in compile.h) are transfered
550 * directly to the rule flags (as defined in rules.h).
552 LIST
*compile_setexec (PARSE
*parse
, LOL
*args
, int *jmp
) {
553 RULE
*rule
= bindrule(parse
->string
);
554 LIST
*bindlist
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
556 /* free old one, if present */
558 freestr(rule
->actions
);
559 list_free(rule
->bindlist
);
561 rule
->actions
= copystr(parse
->string1
);
562 rule
->bindlist
= bindlist
;
563 rule
->flags
= parse
->num
;
569 * compile_settings() - compile the "on =" (set variable on exec) statement
571 * parse->left variable names
572 * parse->right target name
573 * parse->third variable value
574 * parse->num VAR_SET/APPEND/DEFAULT
576 LIST
*compile_settings (PARSE
*parse
, LOL
*args
, int *jmp
) {
577 LIST
*nt
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
578 LIST
*ns
= (*parse
->third
->func
)(parse
->third
, args
, jmp
);
579 LIST
*targets
= (*parse
->right
->func
)(parse
->right
, args
, jmp
);
583 debug_compile(0, "set");
587 printf(" %s ", set_names
[parse
->num
]);
591 /* call addsettings to save variable setting addsettings keeps ns, so need to copy it */
592 /* pass append flag to addsettings() */
593 for (ts
= targets
; ts
; ts
= list_next(ts
)) {
594 TARGET
*t
= bindtarget(ts
->string
);
597 for (l
= nt
; l
; l
= list_next(l
)) {
598 t
->settings
= addsettings(t
->settings
, parse
->num
, l
->string
, list_copy((LIST
*)0, ns
));
608 * compile_switch() - compile 'switch' rule
610 * parse->left switch value (only 1st used)
613 * cases->left 1st case
614 * cases->right next cases
616 * case->string argument to match
617 * case->left parse tree to execute
619 LIST
*compile_switch (PARSE
*parse
, LOL
*args
, int *jmp
) {
620 LIST
*nt
= (*parse
->left
->func
)(parse
->left
, args
, jmp
);
624 debug_compile(0, "switch");
628 /* step through cases */
629 for (parse
= parse
->right
; parse
; parse
= parse
->right
) {
630 if (!glob( parse
->left
->string
, nt
?nt
->string
:"")) {
631 /* get and exec parse tree for this case */
632 parse
= parse
->left
->left
;
633 result
= (*parse
->func
)(parse
, args
, jmp
);
643 * compile_while() - compile 'while' rule
645 * parse->left condition tree
646 * parse->right execution tree
648 LIST
*compile_while (PARSE
*p
, LOL
*args
, int *jmp
) {
652 /* returns the value from the last execution of the block */
653 while ((*jmp
== JMP_NONE
) && (l
= (*p
->left
->func
)(p
->left
, args
, jmp
))) {
654 /* always toss while's expression */
656 /* keep only last result */
658 result
= (*p
->right
->func
)(p
->right
, args
, jmp
);
660 if (*jmp
== JMP_CONTINUE
) *jmp
= JMP_NONE
;
662 /* here by break/continue? */
663 if (*jmp
== JMP_BREAK
|| *jmp
== JMP_CONTINUE
) *jmp
= JMP_NONE
;
664 /* returns result of last loop */
670 * debug_compile() - printf with indent to show rule expansion.
672 static void debug_compile (int which
, const char *s
) {
673 static int level
= 0;
674 static char indent
[36] = ">>>>|>>>>|>>>>|>>>>|>>>>|>>>>|>>>>|";
675 int i
= ((1+level
)*2)%35;
677 if (which
>= 0) printf("%*.*s ", i
, i
, indent
);
678 if (s
) printf("%s ", s
);