characteristic.ml 60.2 KB
Newer Older
charguer's avatar
init  
charguer committed
1 2 3 4 5 6 7 8 9 10 11
open Misc
open Asttypes
open Types
open Typedtree
open Mytools
open Longident
open Print_tast
open Print_type
open Formula
open Coq
open Path
charguer's avatar
charguer committed
12
open Renaming
charguer's avatar
init  
charguer committed
13 14
open Printf

charguer's avatar
credits  
charguer committed
15 16


charguer's avatar
init  
charguer committed
17 18 19
(*#########################################################################*)
(* ** Error messages *)

charguer's avatar
charguer committed
20
exception Not_in_normal_form of Location.t * string
charguer's avatar
init  
charguer committed
21

charguer's avatar
charguer committed
22 23
let not_in_normal_form loc s =
   raise (Not_in_normal_form (loc, s))
charguer's avatar
init  
charguer committed
24 25


charguer's avatar
charguer committed
26 27 28 29 30 31
(*#########################################################################*)
(* ** List of external modules that need to be required *)

let external_modules = ref []

let external_modules_add name =
32 33 34
   if not (List.mem name !external_modules) 
     then external_modules := name::!external_modules
   (* TODO: use a structure more efficient than lists *)
charguer's avatar
charguer committed
35 36

let external_modules_get_coqtop () = 
charguer's avatar
charguer committed
37
   List.map (fun name -> Coqtop_require [name]) !external_modules
charguer's avatar
charguer committed
38 39 40 41 42

let external_modules_reset () = 
   external_modules := []


charguer's avatar
charguer committed
43

charguer's avatar
init  
charguer committed
44 45 46
(*#########################################################################*)
(* ** Lifting of paths *)

charguer's avatar
charguer committed
47 48 49
(* Take a module name and add "_ml" suffix to it;
   Moreover, insert a "Require" directive in case the module 
   corresponds to a file (i.e. a compilation unit. *)
charguer's avatar
charguer committed
50

charguer's avatar
charguer committed
51
let lift_module_name id =
charguer's avatar
init  
charguer committed
52
   let name = Ident.name id in
charguer's avatar
charguer committed
53
   let coqname = module_name name in
charguer's avatar
charguer committed
54 55
   if Ident.persistent id then external_modules_add coqname;
   coqname
charguer's avatar
charguer committed
56

charguer's avatar
charguer committed
57
   (* -- old:
charguer's avatar
charguer committed
58
     if Ident.persistent id  
charguer's avatar
charguer committed
59
      then (let result = name ^ "_ml" in external_modules_add result; result)
charguer's avatar
init  
charguer committed
60
      else "ML" ^ name
charguer's avatar
charguer committed
61 62
   *)
   (* -- old: if name = "OkaStream" then "CFPrim" else  *)
charguer's avatar
init  
charguer committed
63

charguer's avatar
charguer committed
64 65 66 67
(* Function for adding "_ml" to the modules in a path, 
   including the last constant which is assumed to a module name *)
   (* TODO: rename this function *)

charguer's avatar
init  
charguer committed
68
let rec lift_full_path = function
charguer's avatar
charguer committed
69
  | Pident id -> Pident (Ident.create (lift_module_name id))
charguer's avatar
charguer committed
70
  | Pdot(p, s, pos) -> Pdot(lift_full_path p, (module_name s), pos) 
charguer's avatar
init  
charguer committed
71 72
  | Papply(p1, p2) -> assert false 

charguer's avatar
charguer committed
73 74 75
(* Function for adding "_ml" to the modules in a path, 
   but not changing the last constant in the path *)

charguer's avatar
init  
charguer committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
let lift_path = function
  | Pident id -> Pident id
  | Pdot(p, s, pos) -> Pdot(lift_full_path p, s, pos) 
  | Papply(p1, p2) -> assert false 

(** Translates a path into a string. A module called "Test" 
    becomes "Test_ml" if it refers to a file, and it becomes
    "MLTest" if it refers to a functor argument. 
    --todo: call them all "Test_ml"? *)

let lift_full_path_name p =
  Path.name (lift_full_path p)

(** Translates a path into a string --todo: why not full? *)

let lift_path_name p =
  Path.name (lift_path p)


(*#########################################################################*)
(* ** Lifting of types *)

(** Computes the free variables of a [btyp] *)

let rec fv_btyp ?(through_arrow = true) t =
   let aux = fv_btyp in
   match t with
   | Btyp_val -> []
   | Btyp_arrow (t1,t2) -> if through_arrow then aux t1 @ aux t2 else []
   | Btyp_constr (id,ts) -> list_concat_map aux ts
   | Btyp_tuple ts -> list_concat_map aux ts
   | Btyp_var (b,s) -> [s]
charguer's avatar
charguer committed
108
   | Btyp_poly (ss,t) -> unsupported_noloc "poly-types"
charguer's avatar
init  
charguer committed
109 110 111 112 113 114 115 116 117 118 119
   | Btyp_alias (t,s) -> s :: aux t 

(** Translates a [btyp] into a Coq type *)

let rec lift_btyp t =
   let aux = lift_btyp in
   match t with
   | Btyp_val -> 
      val_type
   | Btyp_arrow (t1,t2) -> 
      val_type
charguer's avatar
charguer committed
120 121
   | Btyp_constr (id,[t]) when Path.name id = "array" -> 
      (* || Path.name id = "Pervasives.array" *)
charguer's avatar
init  
charguer committed
122 123
      loc_type
   | Btyp_constr (id,ts) -> 
charguer's avatar
charguer committed
124
      coq_apps (Coq_var (type_constr_name (lift_path_name id))) (List.map aux ts)
charguer's avatar
init  
charguer committed
125 126 127
   | Btyp_tuple ts -> 
      coq_prod (List.map aux ts)
   | Btyp_var (b,s) -> 
charguer's avatar
charguer committed
128
      if b then unsupported_noloc "non-generalizable free type variables (of the form '_a); please add a type annotation";
charguer's avatar
init  
charguer committed
129 130
      Coq_var s
   | Btyp_poly (ss,t) -> 
charguer's avatar
charguer committed
131
      unsupported_noloc "poly-types"
charguer's avatar
init  
charguer committed
132 133 134
   | Btyp_alias (t1,s) -> 
      let occ = fv_btyp ~through_arrow:false t1 in
      if List.mem s occ 
charguer's avatar
charguer committed
135
        then unsupported_noloc ("found a recursive type that is not erased by an arrow:" ^ (print_out_type t));
charguer's avatar
init  
charguer committed
136 137
      aux t1 

charguer's avatar
charguer committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
(* TEMPORARILY DEPRECATED

   | Btyp_constr (id,[t]) when Path.name id = "ref" || Path.name id = "Pervasives.ref" ->
      loc_type

   | Btyp_constr (id,[t]) when Path.name id = "heap" || Path.name id = "Heap.heap" ->
      loc_type

   | Btyp_constr (id,[t]) when Path.same id Predef.path_lazy_t || Path.name id = "Lazy.t" -> 
      aux t  
   | Btyp_constr (id,[t]) when Path.name id = "Stream.stream" || Path.name id = "stream" -> 
      Coq_app (Coq_var "list", aux t)
   | Btyp_constr (id,[t]) when Path.name id = "Stream.stream_cell" || Path.name id = "stream_cell" -> 
      Coq_app (Coq_var "list", aux t)
*)
(* REMARK: les Lazy provenant des patterns ne sont pas identique Predef.path_lazy_t *)


charguer's avatar
init  
charguer committed
156 157 158 159 160 161 162 163
(** Translates a Caml type into a Coq type *)

let lift_typ_exp ty =
  lift_btyp (btyp_of_typ_exp ty)  

(** Translates a Caml type scheme into a Coq type *)

let lift_typ_sch ty =
charguer's avatar
charguer committed
164 165
   let t = btyp_of_typ_sch_simple ty in
   let fv = fv_btyp ~through_arrow:false t in
charguer's avatar
init  
charguer committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
   fv, lift_btyp t

(** Translates the type of a Caml expression into a Coq type *)

let coq_typ e =
   lift_typ_exp (e.exp_type)

(** Translates the type of a Caml pattern into a Coq type *)

let coq_typ_pat p =
   lift_typ_exp (p.pat_type)

(** Decompose "A.B.s" as ("A.B","s") *)

let rec path_decompose = function
    Pident id -> ("", Ident.name id)
  | Pdot(p, s, pos) -> 
      let (f,r) = path_decompose p in
      (f ^ r ^ ".", s)
charguer's avatar
charguer committed
185
  | Papply(p1, p2) -> unsupported_noloc "application in paths"
charguer's avatar
init  
charguer committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222


(** Extracts a record path_name / path from a type *)

let get_record_decomposed_name_for_exp e = 
   let b = btyp_of_typ_exp (e.exp_type) in   
   match b with 
   | Btyp_constr (p,_) -> path_decompose (lift_path p)
   | _ -> failwith "illegal argument for get_record_decomposed_name_for_exp"



(*#########################################################################*)
(* ** Type arity functions *)

(** Get the number of type arguments of a (polymorphic) free variable *)

let typ_arity_var env x =
   match x with
   | Path.Pident id -> 
      begin try Ident.find_same id env
      with Not_found -> 0 end
   | _ -> 0

(** Get the number of type arguments of a (polymorphic) data constructor *)

let typ_arity_constr c =
   match (c.cstr_res).desc with
   | Tconstr (_,ts,_) -> List.length ts
   | _ -> failwith "typ_arity_constr: result type of constructor is not a type constructor"

(** Translate a Caml data constructor into a Coq expression *)

let coq_of_constructor p c =
   let x = string_of_path p in
   match find_builtin_constructor x with
   | None -> coq_app_var_wilds x (typ_arity_constr c) 
charguer's avatar
encours  
charguer committed
223
   | Some (y,arity) -> coq_app_var_wilds y arity
charguer's avatar
init  
charguer committed
224 225 226 227 228 229 230 231


(*#########################################################################*)
(* ** Lifting of patterns *)

(** Compute the free variables of a pattern *)

let rec pattern_variables p : typed_vars = (* ignores aliases *)
charguer's avatar
charguer committed
232
   let loc = p.pat_loc in
charguer's avatar
init  
charguer committed
233 234
   let aux = pattern_variables in
   match p.pat_desc with
charguer's avatar
charguer committed
235
   | Tpat_any -> not_in_normal_form loc "wildcard patterns remain after normalization"
charguer's avatar
init  
charguer committed
236 237 238 239 240 241
   | Tpat_var s -> [Ident.name s, coq_typ_pat p]
   | Tpat_alias (p, s) -> aux p
   | Tpat_constant c -> []
   | Tpat_tuple l -> list_concat_map aux l
   | Tpat_construct (p, c, ps) -> list_concat_map aux ps
   | Tpat_lazy p1 -> aux p1
charguer's avatar
charguer committed
242 243 244 245
   | Tpat_variant (_,_,_) -> unsupported loc "variant patterns"
   | Tpat_record _ -> unsupported loc "record patterns"
   | Tpat_array pats -> unsupported loc "array patterns"
   | Tpat_or (_,p1,p2) -> unsupported loc "or patterns"
charguer's avatar
init  
charguer committed
246 247 248 249 250

(** Translate a Caml pattern into a Coq expression, and
    ignores the aliases found in the pattern *)

let rec lift_pat ?(through_aliases=true) p : coq = 
charguer's avatar
charguer committed
251
   let loc = p.pat_loc in
charguer's avatar
init  
charguer committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
   let aux = lift_pat ~through_aliases:through_aliases in
   match p.pat_desc with
   | Tpat_var s -> 
      Coq_var (Ident.name s)
   | Tpat_constant (Const_int n) -> 
      Coq_int n
   | Tpat_tuple l -> 
      Coq_tuple (List.map aux l)
   | Tpat_construct (p, c, ps) -> 
      coq_apps (coq_of_constructor p c) (List.map aux ps)
   | Tpat_alias (p, ak) -> 
      begin match ak with
      | TPat_alias id -> 
          if through_aliases then aux p else Coq_var (Ident.name id)
      | TPat_constraint _ -> aux p
      | TPat_type pp -> aux p 
      end
   | Tpat_lazy p1 ->
      aux p1
charguer's avatar
charguer committed
271 272 273 274 275 276
   | Tpat_record _ -> unsupported loc "record patterns" (* todo! *)
   | Tpat_array pats -> unsupported loc "array patterns" (* todo! *)
   | Tpat_constant _ -> unsupported loc "only integer constant are supported"
   | Tpat_any -> not_in_normal_form loc "wildcard patterns remain after normalization"
   | Tpat_variant (_,_,_) -> unsupported loc "variant patterns"
   | Tpat_or (_,p1,p2) -> unsupported loc "or patterns in depth"
charguer's avatar
init  
charguer committed
277 278 279 280 281

(** Extracts the aliases from a Caml pattern, in the form of an
    association list mapping variables to Coq expressions *)

let pattern_aliases p : (typed_var*coq) list = 
charguer's avatar
charguer committed
282
   let loc = p.pat_loc in
charguer's avatar
init  
charguer committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296
   let rec aux p =
      match p.pat_desc with
      | Tpat_var s -> []
      | Tpat_constant (Const_int n) -> []
      | Tpat_tuple l -> list_concat_map aux l
      | Tpat_construct (p, c, ps) -> list_concat_map aux ps
      | Tpat_alias (p1, ak) -> 
          begin match ak with
          | TPat_alias id ->
             ((Ident.name id, coq_typ_pat p), lift_pat ~through_aliases:false p1) :: (aux p1)
          | TPat_constraint _ -> aux p1
          | TPat_type pp -> aux p1
         end
      | Tpat_lazy p1 ->  aux p1
charguer's avatar
charguer committed
297 298 299 300 301 302
      | Tpat_record _ -> unsupported loc "record patterns" (* todo! *)
      | Tpat_array pats -> unsupported loc "array patterns" (* todo! *)
      | Tpat_constant _ -> unsupported loc "only integer constant are supported"
      | Tpat_any -> not_in_normal_form loc "wildcard patterns remain after normalization"
      | Tpat_variant (_,_,_) -> unsupported loc "variant patterns"
      | Tpat_or (_,p1,p2) -> unsupported loc "or patterns"   
charguer's avatar
init  
charguer committed
303 304 305 306 307
      in
   List.rev (aux p)


(*#########################################################################*)
charguer's avatar
charguer committed
308
(* ** Helper functions for various things *)
charguer's avatar
init  
charguer committed
309 310

let register_cf x =
charguer's avatar
charguer committed
311
   Coqtop_register ("database_cf", x, cf_axiom_name x)
charguer's avatar
init  
charguer committed
312 313 314 315

let register_spec x v =
   Coqtop_register ("database_spec", x, v)

charguer's avatar
charguer committed
316

charguer's avatar
charguer committed
317
(* TODO: rewrite this function by using a normalization function that returns p *)
charguer's avatar
init  
charguer committed
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
let rec prefix_for_label typ = 
  match typ.desc with  
  | Tconstr (p, _, _) -> lift_path_name p 
  | Tlink t -> prefix_for_label t
  | _ -> failwith "string_of_label: type of a record should be a Tconstr or Tlink"
  (*
  | Tvar -> failwith "x1"
  | Tarrow _ -> failwith "x2"
  | Ttuple  _ -> failwith "x3"
  | Tconstr _ -> failwith "x4"
  | Tobject  _ -> failwith "x5"
  | Tfield _ -> failwith "x6"
  | Tnil _ -> failwith "x7"
  | Tsubst  _ -> failwith "x9"
  | Tvariant  _ -> failwith "x10"
  | Tunivar -> failwith "x11"
  | Tpoly  _ -> failwith "x12"
  *)

charguer's avatar
charguer committed
337
(* DEPRECATED 
charguer's avatar
init  
charguer committed
338 339 340 341 342
let string_of_label_with prefix lbl =
  prefix ^ "_" ^ lbl.lbl_name

let string_of_label typ lbl =
  string_of_label_with (prefix_for_label typ) lbl
charguer's avatar
charguer committed
343
*)
charguer's avatar
init  
charguer committed
344

charguer's avatar
charguer committed
345 346 347 348 349 350 351 352 353 354 355 356

(*#########################################################################*)
(* ** Helper functions for primitive functions *)

let simplify_apply_args loc oargs =
  List.map (function (lab, Some e, Required) -> e | _ -> unsupported loc "optional arguments") oargs 

let get_qualified_pervasives_name f = 
   let name = Path.name f in
   if !Clflags.nopervasives 
      then "Pervasives." ^ name  (* unqualified name when from inside Pervasives *)
      else name  (* qualified name otherwise *)
charguer's avatar
init  
charguer committed
357 358

let exp_find_inlined_primitive e oargs =
charguer's avatar
charguer committed
359 360 361 362 363
   let loc = e.exp_loc in
   let args = simplify_apply_args loc oargs in
   match e.exp_desc with
   | Texp_ident (f,d) ->
      let name = get_qualified_pervasives_name f in
charguer's avatar
init  
charguer committed
364

charguer's avatar
charguer committed
365 366 367 368 369 370 371 372 373 374 375 376 377
      let debug() =
         Printf.printf "exp_find_inlined_primitive: %s\n arity: %d\n name: %s\n" (Path.name f) (List.length args) name
         in
      (* debug(); *)

      begin match args with 
      | [n; {exp_desc = Texp_constant (Const_int m)}] 
           when m <> 0  
             && List.mem name ["Pervasives.mod"; "Pervasives./"] -> 
           begin match find_inlined_primitive name with
           | Some (Primitive_binary_div_or_mod, coq_name) -> Some coq_name
           | _ -> None
           end
charguer's avatar
init  
charguer committed
378

charguer's avatar
charguer committed
379 380 381 382 383 384
       | [e1; e2] 
           when List.mem name ["Pervasives.&&"; "Pervasives.||"] -> 
           begin match find_inlined_primitive (Path.name f) with
           | Some (Primitive_binary_lazy, coq_name) -> Some coq_name
           | _ -> None
           end
charguer's avatar
init  
charguer committed
385

charguer's avatar
charguer committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
       | [e1; e2] 
           when List.mem name ["Pervasives.="; "Pervasives.<>"; "Pervasives.<="; 
                               "Pervasives.>="; "Pervasives.<"; "Pervasives.>";
                               "Pervasives.min"; "Pervasives.max"; ] -> 
           let is_number = 
              begin match btyp_of_typ_exp e1.exp_type with
              | Btyp_constr (id,[]) when Path.name id = "int" -> true
              end in
             (* Remark: by typing, [e2] has the same type as [e1] *)
           if not is_number then 
             unsupported loc (Printf.sprintf "comparison operators on non integer arguments (here, %s)" (string_of_type_exp e1.exp_type));
           begin match find_inlined_primitive name with
           | Some (Primitive_binary_only_numbers, coq_name) -> Some coq_name
           | _ -> failwith ("in exp_find_inlined_primitive, could not find the coq translation of the function: " ^ name)
           end

       | _ -> 
           let arity = List.length args in
           begin match find_inlined_primitive name with
           | Some (Primitive_unary, coq_name) when arity = 1 -> Some coq_name
           | Some (Primitive_binary, coq_name) when arity = 2 -> Some coq_name
           | _ -> None
           end
           (* debug: Printf.printf "exp_find_inlined_primitive: %s %d\n"  (Path.name f)  (List.length args);
           if r = None then Printf.printf "failed\n"; *)

       end

    | _ -> None


let exp_is_inlined_primitive e oargs = 
  exp_find_inlined_primitive e oargs <> None
charguer's avatar
init  
charguer committed
419

charguer's avatar
charguer committed
420

charguer's avatar
init  
charguer committed
421 422 423 424 425 426 427 428 429
(*#########################################################################*)
(* ** Lifting of values *)

(** Translate a Caml identifier into a Coq identifier, possibly 
    applied to wildcards for taking type applications into account *)

let lift_exp_path env p =
   match find_primitive (Path.name p) with
   | None -> 
430
      let x = lift_path_name (protect_infix_path p) in
charguer's avatar
init  
charguer committed
431
      coq_app_var_wilds x (typ_arity_var env p)
charguer's avatar
charguer committed
432 433
   | Some y -> 
      Coq_var y 
charguer's avatar
init  
charguer committed
434 435 436 437 438

(** Translate a Caml value into a Coq value. Fails if the Coq 
    expression provided is not a value. *)

let rec lift_val env e = 
charguer's avatar
charguer committed
439
   let loc = e.exp_loc in
charguer's avatar
init  
charguer committed
440
   let aux = lift_val env in
charguer's avatar
charguer committed
441 442
   let fail () =
     not_in_normal_form loc ("in liftval: " ^ Print_tast.string_of_expression false e) in
charguer's avatar
init  
charguer committed
443 444 445 446 447 448 449 450
   match e.exp_desc with
   | Texp_ident (p,d) -> 
     lift_exp_path env p 
   | Texp_open (p, _) -> 
     assert false
   | Texp_constant (Const_int n) ->
      Coq_int n
   | Texp_constant _ -> 
charguer's avatar
charguer committed
451
      unsupported loc "only integer constant are supported"
charguer's avatar
init  
charguer committed
452 453 454 455 456
   | Texp_tuple el -> 
      Coq_tuple (List.map aux el)
   | Texp_construct (p, c, es) ->
      coq_apps (coq_of_constructor p c) (List.map aux es)
   | Texp_record (l, opt_init_expr) ->  
charguer's avatar
charguer committed
457
       if opt_init_expr <> None then unsupported loc "record-with expression"; (* todo *)
charguer's avatar
init  
charguer committed
458 459 460 461 462 463
       if List.length l < 1 then failwith "record should have at least one field";
       let labels = ((fun (p,li,ei) -> li) (List.hd l)).lbl_all in
       let args = Array.make (Array.length labels) (Coq_var "dummy") in
       let register_arg lbl v =
          Array.iteri (fun i lbli -> if lbl.lbl_name = lbli.lbl_name then args.(i) <- v) labels in
       List.iter (fun (p,lbl,v) -> register_arg lbl (aux v)) l;
charguer's avatar
charguer committed
464
       let constr = record_constructor_name_from_type (prefix_for_label (e.exp_type)) in
charguer's avatar
init  
charguer committed
465 466 467 468 469 470
       let typ_args = 
          match btyp_of_typ_exp e.exp_type with
          | Btyp_constr (id,ts) -> List.map lift_btyp ts
          | _ -> failwith "record should have a type-constructor as type"
          in
       coq_apps (coq_var_at constr) (typ_args @ Array.to_list args)
charguer's avatar
charguer committed
471 472 473 474 475 476 477
   | Texp_apply (funct, oargs) ->
      let fo = exp_find_inlined_primitive funct oargs in
      let f = match fo with
         | Some f -> f
         | _ -> fail()
         in
      let args = simplify_apply_args loc oargs in
charguer's avatar
init  
charguer committed
478 479 480 481 482 483 484 485 486
      coq_apps (Coq_var f) (List.map aux args)
   | Texp_lazy e -> 
      aux e
   | Texp_array [] -> 
      Coq_var "array_empty"
   | Texp_constraint (e,_,_) -> 
      aux e

   (* --uncomment for debugging 
charguer's avatar
charguer committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
   | Texp_function _ -> not_in_normal_form loc "function"
   | Texp_apply _ -> not_in_normal_form loc "apply"
   | Texp_assertfalse -> not_in_normal_form loc "assert false"
   | Texp_try(body, pat_expr_list) -> not_in_normal_form loc "try expression"
   | Texp_variant(l, arg) ->  not_in_normal_form loc "variant expression"
   | Texp_setfield(arg, p, lbl, newval) -> not_in_normal_form loc "set-field expression"
   | Texp_array expr_list -> not_in_normal_form loc "array expressions"
   | Texp_ifthenelse(cond, ifso, None) -> not_in_normal_form loc "if-then-without-else expressions"
   | Texp_sequence(expr1, expr2) -> not_in_normal_form loc "sequence expressions"
   | Texp_while(cond, body) -> not_in_normal_form loc "while expressions"
   | Texp_for(param, low, high, dir, body) -> not_in_normal_form loc "for expressions"
   | Texp_when(cond, body) -> not_in_normal_form loc "when expressions"
   | Texp_send(_ , _, _) -> not_in_normal_form loc "send expressions"
   | Texp_new (cl, _) -> not_in_normal_form loc "new expressions"
   | Texp_instvar(path_self, path) -> not_in_normal_form loc "inst-var expressions"
   | Texp_setinstvar(path_self, path, expr) -> not_in_normal_form loc "set-inst-var expressions"
   | Texp_override(path_self, modifs) -> not_in_normal_form loc "override expressions"
   | Texp_letmodule(id, modl, body) -> not_in_normal_form loc "let-module expressions"
   | Texp_assert (cond) -> not_in_normal_form loc "assert expressions"
   | Texp_object (_, _) -> not_in_normal_form loc "object expressions"
   | Texp_poly _  -> not_in_normal_form loc "object expressions"
   | Texp_newtype _  -> not_in_normal_form loc "object expressions"
   | Texp_pack _  -> not_in_normal_form loc "object expressions"
   | Texp_let _ -> not_in_normal_form loc "let"
   | Texp_match _ -> not_in_normal_form loc "match"
   | Texp_field _ -> not_in_normal_form loc "field"
charguer's avatar
init  
charguer committed
513
   *)
charguer's avatar
charguer committed
514
   | _ -> fail()
charguer's avatar
init  
charguer committed
515 516 517 518 519 520 521 522 523 524

   (* --todo: could be a value in a purely-functional setting
   | Texp_field (e, lbl) ->
       let typ = e.exp_type in
       Coq_app (Coq_var (string_of_label typ lbl), aux e) *)


(*#########################################################################*)
(* ** Helper functions for producing label names *)

charguer's avatar
charguer committed
525 526
(* FOR FUTURE USE *)

charguer's avatar
init  
charguer committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
let counter_local_label = 
   ref 0
let get_next_local_label () = 
   incr counter_local_label;
   "_m" ^ (string_of_int !counter_local_label)
let reset_local_labels() = 
   counter_local_label := 0

let used_labels : (var list) ref = 
   ref []
let reset_used_labels () =
   used_labels := []
let add_used_label x =
   if not (List.mem x !used_labels)
      then used_labels := x :: !used_labels

let cfg_extract_labels () =
   let labs = List.rev !used_labels in
   let cft = [ Cftop_coqs (list_mapi (fun i x -> Coqtop_label (x,i+1)) labs) ] in
   reset_used_labels();
   cft


(*#########################################################################*)
(* ** Helper functions for names *)

(** Takes a pattern that is expected to be reduced simply to an identifier, 
    and returns this identifier *)

let rec pattern_ident p =
   match p.pat_desc with
   | Tpat_var s -> s
   | Tpat_alias (p1,_) -> pattern_ident p1
   | _ -> failwith ("pattern_ident: the pattern is not a name: " ^ (Print_tast.string_of_pattern false p))

(** Takes a pattern that is expected to be reduced simply to an identifier, 
    and returns the name of this identifier *)

let pattern_name p =
   Ident.name (pattern_ident p)

charguer's avatar
charguer committed
568 569 570
(** Takes a function name and encodes its name in case of an infix operator *)

let pattern_name_protect_infix p =
charguer's avatar
charguer committed
571
   protect_infix (pattern_name p)
charguer's avatar
charguer committed
572 573


charguer's avatar
init  
charguer committed
574 575 576 577 578 579 580 581 582 583 584
(** An alternative version of function extract_label_names, for obtaining record labels *)

let rec extract_label_names_simple env ty =
  let ty = Ctype.repr ty in
  match ty.desc with
  | Tconstr (path, _, _) ->
      let td = Env.find_type path env in
      begin match td.type_kind with
      | Type_record (fields, _) ->
          List.map (fun (name, _, _) -> name) fields
      | Type_abstract when td.type_manifest <> None ->
charguer's avatar
charguer committed
585
          unsupported_noloc "building of a record with abstract type"
charguer's avatar
init  
charguer committed
586 587 588 589 590 591 592 593 594 595
      | _ -> assert false
      end
  | _ -> assert false


(*#########################################################################*)
(* ** Characteristic formulae for expressions *)

(** Translate a Caml expression into its Coq characteristic formula *)

charguer's avatar
charguer committed
596 597
let rec cfg_exp env e = 
   let loc = e.exp_loc in
charguer's avatar
init  
charguer committed
598 599 600
   let aux = cfg_exp env in
   let lift e = lift_val env e in
   let ret e = Cf_ret (lift e) in
charguer's avatar
charguer committed
601 602
   let not_normal ?s:(s="") () =
      not_in_normal_form loc (s ^ Print_tast.string_of_expression false e) in
charguer's avatar
init  
charguer committed
603 604 605 606 607 608 609 610 611
   match e.exp_desc with
   | Texp_ident (x,d) -> ret e
   | Texp_open (p, {exp_desc = Texp_ident _}) -> assert false
   | Texp_constant cst -> ret e
   | Texp_tuple el -> ret e
   | Texp_construct(p, cstr, args) -> ret e
   (* TODO: only in purely function setting:   | Texp_record (lbl_expr_list, opt_init_expr) -> ret e*)

   | Texp_record (lbl_expr_list, opt_init_expr) ->
charguer's avatar
charguer committed
612
      if opt_init_expr <> None then unsupported loc "record-with"; (* TODO *)
charguer's avatar
init  
charguer committed
613
      let (pathfront,pathend) = get_record_decomposed_name_for_exp e in
charguer's avatar
charguer committed
614
      let func = Coq_var (pathfront ^ (record_make_name pathend)) in (* tood: move the underscore *)
charguer's avatar
init  
charguer committed
615 616 617 618 619 620 621 622
      let named_args = List.map (fun (p,li,ei) -> (li.lbl_name,ei)) lbl_expr_list in
      (* deprecated sorting: let args = List.map snd (list_ksort str_cmp named_args) in *)
      let fields_names = extract_label_names_simple e.exp_env e.exp_type in
      let args = 
         try List.map (fun name -> List.assoc name named_args) fields_names
         with Not_found -> failwith "some fields are missing in a record construction" 
         in
      let tprod = coq_prod (List.map coq_typ args) in
charguer's avatar
charguer committed
623
      Cf_app ([tprod], loc_type, func, [Coq_tuple (List.map lift args)]) 
charguer's avatar
init  
charguer committed
624 625 626

   | Texp_apply (funct, oargs) when exp_is_inlined_primitive funct oargs -> ret e

charguer's avatar
charguer committed
627
   | Texp_function (_, pat_expr_list, partial) -> not_normal ~s:"The function involved has not been lifted properly during normalization;\n check the normalized file in _output folder.\n" ()
charguer's avatar
init  
charguer committed
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643

   | Texp_let(rf, fvs, pat_expr_list, body) ->
      
      let is_let_fun = 
         match (snd (List.hd pat_expr_list)).exp_desc with
         | Texp_function (_,_,_) -> true
         | Texp_constraint ({exp_desc = Texp_function (_,_,_)},_,_) -> true (* todo: generalize *)
         | _ -> false in

      (* binding of functions, possibly mutually-recursive *)
      if is_let_fun then begin
        let env' = match rf with 
           | Nonrecursive -> env
           | Recursive -> env
              (* --todo: add better support for local polymorphic recursion
              List.fold_left (fun (pat,bod) acc -> Ident.add (pattern_ident pat) 0 acc) env pat_expr_list *)
charguer's avatar
charguer committed
644
           | Default -> unsupported loc "Default recursion mode"
charguer's avatar
init  
charguer committed
645
           in
charguer's avatar
charguer committed
646
        let ncs = List.map (fun (pat,bod) -> (pattern_name_protect_infix pat, cfg_func env' fvs pat bod)) pat_expr_list in
charguer's avatar
init  
charguer committed
647 648
        let cf_body = cfg_exp env' body in 
        add_used_label (fst (List.hd ncs));
charguer's avatar
charguer committed
649
        Cf_fun (ncs, cf_body)
charguer's avatar
init  
charguer committed
650 651 652 653 654 655
        (* --todo: check what happens with recursive types *)

      (* let-binding of a single value *)
      end else begin 
        if (List.length pat_expr_list <> 1) then not_normal();
        let (pat,bod) = List.hd pat_expr_list in
charguer's avatar
charguer committed
656
        let x = pattern_name_protect_infix pat in
charguer's avatar
init  
charguer committed
657 658 659 660 661
        let fvs_typ, typ = lift_typ_sch pat.pat_type in
        let fvs = List.map name_of_type fvs in
        let fvs_strict = list_intersect fvs fvs_typ in
        let fvs_others = list_minus fvs fvs_strict in
            
charguer's avatar
charguer committed
662
        (* deprecated: pure-mode let-binding
charguer's avatar
init  
charguer committed
663 664 665 666 667 668 669
        if !pure_mode then begin 
       
           let cf1 = cfg_exp env bod in
           let env' = Ident.add (pattern_ident pat) (List.length fvs_strict) env in
           let cf2 = cfg_exp env' body in
           add_used_label x;
           Cf_letpure (x, fvs_strict, fvs_others, typ, cf1, cf2)
charguer's avatar
charguer committed
670
         end else *)
charguer's avatar
init  
charguer committed
671 672

        (* value let-binding *)
charguer's avatar
charguer committed
673
        if Typecore.is_nonexpansive bod then begin 
charguer's avatar
init  
charguer committed
674 675 676

           let v = 
             try lift_val env bod  
charguer's avatar
charguer committed
677 678
             with Not_in_normal_form (loc2, s) -> 
                raise (Not_in_normal_form (loc2, s ^ " (only value can satisfy the value restriction)"))
charguer's avatar
init  
charguer committed
679 680 681 682
             in
           let env' = Ident.add (pattern_ident pat) (List.length fvs_strict) env in
           let cf = cfg_exp env' body in
           add_used_label x;
charguer's avatar
charguer committed
683
           Cf_val (x, fvs_strict, fvs_others, typ, v, cf)
charguer's avatar
init  
charguer committed
684 685 686 687 688

        (* term let-binding *)
        end else begin
            
           if fvs_strict <> [] || fvs_others <> [] 
charguer's avatar
charguer committed
689 690 691
               then unsupported loc "relaxed value restriction";
               (* not_in_normal_form loc ("(un value restriction) "
                                        ^ (Print_tast.string_of_expression false e));*)
charguer's avatar
init  
charguer committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705
           let cf1 = cfg_exp env bod in
           let env' = Ident.add (pattern_ident pat) (List.length fvs_strict) env in
           let cf2 = cfg_exp env' body in
           add_used_label x;
           Cf_let ((x,typ), cf1, cf2)

        end
      end

   | Texp_ifthenelse (cond, ifso, Some ifnot) ->
      (* old: Cf_caseif (aux cond, aux ifso, aux ifnot) *)
      Cf_caseif (lift cond, aux ifso, aux ifnot) 

   | Texp_apply (funct, oargs) ->
charguer's avatar
charguer committed
706
      let args = simplify_apply_args loc oargs in
charguer's avatar
init  
charguer committed
707 708
      let tr = coq_typ e in
      let ts = List.map coq_typ args in
charguer's avatar
charguer committed
709
      Cf_app (ts, tr, lift funct, List.map lift args) 
charguer's avatar
init  
charguer committed
710 711 712 713 714 715 716 717 718 719

   | Texp_match (arg, pat_expr_list, partial) ->
      let tested = lift arg in
      let conclu = match partial with Partial -> Cf_fail | Total -> Cf_done in
      let cfg_case (pat,body) acc =
         let whenopt, cfbody =  
            match body.exp_desc with 
            | Texp_when (econd, ebody) ->
                let w = 
                   try lift_val env econd  
charguer's avatar
charguer committed
720 721
                   with Not_in_normal_form (loc2, s) -> 
                      raise (Not_in_normal_form (loc2, s ^ " (Only total expressions are allowed in when clauses)"))
charguer's avatar
init  
charguer committed
722 723 724 725 726 727 728 729 730
                   in
                Some w, aux ebody
            | _ -> None, aux body
            in
         Cf_case (tested, pattern_variables pat, lift_pat pat, whenopt, pattern_aliases pat, cfbody, acc) in
      let label = get_next_local_label() in
      add_used_label label;
      Cf_match (label, List.length pat_expr_list, List.fold_right cfg_case pat_expr_list conclu)

charguer's avatar
charguer committed
731
   | Texp_assert e -> 
charguer's avatar
init  
charguer committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
      Cf_assert (aux e)

   | Texp_assertfalse -> 
      Cf_fail

   | Texp_lazy e -> 
      aux e

   | Texp_sequence(expr1, expr2) -> 
      Cf_seq (aux expr1, aux expr2)

   | Texp_while(cond, body) -> 
      Cf_while (aux cond, aux body)

   | Texp_for(param, low, high, dir, body) -> 
      begin match dir with 
        | Upto -> Cf_for (Ident.name param, lift low, lift high, aux body)
charguer's avatar
charguer committed
749
        | Downto -> unsupported loc "for-downto expressions" (* later *)
charguer's avatar
init  
charguer committed
750 751
      end

charguer's avatar
charguer committed
752
   | Texp_array expr_list -> unsupported loc "array expressions" (* later *)
charguer's avatar
init  
charguer committed
753 754 755 756

   | Texp_field (arg, p, lbl) -> 
      let tr = coq_typ e in 
      let ts = coq_typ arg in (* todo: check it is always 'loc' *)
charguer's avatar
charguer committed
757
      let func = Coq_var (record_field_get_name lbl.lbl_name) in
charguer's avatar
charguer committed
758
      Cf_app ([ts], tr, func, [lift arg]) 
charguer's avatar
init  
charguer committed
759 760 761 762

   | Texp_setfield(arg, p, lbl, newval) -> 
      let ts1 = coq_typ arg in (* todo: check it is always 'loc' *)
      let ts2 = coq_typ newval in 
charguer's avatar
charguer committed
763
      let func = Coq_var (record_field_set_name lbl.lbl_name) in
charguer's avatar
charguer committed
764
      Cf_app ([ts1;ts2], coq_unit, func, [lift arg; lift newval]) 
charguer's avatar
init  
charguer committed
765

charguer's avatar
charguer committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
   | Texp_try(body, pat_expr_list) -> unsupported loc "try expression"
   | Texp_variant(l, arg) ->  unsupported loc "variant expression"
   | Texp_ifthenelse(cond, ifso, None) -> unsupported loc "if-then-without-else expressions should have been normalized"
   | Texp_when(cond, body) -> unsupported loc "when expressions outside of pattern matching"
   | Texp_send(_, _, _) -> unsupported loc "send expressions"
   | Texp_new (cl, _) -> unsupported loc "new expressions"
   | Texp_instvar(path_self, path) -> unsupported loc "inst-var expressions"
   | Texp_setinstvar(path_self, path, expr) -> unsupported loc "set-inst-var expressions"
   | Texp_override(path_self, modifs) -> unsupported loc "override expressions"
   | Texp_letmodule(id, modl, body) -> unsupported loc "let-module expressions"
   | Texp_object _ -> unsupported loc "object expressions"
   | Texp_poly (_,_) -> unsupported loc "poly"
   | Texp_newtype (_,_) -> unsupported loc "newtype"
   | Texp_pack _ -> unsupported loc "pack"
   | Texp_open (_,_) -> unsupported loc "open in term"
charguer's avatar
init  
charguer committed
781 782 783 784
   | Texp_constraint (e,_,_) -> aux e

and cfg_func env fvs pat bod =
   let rec get_typed_args acc e =
charguer's avatar
charguer committed
785
      let loc = e.exp_loc in
charguer's avatar
init  
charguer committed
786 787 788 789
      match e.exp_desc with
      | Texp_function (_,[p1,e1],partial) 
      | Texp_constraint ({exp_desc = Texp_function (_,[p1,e1],partial)},_,_) ->
         if partial <> Total 
charguer's avatar
charguer committed
790
            then not_in_normal_form loc (Print_tast.string_of_expression false e);
charguer's avatar
init  
charguer committed
791 792 793
         get_typed_args ((pattern_name p1, coq_typ_pat p1)::acc) e1
      | _ -> List.rev acc, e
      in  
charguer's avatar
charguer committed
794
   let f = pattern_name_protect_infix pat in
charguer's avatar
init  
charguer committed
795 796 797
   let targs, body = get_typed_args [] bod in
   let typ = coq_typ body in
   let cf_body = cfg_exp env body in
charguer's avatar
cp  
charguer committed
798
   let cf_body = if !Mytools.use_credits then Cf_pay cf_body else cf_body in
charguer's avatar
init  
charguer committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
   let fvs = List.map name_of_type fvs in
   Cf_body (f, fvs, targs, typ, cf_body) 
   (* --todo: check if the set of type variables quantified is not too
      conservative. Indeed, some type variables may no longer occur. *)


(*#########################################################################*)
(* ** Characteristic formulae for modules *)

(** Helper functions to find out the kind of a type declaration *)

let is_algebraic (name,dec) =
   match dec.typ_type.type_kind with Type_variant _ -> true | _ -> false 

let is_type_abbrev (name,dec) =
   match dec.typ_type.type_kind with Type_abstract -> true | _ -> false 

let is_type_record (name,dec) =
   match dec.typ_type.type_kind with Type_record _ -> true | _ -> false 

(** Generate the top-level Coq declarations associated with 
    a top-level declaration from a module. *)

let rec cfg_structure_item s : cftops = 
charguer's avatar
charguer committed
823
  let loc = s.str_loc in
charguer's avatar
init  
charguer committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
  match s.str_desc with
  | Tstr_value(rf, fvs, pat_expr_list) ->
      reset_local_labels();

      (* --todo: improve code sharing between local bindings and top-level bindings *)
      let is_let_fun (pat,exp) = 
         match exp.exp_desc with 
         | Texp_function (_,_,_) -> true
         | Texp_constraint({exp_desc = Texp_function (_,_,_)},_,_) -> true
         | _ -> false in

      if List.for_all is_let_fun pat_expr_list then begin
        let env' = match rf with 
           | Nonrecursive -> Ident.empty
           | Recursive -> Ident.empty
               (* --todo: better support for polymorphic recursion
              List.fold_left (fun (pat,bod) acc -> Ident.add (pattern_ident pat) 0 acc) env pat_expr_list *)
charguer's avatar
charguer committed
841
           | Default -> unsupported loc "Default recursion mode"
charguer's avatar
init  
charguer committed
842
           in
charguer's avatar
charguer committed
843
        let ncs = List.map (fun (pat,bod) -> (pattern_name_protect_infix pat, cfg_func env' fvs pat bod)) pat_expr_list in
charguer's avatar
init  
charguer committed
844 845 846 847 848 849 850
          (List.map (fun (name,_) -> Cftop_val (name, val_type)) ncs)
        @ (List.map (fun (name,cf_body) -> Cftop_fun_cf (name, cf_body)) ncs)
        @ [Cftop_coqs (List.map (fun (name,_) -> register_cf name) ncs)]
   
      (* let-binding of a single value *)
      end else if (List.length pat_expr_list = 1) then begin (* later: check it is not a function *)
        let (pat,bod) = List.hd pat_expr_list in
charguer's avatar
charguer committed
851
        let x = pattern_name_protect_infix pat in
charguer's avatar
charguer committed
852 853
        (* DEPRECATED if (hack_recognize_okasaki_lazy x) then [] else *)
        begin
charguer's avatar
init  
charguer committed
854 855 856 857 858
        let fvs_typ, typ = lift_typ_sch pat.pat_type in
        let fvs = List.map name_of_type fvs in
        let fvs_strict = list_intersect fvs fvs_typ in
        let fvs_others = list_minus fvs fvs_strict in
        
charguer's avatar
charguer committed
859
        (* deprecated: pure-mode let-binding 
charguer's avatar
init  
charguer committed
860 861 862 863 864 865 866 867 868 869 870 871
        if !pure_mode then begin 

           let cf_body = cfg_exp (Ident.empty) bod in
           let implicits = 
              match fvs_strict with
              | [] -> []
              | _ ->  [ Coqtop_implicit (x, List.map (fun t -> (t,Coqi_maximal)) fvs_strict) ]
              in
           [ Cftop_val (x, coq_forall_types fvs_strict typ);
             Cftop_coqs implicits;
             Cftop_pure_cf (x, fvs_strict, fvs_others, cf_body); 
             Cftop_coqs [register_cf x]; ] 
charguer's avatar
charguer committed
872
        end else*)
charguer's avatar
init  
charguer committed
873 874

        (* value let-binding *)
charguer's avatar
charguer committed
875
        if Typecore.is_nonexpansive bod then begin 
charguer's avatar
init  
charguer committed
876 877 878

           let v = 
             try lift_val (Ident.empty) bod  
charguer's avatar
charguer committed
879 880 881
             with Not_in_normal_form (loc2, s) -> 
                (* TODO: here and elsewhere, use a wrapper for extending the errors *)
                raise (Not_in_normal_form (loc2, s ^ " (only value can satisfy the value restriction)"))
charguer's avatar
init  
charguer committed
882
            in
charguer's avatar
charguer committed
883
           let v_typed = coq_annot v typ in
charguer's avatar
init  
charguer committed
884 885 886 887 888 889 890
           let implicits = 
              match fvs_strict with
              | [] -> []
              | _ ->  [ Coqtop_implicit (x, List.map (fun t -> (t,Coqi_maximal)) fvs_strict) ]
              in
           [ Cftop_val (x, coq_forall_types fvs_strict typ);
             Cftop_coqs implicits;
charguer's avatar
charguer committed
891
             Cftop_val_cf (x, fvs_strict, fvs_others, v_typed); 
charguer's avatar
init  
charguer committed
892 893 894 895 896
             Cftop_coqs [register_cf x]; ] 

        (* term let-binding -- later *)
        end else begin
            
charguer's avatar
charguer committed
897
           unsupported loc "top-level binding of terms that are not values";
charguer's avatar
init  
charguer committed
898 899

           (* if fvs_strict <> [] || fvs_others <> [] 
charguer's avatar
charguer committed
900
               then not_in_normal_form loc ("(unsatisfied value restriction) "
charguer's avatar
init  
charguer committed
901 902 903 904 905 906 907 908 909 910 911 912
                                        ^ (Print_tast.string_of_expression false e));
           let cf1 = cfg_exp env bod in
           let env' = Ident.add (pattern_ident pat) (List.length fvs_strict) env in
           let cf2 = cfg_exp env' body in
           add_used_label x;
           Cf_let ((x,typ), cf1, cf2) *)

        end

      end (* for skip_cf *)

     end else
charguer's avatar
charguer committed
913
        unsupported loc ("mutually-recursive values that are not all functions");
charguer's avatar
init  
charguer committed
914 915 916 917 918 919 920 921 922


  | Tstr_type(decls) -> [ Cftop_coqs (cfg_type_decls decls) ]

  | Tstr_module(id, modl) -> cfg_module id modl 

  | Tstr_modtype(id, decl) -> cfg_modtype id decl

  | Tstr_open path -> 
charguer's avatar
charguer committed
923
      (* TEMPORARILY DEPRECATED if is_primitive_module (Path.name path) then [] else *)
charguer's avatar
charguer committed
924
      [ Cftop_coqs [ Coqtop_require_import [ lift_full_path_name path ] ] ]
charguer's avatar
init  
charguer committed
925 926

  | Tstr_primitive(id, descr) ->
charguer's avatar
charguer committed
927
      let id = protect_infix (Ident.name id) in
charguer's avatar
charguer committed
928 929 930 931
      let fvs, typ = lift_typ_sch descr.val_desc.ctyp_type in
      let typ = coq_fun_types fvs typ in
      [ Cftop_val (id, typ) ]

charguer's avatar
init  
charguer committed
932 933 934 935 936
  | Tstr_exception(id, decl) ->
      [] (* unsupported "exceptions" *)
  | Tstr_exn_rebind(id, path) -> 
      [] (* unsupported "exceptions" *)

charguer's avatar
charguer committed
937 938 939 940 941
  | Tstr_recmodule bindings -> unsupported loc "recursive modules"
  | Tstr_class _ -> unsupported loc "objects"
  | Tstr_class_type _ -> unsupported loc "objects"
  | Tstr_include (m,ids) -> unsupported loc "module-include"
  | Tstr_eval expr -> unsupported loc "top level eval expression (let _)"
charguer's avatar
init  
charguer committed
942 943 944 945 946

(** Generate the top-level Coq declarations associated with 
    a type abbreviation. *)

and cfg_type_abbrev (name,dec) =
charguer's avatar
charguer committed
947
   let x = type_constr_name (Ident.name name) in
charguer's avatar
init  
charguer committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961
   let args = List.map name_of_type dec.typ_type.type_params in
   let sort = coq_impl_types (List.length args) in
   let coqs = match dec.typ_type.type_manifest with
      | None -> [Coqtop_param (x, sort)]
      | Some t -> [Coqtop_def ((x, sort), coq_fun_types args (lift_typ_exp t));
                   Coqtop_hint_unfold ([x],"typeclass_instances") ] in
   coqs, [] 

(** Generate the top-level Coq declarations associated with 
    a record definition. *)

and cfg_type_record (name,dec) =
   let x = Ident.name name in
   let name_of_field lbl = 
charguer's avatar
charguer committed
962
      record_field_name lbl in
charguer's avatar
init  
charguer committed
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
   let fields = match dec.typ_type.type_kind with Type_record (l,_) -> l | _ -> assert false in
   (* let fields_base_names = List.map (fun (lbl,_,_) -> lbl) fields in *)
   let declared_params = List.map name_of_type dec.typ_type.type_params in
   let branches, branches_params = List.split (List.map (fun (lbl, mut, typ) -> 
      let btyp = btyp_of_typ_exp typ in 
      ((name_of_field lbl, lift_btyp btyp), fv_btyp ~through_arrow:false btyp)) fields) in
          (* todo: use a function to factorize above work *)

   (* deprecated sorting: let branches = list_ksort str_cmp branches in *)
   let fields_names, fields_types = List.split branches in
   (* let remaining_params = List.concat branches_params in *)
   (* todo: assert remaining_params included in declared_params *)
   (* TODO: enlever le polymorphisme inutile : list_intersect remaining_params declared_params *) 
   let params = declared_params in 
   let top = { 
charguer's avatar
charguer committed
978 979
      coqind_name = record_structure_name x;
      coqind_constructor_name = record_constructor_name x;
charguer's avatar
init  
charguer committed
980 981 982 983 984 985 986 987
      coqind_targs = coq_types params;
      coqind_ret = Coq_type;
      coqind_branches = branches } in
   let implicit_decl =
      match params with
      | [] -> []
      | _ -> List.map (fun field -> Coqtop_implicit (field, List.map (fun p -> p, Coqi_maximal) params)) fields_names 
      in
charguer's avatar
charguer committed
988
   let type_abbrev = Coqtop_def ((type_constr_name x, Coq_wild), coq_fun_types params loc_type) in
charguer's avatar
init  
charguer committed
989 990 991
   [ type_abbrev ],
   [ Coqtop_record top ] 
   @ (implicit_decl)
charguer's avatar
charguer committed
992 993
   @ [ Coqtop_hint_constructors ([record_structure_name x], "typeclass_instances") ]
   @ record_functions x (record_constructor_name x) (record_repr_name x) params fields_names fields_types
charguer's avatar
init  
charguer committed
994 995 996 997
  (*  todo: move le "_of" *)

(** Auxiliary function to generate stuff for records *)

charguer's avatar
fix  
charguer committed
998
and record_functions name record_constr repr_name params fields_names fields_types =
charguer's avatar
init  
charguer committed
999 1000 1001 1002 1003
   let nth i l = List.nth l i in
   let n = List.length fields_names in
   let indices = list_nat n in
   let for_indices f = List.map f indices in

charguer's avatar
fix  
charguer committed
1004
   let new_name = record_make_name name in
charguer's avatar
charguer committed
1005 1006
   let get_names = for_indices (fun i -> record_field_get_name (nth i fields_names)) in
   let set_names = for_indices (fun i -> record_field_set_name (nth i fields_names)) in
charguer's avatar
init  
charguer committed
1007 1008 1009 1010 1011
   let new_decl = Coqtop_param (new_name, val_type) in
   let get_set_decl i =
      [ Coqtop_param (nth i get_names, val_type); 
        Coqtop_param (nth i set_names, val_type) ] in
   
charguer's avatar
charguer committed
1012
   let logicals = List.map str_capitalize_1 fields_names (* for_indices (fun i -> sprintf "A%d" (i+1)) *) in
charguer's avatar
init  
charguer committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
   let reprs = for_indices (fun i -> sprintf "_T%d" (i+1)) in
   let abstracts = for_indices (fun i -> sprintf "_X%d" (i+1)) in
   let concretes = for_indices (fun i -> sprintf "x%d" (i+1)) in
   let loc = "l" in

   let vparams = coq_vars params in
   let vlogicals = coq_vars logicals in
   let vreprs = coq_vars reprs in
   let vabstracts = coq_vars abstracts in
   let vconcretes = coq_vars concretes in
   let vloc = coq_var "l" in

   let tparams = coq_types params in
   let tlogicals = coq_types logicals in
   let treprs = List.map (fun i -> nth i reprs, htype (nth i vlogicals) (nth i fields_types)) indices in
   let tabstracts = List.map (fun i -> nth i abstracts, nth i vlogicals) indices in
   let tconcretes = List.map (fun i -> nth i concretes, nth i fields_types) indices in
   let tloc = (loc, loc_type) in

   let repr_args = tparams @ tlogicals @ treprs @ tabstracts @ [tloc] in
   let hcore = heap_is_single vloc (coq_apps (coq_var_at record_constr) (vparams @ vconcretes)) in
   let helems_items = for_indices (fun i -> hdata (nth i vconcretes) (Coq_app (nth i vreprs, nth i vabstracts))) in
   let helems = heap_stars helems_items in
   let repr_body = heap_star hcore helems in
   let repr_def = coqtop_def_untyped repr_name (coq_funs repr_args (heap_existss tconcretes repr_body)) in

   let repr_folded = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ vlogicals @ vreprs @ vabstracts)) in
   let repr_unfolded = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ fields_types @ (list_make n id_repr) @ vconcretes)) in
   let repr_elems = helems in
   let repr_convert_body = coq_eq repr_folded (heap_existss tconcretes (heap_star repr_unfolded repr_elems)) in
   let repr_focus_body = heap_impl repr_folded (heap_existss tconcretes (heap_star repr_unfolded repr_elems)) in
   let repr_unfocus_body = heap_impl (heap_star repr_unfolded repr_elems) repr_folded in
   let repr_convert_quantif = [tloc] @ tparams @ tlogicals @ treprs @ tabstracts in
   let repr_focus_quantif = repr_convert_quantif in
   let repr_unfocus_quantif = [tloc] @ tparams @ tconcretes @ tlogicals @ treprs @ tabstracts in
charguer's avatar
fix  
charguer committed
1048 1049 1050
   let convert_name = record_convert_name name in
   let focus_name = record_unfocus_name name in
   let unfocus_name = record_focus_name name in
charguer's avatar
init  
charguer committed
1051 1052 1053 1054 1055 1056 1057
   let repr_convert = Coqtop_param (convert_name, coq_foralls repr_convert_quantif repr_convert_body) in
   let repr_focus = Coqtop_param (focus_name, coq_foralls repr_focus_quantif repr_focus_body) in
   let repr_unfocus = Coqtop_param (unfocus_name, coq_foralls repr_unfocus_quantif repr_unfocus_body) in 
   let repr_convert_focus_unfocus = [ repr_convert; repr_focus; repr_unfocus;
      coqtop_noimplicit convert_name; coqtop_noimplicit focus_name; coqtop_noimplicit unfocus_name ] in
   let field_convert_focus_unfocus i = 
      let field_name = nth i fields_names in
charguer's avatar
fix  
charguer committed
1058 1059 1060
      let field_convert_name = record_convert_field_name field_name in
      let field_focus_name = record_focus_field_name field_name in
      let field_unfocus_name = record_unfocus_field_name field_name in
charguer's avatar
init  
charguer committed
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
      let tconcretei = nth i tconcretes in
      let helemi = nth i helems_items in 
      let field_folded = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ vlogicals @ vreprs @ vabstracts)) in
      let field_unfolded = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ (list_replace_nth i fields_types vlogicals) @ (list_replace i id_repr vreprs) @ (list_replace_nth i vconcretes vabstracts))) in
      let field_convert_body = coq_eq field_folded (heap_exists_one tconcretei (heap_star field_unfolded helemi)) in
      let field_focus_body = heap_impl field_folded (heap_exists_one tconcretei (heap_star field_unfolded helemi)) in
      let field_unfocus_body = heap_impl (heap_star field_unfolded helemi) field_folded in
      let field_convert_quantif = [tloc] @ tparams @ tlogicals @ treprs @ tabstracts in
      let field_focus_quantif = field_convert_quantif in
      let field_unfocus_quantif = [tloc] @ tparams @ [ tconcretei ] @ tlogicals @ treprs @ tabstracts in
      let field_convert = Coqtop_param (field_convert_name, coq_foralls field_convert_quantif field_convert_body) in
      let field_focus = Coqtop_param (field_focus_name, coq_foralls field_focus_quantif field_focus_body) in
      let field_unfocus = Coqtop_param (field_unfocus_name, coq_foralls field_unfocus_quantif field_unfocus_body) in 
      [ field_convert; field_focus; field_unfocus;
        coqtop_noimplicit field_convert_name; coqtop_noimplicit field_focus_name; coqtop_noimplicit field_unfocus_name ] 
      in
   let fields_convert_focus_unfocus = List.concat (List.map (fun i -> field_convert_focus_unfocus i) indices) in

   let new_spec =
      let new_name_spec = new_name ^ "_spec" in
      let r = "R" in
      let vr = coq_var r in
      let tr = (r, formula_type_of loc_type) in
      let x = "_X" in
      let tx = (x, coq_prod fields_types) in
      let data_targs = vparams @ fields_types @ (for_indices (fun _ -> id_repr)) in
      let post = coq_funs [(loc, loc_type)] (hdata vloc (coq_apps (coq_var_at repr_name) (data_targs @ vabstracts))) in
      let body = coq_funs [tx; tr] (Coq_lettuple (coq_vars abstracts, Coq_var x, coq_apps vr [heap_empty; post])) in
      let spec = coq_foralls tparams (coq_apps (Coq_var "spec_1") [body; coq_var new_name]) in
      [ Coqtop_param (new_name_spec, spec); 
        register_spec new_name new_name_spec; ]
      in
   let get_set_spec i = 
      let get_name = nth i get_names in
      let set_name = nth i set_names in
      let get_name_spec = get_name ^ "_spec" in
      let set_name_spec = set_name ^ "_spec" in
      let r = "R" in
      let vr = coq_var r in
      let trget = (r, formula_type_of (nth i fields_types)) in
      let trset = (r, formula_type_of coq_unit) in
      let x' = sprintf "_X%d'" i in
      let vx' = coq_var x' in
      let tx' = (x', nth i fields_types) in
      let selected_tlogicals = list_remove i tlogicals in
      let replaced_vlogicals = list_replace i (nth i fields_types) vlogicals in
      let replaced_vreprs = list_replace i id_repr vreprs in
      let selected_treprs = list_remove i treprs in
      let replaced_tabstracts = list_replace i (nth i abstracts, nth i fields_types) tabstracts in
      let update_vabstracts = list_replace i vx' vabstracts in
      let data_targs = vparams @ replaced_vlogicals @ replaced_vreprs in
      let data_initial = hdata vloc (coq_apps (coq_var_at repr_name) (data_targs @ vabstracts)) in
      let data_updated = hdata vloc (coq_apps (coq_var_at repr_name) (data_targs @ update_vabstracts)) in
      let post_get = coq_funs [("x", Coq_wild)] (heap_star (heap_pred (coq_eq (Coq_var "x") (nth i vabstracts))) data_initial) in
      let post_set = post_unit data_updated in
      let body_quantif = replaced_tabstracts @ selected_treprs in
      let body_get = coq_funs [tloc; trget] (coq_foralls body_quantif (coq_apps vr [data_initial; post_get])) in
      let body_set = coq_funs [tloc; tx'; trset] (coq_foralls body_quantif (coq_apps vr [data_initial; post_set])) in
      let spec_get = coq_foralls (tparams @ selected_tlogicals) (coq_apps (Coq_var "spec_1") [body_get; coq_var get_name]) in
      let spec_set = coq_foralls (tparams @ selected_tlogicals) (coq_apps (Coq_var "spec_2") [body_set; coq_var set_name]) in
      [ Coqtop_param (get_name_spec, spec_get); 
        register_spec get_name get_name_spec; 
        Coqtop_param (set_name_spec, spec_set);
        register_spec set_name set_name_spec; ]
      in

   let get_spec_focus i = 
      let get_name = nth i get_names in
      let get_name_spec = get_name ^ "_spec_focus" in
      let r = "R" in
      let vr = coq_var r in
      let trget = (r, formula_type_of (nth i fields_types)) in
      let replaced_vlogicals = list_replace i (nth i fields_types) vlogicals in
      let replaced_vreprs = list_replace i id_repr vreprs in
      let replaced_vabstracts = list_replace i (Coq_var "x") vabstracts in
      let data_initial = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ vlogicals @ vreprs @ vabstracts)) in
      let data_focused = hdata (Coq_var "x") (Coq_app (nth i vreprs, nth i vabstracts)) in
      let data_final = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ replaced_vlogicals @ replaced_vreprs @ replaced_vabstracts)) in
      let post_get = coq_funs [("x", Coq_wild)] (heap_star data_focused data_final) in
      let body_quantif = tabstracts @ treprs in
      let body_get = coq_funs [tloc; trget] (coq_foralls body_quantif (coq_apps vr [data_initial; post_get])) in
      let spec_get = coq_foralls (tparams @ tlogicals) (coq_apps (Coq_var "spec_1") [body_get; coq_var get_name]) in
      [ Coqtop_param (get_name_spec, spec_get); 
        coqtop_register "database_spec_focus" get_name get_name_spec; ]
      in

   let set_spec_unfocus i = 
      let set_name = nth i set_names in
      let set_name_spec = set_name ^ "_spec_unfocus" in
      let r = "R" in
      let vr = coq_var r in
      let trset = (r, formula_type_of coq_unit) in
      let x_concrete = "x0" in
      let tx_concrete = (x_concrete, nth i fields_types) in
      let vlogical0 = Coq_var "_A0" in
      let tlogical0 = ("_A0", Coq_type) in
      let vabstract0 = Coq_var "_X0" in
      let tabstract0 = ("_X0", vlogical0) in
      let vrepr0 = Coq_var "_T0" in
      let trepr0 = ("_T0", htype vlogical0 (nth i fields_types)) in
      let updated_vlogicals = list_replace i vlogical0 vlogicals in
      let updated_vreprs = list_replace i vrepr0 vreprs in
      let update_vabstracts = list_replace i vabstract0 vabstracts in
      let data_initial = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ vlogicals @ vreprs @ vabstracts)) in
      let data_updated = hdata vloc (coq_apps (coq_var_at repr_name) (vparams @ updated_vlogicals @ updated_vreprs @ update_vabstracts)) in
      let data_focused = hdata (Coq_var x_concrete) (Coq_app (vrepr0, vabstract0)) in
      let post_set = post_unit data_updated in
      let body_quantif = [tabstract0] @ tabstracts @ [trepr0] @ treprs in
      let body_set = coq_funs [tloc; tx_concrete; trset] (coq_foralls body_quantif (coq_apps vr [(heap_star data_initial data_focused); post_set])) in
      let spec_set = coq_foralls (tparams @ [tlogical0] @ tlogicals) (coq_apps (Coq_var "spec_2") [body_set; coq_var set_name]) in
      [ Coqtop_param (set_name_spec, spec_set);
        coqtop_register "database_spec_unfocus" set_name set_name_spec; ]
      in

     [ new_decl ]
   @ (List.concat (List.map get_set_decl indices))
charguer's avatar
charguer committed
1177
   @ [ repr_def ]
charguer's avatar
init  
charguer committed
1178 1179
   @ repr_convert_focus_unfocus
   @ fields_convert_focus_unfocus
charguer's avatar
fix  
charguer committed
1180 1181
   (* TODO: revive *)
   (*
charguer's avatar
init  
charguer committed
1182 1183 1184
   @ new_spec
   @ (List.concat (List.map get_set_spec indices))
   @ (List.concat (List.map get_spec_focus indices))
charguer's avatar
fix  
charguer committed
1185 1186
   @ (List.concat (List.map set_spec_unfocus indices)) *)
  
charguer's avatar
init  
charguer committed
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199


(** Generate the top-level Coq declarations associated with 
    a algebraic data type definition. *)

and cfg_algebraic decls =
   (* -- todo: data constructor type arity may be reduced when types are erased *)
   (* -- todo: Caml types often clash with Caml program variables, since in Coq
         they get put in the same namespace *)
    let trans_ind (name,dec) =
      let x = Ident.name name in
      let branches = match dec.typ_type.type_kind with Type_variant l -> l | _ -> assert false in
      let params = List.map name_of_type dec.typ_type.type_params in
charguer's avatar
charguer committed
1200
      let ret_typ = coq_apps (Coq_var (type_constr_name x)) (coq_vars params) in
charguer's avatar
init  
charguer committed
1201 1202 1203 1204
      let get_typed_constructor (c,ts) =
         (c, coq_impls (List.map lift_typ_exp ts) ret_typ) in
      let coqind_decl = 
         if List.length decls = 1 then
charguer's avatar
charguer committed
1205
            {  coqind_name = type_constr_name x;
charguer's avatar
charguer committed
1206
               coqind_constructor_name = record_constructor_name x;
charguer's avatar
init  
charguer committed
1207 1208 1209 1210
               coqind_targs = coq_types params;
               coqind_ret = Coq_type;
               coqind_branches = List.map get_typed_constructor branches; } 
          else
charguer's avatar
charguer committed
1211
            {  coqind_name = type_constr_name x;
charguer's avatar
charguer committed
1212
               coqind_constructor_name = record_constructor_name x;
charguer's avatar
init  
charguer committed
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
               coqind_targs = [];
               coqind_ret = coq_impl_types (List.length params); 
               coqind_branches = List.map 
                  (fun tc -> let (c,t) = get_typed_constructor tc in
                             (c, coq_foralls (coq_types params) t)
                     ) branches; } 
          in
      let implicit_decl =
         match params with
         | [] -> []
         | _ -> List.map (fun (cname,_) -> Coqtop_implicit (cname, List.map (fun p -> p,Coqi_maximal) params)) branches 
         in
      (coqind_decl, implicit_decl)
      in
   let inds,maxiss = List.split (List.map trans_ind decls) in
     [ Coqtop_ind inds ] 
   @ (List.concat maxiss)
   @ [ Coqtop_hint_constructors (List.map (fun i -> i.coqind_name) inds, "typeclass_instances") ],
   []

(** Generate the top-level Coq declarations associated with 
    a type definition. *)

and cfg_type_decls (decls : (Ident.t * Typedtree.type_declaration) list) =
   let rec aux decls =   
       if List.length decls = 1 && is_type_abbrev (List.hd decls)  
          then cfg_type_abbrev (List.hd decls)
       else if List.length decls = 1 && is_type_record (List.hd decls)  
          then cfg_type_record (List.hd decls)
       else if (List.for_all is_algebraic decls)  
          then cfg_algebraic decls
       else 
(* /todo/ very experimental support: simply break circularity; might stack overflow! *)
          let (a,b) = List.split (List.map aux (List.map (fun x -> [x]) decls)) in
          (List.concat a, List.concat b)
          (* unsupported "type definitions must be single abbreviations or mutually-recursive inductive definitions (mixing both is not supported in Coq)" *)
      in
   let (a,b) = aux decls in 
   a @ b

(** Generate the top-level Coq declarations associated with 
    the content of a module. *)

and cfg_structure s =
   reset_used_labels();
   let body = list_concat_map (fun si -> reset_names(); cfg_structure_item si) s.str_items in
charguer's avatar
charguer committed
1259 1260
   (* cfg_extract_labels() @ *)
   body
charguer's avatar
init  
charguer committed
1261 1262 1263 1264 1265

(** Generate the top-level Coq declarations associated with 
    a Caml signature definition. *)

and cfg_modtype id mt =
charguer's avatar
charguer committed
1266
   let loc = mt.mty_loc in
charguer's avatar
charguer committed
1267
   let id = lift_module_name id in
charguer's avatar
init  
charguer committed
1268 1269 1270 1271 1272 1273
   let rec aux (bindings:mod_bindings) mt =
      match mt.mty_desc with
      | Tmty_ident p -> Coqtop_module_type (id, bindings, Mod_def_inline [lift_full_path_name p]), None
      | Tmty_signature s -> Coqtop_module_type (id, bindings, Mod_def_declare), Some (cfg_signature s)
      | Tmty_functor (x,mtx,mtr) -> 
          begin match mtx.mty_desc with
charguer's avatar
charguer committed
1274
          | Tmty_ident p -> aux (bindings @ [([lift_module_name x], Mod_typ_var (lift_full_path_name p))]) mtr (* TODO: use List.rev *)
charguer's avatar
charguer committed
1275
          | _ -> unsupported loc "functor with on-the-fly signature for its argument"
charguer's avatar
init  
charguer committed
1276
          end
charguer's avatar
charguer committed
1277 1278
      | Tmty_with _ -> unsupported loc "module sig with"
      | Tmty_typeof _ -> unsupported loc "type of module"
charguer's avatar
init  
charguer committed
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
      in
   let mod_typ_dec, sign_opt = aux [] mt in
   match sign_opt with
   | None -> [ Cftop_coqs [ mod_typ_dec ] ]
   | Some sign -> [ Cftop_coqs ( [mod_typ_dec] @ sign @ [Coqtop_end id] ) ]

(** Generate the top-level Coq declarations associated with 
    a top-level declaration from a signature. *)

and cfg_signature_item s =
charguer's avatar
charguer committed
1289
  let loc = s.sig_loc in
charguer's avatar
init  
charguer committed
1290 1291 1292
  match s.sig_desc with

  | Tsig_value (id,vd) -> 
charguer's avatar
charguer committed
1293
     if vd.val_val.val_kind <> Val_reg then unsupported loc "value in signature which is not a regular value";
charguer's avatar
init  
charguer committed
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305