package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

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

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.8.1-505.tbz
sha256=b8fb32bc0fc092af2fd6bdc831cb966057f2e3fd7b99a172b705e96ba8082583
sha512=01ca96f8167d062ba24036e43f650ff958fb157d44867bd52eb7999b7d19bf9fc97cdcd46c04b6979f0e1149d5041047723eed5913b03c4404d7acb116183bee

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 : print_filename:string Format_doc.printer -> error Format_doc.format_printer
Sourceval report_error_doc : print_filename:string Format_doc.printer -> error Format_doc.printer