Merge pull request rescript-lang#4028 from BuckleScript/self_document_code

[refactor] self-document code

Author: bobzhang

jscomp/core/lam.ml

@@ -80,17 +80,16 @@ module Types = struct
       loc : Location.t;
       status : apply_status
     }
-  and function_info =
-    { arity : int ;
-      params : ident list ;
-      body : t
-    }
+
   and t =
     | Lvar of ident
     | Lglobal_module of ident
     | Lconst of Lam_constant.t
     | Lapply of apply_info
-    | Lfunction of function_info
+    | Lfunction of { arity : int ;
+                     params : ident list ;
+                     body : t
+                   }
     | Llet of Lam_compat.let_kind * ident * t * t
     | Lletrec of (ident * t) list * t
     | Lprim of prim_info
@@ -133,22 +132,17 @@ module X = struct
         loc : Location.t;
         status : apply_status
       }
-
-  and function_info
-    = Types.function_info
-    =
-      { arity : int ;
-        params : ident list ;
-        body : t
-      }
   and t
     = Types.t
     =
       | Lvar of ident
       | Lglobal_module of ident
       | Lconst of Lam_constant.t
       | Lapply of apply_info
-      | Lfunction of function_info
+      | Lfunction of { arity : int ;
+                       params : ident list ;
+                       body : t
+                     }      
       | Llet of Lam_compat.let_kind * ident * t * t
       | Lletrec of (ident * t) list * t
       | Lprim of prim_info
@@ -839,12 +833,12 @@ let handle_bs_non_obj_ffi
     loc
     prim_name =
   if no_auto_uncurried_arg_types arg_types then
-    result_wrap loc result_type @@ prim ~primitive:(Pjs_call(prim_name, arg_types, ffi))
-      ~args loc
+    result_wrap loc result_type (prim ~primitive:(Pjs_call {prim_name; arg_types; ffi})
+      ~args loc)
   else
     let n_arg_types, n_args =
       transform_uncurried_arg_type loc  arg_types args in
-    result_wrap loc result_type @@
-    prim ~primitive:(Pjs_call (prim_name, n_arg_types, ffi))
-      ~args:n_args loc
+    result_wrap loc result_type (
+    prim ~primitive:(Pjs_call {prim_name; arg_types = n_arg_types; ffi})
+      ~args:n_args loc)
 

jscomp/core/lam.mli

@@ -51,17 +51,15 @@ and prim_info = private
     args : t list ; 
     loc : Location.t 
   }
-and function_info = private
-  { arity : int ; 
-    params : ident list ;
-    body : t 
-  }
 and  t =  private
   | Lvar of ident
   | Lglobal_module of ident
   | Lconst of Lam_constant.t
   | Lapply of apply_info
-  | Lfunction of function_info
+  | Lfunction of   { arity : int ; 
+                     params : ident list ;
+                     body : t 
+                   }
   | Llet of Lam_compat.let_kind * ident * t * t
   | Lletrec of (ident * t) list * t
   | Lprim of prim_info

jscomp/core/lam_compile_primitive.ml

@@ -576,7 +576,7 @@ let translate  loc
     -> 
     assert false 
 
-  | Pjs_call (_, arg_types, ffi) -> 
+  | Pjs_call {arg_types; ffi} -> 
     Lam_compile_external_call.translate_ffi 
       loc cxt arg_types ffi args 
   (** FIXME, this can be removed later *)

jscomp/core/lam_id_kind.ml

@@ -37,15 +37,6 @@ type rec_flag =
     *)
 
 
-type function_id = {
-
-  mutable arity : Lam_arity.t;
-  (* TODO: This may contain some closure environment,
-     check how it will interact with dead code elimination
-  *)
-  lambda  : (Lam.t * rec_flag) option ;
-  
-}
 
 type element = 
   | NA 
@@ -66,7 +57,14 @@ type t =
   | Constant of Lam_constant.t
   | Module of Ident.t
         (** TODO: static module vs first class module *)
