To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
Library
Module
Module type
Parameter
Class
Class type
Definitions of many types used throughout
Filenames
type basename = OpamFilename.Base.t
Basenames
type dirname = OpamFilename.Dir.t
Directory names (translated to absolute)
type filename = OpamFilename.t
Filenames
type filename_set = OpamFilename.Set.t
Set of files
type 'a filename_map = 'a OpamFilename.Map.t
Map of files
Predefined installation directories within a switch
Packages
Packages are (name
* version
) tuple
type package_set = OpamPackage.Set.t
Set of packages
type 'a package_map = 'a OpamPackage.Map.t
Map of packages
type name = OpamPackage.Name.t
Package names
type name_set = OpamPackage.Name.Set.t
Set of package names
type 'a name_map = 'a OpamPackage.Name.Map.t
Map of package names
type version = OpamPackage.Version.t
Package versions
type version_set = OpamPackage.Version.Set.t
Set of package versions
type opam_version = OpamVersion.t
OPAM versions
Variables
type variable = OpamVariable.t
Variables
type full_variable = OpamVariable.Full.t
Fully qualified variables (ie. with the name of sections/sub-sections they appear in)
type variable_contents = OpamVariable.variable_contents =
Content of user-defined variables
type variable_map = OpamVariable.variable_contents OpamVariable.Map.t
A map from variables to their contents (i.e an environment)
type package_flag =
| Pkgflag_LightUninstall
(*The package doesn't require downloading to uninstall
*)| Pkgflag_Verbose
(*The package's scripts output is to be displayed to the user
*)| Pkgflag_Plugin
(*The package is an opam plugin that will install a
*)opam-<name>
exec, and may be auto-installed when doingopam <name>
| Pkgflag_Compiler
(*Package may be used for 'opam switch'
*)| Pkgflag_Conf
(*Virtual package: no source, no install or remove instructions, .install, but likely has depexts
*)| Pkgflag_AvoidVersion
(*This version of the package will only be installed if strictly required
*)| Pkgflag_Unknown of string
(*Used for error reporting, otherwise ignored
*)
Opam package flags
module type GenericPackage = sig ... end
At some point we want to abstract so that the same functions can be used over CUDF and OPAM packages
Formulas
type 'a generic_formula = 'a OpamFormula.formula =
| Empty
| Atom of 'a
| Block of 'a generic_formula
| And of 'a generic_formula * 'a generic_formula
| Or of 'a generic_formula * 'a generic_formula
A generic formula
type atom = OpamFormula.atom
Formula atoms
type formula = OpamFormula.t
Formula over versionned packages
type 'a conjunction = 'a OpamFormula.conjunction
AND formulat
type 'a disjunction = 'a OpamFormula.disjunction
OR formulat
Repositories
type repository_name = OpamRepositoryName.t
Repository names
type 'a repository_name_map = 'a OpamRepositoryName.Map.t
Maps of repository names
type url = OpamUrl.t
Repositories
Variable-based filters
type relop = OpamParserTypes.FullPos.relop_kind
type filter =
| FBool of bool
| FString of string
| FIdent of name option list * variable * (string * string) option
(*packages (or None for self-ref through "_"), variable name, string converter (val_if_true, val_if_false_or_undef)
*)| FOp of filter * relop * filter
| FAnd of filter * filter
| FOr of filter * filter
| FNot of filter
| FDefined of filter
| FUndef of filter
(*Returned by reduce functions when the filter could not be resolved to an atom (due to undefined variables or string expansions). The argument contains the partially reduced filter, where strings may still contain expansions (and are otherwise escaped). Used both for partial evaluation, and error messaging. Not allowed as an argument to other filters
*)
Filtered formulas (to express conditional dependencies)
These are first reduced to only the dependency-flag variables build, doc, dev, test defined in Opam formulas
type filtered_formula =
(name * filter filter_or_constraint OpamFormula.formula) OpamFormula.formula
Solver
Used internally when computing sequences of actions
type 'a highlevel_action = [
|
'a atomic_action
|
`Change of [ `Up | `Down ] * 'a * 'a
|
`Reinstall of 'a
]
Used to compact the atomic actions and display to the user in a more meaningful way
Sub-type of highlevel_action
corresponding to an installed package that changed state or version
Used when applying solutions, separates build from install
type actions_result = {
actions_successes : package action list;
actions_errors : (package action * exn) list;
actions_aborted : package action list;
}
Solver result
type solution_result =
| Nothing_to_do
| OK of package action list
(*List of successful actions
*)| Aborted
| Partial_error of actions_result
type 'a request = {
criteria : solver_criteria;
wish_install : 'a conjunction;
wish_remove : 'a conjunction;
wish_upgrade : 'a conjunction;
extra_attributes : string list;
}
Solver request
type universe = {
u_packages : package_set;
u_installed : package_set;
u_available : package_set;
u_depends : filtered_formula package_map;
u_depopts : filtered_formula package_map;
u_conflicts : formula package_map;
u_action : user_action;
u_installed_roots : package_set;
u_pinned : package_set;
u_base : package_set;
u_invariant : formula;
u_reinstall : package_set;
u_attrs : (string * package_set) list;
}
Solver universe
Command line arguments
Pin kind
Shell compatibility modes
Generic command-line definitions with filters
type arg = simple_arg * filter option
Command argument
Switches
type switch = OpamSwitch.t
Compiler switches
type switch_set = OpamSwitch.Set.t
Set of compiler switches
type 'a switch_map = 'a OpamSwitch.Map.t
Map of compile switches
type switch_selections = {
sel_installed : package_set;
sel_roots : package_set;
sel_compiler : package_set;
sel_pinned : package_set;
}
Misc
type lock =
| Read_lock of unit -> unit
(*The function does not modify anything, but it needs the state not to change while it is running.
*)| Global_lock of unit -> unit
(*Take the global lock, all subsequent calls to OPAM are blocked.
*)| Switch_lock of unit -> switch * unit -> unit
(*Take a global read lock and a switch lock. The first function is called with the read lock, then the second function is called with the returned switch write-locked.
*)| Global_with_switch_cont_lock of unit -> switch * (unit -> unit)
(*Call the function in a global lock, then relax to a switch lock and call the function it returned
*)
The different kinds of locks
type file_attribute = OpamFilename.Attribute.t
A line in urls.tx
type file_attribute_set = OpamFilename.Attribute.Set.t
All the lines in urls.txt
Optional contents
Upgrade statistics
Environement variables: var name, value, optional comment
type env_update =
string * OpamParserTypes.FullPos.env_update_op_kind * string * string option
Environment updates
var, update_op, value, comment
type tags = OpamStd.String.Set.t OpamStd.String.SetMap.t
Tags
Repository and global states
type json = OpamJson.t
JSON
type sys_package = OpamSysPkg.t
type sys_pkg_status = OpamSysPkg.status