package merlin-lib

  1. Overview
  2. Docs
package merlin-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type
type buffer = {
  1. path : string;
    (*

    Path of the buffer in the editor. The path is absolute if it is backed by a file, although it might not yet have been saved in the editor. The path is relative if it is a temporary buffer.

    *)
  2. flags : string list;
    (*

    Any flag that has been passed to the reader in .merlin file

    *)
  3. text : string;
    (*

    Content of the buffer

    *)
}

Description of a buffer managed by Merlin

type parsetree =
  1. | Structure of Ocaml_parsing.Parsetree.structure
    (*

    An implementation, usually coming from a .ml file

    *)
  2. | Signature of Ocaml_parsing.Parsetree.signature
    (*

    An interface, usually coming from a .mli file

    *)

ASTs exchanged with Merlin

Printing in error messages or completion items

type pretty_parsetree =
  1. | Pretty_toplevel_phrase of Ocaml_parsing.Parsetree.toplevel_phrase
  2. | Pretty_expression of Ocaml_parsing.Parsetree.expression
  3. | Pretty_core_type of Ocaml_parsing.Parsetree.core_type
  4. | Pretty_pattern of Ocaml_parsing.Parsetree.pattern
  5. | Pretty_signature of Ocaml_parsing.Parsetree.signature
  6. | Pretty_structure of Ocaml_parsing.Parsetree.structure
  7. | Pretty_case_list of Ocaml_parsing.Parsetree.case list

Printing in case destruction

type complete_info = {
  1. complete_labels : bool;
    (*

    True if it is appropriate to suggest labels for this completion.

    *)
}

Additional information useful for guiding completion

module type V0 = sig ... end
type request =
  1. | Req_load of buffer
  2. | Req_parse
  3. | Req_parse_line of Lexing.position * string
  4. | Req_parse_for_completion of Lexing.position
  5. | Req_get_ident_at of Lexing.position
  6. | Req_print_outcome of outcometree list
  7. | Req_pretty_print of pretty_parsetree
type response =
  1. | Res_loaded
  2. | Res_parse of parsetree
  3. | Res_parse_for_completion of complete_info * parsetree
  4. | Res_get_ident_at of string Ocaml_parsing.Location.loc list
  5. | Res_print_outcome of string list
  6. | Res_pretty_print of string