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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
#import "OFObject.h"
#import "OFString.h"
@class OFMapTable;
OF_ASSUME_NONNULL_BEGIN
/*!
* @struct of_options_parser_option_t OFOptionsParser.h ObjFW/OFOptionsParser.h
*
* @brief An option which can be parsed by an @ref OFOptionsParser.
*/
struct of_options_parser_option_t {
/*! The short version (e.g. `-v`) of the option or `\0` for none. */
of_unichar_t shortOption;
/*!
* The long version (e.g. `--verbose`) of the option or `nil` for none.
*/
OFString *__unsafe_unretained _Nullable longOption;
/*!
* Whether the option takes an argument.
*
* 0 means it takes no argument.@n
* 1 means it takes a required argument.@n
* -1 means it takes an optional argument.@n
*
* All other values are invalid and will throw an
* @ref OFInvalidArgumentException.
*/
signed char hasArgument;
/*!
* An optional pointer to a bool that is set to whether the option has
* been specified.
*/
bool *_Nullable isSpecifiedPtr;
/*!
* An optional pointer to an `OFString *` that is set to the
* argument specified for the option or `nil` for no argument.
*/
OFString *__autoreleasing _Nullable *_Nullable argumentPtr;
};
typedef struct of_options_parser_option_t of_options_parser_option_t;
/*!
* @class OFOptionsParser OFOptionsParser.h ObjFW/OFOptionsParser.h
*
* @brief A class for parsing the program options specified on the command line.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFOptionsParser: OFObject
{
of_options_parser_option_t *_options;
OFMapTable *_longOptions;
OFArray OF_GENERIC(OFString *) *_arguments;
size_t _index, _subIndex;
of_unichar_t _lastOption;
OFString *_Nullable _lastLongOption, *_Nullable _argument;
bool _done;
}
/*!
* @brief The last parsed option.
*
* If @ref nextOption returned `?` or `:`, this returns the option which was
* unknown or for which the argument was missing.@n
* If this returns `-`, the last option is only available as a long option (see
* lastLongOption).
*/
@property (readonly, nonatomic) of_unichar_t lastOption;
/*!
* @brief The long option for the last parsed option, or `nil` if the last
* parsed option was not passed as a long option by the user.
*
* In case @ref nextOption returned `?`, this contains the unknown long
* option.@n
* In case it returned `:`, this contains the long option which is missing an
* argument.@n
* In case it returned `=`, this contains the long option for which an
* argument was specified even though the option takes no argument.
*
* @warning Unlike @ref lastOption, which returns the short option even if the
* user specified a long option, this only returns the long option if
* it was actually specified as a long option by the user.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *lastLongOption;
/*!
* @brief The argument for the last parsed option, or `nil` if the last parsed
* option takes no argument.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *argument;
/*!
* @brief The arguments following the last option.
*/
@property (readonly, nonatomic)
OFArray OF_GENERIC(OFString *) *remainingArguments;
/*!
* @brief Creates a new OFOptionsParser which accepts the specified options.
*
* @param options An array of @ref of_options_parser_option_t specifying all
* accepted options, terminated with an option whose short
* option is `\0` and long option is `nil`.
*
* @return A new, autoreleased OFOptionsParser
*/
+ (instancetype)parserWithOptions: (const of_options_parser_option_t *)options;
- (instancetype)init OF_UNAVAILABLE;
/*!
* @brief Initializes an already allocated OFOptionsParser so that it accepts
* the specified options.
*
* @param options An array of @ref of_options_parser_option_t specifying all
* accepted options, terminated with an option whose short
* option is `\0` and long option is `nil`.
*
* @return An initialized OFOptionsParser
*/
- (instancetype)initWithOptions: (const of_options_parser_option_t *)options
OF_DESIGNATED_INITIALIZER;
/*!
* @brief Returns the next option.
*
* If the option is only available as a long option, `-` is returned.
* Otherwise, the short option is returned, even if it was specified as a long
* option.@n
* If an unknown option is specified, `?` is returned.@n
* If the argument for the option is missing, `:` is returned.@n
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
#import "OFObject.h"
#import "OFString.h"
@class OFMapTable;
OF_ASSUME_NONNULL_BEGIN
/**
* @struct of_options_parser_option_t OFOptionsParser.h ObjFW/OFOptionsParser.h
*
* @brief An option which can be parsed by an @ref OFOptionsParser.
*/
struct of_options_parser_option_t {
/** The short version (e.g. `-v`) of the option or `\0` for none. */
of_unichar_t shortOption;
/**
* The long version (e.g. `--verbose`) of the option or `nil` for none.
*/
OFString *__unsafe_unretained _Nullable longOption;
/**
* Whether the option takes an argument.
*
* 0 means it takes no argument.@n
* 1 means it takes a required argument.@n
* -1 means it takes an optional argument.@n
*
* All other values are invalid and will throw an
* @ref OFInvalidArgumentException.
*/
signed char hasArgument;
/**
* An optional pointer to a bool that is set to whether the option has
* been specified.
*/
bool *_Nullable isSpecifiedPtr;
/**
* An optional pointer to an `OFString *` that is set to the
* argument specified for the option or `nil` for no argument.
*/
OFString *__autoreleasing _Nullable *_Nullable argumentPtr;
};
typedef struct of_options_parser_option_t of_options_parser_option_t;
/**
* @class OFOptionsParser OFOptionsParser.h ObjFW/OFOptionsParser.h
*
* @brief A class for parsing the program options specified on the command line.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFOptionsParser: OFObject
{
of_options_parser_option_t *_options;
OFMapTable *_longOptions;
OFArray OF_GENERIC(OFString *) *_arguments;
size_t _index, _subIndex;
of_unichar_t _lastOption;
OFString *_Nullable _lastLongOption, *_Nullable _argument;
bool _done;
}
/**
* @brief The last parsed option.
*
* If @ref nextOption returned `?` or `:`, this returns the option which was
* unknown or for which the argument was missing.@n
* If this returns `-`, the last option is only available as a long option (see
* lastLongOption).
*/
@property (readonly, nonatomic) of_unichar_t lastOption;
/**
* @brief The long option for the last parsed option, or `nil` if the last
* parsed option was not passed as a long option by the user.
*
* In case @ref nextOption returned `?`, this contains the unknown long
* option.@n
* In case it returned `:`, this contains the long option which is missing an
* argument.@n
* In case it returned `=`, this contains the long option for which an
* argument was specified even though the option takes no argument.
*
* @warning Unlike @ref lastOption, which returns the short option even if the
* user specified a long option, this only returns the long option if
* it was actually specified as a long option by the user.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *lastLongOption;
/**
* @brief The argument for the last parsed option, or `nil` if the last parsed
* option takes no argument.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *argument;
/**
* @brief The arguments following the last option.
*/
@property (readonly, nonatomic)
OFArray OF_GENERIC(OFString *) *remainingArguments;
/**
* @brief Creates a new OFOptionsParser which accepts the specified options.
*
* @param options An array of @ref of_options_parser_option_t specifying all
* accepted options, terminated with an option whose short
* option is `\0` and long option is `nil`.
*
* @return A new, autoreleased OFOptionsParser
*/
+ (instancetype)parserWithOptions: (const of_options_parser_option_t *)options;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Initializes an already allocated OFOptionsParser so that it accepts
* the specified options.
*
* @param options An array of @ref of_options_parser_option_t specifying all
* accepted options, terminated with an option whose short
* option is `\0` and long option is `nil`.
*
* @return An initialized OFOptionsParser
*/
- (instancetype)initWithOptions: (const of_options_parser_option_t *)options
OF_DESIGNATED_INITIALIZER;
/**
* @brief Returns the next option.
*
* If the option is only available as a long option, `-` is returned.
* Otherwise, the short option is returned, even if it was specified as a long
* option.@n
* If an unknown option is specified, `?` is returned.@n
* If the argument for the option is missing, `:` is returned.@n
|