use File_content.Position.t in many more places

Summary: The IDE code caries a lot of `line` and `column` parameters which originally come from a `File_content.Position.t`. Since that type is now nicely abstracting the indexing base, let's propagate it everywhere where a raw line and column are used. That's a lot of places...

Reviewed By: andrewjkennedy

Differential Revision: D68553997

fbshipit-source-id: fe98c3fe019e5f39db75aefc9448c47c1f61f2fa

Author: Catherine Gasnier

hphp/hack/src/client/clientCheck.ml

@@ -521,6 +521,7 @@ let main_internal
   | ClientEnv.MODE_IDENTIFY_SYMBOL2 arg
   | ClientEnv.MODE_IDENTIFY_SYMBOL3 arg ->
     let (line, char) = parse_position_string ~split_on:":" arg in
+    let pos = File_content.Position.from_one_based line char in
     let file =
       match args.ClientEnv.stdin_name with
       | None -> ""
@@ -530,8 +531,7 @@ let main_internal
       ServerCommandTypes.FileContent (Sys_utils.read_stdin_to_string ())
     in
     let%lwt (result, telemetry) =
-      rpc args
-      @@ ServerCommandTypes.IDENTIFY_FUNCTION (file, content, line, char)
+      rpc args @@ ServerCommandTypes.IDENTIFY_FUNCTION (file, content, pos)
     in
     ClientGetDefinition.go result args.ClientEnv.output_json;
     Lwt.return (Exit_status.No_error, telemetry)
@@ -556,8 +556,9 @@ let main_internal
         Printf.eprintf "Invalid position\n";
         raise Exit_status.(Exit_with Input_error)
     in
+    let pos = File_content.Position.from_one_based line char in
     let%lwt (ty, telemetry) =
-      rpc args @@ ServerCommandTypes.INFER_TYPE (fn, line, char)
+      rpc args @@ ServerCommandTypes.INFER_TYPE (fn, pos)
     in
     ClientTypeAtPos.go ty args.ClientEnv.output_json;
     Lwt.return (Exit_status.No_error, telemetry)
@@ -568,16 +569,23 @@ let main_internal
             match Str.split (Str.regexp ":") pos with
             | [filename; line; char] ->
               ( expand_path filename,
-                int_of_string line,
-                int_of_string char,
+                File_content.Position.from_one_based
+                  (int_of_string line)
+                  (int_of_string char),
                 None )
             | [filename; start_line; start_char; end_line; end_char] ->
               let filename = expand_path filename in
               let start_line = int_of_string start_line in
               let start_char = int_of_string start_char in
               let end_line = int_of_string end_line in
               let end_char = int_of_string end_char in
-              (filename, start_line, start_char, Some (end_line, end_char))
+              let start_pos =
+                File_content.Position.from_one_based start_line start_char
+              in
+              let end_pos =
+                File_content.Position.from_one_based end_line end_char
+              in
+              (filename, start_pos, Some end_pos)
             | _ -> raise Exit
           with
           | _ ->

hphp/hack/src/client/clientLsp.ml

@@ -1015,14 +1015,13 @@ let lsp_position_to_ide ({ Lsp.line; character } : Lsp.position) :
   File_content.Position.from_zero_based line character
 
 let lsp_file_position_to_hack (params : Lsp.TextDocumentPositionParams.t) :
-    string * int * int =
+    string * File_content.Position.t =
   let open Lsp.TextDocumentPositionParams in
   let pos = lsp_position_to_ide params.position in
   let filename =
     Lsp_helpers.lsp_textDocumentIdentifier_to_filename params.textDocument
   in
-  let (line, column) = File_content.Position.line_column_one_based pos in
-  (filename, line, column)
+  (filename, pos)
 
 let rename_params_to_document_position (params : Lsp.Rename.params) :
     Lsp.TextDocumentPositionParams.t =
@@ -1290,15 +1289,14 @@ Raises an LSP [InvalidRequest] exception if the file isn't currently open. *)
 let get_document_location
     (editor_open_files : Lsp.TextDocumentItem.t UriMap.t)
     (params : Lsp.TextDocumentPositionParams.t) :
