lib/pa_when.ml

   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 (* For general information about camlp4, see:
  20  * http://brion.inria.fr/gallium/index.php/Camlp4
  21  *
  22  * For information about quotations, see:
  23  * http://brion.inria.fr/gallium/index.php/Quotation
  24  *)
  25
  26 open Printf
  27
  28 open Camlp4.PreCast
  29 open Syntax
  30 open Ast
  31
  32 let unique = let i = ref 0 in fun () -> incr i; !i
  33
  34 let unique_job_name () = sprintf "job$%d" (unique ())
  35
  36 let rec find s sub =
  37   let len = String.length s in
  38   let sublen = String.length sub in
  39   let rec loop i =
  40     if i <= len-sublen then (
  41       let rec loop2 j =
  42         if j < sublen then (
  43           if s.[i+j] = sub.[j] then loop2 (j+1)
  44           else -1
  45         ) else
  46           i (* found *)
  47       in
  48       let r = loop2 0 in
  49       if r = -1 then loop (i+1) else r
  50     ) else
  51       -1 (* not found *)
  52   in
  53   loop 0
  54
  55 let rec replace_str s s1 s2 =
  56   let len = String.length s in
  57   let sublen = String.length s1 in
  58   let i = find s s1 in
  59   if i = -1 then s
  60   else (
  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
  64   )
  65
  66 (* Convert a _loc to an AST. *)
  67 let expr_of_loc _loc loc =
  68   let file_name,
  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
  73     ($str:file_name$,
  74      $`int:start_line$, $`int:start_bol$, $`int:start_off$,
  75      $`int:stop_line$, $`int:stop_bol$, $`int:stop_off$,
  76      $`bool:ghost$) >>
  77
  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
  81  *)
  82 module M = Ast.Meta.Make (Ast.Meta.MetaGhostLoc)
  83 let lift_expr = M.Expr.meta_expr
  84
  85 (* Handle a top level statement. *)
  86 let rec call_stmt name (_loc, stmt, sh) =
  87   let name = if name <> "" then name else unique_job_name () in
  88   let name = <:expr< $str:name$ >> in
  89   match stmt with
  90   | `When e -> when_stmt _loc name e sh
  91   | `Every p -> every_stmt _loc name p sh
  92
  93 (* Handle a top level "when" statement.
  94  * e -> when expression
  95  * sh -> the shell script to run
  96  * Returns a top level statement (str_item) which when executed just
  97  * adds the statement to a global list.
  98  *)
  99 and when_stmt _loc name e sh =
 100   let loc = expr_of_loc _loc _loc in
 101   let e = lift_expr _loc e in
 102   <:str_item<
 103     open Camlp4.PreCast
 104     Whenfile.add_when_job $loc$ $name$ $e$ $sh$
 105   >>
 106
 107 (* Handle a top level "every" statement. *)
 108 and every_stmt _loc name period sh =
 109   let loc = expr_of_loc _loc _loc in
 110   <:str_item<
 111     open Camlp4.PreCast
 112     Whenfile.add_every_job $loc$ $name$ $period$ $sh$
 113   >>
 114
 115 let () =
 116   (* Quotation expander for shell script. *)
 117   let sh_quotation_expander _loc _ sh =
 118     let loc = expr_of_loc _loc _loc in
 119
 120     (* Convert ">\>" to ">>" in code. *)
 121     let sh = replace_str sh ">\\>" ">>" in
 122
 123     <:expr< { Whenexpr.sh_loc = $loc$;
 124               sh_script = $str:sh$ } >>
 125   in
 126   Quotation.add "sh" Quotation.DynAst.expr_tag sh_quotation_expander;
 127
 128   (* Default quotation expander (<< .. >>) should be shell script ("sh"). *)
 129   Quotation.default := "sh"
 130
 131 (* For period expressions "<NN> (secs|mins|hours|...)" we cannot use
 132  * the ordinary camlp4 parser since it only looks ahead by 1 symbol, so
 133  * it gets "stuck" on the integer.  Write a custom parser instead.
 134  *
 135  * Note the EXTEND macro implicitly reserves KEYWORDs.
 136  *)
 137 let period_parser =
 138   Gram.Entry.of_parser "period"
 139     (fun stream ->
 140       match Stream.peek stream with
 141       | Some (INT (_, i), info) ->
 142         let i = int_of_string i in
 143         let _loc = Gram.token_location info in
 144         Stream.junk stream;
 145         (match Stream.next stream with
 146         | KEYWORD ("sec"|"secs"|"second"|"seconds"), _ ->
 147           <:expr< Whenexpr.Every_seconds $`int:i$ >>
 148         | KEYWORD ("min"|"mins"|"minute"|"minutes"), _ ->
 149           let i = 60 * i in
 150           <:expr< Whenexpr.Every_seconds $`int:i$ >>
 151         | KEYWORD ("hour"|"hours"), _ ->
 152           let i = 3600 * i in
 153           <:expr< Whenexpr.Every_seconds $`int:i$ >>
 154         | KEYWORD ("day"|"days"), _ ->
 155           <:expr< Whenexpr.Every_days $`int:i$ >>
 156         | KEYWORD ("week"|"weeks"), _ ->
 157           let i = 7 * i in
 158           <:expr< Whenexpr.Every_days $`int:i$ >>
 159         | KEYWORD ("month"|"months"), _ ->
 160           <:expr< Whenexpr.Every_months $`int:i$ >>
 161         | KEYWORD ("year"|"years"), _ ->
 162           <:expr< Whenexpr.Every_years $`int:i$ >>
 163         | KEYWORD ("decade"|"decades"), _ ->
 164           let i = 10 * i in
 165           <:expr< Whenexpr.Every_years $`int:i$ >>
 166         | KEYWORD ("century"|"centuries"|"centurys"), _ ->
 167           let i = 100 * i in
 168           <:expr< Whenexpr.Every_years $`int:i$ >>
 169         | KEYWORD ("millenium"|"millenia"|"milleniums"), _ ->
 170           let i = 1000 * i in
 171           <:expr< Whenexpr.Every_years $`int:i$ >>
 172         | (KEYWORD s | LIDENT s), _ ->
 173           eprintf "period: failed to parse %d %s\n%!" i s;
 174           raise Stream.Failure
 175         | _ ->
 176           raise Stream.Failure
 177         )
 178       | _ -> raise Stream.Failure
 179     )
 180
 181 (*
 182 (* This hand-written parser looks for "job <name>" before a statement. *)
 183 let optjob =
 184   Gram.Entry.of_parser "optjob"
 185     (fun stream ->
 186       let info, name =
 187         match Stream.npeek 2 stream with
 188         | [ LIDENT "job", info; STRING (_,name), _ ] ->
 189           Stream.junk stream;
 190           Stream.junk stream;
 191           info, name
 192         | (_, info) :: _ ->
 193           (* Job is unnamed so generate a unique internal name. *)
 194           info, unique_job_name ()
 195         | _ -> assert false in
 196       let _loc = Gram.token_location info in
 197       <:expr< $str:name$ >>
 198     )
 199 *)
 200 ;;
 201
 202 EXTEND Gram
 203   GLOBAL: str_item;
 204
 205   (* A period expression (used in "every"). *)
 206   periodexpr: [
 207     [ ["sec"|"secs"|"second"|"seconds"] ->
 208       <:expr< Whenexpr.Every_seconds 1 >> ]
 209   | [ ["min"|"mins"|"minute"|"minutes"] ->
 210       <:expr< Whenexpr.Every_seconds 60 >> ]
 211   | [ ["hour"|"hours"] -> <:expr< Whenexpr.Every_seconds 3600 >> ]
 212   | [ ["day"|"days"] -> <:expr< Whenexpr.Every_days 1 >> ]
 213   | [ ["week"|"weeks"] -> <:expr< Whenexpr.Every_days 7 >> ]
 214   | [ ["month"|"months"] -> <:expr< Whenexpr.Every_months 1 >> ]
 215   | [ ["year"|"years"] -> <:expr< Whenexpr.Every_years 1 >> ]
 216   | [ ["decade"|"decades"] -> <:expr< Whenexpr.Every_years 10 >> ]
 217   | [ ["century"|"centuries"|"centurys"] ->
 218       <:expr< Whenexpr.Every_years 100 >> ]
 219   | [ ["millenium"|"millenia"|"milleniums"] ->
 220       <:expr< Whenexpr.Every_years 1000 >> ]
 221   | [ e = period_parser -> e ]
 222   ];
 223
 224   (* Top level statements. *)
 225   statement: [
 226     [ "when"; e = expr; ":"; sh = expr ->
 227       (_loc, `When e, sh) ]
 228   | [ "every"; p = periodexpr; ":"; sh = expr ->
 229       (_loc, `Every p, sh) ]
 230   ];
 231
 232   (* "str_item" is a top level statement in an OCaml program. *)
 233   str_item: LEVEL "top" [
 234     [ s = statement -> call_stmt "" s ]
 235   | [ "job"; name = STRING; s = statement -> call_stmt name s ]
 236   ];
 237
 238 END