Module Arg_complete

Specification

Command line argument specifications are extended with completion functions.

type complete = string -> string list

Type for function providing single-argument completions.

type complete_all = string list -> string list

Type for function providing multiple-argument completions (only in Rest_all).

type spec =
  1. | Unit of unit -> unit
    (*

    Call the function with unit argument

    *)
  2. | Bool of bool -> unit
    (*

    Call the function with a bool argument

    *)
  3. | Set of bool Stdlib.ref
    (*

    Set the reference to true

    *)
  4. | Clear of bool Stdlib.ref
    (*

    Set the reference to false

    *)
  5. | String of string -> unit * complete
    (*

    Call the function with a string argument

    *)
  6. | Set_string of string Stdlib.ref * complete
    (*

    Set the reference to the string argument

    *)
  7. | Int of int -> unit * complete
    (*

    Call the function with an int argument

    *)
  8. | Set_int of int Stdlib.ref * complete
    (*

    Set the reference to the int argument

    *)
  9. | Float of float -> unit * complete
    (*

    Call the function with a float argument

    *)
  10. | Set_float of float Stdlib.ref * complete
    (*

    Set the reference to the float argument

    *)
  11. | Tuple of spec list
    (*

    Take several arguments according to the spec list

    *)
  12. | Symbol of string list * string -> unit
    (*

    Take one of the symbols as argument and call the function with the symbol

    *)
  13. | Rest of string -> unit * complete
    (*

    Stop interpreting keywords and call the function with each remaining argument

    *)
  14. | Rest_all of string list -> unit * complete_all
    (*

    Stop interpreting keywords and call the function with all remaining arguments

    • since OCaml 4.12
    *)
  15. | Expand of string -> string array
    (*

    If the remaining arguments to process are of the form ["-foo"; "arg"] @ rest where "foo" is registered as Expand f, then the arguments f "arg" @ rest are processed. Only allowed in Stdlib.Arg.parse_and_expand_argv_dynamic.

    • since OCaml 4.05
    *)

Command line argument specification like Stdlib.Arg.spec, but extended with completion functions.

module Rest_all_compat : sig ... end

Compatibility for Rest_all before OCaml 4.12

type speclist = (Stdlib.Arg.key * spec * Stdlib.Arg.doc) list
type arg_speclist = (Stdlib.Arg.key * Stdlib.Arg.spec * Stdlib.Arg.doc) list

Parsing

The library does not provide parsing of command line arguments itself. Instead, the following functions can be used to strip completion functions from specifications, such that parsing functions from Stdlib.Arg can be used.

val arg_spec : spec -> Stdlib.Arg.spec

Strip completion functions from spec.

val arg_speclist : speclist -> arg_speclist

Strip completion functions from speclist.

Completing

type anon_complete = complete
val complete_argv : ?prefer_getopt_long:bool -> string list -> speclist -> anon_complete -> string list

complete_argv args speclist anon_complete provides the completions for the partial arguments args using speclist for options and anon_complete for anonymous arguments.

  • parameter prefer_getopt_long

    Complete = for options with argument (false by default). GNU getopt_long format keyword=arg is supported regardless.

Convenience

val empty : complete

Completion function with constant empty result.

val empty_all : complete_all

Completion function with constant empty result for Rest_all.

val strings : string list -> complete

Completion function for a list of possible strings.

module Util : sig ... end