-    ClientIdeMessage.document * ClientIdeMessage.location =
-  let (file_path, line, column) = lsp_file_position_to_hack params in
+    ClientIdeMessage.document * File_content.Position.t =
+  let (file_path, pos) = lsp_file_position_to_hack params in
   let uri =
     params.TextDocumentPositionParams.textDocument.TextDocumentIdentifier.uri
   in
   let file_path = Path.make file_path in
   let file_contents = get_document_contents editor_open_files uri in
-  ( { ClientIdeMessage.file_path; file_contents },
-    { ClientIdeMessage.line; column } )
+  ({ ClientIdeMessage.file_path; file_contents }, pos)
 
 (** Parses output of "hh --ide-find-references" and "hh --ide-go-to-impl".
 If the output is malformed, raises an exception. *)
@@ -2510,11 +2508,12 @@ let do_resolve
           let ranking_detail = Jget.string_opt data "ranking_detail" in
           let ranking_source = Jget.int_opt data "ranking_source" in
           if line = 0 && column = 0 then failwith "NoFileLineColumnData";
+          let pos = File_content.Position.from_one_based line column in
           let request =
             ClientIdeMessage.Completion_resolve_location
               ( file_path,
                 ClientIdeMessage.Full_name fullname,
-                { ClientIdeMessage.line; column },
+                pos,
                 resolve_ranking_source kind ranking_source )
           in
           let%lwt raw_docblock =

hphp/hack/src/client/ide_service/clientIdeDaemon.ml

@@ -807,19 +807,18 @@ let handle_request
   (***********************************************************)
   (************************* NORMAL HANDLING AFTER INIT ******)
   (***********************************************************)
-  | (Initialized istate, Hover (document, { line; column })) ->
+  | (Initialized istate, Hover (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let result =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          Ide_hover.go_quarantined ~ctx ~entry ~line ~column)
+          Ide_hover.go_quarantined ~ctx ~entry pos)
     in
     (Initialized istate, Ok result)
-  | ( Initialized istate,
-      Go_to_implementation (document, { line; column }, document_list) ) ->
+  | (Initialized istate, Go_to_implementation (document, pos, document_list)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let (istate, result) =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          match ServerFindRefs.go_from_file_ctx ~ctx ~entry ~line ~column with
+          match ServerFindRefs.go_from_file_ctx ~ctx ~entry pos with
           | Some (_name, action)
             when not @@ ServerGoToImpl.is_searchable ~action ->
             (istate, ClientIdeMessage.Invalid_symbol_impl)
@@ -874,17 +873,15 @@ let handle_request
     in
     (Initialized istate, Ok result)
     (* textDocument/rename *)
-  | ( Initialized istate,
-      Rename (document, { line; column }, new_name, document_list) ) ->
+  | (Initialized istate, Rename (document, pos, new_name, document_list)) ->
     let (istate, ctx, entry, _errors) = update_file_ctx istate document in
     let (istate, result) =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
           match
             ServerFindRefs.go_from_file_ctx_with_symbol_definition
               ~ctx
               ~entry
-              ~line
-              ~column
+              pos
           with
           | None -> (istate, ClientIdeMessage.Not_renameable_position)
           | Some (_definition, action) when ServerFindRefs.is_local action ->
@@ -945,14 +942,13 @@ let handle_request
     in
     (Initialized istate, Ok result)
     (* textDocument/references - localvar only *)
-  | ( Initialized istate,
-      Find_references (document, { line; column }, document_list) ) ->
+  | (Initialized istate, Find_references (document, pos, document_list)) ->
     let open Result.Monad_infix in
     (* Update the state of the world with the document as it exists in the IDE *)
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let (istate, result) =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          match ServerFindRefs.go_from_file_ctx ~ctx ~entry ~line ~column with
+          match ServerFindRefs.go_from_file_ctx ~ctx ~entry pos with
           | Some (name, action) when ServerFindRefs.is_local action ->
             let result =
               ServerFindRefs.go_for_localvar ctx action
@@ -1091,9 +1087,7 @@ let handle_request
     (Initialized istate, Ok result)
   (* Autocomplete *)
   | ( Initialized istate,
-      Completion
-        (document, { line; column }, { ClientIdeMessage.is_manually_invoked })
-    ) ->
+      Completion (document, pos, { ClientIdeMessage.is_manually_invoked }) ) ->
     (* Update the state of the world with the document as it exists in the IDE *)
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let sienv_ref = ref istate.sienv in
@@ -1103,8 +1097,7 @@ let handle_request
         ~entry
         ~sienv_ref
         ~is_manually_invoked
