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
55
56
57
  let forget_tvs () =
    forget_all aprinter

  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
67
68
69
  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
70
71
72
73
  let print_ident fmt id =
    let s = id_unique iprinter id in
    fprintf fmt "%s" s

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

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

101
102
103
  let protect_on b s =
    if b then "(" ^^ s ^^ ")" else s

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

106
107
  (** Types *)

Mario Pereira's avatar
Mario Pereira committed
108
  let rec print_ty ?(paren=false) info fmt = function
109
    | Tvar tv ->
110
      print_tv fmt tv
Mário Pereira's avatar
Mário Pereira committed
111
    | Ttuple [] ->
112
      fprintf fmt "unit"
Mário Pereira's avatar
Mário Pereira committed
113
    | Ttuple tl ->
114
      fprintf fmt (protect_on paren "@[%a@]")
Mario Pereira's avatar
Mario Pereira committed
115
        (print_list star (print_ty ~paren:false info)) tl
Mário Pereira's avatar
Mário Pereira committed
116
117
118
    | 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
119
    | Tapp (ts, tl) ->
Mario Pereira's avatar
Mario Pereira committed
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
      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
138
139
140
141
142
143

  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
144

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

Mário Pereira's avatar
Mário Pereira committed
148
149
150
151
152
153
154
155
156
157
158
159
160
  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

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
  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

