Module `Merlin_analysis.Locate`Source

Sourceval log : 'a Merlin_utils.Logger.printf

Sourcetype config = {

mconfig : Merlin_kernel.Mconfig.t;
ml_or_mli : [ `ML | `Smart | `MLI ];
(*
When ml_or_mli is `Smart, if locate blocks on an interface uid, it will use the cmt_declaration_dependencies to try finding a unique corresponding definition in the implementation.
*)
traverse_aliases : bool;

}

Sourcetype result = {

uid : Ocaml_typing.Shape.Uid.t;
decl_uid : Ocaml_typing.Shape.Uid.t;
file : string;
location : Ocaml_parsing.Location.t;
approximated : bool;

}

val uid_of_result : 
  traverse_aliases:bool ->
  Ocaml_typing.Shape_reduce.result ->
  Ocaml_typing.Shape.Uid.t option * bool

Source

val lookup_uid_decl : 
  config:Merlin_kernel.Mconfig.t ->
  Ocaml_typing.Shape.Uid.t ->
  Ocaml_typing.Typedtree.item_declaration option

Lookup the delcaration of the given Uid in the appropriate cmt file

Source

val get_linked_uids : 
  config:config ->
  comp_unit:string ->
  Ocaml_typing.Shape.Uid.t ->
  Ocaml_typing.Shape.Uid.t list

get_linked_uids queries the cmt_declaration_dependencies table and returns udis related to the one passed as argument. TODO right now this function only returns simple links tagged with Definition_to_declaration

Source

val find_source : 
  config:Merlin_kernel.Mconfig.t ->
  Ocaml_utils.Warnings.loc ->
  string ->
  [> `File_not_found of string | `Found of string * Ocaml_parsing.Location.t ]

Source

val from_path : 
  config:config ->
  env:Ocaml_typing.Env.t ->
  local_defs:Merlin_kernel.Mtyper.typedtree ->
  namespace:Env_lookup.Namespace.t ->
  Ocaml_typing.Path.t ->
  [> `File_not_found of result
  | `Found of result
  | `Builtin of Ocaml_typing.Shape.Uid.t * string
  | `Not_in_env of string
  | `Not_found of string * string option ]

Source

val from_string : 
  config:config ->
  env:Ocaml_typing.Env.t ->
  local_defs:Merlin_kernel.Mtyper.typedtree ->
  pos:Lexing.position ->
  ?namespaces:Env_lookup.Namespace.inferred_basic list ->
  string ->
  [> `File_not_found of result
  | `Found of result
  | `Builtin of Ocaml_typing.Shape.Uid.t * string
  | `Missing_labels_namespace
  | `Not_found of string * string option
  | `Not_in_env of string
  | `At_origin ]

Source

val get_doc : 
  config:Merlin_kernel.Mconfig.t ->
  env:Ocaml_typing.Env.t ->
  local_defs:Merlin_kernel.Mtyper.typedtree ->
  comments:(string * Ocaml_parsing.Location.t) list ->
  pos:Lexing.position ->
  [ `User_input of string
  | `Completion_entry of
    Env_lookup.Namespace.t * Ocaml_typing.Path.t * Ocaml_parsing.Location.t ] ->
  [> `Found of string
  | `Builtin of string
  | `Not_found of string * string option
  | `Not_in_env of string
  | `No_documentation ]

Install

Dune Dependency

Authors

Maintainers

Sources

doc/merlin-lib.analysis/Merlin_analysis/Locate/index.html

Module `Merlin_analysis.Locate`Source

package merlin-lib

Install

Dune Dependency

Authors

Maintainers

Sources

doc/merlin-lib.analysis/Merlin_analysis/Locate/index.html

Module Merlin_analysis.LocateSource

Module `Merlin_analysis.Locate`Source