2 * Copyright (C) 2012 Red Hat Inc.
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.
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.
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.
19 (** When- and every-expression definition and evaluation, variables
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. *)
51 | Every_seconds of int
55 (** Internal type used to represent 'every' expressions. *)
58 sh_loc : Camlp4.PreCast.Loc.t;
61 (** A shell script. *)
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. *)
70 (** Result of the run of a job. *)
72 type cleanup = result -> unit
73 (** A cleanup function. *)
79 | T_int of Big_int.big_int
81 (** Typed variable (see also [whenproto.x]) *)
83 val string_of_variable : variable -> string
85 val variable_of_rpc : Whenproto_aux.variable -> variable
86 val rpc_of_variable : variable -> Whenproto_aux.variable
88 type variables = variable Whenutils.StringMap.t
89 (** A set of variables. *)
92 | When_job of whenexpr (** when ... : << >> *)
93 | Every_job of periodexpr (** every ... : << >> *)
96 job_loc : Camlp4.PreCast.Loc.t;
98 job_cleanup : cleanup option;
100 job_script : shell_script;
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. *)
109 val string_of_whenexpr : whenexpr -> string
110 (** Pretty-print an expression to a string. *)
112 val string_of_periodexpr : periodexpr -> string
113 (** Pretty-print a period expression to a string. *)
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. *)
119 val dependencies_of_job : job -> string list
120 (** Which variables does this job depend on? *)
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]).
129 [eval_whenexpr_as_bool] is the same but it forces the returned
130 value to be a boolean.
132 The other parameters represent the current and past state:
134 [variables] is the current set of variables and their values.
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.
140 [onload] is used to implement the {i reloaded} operator. It is
141 true if the file is being reloaded, and false otherwise. *)
143 val next_periodexpr : float -> periodexpr -> float
144 (** [next_periodexpr t period] returns the earliest event of [period]
145 strictly after time [t].
147 Visualising periods as repeated events on a timeline, this
151 events: ---+---------+---------+---------+---------+---------+-----
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).
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.
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.
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.
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. *)
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. *)