package merlin-lib

You can search for identifiers within the package.

in-package search v0.2.0

merlin-lib.analysis
- Merlin_analysis
  - Browse_misc
  - Browse_tree
  - Completion
  - Construct
  - Context
  - Destruct
  - Expansion
  - Jump
  - Locate
    
    Namespace
  - Misc_utils
    
    Path
  - Namespaced_path
    
    Id
    
    Namespace
  - Ocamldoc
  - Outline
  - Polarity_search
    
    PathSet
  - Ptyp_of_type
  - Refactor_open
  - Tail_analysis
  - Type_enclosing
  - Type_utils
    
    Printtyp
merlin-lib.config
- Merlin_config
merlin-lib.dot_protocol
- Merlin_dot_protocol
  - Commands
  - Directive
    
    Processed
    
    Raw
merlin-lib.extend
- Merlin_extend
  - Extend_driver
  - Extend_main
    
    Description
    
    Handshake
    
    Reader
    
    Utils
  - Extend_protocol
    
    Reader
    
    V0
merlin-lib.kernel
- Merlin_kernel
  - Extension
  - Mbrowse
  - Mconfig
    
    Verbosity
  - Mconfig_dot
  - Mocaml
  - Mpipeline
  - Mppx
  - Mreader
  - Mreader_explain
  - Mreader_extend
  - Mreader_lexer
  - Mreader_parser
  - Mreader_recover
    
    Make
    
    Dump
    
    Parser
    
    Recovery
  - Msource
  - Mtyper
  - Pparse
  - Standard_library
merlin-lib.ocaml_merlin_specific
- Merlin_specific
  - Browse_raw
  - Tast_helper
    
    Pat
  - Typer_raw
merlin-lib.ocaml_parsing
- Ocaml_parsing
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_iterator
  - Ast_mapper
  - Asttypes
  - Attr_helper
  - Builtin_attributes
  - Docstrings
    
    WithMenhir
  - Extend_helper
  - Fake
    
    Lwt
    
    Meta
  - Location
  - Location_aux
  - Longident
  - Msupport_parsing
  - Parsetree
  - Pprintast
  - Printast
  - Syntaxerr
merlin-lib.ocaml_preprocess
- Ocaml_preprocess
  - Lexer_ident
  - Lexer_raw
  - MenhirLib
    
    Convert
    
    Simplified
    
    Engine
    
    Make
    
    T
    
    Log
    
    EngineTypes
    
    ENGINE
    
    INCREMENTAL_ENGINE_START
    
    MONOLITHIC_ENGINE
    
    TABLE
    
    Log
    
    ErrorReports
    
    General
    
    IncrementalEngine
    
    EVERYTHING
    
    INCREMENTAL_ENGINE
    
    INSPECTION
    
    SYMBOLS
    
    InfiniteArray
    
    InspectionTableFormat
    
    TABLES
    
    InspectionTableInterpreter
    
    Make
    
    E
    
    ET
    
    Log
    
    IT
    
    TT
    
    Symbols
    
    T
    
    LexerUtil
    
    LinearizedArray
    
    PackedIntArray
    
    Printers
    
    Make
    
    I
    
    User
    
    RowDisplacement
    
    StaticVersion
    
    TableFormat
    
    TABLES
    
    TableInterpreter
    
    MakeEngineTable
    
    Log
    
    T
  - Parser_explain
  - Parser_printer
  - Parser_raw
    
    Incremental
    
    MenhirInterpreter
  - Parser_recover
    
    Default
