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 type file = stmt list
  21 and stmt =
  22   (* let id = expr *)
  23   | Let of id * expr
  24   (* goal id (params) = patterns : exprs = code *)
  25   | Goal of id * id list * pattern list * expr list * code option
  26 and pattern =
  27   (* match tactic such as file ("filename") *)
  28   | PTactic of id * substs list
  29   (* match named variable, which must be a string or list *)
  30   | PVarSubst of id
  31 and expr =
  32   (* goalname (params), tactic (params) etc. *)
  33   | ECall of id * expr list
  34   (* variable *)
  35   | EVar of id
  36   (* string with %-substitutions *)
  37   | EString of substs
  38   (* list *)
  39   | EList of expr list
  40 and id = string
  41 and code = substs
  42 and substs = subst list
  43 and subst =
  44   (* String literal part. *)
  45   | SString of string
  46   (* %-substitution. *)
  47   | SVar of id
  48
  49 (* This is used for incrementally building Ast.substs in the parser. *)
  50 module Substs : sig
  51   type t
  52   val create : unit -> t
  53   val get : t -> substs
  54   val add_char : t -> char -> unit
  55   val add_string : t -> string -> unit
  56   val add_var : t -> string -> unit
  57 end
  58
  59 val print_file : out_channel -> file -> unit