Overview
Comment: | OFOptionsParser: Reworked API
The new API allows long options and requires less manual parsing. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
bfa913aebe57b299ec08629c673f3459 |
User & Date: | js on 2015-11-28 18:56:19 |
Other Links: | manifest | tags |
Context
2015-11-28
| ||
19:47 | Minor documentation improvements check-in: 650b4be224 user: js tags: trunk | |
18:56 | OFOptionsParser: Reworked API check-in: bfa913aebe user: js tags: trunk | |
2015-11-22
| ||
22:35 | lookup-asm-sparc*.S: Add prediction to branches check-in: 8838387d21 user: js tags: trunk | |
Changes
Modified src/OFOptionsParser.h from [bff8d10a51] to [d487046e69].
︙ | ︙ | |||
11 12 13 14 15 16 17 | * Alternatively, it may be distributed under the terms of the GNU General * Public License, either version 2 or 3, which can be found in the file * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this * file. */ #import "OFObject.h" | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > > > > > > | | | | | | | | > > > > > | > > > > | > > > > > > > > > > > > > > > > > > > > > | | 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 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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | * Alternatively, it may be distributed under the terms of the GNU General * Public License, either version 2 or 3, which can be found in the file * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this * file. */ #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. */ typedef 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 *_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 @ref OFString* that is set to the argument * specified for the option or `nil` for no argument */ OFString *__autoreleasing _Nullable *_Nullable argumentPtr; } 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. */ @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 *_lastLongOption, *_argument; bool _done; } #ifdef OF_HAVE_PROPERTIES @property (readonly) of_unichar_t lastOption; @property OF_NULLABLE_PROPERTY (readonly) OFString *lastLongOption; @property OF_NULLABLE_PROPERTY (readonly) OFString *argument; @property (readonly) OFArray OF_GENERIC(OFString*) *remainingArguments; #endif /*! * @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; /*! * @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 */ - initWithOptions: (const of_options_parser_option_t*)options; /*! * @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 * If there is an argument for the option even though it takes none, '=' is * returned.@n * If all options have been parsed, `'\0'` is returned. * * @note You need to call @ref nextOption repeatedly until it returns `'\0'` to * make sure all options have been parsed, even if you only rely on the * optional pointers specified and don't do any parsing yourself. * * @return The next option */ - (of_unichar_t)nextOption; /*! * @brief Returns 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 * @ref lastLongOption). * * @return The last parsed option */ - (of_unichar_t)lastOption; /*! * @brief Returns 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. * * @return The last parsed long option or `nil` */ - (nullable OFString*)lastLongOption; /*! * @brief Returns the argument for the last parsed option, or `nil` if the last * parsed option takes no argument. * * @return The argument for the last parsed option */ - (nullable OFString*)argument; /*! |
︙ | ︙ |
Modified src/OFOptionsParser.m from [3c15f89aa9] to [fbe9ab7d4c].
︙ | ︙ | |||
15 16 17 18 19 20 21 22 23 | */ #include "config.h" #import "OFOptionsParser.h" #import "OFApplication.h" #import "OFArray.h" @implementation OFOptionsParser | > > > > > > > > > > > > > > > | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > | > > > > > > > > | > > | > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | | < | < < > > > > > > > > > > > | | 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 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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 | */ #include "config.h" #import "OFOptionsParser.h" #import "OFApplication.h" #import "OFArray.h" #import "OFMapTable.h" #import "OFInvalidArgumentException.h" static uint32_t stringHash(void *value) { return [(OFString*)value hash]; } static bool stringEqual(void *value1, void *value2) { return [(OFString*)value1 isEqual: (OFString*)value2]; } @implementation OFOptionsParser + (instancetype)parserWithOptions: (const of_options_parser_option_t*)options { return [[[self alloc] initWithOptions: options] autorelease]; } - init { OF_INVALID_INIT_METHOD } - initWithOptions: (const of_options_parser_option_t*)options { self = [super init]; @try { size_t count = 0; const of_options_parser_option_t *iter; of_options_parser_option_t *iter2; const of_map_table_functions_t keyFunctions = { .hash = stringHash, .equal = stringEqual }; const of_map_table_functions_t valueFunctions = { NULL }; /* Count, sanity check and initialize pointers */ for (iter = options; iter->shortOption != '\0' || iter->longOption != nil; iter++) { if (iter->hasArgument < -1 || iter->hasArgument > 1) @throw [OFInvalidArgumentException exception]; if (iter->shortOption != '\0' && iter->hasArgument == -1) @throw [OFInvalidArgumentException exception]; if (iter->hasArgument == 0 && iter->argumentPtr != NULL) @throw [OFInvalidArgumentException exception]; if (iter->isSpecifiedPtr) *iter->isSpecifiedPtr = false; if (iter->argumentPtr) *iter->argumentPtr = nil; count++; } _longOptions = [[OFMapTable alloc] initWithKeyFunctions: keyFunctions valueFunctions: valueFunctions]; _options = [self allocMemoryWithSize: sizeof(*_options) count: count + 1]; for (iter = options, iter2 = _options; iter->shortOption != '\0' || iter->longOption != nil; iter++, iter2++) { iter2->shortOption = iter->shortOption; iter2->longOption = nil; iter2->hasArgument = iter->hasArgument; iter2->isSpecifiedPtr = iter->isSpecifiedPtr; iter2->argumentPtr = iter->argumentPtr; @try { iter2->longOption = [iter->longOption copy]; if ([_longOptions valueForKey: iter2->longOption] != NULL) @throw [OFInvalidArgumentException exception]; [_longOptions setValue: iter2 forKey: iter2->longOption]; } @catch (id e) { /* * Make sure we are in a consistent state where * dealloc works. */ [iter2->longOption release]; iter2->shortOption = '\0'; iter2->longOption = nil; @throw e; } } _arguments = [[OFApplication arguments] retain]; } @catch (id e) { [self release]; @throw e; } return self; } - (void)dealloc { of_options_parser_option_t *iter; [_longOptions release]; if (_options != NULL) for (iter = _options; iter->shortOption != '\0' || iter->longOption != nil; iter++) [iter->longOption release]; [_arguments release]; [_argument release]; [super dealloc]; } - (of_unichar_t)nextOption { of_options_parser_option_t *iter; OFString *argument; if (_done || _index >= [_arguments count]) return '\0'; [_lastLongOption release]; [_argument release]; _lastLongOption = nil; _argument = nil; argument = [_arguments objectAtIndex: _index]; if (_subIndex == 0) { if ([argument length] < 2 || [argument characterAtIndex: 0] != '-') { _done = true; return '\0'; } if ([argument isEqual: @"--"]) { _done = true; _index++; return '\0'; } if ([argument hasPrefix: @"--"]) { void *pool = objc_autoreleasePoolPush(); size_t pos; of_options_parser_option_t *option; _lastOption = '-'; _index++; if ((pos = [argument rangeOfString: @"="].location) != OF_NOT_FOUND) { of_range_t range = of_range(pos + 1, [argument length] - pos - 1); _argument = [[argument substringWithRange: range] copy]; } else pos = [argument length]; _lastLongOption = [[argument substringWithRange: of_range(2, pos - 2)] copy]; objc_autoreleasePoolPop(pool); option = [_longOptions valueForKey: _lastLongOption]; if (option == nil) return '?'; if (option->hasArgument == 1 && _argument == nil) return ':'; if (option->hasArgument == 0 && _argument != nil) return '='; if (option->isSpecifiedPtr != NULL) *option->isSpecifiedPtr = true; if (option->argumentPtr != NULL) *option->argumentPtr = [[_argument copy] autorelease]; if (option->shortOption != '\0') _lastOption = option->shortOption; return _lastOption; } _subIndex = 1; } _lastOption = [argument characterAtIndex: _subIndex++]; if (_subIndex >= [argument length]) { _index++; _subIndex = 0; } for (iter = _options; iter->shortOption != '\0' || iter->longOption != nil; iter++) { if (iter->shortOption == _lastOption) { if (iter->hasArgument == 0) return _lastOption; if (_index >= [_arguments count]) return ':'; argument = [_arguments objectAtIndex: _index]; argument = [argument substringWithRange: of_range(_subIndex, [argument length] - _subIndex)]; _argument = [argument copy]; if (iter->isSpecifiedPtr != NULL) *iter->isSpecifiedPtr = true; if (iter->argumentPtr != NULL) *iter->argumentPtr = [[_argument copy] autorelease]; _index++; _subIndex = 0; return _lastOption; } } return '?'; } - (of_unichar_t)lastOption { return _lastOption; } - (OFString*)lastLongOption { OF_GETTER(_lastLongOption, true) } - (OFString*)argument { OF_GETTER(_argument, true) } - (OFArray*)remainingArguments { return [_arguments objectsInRange: of_range(_index, [_arguments count] - _index)]; } @end |
Modified utils/ofhttp/OFHTTP.m from [45b5064c67] to [bdce356a5d].
︙ | ︙ | |||
209 210 211 212 213 214 215 | [OFApplication programName]]; [OFApplication terminateWithStatus: 1]; } } - (void)applicationDidFinishLaunching { | > > > > > > > > > > > > > > | | < < < < < < < < < < | > > > > > > > > > > | > | > > > > | > | > | | | | < | | > | | > > > | 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | [OFApplication programName]]; [OFApplication terminateWithStatus: 1]; } } - (void)applicationDidFinishLaunching { OFString *outputPath; const of_options_parser_option_t options[] = { { 'b', @"body", 1, NULL, NULL }, { 'c', @"continue", 0, &_continue, NULL }, { 'h', @"help", 0, NULL, NULL }, { 'H', @"header", 1, NULL, NULL }, { 'm', @"method", 1, NULL, NULL }, { 'o', @"output", 1, NULL, &outputPath }, { 'O', @"detect-filename", 0, &_detectFileName, NULL }, { 'P', @"socks5-proxy", 1, NULL, NULL }, { 'q', @"quiet", 0, &_quiet, NULL }, { 'v', @"verbose", 0, &_verbose, NULL }, { '\0', nil, 0, NULL, NULL } }; OFOptionsParser *optionsParser = [OFOptionsParser parserWithOptions: options]; of_unichar_t option; while ((option = [optionsParser nextOption]) != '\0') { switch (option) { case 'b': [self setBody: [optionsParser argument]]; break; case 'h': help(of_stdout, true, 0); break; case 'H': [self addHeader: [optionsParser argument]]; break; case 'm': [self setMethod: [optionsParser argument]]; break; case 'P': [self setProxy: [optionsParser argument]]; break; case ':': if ([optionsParser lastLongOption] != nil) [of_stderr writeFormat: @"%@: Argument for option --%@ missing\n", [OFApplication programName], [optionsParser lastLongOption]]; else [of_stderr writeFormat: @"%@: Argument for option -%C missing\n", [OFApplication programName], [optionsParser lastOption]]; [OFApplication terminateWithStatus: 1]; break; case '=': [of_stderr writeFormat: @"%@: Option --%@ takes no " @"argument\n", [OFApplication programName], [optionsParser lastLongOption]]; [OFApplication terminateWithStatus: 1]; break; case '?': if ([optionsParser lastLongOption] != nil) [of_stderr writeFormat: @"%@: Unknown option: --%@\n", [OFApplication programName], [optionsParser lastLongOption]]; else [of_stderr writeFormat: @"%@: Unknown option: -%C\n", [OFApplication programName], [optionsParser lastOption]]; [OFApplication terminateWithStatus: 1]; break; } } _outputPath = [outputPath copy]; _URLs = [[optionsParser remainingArguments] retain]; if ([_URLs count] < 1) help(of_stderr, false, 1); if (_quiet && _verbose) { [of_stderr writeFormat: @"%@: -q and -v are mutually " |
︙ | ︙ |
Modified utils/ofzip/OFZIP.m from [9b11336043] to [6492307736].
︙ | ︙ | |||
104 105 106 107 108 109 110 111 | } #endif } @implementation OFZIP - (void)applicationDidFinishLaunching { OFOptionsParser *optionsParser = | > > > > > > > > > > | | 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 | } #endif } @implementation OFZIP - (void)applicationDidFinishLaunching { const of_options_parser_option_t options[] = { { 'f', @"force", 0, NULL, NULL }, { 'h', @"help", 0, NULL, NULL }, { 'l', @"list", 0, NULL, NULL }, { 'n', @"no-clobber", 0, NULL, NULL }, { 'q', @"quiet", 0, NULL, NULL }, { 'v', @"verbose", 0, NULL, NULL }, { 'x', @"extract", 0, NULL, NULL }, { '\0', nil, 0, NULL, NULL } }; OFOptionsParser *optionsParser = [OFOptionsParser parserWithOptions: options]; of_unichar_t option, mode = '\0'; OFArray OF_GENERIC(OFString*) *remainingArguments, *files; OFZIPArchive *archive; while ((option = [optionsParser nextOption]) != '\0') { switch (option) { case 'f': |
︙ | ︙ | |||
146 147 148 149 150 151 152 153 | mutuallyExclusiveError('x', 'l'); mode = option; break; case 'h': help(of_stdout, true, 0); break; default: | > > > > > > > > > | > | > > > > > | > | 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | mutuallyExclusiveError('x', 'l'); mode = option; break; case 'h': help(of_stdout, true, 0); break; case '=': [of_stderr writeFormat: @"%@: Option --%@ takes no " @"argument!\n", [OFApplication programName], [optionsParser lastLongOption]]; [OFApplication terminateWithStatus: 1]; break; default: if ([optionsParser lastLongOption] != nil) [of_stderr writeFormat: @"%@: Unknown option: --%@\n", [OFApplication programName], [optionsParser lastLongOption]]; else [of_stderr writeFormat: @"%@: Unknown option: -%C\n", [OFApplication programName], [optionsParser lastOption]]; [OFApplication terminateWithStatus: 1]; } } remainingArguments = [optionsParser remainingArguments]; switch (mode) { |
︙ | ︙ | |||
355 356 357 358 359 360 361 | } directory = [outFileName stringByDeletingLastPathComponent]; if (![fileManager directoryExistsAtPath: directory]) [fileManager createDirectoryAtPath: directory createParents: true]; | > | < | 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 | } directory = [outFileName stringByDeletingLastPathComponent]; if (![fileManager directoryExistsAtPath: directory]) [fileManager createDirectoryAtPath: directory createParents: true]; if (_override != 1 && [fileManager fileExistsAtPath: outFileName]) { OFString *line; if (_override == -1) { if (_outputLevel >= 0) [of_stdout writeLine: @" skipped"]; goto outer_loop_end; |
︙ | ︙ |