aargvark 0.9.6

Self-similar argument parsing
Documentation
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
use {
    crate::{
        base::{
            PeekR,
            VarkState,
            R,
        },
        help::{
            HelpPartialContent,
            HelpPartialProduction,
            HelpPattern,
            HelpPatternElement,
            HelpState,
        },
        traits::{
            empty_completer,
            AargvarkCompleter,
            AargvarkTrait,
        },
    },
    std::{
        collections::{
            HashMap,
            HashSet,
        },
        env::current_dir,
        ffi::OsString,
        fs::read_dir,
        io::Read,
        net::{
            IpAddr,
            Ipv4Addr,
            Ipv6Addr,
            SocketAddr,
            SocketAddrV4,
            SocketAddrV6,
        },
        ops::Deref,
        path::{
            Path,
            PathBuf,
        },
    },
};

/// A helper enum, providing a simpler interface for types that can be parsed from
/// a single primitive string.
///
/// Note that `from_str` is not called if there is no argument - this means if you
/// need to do completer-specific setup regardless of whether a partial argument
/// was present or not, this must be done in the `Default` method of the completer.
pub trait AargvarkFromStr: Sized {
    fn from_str(s: &str) -> Result<Self, String>;
    fn build_help_pattern(state: &mut HelpState) -> HelpPattern;

    fn build_completer(_arg: &str) -> AargvarkCompleter {
        return empty_completer();
    }
}

impl<T: AargvarkFromStr> AargvarkTrait for T {
    fn vark(state: &mut VarkState) -> R<Self> {
        let s = match state.peek() {
            PeekR::None => return state.r_err_missing(),
            PeekR::Help => return R::Help(Box::new(|state| {
                return HelpPartialProduction {
                    description: "".to_string(),
                    content: HelpPartialContent::Pattern(<Self as AargvarkTrait>::build_help_pattern(state)),
                };
            })),
            PeekR::Ok(s) => s,
        };
        let completer = T::build_completer(s);
        match T::from_str(s) {
            Ok(v) => {
                state.consume();
                return state.r_ok(v, Some(completer));
            },
            Err(e) => return state.r_err(e, Some(completer)),
        }
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return <T as AargvarkFromStr>::build_help_pattern(state);
    }
}

macro_rules! auto_from_str{
    ($placeholder: literal, $t: ty) => {
        impl AargvarkFromStr for $t {
            fn from_str(s: &str) -> Result<Self, String> {
                return <Self as std::str::FromStr>::from_str(s).map_err(|e| e.to_string());
            }

            fn build_help_pattern(_state: &mut HelpState) -> HelpPattern {
                return HelpPattern(vec![HelpPatternElement:: Type($placeholder.to_string())]);
            }
        }
    };
}

auto_from_str!("STRING", String);

auto_from_str!("INT", u8);

auto_from_str!("INT", u16);

auto_from_str!("INT", u32);

auto_from_str!("INT", u64);

auto_from_str!("INT", usize);

auto_from_str!("INT", i8);

auto_from_str!("INT", i16);

auto_from_str!("INT", i32);

auto_from_str!("INT", i64);

auto_from_str!("INT", f32);

auto_from_str!("NUM", f64);

auto_from_str!("STRING", OsString);

auto_from_str!("SOCKET", SocketAddr);

auto_from_str!("SOCKETV4", SocketAddrV4);

auto_from_str!("SOCKETV6", SocketAddrV6);

auto_from_str!("IP", IpAddr);

auto_from_str!("IPV4", Ipv4Addr);

auto_from_str!("IPV6", Ipv6Addr);

