|
sl@0
|
1 |
// Copyright Vladimir Prus 2004.
|
|
sl@0
|
2 |
// Distributed under the Boost Software License, Version 1.0.
|
|
sl@0
|
3 |
// (See accompanying file LICENSE_1_0.txt
|
|
sl@0
|
4 |
// or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
sl@0
|
5 |
|
|
sl@0
|
6 |
#ifndef BOOST_CMDLINE_HPP_VP_2004_03_13
|
|
sl@0
|
7 |
#define BOOST_CMDLINE_HPP_VP_2004_03_13
|
|
sl@0
|
8 |
|
|
sl@0
|
9 |
namespace boost { namespace program_options { namespace command_line_style {
|
|
sl@0
|
10 |
/** Various possible styles of options.
|
|
sl@0
|
11 |
|
|
sl@0
|
12 |
There are "long" options, which start with "--" and "short",
|
|
sl@0
|
13 |
which start with either "-" or "/". Both kinds can be allowed or
|
|
sl@0
|
14 |
disallowed, see allow_long and allow_short. The allowed character
|
|
sl@0
|
15 |
for short options is also configurable.
|
|
sl@0
|
16 |
|
|
sl@0
|
17 |
Option's value can be specified in the same token as name
|
|
sl@0
|
18 |
("--foo=bar"), or in the next token.
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
It's possible to introduce long options by the same character as
|
|
sl@0
|
21 |
short options, see allow_long_disguise.
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
Finally, guessing (specifying only prefix of option) and case
|
|
sl@0
|
24 |
insensitive processing are supported.
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
enum style_t {
|
|
sl@0
|
27 |
/// Allow "--long_name" style
|
|
sl@0
|
28 |
allow_long = 1,
|
|
sl@0
|
29 |
/// Alow "-<single character" style
|
|
sl@0
|
30 |
allow_short = allow_long << 1,
|
|
sl@0
|
31 |
/// Allow "-" in short options
|
|
sl@0
|
32 |
allow_dash_for_short = allow_short << 1,
|
|
sl@0
|
33 |
/// Allow "/" in short options
|
|
sl@0
|
34 |
allow_slash_for_short = allow_dash_for_short << 1,
|
|
sl@0
|
35 |
/** Allow option parameter in the same token
|
|
sl@0
|
36 |
for long option, like in
|
|
sl@0
|
37 |
@verbatim
|
|
sl@0
|
38 |
--foo=10
|
|
sl@0
|
39 |
@endverbatim
|
|
sl@0
|
40 |
*/
|
|
sl@0
|
41 |
long_allow_adjacent = allow_slash_for_short << 1,
|
|
sl@0
|
42 |
/** Allow option parameter in the next token for
|
|
sl@0
|
43 |
long options. */
|
|
sl@0
|
44 |
long_allow_next = long_allow_adjacent << 1,
|
|
sl@0
|
45 |
/** Allow option parameter in the same token for
|
|
sl@0
|
46 |
short options. */
|
|
sl@0
|
47 |
short_allow_adjacent = long_allow_next << 1,
|
|
sl@0
|
48 |
/** Allow option parameter in the next token for
|
|
sl@0
|
49 |
short options. */
|
|
sl@0
|
50 |
short_allow_next = short_allow_adjacent << 1,
|
|
sl@0
|
51 |
/** Allow to merge several short options together,
|
|
sl@0
|
52 |
so that "-s -k" become "-sk". All of the options
|
|
sl@0
|
53 |
but last should accept no parameter. For example, if
|
|
sl@0
|
54 |
"-s" accept a parameter, then "k" will be taken as
|
|
sl@0
|
55 |
parameter, not another short option.
|
|
sl@0
|
56 |
Dos-style short options cannot be sticky.
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
allow_sticky = short_allow_next << 1,
|
|
sl@0
|
59 |
/** Allow abbreviated spellings for long options,
|
|
sl@0
|
60 |
if they unambiguously identify long option.
|
|
sl@0
|
61 |
No long option name should be prefix of other
|
|
sl@0
|
62 |
long option name if guessing is in effect.
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
allow_guessing = allow_sticky << 1,
|
|
sl@0
|
65 |
/** Ignore the difference in case for options.
|
|
sl@0
|
66 |
@todo Should this apply to long options only?
|
|
sl@0
|
67 |
*/
|
|
sl@0
|
68 |
case_insensitive = allow_guessing << 1,
|
|
sl@0
|
69 |
/** Allow long options with single option starting character,
|
|
sl@0
|
70 |
e.g <tt>-foo=10</tt>
|
|
sl@0
|
71 |
*/
|
|
sl@0
|
72 |
allow_long_disguise = case_insensitive << 1,
|
|
sl@0
|
73 |
/** The more-or-less traditional unix style. */
|
|
sl@0
|
74 |
unix_style = (allow_short | short_allow_adjacent | short_allow_next
|
|
sl@0
|
75 |
| allow_long | long_allow_adjacent | long_allow_next
|
|
sl@0
|
76 |
| allow_sticky | allow_guessing
|
|
sl@0
|
77 |
| allow_dash_for_short),
|
|
sl@0
|
78 |
/** The default style. */
|
|
sl@0
|
79 |
default_style = unix_style
|
|
sl@0
|
80 |
};
|
|
sl@0
|
81 |
}}}
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
#endif
|
|
sl@0
|
85 |
|