Module OpamFilter

Pretty-print

Folds on the tree of a filter

Maps on all nodes of a filter, bottom-up

Returns all the variables appearing in a filter (including the ones within string interpolations

Type of filter environment.

The type of filter idents with (optionally multiple) qualifying package names and optional string converter. Package name None encodes the self-reference _

Maps on all variables appearing in a filter. The case where package variables are renamed differently and appear in a filter ident of the form %{pkg1+pkg2:var}% is not supported and raises Invalid_argument.

Same limitation as map_variables

Does not handle rewriting the variables to different names (which can't be expressed with a fident anymore), and raises Invalid_argument

Distributes the negations to apply only to atoms

Rewrites string interpolations within a string. default is applied to the fident string (e.g. what's between %{ and }%) when the expansion is undefined. If unspecified, this raises Failure.

With partial, default defaults to the identity, and is otherwise expected to return a fident. In this case, the returned string is supposed to be expanded again (expansion results are escaped, escapes are otherwise kept). This makes the function idempotent

Returns the (beginning, end) offsets and substrings of any unclosed %{ expansions

Computes the value of a filter. May raise Failure if default isn't provided

Like eval but casts the result to a bool. Raises Invalid_argument if not a valid bool and no default supplied.

Same as eval_to_bool, but takes an option as filter and returns always true on None, false when the filter is Undefined. This is the most common behaviour for using "filters" for filtering

Like eval but casts the result to a string

Reduces what can be, keeps the rest unchanged

Wraps a full_variable into a fident accessor

A fident accessor directly referring a variable with the given name

Resolves a filter ident. Like eval, may raise Failure if no default is provided

Like ident_value, but casts the result to a string

Like ident_value, but casts the result to a bool

Rewrites basename.in to basename, expanding interpolations. If the first line begins "opam-version:", assumes that expansion of variables within strings should be properly escaped. In particular, this means that Windows paths should expand correctly when generating .config files.

Processes filters evaluation in a command list: parameter expansion and conditional filtering

Process a simpler command, without filters

Extracts variables appearing in a list of commands

Converts a generic formula to a filter, given a converter for atoms

Resolves the filter in a filtered formula, reducing to a pure formula.

default is the assumed result for undefined filters. If a version filter doesn't resolve to a valid version, the constraint is dropped unless default_version is specified.

May raise, as other filter functions, if default is not provided and filters don't resolve.

Reduces according to what is defined in env, and returns the simplified formula

A more generic formula reduction function, that takes a "partial resolver" as argument

Resolves the build, post, test, doc, dev flags in a filtered formula (which is supposed to have been pre-processed to remove switch and global variables). default determines the behaviour on undefined filters, and the function may raise if it is undefined. If a constraint resolves to an invalid version, it is dropped, or replaced with default_version if specified. If test, doc or dev are unspecified, they are assumed to be filtered out already and encountering them will raise an assert.

The environment used in resolving the dependency filters, as per filter_deps.

Like OpamFormula.simplify_version_formula, but on filtered formulas (filters are kept unchanged, but put in front)