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 end
  26
  27 (** An environment is a set of variable and goal definitions, mapping
  28     variable or goal name -> expression. *)
  29 type env = expr StringMap.t
  30 and pattern =
  31   (** match tactic such as file ("filename") *)
  32   | PTactic of id * substs list
  33   (** match named variable, which must be a string or list *)
  34   | PVarSubst of id
  35 and expr =
  36   (** goal (params) = patterns : exprs = code *)
  37   | EGoal of goal
  38   (** goalname (params), tactic (params) etc. *)
  39   | ECall of id * expr list
  40   (** variable *)
  41   | EVar of id
  42   (** list *)
  43   | EList of expr list
  44   (** string with %-substitutions *)
  45   | ESubsts of substs
  46   (** string with no substitutions *)
  47   | EString of string
  48 and goal = id list * pattern list * expr list * code option
  49 and id = string
  50 and code = substs
  51 and substs = subst list
  52 and subst =
  53   (** String literal part. *)
  54   | SString of string
  55   (** %-substitution. *)
  56   | SVar of id
  57
  58 (** This is used for incrementally building Ast.substs in the parser. *)
  59 module Substs : sig
  60   type t
  61   val create : unit -> t
  62   val get : t -> substs
  63   val add_char : t -> char -> unit
  64   val add_string : t -> string -> unit
  65   val add_var : t -> string -> unit
  66 end
  67
  68 val print_env : out_channel -> env -> unit