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-4.14-500.tbz
sha256=ec23f324f875520cd8897f303cc6d4e595f3d7000914d410729f16b86ad1d70e
sha512=8db22100cc0af65b08f456a2a7af84e75396f5869ee7552f1f5888a1c0279d1d85e6eecb3a677ae6f0973a99823cddba0563843ce216197255667342ef161885

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 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 : 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 -> string list -> unit

init l is the same as reset (); List.iter add_dir (List.rev l)

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_paths : unit -> string list

Return the list of 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_uncap : string -> string

Same as find, but search also for uncapitalized name, i.e. if name is Foo.ml, allow /path/Foo.ml and /path/foo.ml to match.

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 : unit -> Dir.t list

Same as get_paths (), except that it returns a Dir.t list.