package opam-format
Install
Dune Dependency
Authors
-
VVincent Bernardoff <vb@luminar.eu.org>
-
RRaja Boujbel <raja.boujbel@ocamlpro.com>
-
RRoberto Di Cosmo <roberto@dicosmo.org>
-
TThomas Gazagnaire <thomas@gazagnaire.org>
-
LLouis Gesbert <louis.gesbert@ocamlpro.com>
-
FFabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
-
AAnil Madhavapeddy <anil@recoil.org>
-
GGuillem Rieu <guillem.rieu@ocamlpro.com>
-
RRalf Treinen <ralf.treinen@pps.jussieu.fr>
-
FFrederic Tuong <tuong@users.gforge.inria.fr>
Maintainers
Sources
md5=58f9fe5045c00c2a022a5b65d36be868
sha512=4395defe7df1d03ca889718b8eafd8161ff009710475f62673f19f012e0bde8ad2a919bd9d02d7f96b4c5a9bbf38e0ba9a256531c24de15cafabd4ef11f7c8e8
doc/opam-format/OpamFilter/index.html
Module OpamFilter
Source
Formulas on variables, as used in opam files build scripts
Filters are a small language of formulas over strings and booleans used for conditions and text replacements. It has relational operators over strings (using version-number comparison), And, Or and Not boolean operations, dynamic casting (using strings "true" and "false"), and string interpolation. Variables are resolved using a user function returning an option, undefined values are propagated.
String interpolation uses the syntax %{identifier}%
Identifiers have the form
[package:]var[?str_if_true:str_if_false_or_undef]
The last optional part specifies a conversion from boolean to static strings.
The syntax pkg1+pkg2+pkgn:var
is allowed as a shortcut to pkg1:var & pkg2:var & pkgn:var
.
The special variable pkg:enable
is allowed as a shortcut for pkg:installed?enable:disable
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 _
val map_variables :
(OpamTypes.full_variable -> OpamTypes.full_variable) ->
OpamTypes.filter ->
OpamTypes.filter
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
.
val map_variables_in_string :
(OpamTypes.full_variable -> OpamTypes.full_variable) ->
string ->
string
Same limitation as map_variables
val map_variables_in_fident :
(OpamTypes.full_variable -> OpamTypes.full_variable) ->
fident ->
fident
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
val eval :
?default:OpamTypes.variable_contents ->
env ->
OpamTypes.filter ->
OpamTypes.variable_contents
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
val ident_value :
?default:OpamTypes.variable_contents ->
env ->
fident ->
OpamTypes.variable_contents
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
val filter_formula :
?default_version:OpamTypes.version ->
?default:bool ->
env ->
OpamTypes.filtered_formula ->
OpamTypes.formula
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
val gen_filter_formula :
('a -> [< `True | `False | `Formula of 'b OpamTypes.generic_formula ]) ->
('c * 'a) OpamFormula.formula ->
('c * 'b OpamTypes.generic_formula) OpamFormula.formula
A more generic formula reduction function, that takes a "partial resolver" as argument
val variables_of_filtered_formula :
OpamTypes.filtered_formula ->
OpamTypes.full_variable list
val filter_deps :
build:bool ->
post:bool ->
?test:bool ->
?doc:bool ->
?dev:bool ->
?default_version:OpamTypes.version ->
?default:bool ->
OpamTypes.filtered_formula ->
OpamTypes.formula
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
.
val simplify_extended_version_formula :
OpamTypes.filter OpamTypes.filter_or_constraint OpamFormula.formula ->
OpamTypes.filter OpamTypes.filter_or_constraint OpamFormula.formula option
Like OpamFormula.simplify_version_formula
, but on filtered formulas (filters are kept unchanged, but put in front)
val atomise_extended :
OpamTypes.filtered_formula ->
(OpamPackage.Name.t
* (OpamTypes.filter * (OpamTypes.relop * OpamTypes.filter) option))
OpamFormula.formula
val sort_filtered_formula :
((OpamTypes.name
* OpamTypes.filter OpamTypes.filter_or_constraint OpamFormula.formula) ->
(OpamTypes.name
* OpamTypes.filter OpamTypes.filter_or_constraint OpamFormula.formula) ->
int) ->
OpamTypes.filtered_formula ->
OpamTypes.filtered_formula