ocaml_printer.ml 15.6 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
open Pdecl
Mario Pereira's avatar
Mario Pereira committed
26
open Printer
Mário Pereira's avatar
Mário Pereira committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

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";]

43
44
45
46
47
  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
48
  let iprinter, aprinter =
Mário Pereira's avatar
Mário Pereira committed
49
    let isanitize = sanitizer char_to_alpha char_to_alnumus in
Mário Pereira's avatar
Mário Pereira committed
50
51
52
    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
53

Mário Pereira's avatar
Mário Pereira committed
54
  let forget_tvs () =
Mário Pereira's avatar
Mário Pereira committed
55
    forget_all iprinter
Mário Pereira's avatar
Mário Pereira committed
56
57

  let forget_id vs = forget_id iprinter vs
Mário Pereira's avatar
Mário Pereira committed
58
  let _forget_ids = List.iter forget_id
Mário Pereira's avatar
Mário Pereira committed
59
60
61
  let forget_var (id, _, _) = forget_id id
  let forget_vars = List.iter forget_var

Mário Pereira's avatar
Mário Pereira committed
62
63
64
65
66
  let forget_let_defn = function
  | Lvar (v,_) -> forget_pv v
  | Lsym (s,_,_) -> forget_rs s
  | Lrec rdl -> List.iter (fun fd -> forget_rs fd.rec_sym) rdl

Mário Pereira's avatar
Mário Pereira committed
67
68
69
70
71
72
73
74
  let rec forget_pat = function
    | Pwild -> ()
    | Pident id -> forget_id id
    | Papp (_, pl) | Ptuple pl -> List.iter forget_pat pl
    | Precord pl -> List.iter (fun (_,p) -> forget_pat p) pl
    | Por (p1, p2) -> forget_pat p1; forget_pat p2
    | Pas (p, _) -> forget_pat p

Mário Pereira's avatar
Mário Pereira committed
75
76
77
78
  let print_ident fmt id =
    let s = id_unique iprinter id in
    fprintf fmt "%s" s

79
80
  let print_qident ~sanitizer info fmt id =
    try
81
      let _, _, q =
82
83
84
85
86
87
88
89
90
91
92
        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
93
        (* let fname = if lp = [] then info.info_fname else None in *)
94
95
96
97
98
99
100
101
        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
102
103

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

106
107
108
  let protect_on b s =
    if b then "(" ^^ s ^^ ")" else s

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

111
112
  (** Types *)

Mario Pereira's avatar
Mario Pereira committed
113
  let rec print_ty ?(paren=false) info fmt = function
114
    | Tvar tv ->
115
      print_tv fmt tv
Mário Pereira's avatar
Mário Pereira committed
116
    | Ttuple [] ->
117
      fprintf fmt "unit"
Mário Pereira's avatar
Mário Pereira committed
118
    | Ttuple tl ->
119
      fprintf fmt (protect_on paren "@[%a@]")
Mario Pereira's avatar
Mario Pereira committed
120
        (print_list star (print_ty ~paren:false info)) tl
Mário Pereira's avatar
Mário Pereira committed
121
122
123
    | Tapp (ts, [t1; t2]) when id_equal ts ts_func.ts_name ->
      fprintf fmt (protect_on paren "@[%a ->@ %a@]")
        (print_ty ~paren:true info) t1 (print_ty info) t2
Mário Pereira's avatar
Mário Pereira committed
124
    | Tapp (ts, tl) ->
Mario Pereira's avatar
Mario Pereira committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
      begin match query_syntax info.info_syn ts with
        | Some s -> syntax_arguments s (print_ty info) fmt tl
        | None   ->
          begin match tl with
            | [] ->
              print_ident fmt ts
            | [ty] ->
              fprintf fmt (protect_on paren "%a@ %a")
                (print_ty ~paren:true info) ty print_ident ts
            | tl ->
              fprintf fmt (protect_on paren "(%a)@ %a")
                (print_list comma (print_ty ~paren:false info)) tl
                print_ident ts
          end
      end

  let print_vsty info fmt (v, ty, _) =
    fprintf fmt "%a:@ %a" print_ident v (print_ty ~paren:false info) ty
143
144
145
146
147
148

  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
149

