package opam-format

You can search for identifiers within the package.

in-package search v0.2.0

opam-format
- Library opam-format
  - OpamFile
    
    IO_FILE
    
    Lines
    
    Wrappers
    
    Config
    
    InitConfig
    
    Descr
    
    URL
    
    OPAM
    
    Aliases
    
    LegacyState
    
    SwitchSelections
    
    SwitchExport
    
    PkgList
    
    Environment
    
    Comp
    
    Dot_install
    
    Changes
    
    Dot_config
    
    Package_index
    
    Repo_config_legacy
    
    Repos_config
    
    Switch_config
    
    Pinned_legacy
    
    Repo
    
    File_attributes
    
    Stats
    
    Syntax
  - OpamFilter
  - OpamFormat
    
    V
    
    I
  - OpamFormatConfig
  - OpamFormula
  - OpamLineLexer
  - OpamPackage
    
    Version
    
    Set
    
    Op
    
    Map
    
    Name
    
    Set
    
    Op
    
    Map
    
    Set
    
    Op
    
    Map
    
    Graph
    
    V
    
    E
    
    Topological
    
    Parallel
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    Dot
  - OpamPath
    
    Switch
    
    Default
    
    Overlay
    
    Builddir
  - OpamPp
    
    Op
    
    STR
  - OpamRepositoryName
    
    Set
    
    Op
    
    Map
  - OpamSwitch
    
    Set
    
    Op
    
    Map
  - OpamTypes
    
    GenericPackage
  - OpamTypesBase
    
    String
    
    Char
    
    Printexc
    
    Unix
    
    Uchar
    
    Buffer
    
    Filename
  - OpamVariable
    
    Set
    
    Op
    
    Map
    
    Full
    
    Set
    
    Op
    
    Map
- Sources
  - opam-format
    
    opamFile.ml
    
    opamFilter.ml
    
    opamFormat.ml
    
    opamFormatConfig.ml
    
    opamFormula.ml
    
    opamLineLexer.ml
    
    opamPackage.ml
    
    opamPath.ml
    
    opamPp.ml
    
    opamRepositoryName.ml
    
    opamSwitch.ml
    
    opamTypesBase.ml
    
    opamVariable.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `OpamFormat.V`Source