184
185
186
187
188
189
190
  (** 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

191
192
  let pv_name pv = pv.pv_vs.vs_name

Mário Pereira's avatar
Mário Pereira committed
193
194
195
196
197
198
199
200
  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
201
  let rec args_syntax info fmt s tl =
Mário Pereira's avatar
Mário Pereira committed
202
203
    try
      ignore (Str.search_forward (Str.regexp "[%]\\([tv]?\\)[0-9]+") s 0);
Mario Pereira's avatar
Mario Pereira committed
204
      syntax_arguments s (print_expr info) fmt tl
Mário Pereira's avatar
Mário Pereira committed
205
    with Not_found -> ()
Mário Pereira's avatar
Mário Pereira committed
206

Mario Pereira's avatar
Mario Pereira committed
207
  and print_apply info fmt rs pvl =
208
    let isfield =
209
210
      match rs.rs_field with
      | None -> false
211
212
213
214
215
216
217
218
219
      | 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
220
    in
Mário Pereira's avatar
Mário Pereira committed
221
222
223
224
225
226
227
228
    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 ->
229
      fprintf fmt "%a.%a" (print_expr info) t1 print_ident rs.rs_name
Mário Pereira's avatar
Mário Pereira committed
230
    | _, _, tl when isconstructor () ->
Mário Pereira's avatar
Mário Pereira committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
      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
246
        fprintf fmt "@[<hov 2>{ %a}@]"
Mário Pereira's avatar
Mário Pereira committed
247
          (print_list2 semi equal (print_rs info) (print_expr info)) (pjl, tl)
Mário Pereira's avatar
Mário Pereira committed
248
    | _, _, tl ->
Mário Pereira's avatar
Mário Pereira committed
249
250
        fprintf fmt "@[<hov 2>%a %a@]"
          print_ident rs.rs_name (print_list space (print_expr info)) tl
251

252
  and print_enode info fmt = function
253
    | Econst c ->
Mário Pereira's avatar
Mário Pereira committed
254
255
      let n = Number.compute_int c in
      fprintf fmt "(Z.of_string \"%s\")" (BigInt.to_string n)
256
    | Evar pvs ->
Mário Pereira's avatar
Mário Pereira committed
257
      (print_lident info) fmt (pv_name pvs)
258
    | Elet (pv, e1, e2) ->
Mário Pereira's avatar
Mário Pereira committed
259
260
261
262
      fprintf fmt "@[<hov 2>let %a =@ %a@] in@\n%a"
        (print_lident info) (pv_name pv)
        (print_expr info) e1 (print_expr info) e2;
      forget_id (pv_name pv)
263
    | Eabsurd ->
Mário Pereira's avatar
Mário Pereira committed
264
      fprintf fmt "assert false (* absurd *)"
265
    | Eapp (s, []) when rs_equal s rs_true ->
Mário Pereira's avatar
Mário Pereira committed
266
      fprintf fmt "true"
267
    | Eapp (s, []) when rs_equal s rs_false ->
Mário Pereira's avatar
Mário Pereira committed
268
269
270
271
      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
272
    | Eapp (s, pvl) ->
Mário Pereira's avatar
Mário Pereira committed
273
      print_apply info fmt s pvl
274
    | Ematch (e, pl) ->
Mário Pereira's avatar
Mário Pereira committed
275
      fprintf fmt "begin match @[%a@] with@\n@[<hov>%a@] end"
276
        (print_expr info) e (print_list newline (print_branch info)) pl
Mário Pereira's avatar
Mário Pereira committed
277
278
279
280
281
282
283
284
    | 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
285
286
287
288
    | 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
289
    | Eblock [] ->
290
291
292
293
      fprintf fmt "()"
    | Eblock [e] ->
      print_expr info fmt e
    | Eblock el ->
294
295
296
297
      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
298
        (print_list space (print_vs_arg info)) varl (print_expr info) e
299
300
301
302
303
304
305
306
307
308
    | Eletrec (is_rec, [rs, [], ef], ein) ->
      fprintf fmt "@[<hov 2>let %s%a =@ @[%a@]@] in@ %a"
        (if is_rec then "rec " else "")
        (print_lident info) rs.rs_name
        (print_expr info) ef
        (print_expr info) ein
    | Eletrec (is_rec, [rs, args, ef], ein) ->
      fprintf fmt "@[<hov 2>let %s%a %a@ =@ @[%a@]@] in@ %a"
        (if is_rec then "rec " else "")
        (print_lident info) rs.rs_name
Mario Pereira's avatar
Mario Pereira committed
309
        (print_list space (print_vs_arg info)) args
310
311
        (print_expr info) ef
        (print_expr info) ein
Mário Pereira's avatar
Mário Pereira committed
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
    | 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
    | Eletrec _ -> (* TODO *) assert false
    | Ecast _ -> (* TODO *) assert false
    | Eassign _ -> (* TODO *) assert false
Mário Pereira's avatar
Mário Pereira committed
338

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

342
343
  and print_expr info fmt e =
    print_enode info fmt e.e_node
Mário Pereira's avatar
Mário Pereira committed
344

Mario Pereira's avatar
Mario Pereira committed
345
  let print_type_decl info fmt its =
346
347
    let print_constr fmt (id, cs_args) =
      match cs_args with
348
349
350
351
352
353
354
      | [] ->
         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
355
                 (print_list star (print_ty ~paren:false info)) l in
356
357
358
359
    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
360
              (print_ty ~paren:false info) ty in
361
    let print_def fmt = function
362
363
364
365
366
367
368
369
370
      | 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
371
        fprintf fmt " =@ %a" (print_ty ~paren:false info) ty
372
    in
373
    fprintf fmt "@[<hov 2>%s %a%a%a@]"
374
375
376
      (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
377
                                   -> print_lident *)
378
      print_def its.its_def
379

380
  let print_decl info fmt = function
Mário Pereira's avatar
Mário Pereira committed
381
382
383
384
385
386
387
    | Dlet (isrec, [rs, [], e]) ->
       fprintf fmt "@[<hov 2>%s %a =@ %a@]"
               (if isrec then "let rec" else "let")
               print_ident rs.rs_name
               (print_expr info) e;
       forget_tvs ();
       fprintf fmt "@\n@\n"
388
    | Dlet (isrec, [rs, pvl, e]) ->
Mário Pereira's avatar
Mário Pereira committed
389
       fprintf fmt "@[<hov 2>%s %a@ %a =@ %a@]"
Mário Pereira's avatar
Mário Pereira committed
390
               (if isrec then "let rec" else "let")
391
               print_ident rs.rs_name
Mario Pereira's avatar
Mario Pereira committed
392
               (print_list space (print_vs_arg info)) pvl
393
               (print_expr info) e;
Mário Pereira's avatar
Mário Pereira committed
394
395
       forget_vars pvl;
       forget_tvs ();
Mário Pereira's avatar
Mário Pereira committed
396
       fprintf fmt "@\n@\n"
397
    | Dtype dl ->
Mario Pereira's avatar
Mario Pereira committed
398
       print_list newline (print_type_decl info) fmt dl;
399
       fprintf fmt "@\n@\n"
400
401
402
    | Dexn (xs, None) ->
       fprintf fmt "exception %a@\n@\n" print_ident xs.xs_name
    | Dexn (xs, Some t) ->
403
       fprintf fmt "@[<hov 2>exception %a of %a@]@\n@\n"
Mario Pereira's avatar
Mario Pereira committed
404
               print_ident xs.xs_name (print_ty ~paren:true info) t
405
    | _ -> (* TODO *) assert false
Mário Pereira's avatar
Mário Pereira committed
406
407
408

end

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

430

431
432
433
434
let fg ?fname m =
  let mod_name = m.Pmodule.mod_theory.Theory.th_name.id_string in
  match fname with
  | None   -> mod_name ^ ".ml"
435
436
437
438
439
440
441
  | 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
442
    let f = Filename.basename f in
443
    (remove_extension f) ^ "__" ^ mod_name ^ ".ml"
444

445
446
let () = Pdriver.register_printer "ocaml"
  ~desc:"printer for OCaml code" fg extract_module
447

448
449
(*
 * Local Variables:
450
 * compile-command: "make -C ../.. -j3 bin/why3extract.opt"
451
452
 * End:
 *)