src/ast.mli

   1 (* Goalfile Abstract Syntax Tree
   2  * Copyright (C) 2019 Richard W.M. Jones
   3  * Copyright (C) 2019 Red Hat Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  18  *)
  19
  20 module StringMap : sig
  21   type key = string
  22   type 'a t
  23   val empty: 'a t
  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
  29 end
  30
  31 (** An environment is a set of variable and goal definitions, mapping
  32     variable or goal name -> expression. *)
  33 type env = expr StringMap.t
  34 and pattern =
  35   (** match tactic such as file ("filename") *)
  36   | PTactic of id * substs list
  37   (** match named variable, which must be a string or list *)
  38   | PVar of id
  39 and expr =
  40   (** goal (params) = patterns : exprs = code *)
  41   | EGoal of goal
  42   (** goalname (params), tactic (params) etc. *)
  43   | ECall of id * expr list
  44   (** variable *)
  45   | EVar of id
  46   (** list *)
  47   | EList of expr list
  48   (** string with %-substitutions *)
  49   | ESubsts of substs
  50   (** constant expression, such as a plain string, int, boolean, etc. *)
  51   | EConstant of constant
  52 and constant =
  53   | CString of string
  54 and goal = id list * pattern list * expr list * code option
  55 and id = string
  56 and code = substs
  57 and substs = subst list
  58 and subst =
  59   (** String literal part. *)
  60   | SString of string
  61   (** %-substitution. *)
  62   | SVar of id
  63
  64 (** This is used for incrementally building Ast.substs in the parser. *)
  65 module Substs : sig
  66   type t
  67   val create : unit -> t
  68   val get : t -> substs
  69   val add_char : t -> char -> unit
  70   val add_string : t -> string -> unit
  71   val add_var : t -> string -> unit
  72 end
  73
  74 val print_env : out_channel -> env -> unit