src/eval.mli

   1 (* Goalfile evaluation
   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 (** Take any expression and simplify it down to a constant.
  21     If the expression cannot be simplified then this raises
  22     [Failure _]. *)
  23 val to_constant : Ast.env -> Ast.expr -> Ast.constant
  24
  25 (** Take a substitution list and try to turn it into a simple
  26     string by evaluating every variable.  If not possible this
  27     raises [Failure _]. *)
  28 val substitute : Ast.env -> Ast.loc -> Ast.substs -> string
  29
  30 (** Run a code section.  Returns the exit code.
  31     Raises [Failure _] on error. *)
  32 val run_code : Ast.env -> Ast.loc -> Ast.code -> int
  33
  34 (** Run a code section.  Returns the exit code and the full stdout
  35     as a string.  Raises [Failure _] on error. *)
  36 val run_code_to_string : Ast.env -> Ast.loc -> Ast.code -> int * string
  37
  38 (** Run a code section.  Returns the exit code and the full stdout
  39     as a list of strings.  Raises [Failure _] on error. *)
  40 val run_code_to_string_list : Ast.env -> Ast.loc -> Ast.code ->
  41                               int * string list
  42
  43 (** Evaluate a goal argument.  This substitutes any variables found,
  44     and recursively calls functions. *)
  45 val evaluate_goal_arg : Ast.env -> Ast.expr -> Ast.expr
  46
  47 (* Call a function. *)
  48 val call_function : Ast.env -> Ast.loc -> Ast.id -> Ast.expr list -> Ast.func ->
  49                     Ast.expr