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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// De-duplication macro used in src/app.rs
macro_rules! get_help {
	($opt:ident) => {
		if let Some(h) = $opt.help {
	        format!("{}{}", h,
	            if let Some(ref pv) = $opt.possible_vals {
	                let mut pv_s = pv.iter().fold(String::with_capacity(50), |acc, name| acc + &format!(" {}",name)[..]);
	                pv_s.shrink_to_fit();
	                format!(" [values:{}]", &pv_s[..])
	            }else{"".to_owned()})
	    } else {
	        "    ".to_owned()
	    } 
	};
}

// Thanks to bluss and flan3002 in #rust IRC
//
// Helps with rightward drift when iterating over something and matching each item.
macro_rules! for_match {
	($it:ident, $($p:pat => $($e:expr);+),*) => {
		for i in $it {
			match i {
			$(
			    $p => { $($e)+ }
			)*
			}
		}
	};
}

/// Convenience macro getting a typed value `T` where `T` implements `std::str::FromStr`
/// This macro returns a `Result<T,String>` which allows you as the developer to decide
/// what you'd like to do on a failed parse. There are two types of errors, parse failures
/// and those where the argument wasn't present (such as a non-required argument). 
///
/// You can use it to get a single value, or a `Vec<T>` with the `values_of()`
/// 
/// **NOTE:** Be cautious, as since this a macro invocation it's not exactly like
/// standard syntax.
///
///
/// # Example single value
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::App;
/// # fn main() {
/// let matches = App::new("myapp")
///               .arg_from_usage("[length] 'Set the length to use as a pos whole num, i.e. 20'")
///				  .get_matches();
/// let len = value_t!(matches.value_of("length"), u32)
/// 				.unwrap_or_else(|e|{
///						println!("{}",e); 
///						std::process::exit(1)
///					});
///
/// println!("{} + 2: {}", len, len + 2);
/// # }
/// ```
///
///
/// # Example multiple values
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::App;
/// # fn main() {
/// let matches = App::new("myapp")
///               .arg_from_usage("[seq]... 'A sequence of pos whole nums, i.e. 20 45'")
///				  .get_matches();
/// for v in value_t!(matches.values_of("seq"), u32)
///				.unwrap_or_else(|e|{
///					println!("{}",e); 
///					std::process::exit(1)
///				}) {
/// 	println!("{} + 2: {}", v, v + 2);
///	}
/// # }
/// ```
#[macro_export]
macro_rules! value_t {
	($m:ident.value_of($v:expr), $t:ty) => {
		match $m.value_of($v) {
			Some(v) => {
				match v.parse::<$t>() {
					Ok(val) => Ok(val),
					Err(_)  => Err(format!("{} isn't a valid {}",v,stringify!($t))),
				}
			},
			None => Err(format!("Argument \"{}\" not found", $v))
		}
	};
	($m:ident.values_of($v:expr), $t:ty) => {
		match $m.values_of($v) {
			Some(ref v) => {
				let mut tmp = Vec::with_capacity(v.len());
				let mut err = None;
				for pv in v {
					match pv.parse::<$t>() {
						Ok(rv) => tmp.push(rv),
						Err(e) => {
							err = Some(format!("{} isn't a valid {}\n{}",pv,stringify!($t),e));
							break
						}
					}
				}
				match err {
					Some(e) => Err(e),
					None => Ok(tmp)
				}
			},
			None => Err(format!("Argument \"{}\" not found", $v))
		}
	};
}

