blob: b7fb1a46432f50d764939364d059c5ab5fd628e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
(***********************************************************************)
(* *)
(* Caml Special Light *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1995 Institut National de Recherche en Informatique et *)
(* Automatique. Distributed only by permission. *)
(* *)
(***********************************************************************)
(* $Id$ *)
(* Module [Arg]: parsing of command line arguments *)
(* This module provides a general mechanism for extracting options and
arguments from the command line to the program. *)
(* Syntax of command lines:
A keyword is a character string starting with a [-].
An option is a keyword alone or followed by an argument.
There are six types of keywords: [Unit], [String], [Int], and [Float].
[Unit], [Set_flag] and [Clear_flag] keywords do not take an argument.
[String], [Int], and [Float] keywords take the following word on the
command line as an argument.
Arguments not preceded by a keyword are called anonymous arguments. *)
(* Examples ([cmd] is assumed to be the command name):
- [cmd -flag ](a unit option)
- [cmd -int 1 ](an int option with argument [1])
- [cmd -string foobar ](a string option with argument ["foobar"])
- [cmd -float 12.34 ](a float option with argument [12.34])
- [cmd 1 2 3 ](three anonymous arguments: ["1"], ["2"], and ["3"])
*)
type spec =
Unit of (unit -> unit) (* Call the function with no argument *)
| Set of bool ref (* Set the reference to true *)
| Clear of bool ref (* Set the reference to false *)
| String of (string -> unit) (* Call the function with a string argument *)
| Int of (int -> unit) (* Call the function with an int argument *)
| Float of (float -> unit) (* Call the function with a float argument *)
(* The concrete type describing the behavior associated
with a keyword. *)
val parse : (string * spec) list -> (string -> unit) -> unit
(* [parse speclist anonfun] parses the command line,
calling the functions in [speclist] whenever appropriate,
and [anonfun] on anonymous arguments.
The functions are called in the same order as they appear
on the command line.
The strings in the [(string * spec) list] are keywords and must
start with a [-], else they are ignored. *)
exception Bad of string
(* Functions in [speclist] or [anonfun] can raise [Bad] with
an error message to reject invalid arguments. *)
|