fn pathbuf_completer(arg: &str) -> AargvarkCompleter {
    let arg = arg.to_string();
    return Box::new(move || {
        fn list(p: &Path) -> Option<Vec<String>> {
            let d;
            match read_dir(&p) {
                Ok(d0) => {
                    d = d0;
                },
                Err(_) => {
                    return None;
                },
            }
            let mut out = vec![];
            for e in d {
                let Ok(e) = e else {
                    continue;
                };
                let Some(n) = e.file_name().to_str().map(|x| x.to_string()) else {
                    continue;
                };
                out.push(n);
            }
            return Some(out);
        }

        let path = PathBuf::from(&arg);
        let Ok(current_dir) = current_dir() else {
            return vec![];
        };

        // If dir, list that dir
        {
            let prefix;
            let use_path;
            if arg == "" {
                use_path = &current_dir;
                prefix = format!("");
            } else if arg.ends_with("/") {
                use_path = &path;
                prefix = arg.to_string();
            } else {
                use_path = &path;
                prefix = format!("{}/", arg);
            }
            if let Some(o) = list(use_path) {
                return o.into_iter().filter_map(|x| Some(vec![format!("{}{}", prefix, x)])).collect();
            }
        }

        // Not a dir, so must be a partial filename
        {
            let parent = path.parent().unwrap().to_path_buf();
            let prefix;
            let use_path;
            if parent.as_os_str().as_encoded_bytes() == b"" {
                use_path = &current_dir;
                prefix = format!("");
            } else {
                use_path = &parent;
                prefix = format!("{}/", parent.to_str().unwrap());
            }
            if let Some(o) = list(use_path) {
                let filter_prefix = path.file_name().unwrap().to_str().unwrap();
                let mut out = vec![];
                for e in o {
                    if !e.starts_with(filter_prefix) {
                        continue;
                    }
                    out.push(vec![format!("{}{}", prefix, e)]);
                }
                return out;
            }
        }

        // Bad path, give up
        return vec![];
    });
}

impl AargvarkFromStr for PathBuf {
    fn from_str(s: &str) -> Result<Self, String> {
        return <Self as std::str::FromStr>::from_str(s).map_err(|e| e.to_string());
    }

    fn build_help_pattern(_state: &mut HelpState) -> HelpPattern {
        return HelpPattern(vec![HelpPatternElement::Type("PATH".to_string())]);
    }

    fn build_completer(arg: &str) -> AargvarkCompleter {
        return pathbuf_completer(arg);
    }
}

#[cfg(feature = "http_types")]
auto_from_str!("URI", http::Uri);

const BOOL_LITERALS: &[&str] = &["true", "false"];

impl AargvarkFromStr for bool {
    fn from_str(s: &str) -> Result<Self, String> {
        return <Self as std::str::FromStr>::from_str(s).map_err(|e| e.to_string());
    }

    fn build_help_pattern(_state: &mut HelpState) -> HelpPattern {
        return HelpPattern(
            vec![
                HelpPatternElement::Variant(
                    BOOL_LITERALS
                        .iter()
                        .map(|l| HelpPattern(vec![HelpPatternElement::Literal(l.to_string())]))
                        .collect(),
                )
            ],
        );
    }

    fn build_completer(arg: &str) -> AargvarkCompleter {
        let arg = arg.to_string();
        return Box::new(move || {
            let mut out = vec![];
            for l in BOOL_LITERALS {
                if l.starts_with(&arg) {
                    out.push(vec![l.to_string()]);
                }
            }
            return out;
        });
    }
}

#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
pub enum Source {
    Stdin,
    File(PathBuf),
}

/// This parses a path (or - for stdin) passed on the command line into bytes.
pub struct AargvarkFile {
    pub value: Vec<u8>,
    pub source: Source,
}

impl AargvarkFromStr for AargvarkFile {
    fn from_str(s: &str) -> Result<Self, String> {
        if s == "-" {
            let mut out = vec![];
            match std::io::stdin().read_to_end(&mut out) {
                Ok(_) => return Ok(Self {
                    value: out,
                    source: Source::Stdin,
                }),
                Err(e) => return Err(format!("Error reading stdin: {}", e)),
            };
        } else {
            match std::fs::read(s) {
                Ok(v) => return Ok(Self {
                    value: v,
                    source: Source::File(PathBuf::from(s)),
                }),
                Err(e) => return Err(format!("Error reading {}: {}", s, e)),
            };
        }
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return HelpPattern(
            vec![
                HelpPatternElement::Variant(
                    vec![
                        <PathBuf as AargvarkTrait>::build_help_pattern(state),
                        HelpPattern(vec![HelpPatternElement::Literal("-".to_string())])
                    ],
                )
            ],
        );
    }

    fn build_completer(arg: &str) -> AargvarkCompleter {
        return pathbuf_completer(arg);
    }
}

/// This parses a path (or - for stdin) passed on the command line as json into the
/// specified type.
#[cfg(feature = "serde_json")]
pub struct AargvarkJson<T> {
    pub value: T,
    pub source: Source,
}

