document js_stmt_make.mli

Author: bobzhang

jscomp/core/js_ast_util.ml

@@ -39,6 +39,6 @@ let rec named_expression (e : J.expression)
   else 
     let obj = Ext_ident.create_tmp () in 
     let obj_code = 
-      S.define
+      S.define_variable
         ~kind:Strict obj e in 
     Some (obj_code, obj)

jscomp/core/js_output.ml

@@ -69,7 +69,7 @@ let handle_name_tail
   | EffectCall, ReturnTrue _ ->
       make [S.return_stmt  exp] ~finished:True
   | Declare (kind, n), ReturnFalse -> 
-      make [ S.define ~kind n  exp]
+      make [ S.define_variable ~kind n  exp]
   | Assign n ,ReturnFalse -> 
       make [S.assign n exp ]
   | (Declare _ | Assign _ ), ReturnTrue _ -> 
@@ -83,7 +83,7 @@ let handle_block_return
     (lam : Lam.t) (block : J.block) exp : t = 
   match st, should_return with 
   | Declare (kind,n), ReturnFalse -> 
-    make (block @ [ S.define ~kind  n exp])
+    make (block @ [ S.define_variable ~kind  n exp])
   | Assign n, ReturnFalse -> make (block @ [S.assign n exp])
   | (Declare _ | Assign _), ReturnTrue _ -> make [S.unknown_lambda lam] ~finished:True
   | EffectCall, ReturnFalse -> make block ~value:exp

jscomp/core/js_pass_flatten_and_mark_dead.ml

@@ -49,7 +49,8 @@ class rewrite_return ?return_value ()=
   let mk_return  = 
     match return_value with 
     | None -> fun e -> S.exp e 
-    | Some ident -> fun e -> S.define ~kind:Variable ident e in
+    | Some ident -> fun e -> 
+      S.define_variable ~kind:Variable ident e in
   object (self : 'self)
     inherit Js_map.map as super
     method! statement x =
@@ -229,8 +230,9 @@ let subst_map name = object (self)
         | _ ->  
           (* self#add_substitue ident e ; *)
           S.block @@
-          (Ext_list.rev_map_append  (fun (id,v) -> 
-               S.define ~kind:Strict id v)  bindings [original_statement] )
+          (Ext_list.rev_map_append  
+            (fun (id,v) -> 
+               S.define_variable ~kind:Strict id v)  bindings [original_statement] )
       end
     | _ -> super#statement v 
 

jscomp/core/js_pass_tailcall_inline.ml

@@ -211,7 +211,9 @@ let subst name export_set stats  =
             (*   (Js_dump.string_of_block [st]); *)
             Js_op_util.update_used_stats v.ident_info Dead_pure;
             let block  = 
-              Ext_list.fold_right2 (fun param arg acc ->  S.define ~kind:Variable param arg :: acc)
+              Ext_list.fold_right2 
+              (fun param arg acc ->  
+                S.define_variable ~kind:Variable param arg :: acc)
                 params args  ( self#block block) (* see #278 before changes*)
 
             in

jscomp/core/js_stmt_make.ml

@@ -74,7 +74,8 @@ let declare_variable ?comment  ?ident_info  ~kind (v:Ident.t)  : t=
                 ident_info ;};
    comment}
 
-let define ?comment  ?ident_info ~kind (v:Ident.t) exp    : t=
+let define_variable ?comment  ?ident_info 
+  ~kind (v:Ident.t) exp : t=
   let property : J.property =  kind in
   let ident_info  : J.ident_info  = 
     match ident_info with
@@ -85,6 +86,14 @@ let define ?comment  ?ident_info ~kind (v:Ident.t) exp    : t=
                 ident_info ;};
    comment}
 
+let alias_variable ?comment  ~exp (v:Ident.t)  : t=
+  {statement_desc = 
+     Variable {
+       ident = v; value = Some exp; property = Alias;
+       ident_info = {used_stats = NA }   };
+   comment}   
+
+
 let int_switch ?comment   ?declaration ?default (e : J.expression)  clauses : t = 
   match e.expression_desc with 
   | Number (Int {i; _}) -> 
