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
42 | ECall of loc * id * expr list
43 | ETactic of loc * id * expr list
45 | EList of loc * expr list
46 | ESubsts of loc * substs
47 | EConstant of loc * constant
50 and goal = param_decl list * pattern list * expr list * code option
54 and substs = subst list
59 let getvar env loc name =
62 failwithf "%a: variable ‘%s’ not found" string_loc loc name
64 let getgoal env loc name =
68 failwithf "%a: goal ‘%s’ not found" string_loc loc name in
71 | EGoal (loc, goal) -> goal
73 failwithf "%a: tried to call ‘%s’ which is not a goal"
74 string_loc loc name in
77 let rec to_constant env = function
78 | EConstant (loc, c) -> c
81 let expr = getvar env loc name in
84 | ESubsts (loc, str) ->
85 CString (substitute env loc str)
88 failwithf "%a: list found where constant expression expected"
91 | ECall (loc, name, _) ->
92 failwithf "%a: cannot use goal ‘%s’ in constant expression"
95 | ETactic (loc, name, _) ->
96 failwithf "%a: cannot use tactic ‘*%s’ in constant expression"
100 failwithf "%a: cannot use goal in constant expression"
103 and substitute env loc substs =
104 let b = Buffer.create 13 in
107 | SString s -> Buffer.add_string b s
109 let expr = getvar env loc name in
110 match to_constant env expr with
111 | CString s -> Buffer.add_string b s
115 let rec to_shell_script env loc substs =
116 let b = Buffer.create 13 in
119 | SString s -> Buffer.add_string b s
121 let expr = getvar env loc name in
122 let s = expr_to_shell_string env expr in
123 Buffer.add_string b s
127 and expr_to_shell_string env = function
128 | EConstant (loc, CString s) -> Filename.quote s
130 | EVar (loc, name) ->
131 let expr = getvar env loc name in
132 expr_to_shell_string env expr
134 | ESubsts (loc, str) ->
135 Filename.quote (substitute env loc str)
137 | EList (loc, exprs) ->
138 let strs = List.map (expr_to_shell_string env) exprs in
139 (* These are shell quoted so we can just concat them with space. *)
140 String.concat " " strs
142 | ECall (loc, name, _) ->
143 failwithf "%a: cannot use goal ‘%s’ in shell expansion"
146 (* Tactics expand to the first parameter. *)
147 | ETactic (loc, _, []) -> Filename.quote ""
148 | ETactic (loc, _, (arg :: _)) -> expr_to_shell_string env arg
151 failwithf "%a: cannot use goal in shell expansion"
154 module Substs = struct
156 mutable elems : subst list; (* built in reverse order *)
157 curr : Buffer.t; (* current string *)
160 let create () = { elems = []; curr = Buffer.create 13 }
163 if Buffer.length t.curr > 0 then
164 t.elems <- SString (Buffer.contents t.curr) :: t.elems;
167 let get t = finalize t; List.rev t.elems
169 let add_char { curr } = Buffer.add_char curr
170 let add_string { curr} = Buffer.add_string curr
171 let add_var t id = finalize t; t.elems <- SVar id :: t.elems
175 : out_channel -> (out_channel -> 'a -> unit) -> 'a list -> unit =
177 let comma = ref false in
180 if !comma then fprintf fp ", ";
185 let rec string_env () env =
186 let env = Env.bindings env in
187 String.concat "" (List.map (string_def ()) env)
189 and print_env fp env = output_string fp (string_env () env)
191 and string_def () (name, expr) =
193 | EGoal (loc, goal) -> string_goal () (Some name, goal) ^ "\n"
194 | expr -> sprintf "let %s = %a\n" name string_expr expr;
196 and print_def fp name expr = output_string fp (string_def () (name, expr))
198 and string_goal () (name, (param_decls, patterns, exprs, code)) =
199 sprintf "goal%s (%s) = %s : %s%s"
200 (match name with None -> "" | Some name -> " " ^ name)
201 (String.concat ", " (List.map (string_param_decl ()) param_decls))
202 (String.concat ", " (List.map (string_pattern ()) patterns))
203 (String.concat ", " (List.map (string_expr ()) exprs))
204 (match code with None -> "" | Some code -> " = { ... }")
206 and string_param_decl () name = name
208 and string_pattern () = function
209 | PTactic (loc, name, params) ->
210 sprintf "*%s (%s)" name (String.concat ", "
211 (List.map (string_substs ()) params));
212 | PVar (loc, id) -> id
214 and print_pattern fp p = output_string fp (string_pattern () p)
216 and string_expr () = function
217 | EGoal (loc, goal) -> string_goal () (None, goal)
218 | ECall (loc, name, params) ->
220 name (String.concat ", " (List.map (string_expr ()) params))
221 | ETactic (loc, name, params) ->
223 name (String.concat ", " (List.map (string_expr ()) params))
224 | EVar (loc, var) -> var
226 sprintf "[%s]" (String.concat ", " (List.map (string_expr ()) xs))
227 | ESubsts (loc, s) -> string_substs () s
228 | EConstant (loc, c) -> string_constant () c
230 and print_expr fp expr = output_string fp (string_expr () expr)
232 and string_constant () = function
233 | CString s -> sprintf "%S" s
235 and print_constant fp c = output_string fp (string_constant () c)
237 and print_id = output_string
239 and string_substs () ss =
243 | SString s -> sprintf "%S" s
246 (String.concat "+" ss)
248 and print_substs fp ss = output_string fp (string_substs () ss)
250 and print_code fp xs =
253 | SString s -> fprintf fp "%s" s
254 | SVar id -> fprintf fp "%%%s" id