20df4fa01a1143fccfec658b7c15a21195773da1
[goaljobs.git] / pa_goal.ml
1 (* goaljobs
2  * Copyright (C) 2013 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 locfail _loc msg = Loc.raise _loc (Failure msg)
33
34 (* 'expr' is a function expression (RHS of a binding).  It has the
35  * form 'fun a -> fun b -> ...'.  Return the parameters and the body of
36  * the function.
37  *)
38 let rec function_parameters = function
39   (* fun patt -> expr *)
40   | ExFun (_loc, McArr (_ploc, param, ExNil _, expr)) ->
41     let params, body = function_parameters expr in
42     ((_ploc, param) :: params), body
43   (* patt when expr -> expr *)
44   | ExFun (_loc, McArr (_, _, _, expr)) ->
45     locfail _loc "not supported: goal function uses when-clause"
46   | body -> [], body
47
48 (* Define one or more 'let [rec] goal ... [and ...]' expressions.
49  *
50  * 'r' is Some _ if the rec keyword was defined.  'lets' is the list
51  * of let statements.
52  *)
53 let generate_let_goal _loc (r : rec_flag) (lets : binding) =
54   let autopublish = ref [] in
55
56   (* lets might be a single binding, or multiple bindings using BiAnd
57    * ('let .. and').  Rewrite each individual goal in the list.
58    *)
59   let rec rewrite = function
60     | BiNil _loc -> BiNil _loc
61
62     (* let goal left = ... and right = ... *)
63     | BiAnd (_loc, left, right) ->
64       BiAnd (_loc, rewrite left, rewrite right)
65
66     (* let goal name = expr *)
67     | BiEq (_loc, PaId (_, (IdLid (_, name))), expr) ->
68       (* Rename the function to goal_<name>. *)
69       let gname = "goal_" ^ name in
70
71       (* Convert loc to string for goalloc. *)
72       let goalloc = Loc.to_string _loc in
73
74       (* Split the function into parameters and body. *)
75       let params, body = function_parameters expr in
76
77       if params = [] then
78         locfail _loc "goal must have some parameters; you probably want to put '()' here";
79
80       (* Is it a "zero-parameters" automatically published goal?  What
81        * this really means is it has exactly one unit parameter.
82        *)
83       (match params with
84       | [ _, PaId (_, IdUid (_, "()")) ] ->
85         autopublish := name :: !autopublish
86       | _ -> ()
87       );
88
89       (* Put a try-clause around the body. *)
90       let body = <:expr<
91         (* Define a goal name which the body may use. *)
92         let goalname = $str:name$ in
93
94         (* Source location. *)
95         let goalloc = $str:goalloc$ in
96
97         (* Define onsuccess, onrun, onfail functions that the body may call. *)
98         let _on, _call_on =
99           let _on fns f = fns := f :: !fns in
100           let _call_on fns a = List.iter (fun f -> f a) !fns in
101           _on, _call_on
102         in
103         let onfail, _call_onfails =
104           let fns = ref [] in (_on fns), (_call_on fns)
105         in
106         let onrun, _call_onruns =
107           let fns = ref [] in (_on fns), (_call_on fns)
108         in
109         let onsuccess, _call_onsuccesses =
110           let fns = ref [] in (_on fns), (_call_on fns)
111         in
112
113         try
114           $body$ ;
115           _call_onruns ();
116           _call_onsuccesses ();
117
118           (* Avoid a compiler warning: *)
119           ignore (goalname); ignore (goalloc)
120         with
121         (* target() within the body may raise Goal_OK meaning that the
122          * goal should be short-circuited.  We return as if it's an
123          * ordinary function exit.
124          *)
125         | Goal_result Goal_OK ->
126           _call_onsuccesses ();
127           ()
128         | exn ->
129           _call_onfails exn;
130           raise exn
131       >> in
132
133       (* Recreate the function with parameters. *)
134       let expr =
135         List.fold_right (
136           fun (_ploc, param) rest ->
137             ExFun (_loc, McArr (_ploc, param, ExNil _ploc, rest))
138         ) params body in
139
140       <:binding< $lid:gname$ = $expr$ >>
141     | _ ->
142       locfail _loc "cannot parse 'let goal' expression"
143   in
144   let lets = rewrite lets in
145
146   (* let [rec] ... and ... in () *)
147   let stmts = Ast.StVal (_loc, r, lets) in
148
149   (* Auto-published goals. *)
150   List.fold_left (
151     fun stmt name ->
152       let publish_name =
153         let gname = "goal_" ^ name in
154         <:str_item<
155           let () = publish $str:name$ (
156             function
157             | [] ->
158               Goaljobs.require $lid:gname$
159             | _ ->
160               failwith (Printf.sprintf "goal '%s' does not take any arguments"
161                           $str:name$);
162           )
163         >> in
164       StSem (_loc, stmt, publish_name)
165   ) stmts !autopublish
166
167 (* Rewrite 'require (name args...)' as 'require (fun () -> goal_name args)'.
168  * 'expr' is a function call.
169  *)
170 let generate_require _loc expr =
171   (* Note that 'f a b c' is parsed as '((f a) b) c' so the actual
172    * function name is buried deeply in the tree.  Rewrite the name.
173    *)
174   let rec rewrite = function
175     | ExApp (_loc, ExId (_loc1, IdLid (_loc2, name)), right) ->
176       let gname = "goal_" ^ name in
177       ExApp (_loc, ExId (_loc1, IdLid (_loc2, gname)), right)
178     | ExApp (_loc, (ExApp _ as expr), right) ->
179       ExApp (_loc, rewrite expr, right)
180     | _ ->
181       locfail _loc "require (...) expression must contain a call to a goal"
182   in
183   let expr = rewrite expr in
184   <:expr< Goaljobs.require (fun () -> $expr$) >>
185
186 ;;
187
188 EXTEND Gram
189   GLOBAL: expr str_item;
190
191   (* Rewrite 'require (name args...)'. *)
192   expr: LEVEL "apply" [
193     [ "require"; e = expr ->
194       generate_require _loc e ]
195   ];
196
197   (* "str_item" is a top level statement in an OCaml program. *)
198   str_item: LEVEL "top" [
199     [ "let"; r = opt_rec; "goal"; ls = binding ->
200     generate_let_goal _loc r ls ]
201   ];
202
203 END