lex.rs

//! Lexing types

use std::fmt::Display;

pub use logos::Span;

/// A WAVE `logos::Lexer`
pub type Lexer<'source> = logos::Lexer<'source, Token>;

/// A WAVE token
#[derive(Clone, Copy, Debug, PartialEq, Eq, logos::Logos)]
#[logos(error = Option<Span>)]
#[logos(skip r"[ \t\n\r]+")]
#[logos(skip r"//[^\n]*")]
#[logos(subpattern label_word = r"[a-z][a-z0-9]*|[A-Z][A-Z0-9]*")]
#[logos(subpattern char_escape = r#"\\['"tnr\\]|\\u\{[0-9a-fA-F]{1,6}\}"#)]
pub enum Token {
    /// The `{` symbol
    #[token("{")]
    BraceOpen,
    /// The `}` symbol
    #[token("}")]
    BraceClose,

    /// The `(` symbol
    #[token("(")]
    ParenOpen,
    /// The `)` symbol
    #[token(")")]
    ParenClose,

    /// The `[` symbol
    #[token("[")]
    BracketOpen,
    /// The `]` symbol
    #[token("]")]
    BracketClose,

    /// The `:` symbol
    #[token(":")]
    Colon,

    /// The `,` symbol
    #[token(",")]
    Comma,

    /// A number literal
    #[regex(r"-?(0|([1-9][0-9]*))(\.[0-9]+)?([eE][-+]?[0-9]+)?")]
    #[token("-inf")]
    Number,

    /// A label or keyword
    #[regex(r"%?(?&label_word)(-(?&label_word))*")]
    LabelOrKeyword,

    /// A char literal
    #[regex(r#"'([^\\'\n]{1,4}|(?&char_escape))'"#, validate_char)]
    Char,

    /// A string literal
    #[regex(r#""([^\\"\n]|(?&char_escape))*""#)]
    String,

    /// A multi-line string literal
    #[token(r#"""""#, lex_multiline_string)]
    MultilineString,
}

impl Display for Token {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{self:?}")
    }
}

fn validate_char(lex: &mut Lexer) -> Result<(), Option<Span>> {
    let s = &lex.slice()[1..lex.slice().len() - 1];
    if s.starts_with('\\') || s.chars().count() == 1 {
        Ok(())
    } else {
        Err(Some(lex.span()))
    }
}

fn lex_multiline_string(lex: &mut Lexer) -> bool {
    if let Some(end) = lex.remainder().find(r#"""""#) {
        lex.bump(end + 3);
        true
    } else {
        false
    }
}

/// A WAVE keyword
#[derive(Clone, Copy, Debug, PartialEq)]
#[allow(missing_docs)]
pub enum Keyword {
    True,
    False,
    Some,
    None,
    Ok,
    Err,
    Inf,
    Nan,
}

impl Keyword {
    /// Returns any keyword exactly matching the given string.
    pub fn decode(raw_label: &str) -> Option<Self> {
        Some(match raw_label {
            "true" => Self::True,
            "false" => Self::False,
            "some" => Self::Some,
            "none" => Self::None,
            "ok" => Self::Ok,
            "err" => Self::Err,
            "inf" => Self::Inf,
            "nan" => Self::Nan,
            _ => return None,
        })
    }
}

impl Display for Keyword {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(match self {
            Keyword::True => "true",
            Keyword::False => "false",
            Keyword::Some => "some",
            Keyword::None => "none",
            Keyword::Ok => "ok",
            Keyword::Err => "err",
            Keyword::Inf => "inf",
            Keyword::Nan => "nan",
        })
    }
}