package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

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

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.9.tbz
sha256=de395dd37d246e3ec303e1af35ff8421665fa4f0f0005d95732124b22e3417ac
sha512=74756b28767cdfe10288720540582e818a9d946dd2406606724ebc7b68d1cf6623142e56a1e457f7862839732e7add365aec056930c7ac89be7036c22e5f29ae

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

Module Ocaml_utils.Load_pathSource

Management of include directories.

This module offers a high level interface to locating files in the load path, which is constructed from -I and -H command line flags and a few other parameters.

It makes the assumption that the contents of include directories doesn't change during the execution of the compiler.

Sourceval add_dir : hidden:bool -> string -> unit

Add a directory to the end of the load path (i.e. at lowest priority.)

Sourceval remove_dir : string -> unit

Remove a directory from the load path

Sourceval reset : unit -> unit

Remove all directories

Sourcemodule Dir : sig ... end
Sourcetype auto_include_callback = (Dir.t -> string -> string option) -> string -> string

The type of callback functions on for init ~auto_include

Sourceval no_auto_include : auto_include_callback

No automatic directory inclusion: misses in the load path raise Not_found as normal.

Sourceval init : auto_include:auto_include_callback -> visible:string list -> hidden:string list -> unit

init ~visible ~hidden is the same as reset (); List.iter add_dir (List.rev hidden); List.iter add_dir (List.rev visible)

auto_include_otherlibs alert is a callback function to be passed to Load_path.init and automatically adds -I +lib to the load path after calling alert lib.

Sourceval get_path_list : unit -> string list

Return the list of directories passed to add_dir so far.

Sourcetype paths = {
  1. visible : string list;
  2. hidden : string list;
}
Sourceval get_paths : unit -> paths

Return the directories passed to add_dir so far.

Sourceval find : string -> string

Locate a file in the load path. Raise Not_found if the file cannot be found. This function is optimized for the case where the filename is a basename, i.e. doesn't contain a directory separator.

Sourceval find_normalized : string -> string

Same as find, but search also for normalized unit name (see Misc.normalized_unit_filename), i.e. if name is Foo.ml, allow /path/Foo.ml and /path/foo.ml to match.

Sourcetype visibility =
  1. | Visible
  2. | Hidden
Sourceval find_normalized_with_visibility : string -> string * visibility

Same as find_normalized, but also reports whether the cmi was found in a -I directory (Visible) or a -H directory (Hidden)

Sourceval add : Dir.t -> unit

Old name for append_dir

  • deprecated
Sourceval append_dir : Dir.t -> unit

append_dir d adds d to the end of the load path (i.e. at lowest priority.

Sourceval prepend_dir : Dir.t -> unit

prepend_dir d adds d to the start of the load path (i.e. at highest priority.

Sourceval get_visible : unit -> Dir.t list

Same as get_paths (), except that it returns a Dir.t list, and doesn't include the -H paths.