sqlite3_parser/dialect/
mod.rs

1//! SQLite dialect
2
3use bumpalo::Bump;
4use std::fmt::Formatter;
5use std::str;
6
7mod token;
8pub use token::TokenType;
9
10/// Token value (lexeme)
11#[derive(Clone, Copy)]
12pub struct Token<'i>(pub usize, pub &'i [u8], pub usize);
13
14pub(crate) fn sentinel(start: usize) -> Token<'static> {
15    Token(start, b"", start)
16}
17
18impl Token<'_> {
19    /// Access token value
20    pub fn unwrap(self, b: &Bump) -> &str {
21        from_bytes(self.1, b)
22    }
23}
24
25impl std::fmt::Debug for Token<'_> {
26    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
27        f.debug_tuple("Token").field(&self.1).finish()
28    }
29}
30
31impl TokenType {
32    // TODO try Cow<&'static, str> (Borrowed<&'static str> for keyword and Owned<String> for below),
33    // => Syntax error on keyword will be better
34    // => `from_token` will become unnecessary
35    pub(crate) fn to_token(self, start: usize, value: &[u8], end: usize) -> Token<'_> {
36        Token(start, value, end)
37    }
38}
39
40pub(crate) fn from_bytes<'bump>(bytes: &[u8], b: &'bump Bump) -> &'bump str {
41    b.alloc_str(str::from_utf8(bytes).unwrap()) // FIXME error handling
42}
43
44include!(concat!(env!("OUT_DIR"), "/keywords.rs"));
45pub(crate) const MAX_KEYWORD_LEN: usize = 17;
46
47/// Check if `word` is a keyword
48pub fn keyword_token(word: &[u8]) -> Option<TokenType> {
49    keywordCode(word)
50}
51
52pub(crate) fn is_identifier(name: &str) -> bool {
53    if name.is_empty() {
54        return false;
55    }
56    let bytes = name.as_bytes();
57    is_identifier_start(bytes[0])
58        && (bytes.len() == 1 || bytes[1..].iter().all(|b| is_identifier_continue(*b)))
59}
60
61pub(crate) fn is_identifier_start(b: u8) -> bool {
62    b.is_ascii_uppercase() || b == b'_' || b.is_ascii_lowercase() || b > b'\x7F'
63}
64
65pub(crate) fn is_identifier_continue(b: u8) -> bool {
66    b == b'$'
67        || b.is_ascii_digit()
68        || b.is_ascii_uppercase()
69        || b == b'_'
70        || b.is_ascii_lowercase()
71        || b > b'\x7F'
72}
73
74// keyword may become an identifier
75// see %fallback in parse.y
76pub(crate) fn from_token<'bump>(_ty: u16, value: Token, b: &'bump Bump) -> &'bump str {
77    from_bytes(value.1, b)
78}
79
80impl TokenType {
81    /// Return the associated string (mainly for testing)
82    pub const fn as_str(&self) -> Option<&'static str> {
83        use TokenType::*;
84        match self {
85            TK_ABORT => Some("ABORT"),
86            TK_ACTION => Some("ACTION"),
87            TK_ADD => Some("ADD"),
88            TK_AFTER => Some("AFTER"),
89            TK_ALL => Some("ALL"),
90            TK_ALTER => Some("ALTER"),
91            TK_ANALYZE => Some("ANALYZE"),
92            TK_ALWAYS => Some("ALWAYS"),
93            TK_AND => Some("AND"),
94            TK_AS => Some("AS"),
95            TK_ASC => Some("ASC"),
96            TK_ATTACH => Some("ATTACH"),
97            TK_AUTOINCR => Some("AUTOINCREMENT"),
98            TK_BEFORE => Some("BEFORE"),
99            TK_BEGIN => Some("BEGIN"),
100            TK_BETWEEN => Some("BETWEEN"),
101            TK_BY => Some("BY"),
102            TK_CASCADE => Some("CASCADE"),
103            TK_CASE => Some("CASE"),
104            TK_CAST => Some("CAST"),
105            TK_CHECK => Some("CHECK"),
106            TK_COLLATE => Some("COLLATE"),
107            TK_COLUMNKW => Some("COLUMN"),
108            TK_COMMIT => Some("COMMIT"),
109            TK_CONFLICT => Some("CONFLICT"),
110            TK_CONSTRAINT => Some("CONSTRAINT"),
111            TK_CREATE => Some("CREATE"),
112            TK_CURRENT => Some("CURRENT"),
113            TK_DATABASE => Some("DATABASE"),
114            TK_DEFAULT => Some("DEFAULT"),
115            TK_DEFERRABLE => Some("DEFERRABLE"),
116            TK_DEFERRED => Some("DEFERRED"),
117            TK_DELETE => Some("DELETE"),
118            TK_DESC => Some("DESC"),
119            TK_DETACH => Some("DETACH"),
120            TK_DISTINCT => Some("DISTINCT"),
121            TK_DO => Some("DO"),
122            TK_DROP => Some("DROP"),
123            TK_EACH => Some("EACH"),
124            TK_ELSE => Some("ELSE"),
125            TK_END => Some("END"),
126            TK_ESCAPE => Some("ESCAPE"),
127            TK_EXCEPT => Some("EXCEPT"),
128            TK_EXCLUDE => Some("EXCLUDE"),
129            TK_EXCLUSIVE => Some("EXCLUSIVE"),
130            TK_EXISTS => Some("EXISTS"),
131            TK_EXPLAIN => Some("EXPLAIN"),
132            TK_FAIL => Some("FAIL"),
133            TK_FILTER => Some("FILTER"),
134            TK_FIRST => Some("FIRST"),
135            TK_FOLLOWING => Some("FOLLOWING"),
136            TK_FOR => Some("FOR"),
137            TK_FOREIGN => Some("FOREIGN"),
138            TK_FROM => Some("FROM"),
139            TK_GENERATED => Some("GENERATED"),
140            TK_GROUP => Some("GROUP"),
141            TK_GROUPS => Some("GROUPS"),
142            TK_HAVING => Some("HAVING"),
143            TK_IF => Some("IF"),
144            TK_IGNORE => Some("IGNORE"),
145            TK_IMMEDIATE => Some("IMMEDIATE"),
146            TK_IN => Some("IN"),
147            TK_INDEX => Some("INDEX"),
148            TK_INDEXED => Some("INDEXED"),
149            TK_INITIALLY => Some("INITIALLY"),
150            TK_INSERT => Some("INSERT"),
151            TK_INSTEAD => Some("INSTEAD"),
152            TK_INTERSECT => Some("INTERSECT"),
153            TK_INTO => Some("INTO"),
154            TK_IS => Some("IS"),
155            TK_ISNULL => Some("ISNULL"),
156            TK_JOIN => Some("JOIN"),
157            TK_KEY => Some("KEY"),
158            TK_LAST => Some("LAST"),
159            TK_LIMIT => Some("LIMIT"),
160            TK_MATCH => Some("MATCH"),
161            TK_MATERIALIZED => Some("MATERIALIZED"),
162            TK_NO => Some("NO"),
163            TK_NOT => Some("NOT"),
164            TK_NOTHING => Some("NOTHING"),
165            TK_NOTNULL => Some("NOTNULL"),
166            TK_NULL => Some("NULL"),
167            TK_NULLS => Some("NULLS"),
168            TK_OF => Some("OF"),
169            TK_OFFSET => Some("OFFSET"),
170            TK_ON => Some("ON"),
171            TK_OR => Some("OR"),
172            TK_ORDER => Some("ORDER"),
173            TK_OTHERS => Some("OTHERS"),
174            TK_OVER => Some("OVER"),
175            TK_PARTITION => Some("PARTITION"),
176            TK_PLAN => Some("PLAN"),
177            TK_PRAGMA => Some("PRAGMA"),
178            TK_PRECEDING => Some("PRECEDING"),
179            TK_PRIMARY => Some("PRIMARY"),
180            TK_QUERY => Some("QUERY"),
181            TK_RAISE => Some("RAISE"),
182            TK_RANGE => Some("RANGE"),
183            TK_RECURSIVE => Some("RECURSIVE"),
184            TK_REFERENCES => Some("REFERENCES"),
185            TK_REINDEX => Some("REINDEX"),
186            TK_RELEASE => Some("RELEASE"),
187            TK_RENAME => Some("RENAME"),
188            TK_REPLACE => Some("REPLACE"),
189            TK_RESTRICT => Some("RESTRICT"),
190            TK_RETURNING => Some("RETURNING"),
191            TK_ROLLBACK => Some("ROLLBACK"),
192            TK_ROW => Some("ROW"),
193            TK_ROWS => Some("ROWS"),
194            TK_SAVEPOINT => Some("SAVEPOINT"),
195            TK_SELECT => Some("SELECT"),
196            TK_SET => Some("SET"),
197            TK_TABLE => Some("TABLE"),
198            TK_TEMP => Some("TEMP"), // or TEMPORARY
199            TK_TIES => Some("TIES"),
200            TK_THEN => Some("THEN"),
201            TK_TO => Some("TO"),
202            TK_TRANSACTION => Some("TRANSACTION"),
203            TK_TRIGGER => Some("TRIGGER"),
204            TK_UNBOUNDED => Some("UNBOUNDED"),
205            TK_UNION => Some("UNION"),
206            TK_UNIQUE => Some("UNIQUE"),
207            TK_UPDATE => Some("UPDATE"),
208            TK_USING => Some("USING"),
209            TK_VACUUM => Some("VACUUM"),
210            TK_VALUES => Some("VALUES"),
211            TK_VIEW => Some("VIEW"),
212            TK_VIRTUAL => Some("VIRTUAL"),
213            TK_WHEN => Some("WHEN"),
214            TK_WHERE => Some("WHERE"),
215            TK_WINDOW => Some("WINDOW"),
216            TK_WITH => Some("WITH"),
217            #[cfg(feature = "SQLITE_ENABLE_ORDERED_SET_AGGREGATES")]
218            TK_WITHIN => Some("WITHIN"),
219            TK_WITHOUT => Some("WITHOUT"),
220            TK_BITAND => Some("&"),
221            TK_BITNOT => Some("~"),
222            TK_BITOR => Some("|"),
223            TK_COMMA => Some(","),
224            TK_CONCAT => Some("||"),
225            TK_DOT => Some("."),
226            TK_EQ => Some("="), // or ==
227            TK_GT => Some(">"),
228            TK_GE => Some(">="),
229            TK_LP => Some("("),
230            TK_LSHIFT => Some("<<"),
231            TK_LE => Some("<="),
232            TK_LT => Some("<"),
233            TK_MINUS => Some("-"),
234            TK_NE => Some("<>"), // or !=
235            TK_PLUS => Some("+"),
236            TK_REM => Some("%"),
237            TK_RP => Some(")"),
238            TK_RSHIFT => Some(">>"),
239            TK_SEMI => Some(";"),
240            TK_SLASH => Some("/"),
241            TK_STAR => Some("*"),
242            _ => None,
243        }
244    }
245}
sqlite3_parser/dialect/mod.rs

sqlite3_parser/dialect/
mod.rs
