[src] rename "end of analysis" values

+ `eom` is now `eof` (end of file)
+ `later` is now `at_eof`
+ `last` is `at_eocb` (end of codebase)
+ add comments for `eof` in `.mli`s

Author: fantazio

src/deadArg.ml

@@ -12,16 +12,19 @@ open Typedtree
 
 open DeadCommon
 
-let later = ref []
-let last = ref []
+let at_eof = ref []
+let at_eocb = ref []
 
 let met = Hashtbl.create 512
 
-let eom () =
-  List.iter (fun f -> f ()) !later;
-  later := [];
+let eof () =
+  List.iter (fun f -> f ()) !at_eof;
+  at_eof := [];
   Hashtbl.reset met
 
+let eocb () =
+  List.iter (fun f -> f ()) !at_eocb
+
 let increment_count label count_tbl =
   let count = Hashtbl.find_opt count_tbl label |> Option.value ~default:0 in
   let count = count + 1 in
@@ -62,8 +65,8 @@ let deferrable_register_use label expr builddir loc last_loc count_tbl =
       (* TODO:
        * What does it mean to have a loc in a signature ?
        * When does it happen ? *)
-      last := register_use :: !last
-    else if !depth > 0 then later := register_use :: !later
+      at_eocb := register_use :: !at_eocb
+    else if !depth > 0 then at_eof := register_use :: !at_eof
     else register_use ()
   else register_use ()
 

src/deadArg.mli

@@ -9,20 +9,24 @@
 
 open Typedtree
 
-val later : (unit -> unit) list ref
-(** Functions needing a location in the current file to be processed
-    before being executed.
-    It is known that this location will have been processed at the end of
-    the binding.
-    Needed because the Tast_mapper run through sequences from the end
-    because tuples are built from right to left*)
+val at_eof : (unit -> unit) list ref
+(** Functions deferred to run at the end of the current file's analysis.
+    They reaqire the analysis of future locations in the current file.
+    It is known that these locations will have been processed at the end
+    of the binding.
+    Needed because the Tast_mapper runs through sequences from the end
+    because tuples are built from right to left. *)
 
-val last : (unit -> unit) list ref
-(** Functions needing a location out of the current file to be processed
-    before being executed. *)
+val eof : unit -> unit
+(** To use at the end of a [.cmt]'s analysis:
+    apply [at_eof] functions + reset internal state *)
+
+val eocb : unit -> unit
+(** To use at the end of the codebase analysis:
+    apply remaining deferred functions which required the analysis of future
+    locations, their respective files.
+    [eocb] = end of code base. *)
 
-val eom : unit -> unit
-(** Self cleaning *)
 
 val register_uses :
   Lexing.position -> (Asttypes.arg_label * expression option) list -> unit

src/deadCode.ml

@@ -78,8 +78,8 @@ let rec treat_exp exp args =
 
 
 let value_binding super self x =
-  let old_later = !DeadArg.later in
-  DeadArg.later := [];
+  let at_eof_saved = !DeadArg.at_eof in
+  DeadArg.at_eof := [];
   incr depth;
   let open Asttypes in
   begin match x with
@@ -111,8 +111,8 @@ let value_binding super self x =
   end;
 
   let r = super.Tast_mapper.value_binding self x in
-  List.iter (fun f -> f()) !DeadArg.later;
-  DeadArg.later := old_later;
+  List.iter (fun f -> f()) !DeadArg.at_eof;
+  DeadArg.at_eof := at_eof_saved;
   decr depth;
   r
 
@@ -406,9 +406,9 @@ let clean references loc =
   if (fn.[String.length fn - 1] <> 'i' && Utils.unit fn = sourceunit) then
     LocHash.remove references loc
 
-let eom loc_dep =
+let eof loc_dep =
   let state = State.get_current () in
-  DeadArg.eom();
+  DeadArg.eof();
   List.iter (assoc decs) loc_dep;
   List.iter (assoc DeadType.decs) !DeadType.dependencies;
   let sourcepath = State.File_infos.get_sourcepath state.State.file_infos in
@@ -422,8 +422,8 @@ let eom loc_dep =
     clean loc_dep;
     clean !DeadType.dependencies;
   end;
-  VdNode.eom ();
-  DeadObj.eom ();
+  VdNode.eof ();
+  DeadObj.eof ();
   DeadType.dependencies := [];
   Hashtbl.reset incl
 
@@ -480,7 +480,7 @@ let rec load_file state fn =
                 cmt_value_dependencies
             else []
           in
-          eom loc_dep
+          eof loc_dep
       | _ -> () (* todo: support partial_implementation? *)
       )
 
@@ -500,7 +500,7 @@ let rec load_file state fn =
 
 (* Prepare the list of opt_args for report *)
 let analyze_opt_args () =
-  List.iter (fun f -> f ()) !DeadArg.last;
+  DeadArg.eocb ();
   let all = ref [] in
   let tbl = Hashtbl.create 256 in
   let dec_loc loc = Hashtbl.mem main_files (Utils.unit loc.Lexing.pos_fname) in

src/deadCommon.ml

@@ -321,7 +321,7 @@ module VdNode = struct
       end
     in loop (func loc) lab occur
 
-  let eom () =
+  let eof () =
     let state = State.get_current () in
 
     let sons =

src/deadObj.ml

@@ -28,7 +28,7 @@ let inheritances = Hashtbl.create 512               (* inheritance links loc-> l
 
 let equals = Hashtbl.create 64
 
-let later = ref []
+let at_eof = ref []
 
 let last_class = ref Lexing.dummy_pos            (* last class met *)
 
@@ -160,7 +160,7 @@ let locate expr =
   in repr_exp expr locate
 
 
-let eom () =
+let eof () =
   Hashtbl.reset defined;
   last_class := Lexing.dummy_pos
 
@@ -318,7 +318,7 @@ let class_field f =
         add_equal f.cf_loc.Location.loc_start cl_exp.cl_loc.Location.loc_start;
         let loc = get_loc path in
         let equal () = add_equal cl_exp.cl_loc.Location.loc_start (get_loc path) in  (* for uses inside class def *)
-        if loc == Lexing.dummy_pos then later := equal :: !later
+        if loc == Lexing.dummy_pos then at_eof := equal :: !at_eof
         else equal ()
       end;
       List.iter (fun (s, _) -> update_overr false s) l
@@ -376,7 +376,7 @@ let coerce expr typ =
 
 let prepare_report () =
 
-  List.iter (fun f -> f ()) !later;
+  List.iter (fun f -> f ()) !at_eof;
 
   let apply_self meth loc1 loc2 =
     let loc1 = repr_loc loc1

src/deadObj.mli

@@ -60,8 +60,8 @@ val coerce:
   expression -> Types.type_expr -> unit
 
 
-val eom :
-  unit -> unit
+val eof : unit -> unit
+(** For use at the end of a [.cmt]'s analysis: reset internal state *)
 
 
 val report :