rename lineInfo to lineAnnotation

Author: cristianoc

analysis/reanalyze/src/Common.ml

@@ -238,6 +238,8 @@ type deadWarning =
   | WarningDeadValueWithSideEffects
   | IncorrectDeadAnnotation
 
+type lineAnnotation = (decl * line) option
+
 type description =
   | Circular of {message : string}
   | ExceptionAnalysis of {message : string}
@@ -248,8 +250,8 @@ type description =
       deadWarning : deadWarning;
       path : string;
       message : string;
-      shouldWriteAnnotation : bool;
-      lineInfo : (decl * line) option;
+      shouldWriteLineAnnotation : bool;
+      lineAnnotation : lineAnnotation;
     }
   | Termination of {termination : termination; message : string}
 

analysis/reanalyze/src/DeadCommon.ml

@@ -400,13 +400,14 @@ let emitWarning ~decl ~message deadWarning =
     | Value {isToplevel; sideEffects} -> isToplevel && sideEffects
     | _ -> false
   in
-  let shouldWriteAnnotation =
+  let shouldWriteLineAnnotation =
     (not (isToplevelValueWithSideEffects decl))
     && Suppress.filter decl.pos
     && deadWarning <> IncorrectDeadAnnotation
   in
-  let lineInfo =
-    if shouldWriteAnnotation then decl |> WriteDeadAnnotations.onDeadDecl
+  let lineAnnotation =
+    if shouldWriteLineAnnotation then
+      WriteDeadAnnotations.addLineAnnotation ~decl
     else None
   in
   decl.path
@@ -418,8 +419,8 @@ let emitWarning ~decl ~message deadWarning =
          deadWarning;
          path = Path.withoutHead decl.path;
          message;
-         lineInfo;
-         shouldWriteAnnotation;
+         lineAnnotation;
+         shouldWriteLineAnnotation;
        })
 
 module Decl = struct

analysis/reanalyze/src/Log_.ml

@@ -110,8 +110,9 @@ let missingRaiseInfoToText {exnTable; missingAnnotations; locFull} =
 
 let logAdditionalInfo ~(description : description) =
   match description with
-  | DeadWarning {lineInfo; shouldWriteAnnotation} ->
-    if shouldWriteAnnotation then WriteDeadAnnotations.lineInfoToString lineInfo
+  | DeadWarning {lineAnnotation; shouldWriteLineAnnotation} ->
+    if shouldWriteLineAnnotation then
+      WriteDeadAnnotations.lineAnnotationToString lineAnnotation
     else ""
   | ExceptionAnalysisMissing missingRaiseInfo ->
     missingRaiseInfoToText missingRaiseInfo

analysis/reanalyze/src/WriteDeadAnnotations.ml

@@ -109,7 +109,7 @@ let offsetOfPosAdjustment = function
   | FirstVariant | Nothing -> 0
   | OtherVariant -> 2
 
-let getLineInformation ~decl ~line =
+let getLineAnnotation ~decl ~line =
   if !Cli.json then
     let posAnnotation = decl |> getPosAnnotation in
     let offset = decl.posAdjustment |> offsetOfPosAdjustment in
@@ -127,13 +127,13 @@ let getLineInformation ~decl ~line =
     Format.asprintf "@.  <-- line %d@.  %s" decl.pos.pos_lnum
       (line |> lineToString)
 
-let getNoLineInfo () = if !Cli.json then "" else "\n  <-- Can't find line"
+let cantFindLine () = if !Cli.json then "" else "\n  <-- Can't find line"
 
-let lineInfoToString = function
-  | None -> getNoLineInfo ()
-  | Some (decl, line) -> getLineInformation ~decl ~line
+let lineAnnotationToString = function
+  | None -> cantFindLine ()
+  | Some (decl, line) -> getLineAnnotation ~decl ~line
 
-let onDeadDecl decl =
+let addLineAnnotation ~decl : lineAnnotation =
   let fileName = decl.pos.pos_fname in
   if Sys.file_exists fileName then (
     if fileName <> !currentFile then (