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_changes of string (** changes var *)
43 | Expr_increases of string (** increases var *)
44 | Expr_decreases of string (** decreases var *)
45 | Expr_prev of string (** prev var *)
46 | Expr_reloaded (** reloaded () *)
47 (** Internal type used to represent 'when' expressions. *)
50 | Every_seconds of int
54 (** Internal type used to represent 'every' expressions. *)
57 sh_loc : Camlp4.PreCast.Loc.t;
60 (** A shell script. *)
66 | T_int of Big_int.big_int
68 (** Typed variable (see also [whenproto.x]) *)
70 val string_of_variable : variable -> string
72 val variable_of_rpc : Whenproto_aux.variable -> variable
73 val rpc_of_variable : variable -> Whenproto_aux.variable
75 type variables = variable Whenutils.StringMap.t
76 (** A set of variables. *)
79 | When_job of whenexpr (** when ... : << >> *)
80 | Every_job of periodexpr (** every ... : << >> *)
83 job_loc : Camlp4.PreCast.Loc.t;
86 job_script : shell_script;
90 val expr_of_ast : Camlp4.PreCast.Ast.Loc.t -> Camlp4.PreCast.Ast.expr -> whenexpr
91 (** Convert OCaml AST to an expression. Since OCaml ASTs are much
92 more general than the expressions we can use, this can raise
93 [Invalid_argument] in many different situations. *)
95 val string_of_whenexpr : whenexpr -> string
96 (** Pretty-print an expression to a string. *)
98 val string_of_periodexpr : periodexpr -> string
99 (** Pretty-print a period expression to a string. *)
101 val dependencies_of_whenexpr : whenexpr -> string list
102 (** Return list of variables that an expression depends on. This is
103 used to work out when an expression needs to be reevaluated. *)
105 val dependencies_of_job : job -> string list
106 (** Which variables does this job depend on? *)
108 val eval_whenexpr : variables -> variables option -> bool -> whenexpr -> variable
109 val eval_whenexpr_as_bool : variables -> variables option -> bool -> whenexpr -> bool
110 (** [eval_whenexpr variables prev_variables onload expr] is the
111 evaluation function for when expressions. It full evaluates
112 [expr], returning its typed value. It can also throw exceptions
113 (at least [Invalid_argument] and [Failure]).
115 [eval_whenexpr_as_bool] is the same but it forces the returned
116 value to be a boolean.
118 The other parameters represent the current and past state:
120 [variables] is the current set of variables and their values.
122 [prev_variables] is the set of variables from the previous
123 run. It is used to implement {i prev}, {i changes} etc operators.
124 This can be [None], meaning there is no previous state.
126 [onload] is used to implement the {i reloaded} operator. It is
127 true if the file is being reloaded, and false otherwise. *)
129 val next_periodexpr : float -> periodexpr -> float
130 (** [next_periodexpr t period] returns the earliest event of [period]
131 strictly after time [t].
133 Visualising periods as repeated events on a timeline, this
137 events: ---+---------+---------+---------+---------+---------+-----
141 Note that [periodexpr] events are not necessarily regular.
142 eg. The start of a month is not a fixed number of seconds
143 after the start of the previous month. 'Epoch' refers
144 to the Unix Epoch (ie. 1970-01-01 00:00:00 UTC).
146 If [period = Every_seconds i] then events are when
147 [t' mod i == 0] when t' is the number of seconds since
148 the Epoch. This returns the next t' > t.
150 If [period = Every_days i] then events happen at
151 midnight UTC every [i] days since the Epoch.
152 This returns the next midnight > t.
154 If [period = Every_months i] then events happen at
155 midnight UTC on the 1st day of the month every [i] months
156 since the Epoch. This returns midnight on the
157 1st day of the next month > t.
159 If [period = Every_years i] then events happen at
160 midnight UTC on the 1st day of the year when
161 [(y - 1970) mod i == 0]. This returns midnight on the
162 1st day of the next year > t. *)