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 (* For general information about camlp4, see:
20 * http://brion.inria.fr/gallium/index.php/Camlp4
22 * For information about quotations, see:
23 * http://brion.inria.fr/gallium/index.php/Quotation
32 let unique = let i = ref 0 in fun () -> incr i; !i
34 let unique_job_name () = sprintf "job$%d" (unique ())
37 let len = String.length s in
38 let sublen = String.length sub in
40 if i <= len-sublen then (
43 if s.[i+j] = sub.[j] then loop2 (j+1)
49 if r = -1 then loop (i+1) else r
55 let rec replace_str s s1 s2 =
56 let len = String.length s in
57 let sublen = String.length s1 in
61 let s' = String.sub s 0 i in
62 let s'' = String.sub s (i+sublen) (len-i-sublen) in
63 s' ^ s2 ^ replace_str s'' s1 s2
66 (* Convert a _loc to an AST. *)
67 let expr_of_loc _loc loc =
69 start_line, start_bol, start_off,
70 stop_line, stop_bol, stop_off,
71 ghost = Loc.to_tuple loc in
72 <:expr< Camlp4.PreCast.Loc.of_tuple
74 $`int:start_line$, $`int:start_bol$, $`int:start_off$,
75 $`int:stop_line$, $`int:stop_bol$, $`int:stop_off$,
78 (* "Lift" an expression, turning it from an expression into an OCaml
79 * abstract syntax tree in the output. This is pretty obscure.
80 * http://caml.inria.fr/pub/ml-archives/caml-list/2008/09/591f7c4a8df9295d675a5adcb6802748.en.html
82 module M = Ast.Meta.Make (Ast.Meta.MetaGhostLoc)
83 let lift_expr = M.Expr.meta_expr
85 (* Handle a top level statement. *)
86 let rec call_stmt name (_loc, stmt, sh) =
89 | None -> let name = unique_job_name () in <:expr< $str:name$ >>
90 | Some name -> name in
92 | `When e -> when_stmt _loc name e sh
93 | `Every p -> every_stmt _loc name p sh
95 (* Handle a top level "when" statement.
96 * e -> when expression
97 * sh -> the shell script to run
98 * Returns a top level statement (str_item) which when executed just
99 * adds the statement to a global list.
101 and when_stmt _loc name e sh =
102 let loc = expr_of_loc _loc _loc in
103 let e = lift_expr _loc e in
106 Whenfile.add_when_job $loc$ $name$ $e$ $sh$
109 (* Handle a top level "every" statement. *)
110 and every_stmt _loc name period sh =
111 let loc = expr_of_loc _loc _loc in
114 Whenfile.add_every_job $loc$ $name$ $period$ $sh$
118 (* Quotation expander for shell script. *)
119 let sh_quotation_expander _loc _ sh =
120 let loc = expr_of_loc _loc _loc in
122 (* Convert ">\>" to ">>" in code. *)
123 let sh = replace_str sh ">\\>" ">>" in
125 <:expr< { Whenexpr.sh_loc = $loc$;
126 sh_script = $str:sh$ } >>
128 Quotation.add "sh" Quotation.DynAst.expr_tag sh_quotation_expander;
130 (* Default quotation expander (<< .. >>) should be shell script ("sh"). *)
131 Quotation.default := "sh"
133 (* For period expressions "<NN> (secs|mins|hours|...)" we cannot use
134 * the ordinary camlp4 parser since it only looks ahead by 1 symbol, so
135 * it gets "stuck" on the integer. Write a custom parser instead.
137 * Note the EXTEND macro implicitly reserves KEYWORDs.
140 Gram.Entry.of_parser "period"
142 match Stream.peek stream with
143 | Some (INT (_, i), info) ->
144 let i = int_of_string i in
145 let _loc = Gram.token_location info in
147 (match Stream.next stream with
148 | KEYWORD ("sec"|"secs"|"second"|"seconds"), _ ->
149 <:expr< Whenexpr.Every_seconds $`int:i$ >>
150 | KEYWORD ("min"|"mins"|"minute"|"minutes"), _ ->
152 <:expr< Whenexpr.Every_seconds $`int:i$ >>
153 | KEYWORD ("hour"|"hours"), _ ->
155 <:expr< Whenexpr.Every_seconds $`int:i$ >>
156 | KEYWORD ("day"|"days"), _ ->
157 <:expr< Whenexpr.Every_days $`int:i$ >>
158 | KEYWORD ("week"|"weeks"), _ ->
160 <:expr< Whenexpr.Every_days $`int:i$ >>
161 | KEYWORD ("month"|"months"), _ ->
162 <:expr< Whenexpr.Every_months $`int:i$ >>
163 | KEYWORD ("year"|"years"), _ ->
164 <:expr< Whenexpr.Every_years $`int:i$ >>
165 | KEYWORD ("decade"|"decades"), _ ->
167 <:expr< Whenexpr.Every_years $`int:i$ >>
168 | KEYWORD ("century"|"centuries"|"centurys"), _ ->
170 <:expr< Whenexpr.Every_years $`int:i$ >>
171 | KEYWORD ("millenium"|"millenia"|"milleniums"), _ ->
173 <:expr< Whenexpr.Every_years $`int:i$ >>
174 | (KEYWORD s | LIDENT s), _ ->
175 eprintf "period: failed to parse %d %s\n%!" i s;
180 | _ -> raise Stream.Failure
187 (* A period expression (used in "every"). *)
189 [ ["sec"|"secs"|"second"|"seconds"] ->
190 <:expr< Whenexpr.Every_seconds 1 >> ]
191 | [ ["min"|"mins"|"minute"|"minutes"] ->
192 <:expr< Whenexpr.Every_seconds 60 >> ]
193 | [ ["hour"|"hours"] -> <:expr< Whenexpr.Every_seconds 3600 >> ]
194 | [ ["day"|"days"] -> <:expr< Whenexpr.Every_days 1 >> ]
195 | [ ["week"|"weeks"] -> <:expr< Whenexpr.Every_days 7 >> ]
196 | [ ["month"|"months"] -> <:expr< Whenexpr.Every_months 1 >> ]
197 | [ ["year"|"years"] -> <:expr< Whenexpr.Every_years 1 >> ]
198 | [ ["decade"|"decades"] -> <:expr< Whenexpr.Every_years 10 >> ]
199 | [ ["century"|"centuries"|"centurys"] ->
200 <:expr< Whenexpr.Every_years 100 >> ]
201 | [ ["millenium"|"millenia"|"milleniums"] ->
202 <:expr< Whenexpr.Every_years 1000 >> ]
203 | [ e = period_parser -> e ]
206 (* Top level statements. *)
208 [ "when"; e = expr; ":"; sh = expr ->
209 (_loc, `When e, sh) ]
210 | [ "every"; p = periodexpr; ":"; sh = expr ->
211 (_loc, `Every p, sh) ]
214 (* "str_item" is a top level statement in an OCaml program. *)
215 str_item: LEVEL "top" [
216 [ s = statement -> call_stmt None s ]
217 | [ "job"; name = expr; s = statement -> call_stmt (Some name) s ]