-  | FunctionId of function_id 
+  | FunctionId of {
+      mutable arity : Lam_arity.t;
+      (* TODO: This may contain some closure environment,
+         check how it will interact with dead code elimination
+      *)
+      lambda  : (Lam.t * rec_flag) option ;
+    }
+
   | Exception 
   | Parameter
       (** For this case, it can help us determine whether it should be inlined or not *)

jscomp/core/lam_id_kind.mli

@@ -32,10 +32,6 @@ type rec_flag =
 *)  
   | Lam_self_rec
   (* not inlining in this case *)
-type function_id = {
-  mutable arity : Lam_arity.t;
-  lambda  : (Lam.t * rec_flag) option ;
-}
 
 type element = 
   | NA 
@@ -56,7 +52,10 @@ type t =
   | Constant of Lam_constant.t
   | Module of Ident.t
         (** TODO: static module vs first class module *)
-  | FunctionId of function_id 
+  | FunctionId of {
+    mutable arity : Lam_arity.t;
+    lambda : (Lam.t * rec_flag) option;
+  }
   | Exception 
   | Parameter
       (** For this case, it can help us determine whether it should be inlined or not *)

jscomp/core/lam_primitive.ml

@@ -48,9 +48,9 @@ type t =
   (* External call *)
   | Pccall of  Primitive_compat.t
   | Pjs_call of
-      string *  (* prim_name *)
-      External_arg_spec.t list * (* arg_types *)
-      External_ffi_types.external_spec  (* ffi *)
+      { prim_name : string ;
+        arg_types : External_arg_spec.t list ;
+        ffi : External_ffi_types.external_spec }
   | Pjs_object_create of External_ffi_types.obj_create
   (* Exceptions *)
   | Praise