#[cfg(feature = "serde_json")]
impl<T: for<'a> serde::Deserialize<'a>> AargvarkFromStr for AargvarkJson<T> {
    fn from_str(s: &str) -> Result<Self, String> {
        let b = AargvarkFile::from_str(s)?;
        match serde_path_to_error::deserialize(&mut serde_json::Deserializer::from_slice(&b.value)) {
            Ok(v) => return Ok(Self {
                value: v,
                source: b.source,
            }),
            Err(e) => return Err(e.to_string()),
        };
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return HelpPattern(
            vec![
                HelpPatternElement::Variant(
                    vec![
                        <PathBuf as AargvarkTrait>::build_help_pattern(state),
                        HelpPattern(vec![HelpPatternElement::Literal("-".to_string())])
                    ],
                )
            ],
        );
    }

    fn build_completer(arg: &str) -> AargvarkCompleter {
        return pathbuf_completer(arg);
    }
}

#[cfg(feature = "serde_json")]
impl<T: Clone> Clone for AargvarkJson<T> {
    fn clone(&self) -> Self {
        return AargvarkJson {
            value: self.value.clone(),
            source: self.source.clone(),
        };
    }
}

/// This parses a path (or - for stdin) passed on the command line as yaml into the
/// specified type.
#[cfg(feature = "serde_yaml")]
pub struct AargvarkYaml<T> {
    pub value: T,
    pub source: Source,
}

#[cfg(feature = "serde_yaml")]
impl<T: for<'a> serde::Deserialize<'a>> AargvarkFromStr for AargvarkYaml<T> {
    fn from_str(s: &str) -> Result<Self, String> {
        let b = AargvarkFile::from_str(s)?;
        match serde_path_to_error::deserialize(serde_yaml::Deserializer::from_slice(&b.value)) {
            Ok(v) => return Ok(Self {
                value: v,
                source: b.source,
            }),
            Err(e) => return Err(e.to_string()),
        };
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return HelpPattern(
            vec![
                HelpPatternElement::Variant(
                    vec![
                        <PathBuf as AargvarkTrait>::build_help_pattern(state),
                        HelpPattern(vec![HelpPatternElement::Literal("-".to_string())])
                    ],
                )
            ],
        );
    }

    fn build_completer(arg: &str) -> AargvarkCompleter {
        return pathbuf_completer(arg);
    }
}

#[cfg(feature = "serde_yaml")]
impl<T: Clone> Clone for AargvarkYaml<T> {
    fn clone(&self) -> Self {
        return AargvarkYaml {
            value: self.value.clone(),
            source: self.source.clone(),
        };
    }
}

/// This parses a path (or - for stdin) passed on the command line as toml into the
/// specified type.
#[cfg(feature = "serde_toml")]
pub struct AargvarkToml<T> {
    pub value: T,
    pub source: Source,
}

#[cfg(feature = "serde_toml")]
impl<T: for<'a> serde::Deserialize<'a>> AargvarkFromStr for AargvarkToml<T> {
    fn from_str(s: &str) -> Result<Self, String> {
        let b = AargvarkFile::from_str(s)?;
        match serde_path_to_error::deserialize(
            toml::Deserializer::new(
                &String::from_utf8(b.value).map_err(|e| format!("TOML document at {} isn't valid UTF-8: {}", s, e))?,
            ),
        ) {
            Ok(v) => return Ok(Self {
                value: v,
                source: b.source,
            }),
            Err(e) => return Err(e.to_string()),
        };
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return HelpPattern(
            vec![
                HelpPatternElement::Variant(
                    vec![
                        <PathBuf as AargvarkTrait>::build_help_pattern(state),
                        HelpPattern(vec![HelpPatternElement::Literal("-".to_string())])
                    ],
                )
            ],
        );
    }

    fn build_completer(arg: &str) -> AargvarkCompleter {
        return pathbuf_completer(arg);
    }
}

#[cfg(feature = "serde_toml")]
impl<T: Clone> Clone for AargvarkToml<T> {
    fn clone(&self) -> Self {
        return AargvarkToml {
            value: self.value.clone(),
            source: self.source.clone(),
        };
    }
}

#[doc(hidden)]
pub fn vark_from_iter<T: AargvarkTrait, C: FromIterator<T>>(state: &mut VarkState) -> R<C> {
    let mut out = vec![];
    let mut rewind_to = state.position();
    loop {
        if state.provide_completions() && !out.is_empty() && state.peek() == PeekR::None {
            // Short circuit before overwriting previous state if at EOF - all types must
            // consume at least one argument
            return R::Err;
        }
        match T::vark(state) {
            R::Ok(v) => {
                out.push(v);
                rewind_to = state.position();
            },
            R::Help(b) => return R::Help(b),
            R::Err => {
                state.rewind(rewind_to);
                return state.r_ok(C::from_iter(out.into_iter()), None);
            },
        };
    }
}

