ocaml_printer.ml 11.1 KB
Newer Older
Mário Pereira's avatar
Mário Pereira committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
(*  Copyright 2010-2016   --   INRIA - CNRS - Paris-Sud University  *)
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
(*                                                                  *)
(********************************************************************)

(** Printer for extracted OCaml code *)

open Compile
open Format
open Ident
open Pp
18
19
open Ity
open Term
20
21
open Expr
open Ty
22
23
24
open Theory
open Pmodule
open Stdlib
Mário Pereira's avatar
Mário Pereira committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

module Print = struct

  open ML

  let ocaml_keywords =
    ["and"; "as"; "assert"; "asr"; "begin";
     "class"; "constraint"; "do"; "done"; "downto"; "else"; "end";
     "exception"; "external"; "false"; "for"; "fun"; "function";
     "functor"; "if"; "in"; "include"; "inherit"; "initializer";
     "land"; "lazy"; "let"; "lor"; "lsl"; "lsr"; "lxor"; "match";
     "method"; "mod"; "module"; "mutable"; "new"; "object"; "of";
     "open"; "or"; "private"; "rec"; "sig"; "struct"; "then"; "to";
     "true"; "try"; "type"; "val"; "virtual"; "when"; "while"; "with";
     "raise";]

41
42
43
44
45
  let is_ocaml_keyword =
    let h = Hstr.create 16 in
    List.iter (fun s -> Hstr.add h s ()) ocaml_keywords;
    Hstr.mem h

Mário Pereira's avatar
Mário Pereira committed
46
  let iprinter, aprinter =
Mário Pereira's avatar
Mário Pereira committed
47
    let isanitize = sanitizer char_to_alpha char_to_alnumus in
Mário Pereira's avatar
Mário Pereira committed
48
49
50
    let lsanitize = sanitizer char_to_lalpha char_to_alnumus in
    create_ident_printer ocaml_keywords ~sanitizer:isanitize,
    create_ident_printer ocaml_keywords ~sanitizer:lsanitize
Mário Pereira's avatar
Mário Pereira committed
51
52
53
54
55

  let print_ident fmt id =
    let s = id_unique iprinter id in
    fprintf fmt "%s" s

56
57
  let print_qident ~sanitizer info fmt id =
    try
58
      let _, _, q =
59
60
61
62
63
64
65
66
67
68
69
        try Pmodule.restore_path id
        with Not_found -> Theory.restore_path id in
      let s = String.concat "__" q in
      let s = Ident.sanitizer char_to_alpha char_to_alnumus s in
      let s = sanitizer s in
      let s = if is_ocaml_keyword s then s ^ "_renamed" else s in
      if Sid.mem id info.info_current_th.th_local ||
         Opt.fold (fun _ m -> Sid.mem id m.Pmodule.mod_local)
           false info.info_current_mo
      then fprintf fmt "%s" s
      else
70
        (* let fname = if lp = [] then info.info_fname else None in *)
71
72
73
74
75
76
77
78
        let m = Strings.capitalize "m" in
        fprintf fmt "%s.%s" m s
    with Not_found ->
      let s = id_unique ~sanitizer iprinter id in
      fprintf fmt "%s" s

  let print_lident = print_qident ~sanitizer:Strings.uncapitalize
  let print_uident = print_qident ~sanitizer:Strings.capitalize
Mário Pereira's avatar
Mário Pereira committed
79
80

  let print_tv fmt tv =
81
    fprintf fmt "'%s" (id_unique aprinter tv.tv_name)
Mário Pereira's avatar
Mário Pereira committed
82

83
84
85
  let protect_on b s =
    if b then "(" ^^ s ^^ ")" else s

Mário Pereira's avatar
Mário Pereira committed
86
87
  let star fmt () = fprintf fmt " *@ "

88
89
  (** Types *)

90
  let rec print_ty ?(paren=false) fmt = function
91
    | Tvar tv ->
92
      print_tv fmt tv
