2 * Copyright (C) 2019 Richard W.M. Jones
3 * Copyright (C) 2019 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 let rec evaluate_targets env exprs =
25 List.iter (evaluate_target env) exprs
27 and evaluate_target env = function
28 | Ast.EGoal _ -> assert false
31 | Ast.ECall (loc, name, args) ->
32 let goal = Ast.getgoal env loc name in
33 run_goal env loc name args goal
35 | Ast.ETactic (loc, name, args) ->
36 (* All parameters of tactics must be simple constant expressions
37 * (strings, in future booleans, numbers, etc).
39 let args = List.map (Ast.to_constant env) args in
40 run_tactic env loc name args
42 (* Look up the variable and substitute it. *)
43 | Ast.EVar (loc, name) ->
44 let expr = Ast.getvar env loc name in
45 evaluate_target env expr
47 (* Lists are inlined when found as a target. *)
48 | Ast.EList (loc, exprs) ->
49 evaluate_targets env exprs
51 (* A string (with or without substitutions) implies *file(filename). *)
52 | Ast.ESubsts (loc, str) ->
53 let str = Ast.substitute env loc str in
54 run_tactic env loc "file" [Ast.CString str]
56 | Ast.EConstant (loc, c) ->
57 run_tactic env loc "file" [c]
59 (* Run a goal by name. *)
60 and run_goal env loc name args (params, patterns, deps, code) =
61 (* Create a new environment which maps the parameter names to
66 try List.combine params args
67 with Invalid_argument _ ->
68 failwithf "%a: calling goal ‘%s’ with wrong number of arguments"
69 Ast.string_loc loc name in
70 List.fold_left (fun env (k, v) -> Ast.Env.add k v env) env params in
72 (* Check all dependencies have been updated. *)
73 evaluate_targets env deps;
75 (* Check if any target (ie. pattern) needs to be rebuilt. *)
76 let rebuild = List.exists (needs_rebuild env loc deps) patterns in
79 (* Run the code (if any). *)
83 (* Add some standard variables to the environment. *)
84 let expr_of_substs s = Ast.ESubsts (Ast.noloc, s) in
85 let expr_of_pattern = function
86 | Ast.PTactic (loc, tactic, targs) ->
87 Ast.ETactic (loc, tactic, List.map expr_of_substs targs)
89 let pexprs = List.map expr_of_pattern patterns in
90 let env = Ast.Env.add "@" (Ast.EList (Ast.noloc, pexprs)) env in
91 let env = Ast.Env.add "<" (Ast.EList (Ast.noloc, deps)) env in
95 | d :: _ -> Ast.Env.add "^" d env in
96 let code = Ast.to_shell_script env loc code in
97 let code = "set -e\nset -x\n\n" ^ code in
98 let r = Sys.command code in
100 eprintf "*** goal ‘%s’ failed with exit code %d\n" name r;
105 (* Check all targets were updated (else it's an error). *)
106 let pattern_still_needs_rebuild =
107 try Some (List.find (needs_rebuild env loc deps) patterns)
108 with Not_found -> None in
109 match pattern_still_needs_rebuild with
112 failwithf "%a: goal ‘%s’ ran successfully but it did not rebuild %a"
115 Ast.string_pattern pattern
118 (* Return whether the target (pattern) needs to be rebuilt. *)
119 and needs_rebuild env loc deps pattern =
121 | Ast.PTactic (loc, tactic, targs) ->
122 (* Resolve the targs down to constants. *)
123 let targs = List.map ((* XXX Ast.to_shell_script *)
124 Ast.substitute env loc) targs in
125 (* XXX Look up the tactic.
126 * We would do that, but for now hard code the *file tactic. XXX
128 assert (tactic = "file");
129 assert (List.length targs = 1);
130 let targ = List.hd targs in
131 not (Sys.file_exists targ)
133 (* Find the goal which matches the given tactic and run it.
134 * cargs is a list of parameters (all constants).
136 and run_tactic env loc tactic cargs =
137 (* Find all goals in the environment. Returns a list of (name, goal). *)
139 let env = Ast.Env.bindings env in
142 | name, Ast.EGoal (loc, goal) -> Some (name, goal)
145 (* Find all patterns. Returns a list of (pattern, name, goal). *)
146 let patterns : (Ast.pattern * Ast.id * Ast.goal) list =
148 (List.map (fun (name, ((_, patterns, _, _) as goal)) ->
149 List.map (fun pattern -> (pattern, name, goal)) patterns) goals) in
151 (* Find any patterns (ie. tactics) which match the one we
152 * are searching for. This returns a binding for the goal args,
153 * so we end up with a list of (pattern, name, goal, args).
155 let patterns : (Ast.pattern * Ast.id * Ast.goal * Ast.expr list) list =
157 fun (pattern, name, ((params, _, _, _) as goal)) ->
158 match matching_pattern env loc tactic cargs pattern params with
160 | Some args -> Some (pattern, name, goal, args)
164 | [_, name, goal, args] ->
165 run_goal env loc name args goal
168 (* There's no matching goal, but we don't need one if
169 * the tactic doesn't need to be rebuilt.
171 let targs = List.map (function Ast.CString s -> [Ast.SString s]) cargs in
172 let p = Ast.PTactic (loc, tactic, targs) in
173 if needs_rebuild env loc [] p then (
174 let t = Ast.ETactic (loc, tactic,
175 List.map (fun c -> Ast.EConstant (loc, c))
177 failwithf "%a: don't know how to build %a"
178 Ast.string_loc loc Ast.string_expr t
182 (* If there are multiple matching goals, then assuming the goals
183 * are different we must pick the one which was defined last in
184 * the file. However we don't do that right now. XXX
186 assert false (* TODO! *)
188 (* Test if pattern matches *tactic(cargs). If it does
189 * then we return Some args where args is the arguments that must
190 * be passed to the matching goal. The params parameter is
191 * the names of the parameters of that goal.
193 and matching_pattern env loc tactic cargs pattern params =
195 | Ast.PTactic (loc, ttactic, targs)
196 when tactic <> ttactic ||
197 List.length cargs <> List.length targs ->
198 None (* Can't possibly match if tactic name or #args is different. *)
199 | Ast.PTactic (loc, ttactic, targs) ->
200 (* Do the args match with a possible params binding? *)
201 try Some (matching_params env loc params targs cargs)
202 with Not_found -> None
204 (* Return a possible binding. For example the goal is:
205 * goal compile (name) = "%name.o": "%name.c" {}
206 * which means that params = ["name"] and targs = ["%name.o"].
208 * If we are called with cargs = ["file1.o"], we would
211 * On non-matching this raises Not_found.
213 and matching_params env loc params targs cargs =
214 (* This is going to record the resulting binding. *)
215 let res = ref Ast.Env.empty in
216 List.iter2 (matching_param env loc params res) targs cargs;
218 (* Rearrange the result into goal parameter order. Also this
219 * checks that every parameter got a binding.
223 (* Allow the Not_found exception to escape if no binding for this param. *)
224 fun param -> Ast.Env.find param res
227 (* If targ = "%name.o" and carg = "file.o" then this would set
228 * name => "file" in !res. If they don't match, raises Not_found.
230 and matching_param env loc params res targ carg =
232 | Ast.CString carg ->
233 (* Substitute any non parameters in targ from the environment. *)
237 | Ast.SString _ as s -> s
239 if not (List.mem name params) then (
241 let expr = Ast.getvar env loc name in
242 match Ast.to_constant env expr with
243 | Ast.CString s -> Ast.SString s
244 with Failure _ -> raise Not_found
250 (* Do the actual pattern matching. Any remaining SVar elements
251 * must refer to goal parameters.
253 let carg = ref carg in
254 let rec loop = function
256 (* End of targ, we must have matched all of carg. *)
257 if !carg <> "" then raise Not_found
258 | Ast.SString s :: rest ->
259 (* Does this match the first part of !carg? *)
260 let clen = String.length !carg in
261 let slen = String.length s in
262 if slen > clen || s <> String.sub !carg 0 slen then
264 (* Yes, so continue after the matching prefix. *)
265 carg := String.sub !carg slen (clen-slen);
267 | Ast.SVar name :: Ast.SString s :: rest ->
268 (* This is a goal parameter. Find s later in !carg. *)
269 let i = string_find !carg s in
270 if i = -1 then raise Not_found;
271 (* Set the binding in !res. *)
272 let r = Ast.EConstant (Ast.noloc,
273 Ast.CString (String.sub !carg 0 i)) in
274 res := Ast.Env.add name r !res;
275 (* Continue after the match. *)
276 let skip = i + String.length s in
277 carg := String.sub !carg skip (String.length !carg - skip);
279 | Ast.SVar name :: [] ->
280 (* Matches the whole remainder of the string. *)
281 let r = Ast.EConstant (Ast.noloc, Ast.CString !carg) in
282 res := Ast.Env.add name r !res
283 | Ast.SVar x :: Ast.SVar y :: _ ->
284 (* TODO! We cannot match a target like "%x%y". *)