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.
24 val add: key -> 'a -> 'a t -> 'a t
25 val find: key -> 'a t -> 'a
26 val fold: (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
27 val filter: (key -> 'a -> bool) -> 'a t -> 'a t
28 val bindings: 'a t -> (key * 'a) list
31 (** Location where we parsed from $loc = $startpos, $endpos *)
32 type loc = Lexing.position * Lexing.position
34 val print_loc : out_channel -> loc -> unit
35 val string_loc : unit -> loc -> string
37 (** An environment is a set of variable and goal definitions, mapping
38 variable or goal name -> expression. *)
41 (** match tactic such as *file ("filename") *)
42 | PTactic of loc * id * substs list
43 (** match named variable, which must be a string, ETactic or
47 (** goal (params) = patterns : exprs = code *)
49 (** goalname (params) etc. *)
50 | ECall of loc * id * expr list
51 (** *tactic (params) etc. *)
52 | ETactic of loc * id * expr list
53 (** variable, or goal call with no parameters *)
56 | EList of loc * expr list
57 (** string with %-substitutions *)
58 | ESubsts of loc * substs
59 (** constant expression, such as a plain string, int, boolean, etc. *)
60 | EConstant of loc * constant
63 and goal = param_decl list * pattern list * expr list * code option
64 (** Goal parameter is the parameter name and an optional default value. *)
68 and substs = subst list
70 (** String literal part. *)
72 (** %-substitution. *)
75 (** Look up a variable in the environment. Raise [Failure _]
77 val getvar : env -> loc -> id -> expr
79 (** Look up a goal in the environment. Raise [Failure _] if not
80 found or if the named variable is not a goal. *)
81 val getgoal : env -> loc -> id -> goal
83 (** Take any expression and simplify it down to a constant.
84 If the expression cannot be simplified then this raises
86 val to_constant : env -> expr -> constant
88 (** Take a substitution list and try to turn it into a simple
89 string by evaluating every variable. If not possible this
90 raises [Failure _]. *)
91 val substitute : env -> loc -> substs -> string
93 (** Similar to {!substitute} except this is used where we will
94 pass the result immediately to the shell to execute. Variables
95 are substituted with shell quoted strings. Raises [Failure _]
97 val to_shell_script : env -> loc -> substs -> string
99 (** This is used for incrementally building Ast.substs in the parser. *)
102 val create : unit -> t
103 val get : t -> substs
104 val add_char : t -> char -> unit
105 val add_string : t -> string -> unit
106 val add_var : t -> string -> unit
109 (** Print all definitions in an environment. *)
110 val print_env : out_channel -> env -> unit
112 (** %a formatters. *)
113 val string_pattern : unit -> pattern -> string
114 val string_expr : unit -> expr -> string