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 (** Types and utility functions. *)
21 module StringMap : sig
25 val is_empty : 'a t -> bool
26 val mem : key -> 'a t -> bool
27 val add : key -> 'a -> 'a t -> 'a t
28 (*val singleton : key -> 'a -> 'a t*)
29 val remove : key -> 'a t -> 'a t
31 (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t*)
32 val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
33 val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
34 val iter : (key -> 'a -> unit) -> 'a t -> unit
35 val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
36 (*val for_all : (key -> 'a -> bool) -> 'a t -> bool
37 val exists : (key -> 'a -> bool) -> 'a t -> bool
38 val filter : (key -> 'a -> bool) -> 'a t -> 'a t
39 val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
40 val cardinal : 'a t -> int
41 val bindings : 'a t -> (key * 'a) list
42 val min_binding : 'a t -> key * 'a
43 val max_binding : 'a t -> key * 'a
44 val choose : 'a t -> key * 'a
45 val split : key -> 'a t -> 'a t * 'a option * 'a t*)
46 val find : key -> 'a t -> 'a
47 val map : ('a -> 'b) -> 'a t -> 'b t
48 val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
49 val keys : 'a t -> key list
50 val values : 'a t -> 'a list
52 (** A map from string to any type. *)
58 val is_empty : 'a t -> bool
59 val mem : key -> 'a t -> bool
60 val add : key -> 'a -> 'a t -> 'a t
61 (*val singleton : key -> 'a -> 'a t*)
62 val remove : key -> 'a t -> 'a t
64 (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t*)
65 val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
66 val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
67 val iter : (key -> 'a -> unit) -> 'a t -> unit
68 val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
69 (*val for_all : (key -> 'a -> bool) -> 'a t -> bool
70 val exists : (key -> 'a -> bool) -> 'a t -> bool
71 val filter : (key -> 'a -> bool) -> 'a t -> 'a t
72 val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
73 val cardinal : 'a t -> int
74 val bindings : 'a t -> (key * 'a) list
75 val min_binding : 'a t -> key * 'a
76 val max_binding : 'a t -> key * 'a
77 val choose : 'a t -> key * 'a
78 val split : key -> 'a t -> 'a t * 'a option * 'a t*)
79 val find : key -> 'a t -> 'a
80 val map : ('a -> 'b) -> 'a t -> 'b t
81 val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
82 val keys : 'a t -> key list
83 val values : 'a t -> 'a list
85 (** A map from int to any type. *)
87 module StringSet : sig
89 type t = Set.Make(String).t
91 val is_empty : t -> bool
92 val mem : elt -> t -> bool
93 val add : elt -> t -> t
94 val singleton : elt -> t
95 val remove : elt -> t -> t
96 val union : t -> t -> t
97 val inter : t -> t -> t
98 val diff : t -> t -> t
99 val compare : t -> t -> int
100 val equal : t -> t -> bool
101 val subset : t -> t -> bool
102 val iter : (elt -> unit) -> t -> unit
103 val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
104 val for_all : (elt -> bool) -> t -> bool
105 val exists : (elt -> bool) -> t -> bool
106 val filter : (elt -> bool) -> t -> t
107 val partition : (elt -> bool) -> t -> t * t
108 val cardinal : t -> int
109 val elements : t -> elt list
110 val min_elt : t -> elt
111 val max_elt : t -> elt
112 val choose : t -> elt
113 val split : elt -> t -> t * bool * t
115 (** A set of strings. *)
117 val (//) : string -> string -> string
118 (** [dir // file] concatenates directory and file. *)
120 val filter_map : ('a -> 'b option) -> 'a list -> 'b list
124 | Expr_bool of bool (** A boolean constant. *)
125 | Expr_str of string (** A string constant. *)
126 | Expr_int of Big_int.big_int (** An integer constant. *)
127 | Expr_float of float (** A float constant. *)
128 | Expr_var of string (** A variable name. *)
129 | Expr_and of whenexpr * whenexpr (** && *)
130 | Expr_or of whenexpr * whenexpr (** || *)
131 | Expr_eq of whenexpr * whenexpr (** == *)
132 | Expr_not of whenexpr (** ! *)
133 | Expr_changes of string (** changes var *)
134 (** Internal type used to represent 'when' expressions. *)
137 | Every_seconds of int
139 | Every_months of int
141 (** Internal type used to represent 'every' expressions. *)
143 type shell_script = {
144 sh_loc : Camlp4.PreCast.Loc.t;
147 (** A shell script. *)
152 | T_int of Big_int.big_int
154 (** Typed variable (see also [whenproto.x]) *)
156 val variable_of_rpc : Whenproto_aux.variable -> variable
157 val rpc_of_variable : variable -> Whenproto_aux.variable
159 type variables = variable StringMap.t
160 (** A set of variables. *)
163 (** Private state associated with a job, used for evaluation. *)
165 val no_job_private : job_private
166 (* XXX any use of no_job_private is wrong XXX *)
169 | When_job of whenexpr (** when ... : << >> *)
170 | Every_job of periodexpr (** every ... : << >> *)
173 job_loc : Camlp4.PreCast.Loc.t;
176 job_script : shell_script;
177 job_private : job_private;
181 val expr_of_ast : Camlp4.PreCast.Ast.Loc.t -> Camlp4.PreCast.Ast.expr -> whenexpr
182 (** Convert OCaml AST to an expression. Since OCaml ASTs are much
183 more general than the expressions we can use, this can raise
184 [Invalid_argument] in many different situations. *)
186 val string_of_whenexpr : whenexpr -> string
187 (** Pretty-print an expression to a string. *)
189 val string_of_periodexpr : periodexpr -> string
190 (** Pretty-print a period expression to a string. *)
192 val dependencies_of_whenexpr : whenexpr -> string list
193 (** Return list of variables that an expression depends on. This is
194 used to work out when an expression needs to be reevaluated. *)
196 val dependencies_of_job : job -> string list
197 (** Which variables does this job depend on? *)
199 val job_evaluate : job -> variables -> bool * job
200 (** Evaluate [job]'s condition in the context of the [variables], and
201 return [true] iff it should be run now. Note that this returns a
202 possibly-updated [job] structure.
204 This is a no-op for 'every' jobs. *)
206 val next_periodexpr : float -> periodexpr -> float
207 (** [next_periodexpr t period] returns the earliest event of [period]
208 strictly after time [t].
210 Visualising periods as repeated events on a timeline, this
214 events: ---+---------+---------+---------+---------+---------+-----
218 Note that [periodexpr] events are not necessarily regular.
219 eg. The start of a month is not a fixed number of seconds
220 after the start of the previous month. 'Epoch' refers
221 to the Unix Epoch (ie. 1970-01-01 00:00:00 UTC).
223 If [period = Every_seconds i] then events are when
224 [t' mod i == 0] when t' is the number of seconds since
225 the Epoch. This returns the next t' > t.
227 If [period = Every_days i] then events happen at
228 midnight UTC every [i] days since the Epoch.
229 This returns the next midnight > t.
231 If [period = Every_months i] then events happen at
232 midnight UTC on the 1st day of the month every [i] months
233 since the Epoch. This returns midnight on the
234 1st day of the next month > t.
236 If [period = Every_years i] then events happen at
237 midnight UTC on the 1st day of the year when
238 [(y - 1970) mod i == 0]. This returns midnight on the
239 1st day of the next year > t. *)