These base converters raise Unexpected when not run on the right input (which is then converted to Bad_format by the parser.

Sourceval bool : (OpamTypes.value, bool) OpamPp.t

Sourceval int : (OpamTypes.value, int) OpamPp.t

Sourceval pos_int : (OpamTypes.value, int) OpamPp.t

positive or null integer

Sourceval ident : (OpamTypes.value, string) OpamPp.t

Sourceval string : (OpamTypes.value, string) OpamPp.t

Sourceval string_tr : (OpamTypes.value, string) OpamPp.t

Trimmed string

Sourceval simple_arg : (OpamTypes.value, OpamTypes.simple_arg) OpamPp.t

Command arguments, i.e. strings or idents

Sourceval variable_contents : (OpamTypes.value, OpamTypes.variable_contents) OpamPp.t

Strings or bools

Sourceval list : (OpamTypes.value, OpamTypes.value list) OpamPp.t

"a b c"; also allows just "a" to be parsed as a singleton list

Sourceval group : (OpamTypes.value, OpamTypes.value list) OpamPp.t

"(a b c)"

Sourceval option : (OpamTypes.value, OpamTypes.value * OpamTypes.value list) OpamPp.t

Options in the value type sense, i.e. a value with an optional list of parameters in braces: "value op1 op2"

Source

val map_group : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value, 'a list) OpamPp.t

Source

val map_list : 
  ?depth:int ->
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value, 'a list) OpamPp.t

An expected list depth may be specified to enable removal of extra brackets (never use ~depth for an inner list)

Sourceval list_depth : int -> (OpamTypes.value, OpamTypes.value) OpamPp.t

Normalises to the given list depth when parsing, and removes brackets that can be made implicit when printing

Source

val map_option : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value list, 'b) OpamPp.t ->
  (OpamTypes.value, 'a * 'b) OpamPp.t

Maps on the two terms of an option constructor.

Source

val map_options_2 : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value list, 'b) OpamPp.t ->
  (OpamTypes.value list, 'c) OpamPp.t ->
  (OpamTypes.value, 'a * 'b * 'c) OpamPp.t

Maps over two options (e.g. v {op1} {op2})

Source

val map_options_3 : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value list, 'b) OpamPp.t ->
  (OpamTypes.value list, 'c) OpamPp.t ->
  (OpamTypes.value list, 'd) OpamPp.t ->
  (OpamTypes.value, 'a * 'b * 'c * 'd) OpamPp.t

Maps over three options (e.g. v {op1} {op2} {op3})

Source

val map_pair : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value, 'b) OpamPp.t ->
  (OpamTypes.value, 'a * 'b) OpamPp.t

A pair is simply a list with two elements in the value type

Source

val map_triple : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value, 'b) OpamPp.t ->
  (OpamTypes.value, 'c) OpamPp.t ->
  (OpamTypes.value, 'a * 'b * 'c) OpamPp.t

A triple is simply a list with three elements in the value type

Sourceval url : (OpamTypes.value, OpamTypes.url) OpamPp.t

Source

val url_with_backend : 
  OpamUrl.backend ->
  (OpamTypes.value, OpamTypes.url) OpamPp.t

Specialised url parser when the backend is already known

Sourceval compiler_version : (OpamTypes.value, string) OpamPp.t

Source

val filter_ident : 
  (OpamTypes.value,
    OpamTypes.name option list * OpamTypes.variable * (string * string) option)
    OpamPp.t

Sourceval filter : (OpamTypes.value list, OpamTypes.filter) OpamPp.t

Source

val arg : 
  (OpamTypes.value, OpamTypes.simple_arg * OpamTypes.filter option) OpamPp.t

Arguments in commands (term + optional filter)

Source

val command : 
  (OpamTypes.value,
    (OpamTypes.simple_arg * OpamTypes.filter option) list
    * OpamTypes.filter option)
    OpamPp.t

Source

val constraints : 
  (OpamTypes.value, 'a) OpamPp.t ->
  (OpamTypes.value list, (OpamFormula.relop * 'a) OpamFormula.formula) OpamPp.t

Simple dependency constraints

Source

val filtered_constraints : 
  (OpamTypes.value, 'version) OpamPp.t ->
  (OpamTypes.value list,
    'version OpamTypes.filter_or_constraint OpamFormula.formula)
    OpamPp.t

Dependency constraints mixed with filters

Sourceval version : (OpamTypes.value, OpamTypes.version) OpamPp.t

Package versions

Sourceval ext_version : (OpamTypes.value, OpamTypes.filter) OpamPp.t

Package versions as filters, as they may appear in dependency (may be an expanded string or an ident)

Sourceval pkgname : (OpamTypes.value, OpamTypes.name) OpamPp.t

A package name, encoded as a string, but with restrictions

Source

val package_atom : 
  (OpamTypes.value list, 'a) OpamPp.t ->
  (OpamTypes.value, OpamTypes.name * 'a) OpamPp.t

Returns an atom parser ("package" {>= "version"}) from a constraint and a version parser

Source

val package_formula : 
  [< `Conj | `Disj ] ->
  (OpamTypes.value list, 'a) OpamPp.t ->
  (OpamTypes.value, (OpamTypes.name * 'a) OpamFormula.formula) OpamPp.t

Takes a parser for constraints. Lists without operator will be understood as conjunctions or disjunctions depending on the first argument.

Source

val package_formula_items : 
  [< `Conj | `Disj ] ->
  (OpamTypes.value list, 'a) OpamPp.t ->
  (OpamTypes.value list, (OpamTypes.name * 'a) OpamFormula.formula) OpamPp.t

Like package_formula, but takes the list items directly

Sourceval env_binding : (OpamTypes.value, OpamTypes.env_update) OpamPp.t

Environment variable updates syntax

Source

val os_constraint : 
  (OpamTypes.value, (bool * string) OpamFormula.formula) OpamPp.t

package opam-format

Module OpamFormat.VSource

Module `OpamFormat.V`Source