package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (12)

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.6-504.tbz
sha256=82d648a4180d6d5aa3a083218e28bf197f4e9f147884de9302bb6811ad98b77f
sha512=e21c96db754a289462677e6985181902ddd90bab9e9cebbbb739d92d94b5aee7ef7a134da70ae384291d9bfaccfecd26d37b48f8d75c5d36b9eda18f6e5afd3d

doc/merlin-lib.ocaml_utils/Ocaml_utils/Linkdeps/index.html

Module Ocaml_utils.LinkdepsSource

Sourcetype t

The state of the linking check. It keeps track of compilation units provided and required so far.

Sourcetype compunit = string
Sourcetype filename = string
Sourceval create : complete:bool -> t

create ~complete returns an empty state. If complete is true, missing compilation units will be treated as errors.

Sourceval add : t -> filename:filename -> compunit:compunit -> provides:compunit list -> requires:compunit list -> unit

add t ~filename ~compunit ~provides ~requires registers the compilation unit compunit found in filename to t.

  • provides are units and sub-units provided by compunit
  • requires are units required by compunit

add should be called in reverse topological order.

Sourceval required : t -> compunit -> bool

required t compunit returns true if compunit is a dependency of previously added compilation units.

Sourcetype compunit_and_source = {
  1. compunit : compunit;
  2. filename : filename;
}
Sourcetype error =
  1. | Missing_implementations of (compunit * compunit_and_source list) list
  2. | Multiple_definitions of (compunit * filename list) list
Sourceval check : t -> error option

check t should be called once all the compilation units to be linked have been added. It returns some error if:

  • There are some missing implementations and complete is true
  • Some implementation appear before their dependencies
Sourceval report_error_doc : print_filename:string Merlin_utils.Format_doc.printer -> error Merlin_utils.Format_doc.printer