@@ -105,7 +114,7 @@ let int_switch ?comment   ?declaration ?default (e : J.expression)  clauses : t
         [ {statement_desc = Exp {expression_desc = Bin(Eq,  {expression_desc = Var (Id id) ; _}, e0); _}; _}]
         when Ident.same did id 
         -> 
-        define ?comment ~kind id e0
+        define_variable ?comment ~kind id e0
       | Some(kind,did), _ 
         -> 
         block (declare_variable ?comment ~kind did :: continuation)
@@ -142,7 +151,7 @@ let string_switch ?comment ?declaration  ?default (e : J.expression)  clauses :
         [ {statement_desc = Exp {expression_desc = Bin(Eq,  {expression_desc = Var (Id id); _}, e0);_} ; _}]
         when Ident.same did id 
         -> 
-        define ?comment ~kind id e0
+        define_variable ?comment ~kind id e0
       | Some(kind,did), _ 
         -> 
         block @@ declare_variable ?comment ~kind did :: continuation
@@ -190,7 +199,7 @@ let rec if_ ?comment  ?declaration ?else_ (e : J.expression) (then_ : J.block)
       begin match declaration with 
         | Some (kind,did)  when Ident.same did id0 -> 
           declared := true;
-          define ~kind id0 (E.econd e a0 b0) :: acc 
+          define_variable ~kind id0 (E.econd e a0 b0) :: acc 
         (* To hit this branch, we also need [declaration] passed down 
            TODO: check how we compile [Lifthenelse]
         *)
@@ -278,12 +287,7 @@ let rec if_ ?comment  ?declaration ?else_ (e : J.expression) (then_ : J.block)
 
 
 
-let alias_variable ?comment  ?exp (v:Ident.t)  : t=
-  {statement_desc = 
-     Variable {
-       ident = v; value = exp; property = Alias;
-       ident_info = {used_stats = NA }   };
-   comment}
+
 
 let assign ?comment  id e : t = 
   {
@@ -354,7 +358,7 @@ let continue_stmt  ?comment   ?(label="") unit  : t =
     comment;
   }
 
-let debugger : t = 
-  { statement_desc = J.Debugger ; 
+let debugger_block : t list = 
+  [{ statement_desc = J.Debugger ; 
     comment = None 
-  }
+  }]

jscomp/core/js_stmt_make.mli

@@ -95,24 +95,27 @@ val string_switch :
   string J.case_clause list ->
   t
 
+(** Just declaration without initialization *)  
 val declare_variable : 
   ?comment:string ->
   ?ident_info:J.ident_info ->
   kind:Lam.let_kind -> 
   Ident.t ->
   t
 
-val define : 
+(*** Declaration with initialization *)
+val define_variable : 
   ?comment:string ->
   ?ident_info:J.ident_info ->
   kind:Lam.let_kind -> 
   Ident.t ->
   J.expression ->
   t
 
+(** created an alias expression *)  
 val alias_variable :
   ?comment:string ->
-  ?exp:J.expression ->
+  exp:J.expression ->
   Ident.t ->
   t
 
@@ -122,11 +125,25 @@ val assign :
   J.expression ->
   t
 
+(** Used in cases like 
+  {[
+    let x = while true do 
+      ...
+    done in ..
+  ]}
+*)  
 val assign_unit :
   ?comment:string  ->
   J.ident ->
   t
 
+(** used in cases like 
+  {[
+    let x = while true do 
+      ...
+    done in ..
+  ]}
+*)  
 val declare_unit :
   ?comment:string  ->
   J.ident ->
@@ -167,6 +184,9 @@ val return_stmt :
   J.expression ->
   t
 
+(** TODO: this should 
+    be marked as failrue
+*)  
 val unknown_lambda :
   ?comment:string  ->
   Lam.t ->
