OLD | NEW |
1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * This library lets you define parsers for parsing raw command-line arguments | 6 * This library lets you define parsers for parsing raw command-line arguments |
7 * into a set of options and values using [GNU][] and [POSIX][] style options. | 7 * into a set of options and values using [GNU][] and [POSIX][] style options. |
8 * | 8 * |
9 * ## Installing ## | 9 * ## Installing ## |
10 * | 10 * |
(...skipping 329 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
340 } | 340 } |
341 | 341 |
342 options[name] = new Option(name, abbr, help, allowed, allowedHelp, | 342 options[name] = new Option(name, abbr, help, allowed, allowedHelp, |
343 defaultsTo, callback, isFlag: isFlag, negatable: negatable, | 343 defaultsTo, callback, isFlag: isFlag, negatable: negatable, |
344 allowMultiple: allowMultiple); | 344 allowMultiple: allowMultiple); |
345 } | 345 } |
346 | 346 |
347 /** | 347 /** |
348 * Parses [args], a list of command-line arguments, matches them against the | 348 * Parses [args], a list of command-line arguments, matches them against the |
349 * flags and options defined by this parser, and returns the result. | 349 * flags and options defined by this parser, and returns the result. |
| 350 * |
| 351 * If [allowTrailingOptions] is set, the parser will continue parsing even |
| 352 * after it finds an argument that is neither an option nor a command. |
| 353 * This allows options to be specified after regular arguments. |
| 354 * |
| 355 * [allowTrailingOptions] is false by default, so when a non-option, |
| 356 * non-command argument is encountered, it and all remaining arguments, |
| 357 * even those that look like options are passed to the innermost command. |
350 */ | 358 */ |
351 ArgResults parse(List<String> args) => | 359 ArgResults parse(List<String> args, {bool allowTrailingOptions}) { |
352 new Parser(null, this, args.toList()).parse(); | 360 if (allowTrailingOptions == null) allowTrailingOptions = false; |
| 361 return new Parser(null, this, args.toList(), null, null, |
| 362 allowTrailingOptions: allowTrailingOptions).parse(); |
| 363 } |
353 | 364 |
354 /** | 365 /** |
355 * Generates a string displaying usage information for the defined options. | 366 * Generates a string displaying usage information for the defined options. |
356 * This is basically the help text shown on the command line. | 367 * This is basically the help text shown on the command line. |
357 */ | 368 */ |
358 String getUsage() => new Usage(this).generate(); | 369 String getUsage() => new Usage(this).generate(); |
359 | 370 |
360 /** | 371 /** |
361 * Get the default value for an option. Useful after parsing to test | 372 * Get the default value for an option. Useful after parsing to test |
362 * if the user specified something other than the default. | 373 * if the user specified something other than the default. |
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
415 'Could not find an option named "$name".'); | 426 'Could not find an option named "$name".'); |
416 } | 427 } |
417 | 428 |
418 return _options[name]; | 429 return _options[name]; |
419 } | 430 } |
420 | 431 |
421 /** Get the names of the options as an [Iterable]. */ | 432 /** Get the names of the options as an [Iterable]. */ |
422 Iterable<String> get options => _options.keys; | 433 Iterable<String> get options => _options.keys; |
423 } | 434 } |
424 | 435 |
OLD | NEW |