impl<T: AargvarkTrait> AargvarkTrait for Vec<T> {
    fn vark(state: &mut VarkState) -> R<Self> {
        return vark_from_iter(state);
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return HelpPattern(vec![HelpPatternElement::Array(T::build_help_pattern(state))]);
    }
}

impl<T: AargvarkTrait + Eq + std::hash::Hash> AargvarkTrait for HashSet<T> {
    fn vark(state: &mut VarkState) -> R<Self> {
        return vark_from_iter(state);
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return HelpPattern(vec![HelpPatternElement::Array(T::build_help_pattern(state))]);
    }
}

/// A key-value argument type (single argument) that takes the format `K=V` where
/// both `K` and `V` need to be string-parsable types. The argument is split at the
/// first unescaped `=` - additional `=` in the key can be escaped with `\`.
///
/// This is used for the `HashMap` implementation which takes a series of arguments
/// like `a=a b=b c=123`.
pub struct AargvarkKV<K, V> {
    pub key: K,
    pub value: V,
}

impl<K: AargvarkFromStr, V: AargvarkFromStr> AargvarkTrait for AargvarkKV<K, V> {
    fn vark(state: &mut VarkState) -> R<Self> {
        let res = String::vark(state);
        let res = match res {
            R::Err => return R::Err,
            R::Help(b) => return R::Help(b),
            R::Ok(r) => r,
        };
        let mut res = res.chars().into_iter();
        let mut k = vec![];
        let mut escape = false;
        let mut at_value = false;
        for c in &mut res {
            if escape {
                k.push(c);
                escape = false;
            } else {
                if c == '\\' {
                    escape = true;
                } else if c == '=' {
                    at_value = true;
                    break;
                } else {
                    k.push(c);
                }
            }
        }
        let k = k.into_iter().collect::<String>();
        let key = match K::from_str(&k) {
            Ok(r) => r,
            Err(e) => return state.r_err(format!("Error parsing map key: {}", e), Some(K::build_completer(&k))),
        };
        if !at_value {
            return state.r_err(format!("Missing value in K=V argument"), Some(K::build_completer(&k)));
        }
        let v = res.collect::<String>();
        let value = match V::from_str(&v) {
            Ok(r) => r,
            Err(e) => return state.r_err(format!("Error parsing map value: {}", e), Some(V::build_completer(&v))),
        };
        return state.r_ok(AargvarkKV {
            key: key,
            value: value,
        }, Some(V::build_completer(&v)));
    }

    fn build_help_pattern(_state: &mut HelpState) -> HelpPattern {
        return HelpPattern(vec![HelpPatternElement::Literal("K=V".to_string())]);
    }
}

impl<K: AargvarkFromStr + Eq + std::hash::Hash, V: AargvarkFromStr> AargvarkTrait for HashMap<K, V> {
    fn vark(state: &mut VarkState) -> R<Self> {
        let res = match <Vec<AargvarkKV<K, V>>>::vark(state) {
            R::Err => return R::Err,
            R::Help(b) => return R::Help(b),
            R::Ok(r) => r,
        };
        return state.r_ok(res.into_iter().map(|kv| (kv.key, kv.value)).collect(), None);
    }

    fn build_help_pattern(state: &mut HelpState) -> HelpPattern {
        return <Vec<AargvarkKV<K, V>>>::build_help_pattern(state);
    }
}

/// A simple wrapper around `String` that only accepts strings that don't start
/// with `-`. Having an argument of `Vec<String>` will cause it to consume all
/// remaining arguments (since all of them are valid strings), while `Vec<NotFlag>`
/// will only consume until the next flag (or the end of the arguments).
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NotFlag(pub String);

impl AargvarkFromStr for NotFlag {
    fn from_str(s: &str) -> Result<Self, String> {
        if s.starts_with("-") {
            return Err("Argument looks like a flag (starts with -)".to_string());
        }
        return Ok(NotFlag(s.to_string()));
    }

    fn build_help_pattern(_state: &mut HelpState) -> HelpPattern {
        return HelpPattern(vec![HelpPatternElement::Type("STRING".to_string())]);
    }
}

impl ToString for NotFlag {
    fn to_string(&self) -> String {
        return self.0.clone();
    }
}

impl Deref for NotFlag {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        return &self.0;
    }
}

impl Into<String> for NotFlag {
    fn into(self) -> String {
        return self.0;
    }
}

impl AsRef<str> for NotFlag {
    fn as_ref(&self) -> &str {
        return self.0.as_str();
    }
}