Add Ast.to_shell_script.

[goals.git] / src / ast.mli

diff --git a/src/ast.mli b/src/ast.mli
index c7e3be4..9bb2c9a 100644 (file)
--- a/src/ast.mli
+++ b/src/ast.mli
@@ -17,7 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  *)
 
-module StringMap : sig
+module Env : sig
   type key = string
   type 'a t
   val empty: 'a t
@@ -36,11 +36,12 @@ val string_loc : unit -> loc -> string
 
 (** An environment is a set of variable and goal definitions, mapping
     variable or goal name -> expression. *)
-type env = expr StringMap.t
+type env = expr Env.t
 and pattern =
-  (** match tactic such as file ("filename") *)
+  (** match tactic such as *file ("filename") *)
   | PTactic of loc * id * substs list
-  (** match named variable, which must be a string or list *)
+  (** match named variable, which must be a string, ETactic or
+      a list of those *)
   | PVar of loc * id
 and expr =
   (** goal (params) = patterns : exprs = code *)
@@ -59,7 +60,9 @@ and expr =
   | EConstant of loc * constant
 and constant =
   | CString of string
-and goal = id list * pattern list * expr list * code option
+and goal = param_decl list * pattern list * expr list * code option
+  (** Goal parameter is the parameter name and an optional default value. *)
+and param_decl = id
 and id = string
 and code = substs
 and substs = subst list
@@ -69,6 +72,30 @@ and subst =
   (** %-substitution. *)
   | SVar of id
 
+(** Look up a variable in the environment.  Raise [Failure _]
+    if not found. *)
+val getvar : env -> loc -> id -> expr
+
+(** Look up a goal in the environment.  Raise [Failure _] if not
+    found or if the named variable is not a goal. *)
+val getgoal : env -> loc -> id -> goal
+
+(** Take any expression and simplify it down to a constant.
+    If the expression cannot be simplified then this raises
+    [Failure _]. *)
+val to_constant : env -> expr -> constant
+
+(** Take a substitution list and try to turn it into a simple
+    string by evaluating every variable.  If not possible this
+    raises [Failure _]. *)
+val substitute : env -> loc -> substs -> string
+
+(** Similar to {!substitute} except this is used where we will
+    pass the result immediately to the shell to execute.  Variables
+    are substituted with shell quoted strings.  Raises [Failure _]
+    on error. *)
+val to_shell_script : env -> loc -> substs -> string
+
 (** This is used for incrementally building Ast.substs in the parser. *)
 module Substs : sig
   type t
@@ -79,4 +106,9 @@ module Substs : sig
   val add_var : t -> string -> unit
 end
 
+(** Print all definitions in an environment. *)
 val print_env : out_channel -> env -> unit
+
+(** %a formatters. *)
+val string_pattern : unit -> pattern -> string
+val string_expr : unit -> expr -> string