/// Convenience macro getting a typed value `T` where `T` implements `std::str::FromStr`
/// This macro returns a `T` or `Vec<T>` or exits with a usage string upon failure. This
/// removes some of the boiler plate to handle failures from value_t! above. 
///
/// You can use it to get a single value `T`, or a `Vec<T>` with the `values_of()`
/// 
/// **NOTE:** This should only be used on required arguments, as it can be confusing to the user
/// why they are getting error messages when it appears they're entering all required argumetns.
///
/// **NOTE:** Be cautious, as since this a macro invocation it's not exactly like
/// standard syntax.
///
///
/// # Example single value
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::App;
/// # fn main() {
/// let matches = App::new("myapp")
///               .arg_from_usage("[length] 'Set the length to use as a pos whole num, i.e. 20'")
///				  .get_matches();
/// let len = value_t_or_exit!(matches.value_of("length"), u32);
///
/// println!("{} + 2: {}", len, len + 2);
/// # }
/// ```
///
///
/// # Example multiple values
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::App;
/// # fn main() {
/// let matches = App::new("myapp")
///                   .arg_from_usage("[seq]... 'A sequence of pos whole nums, i.e. 20 45'")
///					  .get_matches();
/// for v in value_t_or_exit!(matches.values_of("seq"), u32) {
/// 	println!("{} + 2: {}", v, v + 2);
///	}
/// # }
/// ```
#[macro_export]
macro_rules! value_t_or_exit {
	($m:ident.value_of($v:expr), $t:ty) => {
		match $m.value_of($v) {
			Some(v) => {
				match v.parse::<$t>() {
					Ok(val) => val,
					Err(e)  => {
						println!("{} isn't a valid {}\n{}\n{}\nPlease re-run with --help for more information",
							v,
							stringify!($t), 
							e,
							$m.usage());
						::std::process::exit(1);
					}
				}
			},
			None => {
				println!("Argument \"{}\" not found or is not valid\n{}\nPlease re-run with --help for more information",
					$v, 
					$m.usage());
				::std::process::exit(1);
			}
		}
	};
	($m:ident.values_of($v:expr), $t:ty) => {
		match $m.values_of($v) {
			Some(ref v) => {
				let mut tmp = Vec::with_capacity(v.len());
				for pv in v {
					match pv.parse::<$t>() {
						Ok(rv) => tmp.push(rv),
						Err(_)  => {
							println!("{} isn't a valid {}\n{}\nPlease re-run with --help for more information",
								pv,
								stringify!($t), 
								$m.usage()); 
							::std::process::exit(1);
						}
					}
				}
				tmp
			},
			None => {
				println!("Argument \"{}\" not found or is not valid\n{}\nPlease re-run with --help for more information",
					$v, 
					$m.usage());
				::std::process::exit(1);
			}
		}
	};
}

/// Convenience macro generated a simple enum with variants to be used as a type when parsing
/// arguments.
///
/// # Example
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::{App, Arg};
/// simple_enum!{Foo => Bar, Baz, Qux}
/// // Foo enum can now be used via Foo::Bar, or Foo::Baz, etc
/// // and implements std::str::FromStr to use with the value_t! macros
/// fn main() {
/// 	let m = App::new("app")
///					.arg(Arg::from_usage("<foo> 'the foo'")
///						.possible_values(vec!["Bar", "Baz", "Qux"]))
///					.get_matches();
/// 	let f = value_t_or_exit!(m.value_of("foo"), Foo);
///
///		// Use f like any other Foo variant...
/// }
/// ```
#[macro_export]
macro_rules! simple_enum {
	($e:ident => $($v:ident),+) => {
		enum $e {
			$($v),+
		}

		impl ::std::str::FromStr for $e {
			type Err = String; 

			fn from_str(s: &str) -> Result<Self,Self::Err> {
				match s {
					$(stringify!($v) => Ok($e::$v),)+
					_                => Err({
											let v = vec![
								        		$(stringify!($v),)+
								    		];
								    		format!("valid:{}", v.iter().fold(String::new(),|a, i| a + &format!(" {}", i)[..]))
										})
				}
			}
		}
	};
}

