1
2
3
4
5
6
7
8
9
10
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
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
use std::{
collections::{
HashMap,
hash_map::{Iter as MapIter, IterMut as MapIterMut},
},
ops::Range,
slice::{Iter, IterMut},
str::FromStr,
};
use crate::{Command, HelpReason};
/// stores parsed command line arguments.
pub struct Args {
/// map of option names to their values.
pub opts: HashMap<String, String>,
/// list of positional arguments.
pub pos: Vec<String>,
}
impl Args {
/// parses command line arguments for the given command.
pub fn parse<'a>(
command: &'a Command,
arguments: Vec<String>,
) -> (
&'a Command,
Args,
Option<&'a Box<dyn Fn(HelpReason, &'a Command, Args)>>,
) {
let mut current_command = command;
let mut parsed_args = Args {
opts: HashMap::new(),
pos: Vec::new(),
};
let mut help_fn = None;
let mut ignore_options = false;
for arg in arguments {
// tries to match argument as a subcommand of current_command.
let mut is_subcommand = false;
for cmd in ¤t_command.children {
if cmd.names.iter().any(|alias| alias == &arg) {
current_command = cmd;
help_fn = cmd.help.as_ref().or(help_fn);
is_subcommand = true;
break;
}
}
if is_subcommand {
// continue parsing after moving into subcommand.
continue;
}
if !ignore_options {
if arg == "--" {
// disables option parsing after '--'.
ignore_options = true;
continue;
} else if arg.starts_with("--") {
// parses long option with optional value.
let split: Vec<&str> = arg.splitn(2, '=').collect();
let name = split[0];
let value = split.get(1).unwrap_or(&"true");
parsed_args.opts.insert(name.to_string(), value.to_string());
continue;
} else if arg.starts_with('-') {
// parses one or more short options with optional value.
let split: Vec<&str> = arg.splitn(2, '=').collect();
let chars: Vec<char> = split[0].chars().skip(1).collect(); // skip leading '-'
let value = split.get(1).unwrap_or(&"true");
for ch in chars {
parsed_args.opts.insert(format!("-{ch}"), value.to_string());
}
continue;
}
}
// treats argument as a positional argument.
parsed_args.pos.push(arg);
}
(current_command, parsed_args, help_fn)
}
/// parses command line arguments from a slice of string slices.
pub fn parse_str<'a>(
command: &'a Command,
arguments: Vec<&str>,
) -> (
&'a Command,
Args,
Option<&'a Box<dyn Fn(HelpReason, &'a Command, Args)>>,
) {
Self::parse(
command,
arguments.iter().map(|arg| arg.to_string()).collect(),
)
}
/// creates Args from a vector of argument strings with an empty command.
pub fn new(arguments: Vec<String>) -> Args {
let (_, arguments, _) = Self::parse(&Command::new(""), arguments);
arguments
}
/// creates Args from a vector of argument string slices with an empty command.
pub fn new_str(arguments: Vec<&str>) -> Args {
let (_, arguments, _) = Self::parse_str(&Command::new(""), arguments);
arguments
}
/// checks if an option with the given name exists.
pub fn has(&self, name: &str) -> bool {
self.opts.contains_key(name)
}
/// checks if either of two options exists.
pub fn has_or(&self, name: &str, other: &str) -> bool {
self.opts.contains_key(name) || self.opts.contains_key(other)
}
/// checks if there is a positional argument at the given index.
pub fn has_at(&self, pos: usize) -> bool {
pos < self.pos.len()
}
/// tries to get and parse the option value by name into type T.
pub fn get<T>(&self, name: &str) -> Option<T>
where
T: FromStr,
{
match self.opts.get(name)?.parse::<T>() {
Ok(val) => Some(val),
Err(_) => None,
}
}
/// tries to get and parse the option value by either name or other into type T.
pub fn get_or<T>(&self, name: &str, other: &str) -> Option<T>
where
T: FromStr,
{
if self.opts.contains_key(name) {
self.get(name)
} else {
self.get(other)
}
}
/// gets the option value as a string reference.
pub fn get_string(&self, name: &str) -> Option<&String> {
self.opts.get(name)
}
/// gets the option value as string reference for either name or other.
pub fn get_string_or(&self, name: &str, other: &str) -> Option<&String> {
if self.opts.contains_key(name) {
self.opts.get(name)
} else {
self.opts.get(other)
}
}
/// tries to get and parse the positional argument at index into type T.
pub fn at<T>(&self, pos: usize) -> Option<T>
where
T: FromStr,
{
match self.pos.get(pos)?.parse::<T>() {
Ok(val) => Some(val),
Err(_) => None,
}
}
/// gets the positional argument at index as string reference.
pub fn at_string(&self, pos: usize) -> Option<&String> {
self.pos.get(pos)
}
/// parses a range of positional arguments into a vector of type T.
pub fn range<T>(&self, range: Range<usize>) -> Result<Vec<T>, String>
where
T: FromStr,
T::Err: ToString,
{
let slice = self
.pos
.get(range)
.ok_or_else(|| "index out of bounds".to_string())?;
slice
.iter()
.map(|s| s.parse::<T>().map_err(|e| e.to_string()))
.collect()
}
/// gets a range of positional arguments as string references.
pub fn range_string(&self, range: Range<usize>) -> Option<Vec<&String>> {
self.pos.get(range).map(|slice| slice.iter().collect())
}
/// returns an iterator over positional arguments.
pub fn iter(&self) -> Iter<String> {
self.pos.iter()
}
/// returns an iterator over options.
pub fn iter_opt(&self) -> MapIter<String, String> {
self.opts.iter()
}
/// returns a mutable iterator over positional arguments.
pub fn iter_mut(&mut self) -> IterMut<String> {
self.pos.iter_mut()
}
/// returns a mutable iterator over options.
pub fn iter_mut_opt(&mut self) -> MapIterMut<String, String> {
self.opts.iter_mut()
}
/// joins positional arguments.
pub fn join(&self, separator: &str) -> String {
self.pos.join(separator)
}
}
impl IntoIterator for Args {
type Item = String;
type IntoIter = std::vec::IntoIter<Self::Item>;
fn into_iter(self) -> Self::IntoIter {
self.pos.into_iter()
}
}