refactor : meaningful names for js_cmj_format

Author: bobzhang

jscomp/core/js_cmj_format.ml

@@ -42,8 +42,6 @@ type effect = string option
 
 
 let single_na = Single Lam_arity.na
-(** we don't force people to use package *)
-type cmj_case = Ext_namespace.file_kind
 
 type keyed_cmj_value = { name : string ; arity : arity ; persistent_closed_lambda : Lam.t option}
 type keyed_cmj_values 
@@ -52,20 +50,20 @@ type keyed_cmj_values
 type t = {
   values : keyed_cmj_values ;
   pure : bool;
-  npm_package_path : Js_packages_info.t ;
-  cmj_case : cmj_case; 
+  package_spec : Js_packages_info.t ;
+  js_file_kind : Ext_js_file_kind.t; 
 }
 
-let make ~(values:cmj_value Map_string.t) ~effect ~npm_package_path ~cmj_case : t = 
+let make ~(values:cmj_value Map_string.t) ~effect ~package_spec ~js_file_kind : t = 
   {
     values = Map_string.to_sorted_array_with_f values (fun k v -> {
       name = k ; 
       arity = v.arity;
       persistent_closed_lambda = v.persistent_closed_lambda
     }); 
     pure = effect = None ; 
-    npm_package_path;
-    cmj_case
+    package_spec;
+    js_file_kind
   }
 
 
@@ -178,70 +176,9 @@ let query_by_name (cmj_table : t ) name  : keyed_cmj_value =
   let values = cmj_table.values in    
   binarySearch values name 
 
-let is_pure (cmj_table : t ) = 
-  cmj_table.pure
-
-let get_npm_package_path (cmj_table : t) = 
-  cmj_table.npm_package_path
-
-let get_cmj_case (cmj_table : t) =  
-  cmj_table.cmj_case
-
-
-(* start dumping *)
-
-let f fmt = Printf.fprintf stdout fmt 
-
-let pp_cmj_case  (cmj_case : cmj_case) : unit = 
-  match cmj_case with 
-  | Little_js -> 
-    f  "case : little, .js \n"
-  | Little_bs -> 
-    f  "case : little, .bs.js \n"    
-  | Upper_js -> 
-    f  "case: upper, .js  \n"
-  | Upper_bs -> 
-    f  "case: upper, .bs.js  \n"    
-
-let pp_cmj 
-    ({ values ; pure; npm_package_path ; cmj_case} : t) = 
-  f  "package info: %s\n"  
-    (Format.asprintf "%a" Js_packages_info.dump_packages_info npm_package_path)        
-  ;
-  pp_cmj_case  cmj_case;
-
-  f "effect: %s\n"
-      (if pure then "pure" else "not pure");
-   Ext_array.iter values 
-    (fun ({name = k ; arity; persistent_closed_lambda}) -> 
-       match arity with             
-       | Single arity ->
-         f "%s: %s\n" k (Format.asprintf "%a" Lam_arity.print arity);
-         (match persistent_closed_lambda with 
-          | None -> 
-            f "%s: not saved\n" k 
-          | Some lam -> 
-            begin 
-              f "%s: ======[start]\n" k ;
-              f "%s\n" (Lam_print.lambda_to_string lam);
-              f "%s: ======[finish]\n" k
-            end )         
-       | Submodule xs -> 
-         (match persistent_closed_lambda with 
-          | None -> f "%s: not saved\n" k 
-          | Some lam -> 
-            begin 
-              f "%s: ======[start]\n" k ;
-              f "%s" (Lam_print.lambda_to_string lam);
-              f "%s: ======[finish]\n" k
-            end 
-         );
-         Array.iteri 
-         (fun i arity -> f "%s[%i] : %s \n" 
-          k i 
-          (Format.asprintf "%a" Lam_arity.print arity ))
-         xs
-    )    
+
+
+
 
 type path = string  
 type cmj_load_info = {

jscomp/core/js_cmj_format.mli

@@ -64,39 +64,34 @@ type cmj_value = {
 
 type effect = string option
 
-type cmj_case = Ext_namespace.file_kind 
+type keyed_cmj_value = { 
+  name : string ;
+  arity : arity ; 
+  persistent_closed_lambda : Lam.t option
+}
 
-type t 
+type t = private {
+  values : keyed_cmj_value array ;
+  pure : bool;
+  package_spec : Js_packages_info.t ;
+  js_file_kind : Ext_js_file_kind.t; 
+}
 
 
 val make:
   values: cmj_value Map_string.t -> 
   effect: effect -> 
-  npm_package_path: Js_packages_info.t ->
-  cmj_case:cmj_case -> 
+  package_spec: Js_packages_info.t ->
+  js_file_kind:Ext_js_file_kind.t -> 
   t
 
-type keyed_cmj_value = { 
-  name : string ;
-  arity : arity ; 
-  persistent_closed_lambda : Lam.t option
-}
 
 val query_by_name : 
   t ->
   string -> 
   keyed_cmj_value
 
-val is_pure : 
-  t -> bool 
 
-val get_npm_package_path :  
-  t -> 
-  Js_packages_info.t  
-
-val get_cmj_case :   
-  t ->
-  cmj_case 
 
 val single_na : arity
 
@@ -115,7 +110,7 @@ val from_string : string -> t
 val to_file : 
   string -> check_exists:bool -> t -> unit
 
-val pp_cmj: t -> unit 
+
 
 
 type path = string  

jscomp/core/lam_compile_env.ml

@@ -129,32 +129,31 @@ let query_external_id_info (module_id : Ident.t) (name : string) : ident_info =
 
 
 
-let get_package_path_from_cmj 
-    ( id : Lam_module_ident.t) 
+let get_package_path_from_cmj ( id : Lam_module_ident.t) 
    = 
-  match Lam_module_ident.Hash.find_opt cached_tbl id with 
-  | Some (Ml {cmj_table ; package_path}) -> 
-     (package_path, 
-          Js_cmj_format.get_npm_package_path cmj_table, 
-          Js_cmj_format.get_cmj_case cmj_table )
-  | Some External -> 
-    assert false  
-      (* called by {!Js_name_of_module_id.string_of_module_id}
+   let cmj_load_info =       
+     match Lam_module_ident.Hash.find_opt cached_tbl id with 
+     | Some (Ml cmj_load_info) -> cmj_load_info
+     | Some External -> 
+       assert false  
+     (* called by {!Js_name_of_module_id.string_of_module_id}
         can not be External
-      *)
-  | None -> 
-    begin match id.kind with 
-    | Runtime 
-    | External _ -> assert false
-    | Ml -> 
-      let cmj_load_info = 
-        Js_cmj_load.load_unit_exn (Lam_module_ident.name id) in           
-      let cmj_table = cmj_load_info.cmj_table in    
-      id +> Ml cmj_load_info;  
-      (cmj_load_info.package_path, 
-       Js_cmj_format.get_npm_package_path cmj_table, 
-       Js_cmj_format.get_cmj_case cmj_table )              
-    end 
+     *)
+     | None -> 
+       begin match id.kind with 
+         | Runtime 
+         | External _ -> assert false
+         | Ml -> 
+           let cmj_load_info = 
+             Js_cmj_load.load_unit_exn (Lam_module_ident.name id) in           
+           id +> Ml cmj_load_info;    
+           cmj_load_info
+
+       end  in 
+   let cmj_table = cmj_load_info.cmj_table in          
+   (cmj_load_info.package_path, 
+    cmj_table.package_spec, 
+    cmj_table.js_file_kind)                
 
 let add = Lam_module_ident.Hash_set.add
 
@@ -172,11 +171,11 @@ let is_pure_module (oid : Lam_module_ident.t)  =
         match Js_cmj_load.load_unit_exn (Lam_module_ident.name oid) with
         | cmj_load_info -> 
           oid +> Ml cmj_load_info ;
-          Js_cmj_format.is_pure cmj_load_info.cmj_table
+          cmj_load_info.cmj_table.pure
         | exception _ -> false 
       end 
-    | Some (Ml{cmj_table}(*|Runtime {cmj_table}*)) ->
-       Js_cmj_format.is_pure cmj_table
+    | Some (Ml{cmj_table}) ->
+       cmj_table.pure
     | Some External ->  false
     end 
 

jscomp/core/lam_compile_env.mli

@@ -85,7 +85,7 @@ val is_pure_module : Lam_module_ident.t -> bool
 
 val get_package_path_from_cmj : 
   Lam_module_ident.t -> 
-  (string * Js_packages_info.t * Js_cmj_format.cmj_case) 
+  (string * Js_packages_info.t * Ext_js_file_kind.t) 
 
 
 

jscomp/core/lam_compile_main.ml

@@ -32,7 +32,7 @@
 (* module E = Js_exp_make  *)
 (* module S = Js_stmt_make   *)
 
-let get_cmj_case output_prefix : Ext_namespace.file_kind = 
+let get_cmj_case output_prefix : Ext_js_file_kind.t = 
   let little = 
     Ext_char.is_lower_case (Filename.basename output_prefix).[0] 
   in 

jscomp/core/lam_stats_export.ml

@@ -139,15 +139,15 @@ let export_to_cmj
     (meta : Lam_stats.t ) 
     effect 
     export_map
-    cmj_case
+    js_file_kind
   : Js_cmj_format.t = 
   let values =  values_of_export meta export_map in
 
   Js_cmj_format.make
     ~values
     ~effect 
-    ~npm_package_path: (Js_packages_state.get_packages_info ())
-   ~cmj_case 
+    ~package_spec: (Js_packages_state.get_packages_info ())
+   ~js_file_kind
     (* FIXME: make sure [-o] would not change its case 
       add test for ns/non-ns
     *)

jscomp/core/lam_stats_export.mli

@@ -35,6 +35,6 @@ val export_to_cmj :
   Lam_stats.t ->
   Js_cmj_format.effect ->
   Lam.t Map_ident.t ->
-  Js_cmj_format.cmj_case ->
+  Ext_js_file_kind.t ->
   Js_cmj_format.t
 

jscomp/ext/ext_js_file_kind.ml

@@ -0,0 +1,30 @@
+(* Copyright (C) 2020- Authors of BuckleScript
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+type t = 
+  | Upper_js
+  | Upper_bs
+  | Little_js 
+  | Little_bs
+

jscomp/ext/ext_namespace.ml

@@ -56,19 +56,15 @@ let try_split_module_name name =
   else 
     Some (String.sub name (i+1) (len - i - 1),
           String.sub name 0 i )
-type file_kind = 
-  | Upper_js
-  | Upper_bs
-  | Little_js 
-  | Little_bs
+
 
 
 
 (* let js_name_of_basename bs_suffix s =   
   change_ext_ns_suffix  s 
   (if bs_suffix then Literals.suffix_bs_js else  Literals.suffix_js ) *)
 
-let js_name_of_modulename s little = 
+let js_name_of_modulename s (little : Ext_js_file_kind.t) : string = 
   match little with 
   | Little_js -> 
     change_ext_ns_suffix (Ext_string.uncapitalize_ascii s)  Literals.suffix_js

jscomp/ext/ext_namespace.mli

@@ -46,18 +46,13 @@ val change_ext_ns_suffix :
   string ->
   string
 
-type file_kind = 
-  | Upper_js
-  | Upper_bs
-  | Little_js 
-  | Little_bs 
-  
+
 
 (** [js_name_of_modulename ~little A-Ns]
   *)
 val js_name_of_modulename : 
   string -> 
-  file_kind -> 
+  Ext_js_file_kind.t -> 
   string
 
 (* TODO handle cases like