package opam-format

  1. Overview
  2. Docs
Format library for opam 2.5

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (33)

Authors

  1. David Allsopp
  2. V
    Vincent Bernardoff <vb@luminar.eu.org>
  3. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  4. K
    Kate Deplaix <kit-ty-kate@outlook.com>
  5. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  6. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  7. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  8. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  9. A
    Anil Madhavapeddy <anil@recoil.org>
  10. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  11. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  12. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.5.0.tar.gz
md5=79d057547b7114e31334bc4f556bc541
sha512=707b652997bae086003c4164029ed40a68e9c465b4ce1731d0f8ccc0a496c5b6d9011e45bc2b6f73e56d316e54bce7c82becb83bd7de4fa53b0795ad7ae7032a

doc/opam-format/OpamTypesBase/index.html

Module OpamTypesBaseSource

Helper functions on the base types (from OpamTypes)

This module contains basic utility functions and stringifiers for the basic OPAM types present in OpamTypes.ml

Sourceval string_of_std_path : OpamTypes.std_path -> string
Sourceval std_path_of_string : string -> OpamTypes.std_path
Sourceval all_std_paths : OpamTypes.std_path list
Sourceval action_equal : ('a -> 'a -> bool) -> 'a OpamTypes.action -> 'a OpamTypes.action -> bool
Sourceval action_contents : [< 'a OpamTypes.action ] -> 'a list

Extract a package from a package action.

Sourceval map_atomic_action : ('a -> 'b) -> 'a OpamTypes.atomic_action -> 'b OpamTypes.atomic_action
Sourceval map_highlevel_action : ('a -> 'b) -> 'a OpamTypes.highlevel_action -> 'b OpamTypes.highlevel_action
Sourceval map_concrete_action : ('a -> 'b) -> 'a OpamTypes.concrete_action -> 'b OpamTypes.concrete_action
Sourceval map_action : ('a -> 'b) -> 'a OpamTypes.action -> 'b OpamTypes.action
Sourceval full_action_contents : 'a OpamTypes.action -> 'a list

Extract a packages from a package action. This returns all concerned packages, including the old version for an up/down-grade.

Sourceval string_of_cause : ('pkg -> string) -> 'pkg OpamTypes.cause -> string

Pretty-prints the cause of an action

Sourceval string_of_shell : OpamTypes.shell -> string

Pretty-print

The empty file position

Sourceval nullify_pos : 'a -> 'a OpamParserTypes.FullPos.with_pos

pos_best pos1 pos2 returns the most detailed position between pos1 and pos2 (defaulting to pos1)

Position in the given file, with unspecified line and column

Sourceval string_of_pos : OpamParserTypes.FullPos.pos -> string

Prints a file position

Sourceval string_of_user_action : OpamTypes.user_action -> string
Sourceval env_array : OpamTypes.env -> string array

Makes sure to keep only the last binding for a given variable; doesn't preserve order

Sourceexception Parse_variable of string * string
Sourceval filter_ident_of_string : string -> OpamTypes.name option list * OpamTypes.variable * (string * string) option

Parses the data suitable for a filter.FIdent from a string. A self-reference _ parses to None.

  • raises Failure

    on bad package names.

Sourceval filter_ident_of_string_interp : ?accept:bool -> string -> OpamTypes.name option list * OpamTypes.variable * (string * string) option

Like filter_ident_of_string but parses also %{?pkg+:var:}% syntax for variables with package name that contains a +.

  • raises {!Parse_variable}

    (pkg,var) if accept is false when several + are encountered in package name, i.e. pkg++:var.

Sourceval string_of_filter_ident : (OpamTypes.name option list * OpamTypes.variable * (string * string) option) -> string
Sourceval pkg_flag_of_string : string -> OpamTypes.package_flag
Sourceval string_of_pkg_flag : OpamTypes.package_flag -> string
Sourceval all_package_flags : OpamTypes.package_flag list
Sourceval map_success : ('a -> 'b) -> ('a, 'fail) OpamTypes.result -> ('b, 'fail) OpamTypes.result

Map on a solver result

Sourceval iter_success : ('a -> unit) -> ('a, 'b) OpamTypes.result -> unit
Sourceval env_update : ?comment:string -> rewrite:'a OpamTypes.separator_path_format option -> string -> 'b OpamTypes.env_update_op_kind -> string -> ('a, 'b) OpamTypes.env_update

Environment update helpers

Sourceval env_update_resolved : ?comment:string -> ?rewrite:OpamTypes.spf_resolved OpamTypes.separator_path_format option -> string -> 'a OpamTypes.env_update_op_kind -> string -> (OpamTypes.spf_resolved, 'a) OpamTypes.env_update
Sourceval env_update_unresolved : ?comment:string -> ?rewrite:OpamTypes.spf_unresolved OpamTypes.separator_path_format option -> string -> 'a OpamTypes.env_update_op_kind -> string -> (OpamTypes.spf_unresolved, 'a) OpamTypes.env_update
Sourceval string_of_path_format : OpamTypes.path_format -> string
Sourceval char_of_separator : OpamTypes.separator -> char
Sourceval switch_selections_compare : OpamTypes.switch_selections -> OpamTypes.switch_selections -> int

Comparators *

Sourceval switch_selections_equal : OpamTypes.switch_selections -> OpamTypes.switch_selections -> bool
Sourceval simple_arg_equal : OpamTypes.simple_arg -> OpamTypes.simple_arg -> bool
Sourceval arg_equal : OpamTypes.arg -> OpamTypes.arg -> bool
Sourceval filter_equal : OpamTypes.filter -> OpamTypes.filter -> bool
Sourceval command_equal : OpamTypes.command -> OpamTypes.command -> bool