lib/whenexpr.mli

   1 (* whenjobs
   2  * Copyright (C) 2012 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 (** When- and every-expression definition and evaluation, variables
  20     and jobs. *)
  21
  22 type whenexpr =
  23   | Expr_unit                           (** Unit constant. *)
  24   | Expr_bool of bool                   (** A boolean constant. *)
  25   | Expr_str of string                  (** A string constant. *)
  26   | Expr_int of Big_int.big_int         (** An integer constant. *)
  27   | Expr_float of float                 (** A float constant. *)
  28   | Expr_var of string                  (** A variable name. *)
  29   | Expr_and of whenexpr * whenexpr     (** && *)
  30   | Expr_or of whenexpr * whenexpr      (** || *)
  31   | Expr_lt of whenexpr * whenexpr      (** < *)
  32   | Expr_le of whenexpr * whenexpr      (** <= *)
  33   | Expr_eq of whenexpr * whenexpr      (** == *)
  34   | Expr_ge of whenexpr * whenexpr      (** >= *)
  35   | Expr_gt of whenexpr * whenexpr      (** > *)
  36   | Expr_not of whenexpr                (** boolean not *)
  37   | Expr_add of whenexpr * whenexpr     (** arithmetic addition or string cat *)
  38   | Expr_sub of whenexpr * whenexpr     (** arithmetic subtraction *)
  39   | Expr_mul of whenexpr * whenexpr     (** arithmetic multiplication *)
  40   | Expr_div of whenexpr * whenexpr     (** arithmetic division *)
  41   | Expr_mod of whenexpr * whenexpr     (** arithmetic modulo *)
  42   | Expr_len of whenexpr                (** length *)
  43   | Expr_changes of string              (** changes var *)
  44   | Expr_increases of string            (** increases var *)
  45   | Expr_decreases of string            (** decreases var *)
  46   | Expr_prev of string                 (** prev var *)
  47   | Expr_reloaded                       (** reloaded () *)
  48 (** Internal type used to represent 'when' expressions. *)
  49
  50 type periodexpr =
  51   | Every_seconds of int
  52   | Every_days of int
  53   | Every_months of int
  54   | Every_years of int
  55 (** Internal type used to represent 'every' expressions. *)
  56
  57 type shell_script = {
  58   sh_loc : Camlp4.PreCast.Loc.t;
  59   sh_script : string;
  60 }
  61 (** A shell script. *)
  62
  63 type result = {
  64   res_job_name : string;                (** Job name. *)
  65   res_serial : Big_int.big_int;         (** Job serial number. *)
  66   res_code : int;                       (** Return code from the script. *)
  67   res_tmpdir : string;                  (** Temporary directory. *)
  68   res_output : string;                  (** Filename of output from job. *)
  69 }
  70 (** Result of the run of a job. *)
  71
  72 type cleanup = result -> unit
  73 (** A cleanup function. *)
  74
  75 type variable =
  76   | T_unit
  77   | T_bool of bool
  78   | T_string of string
  79   | T_int of Big_int.big_int
  80   | T_float of float
  81 (** Typed variable (see also [whenproto.x]) *)
  82
  83 val string_of_variable : variable -> string
  84
  85 val variable_of_rpc : Whenproto_aux.variable -> variable
  86 val rpc_of_variable : variable -> Whenproto_aux.variable
  87
  88 type variables = variable Whenutils.StringMap.t
  89 (** A set of variables. *)
  90
  91 type job_cond =
  92   | When_job of whenexpr                (** when ... : << >> *)
  93   | Every_job of periodexpr             (** every ... : << >> *)
  94
  95 type job = {
  96   job_loc : Camlp4.PreCast.Loc.t;
  97   job_name : string;
  98   job_cleanup : cleanup option;
  99   job_cond : job_cond;
 100   job_script : shell_script;
 101 }
 102 (** A job. *)
 103
 104 val expr_of_ast : Camlp4.PreCast.Ast.Loc.t -> Camlp4.PreCast.Ast.expr -> whenexpr
 105 (** Convert OCaml AST to an expression.  Since OCaml ASTs are much
 106     more general than the expressions we can use, this can raise
 107     [Invalid_argument] in many different situations. *)
 108
 109 val string_of_whenexpr : whenexpr -> string
 110 (** Pretty-print an expression to a string. *)
 111
 112 val string_of_periodexpr : periodexpr -> string
 113 (** Pretty-print a period expression to a string. *)
 114
 115 val dependencies_of_whenexpr : whenexpr -> string list
 116 (** Return list of variables that an expression depends on.  This is
 117     used to work out when an expression needs to be reevaluated. *)
 118
 119 val dependencies_of_job : job -> string list
 120 (** Which variables does this job depend on? *)
 121
 122 val eval_whenexpr : variables -> variables option -> bool -> whenexpr -> variable
 123 val eval_whenexpr_as_bool : variables -> variables option -> bool -> whenexpr -> bool
 124 (** [eval_whenexpr variables prev_variables onload expr] is the
 125     evaluation function for when expressions.  It full evaluates
 126     [expr], returning its typed value.  It can also throw exceptions
 127     (at least [Invalid_argument] and [Failure]).
 128
 129     [eval_whenexpr_as_bool] is the same but it forces the returned
 130     value to be a boolean.
 131
 132     The other parameters represent the current and past state:
 133
 134     [variables] is the current set of variables and their values.
 135
 136     [prev_variables] is the set of variables from the previous
 137     run.  It is used to implement {i prev}, {i changes} etc operators.
 138     This can be [None], meaning there is no previous state.
 139
 140     [onload] is used to implement the {i reloaded} operator.  It is
 141     true if the file is being reloaded, and false otherwise. *)
 142
 143 val next_periodexpr : float -> periodexpr -> float
 144 (** [next_periodexpr t period] returns the earliest event of [period]
 145     strictly after time [t].
 146
 147     Visualising periods as repeated events on a timeline, this
 148     returns [t']:
 149
 150     {v
 151     events:  ---+---------+---------+---------+---------+---------+-----
 152     times:          t     t'
 153     }
 154
 155     Note that [periodexpr] events are not necessarily regular.
 156     eg. The start of a month is not a fixed number of seconds
 157     after the start of the previous month.  'Epoch' refers
 158     to the Unix Epoch (ie. 1970-01-01 00:00:00 UTC).
 159
 160     If [period = Every_seconds i] then events are when
 161     [t' mod i == 0] when t' is the number of seconds since
 162     the Epoch.  This returns the next t' > t.
 163
 164     If [period = Every_days i] then events happen at
 165     midnight UTC every [i] days since the Epoch.
 166     This returns the next midnight > t.
 167
 168     If [period = Every_months i] then events happen at
 169     midnight UTC on the 1st day of the month every [i] months
 170     since the Epoch.  This returns midnight on the
 171     1st day of the next month > t.
 172
 173     If [period = Every_years i] then events happen at
 174     midnight UTC on the 1st day of the year when
 175     [(y - 1970) mod i == 0].  This returns midnight on the
 176     1st day of the next year > t. *)
 177
 178 val check_valid_variable_name : string -> unit
 179 (** Check that [name] is a valid variable name that users are permitted
 180     to set, and raise [Failure] if it is not.  *)