Print scope

Author: nojaf

analysis/src/CmtViewer.ml

@@ -1,9 +1,3 @@
-let loc_to_string (loc : Warnings.loc) : string =
-  Format.sprintf "(%02d,%02d--%02d,%02d)" loc.loc_start.pos_lnum
-    (loc.loc_start.pos_cnum - loc.loc_start.pos_bol)
-    loc.loc_end.pos_lnum
-    (loc.loc_end.pos_cnum - loc.loc_end.pos_bol)
-
 let filter_by_cursor cursor (loc : Warnings.loc) : bool =
   match cursor with
   | None -> true
@@ -70,16 +64,16 @@ let dump ?filter rescript_json cmt_path =
            match kind with
            | KType t ->
              Printf.printf "%d ktype        %s\n" stamp
-               (loc_to_string t.extentLoc)
+               (Warnings.loc_to_string t.extentLoc)
            | KValue t ->
              Printf.printf "%d kvalue       %s\n" stamp
-               (loc_to_string t.extentLoc)
+               (Warnings.loc_to_string t.extentLoc)
            | KModule t ->
              Printf.printf "%d kmodule      %s\n" stamp
-               (loc_to_string t.extentLoc)
+               (Warnings.loc_to_string t.extentLoc)
            | KConstructor t ->
              Printf.printf "%d kconstructor %s\n" stamp
-               (loc_to_string t.extentLoc));
+               (Warnings.loc_to_string t.extentLoc));
 
     (* dump the structure *)
     let rec dump_structure indent (structure : Module.structure) =
@@ -91,11 +85,13 @@ let dump ?filter rescript_json cmt_path =
       let open Module in
       match item.kind with
       | Value _typedExpr ->
-        Printf.printf "Value %s %s\n" item.name (loc_to_string item.loc)
+        Printf.printf "Value %s %s\n" item.name
+          (Warnings.loc_to_string item.loc)
       | Type _ ->
-        Printf.printf "Type %s %s\n" item.name (loc_to_string item.loc)
+        Printf.printf "Type %s %s\n" item.name (Warnings.loc_to_string item.loc)
       | Module {type_ = m} ->
-        Printf.printf "Module %s %s\n" item.name (loc_to_string item.loc);
+        Printf.printf "Module %s %s\n" item.name
+          (Warnings.loc_to_string item.loc);
         dump_module indent m
     and dump_module indent (module_ : Module.t) =
       match module_ with
@@ -127,6 +123,6 @@ let dump ?filter rescript_json cmt_path =
            | 0 -> compare aLoc.pos_cnum bLoc.pos_cnum
            | c -> c)
     |> List.iter (fun {loc; locType} ->
-           let locStr = loc_to_string loc in
+           let locStr = Warnings.loc_to_string loc in
            let kindStr = SharedTypes.locTypeToString locType in
            Printf.printf "%s %s\n" locStr kindStr)

analysis/src/Completions.ml

@@ -9,6 +9,13 @@ let getCompletions ~debug ~path ~pos ~currentFile ~forHover =
     with
     | None -> None
     | Some (completable, scope) -> (
+      if debug then (
+        Printf.printf "\nScope from frontend:\n";
+        List.iter
+          (fun item ->
+            Printf.printf "%s\n" (SharedTypes.ScopeTypes.item_to_string item))
+          scope;
+        print_newline ());
       (* Only perform expensive ast operations if there are completables *)
       match Cmt.loadFullCmtFromPath ~path with
       | None -> None

analysis/src/SharedTypes.ml

@@ -801,6 +801,18 @@ module ScopeTypes = struct
     | Type of string * Location.t
     | Value of string * Location.t * Completable.contextPath option * item list
     | Include of string * Location.t
+
+  let item_to_string = function
+    | Constructor (name, loc) ->
+      "Constructor " ^ name ^ " " ^ Warnings.loc_to_string loc
+    | Field (name, loc) -> "Field " ^ name ^ " " ^ Warnings.loc_to_string loc
+    | Module (name, loc) -> "Module " ^ name ^ " " ^ Warnings.loc_to_string loc
+    | Open path -> "Open " ^ (path |> String.concat ".")
+    | Type (name, loc) -> "Type " ^ name ^ " " ^ Warnings.loc_to_string loc
+    | Value (name, loc, _, _) ->
+      "Value " ^ name ^ " " ^ Warnings.loc_to_string loc
+    | Include (name, loc) ->
+      "Include " ^ name ^ " " ^ Warnings.loc_to_string loc
 end
 
 module Completion = struct

compiler/ext/warnings.ml

@@ -676,3 +676,9 @@ let help_warnings () =
         (String.concat ", " (List.map string_of_int l))
   done;
   exit 0
+
+let loc_to_string (loc : loc) : string =
+  Format.sprintf "(%02d,%02d--%02d,%02d)" loc.loc_start.pos_lnum
+    (loc.loc_start.pos_cnum - loc.loc_start.pos_bol)
+    loc.loc_end.pos_lnum
+    (loc.loc_end.pos_cnum - loc.loc_end.pos_bol)

compiler/ext/warnings.mli

@@ -126,3 +126,8 @@ val message : t -> string
 val number : t -> int
 
 val reset : unit -> unit
+
+val loc_to_string : loc -> string
+(**
+Turn the location into a string with (line,column--line,column) format.
+*)