package merlin-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Docstrings
Set functions
Items
Fields and constructors
Unattached comments
Extra text

package merlin-lib

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
  - Blocking
    
    Commands
  - Directive
    
    Processed
    
    Raw
  - Make
    
    Chan
    
    Commands
    
    IO
    
    O
  - S
    
    Commands
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
    
    Digest
  - Mtyper
  - Phase_cache
    
    S
    
    Fingerprint
    
    With_cache
    
    Phase
    
    Fingerprint
  - 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
    
    System
  - Logger
  - Marg
  - Misc
    
    Color
    
    Int_literal_converter
    
    LongString
    
    String
    
    Map
    
    Set
    
    Tbl
  - Ppxsetup
  - Sexp
  - Stamped_hashtable
  - Std
    
    Char
    
    Format
    
    Glob
    
    Hashtbl
    
    Json
    
    Lexing
    
    List
    
    Lazy
    
    Option
    
    Infix
    
    Result
    
    Shell
    
    String
    
    Map
    
    Set
    
    System

Legend:
Library
Module
Module type
Parameter
Class
Class type

Documentation comments

Warning: this module is unstable and part of compiler-libs.

val init : unit -> unit

(Re)Initialise all docstring state

val warn_bad_docstrings : unit -> unit

Emit warnings for unattached and ambiguous docstrings

Docstrings

type docstring

Documentation comments

val docstring : string -> Location.t -> docstring

Create a docstring

val register : docstring -> unit

val docstring_body : docstring -> string

Get the text of a docstring

val docstring_loc : docstring -> Location.t

Get the location of a docstring

Set functions

These functions are used by the lexer to associate docstrings to the locations of tokens.

val set_pre_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately preceding a token

val set_post_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately following a token

val set_floating_docstrings : Lexing.position -> docstring list -> unit

Docstrings not immediately adjacent to a token

val set_pre_extra_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately following the token which precedes this one

val set_post_extra_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately preceding the token which follows this one

Items

The docs type represents documentation attached to an item.

type docs = {

docs_pre : docstring option;
docs_post : docstring option;

}

val empty_docs : docs

val docs_attr : docstring -> Parsetree.attribute

val add_docs_attrs : docs -> Parsetree.attributes -> Parsetree.attributes

Convert item documentation to attributes and add them to an attribute list

val symbol_docs : unit -> docs

Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).

val symbol_docs_lazy : unit -> docs Lazy.t

val rhs_docs : int -> int -> docs

Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).

val rhs_docs_lazy : int -> int -> docs Lazy.t

val mark_symbol_docs : unit -> unit

Mark the item documentation for the current symbol (for ambiguity warnings).

val mark_rhs_docs : int -> int -> unit

Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)

Fields and constructors

The info type represents documentation attached to a field or constructor.

type info = docstring option

val empty_info : info

val info_attr : docstring -> Parsetree.attribute

val add_info_attrs : info -> Parsetree.attributes -> Parsetree.attributes

Convert field info to attributes and add them to an attribute list

val symbol_info : unit -> info

Fetch the field info for the current symbol.

val rhs_info : int -> info

Fetch the field info following the symbol at a given position.

Unattached comments

The text type represents documentation which is not attached to anything.

type text = docstring list

val empty_text : text

val empty_text_lazy : text Lazy.t

val text_attr : docstring -> Parsetree.attribute

val add_text_attrs : text -> Parsetree.attributes -> Parsetree.attributes

Convert text to attributes and add them to an attribute list

val symbol_text : unit -> text

Fetch the text preceding the current symbol.

val symbol_text_lazy : unit -> text Lazy.t

val rhs_text : int -> text

Fetch the text preceding the symbol at the given position.

val rhs_text_lazy : int -> text Lazy.t

Extra text

There may be additional text attached to the delimiters of a block (e.g. struct and end). This is fetched by the following functions, which are applied to the contents of the block rather than the delimiters.

val symbol_pre_extra_text : unit -> text

Fetch additional text preceding the current symbol

val symbol_post_extra_text : unit -> text

Fetch additional text following the current symbol

val rhs_pre_extra_text : int -> text

Fetch additional text preceding the symbol at the given position

val rhs_post_extra_text : int -> text

Fetch additional text following the symbol at the given position

val rhs_post_text : int -> text

Fetch text following the symbol at the given position

module WithMenhir : sig ... end