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
30 (* This is not the normal Map.merge function. *)
31 val merge : 'a t -> 'a t -> 'a t
34 (** Location where we parsed from $loc = $startpos, $endpos *)
35 type loc = Lexing.position * Lexing.position
37 val print_loc : out_channel -> loc -> unit
38 val string_loc : unit -> loc -> string
40 (** An environment is a set of variable and goal definitions, mapping
41 variable or goal name -> expression. *)
44 (** match tactic such as *file ("filename") *)
45 | PTactic of loc * id * substs list
47 (** goal (params) = patterns : exprs code *)
48 | EGoalDefn of loc * goal
49 (** tactic (params) = code *)
50 | ETacticDefn of loc * tactic
51 (** call goalname (params) etc. *)
52 | ECallGoal of loc * id * expr list
53 (** call *tactic (params) etc. *)
54 | ETacticCtor of loc * id * expr list
55 (** variable, or goal call with no parameters *)
58 | EList of loc * expr list
59 (** string with %-substitutions *)
60 | ESubsts of loc * substs
61 (** constant expression, such as a plain string, int, boolean, etc. *)
62 | EConstant of loc * constant
65 and goal = param_decl list * pattern list * expr list * code option
66 and tactic = param_decl list * code
67 (** Goal/tactic parameter. *)
71 and substs = subst list
73 (** String literal part. *)
75 (** %-substitution. *)
78 (** Look up a variable in the environment. Raise [Failure _]
80 val getvar : env -> loc -> id -> expr
82 (** Look up a goal in the environment. Raise [Failure _] if not
83 found or if the named variable is not a goal. *)
84 val getgoal : env -> loc -> id -> goal
86 (** Look up a tactic in the environment. Raise [Failure _] if not
87 found or if the named variable is not a tactic. *)
88 val gettactic : env -> loc -> id -> tactic
90 (** Take any expression and simplify it down to a constant.
91 If the expression cannot be simplified then this raises
93 val to_constant : env -> expr -> constant
95 (** Take a substitution list and try to turn it into a simple
96 string by evaluating every variable. If not possible this
97 raises [Failure _]. *)
98 val substitute : env -> loc -> substs -> string
100 (** Similar to {!substitute} except this is used where we will
101 pass the result immediately to the shell to execute. Variables
102 are substituted with shell quoted strings. Raises [Failure _]
104 val to_shell_script : env -> loc -> substs -> string
106 (** This is used for incrementally building Ast.substs in the parser. *)
109 val create : unit -> t
110 val get : t -> substs
111 val add_char : t -> char -> unit
112 val add_string : t -> string -> unit
113 val add_var : t -> string -> unit
116 (** %a formatters. *)
117 val print_env : out_channel -> env -> unit
118 val string_pattern : unit -> pattern -> string
119 val string_expr : unit -> expr -> string
120 val print_expr : out_channel -> expr -> unit