-        ~line
-        ~column
+        pos
         ~naming_table:istate.naming_table
     in
     let istate = { istate with sienv = !sienv_ref } in
@@ -1119,8 +1112,7 @@ let handle_request
     (Initialized istate, Ok Completion_resolve.{ docblock = result; signature })
   (* Autocomplete docblock resolve *)
   | ( Initialized istate,
-      Completion_resolve_location (file_path, fullname, { line; column }, kind)
-    ) ->
+      Completion_resolve_location (file_path, fullname, pos, kind) ) ->
     (* We're given a location but it often won't be an opened file.
        We will only serve autocomplete docblocks as of truth on disk.
        Hence, we construct temporary entry to reflect the file which
@@ -1133,38 +1125,35 @@ let handle_request
     let (ctx, entry) = Provider_context.add_entry_if_missing ~ctx ~path in
     let result =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          ServerDocblockAt.go_docblock_ctx ~ctx ~entry ~line ~column ~kind)
+          ServerDocblockAt.go_docblock_ctx ~ctx ~entry pos ~kind)
     in
     let (Full_name s) = fullname in
     let signature = ServerAutoComplete.get_signature ctx s in
     (Initialized istate, Ok Completion_resolve.{ docblock = result; signature })
   (* Document highlighting *)
-  | (Initialized istate, Document_highlight (document, { line; column })) ->
+  | (Initialized istate, Document_highlight (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let results =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          Ide_highlight_refs.go_quarantined ~ctx ~entry ~line ~column)
+          Ide_highlight_refs.go_quarantined ~ctx ~entry pos)
     in
     (Initialized istate, Ok results)
   (* Signature help *)
-  | (Initialized istate, Signature_help (document, { line; column })) ->
+  | (Initialized istate, Signature_help (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let results =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          ServerSignatureHelp.go_quarantined ~ctx ~entry ~line ~column)
+          ServerSignatureHelp.go_quarantined ~ctx ~entry pos)
     in
     (Initialized istate, Ok results)
