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
use text_scanner::{ext::CScannerExt, Scanner};

use crate::{impl_lexer_from_scanner, ScanToken, ScannerExt, TokenSpan};

// Reference: https://learn.microsoft.com/en-us/cpp/c-language/c-keywords?view=msvc-170#standard-c-keywords
#[rustfmt::skip]
const KEYWORDS: [&str; 46] = [
    "alignas", "alignof", "auto", "break", "case", "char", "const", "continue",
    "default", "do", "double", "else", "enum", "extern", "float", "for", "goto",
    "if", "inline", "int", "long", "register", "restrict", "return", "short",
    "signed", "sizeof", "static", "struct", "switch", "typedef", "union",
    "unsigned", "void", "volatile", "while", "_Alignas", "_Alignof", "_Atomic",
    "_Bool", "_Complex", "_Generic", "_Imaginary", "_Noreturn", "_Static_assert",
    "_Thread_local",
];

// Reference: https://learn.microsoft.com/en-us/cpp/c-language/c-keywords?view=msvc-170#microsoft-specific-c-keywords
#[rustfmt::skip]
const KEYWORDS_MS: [&str; 21] = [
    "__asm", "__based", "__cdecl", "__declspec", "__except", "__fastcall", "__finally",
    "__inline", "__int16", "__int32", "__int64", "__int8", "__leave", "__restrict",
    "__stdcall", "__try", "dllexport", "dllimport", "naked", "static_assert", "thread",
];

#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum CToken {
    Space,
    LineComment,
    BlockComment,
    Ident,
    Keyword,
    Char,
    String,
    Int,
    Float,
    Delim,
    Punct,
    /// Given valid C code, then this variant should never be encountered. If
    /// is is encountered, then check if an issue has already been submitted,
    /// otherwise please [submit an issue].
    ///
    /// [submit an issue]: https://github.com/vallentin/colorblast/issues
    Unknown,
}

impl ScanToken for CToken {
    fn scan_token<'text>(scanner: &mut Scanner<'text>) -> Option<(Self, TokenSpan<'text>)> {
        let (r, _s) = scanner.skip_whitespace();
        if !r.is_empty() {
            return Some((Self::Space, scanner.span(r)));
        }

        if let Ok((r, _s)) = scanner.scan_c_line_comment() {
            return Some((Self::LineComment, scanner.span(r)));
        } else if let Ok((r, _s)) = scanner.scan_c_block_comment() {
            return Some((Self::BlockComment, scanner.span(r)));
        }

        if let Ok((r, ident)) = scanner.scan_c_identifier() {
            let tok = if KEYWORDS.contains(&ident) || KEYWORDS_MS.contains(&ident) {
                Self::Keyword
            } else {
                Self::Ident
            };
            return Some((tok, scanner.span(r)));
        }

        if let Ok((r, _s)) = scanner.scan_c_char() {
            return Some((Self::Char, scanner.span(r)));
        } else if let Ok((r, _s)) = scanner.scan_c_string() {
            return Some((Self::String, scanner.span(r)));
        }

        if let Ok((r, _s)) = scanner.scan_c_float() {
            return Some((Self::Float, scanner.span(r)));
        } else if let Ok((r, _s)) = scanner
            .scan_c_int_hex()
            .or_else(|_| scanner.scan_c_int_oct())
            .or_else(|_| scanner.scan_c_int_dec())
        {
            return Some((Self::Int, scanner.span(r)));
        }

        if let Ok((r, _c)) = scanner.accept_char_any(&['{', '}', '[', ']', '(', ')']) {
            return Some((Self::Delim, scanner.span(r)));
        }

        // Reference: https://learn.microsoft.com/en-us/cpp/c-language/c-operators?view=msvc-170
        let res = scanner.scan_with(|scanner| {
            let (r, c) = scanner.next()?;
            match c {
                '=' => {
                    _ = scanner.accept_char_any(&['=', '>']);
                }
                '+' => {
                    _ = scanner.accept_char_any(&['+', '=']);
                }
                '-' => {
                    _ = scanner.accept_char_any(&['-', '=']);
                }
                '*' | '/' | '%' | '^' | '!' => {
                    _ = scanner.accept_char('=');
                }
                '&' => {
                    _ = scanner.accept_char_any(&['&', '=']);
                }
                '|' => {
                    _ = scanner.accept_char_any(&['|', '=']);
                }
                '<' => {
                    _ = scanner.accept_char('<');
                    _ = scanner.accept_char('=');
                }
                '>' => {
                    _ = scanner.accept_char('>');
                    _ = scanner.accept_char('=');
                }
                '.' => {
                    _ = scanner.scan_with(|scanner| {
                        scanner.accept_char('.')?;
                        scanner.accept_char('.')?;
                        Ok(())
                    });
                }
                '#' => {
                    _ = scanner.accept_char('#');
                }
                ',' | ';' | ':' | '?' | '~' => {}
                _ => return Err(scanner.ranged_text(r)),
            }
            Ok(())
        });
        if let Ok((r, _s)) = res {
            return Some((Self::Punct, scanner.span(r)));
        }

        let (r, _c) = scanner.next().ok()?;
        Some((Self::Unknown, scanner.span(r)))
    }
}

/// C lexer producing [`CToken`]s.
///
/// **Note:** Cloning `CLexer` is essentially a copy, as it just contains
/// a `&str` and a `usize` for its `cursor`. However, `Copy` is not
/// implemented, to avoid accidentally copying immutable `CLexer`s.
#[derive(Clone, Debug)]
pub struct CLexer<'text> {
    scanner: Scanner<'text>,
}

impl<'text> CLexer<'text> {
    #[inline]
    pub fn new(text: &'text str) -> Self {
        Self {
            scanner: Scanner::new(text),
        }
    }
}

impl_lexer_from_scanner!('text, CLexer<'text>, CToken, scanner);

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_c_lexer_spans() {
        // This intentionally uses Rust code as input, as it is
        // only testing that CLexer returns all characters
        let input = include_str!("../../../text-scanner/src/ext/rust.rs");
        let mut output = String::new();

        let lexer = CLexer::new(input);
        for (_tok, span) in lexer {
            output.push_str(span.as_str());
        }

        assert_eq!(input, output);
    }
}