/// Convenience macro to generate more complete enums with variants to be used as a type when parsing
/// arguments.
///
/// These enums support pub (or not) and use of the #[derive()] traits
///
///
/// # Example
///
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::{App, Arg};
/// arg_enum!{
/// 	#[derive(Debug)]
///		pub enum Foo {
///			Bar,
///			Baz,
///			Qux
///		}
/// }
/// // Foo enum can now be used via Foo::Bar, or Foo::Baz, etc
/// // and implements std::str::FromStr to use with the value_t! macros
/// fn main() {
/// 	let m = App::new("app")
///					.arg_from_usage("<foo> 'the foo'")
///					.get_matches();
/// 	let f = value_t_or_exit!(m.value_of("foo"), Foo);
///
///		// Use f like any other Foo variant...
/// }
/// ```
#[macro_export]
macro_rules! arg_enum {
	(enum $e:ident { $($v:ident),+ } ) => {
		enum $e {
			$($v),+
		}

		impl ::std::str::FromStr for $e {
			type Err = String;

			fn from_str(s: &str) -> Result<Self,Self::Err> {
				match s {
					$(stringify!($v) => Ok($e::$v),)+
					_                => Err({
											let v = vec![
								        		$(stringify!($v),)+
								    		];
								    		format!("valid:{}", v.iter().fold(String::new(),|a, i| a + &format!(" {}", i)[..]))
										})
				}
			}
		}
	};
	(pub enum $e:ident { $($v:ident),+ } ) => {
		pub enum $e {
			$($v),+
		}

		impl ::std::str::FromStr for $e {
			type Err = String;

			fn from_str(s: &str) -> Result<Self,Self::Err> {
				match s {
					$(stringify!($v) => Ok($e::$v),)+
					_                => Err({
											let v = vec![
								        		$(stringify!($v),)+
								    		];
								    		format!("valid:{}", v.iter().fold(String::new(),|a, i| a + &format!(" {}", i)[..]))
										})
				}
			}
		}
	};
	(#[derive($($d:ident),+)] enum $e:ident { $($v:ident),+ } ) => {
		#[derive($($d,)+)]
		enum $e {
			$($v),+
		}

		impl ::std::str::FromStr for $e {
			type Err = String;

			fn from_str(s: &str) -> Result<Self,Self::Err> {
				match s {
					$(stringify!($v) => Ok($e::$v),)+
					_                => Err({
											let v = vec![
								        		$(stringify!($v),)+
								    		];
								    		format!("valid:{}", v.iter().fold(String::new(),|a, i| a + &format!(" {}", i)[..]))
										})
				}
			}
		}
	};
	(#[derive($($d:ident),+)] pub enum $e:ident { $($v:ident),+ } ) => {
		#[derive($($d,)+)]
		pub enum $e {
			$($v),+
		}

		impl ::std::str::FromStr for $e {
			type Err = String;

			fn from_str(s: &str) -> Result<Self,Self::Err> {
				match s {
					$(stringify!($v) => Ok($e::$v),)+
					_                => Err({
											let v = vec![
								        		$(stringify!($v),)+
								    		];
								    		format!("valid:{}", v.iter().fold(String::new(),|a, i| a + &format!(" {}", i)[..]))
										})
				}
			}
		}
	};
}

/// Allows you pull the version for an from your Cargo.toml as MAJOR.MINOR.PATCH_PKGVERSION_PRE
///
/// # Example
/// ```no_run
/// # #[macro_use]
/// # extern crate clap;
/// # use clap::App;
/// # fn main() {
/// 	let m = App::new("app")
///					.version(crate_version!())
///					.get_matches();
/// # }
/// ```
#[macro_export]
macro_rules! crate_version {
	() => {
		format!("{}.{}.{}{}",
      		env!("CARGO_PKG_VERSION_MAJOR"),
      		env!("CARGO_PKG_VERSION_MINOR"),
      		env!("CARGO_PKG_VERSION_PATCH"),
      		option_env!("CARGO_PKG_VERSION_PRE").unwrap_or(""))
	}
}