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.
20 module StringMap : sig
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. *)
39 type env = expr StringMap.t
41 (** match tactic such as file ("filename") *)
42 | PTactic of loc * id * substs list
43 (** match named variable, which must be a string or list *)
46 (** goal (params) = patterns : exprs = code *)
48 (** goalname (params), tactic (params) etc. *)
49 | ECall of loc * id * expr list
53 | EList of loc * expr list
54 (** string with %-substitutions *)
55 | ESubsts of loc * substs
56 (** constant expression, such as a plain string, int, boolean, etc. *)
57 | EConstant of loc * constant
60 and goal = id list * pattern list * expr list * code option
63 and substs = subst list
65 (** String literal part. *)
67 (** %-substitution. *)
70 (** This is used for incrementally building Ast.substs in the parser. *)
73 val create : unit -> t
75 val add_char : t -> char -> unit
76 val add_string : t -> string -> unit
77 val add_var : t -> string -> unit
80 val print_env : out_channel -> env -> unit