Mário Pereira's avatar
Mário Pereira committed
93
    | Ttuple [] ->
94
      fprintf fmt "unit"
Mário Pereira's avatar
Mário Pereira committed
95
    | Ttuple tl ->
96
97
      fprintf fmt (protect_on paren "@[%a@]")
        (print_list star (print_ty ~paren:false)) tl
Mário Pereira's avatar
Mário Pereira committed
98
    | Tapp (ts, []) ->
99
      print_ident fmt ts
Mário Pereira's avatar
Mário Pereira committed
100
    | Tapp (ts, [ty]) ->
101
102
      fprintf fmt (protect_on paren "%a@ %a")
        (print_ty ~paren:true) ty print_ident ts
Mário Pereira's avatar
Mário Pereira committed
103
    | Tapp (ts, tl) ->
104
105
106
      fprintf fmt (protect_on paren "(%a)@ %a")
        (print_list comma (print_ty ~paren:false)) tl
        print_ident ts
Mário Pereira's avatar
Mário Pereira committed
107

108
  let print_vsty fmt (v, ty, _) =
109
110
111
112
113
114
115
    fprintf fmt "%a:@ %a" print_ident v (print_ty ~paren:false) ty

  let print_tv_arg = print_tv
  let print_tv_args fmt = function
    | []   -> ()
    | [tv] -> fprintf fmt "%a@ " print_tv_arg tv
    | tvl  -> fprintf fmt "(%a)@ " (print_list comma print_tv_arg) tvl
Mário Pereira's avatar
Mário Pereira committed
116
117
118
119

  let print_vs_arg fmt vs =
    fprintf fmt "@[(%a)@]" print_vsty vs

Mário Pereira's avatar
Mário Pereira committed
120
121
122
123
124
125
126
127
128
129
130
131
132
  let print_path =
    print_list dot pp_print_string (* point-free *)

  let print_path_id fmt = function
    | [], id -> print_ident fmt id
    | p, id  -> fprintf fmt "%a.%a" print_path p print_ident id

  let print_theory_name fmt th =
    print_path_id fmt (th.th_path, th.th_name)

  let print_module_name fmt m =
    print_theory_name fmt m.mod_theory

133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
  let rec print_pat fmt = function
    | Pwild ->
       fprintf fmt "_"
    | Pident id ->
       print_ident fmt id
    | Pas (p, id) ->
       fprintf fmt "%a as %a" print_pat p print_ident id
    | Por (p1, p2) ->
       fprintf fmt "%a | %a" print_pat p1 print_pat p2
    | Ptuple pl ->
       fprintf fmt "(%a)" (print_list comma print_pat) pl
    | Papp (id, []) ->
       print_ident fmt id
    | Papp (id, [p]) ->
       fprintf fmt "%a %a" print_ident id print_pat p
    | Papp (id, pl) ->
       fprintf fmt "%a (%a)" print_ident id (print_list comma print_pat) pl
    | Precord fl ->
       let print_field fmt (id, p) =
         fprintf fmt "%a = %a" print_ident id print_pat p
       in
       fprintf fmt "{ %a }" (print_list semi print_field) fl

156
157
158
159
160
161
162
163
164
165
166
167
  let print_const fmt c =
    let n = Number.compute_int c in
    let m = BigInt.to_int n in
    fprintf fmt "%d" m

  (** Expressions *)

  let extract_op {id_string = s} =
    try Some (Strings.remove_prefix "infix " s) with Not_found ->
    try Some (Strings.remove_prefix "prefix " s) with Not_found ->
    None

168
169
  let pv_name pv = pv.pv_vs.vs_name

170
  let rec print_apply info fmt rs pvl =
171
    let isfield =
172
173
      match rs.rs_field with
      | None -> false
174
175
176
177
178
179
180
181
182
      | Some _ -> true in
    let isconstructor () =
      let open Pdecl in
      match Mid.find_opt rs.rs_name info.info_mo_known_map with
      | Some {pd_node = PDtype its} ->
        let is_constructor its =
          List.exists (rs_equal rs) its.itd_constructors in
        List.exists is_constructor its
      | _ -> false