@@ -188,10 +188,10 @@ let eq_record_representation ( p : record_representation) ( p1 : record_represen
   match p with 
   | Record_regular -> p1 = Record_regular
 #if OCAML_VERSION =~ ">4.03.0" then 
-  | Record_inlined {tag = a0; name = a1; num_nonconsts = a2 } -> 
+  | Record_inlined {tag ; name ; num_nonconsts} -> 
     (match p1 with 
-    |Record_inlined {tag = b0; name = b1; num_nonconsts = b2} ->
-       a0 = b0 && a1 = b1 && a2 = b2
+    |Record_inlined rhs ->
+       tag = rhs.tag && name = rhs.name && num_nonconsts = rhs.num_nonconsts
     | _ -> false)
   | Record_extension -> 
     p1 = Record_extension   
@@ -277,7 +277,7 @@ let eq_primitive_approx ( lhs : t) (rhs : t) =
 
   | Pglobal_exception ident -> (match rhs with Pglobal_exception ident2 ->  Ident.same ident ident2 | _ -> false )
   | Pduprecord record_repesentation0 -> (match rhs with Pduprecord record_repesentation1 ->  eq_record_representation record_repesentation0 record_repesentation1  | _ -> false)
-  | Pjs_call (prim_name, arg_types, ffi) ->  ( match rhs with Pjs_call(prim_name1, arg_types1,ffi1) -> prim_name = prim_name1 && arg_types = arg_types1 && ffi = ffi1 | _ -> false)
+  | Pjs_call {prim_name; arg_types; ffi} ->  ( match rhs with Pjs_call rhs -> prim_name = rhs.prim_name && arg_types = rhs.arg_types && ffi = rhs.ffi | _ -> false)
   | Pjs_object_create obj_create -> (match rhs with Pjs_object_create obj_create1 -> obj_create = obj_create1 | _ -> false )
   | Pintcomp comparison -> (match rhs with Pintcomp comparison1 -> Lam_compat.eq_comparison comparison  comparison1  | _ -> false )    
   | Pfloatcomp comparison -> (match rhs with Pfloatcomp comparison1 -> Lam_compat.eq_comparison comparison  comparison1 | _ -> false)

jscomp/core/lam_primitive.mli

@@ -46,9 +46,9 @@ type t =
   | Pccall of  Primitive_compat.t
   | Pjs_call of
     (* Location.t *  [loc] is passed down *)
-    string *  (* prim_name *)
-    External_arg_spec.t list * (* arg_types *)
-    External_ffi_types.external_spec  (* ffi *)
+    { prim_name : string;
+      arg_types : External_arg_spec.t list ;
+      ffi : External_ffi_types.external_spec}
   | Pjs_object_create of External_ffi_types.obj_create
 
   | Praise 

jscomp/core/lam_print.ml

@@ -166,7 +166,7 @@ let primitive ppf (prim : Lam_primitive.t) = match prim with
   | Pduprecord rep -> fprintf ppf "duprecord %a" record_rep rep
   | Plazyforce -> fprintf ppf "force"
   | Pccall p -> fprintf ppf "%s" p.prim_name
-  | Pjs_call (prim_name, _, _) -> 
+  | Pjs_call {prim_name} -> 
     fprintf ppf  "%s[js]" prim_name 
   | Pjs_object_create obj_create -> 
     fprintf ppf "[js.obj]"

jscomp/core/lam_stats_export.ml

@@ -47,6 +47,7 @@ let values_of_export
          match Ident_hashtbl.find_opt meta.ident_tbl x with 
          | Some (FunctionId {arity ; _}) -> Single arity 
          | Some (ImmutableBlock(elems)) ->  
+          (* FIXME: field name for dumping*)
            Submodule(Ext_array.map elems (fun x -> 
                match x with 
                | NA -> Lam_arity.na

jscomp/ext/hash_set.cppo.ml

@@ -64,7 +64,7 @@ type  'a t = 'a Hash_set_gen.t
 let create = Hash_set_gen.create
 let clear = Hash_set_gen.clear
 let reset = Hash_set_gen.reset
-let copy = Hash_set_gen.copy
+(* let copy = Hash_set_gen.copy *)
 let iter = Hash_set_gen.iter
 let fold = Hash_set_gen.fold
 let length = Hash_set_gen.length

jscomp/ext/hash_set_gen.ml

@@ -55,7 +55,7 @@ let reset h =
   h.data <- Array.make h.initial_size Empty
 
 
-let copy h = { h with data = Array.copy h.data }
+(* let copy h = { h with data = Array.copy h.data } *)
 
 let length h = h.size
 
@@ -145,7 +145,7 @@ sig
   val create: int ->  t
   val clear : t -> unit
   val reset : t -> unit
-  val copy: t -> t
+  (* val copy: t -> t *)
   val remove:  t -> key -> unit
   val add :  t -> key -> unit
   val of_array : key array -> t 

jscomp/ext/hash_set_poly.mli

@@ -31,7 +31,7 @@ val clear : 'a t -> unit
 
 val reset : 'a t -> unit
 
-val copy : 'a t -> 'a t
+(* val copy : 'a t -> 'a t *)
 
 val add : 'a t -> 'a  -> unit
 val remove : 'a t -> 'a -> unit

jscomp/ext/hashtbl.cppo.ml

@@ -34,7 +34,6 @@ type ('a, 'b) bucketlist = ('a,'b) Hashtbl_gen.bucketlist
 let create = Hashtbl_gen.create
 let clear = Hashtbl_gen.clear
 let reset = Hashtbl_gen.reset
-let copy = Hashtbl_gen.copy
 let iter = Hashtbl_gen.iter
 let to_list = Hashtbl_gen.to_list
 let fold = Hashtbl_gen.fold

jscomp/ext/hashtbl_gen.ml

@@ -47,8 +47,6 @@ let reset h =
   h.data <- Array.make h.initial_size Empty
 
 
-let copy h = { h with data = Array.copy h.data }
-
 let length h = h.size
 
 let resize indexfun h =
@@ -176,7 +174,7 @@ module type S = sig
   val create: int -> 'a t
   val clear: 'a t -> unit
   val reset: 'a t -> unit
-  val copy: 'a t -> 'a t
+
   val add: 'a t -> key -> 'a -> unit
   val modify_or_init: 'a t -> key -> ('a -> unit) -> (unit -> 'a) -> unit 
   val remove: 'a t -> key -> unit

jscomp/main/cmjdump_main.ml

@@ -22,17 +22,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 
-(* open Printf *)
-
-
-
-
 
 let () = 
   match Sys.argv  with
   | [|_; file |] 
     -> 
-      let cmj,digest = (Js_cmj_format.from_file_with_digest file) in 
+      let cmj,digest = Js_cmj_format.from_file_with_digest file in 
       Format.fprintf Format.std_formatter "@[Digest: %s@]@." (Digest.to_hex digest);
       Js_cmj_format.pp_cmj cmj
   | _ -> failwith "expect one argument"

lib/4.06.1/bsb.ml

@@ -7410,7 +7410,7 @@ let reset h =
   h.data <- Array.make h.initial_size Empty
 
 
-let copy h = { h with data = Array.copy h.data }
+(* let copy h = { h with data = Array.copy h.data } *)
 
 let length h = h.size
 
@@ -7500,7 +7500,7 @@ sig
   val create: int ->  t
   val clear : t -> unit
   val reset : t -> unit
-  val copy: t -> t
+  (* val copy: t -> t *)
   val remove:  t -> key -> unit
   val add :  t -> key -> unit
   val of_array : key array -> t 
@@ -7583,7 +7583,7 @@ type  t = key  Hash_set_gen.t
 let create = Hash_set_gen.create
 let clear = Hash_set_gen.clear
 let reset = Hash_set_gen.reset
-let copy = Hash_set_gen.copy
+(* let copy = Hash_set_gen.copy *)
 let iter = Hash_set_gen.iter
 let fold = Hash_set_gen.fold
 let length = Hash_set_gen.length
@@ -8089,8 +8089,6 @@ let reset h =
   h.data <- Array.make h.initial_size Empty
 
 
-let copy h = { h with data = Array.copy h.data }
-
 let length h = h.size
 
 let resize indexfun h =
@@ -8218,7 +8216,7 @@ module type S = sig
   val create: int -> 'a t
   val clear: 'a t -> unit
   val reset: 'a t -> unit
-  val copy: 'a t -> 'a t
+
   val add: 'a t -> key -> 'a -> unit
   val modify_or_init: 'a t -> key -> ('a -> unit) -> (unit -> 'a) -> unit 
   val remove: 'a t -> key -> unit
@@ -8274,7 +8272,6 @@ type ('a, 'b) bucketlist = ('a,'b) Hashtbl_gen.bucketlist
 let create = Hashtbl_gen.create
 let clear = Hashtbl_gen.clear
 let reset = Hashtbl_gen.reset
-let copy = Hashtbl_gen.copy
 let iter = Hashtbl_gen.iter
 let to_list = Hashtbl_gen.to_list
 let fold = Hashtbl_gen.fold
@@ -8398,7 +8395,7 @@ let of_list2 ks vs =
   List.iter2 (fun k v -> add map k v) ks vs ; 
   map
 
-# 162 "ext/hashtbl.cppo.ml"
+# 161 "ext/hashtbl.cppo.ml"
 end
 
 end
@@ -9423,7 +9420,6 @@ type ('a, 'b) bucketlist = ('a,'b) Hashtbl_gen.bucketlist
 let create = Hashtbl_gen.create
 let clear = Hashtbl_gen.clear
 let reset = Hashtbl_gen.reset
-let copy = Hashtbl_gen.copy
 let iter = Hashtbl_gen.iter
 let to_list = Hashtbl_gen.to_list
 let fold = Hashtbl_gen.fold