Mario Pereira's avatar
Mario Pereira committed
150
151
  let print_vs_arg info fmt vs =
    fprintf fmt "@[(%a)@]" (print_vsty info) vs
Mário Pereira's avatar
Mário Pereira committed
152

Mário Pereira's avatar
Mário Pereira committed
153
154
155
156
157
158
159
160
161
162
163
164
165
  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

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
  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

189
190
191
192
193
194
195
  (** 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

196
197
  let pv_name pv = pv.pv_vs.vs_name

Mário Pereira's avatar
Mário Pereira committed
198
199
200
201
202
203
204
205
  let get_record info rs =
    match Mid.find_opt rs.rs_name info.info_mo_known_map with
    | Some {pd_node = PDtype itdl} ->
      let itd = List.find (fun {itd_constructors=constr} ->
          List.exists (rs_equal rs) constr) itdl in
      List.filter (fun e -> not (rs_ghost e)) itd.itd_fields
    | _ -> []

Mario Pereira's avatar
Mario Pereira committed
206
207
  let ht_rs = Hrs.create 7 (* rec_rsym -> rec_sym *)

Mario Pereira's avatar
Mario Pereira committed
208
  let rec args_syntax info fmt s tl =
Mário Pereira's avatar
Mário Pereira committed
209
210
    try
      ignore (Str.search_forward (Str.regexp "[%]\\([tv]?\\)[0-9]+") s 0);
Mario Pereira's avatar
Mario Pereira committed
211
      syntax_arguments s (print_expr info) fmt tl
Mário Pereira's avatar
Mário Pereira committed
212
    with Not_found -> ()
Mário Pereira's avatar
Mário Pereira committed
213

Mario Pereira's avatar
Mario Pereira committed
214
  and print_apply info fmt rs pvl =
215
    let isfield =
216
217
      match rs.rs_field with
      | None -> false
218
219
220
221
222
223
224
225
226
      | 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
227
    in
Mário Pereira's avatar
Mário Pereira committed
228
229
230
231
232
233
234
235
    match query_syntax info.info_convert rs.rs_name,
          query_syntax info.info_syn rs.rs_name, pvl with
    | Some s, _, _
    | _, Some s, _ ->
      syntax_arguments s (print_expr info) fmt pvl
    | _, _, [] ->
      print_ident fmt rs.rs_name
    | _,  _, [t1] when isfield ->
236
      fprintf fmt "%a.%a" (print_expr info) t1 print_ident rs.rs_name
Mário Pereira's avatar
Mário Pereira committed
237
    | _, _, tl when isconstructor () ->
Mário Pereira's avatar
Mário Pereira committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
      let pjl = get_record info rs in
      if pjl = [] then
        fprintf fmt "@[<hov 2>%a (%a)@]"
          print_ident rs.rs_name (print_list comma (print_expr info)) tl
      else
        let rec print_list2 sep sep_m print1 print2 fmt (l1, l2) =
          match l1, l2 with
          | x1 :: r1, x2 :: r2 ->
            print1 fmt x1; sep_m fmt (); print2 fmt x2; sep fmt ();
            print_list2 sep sep_m print1 print2 fmt (r1, r2)
          | _ -> ()
        in
        let print_rs info fmt rs =
          fprintf fmt "%a" (print_lident info) rs.rs_name
        in
Mário Pereira's avatar
Mário Pereira committed
253
        fprintf fmt "@[<hov 2>{ %a}@]"
Mário Pereira's avatar
Mário Pereira committed
254
          (print_list2 semi equal (print_rs info) (print_expr info)) (pjl, tl)
Mário Pereira's avatar
Mário Pereira committed
255
    | _, _, tl ->
Mário Pereira's avatar
Mário Pereira committed
256
257
        fprintf fmt "@[<hov 2>%a %a@]"
          print_ident rs.rs_name (print_list space (print_expr info)) tl
258

Mário Pereira's avatar
Mário Pereira committed
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
  and print_let_def info fmt = function
    | Lvar (pv, e) ->
      fprintf fmt "@[<hov 2>let %a =@ %a@]"
        (print_lident info) (pv_name pv) (print_expr info) e;
      (* forget_id (pv_name pv) *)
    | Lsym (rs, args, ef) ->
      fprintf fmt "@[<hov 2>let %a %a@ =@ @[%a@]@]"
        (print_lident info) rs.rs_name
        (print_list space (print_vs_arg info)) args
        (print_expr info) ef;
      forget_vars args
    | Lrec (rdef) ->
      let print_one fst fmt = function
        | { rec_sym = rs1; rec_args = args; rec_exp = e } ->
          fprintf fmt "@[<hov 2>%s %a@ %a@ =@ %a@]"
            (if fst then "let rec" else "and")
            (print_lident info) rs1.rs_name
            (print_list space (print_vs_arg info)) args
            (print_expr info) e;
          forget_vars args;
          forget_tvs ()
      in
      List.iter (fun fd -> Hrs.replace ht_rs fd.rec_rsym fd.rec_sym) rdef;
      print_list_next newline print_one fmt rdef;
      List.iter (fun fd -> Hrs.remove ht_rs fd.rec_rsym) rdef

285
  and print_enode info fmt = function
286
    | Econst c ->
Mário Pereira's avatar
Mário Pereira committed
287
288
      let n = Number.compute_int c in
      fprintf fmt "(Z.of_string \"%s\")" (BigInt.to_string n)
289
    | Evar pvs ->
Mário Pereira's avatar
Mário Pereira committed
290
      (print_lident info) fmt (pv_name pvs)
Mário Pereira's avatar
Mário Pereira committed
291
292
293
294
295
    | Elet (let_def, e) ->
      fprintf fmt "@[%a@] in@ %a"
        (print_let_def info) let_def
        (print_expr info) e;
      forget_let_defn let_def
296
    | Eabsurd ->
Mário Pereira's avatar
Mário Pereira committed
297
      fprintf fmt "assert false (* absurd *)"
298
    | Eapp (s, []) when rs_equal s rs_true ->
Mário Pereira's avatar
Mário Pereira committed
299
      fprintf fmt "true"
300
    | Eapp (s, []) when rs_equal s rs_false ->
Mário Pereira's avatar
Mário Pereira committed
301
302
303
304
      fprintf fmt "false"
    | Eapp (s, [e1; e2]) when rs_equal s rs_func_app ->
      fprintf fmt "@[<hov 1>%a %a@]"
        (print_expr info) e1 (print_expr info) e2
305
    | Eapp (s, pvl) ->
Mario Pereira's avatar
Mario Pereira committed
306
      print_apply info fmt (Hrs.find_def ht_rs s s) pvl
307
    | Ematch (e, pl) ->
Mário Pereira's avatar
Mário Pereira committed
308
      fprintf fmt "begin match @[%a@] with@\n@[<hov>%a@] end"
309
        (print_expr info) e (print_list newline (print_branch info)) pl
Mário Pereira's avatar
Mário Pereira committed
310
311
312
313
314
315
316
317
    | Eassign [(rho, rs, pv)] ->
      fprintf fmt "%a.%a <-@ %a"
        print_ident (pv_name rho) print_ident rs.rs_name
        print_ident (pv_name pv)
    | Eif (e1, e2, {e_node = Eblock []}) ->
      fprintf fmt
        "@[<hv>@[<hov 2>if@ %a@]@ then begin@;<1 2>@[%a@] end@]"
        (print_expr info) e1 (print_expr info) e2
318
319
320
321
    | 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
322
    | Eblock [] ->
323
324
325
326
      fprintf fmt "()"
    | Eblock [e] ->
      print_expr info fmt e
    | Eblock el ->
327
328
329
330
      fprintf fmt "@[<hv>begin@;<1 2>@[%a@]@ end@]"
        (print_list semi (print_expr info)) el
    | Efun (varl, e) ->
      fprintf fmt "@[<hov 2>(fun %a ->@ %a)@]"
Mario Pereira's avatar
Mario Pereira committed
331
        (print_list space (print_vs_arg info)) varl (print_expr info) e
Mário Pereira's avatar
Mário Pereira committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
    | Ewhile (e1, e2) ->
      fprintf fmt "@[<hov 2>while %a do@ %a@ done@]"
        (print_expr info) e1 (print_expr info) e2
    | Eraise (Xident id, None) -> (* FIXME : check exceptions in driver *)
      fprintf fmt "raise %a" (print_uident info) id
    | Eraise (Xident id, Some e) ->
      fprintf fmt "(raise %a %a)"
        (print_uident info) id (print_expr info) e
    | Etuple _ -> (* TODO *) assert false
    | Efor (pv1, pv2, direction, pv3, e) ->
      let print_for_direction fmt = function
        | To -> fprintf fmt "to"
        | DownTo -> fprintf fmt "downto"
      in
      fprintf fmt "@[<hov 2>for %a = %a %a %a do@ @[%a@]@ done@]"
        (print_lident info) (pv_name pv1)
        (print_lident info) (pv_name pv2)
        print_for_direction direction
        (print_lident info) (pv_name pv3)
        (print_expr info) e
    | Etry _ -> (* TODO *) assert false
    | Enot _ -> (* TODO *) assert false
    | Ebinop _ -> (* TODO *) assert false
    | Ecast _ -> (* TODO *) assert false
    | Eassign _ -> (* TODO *) assert false
Mário Pereira's avatar
Mário Pereira committed
357

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

361
362
  and print_expr info fmt e =
    print_enode info fmt e.e_node
Mário Pereira's avatar
Mário Pereira committed
363

Mario Pereira's avatar
Mario Pereira committed
364
  let print_type_decl info fmt its =
365
366
    let print_constr fmt (id, cs_args) =
      match cs_args with
367
368
369
370
371
372
373
      | [] ->
         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 *)
