Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(101)

Unified Diff: observatory_pub_packages/args/src/arg_parser.dart

Issue 816693004: Add observatory_pub_packages snapshot to third_party (Closed) Base URL: http://dart.googlecode.com/svn/third_party/
Patch Set: Created 6 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: observatory_pub_packages/args/src/arg_parser.dart
===================================================================
--- observatory_pub_packages/args/src/arg_parser.dart (revision 0)
+++ observatory_pub_packages/args/src/arg_parser.dart (working copy)
@@ -0,0 +1,141 @@
+// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+library args.src.arg_parser;
+
+import 'package:collection/wrappers.dart';
+
+import 'arg_results.dart';
+import 'option.dart';
+import 'parser.dart';
+import 'usage.dart';
+
+/// A class for taking a list of raw command line arguments and parsing out
+/// options and flags from them.
+class ArgParser {
+ final Map<String, Option> _options;
+ final Map<String, ArgParser> _commands;
+
+ /// The options that have been defined for this parser.
+ final Map<String, Option> options;
+
+ /// The commands that have been defined for this parser.
+ final Map<String, ArgParser> commands;
+
+ /// Whether or not this parser parses options that appear after non-option
+ /// arguments.
+ final bool allowTrailingOptions;
+
+ /// Creates a new ArgParser.
+ ///
+ /// If [allowTrailingOptions] is set, the parser will continue parsing even
+ /// after it finds an argument that is neither an option nor a command.
+ /// This allows options to be specified after regular arguments. Defaults to
+ /// `false`.
+ factory ArgParser({bool allowTrailingOptions}) =>
+ new ArgParser._(<String, Option>{}, <String, ArgParser>{},
+ allowTrailingOptions: allowTrailingOptions);
+
+ ArgParser._(Map<String, Option> options, Map<String, ArgParser> commands,
+ {bool allowTrailingOptions}) :
+ this._options = options,
+ this.options = new UnmodifiableMapView(options),
+ this._commands = commands,
+ this.commands = new UnmodifiableMapView(commands),
+ this.allowTrailingOptions = allowTrailingOptions != null ?
+ allowTrailingOptions : false;
+
+ /// Defines a command.
+ ///
+ /// A command is a named argument which may in turn define its own options and
+ /// subcommands using the given parser. If [parser] is omitted, implicitly
+ /// creates a new one. Returns the parser for the command.
+ ArgParser addCommand(String name, [ArgParser parser]) {
+ // Make sure the name isn't in use.
+ if (_commands.containsKey(name)) {
+ throw new ArgumentError('Duplicate command "$name".');
+ }
+
+ if (parser == null) parser = new ArgParser();
+ _commands[name] = parser;
+ return parser;
+ }
+
+ /// Defines a flag. Throws an [ArgumentError] if:
+ ///
+ /// * There is already an option named [name].
+ /// * There is already an option using abbreviation [abbr].
+ void addFlag(String name, {String abbr, String help, bool defaultsTo: false,
+ bool negatable: true, void callback(bool value), bool hide: false}) {
+ _addOption(name, abbr, help, null, null, null, defaultsTo, callback,
+ OptionType.FLAG, negatable: negatable, hide: hide);
+ }
+
+ /// Defines a value-taking option. Throws an [ArgumentError] if:
+ ///
+ /// * There is already an option with name [name].
+ /// * There is already an option using abbreviation [abbr].
+ void addOption(String name, {String abbr, String help, String valueHelp,
+ List<String> allowed, Map<String, String> allowedHelp, String defaultsTo,
+ void callback(value), bool allowMultiple: false, bool hide: false}) {
+ _addOption(name, abbr, help, valueHelp, allowed, allowedHelp, defaultsTo,
+ callback, allowMultiple ? OptionType.MULTIPLE : OptionType.SINGLE,
+ hide: hide);
+ }
+
+ void _addOption(String name, String abbr, String help, String valueHelp,
+ List<String> allowed, Map<String, String> allowedHelp, defaultsTo,
+ void callback(value), OptionType type, {bool negatable: false,
+ bool hide: false}) {
+ // Make sure the name isn't in use.
+ if (_options.containsKey(name)) {
+ throw new ArgumentError('Duplicate option "$name".');
+ }
+
+ // Make sure the abbreviation isn't too long or in use.
+ if (abbr != null) {
+ var existing = findByAbbreviation(abbr);
+ if (existing != null) {
+ throw new ArgumentError(
+ 'Abbreviation "$abbr" is already used by "${existing.name}".');
+ }
+ }
+
+ _options[name] = newOption(name, abbr, help, valueHelp, allowed,
+ allowedHelp, defaultsTo, callback, type, negatable: negatable,
+ hide: hide);
+ }
+
+ /// Parses [args], a list of command-line arguments, matches them against the
+ /// flags and options defined by this parser, and returns the result.
+ ArgResults parse(List<String> args) =>
+ new Parser(null, this, args.toList(), null, null).parse();
+
+ /// Generates a string displaying usage information for the defined options.
+ ///
+ /// This is basically the help text shown on the command line.
+ @Deprecated("Replaced with get usage. getUsage() will be removed in args 1.0")
+ String getUsage() => new Usage(this).generate();
+
+ /// Generates a string displaying usage information for the defined options.
+ ///
+ /// This is basically the help text shown on the command line.
+ String get usage => new Usage(this).generate();
+
+ /// Get the default value for an option. Useful after parsing to test if the
+ /// user specified something other than the default.
+ getDefault(String option) {
+ if (!options.containsKey(option)) {
+ throw new ArgumentError('No option named $option');
+ }
+ return options[option].defaultValue;
+ }
+
+ /// Finds the option whose abbreviation is [abbr], or `null` if no option has
+ /// that abbreviation.
+ Option findByAbbreviation(String abbr) {
+ return options.values.firstWhere((option) => option.abbreviation == abbr,
+ orElse: () => null);
+ }
+}
« no previous file with comments | « observatory_pub_packages/args/command_runner.dart ('k') | observatory_pub_packages/args/src/arg_results.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698