mirror of
https://github.com/libguestfs/libguestfs.git
synced 2026-03-22 07:03:38 +00:00
99797a3d2f
Introduce a new type of option to allow a value out of a fixed choice, much like Arg.Symbol.
111 lines
4.5 KiB
OCaml
111 lines
4.5 KiB
OCaml
(* Command line handling for OCaml tools in libguestfs.
|
|
* Copyright (C) 2016 Red Hat Inc.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*)
|
|
|
|
type spec =
|
|
| Unit of (unit -> unit)
|
|
(** Simple option with no argument; call the function. *)
|
|
| Set of bool ref
|
|
(** Simple option with no argument; set the reference to true. *)
|
|
| Clear of bool ref
|
|
(** Simple option with no argument; set the reference to false. *)
|
|
| String of string * (string -> unit)
|
|
(** Option requiring an argument; the first element in the tuple
|
|
is the documentation string of the argument, and the second
|
|
is the function to call. *)
|
|
| Set_string of string * string ref
|
|
(** Option requiring an argument; the first element in the tuple
|
|
is the documentation string of the argument, and the second
|
|
is the reference to be set. *)
|
|
| Int of string * (int -> unit)
|
|
(** Option requiring an integer value as argument; the first
|
|
element in the tuple is the documentation string of the
|
|
argument, and the second is the function to call. *)
|
|
| Set_int of string * int ref
|
|
(** Option requiring an integer value as argument; the first
|
|
element in the tuple is the documentation string of the
|
|
argument, and the second is the reference to be set. *)
|
|
| Symbol of string * string list * (string -> unit)
|
|
(** Option requiring an argument among a fixed set; the first
|
|
element in the tuple is the documentation string of the
|
|
argument, the second is the list of allowed strings,
|
|
and the third is the function to call. *)
|
|
|
|
module OptionName : sig
|
|
type option_name =
|
|
| S of char (** short option like -a *)
|
|
| L of string (** long option like --add *)
|
|
| M of string
|
|
(** [M] should only be used in virt-v2v. Handle options like [-os].
|
|
This works exactly like [L] except for changing the output of
|
|
[--help], and that [M] options appear in [--short-options] and
|
|
[--long-options]. *)
|
|
end
|
|
type keys = OptionName.option_name list
|
|
type doc = string
|
|
type usage_msg = string
|
|
type anon_fun = (string -> unit)
|
|
|
|
type speclist = (keys * spec * doc) list
|
|
|
|
val hidden_option_description : string
|
|
|
|
val compare_command_line_args : OptionName.option_name -> OptionName.option_name -> int
|
|
(** Compare command line arguments for equality, ignoring any leading [-]s. *)
|
|
|
|
val string_of_option_name : OptionName.option_name -> string
|
|
(** Convert an {!OptionName.option_name} to a string for [--help] output
|
|
and man pages. For instance [L"foo"] is converted to ["--foo"]. *)
|
|
|
|
type t
|
|
(** The abstract data type. *)
|
|
|
|
val create : speclist -> ?anon_fun:anon_fun -> usage_msg -> t
|
|
(** [Getopt.create speclist ?anon_fun usage_msg] creates a new parses
|
|
for command line arguments.
|
|
|
|
[speclist] is a list of triples [(keys, spec, doc)]: [keys] is a
|
|
list of options, [spec] is the associated action, and [doc] is
|
|
the help text.
|
|
If [doc] is [Getopt.hidden_option_description], then the option
|
|
is considered internal, and it is not shown in the help text.
|
|
|
|
[anon_fun] is an optional function to handle non-option arguments;
|
|
not specifying one means that only options are allowed, and
|
|
non-options will cause an error.
|
|
|
|
[usage_msg] is the string which is printed before the list of
|
|
options as help text.
|
|
*)
|
|
|
|
val parse_argv : t -> string array -> unit
|
|
(** [Getopt.parse handle args] parses the specified arguments.
|
|
|
|
[handle] is the [Getopt.t] type with the configuration of the
|
|
command line arguments.
|
|
|
|
[args] is the array with command line arguments, with the first
|
|
element representing the application name/path.
|
|
|
|
In case of errors, like non-integer value for [Int] or [Set_int],
|
|
an error message is printed, together with a pointer to use
|
|
[--help], and then the program exists with a non-zero exit
|
|
value. *)
|
|
|
|
val parse : t -> unit
|
|
(** Call {!Getopt.parse_argv} on [Sys.argv]. *)
|