First pass at a generic reusable command line option parser.

lib/args/args.dart

+// Copyright (c) 2012, 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');
+
+#import('utils.dart');
+
+/// Creates a new [ArgParser] which can be used to parse and validate options
+/// from a list of command-line argument strings. It supports [GNU][] and
+/// [POSIX][] style options.
+///
+/// ## Defining options ##
+///
+/// To use this library, you create an [ArgParser] object which will contain
+/// the set of options you support:
+///
+///     var parser = new ArgParser();
+///
+/// Then you define a set of options on that parser using [addOption()] and
+/// [addFlag()]. The minimal way to create an option is:
+///
+///     parser.addOption('name');
+///
+/// This creates an option named "name". Options must be given a value on the
+/// command line. If you have a simple on/off option, you can instead use a
+/// flag:
+///
+///     parser.addFlag('name');
+///
+/// (From here on out "option" will refer to both "regular" options and flags.
+/// In cases where the distinction matters, we'll use "non-flag option".)
+///
+/// Options may have an optional single-character abbreviation:
+///
+///     parser.addOption('mode', abbr: 'm');
+///     parser.addFlag('verbose', abbr: 'v');
+///
+/// They may also specify a default value. If provided, then when you later
+/// query for the option, in the parsed results, the default value will be
+/// returned if it wasn't provided by the arguments:
+///
+///     parser.addOption('mode', defaultsTo: 'debug');
+///     parser.addFlag('verbose', defaultsTo: false);
+///
+/// The default value for non-flag options can be any [String]. For flags, it
+/// must be a [bool].
+///
+/// To validate non-flag options, you may provide an allowed set of values. When
+/// you do, it will throw an [ArgFormatException] when you parse the arguments
+/// if the value for an option is not in the allowed set.
+///
+///     parser.addOption('mode', allowed: ['debug', 'release']);
+///
+/// You can provide a callback when you define an option. When you later parse
+/// a set of arguments, the callback for that option will be invoked with the
+/// value provided for it.
+///
+///     parser.addOption('mode', callback: (mode) => print('Got mode $mode));
+///     parser.addFlag('verbose', callback: (verbose) {
+///       if (verbose) print('Verbose');
+///     });
+///
+/// The callback for each option will *always* be called
+/// when you parse a set of arguments. If the option isn't provided in the args,
+/// the callback will be passed the default value, or `null` if there is none
+/// set.
+///
+/// ## Parsing arguments ##
+///
+/// Once you have an [ArgParser] set up with some options and flags, you use it
+/// by calling [ArgParser.parse()] with a set of arguments:
+///
+///     var results = parser.parse(['some', 'command', 'line', 'args']);
+///
+/// These will usually come from `new Options().arguments`, but you can pass in
+/// any list of strings. It returns an instance of [ArgResults]. This is a
+/// map-like object that will return the value of any parsed option.
+///
+///     var parser = new ArgParser();
+///     parser.addOption('mode');
+///     parser.addFlag('verbose', defaultsTo: true);
+///     var results = parser.parser('['--mode', 'debug', 'something', 'else']);
+///
+///     print(results['mode']); // debug
+///     print(results['verbose']); // true
+///
+/// The [parse()] method will stop as soon as it reaches `--` or anything that
+/// it doesn't recognize as an option, flag, or option value. If there are still
+/// arguments left, they will be provided to you in
+/// [ArgResults.remainingArguments].
+///
+///     print(results.remainingArguments); // ['something', 'else']
+///
+/// ## Specifying options ##
+///
+/// To actually pass in options and flags on the command line, use GNU or POSIX
+/// style. If you define an option like:
+///
+///     parser.addOption('name', abbr: 'n');
+///
+/// Then a value for it can be specified on the command line using any of:
+///
+///     --name=somevalue
+///     --name somevalue
+///     -nsomevalue
+///     -n somevalue
+///
+/// Given this flag:
+///
+///     parser.addFlag('name', abbr: 'n');
+///
+/// You can set it on using one of:
+///
+///     --name
+///     -n
+///
+/// Or set it off using:
+///
+///     --no-name
+///
+/// ## Usage ##
+///
+/// This library can also be used to automatically generate nice usage help
+/// text like you get when you run a program with `--help`. To use this, you
+/// will also want to provide some help text when you create your options. To
+/// define help text for the entire option, do:
+///
+///     parser.addOption('mode', help: 'The compiler configuration',
+///         allowed: ['debug', 'release']);
+///     parser.addFlag('verbose', help: 'Show additional diagnostic info');
+///
+/// For non-flag options, you can also provide detailed help for each expected
+/// value using a map:
+///
+///     parser.addOption('arch', help: 'The architecture to compile for',
+///         allowedHelp: {
+///           'ia32': 'Intel x86',
+///           'arm': 'ARM Holding 32-bit chip'
+///         });
+///
+/// If you define a set of options like the above, then calling this:
+///
+///     print(parser.getUsage());
+///
+/// Will display something like:
+///
+///     --mode            The compiler configuration
+///                       [debug, release]
+///
+///     --[no-]verbose    Show additional diagnostic info
+///     --arch            The architecture to compile for
+///
+///           [arm]       ARM Holding 32-bit chip
+///           [ia32]      Intel x86
+///
+/// [posix]: http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02
+/// [gnu]: http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces
+class ArgParser {
+  static final _SOLO_OPT = const RegExp(@'^-([a-z0-9])$');
+  static final _ABBR_OPT = const RegExp(@'^-([a-z0-9]+)(.*)$');
+  static final _LONG_OPT = const RegExp(@'^--([a-z\-_0-9]+)(=(.*))?$');
+
+  final Map<String, _Option> _options;
+
+  /// The names of the options, in the order that they were added. This way we
+  /// can generate usage information in the same order.
+  final List<String> _optionNames;
+
+  /// The current argument list being parsed. Set by [parse()].
+  List<String> _args;
+
+  /// Index of the current argument being parsed in [_args].
+  int _current;
+
+  /// Creates a new ArgParser.
+  ArgParser()
+    : _options = <_Option>{},
+      _optionNames = <String>[] {
+  }
+
+  /// Defines a flag. Throws an [IllegalArgumentException] if:
+  ///
+  /// * There is already an option with name [name].
+  /// * There is already an option using abbreviation [abbr].
+  void addFlag(String name, [String abbr, String help, bool defaultsTo,
+      void callback(bool value)]) {
+    _addOption(name, abbr, help, null, null, defaultsTo, callback,
+        isFlag: true);
+  }
+
+  /// Defines a value-taking option. Throws an [IllegalArgumentException] 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, List<String> allowed,
+      Map<String, String> allowedHelp, String defaultsTo,
+      void callback(bool value)]) {
+    _addOption(name, abbr, help, allowed, allowedHelp, defaultsTo, callback,
+        isFlag: false);
+  }
+
+  void _addOption(String name, [String abbr, String help, List<String> allowed,
+      Map<String, String> allowedHelp, defaultsTo,
+      void callback(bool value), bool isFlag]) {
+    // Make sure the name isn't in use.
+    if (_options.containsKey(name)) {
+      throw new IllegalArgumentException('Duplicate option "$name".');
+    }
+
+    // Make sure the abbreviation isn't too long or in use.
+    if (abbr != null) {
+      if (abbr.length > 1) {
+        throw new IllegalArgumentException(
+            'Abbreviation "$abbr" is longer than one character.');
+      }
+
+      var existing = _findByAbbr(abbr);
+      if (existing != null) {
+        throw new IllegalArgumentException(
+            'Abbreviation "$abbr" is already used by "${existing.name}".');
+      }
+    }
+
+    _options[name] = new _Option(name, abbr, help, allowed, allowedHelp,
+        defaultsTo, callback, isFlag: isFlag);
+    _optionNames.add(name);
+  }
+
+  /// 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) {
+    _args = args;
+    _current = 0;
+    var results = {};
+
+    // Initialize flags to their defaults.
+    _options.forEach((name, option) {
+      results[name] = option.defaultValue;
+    });
+
+    // Parse the args.
+    for (_current = 0; _current < args.length; _current++) {
+      var arg = args[_current];
+
+      if (arg == '--') {
+        // Reached the argument terminator, so stop here.
+        _current++;
+        break;
+      }
+
+      // Try to parse the current argument as an option. Note that the order
+      // here matters.
+      if (_parseSoloOption(results)) continue;
+      if (_parseAbbreviation(results)) continue;
+      if (_parseLongOption(results)) continue;
+
+      // If we got here, the argument doesn't look like an option, so stop.
+      break;
+    }
+
+    // Invoke the callbacks.
+    for (var name in _optionNames) {
+      var option = _options[name];
+      if (option.callback != null) option.callback(results[name]);
+    }
+
+    // Add in the leftover arguments we didn't parse.
+    return new ArgResults(results,
+        _args.getRange(_current, _args.length - _current));
+  }
+
+  /// Generates a string displaying usage imformation for the defined options.
+  /// This is basically the help text shown on the command line.
+  String getUsage() {
+    return new _Usage(this).generate();
+  }
+
+  /// Called during parsing to validate the arguments. Throws an
+  /// [ArgFormatException] if [condition] is `false`.
+  _validate(bool condition, String message) {
+    if (!condition) throw new ArgFormatException(message);
+  }
+
+  /// Validates and stores [value] as the value for [option].
+  _setOption(Map results, _Option option, value) {
+    // See if it's one of the allowed values.
+    if (option.allowed != null) {
+      _validate(option.allowed.some((allow) => allow == value),
+          '"$value" is not an allowed value for option "${option.name}".');
+    }
+
+    results[option.name] = value;
+  }
+
+  /// Pulls the value for [options] from the next argument in [args] (where the
+  /// current option is at index [i]. Validates that there is a valid value
+  /// there.
+  void _readNextArgAsValue(Map results, _Option option) {
+    _current++;
+    // Take the option argument from the next command line arg.
+    _validate(_current < _args.length,
+        'Missing argument for "${option.name}".');
+
+    // Make sure it isn't an option itself.
+    _validate(!_ABBR_OPT.hasMatch(_args[_current]) &&
+              !_LONG_OPT.hasMatch(_args[_current]),
+        'Missing argument for "${option.name}".');
+
+    _setOption(results, option, _args[_current]);
+  }
+
+  /// Tries to parse the current argument as a "solo" option, which is a single
+  /// hyphen followed by a single letter. We treat this specially from
+  /// collapsed abbreviations (like "-abc") to handle the possible value that
+  /// may follow it.
+  bool _parseSoloOption(Map results) {
+    var soloOpt = _SOLO_OPT.firstMatch(_args[_current]);
+    if (soloOpt == null) return false;
+
+    var option = _findByAbbr(soloOpt[1]);
+    _validate(option != null,
+        'Could not find an option or flag "-${soloOpt[1]}".');
+
+    if (option.isFlag) {
+      _setOption(results, option, true);
+    } else {
+      _readNextArgAsValue(results, option);
+    }
+
+    return true;
+  }
+
+  /// Tries to parse the current argument as a series of collapsed abbreviations
+  /// (like "-abc") or a single abbreviation with the value directly attached
+  /// to it (like "-mrelease").
+  bool _parseAbbreviation(Map results) {
+    var abbrOpt = _ABBR_OPT.firstMatch(_args[_current]);
+    if (abbrOpt == null) return false;
+
+    // If the first character is the abbreviation for an option, then the
+    // rest is the value.
+    var c = abbrOpt[1].substring(0, 1);
+    var first = _findByAbbr(c);
+    if (first == null) {
+      _validate(false, 'Could not find an option with short name "-$c".');
+    } else if (!first.isFlag) {
+      // The first character is an option, so the rest must be the value.
+      var value = '${abbrOpt[1].substring(1)}${abbrOpt[2]}';
+      _setOption(results, first, value);
+    } else {
+      // If we got some non-flag characters, then it must be a value, but
+      // if we got here, it's a flag, which is wrong.
+      _validate(abbrOpt[2] == '',
+        'Option "-$c" is a flag and cannot handle value '
+        '"${abbrOpt[1].substring(1)}${abbrOpt[2]}".');
+
+      // Not an option, so all characters should be flags.
+      for (var i = 0; i < abbrOpt[1].length; i++) {
+        var c = abbrOpt[1].substring(i, i + 1);
+        var option = _findByAbbr(c);
+        _validate(option != null,
+            'Could not find an option with short name "-$c".');
+
+        // In a list of short options, only the first can be a non-flag. If
+        // we get here we've checked that already.
+        _validate(option.isFlag,
+            'Option "-$c" must be a flag to be in a collapsed "-".');
+
+        _setOption(results, option, true);
+      }
+    }
+
+    return true;
+  }
+
+  /// Tries to parse the current argument as a long-form named option, which
+  /// may include a value like "--mode=release" or "--mode release".
+  bool _parseLongOption(Map results) {
+    var longOpt = _LONG_OPT.firstMatch(_args[_current]);
+    if (longOpt == null) return false;
+
+    var name = longOpt[1];
+    var option = _options[name];
+    if (option != null) {
+      if (option.isFlag) {
+        _validate(longOpt[3] == null,
+            'Flag option "$name" should not be given a value.');
+
+        _setOption(results, option, true);
+      } else {
+        // Option. Find the argument value.
+        if (longOpt[3] != null) {
+          // We have a value like --foo=bar.
+          _setOption(results, option, longOpt[3]);
+        } else {
+          _readNextArgAsValue(results, option);
+        }
+      }
+    } else if (name.startsWith('no-')) {
+      // See if it's a negated flag.
+      name = name.substring('no-'.length);
+      option = _options[name];
+      _validate(option != null, 'Could not find an option named "$name".');
+      _validate(option.isFlag, 'Cannot negate non-flag option "$name.');
+
+      _setOption(results, option, false);
+    } else {
+      _validate(option != null, 'Could not find an option named "$name".');
+    }
+
+    return true;
+  }
+
+  /// Finds the option whose abbreviation is [abbr], or `null` if no option has
+  /// that abbreviation.
+  _Option _findByAbbr(String abbr) {
+    for (var option in _options.getValues()) {
+      if (option.abbreviation == abbr) return option;
+    }
+
+    return null;
+  }
+}
+
+/// The results of parsing a series of command line arguments using
+/// [ArgParser.parse()]. Includes the parsed options and any remaining unparsed
+/// command line arguments.
+class ArgResults {
+  final Map _options;
+
+  /// The remaining command-line arguments that were not parsed as options or
+  /// flags. If `--` was used to separate the options from the remaining
+  /// arguments, it will not be included in this list.
+  final List<String> remainingArgs;
+
+  /// Creates a new [ArgResults].
+  ArgResults(this._options, this.remainingArgs);
+
+  /// Gets the parsed command-line option named [name].
+  operator [](String name) {
+    if (!_options.containsKey(name)) {
+      throw new IllegalArgumentException(
+          'Could not find an option named "$name".');
+    }
+
+    return _options[name];
+  }
+}
+
+/// Exception thrown by [ArgParser.parse()] when the argument list isn't valid.
+class ArgFormatException implements Exception {
+  final String message;
+  const ArgFormatException(this.message);
+}
+
+class _Option {
+  final String name;
+  final String abbreviation;
+  final List allowed;
+  final defaultValue;
+  final Function callback;
+  final String help;
+  final Map<String, String> allowedHelp;
+  final bool isFlag;
+
+  _Option(this.name, this.abbreviation, this.help, this.allowed,
+      this.allowedHelp, this.defaultValue, this.callback, [this.isFlag]);
+}
+
+class _Usage {
+  static final NUM_COLUMNS = 3; // Abbreviation, long name, help.
+
+  final ArgParser args;
+  StringBuffer buffer;
+  int currentColumn = 0;
+  List<int> columnWidths;
+  int numHelpLines = 0;
+  int newlinesNeeded = 0;
+
+  _Usage(this.args);
+
+  /// Generates a string displaying usage imformation for the defined options.
+  /// This is basically the help text shown on the command line.
+  String generate() {
+    buffer = new StringBuffer();
+
+    calculateColumnWidths();
+
+    for (var name in args._optionNames) {
+      var option = args._options[name];
+      write(0, getAbbreviation(option));
+      write(1, getLongOption(option));
+
+      if (option.help != null) write(2, option.help);
+
+      if (option.allowedHelp != null) {
+        var allowedNames = option.allowedHelp.getKeys();
+        allowedNames.sort((a, b) => a.compareTo(b));
+        newline();
+        for (var name in allowedNames) {
+          write(1, getAllowedTitle(name));
+          write(2, option.allowedHelp[name]);
+        }
+        newline();
+      } else if (option.allowed != null) {
+        write(2, buildAllowedList(option));
+      } else if (option.defaultValue != null) {
+        if (option.isFlag) {
+          write(2, '(defaults to ${option.defaultValue ? "on" : "off"})');
+        } else {
+          write(2, '(defaults to "${option.defaultValue}")');
+        }
+      }
+
+      // If any given option displays more than one line of text on the right
+      // column (i.e. help, default value, allowed options, etc.) then put a
+      // blank line after it. This gives space where it's useful while still
+      // keeping simple one-line options clumped together.
+      if (numHelpLines > 1) newline();
+    }
+
+    return buffer.toString();
+  }
+
+  String getAbbreviation(_Option option) {
+    if (option.abbreviation != null) {
+      return '-${option.abbreviation}, ';
+    } else {
+      return '';
+    }
+  }
+
+  String getLongOption(_Option option) {
+    if (option.isFlag) {
+      return '--[no-]${option.name}';
+    } else {
+      return '--${option.name}';
+    }
+  }
+
+  String getAllowedTitle(String allowed) {
+    return '      [$allowed]';
+  }
+
+  void calculateColumnWidths() {
+    int abbr = 0;
+    int title = 0;
+    for (var name in args._optionNames) {
+      var option = args._options[name];
+
+      // Make room in the first column if there are abbreviations.
+      abbr = Math.max(abbr, getAbbreviation(option).length);
+
+      // Make room for the option.
+      title = Math.max(title, getLongOption(option).length);
+
+      // Make room for the allowed help affects it.
+      if (option.allowedHelp != null) {
+        for (var allowed in option.allowedHelp.getKeys()) {
+          title = Math.max(title, getAllowedTitle(allowed).length);
+        }
+      }
+    }
+
+    // Leave a gutter between the columns.
+    title += 4;
+    columnWidths = [abbr, title];
+  }
+
+  newline() {
+    newlinesNeeded++;
+    currentColumn = 0;
+    numHelpLines = 0;
+  }
+
+  write(int column, String text) {
+    for (var line in text.split('\n')) {
+      writeLine(column, line);
+    }
+  }
+
+  writeLine(int column, String text) {
+    // Write any pending newlines. We do this lazily so that the last bit of
+    // usage doesn't have dangling newlines. We only write newlines right
+    // *before* we write some real content.
+    while (newlinesNeeded > 0) {
+      buffer.add('\n');
+      newlinesNeeded--;
+    }
+
+    // Advance until we are at the right column (which may mean wrapping around
+    // to the next line.
+    while (currentColumn != column) {
+      if (currentColumn < columnWidths.length) {
+        buffer.add(padRight('', columnWidths[currentColumn]));
+      } else {
+        buffer.add('\n');
+      }
+      currentColumn = (currentColumn + 1) % NUM_COLUMNS;
+    }
+
+    if (column < columnWidths.length) {
+      // Fixed-size column, so pad it.
+      buffer.add(padRight(text, columnWidths[column]));
+    } else {
+      // The last column, so just write it.
+      buffer.add(text);
+    }
+
+    // Advance to the next column.
+    currentColumn = (currentColumn + 1) % NUM_COLUMNS;
+
+    // If we reached the last column, we need to wrap to the next line.
+    if (column == NUM_COLUMNS - 1) newlinesNeeded++;
+
+    // Keep track of how many consecutive lines we've written in the last
+    // column.
+    if (column == NUM_COLUMNS - 1) {
+      numHelpLines++;
+    } else {
+      numHelpLines = 0;
+    }
+  }
+
+  buildAllowedList(_Option option) {
+    var allowedBuffer = new StringBuffer();
+    allowedBuffer.add('[');
+    bool first = true;
+    for (var allowed in option.allowed) {
+      if (!first) allowedBuffer.add(', ');
+      allowedBuffer.add(allowed);
+      if (allowed == option.defaultValue) {
+        allowedBuffer.add(' (default)');
+      }
+      first = false;
+    }
+    allowedBuffer.add(']');
+    return allowedBuffer.toString();
+  }
+}