1 (* Goalfile Abstract Syntax Tree
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.
26 include Map.Make (String)
29 List.fold_left (fun env (k, v) -> add k v env) env (bindings env')
32 type loc = position * position
33 let noloc = dummy_pos, dummy_pos
35 let string_loc () loc =
37 sprintf "%s:%d:%d" pos.pos_fname pos.pos_lnum (pos.pos_cnum - pos.pos_bol)
38 let print_loc fp loc =
39 fprintf fp "%s" (string_loc () loc)
43 | PTactic of loc * id * substs list
46 | ETactic of loc * tactic
47 | ECallGoal of loc * id * expr list
48 | ECallTactic of loc * id * expr list
50 | EList of loc * expr list
51 | ESubsts of loc * substs
52 | EConstant of loc * constant
55 and goal = param_decl list * pattern list * expr list * code option
56 and tactic = param_decl list * code
60 and substs = subst list
65 let getvar env loc name =
68 failwithf "%a: variable ‘%s’ not found" string_loc loc name
70 let getgoal env loc name =
74 failwithf "%a: goal ‘%s’ not found" string_loc loc name in
77 | EGoal (loc, goal) -> goal
79 failwithf "%a: tried to call ‘%s’ which is not a goal"
80 string_loc loc name in
83 let gettactic env loc name =
84 assert (name.[0] = '*');
88 failwithf "%a: tactic ‘%s’ not found" string_loc loc name in
91 | ETactic (loc, tactic) -> tactic
93 failwithf "%a: tried to call ‘%s’ which is not a tactic"
94 string_loc loc name in
97 let rec to_constant env = function
98 | EConstant (loc, c) -> c
100 | EVar (loc, name) ->
101 let expr = getvar env loc name in
104 | ESubsts (loc, str) ->
105 CString (substitute env loc str)
108 failwithf "%a: list found where constant expression expected"
111 | ECallGoal (loc, name, _) ->
112 failwithf "%a: cannot use goal ‘%s’ in constant expression"
115 | ECallTactic (loc, name, _) ->
116 failwithf "%a: cannot use tactic ‘%s’ in constant expression"
120 failwithf "%a: cannot use goal in constant expression"
123 | ETactic (loc, _) ->
124 failwithf "%a: cannot use tactic in constant expression"
127 and substitute env loc substs =
128 let b = Buffer.create 13 in
131 | SString s -> Buffer.add_string b s
133 let expr = getvar env loc name in
134 match to_constant env expr with
135 | CString s -> Buffer.add_string b s
139 let rec to_shell_script env loc substs =
140 let b = Buffer.create 13 in
143 | SString s -> Buffer.add_string b s
145 let expr = getvar env loc name in
146 let s = expr_to_shell_string env expr in
147 Buffer.add_string b s
151 and expr_to_shell_string env = function
152 | EConstant (loc, CString s) -> Filename.quote s
154 | EVar (loc, name) ->
155 let expr = getvar env loc name in
156 expr_to_shell_string env expr
158 | ESubsts (loc, str) ->
159 Filename.quote (substitute env loc str)
161 | EList (loc, exprs) ->
162 let strs = List.map (expr_to_shell_string env) exprs in
163 (* These are shell quoted so we can just concat them with space. *)
164 String.concat " " strs
166 | ECallGoal (loc, name, _) ->
167 failwithf "%a: cannot use goal ‘%s’ in shell expansion"
170 (* Tactics expand to the first parameter. *)
171 | ECallTactic (loc, _, []) -> Filename.quote ""
172 | ECallTactic (loc, _, (arg :: _)) -> expr_to_shell_string env arg
175 failwithf "%a: cannot use goal in shell expansion"
178 | ETactic (loc, _) ->
179 failwithf "%a: cannot use tactic in shell expansion"
182 module Substs = struct
184 mutable elems : subst list; (* built in reverse order *)
185 curr : Buffer.t; (* current string *)
188 let create () = { elems = []; curr = Buffer.create 13 }
191 if Buffer.length t.curr > 0 then
192 t.elems <- SString (Buffer.contents t.curr) :: t.elems;
195 let get t = finalize t; List.rev t.elems
197 let add_char { curr } = Buffer.add_char curr
198 let add_string { curr} = Buffer.add_string curr
199 let add_var t id = finalize t; t.elems <- SVar id :: t.elems
203 : out_channel -> (out_channel -> 'a -> unit) -> 'a list -> unit =
205 let comma = ref false in
208 if !comma then fprintf fp ", ";
213 let rec string_env () env =
214 let env = Env.bindings env in
215 String.concat "" (List.map (string_def ()) env)
217 and print_env fp env = output_string fp (string_env () env)
219 and string_def () (name, expr) =
221 | EGoal (loc, goal) -> string_goal () (Some name, goal) ^ "\n"
222 | ETactic (loc, tactic) -> string_tactic () (Some name, tactic) ^ "\n"
223 | expr -> sprintf "let %s = %a\n" name string_expr expr;
225 and print_def fp name expr = output_string fp (string_def () (name, expr))
227 and string_goal () (name, (param_decls, patterns, exprs, code)) =
228 sprintf "goal%s (%s) = %s : %s%s"
229 (match name with None -> "" | Some name -> " " ^ name)
230 (String.concat ", " (List.map (string_param_decl ()) param_decls))
231 (String.concat ", " (List.map (string_pattern ()) patterns))
232 (String.concat ", " (List.map (string_expr ()) exprs))
233 (match code with None -> "" | Some code -> " = { ... }")
235 and string_tactic () (name, (param_decls, code)) =
236 sprintf "tactic%s (%s) = { ... }"
237 (match name with None -> "" | Some name -> " " ^ name)
238 (String.concat ", " (List.map (string_param_decl ()) param_decls))
240 and string_param_decl () name = name
242 and string_pattern () = function
243 | PTactic (loc, name, params) ->
244 sprintf "%s (%s)" name (String.concat ", "
245 (List.map (string_substs ()) params))
247 and print_pattern fp p = output_string fp (string_pattern () p)
249 and string_expr () = function
250 | EGoal (loc, goal) -> string_goal () (None, goal)
251 | ETactic (loc, goal) -> string_tactic () (None, goal)
252 | ECallGoal (loc, name, params) ->
254 name (String.concat ", " (List.map (string_expr ()) params))
255 | ECallTactic (loc, name, params) ->
257 name (String.concat ", " (List.map (string_expr ()) params))
258 | EVar (loc, var) -> var
260 sprintf "[%s]" (String.concat ", " (List.map (string_expr ()) xs))
261 | ESubsts (loc, s) -> string_substs () s
262 | EConstant (loc, c) -> string_constant () c
264 and print_expr fp expr = output_string fp (string_expr () expr)
266 and string_constant () = function
267 | CString s -> sprintf "%S" s
269 and print_constant fp c = output_string fp (string_constant () c)
271 and print_id = output_string
273 and string_substs () ss =
277 | SString s -> sprintf "%S" s
280 (String.concat "+" ss)
282 and print_substs fp ss = output_string fp (string_substs () ss)
284 and print_code fp xs =
287 | SString s -> fprintf fp "%s" s
288 | SVar id -> fprintf fp "%%%s" id