Command line parsing, the concept of publishing goals.
[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       (* Split the function into parameters and body. *)
72       let params, body = function_parameters expr in
73
74       if params = [] then
75         locfail _loc "goal must have some parameters; you probably want to put '()' here";
76
77       (* Is it a "zero-parameters" automatically published goal?  What
78        * this really means is it has exactly one unit parameter.
79        *)
80       (match params with
81       | [ _, PaId (_, IdUid (_, "()")) ] ->
82         autopublish := name :: !autopublish
83       | _ -> ()
84       );
85
86       (* Put a try-clause around the body. *)
87       let body = <:expr< try $body$ with Goal_result Goal_OK -> () >> in
88
89       (* Recreate the function with parameters. *)
90       let expr =
91         List.fold_right (
92           fun (_ploc, param) rest ->
93             ExFun (_loc, McArr (_ploc, param, ExNil _ploc, rest))
94         ) params body in
95
96       <:binding< $lid:gname$ = $expr$ >>
97     | _ ->
98       locfail _loc "cannot parse 'let goal' expression"
99   in
100   let lets = rewrite lets in
101
102   (* let [rec] ... and ... in () *)
103   let stmts = Ast.StVal (_loc, r, lets) in
104
105   (* Auto-published goals. *)
106   List.fold_left (
107     fun stmt name ->
108       let publish_name =
109         let gname = "goal_" ^ name in
110         <:str_item<
111           let () = publish $str:name$ (
112             function
113             | [] ->
114               Goaljobs.require ($lid:gname$ ())
115             | _ ->
116               failwith (Printf.sprintf "goal '%s' does not take any arguments"
117                           $str:name$);
118           )
119         >> in
120       StSem (_loc, stmt, publish_name)
121   ) stmts !autopublish
122
123 (* Rewrite 'require (name args...)' as 'require (goal_name args)'.
124  * 'expr' is a function call.
125  *)
126 let generate_require _loc expr =
127   (* Note that 'f a b c' is parsed as '((f a) b) c' so the actually
128    * function name is buried deeply in the tree.  Rewrite the name.
129    *)
130   let rec rewrite = function
131     | ExApp (_loc, ExId (_loc1, IdLid (_loc2, name)), right) ->
132       let gname = "goal_" ^ name in
133       ExApp (_loc, ExId (_loc1, IdLid (_loc2, gname)), right)
134     | ExApp (_loc, (ExApp _ as expr), right) ->
135       ExApp (_loc, rewrite expr, right)
136     | _ ->
137       locfail _loc "require (...) expression must contain a call to a goal"
138   in
139   let expr = rewrite expr in
140   <:expr< Goaljobs.require ($expr$) >>
141
142 ;;
143
144 EXTEND Gram
145   GLOBAL: expr str_item;
146
147   (* Rewrite 'require (name args...)'. *)
148   expr: LEVEL "apply" [
149     [ "require"; e = expr ->
150       generate_require _loc e ]
151   ];
152
153   (* "str_item" is a top level statement in an OCaml program. *)
154   str_item: LEVEL "top" [
155     [ "let"; r = opt_rec; "goal"; ls = binding ->
156     generate_let_goal _loc r ls ]
157   ];
158
159 END