package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install

dune-project
 Dependency

Authors

Maintainers

Sources

merlin-5.7.0-504.tbz
sha256=74ccc86a0942219d260c38452b7a4e24162543086d5dc52f8da2e2c529f7eb94
sha512=9c36ed948b7d3502bb390917483004585ae5e715152f685d92caca9eed1b33663079743fe8319ec4133bc8c096fbe374ef6a006a6cb5531fccdbe2677eabf37b

doc/merlin-lib.ocaml_parsing/Ocaml_parsing/Extend_helper/index.html

Module Ocaml_parsing.Extend_helperSource

Sourceval syntax_error : string -> Location.t -> Parsetree.extension

Generate an extension node that will be reported as a syntax error by Merlin.

Sourceval relaxed_location : Location.t -> Parsetree.attribute

Physical locations might be too precise for some features.

For instance in: let x = f in y ^1 ^2

Merlin cannot distinguish position ^1 from ^2 in the normal AST, because IN doesn't appear in abstract syntax. This is a problem when completing, because a different environment should be selected for both positions.

One can add relaxed_location attributes to make some locations closer to the concrete syntax.

Here is the same line annotated with physical and relaxed locations: let x = f in y -- physical locations for f and y nodes -- relaxed locations for f and y nodes

If some code should be ignored by merlin when reporting information to the user, put a hide_node attribute.

This is useful for generated/desugared code which doesn't correspond to anything in concrete syntax (example use-case: encoding of some js_of_ocaml constructs).

Sourceval focus_node : Parsetree.attribute

The converse: when merlin should focus on a specific node of the AST. The main use case is also for js_of_ocaml.

Assuming <code> is translated to:

let module M = struct let prolog = ... (* boilerplate *)

let code = <mapping-of-code>

let epilog = ... (* boilerplate *) end in M.boilerplate

To make merlin focus on M.code and ignore the boilerplate (M.prolog and M.epilog), add a focus_node attribute to the M.code item.

Sourceval classify_extension : Parsetree.extension -> [ `Other | `Syntax_error ]
Sourceval extract_syntax_error : Parsetree.extension -> string * Location.t
Sourceval classify_attribute : Parsetree.attribute -> [ `Other | `Relaxed_location | `Hide | `Focus ]
Sourceval extract_relaxed_location : Parsetree.attribute -> Location.t