merlin-lib.ocaml_typing
- Ocaml_typing
  - Annot
  - Btype
    
    For_copy
    
    TransientTypeMap
    
    TypeHash
    
    TypeMap
    
    TypePairs
    
    TypeSet
  - Cmi_cache
  - Cmi_format
  - Cmt_cache
  - Cmt_format
  - Ctype
  - Datarepr
  - Env
  - Envaux
  - Errortrace
    
    Subtype
  - Ident
    
    Map
    
    Set
    
    T
    
    Tbl
  - Includeclass
  - Includecore
  - Includemod
    
    Error
    
    FieldMap
    
    Functor_app_diff
    
    Defs
    
    Functor_inclusion_diff
    
    Defs
  - Includemod_errorprinter
  - Magic_numbers
    
    Cmi
  - Msupport
  - Mtype
  - Natural
    
    Array
    
    Make
    
    Array
    
    Map
    
    Set
    
    Tbl
    
    Make_no_zero
    
    Array
    
    Map
    
    Set
    
    Tbl
    
    S
    
    Array
    
    Map
    
    Set
    
    Tbl
    
    S_no_zero
    
    Array
    
    Map
    
    Set
    
    Tbl
  - Oprint
  - Outcometree
  - Parmatch
    
    Compat
    
    _
  - Path
    
    Map
    
    Set
  - Patterns
    
    General
    
    Half_simple
    
    Head
    
    Non_empty_row
    
    Simple
  - Persistent_env
    
    Consistbl
    
    Persistent_signature
  - Predef
  - Primitive
  - Printpat
  - Printtyp
    
    Conflicts
    
    Naming_context
    
    Out_name
    
    Subtype
  - Printtyped
  - Rec_check
  - Saved_parts
  - Shape
    
    Item
    
    Map
    
    Make_reduce
    
    Context
    
    Map
    
    Sig_component_kind
    
    Uid
    
    Map
    
    Set
    
    T
    
    Tbl
  - Short_paths
    
    Basis
  - Short_paths_graph
    
    Age
    
    Array
    
    Map
    
    Set
    
    Tbl
    
    Class_type
    
    Component
    
    Dependency
    
    Array
    
    Map
    
    Set
    
    Tbl
    
    Desc
    
    Class_type
    
    Module
    
    Module_type
    
    Type
    
    Diff
    
    Item
    
    Graph
    
    Ident
    
    Ident_map
    
    Ident_set
    
    Module
    
    Module_type
    
    Origin
    
    Path
    
    Path_map
    
    Path_set
    
    Sort
    
    String_map
    
    Type
  - Signature_group
  - Stypes
  - Subst
    
    Lazy
  - Tast_iterator
  - Tast_mapper
  - Type_immediacy
    
    Violation
  - Typeclass
  - Typecore
    
    Datatype_kind
  - Typedecl
  - Typedecl_immediacy
  - Typedecl_properties
  - Typedecl_separability
  - Typedecl_unboxed
  - Typedecl_variance
  - Typedtree
  - Typemod
    
    Sig_component_kind
    
    Signature_names
  - Typeopt
  - Types
    
    MethSet
    
    Meths
    
    Separability
    
    TransientTypeOps
    
    Transient_expr
    
    VarSet
    
    Variance
    
    Vars
  - Typetexp
  - Untypeast
merlin-lib.ocaml_utils
- Ocaml_utils
  - Build_path_prefix_map
  - Clflags
  - Config
  - Consistbl
    
    Make
    
    Module_name
    
    Map
    
    Set
    
    Tbl
  - Diffing
    
    Define
    
    D
    
    Left_variadic
    
    _
    
    Parameters
    
    Right_variadic
    
    _
    
    S
    
    Simple
    
    _
    
    Defs
  - Diffing_with_keys
    
    Define
    
    D
    
    Parameters
    
    Simple
    
    _
  - Directory_content_cache
  - Identifiable
    
    Make
    
    Map
    
    Set
    
    T
    
    Tbl
    
    Pair
    
    A
    
    B
    
    S
    
    Map
    
    Set
    
    T
    
    Tbl
    
    Thing
  - Lazy_backtrack
  - Load_path
    
    Dir
  - Local_store
  - Tbl
  - Warnings
merlin-lib.os_ipc
- Os_ipc
merlin-lib.query_commands
- Query_commands
merlin-lib.query_protocol
- Query_protocol
  - Compl
merlin-lib.utils
- Merlin_utils
  - File_cache
    
    Make
    
    Input
  - File_id
  - Lib_config
    
    Json
  - Logger
  - Marg
  - Misc
    
    Color
    
    Int_literal_converter
    
    LongString
    
    String
    
    Map
    
    Set
    
    Tbl
  - Ppxsetup
  - Sexp
  - Std
    
    Char
    
    Format
    
    Glob
    
    Hashtbl
    
    Json
    
    Lexing
    
    List
    
    Lazy
    
    Option
    
    Infix
    
    Result
    
    Shell
    
    String
    
    Map
    
    Set

Legend:
Library
Module
Module type
Parameter
Class
Class type

val to_shortest_lid : 
  env:Ocaml_typing.Env.t ->
  ?name:string ->
  env_check:(Ocaml_parsing.Longident.t -> Ocaml_typing.Env.t -> 'a) ->
  Ocaml_typing.Path.t ->
  Ocaml_parsing.Longident.t

to_shortest_lid ~env ~env_check path will make a Longident.t from the provided Path.t and attempt to use the shortest prefix possible given the currently opened modules. The result is checked by looking it up in the environment using the env_check : Longident.t -> Env.t -> 'a function.

The check is needed because shadowing can cause subtle issues. A typical check function would be Env.find_constructor_by_name. WHen the check fails the function will return Untypeast.lident_of_path path instead of clever prefix-less constructions.

Optionally a name can be provided that will be used as the last ident of the path.

val is_opened : Ocaml_typing.Env.t -> Ocaml_typing.Path.t -> bool