Mario Pereira's avatar
Mario Pereira committed
374
                 (print_list star (print_ty ~paren:false info)) l in
375
376
377
378
    let print_field fmt (is_mutable, id, ty) =
      fprintf fmt "%s%a: %a;"
              (if is_mutable then "mutable " else "")
              print_ident id
Mario Pereira's avatar
Mario Pereira committed
379
              (print_ty ~paren:false info) ty in
380
    let print_def fmt = function
381
382
383
384
385
386
387
388
389
      | 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) ->
Mario Pereira's avatar
Mario Pereira committed
390
        fprintf fmt " =@ %a" (print_ty ~paren:false info) ty
391
    in
392
    fprintf fmt "@[<hov 2>%s %a%a%a@]"
393
394
395
      (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
396
                                   -> print_lident *)
397
      print_def its.its_def
398

399
  let print_decl info fmt = function
Mário Pereira's avatar
Mário Pereira committed
400
401
402
    | Dlet (ldef) ->
      print_let_def info fmt ldef;
      forget_tvs ();
Mario Pereira's avatar
Mario Pereira committed
403
      fprintf fmt "@\n@\n"
404
    | Dtype dl ->
Mario Pereira's avatar
Mario Pereira committed
405
       print_list newline (print_type_decl info) fmt dl;
