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 (** Similar to {!substitute} except this is used where we will
  31     pass the result immediately to the shell to execute.  Variables
  32     are substituted with shell quoted strings.  Raises [Failure _]
  33     on error. *)
  34 val to_shell_script : Ast.env -> Ast.loc -> Ast.substs -> string
  35
  36 (** Evaluate a goal argument.  This substitutes any variables found,
  37     and recursively calls functions. *)
  38 val evaluate_goal_arg : Ast.env -> Ast.expr -> Ast.expr