183
    in
184
    match extract_op rs.rs_name, pvl with
185
186
    | Some o, [t1; t2] ->
       fprintf fmt "@[<hov 1>%a %s %a@]"
187
         (print_expr info) t1 o (print_expr info) t2
188
    | _, [] ->
189
       print_ident fmt rs.rs_name
190
    | _, [t1] when isfield ->
191
192
193
194
      fprintf fmt "%a.%a" (print_expr info) t1 print_ident rs.rs_name
    | _, tl when isconstructor () ->
      fprintf fmt "@[<hov 2>%a (%a)@]"
        print_ident rs.rs_name (print_list comma (print_expr info)) tl
195
196
    | _, tl ->
       fprintf fmt "@[<hov 2>%a %a@]"
197
         print_ident rs.rs_name (print_list space (print_expr info)) tl
198

199
  and print_enode info fmt = function
200
201
    | Econst c ->
       fprintf fmt "%a" print_const c
202
    | Evar pvs ->
203
       (print_lident info) fmt (pv_name pvs)
204
    | Elet (pv, e1, e2) ->
Mário Pereira's avatar
Mário Pereira committed
205
       fprintf fmt "@[<hov 2>let @[%a@] =@ @[%a@]@] in@ %a"
206
         (print_lident info) (pv_name pv) (print_expr info) e1 (print_expr info) e2
207
208
    | Eabsurd ->
       fprintf fmt "assert false (* absurd *)"
209
210
211
212
213
214
    | Eapp (s, []) when rs_equal s rs_true ->
       fprintf fmt "true"
    | Eapp (s, []) when rs_equal s rs_false ->
       fprintf fmt "false"
    | Eapp (s, pvl) ->
       print_apply info fmt s pvl
215
    | Ematch (e, pl) ->
216
217
218
219
220
221
222
223
      fprintf fmt "@[begin match @[%a@] with@\n@[<hov>%a@] end@]"
        (print_expr info) e (print_list newline (print_branch info)) pl
    | Eassign [(rs, pv)] ->
      fprintf fmt "%a <-@ %a" print_ident rs.rs_name print_ident (pv_name pv)
    | Eif (e1, e2, e3) ->
      fprintf fmt
        "@[<hv>@[<hov 2>if@ %a@]@ then@;<1 2>@[%a@]@;<1 0>else@;<1 2>@[%a@]@]"
        (print_expr info) e1 (print_expr info) e2 (print_expr info) e3
224
    | Eblock [] ->
225
226
227
228
229
      fprintf fmt "()"
    | Eblock [e] ->
      print_expr info fmt e
    | Eblock el ->
      fprintf fmt "@[<hv>begin@;<1 2>@[%a@]@ end@]" (print_list semi (print_expr info)) el
230
    | _ -> (* TODO *) assert false
Mário Pereira's avatar
Mário Pereira committed
231

232
233
  and print_branch info fmt (p, e) =
    fprintf fmt "@[<hov 4>| %a ->@ %a@]" print_pat p (print_expr info) e
234

235
236
  and print_expr info fmt e =
    print_enode info fmt e.e_node
Mário Pereira's avatar
Mário Pereira committed
237

238
  let print_type_decl fmt its =
239
240
    let print_constr fmt (id, cs_args) =
      match cs_args with
241
242
243
244
245
246
247
      | [] ->
         fprintf fmt "@[<hov 4>| %a@]"
                 print_ident id (* FIXME: first letter must be uppercase
                                       -> print_uident *)
      | l ->
         fprintf fmt "@[<hov 4>| %a of %a@]"
                 print_ident id (* FIXME: print_uident *)
248
                 (print_list star (print_ty ~paren:false)) l in
249
250
251
252
    let print_field fmt (is_mutable, id, ty) =
      fprintf fmt "%s%a: %a;"
              (if is_mutable then "mutable " else "")
              print_ident id