406
       fprintf fmt "@\n@\n"
407
408
409
    | Dexn (xs, None) ->
       fprintf fmt "exception %a@\n@\n" print_ident xs.xs_name
    | Dexn (xs, Some t) ->
410
       fprintf fmt "@[<hov 2>exception %a of %a@]@\n@\n"
Mario Pereira's avatar
Mario Pereira committed
411
               print_ident xs.xs_name (print_ty ~paren:true info) t
Mário Pereira's avatar
Mário Pereira committed
412
413
end

414
415
416
417
418
419
420
421
422
423
424
425
426
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
Mário Pereira's avatar
Mário Pereira committed
427
428
429
  fprintf fmt
    "(* This file has been generated from Why3 module %a *)@\n@\n"
    Print.print_module_name m;
430
  let mdecls = Translate.module_ info m in
431
  print_list nothing (Print.print_decl info) fmt mdecls;
Mário Pereira's avatar
Mário Pereira committed
432
  fprintf fmt "@."
433

434

435
436
437
438
let fg ?fname m =
  let mod_name = m.Pmodule.mod_theory.Theory.th_name.id_string in
  match fname with
  | None   -> mod_name ^ ".ml"
439
440
441
442
443
444
445
  | 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
Mário Pereira's avatar
Mário Pereira committed
446
    let f = Filename.basename f in
447
    (remove_extension f) ^ "__" ^ mod_name ^ ".ml"
448

449
450
let () = Pdriver.register_printer "ocaml"
  ~desc:"printer for OCaml code" fg extract_module
451

452
453
(*
 * Local Variables:
454
 * compile-command: "make -C ../.. -j3 bin/why3extract.opt"
455
456
 * End:
 *)