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.EGoalDefn _ | Ast.ETacticDefn _ -> assert false
31 | Ast.ECallGoal (loc, name, args) ->
32 let goal = Ast.getgoal env loc name in
33 run_goal env loc name args goal
36 | Ast.ETacticConstructor (loc, name, args) ->
37 (* All parameters of tactics must be simple constant expressions
38 * (strings, in future booleans, numbers, etc).
40 let args = List.map (Ast.to_constant env) args in
41 run_tactic env loc name args
43 (* If this is a goal then it's the same as calling goal(). If not
44 * then look up the variable and substitute it.
46 | Ast.EVar (loc, name) ->
47 let expr = Ast.getvar env loc name in
49 | EGoalDefn (loc, ([], _, _, _)) ->
50 evaluate_target env (Ast.ECallGoal (loc, name, []))
52 failwithf "%a: cannot call %s() since this goal has parameters"
53 Ast.string_loc loc name
55 evaluate_target env expr
58 (* Lists are inlined when found as a target. *)
59 | Ast.EList (loc, exprs) ->
60 evaluate_targets env exprs
62 (* A string (with or without substitutions) implies *file(filename). *)
63 | Ast.ESubsts (loc, str) ->
64 let str = Ast.substitute env loc str in
65 run_tactic env loc "*file" [Ast.CString str]
67 | Ast.EConstant (loc, c) ->
68 run_tactic env loc "*file" [c]
70 (* Run a goal by name. *)
71 and run_goal env loc name args (params, patterns, deps, code) =
72 Cmdline.debug "%a: running goal %s %a"
73 Ast.string_loc loc name Ast.string_expr (Ast.EList (Ast.noloc, args));
75 (* This is the point where we evaluate the goal arguments. We must
76 * do this before creating the new environment, because variables
77 * appearing in goal arguments don't refer to goal parameters.
79 let args = List.map (evaluate_goal_arg env) args in
81 (* Create a new environment which maps the parameter names to
86 try List.combine params args
87 with Invalid_argument _ ->
88 failwithf "%a: calling goal ‘%s’ with wrong number of arguments"
89 Ast.string_loc loc name in
90 List.fold_left (fun env (k, v) -> Ast.Env.add k v env) env params in
92 (* Check all dependencies have been updated. *)
93 evaluate_targets env deps;
95 (* Check if any target (ie. pattern) needs to be rebuilt. *)
96 let rebuild = List.exists (needs_rebuild env loc deps) patterns in
99 (* Run the code (if any). *)
103 (* Add some standard variables to the environment. *)
104 let expr_of_substs s = Ast.ESubsts (Ast.noloc, s) in
105 let expr_of_pattern = function
106 | Ast.PTactic (loc, tactic, targs) ->
107 Ast.ETacticConstructor (loc, tactic, List.map expr_of_substs targs)
109 let pexprs = List.map expr_of_pattern patterns in
110 let env = Ast.Env.add "@" (Ast.EList (Ast.noloc, pexprs)) env in
111 let env = Ast.Env.add "<" (Ast.EList (Ast.noloc, deps)) env in
115 | d :: _ -> Ast.Env.add "^" d env in
116 let code = Ast.to_shell_script env loc code in
117 let code = "set -e\nset -x\n\n" ^ code in
118 let r = Sys.command code in
120 eprintf "*** goal ‘%s’ failed with exit code %d\n" name r;
125 (* Check all targets were updated (else it's an error). *)
126 let pattern_still_needs_rebuild =
127 try Some (List.find (needs_rebuild env loc deps) patterns)
128 with Not_found -> None in
129 match pattern_still_needs_rebuild with
132 failwithf "%a: goal ‘%s’ ran successfully but it did not rebuild %a"
135 Ast.string_pattern pattern
138 (* Return whether the target (pattern) needs to be rebuilt. *)
139 and needs_rebuild env loc deps pattern =
140 Cmdline.debug "%a: testing if %a needs rebuild"
141 Ast.string_loc loc Ast.string_pattern pattern;
144 | Ast.PTactic (loc, tactic, targs) ->
145 (* Look up the tactic. *)
146 let params, code = Ast.gettactic env loc tactic in
148 (* Resolve the targs down to constants. Since needs_rebuild
149 * should be called with env containing the goal params, this
150 * should substitute any parameters in the tactic arguments.
152 let targs = List.map (Ast.substitute env loc) targs in
154 List.map (fun targ ->
155 Ast.EConstant (Ast.noloc, Ast.CString targ)) targs in
157 (* Create a new environment binding parameter names
162 try List.combine params targs
163 with Invalid_argument _ ->
164 failwithf "%a: calling tactic ‘%s’ with wrong number of arguments"
165 Ast.string_loc loc tactic in
166 List.fold_left (fun env (k, v) -> Ast.Env.add k v env) env params in
168 (* Add some standard variables to the environment. *)
169 let env = Ast.Env.add "<" (Ast.EList (Ast.noloc, deps)) env in
173 | d :: _ -> Ast.Env.add "^" d env in
174 let code = Ast.to_shell_script env loc code in
175 let code = "set -e\nset -x\n\n" ^ code in
176 let r = Sys.command code in
177 if r = 99 (* means "needs rebuild" *) then true
178 else if r = 0 (* means "doesn't need rebuild" *) then false
180 eprintf "*** tactic ‘%s’ failed with exit code %d\n" tactic r;
184 (* Evaluate a goal argument. This substitutes any variables found,
185 * and recursively calls functions.
187 and evaluate_goal_arg env = function
188 | Ast.EVar (loc, name) ->
189 let expr = Ast.getvar env loc name in
190 evaluate_goal_arg env expr
192 | Ast.ESubsts (loc, str) ->
193 let str = Ast.substitute env loc str in
194 Ast.EConstant (loc, Ast.CString str)
196 | Ast.EList (loc, exprs) ->
197 Ast.EList (loc, List.map (evaluate_goal_arg env) exprs)
199 | Ast.ETacticConstructor (loc, name, exprs) ->
200 Ast.ETacticConstructor (loc, name, List.map (evaluate_goal_arg env) exprs)
202 | Ast.ECallGoal (loc, name, _) ->
203 (* Goals don't return anything so they cannot be used in
204 * goal args. Use a function instead.
206 failwithf "%a: cannot use goal ‘%s’ in goal argument"
207 Ast.string_loc loc name
211 | Ast.ETacticDefn _ as e -> e
213 (* Find the goal which matches the given tactic and run it.
214 * cargs is a list of parameters (all constants).
216 and run_tactic env loc tactic cargs =
217 Cmdline.debug "%a: running tactic %s" Ast.string_loc loc tactic;
219 (* Find all goals in the environment. Returns a list of (name, goal). *)
221 let env = Ast.Env.bindings env in
224 | name, Ast.EGoalDefn (loc, goal) -> Some (name, goal)
227 (* Find all patterns. Returns a list of (pattern, name, goal). *)
228 let patterns : (Ast.pattern * Ast.id * Ast.goal) list =
230 (List.map (fun (name, ((_, patterns, _, _) as goal)) ->
231 List.map (fun pattern -> (pattern, name, goal)) patterns) goals) in
233 (* Find any patterns (ie. tactics) which match the one we
234 * are searching for. This returns a binding for the goal args,
235 * so we end up with a list of (pattern, name, goal, args).
237 let patterns : (Ast.pattern * Ast.id * Ast.goal * Ast.expr list) list =
239 fun (pattern, name, ((params, _, _, _) as goal)) ->
240 match matching_pattern env loc tactic cargs pattern params with
242 | Some args -> Some (pattern, name, goal, args)
247 (* There's no matching goal, but we don't need one if
248 * the tactic doesn't need to be rebuilt.
250 let targs = List.map (function Ast.CString s -> [Ast.SString s]) cargs in
251 let p = Ast.PTactic (loc, tactic, targs) in
252 if needs_rebuild env loc [] p then (
253 let t = Ast.ETacticConstructor (loc, tactic,
254 List.map (fun c -> Ast.EConstant (loc, c))
256 failwithf "%a: don't know how to build %a"
257 Ast.string_loc loc Ast.string_expr t
261 (* One or more goals match. We run them all (although if
262 * one of them succeeds in rebuilding, it will cut short the rest).
265 fun (_, name, goal, args) ->
266 run_goal env loc name args goal
269 (* Test if pattern matches *tactic(cargs). If it does
270 * then we return Some args where args is the arguments that must
271 * be passed to the matching goal. The params parameter is
272 * the names of the parameters of that goal.
274 and matching_pattern env loc tactic cargs pattern params =
276 | Ast.PTactic (loc, ttactic, targs)
277 when tactic <> ttactic ||
278 List.length cargs <> List.length targs ->
279 None (* Can't possibly match if tactic name or #args is different. *)
280 | Ast.PTactic (loc, ttactic, targs) ->
281 (* Do the args match with a possible params binding? *)
282 try Some (matching_params env loc params targs cargs)
283 with Not_found -> None
285 (* Return a possible binding. For example the goal is:
286 * goal compile (name) = "%name.o": "%name.c" {}
287 * which means that params = ["name"] and targs = ["%name.o"].
289 * If we are called with cargs = ["file1.o"], we would
292 * On non-matching this raises Not_found.
294 and matching_params env loc params targs cargs =
295 (* This is going to record the resulting binding. *)
296 let res = ref Ast.Env.empty in
297 List.iter2 (matching_param env loc params res) targs cargs;
299 (* Rearrange the result into goal parameter order. Also this
300 * checks that every parameter got a binding.
304 (* Allow the Not_found exception to escape if no binding for this param. *)
305 fun param -> Ast.Env.find param res
308 (* If targ = "%name.o" and carg = "file.o" then this would set
309 * name => "file" in !res. If they don't match, raises Not_found.
311 and matching_param env loc params res targ carg =
313 | Ast.CString carg ->
314 (* Substitute any non parameters in targ from the environment. *)
318 | Ast.SString _ as s -> s
320 if not (List.mem name params) then (
322 let expr = Ast.getvar env loc name in
323 match Ast.to_constant env expr with
324 | Ast.CString s -> Ast.SString s
325 with Failure _ -> raise Not_found
331 (* Do the actual pattern matching. Any remaining SVar elements
332 * must refer to goal parameters.
334 let carg = ref carg in
335 let rec loop = function
337 (* End of targ, we must have matched all of carg. *)
338 if !carg <> "" then raise Not_found
339 | Ast.SString s :: rest ->
340 (* Does this match the first part of !carg? *)
341 let clen = String.length !carg in
342 let slen = String.length s in
343 if slen > clen || s <> String.sub !carg 0 slen then
345 (* Yes, so continue after the matching prefix. *)
346 carg := String.sub !carg slen (clen-slen);
348 | Ast.SVar name :: Ast.SString s :: rest ->
349 (* This is a goal parameter. Find s later in !carg. *)
350 let i = string_find !carg s in
351 if i = -1 then raise Not_found;
352 (* Set the binding in !res. *)
353 let r = Ast.EConstant (Ast.noloc,
354 Ast.CString (String.sub !carg 0 i)) in
355 res := Ast.Env.add name r !res;
356 (* Continue after the match. *)
357 let skip = i + String.length s in
358 carg := String.sub !carg skip (String.length !carg - skip);
360 | Ast.SVar name :: [] ->
361 (* Matches the whole remainder of the string. *)
362 let r = Ast.EConstant (Ast.noloc, Ast.CString !carg) in
363 res := Ast.Env.add name r !res
364 | Ast.SVar x :: Ast.SVar y :: _ ->
365 (* TODO! We cannot match a target like "%x%y". *)