module Findlib:The primary findlib interfacesig..end
The Findlib module is the primary interface of the findlib library. It contains functions to look up packages, to interpret META files, and to determine the ancestors of packages.
This module must be initialized before it can be used: Call either
init or init_manually for this.
exception No_such_package of string * string
exception Package_loop of string
val init : ?env_ocamlpath:string ->
?env_ocamlfind_destdir:string ->
?env_ocamlfind_metadir:string ->
?env_ocamlfind_commands:string ->
?env_ocamlfind_ignore_dups_in:string ->
?env_camllib:string ->
?env_ldconf:string -> ?config:string -> ?toolchain:string -> unit -> unitconfig argument.
Furthermore, the environment variables OCAMLPATH, OCAMLFIND_DESTDIR,
OCAMLFIND_COMMANDS, and CAMLLIB are interpreted. By default, the function takes
the values found in the environment, but you can pass different values
using the env_* arguments. By setting these values to empty strings
they are no longer considered.
The result of the initialization is determined as follows:destdir of the
configuration file.metadir of the configuration file, and otherwise
no such directory is used.
The special value "none" turns this feature off.path of the config fileocamlc, ocamlopt, ocamlcp, ocamlmklib and
ocamlmktop are set, their contents specify the executables. Otherwise,
the obvious default values are chosen: "ocamlc" for ocamlc,
"ocamlopt" for ocamlopt, and so on.stdlib, or if unset the built-in locationld.conf file (configuring the dynamic loader) is the value of
the environment variable OCAMLFIND_LDCONF, or if unset or empty, the
value of the configuration variable ldconf, or if unset the
built-in location.val init_manually : ?ocamlc_command:string ->
?ocamlopt_command:string ->
?ocamlcp_command:string ->
?ocamlmklib_command:string ->
?ocamlmktop_command:string ->
?ocamldep_command:string ->
?ocamlbrowser_command:string ->
?ocamldoc_command:string ->
?ignore_dups_in:string ->
?stdlib:string ->
?ldconf:string ->
install_dir:string ->
meta_dir:string -> search_path:string list -> unit -> unitval default_location : unit -> stringval meta_directory : unit -> string"" if no such directory is configured.val search_path : unit -> string listval command : [ `ocamlbrowser
| `ocamlc
| `ocamlcp
| `ocamldep
| `ocamldoc
| `ocamlmklib
| `ocamlmktop
| `ocamlopt ] -> stringval ocaml_stdlib : unit -> stringval ocaml_ldconf : unit -> stringld.confval package_directory : string -> string
Raises No_such_package if the package cannot be found.
val ignore_dups_in : unit -> string optionSome d, duplicate packages below d are ignored, and do not
produce warnings. (Only affects the generation of warnings.)val package_property : string list -> string -> string -> stringpackage_property predlist pkg propname:
Looks up the property propname of package pkg under the assumption
that the predicates in predlist are true.
Raises No_such_package if the package, and Not_found if the property
cannot be found.
EXAMPLES:
package_property [] "p" "requires":
get the value of the requires clause of package ppackage_property [ "mt"; "byte" ] "p" "archive":
get the value of the archive property of package p for multi-
threaded bytecode applications.val package_ancestors : string list -> string -> string listpackage_ancestors predlist pkg:
Determines the direct ancestors of package pkg under the assumption
that the predicates in predlist are true, i.e. the names of the
packages required by pkg.
The returned list is unsorted.
Raises No_such_package if the package pkg or one of its ancestors
could not be found.
val package_deep_ancestors : string list -> string list -> string listpackage_deep_ancestors predlist pkglist:
determines the list of direct or indirect ancestors of the packages
named in pkglist under the assumption that the predicates in predlist
are true.
The returned list is topologically sorted: The first element is the
deepest ancestor; the last element is one of pkglist.
Raises No_such_package if one of the packages in pkglist or one of
the ancestors cannot be found. Raises Package_loop if there is a
cyclic dependency.
val resolve_path : ?base:string -> string -> string +name/path can be used to refer to the subdirectory name
of the standard library directory; the continuation /path is
optional. The notation @name/path can be used to refer to
the directory of the package name; the continuation /path
is optional. For these two notations, absolute paths are returned.
base : When the function is applied on a relative path, the
base path is prepended. Otherwise, the path is returned as
it is.val list_packages : ?tab:int -> ?descr:bool -> Pervasives.out_channel -> unitout_channel.
tab : The tabulator width, by default 20descr : Whether package descriptions are printed. Default: false