-  | (Initialized istate, Top_level_def_name_at_pos (document, { line; column }))
-    ->
+  | (Initialized istate, Top_level_def_name_at_pos (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
-    let res =
-      Ide_top_level_def_name_at_pos.go_quarantined ctx entry ~line ~column
-    in
+    let res = Ide_top_level_def_name_at_pos.go_quarantined ctx entry pos in
     (Initialized istate, Ok res)
   (* AutoClose *)
-  | (Initialized istate, AutoClose (document, { line; column })) ->
+  | (Initialized istate, AutoClose (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
-    let close_tag = AutocloseTags.go_xhp_close_tag ~ctx ~entry ~line ~column in
+    let close_tag = AutocloseTags.go_xhp_close_tag ~ctx ~entry pos in
     (Initialized istate, Ok close_tag)
   (* Code actions (refactorings, quickfixes) *)
   | (Initialized istate, Code_action (document, range)) ->
@@ -1233,19 +1222,19 @@ let handle_request
     in
     (Initialized istate, Ok result)
   (* Go to definition *)
-  | (Initialized istate, Definition (document, { line; column })) ->
+  | (Initialized istate, Definition (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let result =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          ServerGoToDefinition.go_quarantined ~ctx ~entry ~line ~column)
+          ServerGoToDefinition.go_quarantined ~ctx ~entry pos)
     in
     (Initialized istate, Ok result)
   (* Type Definition *)
-  | (Initialized istate, Type_definition (document, { line; column })) ->
+  | (Initialized istate, Type_definition (document, pos)) ->
     let (istate, ctx, entry, _) = update_file_ctx istate document in
     let result =
       Provider_utils.respect_but_quarantine_unsaved_changes ~ctx ~f:(fun () ->
-          ServerTypeDefinition.go_quarantined ~ctx ~entry ~line ~column)
+          ServerTypeDefinition.go_quarantined ~ctx ~entry pos)
     in
     (Initialized istate, Ok result)
   (* Workspace Symbol *)

hphp/hack/src/client/ide_service/clientIdeMessage.ml

@@ -42,11 +42,6 @@ type document = {
   file_contents: string;
 }
 
-type location = {
-  line: int;
-  column: int;
-}
-
 type fullname = Full_name of string
 
 type find_refs_result =
@@ -127,16 +122,16 @@ type _ t =
   | Diagnostics : document -> diagnostic list t
       (** Obtains latest diagnostics for file. *)
   | Verbose_to_file : bool -> unit t
-  | Hover : document * location -> HoverService.result t
+  | Hover : document * File_content.Position.t -> HoverService.result t
   | Definition :
-      document * location
+      document * File_content.Position.t
       -> ServerCommandTypes.Go_to_definition.result t
   | Completion :
-      document * location * completion_request
+      document * File_content.Position.t * completion_request
       -> AutocompleteTypes.ide_result t
       (** Handles "textDocument/completion" LSP messages *)
   | Completion_resolve_location :
-      Path.t * fullname * location * FileInfo.si_kind
+      Path.t * fullname * File_content.Position.t * FileInfo.si_kind
       -> Completion_resolve.result t
       (** "completionItem/resolve" LSP messages - if we have file/line/column.
       The scenario is that VSCode requests textDocument/completion in A.PHP line 5 col 6,
@@ -148,16 +143,22 @@ type _ t =
       Completion_resolve.request
       -> Completion_resolve.result t
       (** "completionItem/resolve" LSP messages - if we have symbol name, and [Completion_resolve_location] failed *)
-  | Document_highlight : document * location -> Ide_api_types.range list t
+  | Document_highlight :
+      document * File_content.Position.t
+      -> Ide_api_types.range list t
       (** Handles "textDocument/documentHighlight" LSP messages *)
   | Document_symbol : document -> FileOutline.outline t
       (** Handles "textDocument/documentSymbol" LSP messages *)
   | Workspace_symbol : string -> SearchUtils.result t
   | Go_to_implementation :
-      document * location * document list
+      document * File_content.Position.t * document list
       -> go_to_impl_result t
-  | Find_references : document * location * document list -> find_refs_result t
-  | Rename : document * location * string * document list -> rename_result t
+  | Find_references :
+      document * File_content.Position.t * document list
+      -> find_refs_result t
+  | Rename :
+      document * File_content.Position.t * string * document list
+      -> rename_result t
       (** The result of Rename is one of:
        - Not_renameable_position, indicating an attempt to rename something that isn't a valid symbol
        - Rename_success, where we return a record containing two fields:
@@ -167,13 +168,15 @@ type _ t =
             in the input document list
           *)
   | Type_definition :
-      document * location
+      document * File_content.Position.t
       -> ServerCommandTypes.Go_to_type_definition.result t
       (** Handles "textDocument/typeDefinition" LSP messages *)
-  | Signature_help : document * location -> Lsp.SignatureHelp.result t
+  | Signature_help :
+      document * File_content.Position.t
+      -> Lsp.SignatureHelp.result t
       (** Handles "textDocument/signatureHelp" LSP messages *)
   | Top_level_def_name_at_pos :
-      document * location
+      document * File_content.Position.t
       -> Lsp.TopLevelDefNameAtPos.result t
   | Code_action :
       document * Ide_api_types.range
@@ -205,7 +208,7 @@ type _ t =
       use_snippet_edits: bool;
     }
       -> Lsp.CodeActionResolve.result t
-  | AutoClose : document * location -> string option t
+  | AutoClose : document * File_content.Position.t -> string option t
 
 let t_to_string : type a. a t -> string = function
   | Initialize_from_saved_state _ -> "Initialize_from_saved_state"

hphp/hack/src/client/ide_service/dune

@@ -33,8 +33,13 @@
 (library
  (name client_ide_message)
  (wrapped false)
- (modules clientIdeMessage)
- (libraries lwt_utils server_command_types server_services sys_utils)
+ (modules
+  clientIdeMessage)
+ (libraries
+  file_content
+  lwt_utils
+  server_command_types
+  server_services sys_utils)
  (preprocess
   (pps lwt_ppx ppx_deriving.std)))