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.
25 module Env = Map.Make (String)
27 type loc = position * position
28 let noloc = dummy_pos, dummy_pos
30 let string_loc () loc =
32 sprintf "%s:%d:%d" pos.pos_fname pos.pos_lnum (pos.pos_cnum - pos.pos_bol)
33 let print_loc fp loc =
34 fprintf fp "%s" (string_loc () loc)
38 | PTactic of loc * id * substs list
41 | ECall of loc * id * expr list
42 | ETactic of loc * id * expr list
44 | EList of loc * expr list
45 | ESubsts of loc * substs
46 | EConstant of loc * constant
49 and goal = param_decl list * pattern list * expr list * code option
53 and substs = subst list
58 let getvar env loc name =
61 failwithf "%a: variable ‘%s’ not found" string_loc loc name
63 let getgoal env loc name =
67 failwithf "%a: goal ‘%s’ not found" string_loc loc name in
70 | EGoal (loc, goal) -> goal
72 failwithf "%a: tried to call ‘%s’ which is not a goal"
73 string_loc loc name in
76 let rec to_constant env = function
77 | EConstant (loc, c) -> c
80 let expr = getvar env loc name in
83 | ESubsts (loc, str) ->
84 CString (substitute env loc str)
87 failwithf "%a: list found where constant expression expected"
90 | ECall (loc, name, _) ->
91 failwithf "%a: cannot use goal ‘%s’ in constant expression"
94 | ETactic (loc, name, _) ->
95 failwithf "%a: cannot use tactic ‘*%s’ in constant expression"
99 failwithf "%a: cannot use goal in constant expression"
102 and substitute env loc substs =
103 let b = Buffer.create 13 in
106 | SString s -> Buffer.add_string b s
108 let expr = getvar env loc name in
109 match to_constant env expr with
110 | CString s -> Buffer.add_string b s
114 let rec to_shell_script env loc substs =
115 let b = Buffer.create 13 in
118 | SString s -> Buffer.add_string b s
120 let expr = getvar env loc name in
121 let s = expr_to_shell_string env expr in
122 Buffer.add_string b s
126 and expr_to_shell_string env = function
127 | EConstant (loc, CString s) -> Filename.quote s
129 | EVar (loc, name) ->
130 let expr = getvar env loc name in
131 expr_to_shell_string env expr
133 | ESubsts (loc, str) ->
134 Filename.quote (substitute env loc str)
136 | EList (loc, exprs) ->
137 let strs = List.map (expr_to_shell_string env) exprs in
138 (* These are shell quoted so we can just concat them with space. *)
139 String.concat " " strs
141 | ECall (loc, name, _) ->
142 failwithf "%a: cannot use goal ‘%s’ in shell expansion"
145 (* Tactics expand to the first parameter. *)
146 | ETactic (loc, _, []) -> Filename.quote ""
147 | ETactic (loc, _, (arg :: _)) -> expr_to_shell_string env arg
150 failwithf "%a: cannot use goal in shell expansion"
153 module Substs = struct
155 mutable elems : subst list; (* built in reverse order *)
156 curr : Buffer.t; (* current string *)
159 let create () = { elems = []; curr = Buffer.create 13 }
162 if Buffer.length t.curr > 0 then
163 t.elems <- SString (Buffer.contents t.curr) :: t.elems;
166 let get t = finalize t; List.rev t.elems
168 let add_char { curr } = Buffer.add_char curr
169 let add_string { curr} = Buffer.add_string curr
170 let add_var t id = finalize t; t.elems <- SVar id :: t.elems
174 : out_channel -> (out_channel -> 'a -> unit) -> 'a list -> unit =
176 let comma = ref false in
179 if !comma then fprintf fp ", ";
184 let rec string_env () env =
185 let env = Env.bindings env in
186 String.concat "" (List.map (string_def ()) env)
188 and print_env fp env = output_string fp (string_env () env)
190 and string_def () (name, expr) =
192 | EGoal (loc, goal) -> string_goal () (Some name, goal) ^ "\n"
193 | expr -> sprintf "let %s = %a\n" name string_expr expr;
195 and print_def fp name expr = output_string fp (string_def () (name, expr))
197 and string_goal () (name, (param_decls, patterns, exprs, code)) =
198 sprintf "goal%s (%s) = %s : %s%s"
199 (match name with None -> "" | Some name -> " " ^ name)
200 (String.concat ", " (List.map (string_param_decl ()) param_decls))
201 (String.concat ", " (List.map (string_pattern ()) patterns))
202 (String.concat ", " (List.map (string_expr ()) exprs))
203 (match code with None -> "" | Some code -> " = { ... }")
205 and string_param_decl () name = name
207 and string_pattern () = function
208 | PTactic (loc, name, params) ->
209 sprintf "*%s (%s)" name (String.concat ", "
210 (List.map (string_substs ()) params))
212 and print_pattern fp p = output_string fp (string_pattern () p)
214 and string_expr () = function
215 | EGoal (loc, goal) -> string_goal () (None, goal)
216 | ECall (loc, name, params) ->
218 name (String.concat ", " (List.map (string_expr ()) params))
219 | ETactic (loc, name, params) ->
221 name (String.concat ", " (List.map (string_expr ()) params))
222 | EVar (loc, var) -> var
224 sprintf "[%s]" (String.concat ", " (List.map (string_expr ()) xs))
225 | ESubsts (loc, s) -> string_substs () s
226 | EConstant (loc, c) -> string_constant () c
228 and print_expr fp expr = output_string fp (string_expr () expr)
230 and string_constant () = function
231 | CString s -> sprintf "%S" s
233 and print_constant fp c = output_string fp (string_constant () c)
235 and print_id = output_string
237 and string_substs () ss =
241 | SString s -> sprintf "%S" s
244 (String.concat "+" ss)
246 and print_substs fp ss = output_string fp (string_substs () ss)
248 and print_code fp xs =
251 | SString s -> fprintf fp "%s" s
252 | SVar id -> fprintf fp "%%%s" id