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

Side by Side Diff: pkg/args/lib/args.dart

Issue 363083002: Allow defining a help string for an option's parameter value. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 5 months 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 unified diff | Download patch | Annotate | Revision Log
OLDNEW
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 library args; 5 library args;
6 6
7 import 'package:collection/wrappers.dart'; 7 import 'package:collection/wrappers.dart';
8 8
9 import 'src/parser.dart'; 9 import 'src/parser.dart';
10 import 'src/usage.dart'; 10 import 'src/usage.dart';
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after
61 _commands[name] = parser; 61 _commands[name] = parser;
62 return parser; 62 return parser;
63 } 63 }
64 64
65 /// Defines a flag. Throws an [ArgumentError] if: 65 /// Defines a flag. Throws an [ArgumentError] if:
66 /// 66 ///
67 /// * There is already an option named [name]. 67 /// * There is already an option named [name].
68 /// * There is already an option using abbreviation [abbr]. 68 /// * There is already an option using abbreviation [abbr].
69 void addFlag(String name, {String abbr, String help, bool defaultsTo: false, 69 void addFlag(String name, {String abbr, String help, bool defaultsTo: false,
70 bool negatable: true, void callback(bool value), bool hide: false}) { 70 bool negatable: true, void callback(bool value), bool hide: false}) {
71 _addOption(name, abbr, help, null, null, defaultsTo, callback, 71 _addOption(name, abbr, help, null, null, null, defaultsTo, callback,
72 isFlag: true, negatable: negatable, hide: hide); 72 isFlag: true, negatable: negatable, hide: hide);
73 } 73 }
74 74
75 /// Defines a value-taking option. Throws an [ArgumentError] if: 75 /// Defines a value-taking option. Throws an [ArgumentError] if:
76 /// 76 ///
77 /// * There is already an option with name [name]. 77 /// * There is already an option with name [name].
78 /// * There is already an option using abbreviation [abbr]. 78 /// * There is already an option using abbreviation [abbr].
79 void addOption(String name, {String abbr, String help, List<String> allowed, 79 void addOption(String name, {String abbr, String help, String valueHelp,
80 Map<String, String> allowedHelp, String defaultsTo, 80 List<String> allowed, Map<String, String> allowedHelp, String defaultsTo,
81 void callback(value), bool allowMultiple: false, bool hide: false}) { 81 void callback(value), bool allowMultiple: false, bool hide: false}) {
82 _addOption(name, abbr, help, allowed, allowedHelp, defaultsTo, 82 _addOption(name, abbr, help, valueHelp, allowed, allowedHelp, defaultsTo,
83 callback, isFlag: false, allowMultiple: allowMultiple, 83 callback, isFlag: false, allowMultiple: allowMultiple,
84 hide: hide); 84 hide: hide);
85 } 85 }
86 86
87 void _addOption(String name, String abbr, String help, List<String> allowed, 87 void _addOption(String name, String abbr, String help, String valueHelp,
88 Map<String, String> allowedHelp, defaultsTo, 88 List<String> allowed, Map<String, String> allowedHelp, defaultsTo,
89 void callback(value), {bool isFlag, bool negatable: false, 89 void callback(value), {bool isFlag, bool negatable: false,
90 bool allowMultiple: false, bool hide: false}) { 90 bool allowMultiple: false, bool hide: false}) {
91 // Make sure the name isn't in use. 91 // Make sure the name isn't in use.
92 if (_options.containsKey(name)) { 92 if (_options.containsKey(name)) {
93 throw new ArgumentError('Duplicate option "$name".'); 93 throw new ArgumentError('Duplicate option "$name".');
94 } 94 }
95 95
96 // Make sure the abbreviation isn't too long or in use. 96 // Make sure the abbreviation isn't too long or in use.
97 if (abbr != null) { 97 if (abbr != null) {
98 var existing = findByAbbreviation(abbr); 98 var existing = findByAbbreviation(abbr);
99 if (existing != null) { 99 if (existing != null) {
100 throw new ArgumentError( 100 throw new ArgumentError(
101 'Abbreviation "$abbr" is already used by "${existing.name}".'); 101 'Abbreviation "$abbr" is already used by "${existing.name}".');
102 } 102 }
103 } 103 }
104 104
105 _options[name] = new Option(name, abbr, help, allowed, allowedHelp, 105 _options[name] = new Option(name, abbr, help, valueHelp, allowed,
106 defaultsTo, callback, isFlag: isFlag, negatable: negatable, 106 allowedHelp, defaultsTo, callback, isFlag: isFlag, negatable: negatable,
107 allowMultiple: allowMultiple, hide: hide); 107 allowMultiple: allowMultiple, hide: hide);
108 } 108 }
109 109
110 /// Parses [args], a list of command-line arguments, matches them against the 110 /// Parses [args], a list of command-line arguments, matches them against the
111 /// flags and options defined by this parser, and returns the result. 111 /// flags and options defined by this parser, and returns the result.
112 ArgResults parse(List<String> args) => 112 ArgResults parse(List<String> args) =>
113 new Parser(null, this, args.toList(), null, null).parse(); 113 new Parser(null, this, args.toList(), null, null).parse();
114 114
115 /// Generates a string displaying usage information for the defined options. 115 /// Generates a string displaying usage information for the defined options.
116 /// 116 ///
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
170 'Could not find an option named "$name".'); 170 'Could not find an option named "$name".');
171 } 171 }
172 172
173 return _options[name]; 173 return _options[name];
174 } 174 }
175 175
176 /// Get the names of the options as an [Iterable]. 176 /// Get the names of the options as an [Iterable].
177 Iterable<String> get options => _options.keys; 177 Iterable<String> get options => _options.keys;
178 } 178 }
179 179
OLDNEW
« pkg/args/README.md ('K') | « pkg/args/README.md ('k') | pkg/args/lib/src/options.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698