253
              (print_ty ~paren:false) ty in
254
    let print_def fmt = function
255
256
257
258
259
260
261
262
263
264
265
      | None ->
        ()
      | Some (Ddata csl) ->
        fprintf fmt " =@\n%a" (print_list newline print_constr) csl
      | Some (Drecord fl) ->
        fprintf fmt " = %s{@\n%a@\n}"
          (if its.its_private then "private " else "")
          (print_list newline print_field) fl
      | Some (Dalias ty) ->
        fprintf fmt " =@ %a" (print_ty ~paren:false) ty
    in
266
    fprintf fmt "@[<hov 2>%s %a%a%a@]"
267
268
269
      (if true then "type" else "and") (* FIXME: mutual recursive types *)
      print_tv_args its.its_args
      print_ident its.its_name  (* FIXME: first letter must be lowercase
270
                                   -> print_lident *)
271
      print_def its.its_def
272

273
  let print_decl info fmt = function
274
    | Dlet (isrec, [rs, pvl, e]) ->
275
       fprintf fmt "@[<hov 2>%s %a@ %a@ =@ %a@]"
Mário Pereira's avatar
Mário Pereira committed
276
               (if isrec then "let rec" else "let")
277
278
               print_ident rs.rs_name
               (print_list space print_vs_arg) pvl
279
               (print_expr info) e;
Mário Pereira's avatar
Mário Pereira committed
280
       fprintf fmt "@\n@\n"
281
282
283
    | Dtype dl ->
       print_list newline print_type_decl fmt dl;
       fprintf fmt "@\n@\n"
284
285
286
    | Dexn (xs, None) ->
       fprintf fmt "exception %a@\n@\n" print_ident xs.xs_name
    | Dexn (xs, Some t) ->
287
       fprintf fmt "@[<hov 2>exception %a of %a@]@\n@\n"
288
               print_ident xs.xs_name (print_ty ~paren:true) t
289
    | _ -> (* TODO *) assert false
Mário Pereira's avatar
Mário Pereira committed
290
291
292

end

293
294
295
296
297
298
299
300
301
302
303
304
305
let extract_module pargs ?old fmt ({mod_theory = th} as m) =
  ignore (pargs);
  ignore (old);
  ignore (m);
  let info = {
    info_syn          = pargs.Pdriver.syntax;
    info_convert      = pargs.Pdriver.converter;
    info_current_th   = th;
    info_current_mo   = Some m;
    info_th_known_map = th.th_known;
    info_mo_known_map = m.mod_known;
    info_fname        = None; (* TODO *)
  } in
306
  fprintf fmt "(*@\n%a@\n*)@\n@\n" print_module m;
Mário Pereira's avatar
Mário Pereira committed
307
308
309
  fprintf fmt
    "(* This file has been generated from Why3 module %a *)@\n@\n"
    Print.print_module_name m;
310
  let mdecls = Translate.module_ info m in
311
  print_list nothing (Print.print_decl info) fmt mdecls;
Mário Pereira's avatar
Mário Pereira committed
312
  fprintf fmt "@."
313

314

315
316
317
318
let fg ?fname m =
  let mod_name = m.Pmodule.mod_theory.Theory.th_name.id_string in
  match fname with
  | None   -> mod_name ^ ".ml"
319
320
321
322
323
324
325
326
  | Some f ->
    (* TODO: replace with Filename.remove_extension
     * after migration to OCaml 4.04+ *)
    let remove_extension s =
      try Filename.chop_extension s
      with Invalid_argument _ -> s
    in
    (remove_extension f) ^ "__" ^ mod_name ^ ".ml"
327

328
329
let () = Pdriver.register_printer "ocaml"
  ~desc:"printer for OCaml code" fg extract_module
330

331
332
(*
 * Local Variables:
333
 * compile-command: "make -C ../.. -j3 bin/why3extract.opt"
334
335
 * End:
 *)