@@ -183,4 +203,4 @@ val continue_stmt :
   unit  ->
   t
 
-val debugger :  t
+val debugger_block :  t list

jscomp/core/lam_compile.ml

@@ -281,7 +281,7 @@ and compile_recursive_let ~all_bindings
                 (
                   Ident_map.fold
                     (fun old new_param  acc ->
-                       S.define ~kind:Alias old (E.var new_param) :: acc) 
+                       S.define_variable ~kind:Alias old (E.var new_param) :: acc) 
                     ret.new_params body_block
                 )
             ]
@@ -304,7 +304,7 @@ and compile_recursive_let ~all_bindings
        and need to be declared first 
     *)
     Js_output.of_block (
-      S.define ~kind:Variable id (E.array Mutable []) :: 
+      S.define_variable ~kind:Variable id (E.array Mutable []) :: 
       (List.mapi (fun i (x : Lam.t) -> 
            match x with  
            | Lvar lid
@@ -375,7 +375,7 @@ and compile_recursive_lets_aux cxt id_args : Js_output.t =
   | [] -> output_code
   | _ ->  
     (Js_output.of_block  @@
-     Ext_list.map (fun id -> S.define ~kind:Variable id (E.dummy_obj ())) ids ) 
+     Ext_list.map (fun id -> S.define_variable ~kind:Variable id (E.dummy_obj ())) ids ) 
     ++  output_code
 and compile_recursive_lets cxt id_args : Js_output.t  = 
 
@@ -691,7 +691,8 @@ and
       -> 
       (* [%bs.debugger] guarantees that the expression does not matter 
          TODO: make it even safer      *)
-      Js_output.handle_block_return st should_return lam [S.debugger] E.unit
+      Js_output.handle_block_return st should_return lam 
+      S.debugger_block E.unit
 
 
 
@@ -933,7 +934,7 @@ and
                 (* Invariant: should_return is false*)
                 Js_output.make @@ 
                 Ext_list.append b  [
-                  S.define ~kind id (E.econd e out1 out2) ]
+                  S.define_variable ~kind id (E.econd e out1 out2) ]
               | _, _ -> 
                 Js_output.make 
                   ( Ext_list.append b [
@@ -1140,7 +1141,7 @@ and
             | _ -> 
               let v = Ext_ident.create_tmp () in  
               (* Necessary avoid duplicated computation*)
-              (S.define ~kind:Variable v e ) ::  dispatch (E.var v)
+              (S.define_variable ~kind:Variable v e ) ::  dispatch (E.var v)
           end
         | _, _, {value =  None; _}  -> assert false 
       in
@@ -1235,7 +1236,7 @@ and
             TODO: wait for a bug fix
       *)
       let declares = 
-        S.define ~kind:Variable exit_id
+        S.define_variable ~kind:Variable exit_id
           E.zero_int_literal :: 
         (* we should always make it zero here, since [zero] is reserved in our mapping*)
         Ext_list.map (fun x -> S.declare_variable ~kind:Variable x ) bindings in
@@ -1366,7 +1367,7 @@ and
                                              body) ])
               | _ , _
                 -> 
-                Ext_list.append b1 (S.define ~kind:Variable id e1 :: (Ext_list.append b2   [
+                Ext_list.append b1 (S.define_variable ~kind:Variable id e1 :: (Ext_list.append b2   [
                     S.for_ None e2 id direction 
                       (Js_output.to_block @@ 
                        compile_lambda {cxt with should_return = ReturnFalse ; st = EffectCall}

jscomp/core/lam_compile_external_obj.ml

@@ -99,7 +99,7 @@ let assemble_args_obj (labels : External_arg_spec.t list)  (args : J.expression
   | _ ->     
     let v  = Ext_ident.create_tmp () in 
     let var_v = E.var v in 
-    S.define ~kind:Variable v 
+    S.define_variable ~kind:Variable v 
     (begin match eff with
       | [] -> 
         E.obj map