opam-client 2.0~alpha5 · OCaml Package

Functions handling the "opam list" subcommand

type dependency_toggles = {

recursive : bool;
depopts : bool;
build : bool;
test : bool;
doc : bool;
dev : bool;

}

Switches to determine what to include when querying (reverse) dependencies

val default_dependency_toggles : dependency_toggles

type pattern_selector = {

case_sensitive : bool;
exact : bool;
glob : bool;
fields : string list;
ext_fields : bool;
(*
Match on raw strings in x-foo fields
*)

}

val default_pattern_selector : pattern_selector

type selector =

| Any
| Installed
| Root
| Compiler
| Available
| Installable
| Pinned
| Depends_on of dependency_toggles * OpamTypes.atom list
| Required_by of dependency_toggles * OpamTypes.atom list
| Solution of dependency_toggles * OpamTypes.atom list
| Pattern of pattern_selector * string
| Atoms of OpamTypes.atom list
| Flag of OpamTypes.package_flag
| Tag of string
| From_repository of OpamTypes.repository_name list

Package selectors used to filter the set of packages

val filter : 
  base:OpamTypes.package_set ->
  'a OpamStateTypes.switch_state ->
  selector OpamFormula.formula ->
  OpamTypes.package_set

Applies a formula of selectors to filter the package from a given switch state

val print_depexts : 
  'a OpamStateTypes.switch_state ->
  OpamTypes.package_set ->
  string list ->
  unit

Lists the external dependencies matching the given flags for the given set of packages

type output_format =

| Name
(*
Name without version
*)
| Version
(*
Version of the currently looked-at package
*)
| Package
(*
name.version
*)
| Synopsis
(*
One-line package description
*)
| Synopsis_or_target
(*
Pinning target if pinned, synopsis otherwise
*)
| Description
(*
The package description, excluding synopsis
*)
| Field of string
(*
The value of the given opam-file field
*)
| Installed_version
(*
Installed version or "--" if none
*)
| Pinning_target
(*
Empty string if not pinned
*)
| Raw
(*
The full contents of the opam file (reformatted)
*)
| All_installed_versions
(*
List of the installed versions in all switches with the corresponding switches in brackets
*)
| Available_versions
(*
List of the available versions (currently installed one in bold if color enabled)
*)
| All_versions
(*
List of the existing package versions (installed, installed in current switch and unavailable colored specifically if color enabled)
*)
| Repository
(*
The repository the package was found in (may be empty for pinned packages)
*)
| Installed_files
(*
The list of files that the installed package added to the system
*)

Element of package information to be printed

val default_list_format : output_format list

val get_switch_state : 
  'a OpamStateTypes.global_state ->
  OpamStateTypes.unlocked OpamStateTypes.switch_state

Gets either the current switch state, if a switch is selected, or a virtual state corresponding to the configured repos

val field_names : (output_format * string) list

For documentation, includes a dummy '<field>:' for the Field format

val string_of_field : output_format -> string

val field_of_string : string -> output_format

val display : 
  'a OpamStateTypes.switch_state ->
  header:bool ->
  format:output_format list ->
  dependency_order:bool ->
  all_versions:bool ->
  ?wrap:[ `Wrap of string | `Truncate | `None ] ->
  ?separator:string ->
  ?prettify:bool ->
  ?normalise:bool ->
  ?order:(OpamTypes.package -> OpamTypes.package -> int) ->
  OpamTypes.package_set ->
  unit

Outputs a list of packages as a table according to the formatting options. normalise supersedes prettify and uses a canonical way of displaying package definition file fields. prettify uses a nicer to read format for the package definition file fields.

val list : 
  'a OpamStateTypes.global_state ->
  print_short:bool ->
  filter:[ `all | `installed | `roots | `installable ] ->
  order:[ `normal | `depends ] ->
  exact_name:bool ->
  case_sensitive:bool ->
  ?depends:OpamTypes.atom list ->
  ?reverse_depends:bool ->
  ?recursive_depends:bool ->
  ?resolve_depends:bool ->
  ?depopts:bool ->
  ?depexts:string list ->
  ?dev:bool ->
  string list ->
  unit

Display all available packages that match any of the regexps.

val info : 
  'a OpamStateTypes.global_state ->
  fields:string list ->
  raw_opam:bool ->
  where:bool ->
  ?normalise:bool ->
  ?show_empty:bool ->
  OpamTypes.atom list ->
  unit

Display a general summary of a collection of packages.

val mini_field_printer : 
  ?prettify:bool ->
  ?normalise:bool ->
  OpamTypes.value ->
  string

Prints the value of an opam field in a shortened way (with prettify -- the default -- puts lists of strings in a format that is easier to read

val string_of_formula : selector OpamFormula.formula -> string

package opam-client