module Fl_package_base:sig
..end
type
package = {
|
package_name : |
(* | The fully qualified package name, i.e. for subpackages the names of the containing packages are prepended and the name components are separated by '.' | *) |
|
package_dir : |
(* | The directory where to lookup package files | *) |
|
package_defs : |
(* | The definitions in the META file | *) |
|
package_priv : |
(* | Private part of the definition | *) |
type
package_priv
val init : string list -> string -> string option -> unit
Fl_package_base
can be used.
The first string corresponds to the OCAMLPATH
setting, the second
string is the location of the standard library.
This function is called by Findlib.init
and Findlib.init_manually
,
so it is already sufficient to initialize the Findlib
module.
exception No_such_package of string * string
Findlib
.exception Package_loop of string
Findlib
.val query : string -> package
package
definition for the fully-qualified package name,
or raises No_such_package
. It is allowed to query for subpackages.
This function loads package definitions into the graph kept in memory.
val requires : preds:string list -> string -> string list
preds
hold. The function returns the names of the required packages.
It is checked whether these packages exist.
If there is the "mt" predicate, missing dependencies on "threads" are silently added.
The function may raise No_such_package
or Package_loop
.
This function loads package definitions into the graph kept in memory.
val requires_deeply : preds:string list -> string list -> string list
preds
hold. The function returns the names of the required packages.
It is checked whether these packages exist.
If there is the "mt" predicate, missing dependencies on "threads" are silently added.
The function may raise No_such_package
or Package_loop
.
This function loads package definitions into the graph kept in memory.
val package_conflict_report : ?identify_dir:(string -> 'a) -> unit -> unit
Only packages in the loaded part of the package graph are checked (i.e. packages for which there was a query).
It is recommended to pass the ~identify_dir function whose task it is to return a unique value for every existing directory. For example,
fun d ->
let s = Unix.stat d in
(s.Unix.st_dev, s.Unix.st_ino)
could be an implementation for this function. The default is
the identity (and not this nice implementation to avoid dependencies
on the Unix module).val module_conflict_report : ?identify_dir:(string -> 'a) -> string list -> unit
identify_dir
: See package_conflict_report
.val load_base : unit -> unit
val list_packages : unit -> string list
load_base
), and returns the (unsorted) list of all
packages.val package_users : preds:string list -> string list -> string list
load_base
), and determines the packages using one of
the packages passed as second argument. The preds
are assumed
for the evaluation of the requires
directives.
The returned list is sorted in ascending order.
If there is the "mt" predicate, missing dependencies on "threads" are silently added.
Raises No_such_package
if one of the passed packages cannot
be found.
val packages_in_meta_file : ?directory_required:bool ->
name:string ->
dir:string -> meta_file:string -> unit -> package list
meta_file
. In name
, the
name of the main package must be passed. dir
is the
directory associated with the package by default (i.e. before
it is overriden by the "directory" directive).
Returns the package records found in this file. The "directory" directive is already applied.
directory_required
: If true, it is checked whether there is a
"directory" directive in the main package. If this directive is missing,
the function will fail.val package_definitions : search_path:string list -> string -> string list
search_path
. The package name must be
fully-qualified. For simplicity, however, only the name of the main
package is taken into account (so it is a good idea to call this
function only for main packages).