clars 0.1.0

Command line argument resolution system
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

use crate::errors::*;

/// Long option prefix.
const LONG_PREFIX: &str = "--";

/// Short option prefix.
const SHORT_PREFIX: &str = "-";

/// Option value separator.
const VALUE_SEPARATOR: &str = "=";

/// Parsed token.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Token {
  /// Short option with optional value.
  ShortOption(char, Option<String>),
  /// Long option with optional value.
  LongOption(String, Option<String>),
  /// Argument.
  Argument(String),
  /// Option terminator.
  OptionTerminator,
}

pub struct Lexer {
  tokens: Vec<Token>,
  consumed_option_terminator: bool,
}

impl Default for Lexer {
  fn default() -> Self {
    Self::new()
  }
}

impl Lexer {
  pub fn new() -> Self {
    Self {
      tokens: vec![],
      consumed_option_terminator: false,
    }
  }

  /// Parses arguments into lexical tokens.
  pub fn parse<I, S>(&mut self, input: I) -> Result<&[Token]>
  where
    I: IntoIterator<Item = S>,
    S: AsRef<str>,
  {
    for item in input {
      let text = item.as_ref();
      if self.consumed_option_terminator {
        self.tokens.push(Token::Argument(text.to_string()));
      } else if let Some(s) = text.strip_prefix(LONG_PREFIX) {
        self.parse_long_option(s)?;
      } else if let Some(s) = text.strip_prefix(SHORT_PREFIX) {
        self.parse_short_option(s)?
      } else {
        self.tokens.push(Token::Argument(text.to_string()));
      }
    }
    Ok(&self.tokens)
  }

  fn parse_long_option(&mut self, s: &str) -> Result<()> {
    if s.is_empty() {
      // When the string is empty then return option terminator.
      self.tokens.push(Token::OptionTerminator);
      self.consumed_option_terminator = true;
    } else {
      // Parse option name with possible value.
      let (option, value) = self.parse_parts(s)?;
      self.validate_long_name(&option)?;
      self.tokens.push(Token::LongOption(option, value));
    }
    Ok(())
  }

  fn parse_short_option(&mut self, s: &str) -> Result<()> {
    if s.is_empty() {
      self.tokens.push(Token::Argument(SHORT_PREFIX.to_string()));
    } else {
      // Parse option name with possible value.
      let (option, value) = self.parse_parts(s)?;
      let mut chars = option.chars().peekable();
      loop {
        let ch = chars.next().unwrap();
        self.validate_short_name(ch)?;
        if chars.peek().is_none() {
          self.tokens.push(Token::ShortOption(ch, value));
          break;
        } else {
          self.tokens.push(Token::ShortOption(ch, None));
        }
      }
    }
    Ok(())
  }

  fn parse_parts(&self, s: &str) -> Result<(String, Option<String>)> {
    // Split around the value separator to extract possible value for option.
    let parts = s
      .split(VALUE_SEPARATOR)
      .map(|part| part.to_string())
      .collect::<Vec<String>>();
    // Parts may not start or end with whitespaces.
    for part in &parts {
      if part.starts_with(" ") {
        return Err(ClarsError::new("whitespace before"));
      }
      if part.ends_with(" ") {
        return Err(ClarsError::new("whitespace after"));
      }
    }
    match parts.len() {
      1 => Ok((parts[0].clone(), None)),
      2 => Ok((parts[0].clone(), Some(parts[1].clone()))),
      _ => Err(ClarsError::new("too many equal signs")),
    }
  }

  fn validate_long_name(&self, s: &str) -> Result<()> {
    for (index, ch) in s.chars().enumerate() {
      if index == 0 {
        if !ch.is_ascii_alphabetic() {
          return Err(ClarsError::new("long option name must start with a letter"));
        }
      } else {
        if !(ch.is_ascii_alphanumeric() || ch == '-') {
          return Err(ClarsError::new(
            "long option name must contain letters, digits or hyphens",
          ));
        }
      }
    }
    Ok(())
  }

  fn validate_short_name(&self, ch: char) -> Result<()> {
    if !ch.is_ascii_alphanumeric() {
      return Err(ClarsError::new("short option must be a letter or digit"));
    }
    Ok(())
  }
}