package omod
Module OmodSource
Load installed modules in the toplevel.
See the tutorial.
Omod
The type for file paths.
val load :
?batch:bool ->
?silent:silent ->
?force:bool ->
?incs:bool ->
?init:bool ->
?dir:fpath ->
string ->
boolload ~batch ~silent ~force ~deps ~incs ~init ~dir "M" loads module M and returns true if the load was successful; init files may however have failed to load. The exact side effects of this function are described here. The optional parameters are as follows:
batchiftruealternative load sequences error rather than interactively ask to select one. Defaults tonot !Sys.interactive.silentif`Allnothing is logged except errors. If`Loadsthen load sequences are not logged but other diagnostic messages may be logged. If`Noboth load sequences and diagnostic messages are logged. Defaults to`No.forceiftrueforce the reload of objects. Defaults tofalse.incsiftruedirectory includes should be added. Defaults totrue. See load semantics for details.initiftruetoplevel init files should be loaded, see the load semantics. Defaults totrue.diris currently ignored.
The full syntax for specifying the module to load is:
[PKG.]M(@VARIANT)*
Mis always the top level (compilation unit) module name to load.PKGconstrainsMto be found in packagePKG. Packages names are the name of directories just below omod's library directory (seeomod conf, andomod pkgfor a list).@VARIANT(repeatable) indicates that all ambiguities should be resolved according to variantVARIANT. This means that if an object can be found in multiple directories in a package directoryP, the one that is rooted in the hierarchy starting atP/VARIANTorP/@VARIANTwill be selected. If no ambiguity arises the parameter is ignored. See the tutorial for an example.
val loads :
?batch:bool ->
?silent:silent ->
?force:bool ->
?incs:bool ->
?init:bool ->
?dir:fpath ->
string list ->
boolloads is like load but for a list of module specifications. Note that specified variants apply to all of the modules.
help () prints basic help on stdout.
status () prints what is currently loaded by omod (including assumptions)
Assuming loads
This following can be used to assume that certain loads are already performed to prevent them from being (re)loaded by load invocations.
val assume_load :
?batch:bool ->
?silent:silent ->
?force:bool ->
?incs:bool ->
?init:bool ->
?dir:fpath ->
string ->
boolassume_load is like load but assumes the corresponding load sequence was already performed.
val assume_loads :
?batch:bool ->
?silent:silent ->
?force:bool ->
?incs:bool ->
?init:bool ->
?dir:fpath ->
string list ->
boolassume_loads is like loads but assumes the corresponding load sequence was already performed.
Load semantics and effects
- Loading an object means: load its dependencies, add its containing directory to the included directories (if
incsistrue), load the actual object and finally load its toplevel init file (ifinitistrueand the file exists, see below). - The toplevel init file of an object with basename
ois a file calledo_top_init.mlin the same directory as the object. - If an object is available both as a standalone file (
cmo,cmx) and in a library archive (cma,cmxs),Omodfavours loading the library archive. - If an interface dependency cannot be resolved to an implementation but does resolve to a compiled interface, the dependency is assumed to be a mli-only compilation unit and the directory of the compiled interface is added to the includes (if
incsis true). The initialization performed by
omod.topandomod.nattopassume (withincs:falseandinit:false) the following modules:utop.UTopifomod.topis#used inutop.ocaml.Toploopifomod.topis#used (not inutop).ocaml.Opttoploopifomod.nattopis#used. .
- Load sequences with
vmthreadvariants and objects of the formm.p.ext(profiling versions in the stdlib) are excluded from load sequence results. This reduces the load sequence from multiple occurrences to a single candidate on many modules. - For
ocamlnatdependency analysis is made oncmxandcmxafiles, the suffixes of resulting objects is then mapped tocmxs. This assumes the corresponding files exist and their objects match.