Skip to main content

fsqlite_parser/
lexer.rs

1// bd-2tu6: §10.1 SQL Lexer
2//
3// Converts SQL text into a stream of tokens. Uses memchr for accelerated
4// string scanning. Tracks line/column for error reporting.
5
6use fsqlite_ast::Span;
7use fsqlite_types::limits::MAX_VARIABLE_NUMBER;
8use fsqlite_types::sync_primitives::Instant;
9use hashbrown::HashSet;
10use memchr::memchr;
11use std::sync::Arc;
12use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
13use tracing::Level;
14
15use crate::token::{Token, TokenKind};
16
17/// Histogram buckets for `fsqlite_tokenize_duration_seconds`.
18#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
19pub struct TokenizeDurationSecondsHistogram {
20    /// Duration <= 100 µs.
21    pub le_100us: u64,
22    /// Duration <= 250 µs.
23    pub le_250us: u64,
24    /// Duration <= 500 µs.
25    pub le_500us: u64,
26    /// Duration <= 1 ms.
27    pub le_1ms: u64,
28    /// Duration <= 5 ms.
29    pub le_5ms: u64,
30    /// Duration > 5 ms.
31    pub gt_5ms: u64,
32}
33
34/// Point-in-time tokenize metric snapshot.
35#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
36pub struct TokenizeMetricsSnapshot {
37    /// Monotonic token counter across all tokenize calls.
38    pub fsqlite_tokenize_tokens_total: u64,
39    /// Histogram buckets for tokenize runtime.
40    pub fsqlite_tokenize_duration_seconds: TokenizeDurationSecondsHistogram,
41    /// Total tokenize observations recorded in histogram.
42    pub fsqlite_tokenize_duration_seconds_count: u64,
43    /// Sum of tokenize durations in microseconds.
44    pub fsqlite_tokenize_duration_seconds_sum_micros: u64,
45}
46
47static FSQLITE_TOKENIZE_TOKENS_TOTAL: AtomicU64 = AtomicU64::new(0);
48static FSQLITE_TOKENIZE_DURATION_SECONDS_LE_100US: AtomicU64 = AtomicU64::new(0);
49static FSQLITE_TOKENIZE_DURATION_SECONDS_LE_250US: AtomicU64 = AtomicU64::new(0);
50static FSQLITE_TOKENIZE_DURATION_SECONDS_LE_500US: AtomicU64 = AtomicU64::new(0);
51static FSQLITE_TOKENIZE_DURATION_SECONDS_LE_1MS: AtomicU64 = AtomicU64::new(0);
52static FSQLITE_TOKENIZE_DURATION_SECONDS_LE_5MS: AtomicU64 = AtomicU64::new(0);
53static FSQLITE_TOKENIZE_DURATION_SECONDS_GT_5MS: AtomicU64 = AtomicU64::new(0);
54static FSQLITE_TOKENIZE_DURATION_SECONDS_COUNT: AtomicU64 = AtomicU64::new(0);
55static FSQLITE_TOKENIZE_DURATION_SECONDS_SUM_MICROS: AtomicU64 = AtomicU64::new(0);
56static FSQLITE_TOKENIZE_METRICS_ENABLED: AtomicBool = AtomicBool::new(false);
57
58fn saturating_u64_from_usize(value: usize) -> u64 {
59    u64::try_from(value).unwrap_or(u64::MAX)
60}
61
62fn saturating_u64_from_u128(value: u128) -> u64 {
63    u64::try_from(value).unwrap_or(u64::MAX)
64}
65
66fn record_tokenize_metrics(token_count: usize, elapsed_micros: u64) {
67    FSQLITE_TOKENIZE_TOKENS_TOTAL
68        .fetch_add(saturating_u64_from_usize(token_count), Ordering::Relaxed);
69    FSQLITE_TOKENIZE_DURATION_SECONDS_COUNT.fetch_add(1, Ordering::Relaxed);
70    FSQLITE_TOKENIZE_DURATION_SECONDS_SUM_MICROS.fetch_add(elapsed_micros, Ordering::Relaxed);
71
72    let bucket = match elapsed_micros {
73        0..=100 => &FSQLITE_TOKENIZE_DURATION_SECONDS_LE_100US,
74        101..=250 => &FSQLITE_TOKENIZE_DURATION_SECONDS_LE_250US,
75        251..=500 => &FSQLITE_TOKENIZE_DURATION_SECONDS_LE_500US,
76        501..=1_000 => &FSQLITE_TOKENIZE_DURATION_SECONDS_LE_1MS,
77        1_001..=5_000 => &FSQLITE_TOKENIZE_DURATION_SECONDS_LE_5MS,
78        _ => &FSQLITE_TOKENIZE_DURATION_SECONDS_GT_5MS,
79    };
80    bucket.fetch_add(1, Ordering::Relaxed);
81}
82
83/// Point-in-time snapshot of tokenize metrics.
84#[must_use]
85pub fn tokenize_metrics_snapshot() -> TokenizeMetricsSnapshot {
86    TokenizeMetricsSnapshot {
87        fsqlite_tokenize_tokens_total: FSQLITE_TOKENIZE_TOKENS_TOTAL.load(Ordering::Relaxed),
88        fsqlite_tokenize_duration_seconds: TokenizeDurationSecondsHistogram {
89            le_100us: FSQLITE_TOKENIZE_DURATION_SECONDS_LE_100US.load(Ordering::Relaxed),
90            le_250us: FSQLITE_TOKENIZE_DURATION_SECONDS_LE_250US.load(Ordering::Relaxed),
91            le_500us: FSQLITE_TOKENIZE_DURATION_SECONDS_LE_500US.load(Ordering::Relaxed),
92            le_1ms: FSQLITE_TOKENIZE_DURATION_SECONDS_LE_1MS.load(Ordering::Relaxed),
93            le_5ms: FSQLITE_TOKENIZE_DURATION_SECONDS_LE_5MS.load(Ordering::Relaxed),
94            gt_5ms: FSQLITE_TOKENIZE_DURATION_SECONDS_GT_5MS.load(Ordering::Relaxed),
95        },
96        fsqlite_tokenize_duration_seconds_count: FSQLITE_TOKENIZE_DURATION_SECONDS_COUNT
97            .load(Ordering::Relaxed),
98        fsqlite_tokenize_duration_seconds_sum_micros: FSQLITE_TOKENIZE_DURATION_SECONDS_SUM_MICROS
99            .load(Ordering::Relaxed),
100    }
101}
102
103/// Enable or disable tokenize metrics collection on the hot path.
104pub fn set_tokenize_metrics_enabled(enabled: bool) {
105    FSQLITE_TOKENIZE_METRICS_ENABLED.store(enabled, Ordering::Relaxed);
106}
107
108/// Return whether tokenize metrics collection is enabled.
109#[must_use]
110pub fn tokenize_metrics_enabled() -> bool {
111    FSQLITE_TOKENIZE_METRICS_ENABLED.load(Ordering::Relaxed)
112}
113
114/// Reset tokenize metrics (used by tests/diagnostics).
115pub fn reset_tokenize_metrics() {
116    FSQLITE_TOKENIZE_TOKENS_TOTAL.store(0, Ordering::Relaxed);
117    FSQLITE_TOKENIZE_DURATION_SECONDS_LE_100US.store(0, Ordering::Relaxed);
118    FSQLITE_TOKENIZE_DURATION_SECONDS_LE_250US.store(0, Ordering::Relaxed);
119    FSQLITE_TOKENIZE_DURATION_SECONDS_LE_500US.store(0, Ordering::Relaxed);
120    FSQLITE_TOKENIZE_DURATION_SECONDS_LE_1MS.store(0, Ordering::Relaxed);
121    FSQLITE_TOKENIZE_DURATION_SECONDS_LE_5MS.store(0, Ordering::Relaxed);
122    FSQLITE_TOKENIZE_DURATION_SECONDS_GT_5MS.store(0, Ordering::Relaxed);
123    FSQLITE_TOKENIZE_DURATION_SECONDS_COUNT.store(0, Ordering::Relaxed);
124    FSQLITE_TOKENIZE_DURATION_SECONDS_SUM_MICROS.store(0, Ordering::Relaxed);
125}
126
127/// Bound retained identifier interners so scratch reuse does not grow without limit.
128const MAX_RETAINED_IDENTIFIER_INTERNER_ENTRIES: usize = 256;
129const MAX_RETAINED_IDENTIFIER_INTERNER_BYTES: usize = 16 * 1024;
130
131thread_local! {
132    /// bd-5310l benchmark knob: force `retained_bytes` to recompute via the O(entries) fold instead
133    /// of the incremental running sum, so an A/B harness can measure the fold cost within one build.
134    /// Off by default; zero cost when off.
135    static FSQLITE_FORCE_INTERNER_SCAN_BENCH: std::cell::Cell<bool> =
136        const { std::cell::Cell::new(false) };
137}
138
139/// Force the O(entries) `retained_bytes` fold on the current thread (bd-5310l bench A/B only).
140///
141/// When `true`, the interner recomputes its retained byte count by scanning every entry instead of
142/// using the incrementally-maintained sum, so the two can be compared in one process.
143pub fn set_force_interner_scan_bench(enabled: bool) {
144    FSQLITE_FORCE_INTERNER_SCAN_BENCH.with(|c| c.set(enabled));
145}
146
147/// SQL lexer that produces a stream of tokens from source text.
148#[derive(Debug, Default)]
149pub(crate) struct IdentifierInterner {
150    values: HashSet<Arc<str>>,
151    /// bd-5310l: running sum of `value.len()` over all interned entries, kept incrementally so
152    /// `retained_bytes` (called on EVERY parse by `prepare_for_next_parse`) is O(1) instead of an
153    /// O(entries) fold. Entries are only added (`intern`) or bulk-cleared (`reset`), so the running
154    /// sum stays exactly equal to the fold. Byte-identical: only the threshold computation changes.
155    interned_bytes: usize,
156}
157
158impl IdentifierInterner {
159    fn intern(&mut self, value: &str) -> Arc<str> {
160        if let Some(existing) = self.values.get(value) {
161            return Arc::clone(existing);
162        }
163
164        let interned: Arc<str> = Arc::from(value);
165        let inserted = Arc::clone(&interned);
166        self.values.insert(interned);
167        self.interned_bytes = self.interned_bytes.saturating_add(value.len());
168        inserted
169    }
170
171    pub(crate) fn reset(&mut self) {
172        self.values = HashSet::new();
173        self.interned_bytes = 0;
174    }
175
176    pub(crate) fn retained_bytes(&self) -> usize {
177        // bd-5310l: use the incrementally-maintained `interned_bytes` (O(1)) rather than folding
178        // over every entry (O(entries)) on the per-parse hot path. A bench force-flag reinstates the
179        // fold so the two can be A/B-compared within one build.
180        let interned_value_bytes = if FSQLITE_FORCE_INTERNER_SCAN_BENCH.with(std::cell::Cell::get) {
181            self.values
182                .iter()
183                .fold(0usize, |sum, value| sum.saturating_add(value.len()))
184        } else {
185            self.interned_bytes
186        };
187        self.values
188            .capacity()
189            .saturating_mul(std::mem::size_of::<Arc<str>>())
190            .saturating_add(interned_value_bytes)
191    }
192
193    pub(crate) fn prepare_for_next_parse(&mut self) {
194        if self.values.len() > MAX_RETAINED_IDENTIFIER_INTERNER_ENTRIES
195            || self.retained_bytes() > MAX_RETAINED_IDENTIFIER_INTERNER_BYTES
196        {
197            self.reset();
198        }
199    }
200
201    #[cfg(test)]
202    pub(crate) fn is_empty(&self) -> bool {
203        self.values.is_empty()
204    }
205
206    #[cfg(test)]
207    pub(crate) fn len(&self) -> usize {
208        self.values.len()
209    }
210}
211
212/// SQL lexer that produces a stream of tokens from source text.
213pub struct Lexer<'a> {
214    /// The source bytes (UTF-8).
215    src: &'a [u8],
216    /// Current byte offset into src.
217    pos: usize,
218    /// Current line number (1-based).
219    line: u32,
220    /// Current column number (1-based).
221    col: u32,
222    /// Whether TRACE character-level logging is enabled.
223    trace_chars: bool,
224    /// Per-parse identifier interner reused by scratch callers.
225    interner: IdentifierInterner,
226}
227
228impl<'a> Lexer<'a> {
229    fn log_token(token: &Token) {
230        tracing::debug!(
231            target: "fsqlite.parse",
232            token = ?token.kind,
233            start = token.span.start,
234            end = token.span.end,
235            line = token.line,
236            col = token.col,
237            "tokenized token"
238        );
239    }
240
241    /// Create a new lexer for the given SQL source text.
242    #[must_use]
243    pub fn new(source: &'a str) -> Self {
244        Self {
245            src: source.as_bytes(),
246            pos: 0,
247            line: 1,
248            col: 1,
249            trace_chars: tracing::enabled!(target: "fsqlite.parse", Level::TRACE),
250            interner: IdentifierInterner::default(),
251        }
252    }
253
254    /// Tokenize the entire input into a Vec of tokens.
255    #[must_use]
256    pub fn tokenize(source: &'a str) -> Vec<Token> {
257        let mut tokens = Vec::new();
258        Self::tokenize_into(source, &mut tokens);
259        tokens
260    }
261
262    fn new_with_interner(source: &'a str, interner: IdentifierInterner) -> Self {
263        Self {
264            src: source.as_bytes(),
265            pos: 0,
266            line: 1,
267            col: 1,
268            trace_chars: tracing::enabled!(target: "fsqlite.parse", Level::TRACE),
269            interner,
270        }
271    }
272
273    /// Tokenize the entire input into a caller-owned buffer.
274    ///
275    /// This preserves the buffer's existing heap allocation across repeated
276    /// parses so statement-level callers can treat token storage as lookaside
277    /// scratch instead of rebuilding a fresh `Vec<Token>` on every miss.
278    pub fn tokenize_into(source: &'a str, tokens: &mut Vec<Token>) {
279        let mut interner = IdentifierInterner::default();
280        Self::tokenize_into_with_interner(source, tokens, &mut interner);
281    }
282
283    pub(crate) fn tokenize_into_with_interner(
284        source: &'a str,
285        tokens: &mut Vec<Token>,
286        interner: &mut IdentifierInterner,
287    ) {
288        let input_bytes = source.len();
289        let collect_tokenize_metrics = tokenize_metrics_enabled();
290        let trace_tokenize = tracing::enabled!(target: "fsqlite.parse", Level::TRACE);
291        let span = trace_tokenize.then(|| {
292            tracing::span!(
293                target: "fsqlite.parse",
294                Level::TRACE,
295                "tokenize",
296                token_count = tracing::field::Empty,
297                input_bytes,
298                elapsed_us = tracing::field::Empty,
299            )
300        });
301        let _guard = span.as_ref().map(|span| span.enter());
302        let started = (collect_tokenize_metrics || trace_tokenize).then(Instant::now);
303
304        let mut lexer = Self::new_with_interner(source, std::mem::take(interner));
305        let target_capacity = input_bytes / 4 + 1;
306        tokens.clear();
307        if target_capacity > tokens.capacity() {
308            tokens.reserve(target_capacity - tokens.capacity());
309        }
310        loop {
311            let tok = lexer.next_token();
312            let is_eof = tok.kind == TokenKind::Eof;
313            tokens.push(tok);
314            if is_eof {
315                break;
316            }
317        }
318
319        *interner = lexer.interner;
320
321        if let Some(started) = started {
322            let elapsed_us = saturating_u64_from_u128(started.elapsed().as_micros());
323            if let Some(span) = span.as_ref() {
324                span.record("token_count", saturating_u64_from_usize(tokens.len()));
325                span.record("elapsed_us", elapsed_us);
326            }
327            if collect_tokenize_metrics {
328                record_tokenize_metrics(tokens.len(), elapsed_us);
329            }
330        }
331    }
332
333    /// Expose tokenize metrics as a snapshot.
334    #[must_use]
335    pub fn metrics_snapshot() -> TokenizeMetricsSnapshot {
336        tokenize_metrics_snapshot()
337    }
338
339    /// Reset tokenize metrics.
340    pub fn reset_metrics() {
341        reset_tokenize_metrics();
342    }
343
344    /// Produce the next token.
345    pub fn next_token(&mut self) -> Token {
346        self.skip_whitespace_and_comments();
347
348        if self.pos >= self.src.len() {
349            let token = self.make_token(TokenKind::Eof, self.pos, self.pos);
350            Self::log_token(&token);
351            return token;
352        }
353
354        let start = self.pos;
355        let start_line = self.line;
356        let start_col = self.col;
357        let ch = self.src[self.pos];
358
359        let kind = match ch {
360            // String literal (single-quoted)
361            b'\'' => self.lex_string(),
362
363            // Double-quoted identifier
364            b'"' => self.lex_double_quoted_id(),
365
366            // Backtick-quoted identifier
367            b'`' => self.lex_backtick_id(),
368
369            // Bracket-quoted identifier
370            b'[' => self.lex_bracket_id(),
371
372            // Blob literal or hex
373            b'X' | b'x' if self.peek_at(1) == Some(b'\'') => self.lex_blob(),
374
375            // Numbers
376            b'0'..=b'9' => self.lex_number(),
377            b'.' if self.peek_at(1).is_some_and(|c| c.is_ascii_digit()) => self.lex_number(),
378
379            // Identifiers and keywords
380            b'a'..=b'z' | b'A'..=b'Z' | b'_' | 0x80..=0xFF => self.lex_identifier(),
381
382            // Bind parameters
383            b'?' => self.lex_question(),
384            b':' => self.lex_colon_param(),
385            b'@' => self.lex_at_param(),
386            b'$' => self.lex_dollar_param(),
387
388            // Operators and punctuation
389            b'+' => {
390                self.advance();
391                TokenKind::Plus
392            }
393            b'*' => {
394                self.advance();
395                TokenKind::Star
396            }
397            b'/' => {
398                self.advance();
399                TokenKind::Slash
400            }
401            b'%' => {
402                self.advance();
403                TokenKind::Percent
404            }
405            b'&' => {
406                self.advance();
407                TokenKind::Ampersand
408            }
409            b'~' => {
410                self.advance();
411                TokenKind::Tilde
412            }
413            b',' => {
414                self.advance();
415                TokenKind::Comma
416            }
417            b';' => {
418                self.advance();
419                TokenKind::Semicolon
420            }
421            b'(' => {
422                self.advance();
423                TokenKind::LeftParen
424            }
425            b')' => {
426                self.advance();
427                TokenKind::RightParen
428            }
429            b'.' => {
430                self.advance();
431                TokenKind::Dot
432            }
433
434            // Multi-character operators
435            b'-' => self.lex_minus_or_arrow(),
436            b'<' => self.lex_lt(),
437            b'>' => self.lex_gt(),
438            b'=' => self.lex_eq(),
439            b'!' => self.lex_bang(),
440            b'|' => self.lex_pipe(),
441
442            _ => {
443                self.advance();
444                let s = String::from_utf8_lossy(&self.src[start..self.pos]).into_owned();
445                TokenKind::Error(format!("unexpected character: {s}"))
446            }
447        };
448
449        let token = Token {
450            kind,
451            #[allow(clippy::cast_possible_truncation)]
452            span: Span::new(start as u32, self.pos as u32),
453            line: start_line,
454            col: start_col,
455        };
456
457        Self::log_token(&token);
458        token
459    }
460
461    // -----------------------------------------------------------------------
462    // Helpers
463    // -----------------------------------------------------------------------
464
465    #[allow(clippy::cast_possible_truncation)]
466    fn advance_by(&mut self, n: usize) {
467        if n == 0 {
468            return;
469        }
470        let end = self.pos + n;
471        let slice = &self.src[self.pos..end];
472        #[allow(clippy::naive_bytecount)]
473        let newlines = slice.iter().filter(|&&b| b == b'\n').count();
474        if newlines > 0 {
475            self.line += newlines as u32;
476            let last_nl = slice.iter().rposition(|&b| b == b'\n').unwrap_or(0);
477            self.col = (n - last_nl) as u32;
478        } else {
479            self.col += n as u32;
480        }
481        self.pos = end;
482    }
483
484    fn advance(&mut self) -> u8 {
485        let pos = self.pos;
486        let line = self.line;
487        let col = self.col;
488        let ch = self.src[self.pos];
489        self.pos += 1;
490        if ch == b'\n' {
491            self.line += 1;
492            self.col = 1;
493        } else {
494            self.col += 1;
495        }
496        if self.trace_chars {
497            tracing::trace!(
498                target: "fsqlite.parse",
499                byte = ch,
500                pos,
501                line,
502                col,
503                "tokenize char"
504            );
505        }
506        ch
507    }
508
509    fn peek(&self) -> Option<u8> {
510        self.src.get(self.pos).copied()
511    }
512
513    fn peek_at(&self, offset: usize) -> Option<u8> {
514        self.src.get(self.pos + offset).copied()
515    }
516
517    #[allow(clippy::cast_possible_truncation)]
518    fn make_token(&self, kind: TokenKind, start: usize, end: usize) -> Token {
519        Token {
520            kind,
521            span: Span::new(start as u32, end as u32),
522            line: self.line,
523            col: self.col,
524        }
525    }
526
527    /// Skip whitespace, line comments (`--`), and block comments (`/* */`).
528    fn skip_whitespace_and_comments(&mut self) {
529        loop {
530            // Skip whitespace
531            let mut ws_len = 0;
532            while self.pos + ws_len < self.src.len()
533                && self.src[self.pos + ws_len].is_ascii_whitespace()
534            {
535                ws_len += 1;
536            }
537            if ws_len > 0 {
538                self.advance_by(ws_len);
539            }
540
541            if self.pos >= self.src.len() {
542                break;
543            }
544
545            // Line comment: `-- ...`
546            if self.src[self.pos] == b'-' && self.peek_at(1) == Some(b'-') {
547                self.advance(); // skip -
548                self.advance(); // skip -
549                while self.pos < self.src.len() && self.src[self.pos] != b'\n' {
550                    self.advance();
551                }
552                continue;
553            }
554
555            // Block comment: `/* ... */` (SQLite does NOT support nesting)
556            if self.src[self.pos] == b'/' && self.peek_at(1) == Some(b'*') {
557                self.advance(); // skip /
558                self.advance(); // skip *
559                let closed = loop {
560                    if self.pos >= self.src.len() {
561                        break false;
562                    }
563                    if self.src[self.pos] == b'*' && self.peek_at(1) == Some(b'/') {
564                        self.advance();
565                        self.advance();
566                        break true;
567                    }
568                    self.advance();
569                };
570                if !closed {
571                    // Unclosed block comment consumes to EOF
572                    self.pos = self.src.len();
573                }
574                continue;
575            }
576
577            break;
578        }
579    }
580
581    // -----------------------------------------------------------------------
582    // Literal tokenizers
583    // -----------------------------------------------------------------------
584
585    fn lex_string(&mut self) -> TokenKind {
586        let start = self.pos;
587        self.advance(); // skip opening quote
588
589        let mut value = String::new();
590        loop {
591            // Use memchr to find the next single quote quickly
592            let remaining = &self.src[self.pos..];
593            if let Some(offset) = memchr(b'\'', remaining) {
594                // Append bytes up to the quote
595                value.push_str(&String::from_utf8_lossy(
596                    &self.src[self.pos..self.pos + offset],
597                ));
598                // Advance past the accumulated bytes and the quote
599                self.advance_by(offset);
600                self.advance(); // the quote itself
601
602                // Check for escaped quote ('')
603                if self.peek() == Some(b'\'') {
604                    value.push('\'');
605                    self.advance();
606                } else {
607                    return TokenKind::String(value);
608                }
609            } else {
610                // Unterminated string
611                self.pos = self.src.len();
612                return TokenKind::Error(format!(
613                    "unrecognized token: \"{}\"",
614                    String::from_utf8_lossy(&self.src[start..self.pos])
615                ));
616            }
617        }
618    }
619
620    /// Lex a double-quoted identifier. Sets the EP_DblQuoted flag.
621    fn lex_double_quoted_id(&mut self) -> TokenKind {
622        let start = self.pos;
623        self.advance(); // skip opening "
624
625        let mut value = String::new();
626        loop {
627            let remaining = &self.src[self.pos..];
628            if let Some(offset) = memchr(b'"', remaining) {
629                value.push_str(&String::from_utf8_lossy(
630                    &self.src[self.pos..self.pos + offset],
631                ));
632                self.advance_by(offset);
633                self.advance(); // the quote
634
635                // Doubled-quote escape: "" -> "
636                if self.peek() == Some(b'"') {
637                    value.push('"');
638                    self.advance();
639                } else {
640                    return TokenKind::QuotedId(self.interner.intern(&value), true);
641                }
642            } else {
643                self.pos = self.src.len();
644                return TokenKind::Error(format!(
645                    "unrecognized token: \"{}\"",
646                    String::from_utf8_lossy(&self.src[start..self.pos])
647                ));
648            }
649        }
650    }
651
652    /// Lex a backtick-quoted identifier.
653    fn lex_backtick_id(&mut self) -> TokenKind {
654        let start = self.pos;
655        self.advance(); // skip `
656
657        let mut value = String::new();
658        loop {
659            let remaining = &self.src[self.pos..];
660            if let Some(offset) = memchr(b'`', remaining) {
661                value.push_str(&String::from_utf8_lossy(
662                    &self.src[self.pos..self.pos + offset],
663                ));
664                self.advance_by(offset);
665                self.advance(); // the backtick
666
667                if self.peek() == Some(b'`') {
668                    value.push('`');
669                    self.advance();
670                } else {
671                    return TokenKind::QuotedId(self.interner.intern(&value), false);
672                }
673            } else {
674                self.pos = self.src.len();
675                return TokenKind::Error(format!(
676                    "unrecognized token: \"{}\"",
677                    String::from_utf8_lossy(&self.src[start..self.pos])
678                ));
679            }
680        }
681    }
682
683    /// Lex a bracket-quoted identifier `[name]`.
684    fn lex_bracket_id(&mut self) -> TokenKind {
685        let start = self.pos;
686        self.advance(); // skip [
687
688        let mut value = String::new();
689        let remaining = &self.src[self.pos..];
690        if let Some(offset) = memchr(b']', remaining) {
691            value.push_str(&String::from_utf8_lossy(
692                &self.src[self.pos..self.pos + offset],
693            ));
694            self.advance_by(offset);
695            self.advance(); // skip ]
696            TokenKind::QuotedId(self.interner.intern(&value), false)
697        } else {
698            self.pos = self.src.len();
699            TokenKind::Error(format!(
700                "unrecognized token: \"{}\"",
701                String::from_utf8_lossy(&self.src[start..self.pos])
702            ))
703        }
704    }
705
706    /// Lex a blob literal `X'...'` / `x'...'`.
707    fn lex_blob(&mut self) -> TokenKind {
708        let start = self.pos;
709        self.advance(); // skip X/x
710        self.advance(); // skip '
711
712        let hex_start = self.pos;
713        let remaining = &self.src[self.pos..];
714        if let Some(offset) = memchr(b'\'', remaining) {
715            let hex_bytes = &self.src[hex_start..hex_start + offset];
716            self.advance_by(offset);
717            self.advance(); // skip closing '
718
719            // Validate hex content
720            if !hex_bytes.len().is_multiple_of(2) {
721                // SQLite reports a malformed blob literal as an "unrecognized
722                // token" with the full offending text (from `x'` through the
723                // closing quote), not an internal byte-offset diagnostic.
724                // bd-errmsg-parity-batch3-3brmm.
725                return TokenKind::Error(format!(
726                    "unrecognized token: \"{}\"",
727                    String::from_utf8_lossy(&self.src[start..self.pos])
728                ));
729            }
730
731            // Work directly on raw bytes to avoid panics from
732            // string-slicing multi-byte UTF-8 sequences.
733            let mut bytes = Vec::with_capacity(hex_bytes.len() / 2);
734            for &[hi, lo] in hex_bytes.as_chunks::<2>().0 {
735                let hi = hex_digit(hi);
736                let lo = hex_digit(lo);
737                match (hi, lo) {
738                    (Some(h), Some(l)) => bytes.push((h << 4) | l),
739                    _ => {
740                        // Non-hex content in a blob literal: SQLite reports the
741                        // whole `x'...'` token as unrecognized, not a byte offset.
742                        return TokenKind::Error(format!(
743                            "unrecognized token: \"{}\"",
744                            String::from_utf8_lossy(&self.src[start..self.pos])
745                        ));
746                    }
747                }
748            }
749            TokenKind::Blob(bytes)
750        } else {
751            self.pos = self.src.len();
752            TokenKind::Error(format!(
753                "unrecognized token: \"{}\"",
754                String::from_utf8_lossy(&self.src[start..self.pos])
755            ))
756        }
757    }
758
759    /// Lex a number: integer, hex integer, or float.
760    fn lex_number(&mut self) -> TokenKind {
761        let start = self.pos;
762
763        // Check for hex prefix
764        if self.src[self.pos] == b'0' && self.peek_at(1).is_some_and(|c| c == b'x' || c == b'X') {
765            self.advance(); // 0
766            self.advance(); // x
767            let hex_start = self.pos;
768            // Consume hex digits, allowing a single `_` digit separator that is
769            // surrounded on both sides by a hex digit (SQLite 3.46+ digit
770            // separators). `0x_1F`, `0x1__F`, and a trailing `0x1F_` are
771            // rejected because the underscore is not between two hex digits.
772            while self.pos < self.src.len() {
773                let c = self.src[self.pos];
774                let is_separator = c == b'_'
775                    && self.pos > hex_start
776                    && self.src[self.pos - 1].is_ascii_hexdigit()
777                    && self.peek_at(1).is_some_and(|n| n.is_ascii_hexdigit());
778                if c.is_ascii_hexdigit() || is_separator {
779                    self.advance();
780                } else {
781                    break;
782                }
783            }
784            if self.pos == hex_start {
785                // `0x`/`0X` with no hex digits — whether bare (`0x`) or followed by
786                // non-hex identifier characters (`0xGG`) — is an unrecognized token
787                // in SQLite, reported with the FULL offending text, not an internal
788                // "empty hex literal". Consume any trailing identifier characters so
789                // the token text matches stock. bd-errmsg-parity-batch3-3brmm.
790                while self.pos < self.src.len()
791                    && (self.src[self.pos].is_ascii_alphanumeric() || self.src[self.pos] == b'_')
792                {
793                    self.advance();
794                }
795                let err_text = String::from_utf8_lossy(&self.src[start..self.pos]);
796                return TokenKind::Error(format!("unrecognized token: \"{err_text}\""));
797            }
798            // A hex literal cannot be immediately followed by an alphanumeric or
799            // `_` (e.g. `0x1F_` or `0xFFg`) — that is an unrecognized token, the
800            // same rule the decimal path enforces below.
801            if self
802                .peek()
803                .is_some_and(|n| n.is_ascii_alphanumeric() || n == b'_')
804            {
805                let err_start = start;
806                while self.pos < self.src.len()
807                    && (self.src[self.pos].is_ascii_alphanumeric() || self.src[self.pos] == b'_')
808                {
809                    self.advance();
810                }
811                let err_text = String::from_utf8_lossy(&self.src[err_start..self.pos]);
812                return TokenKind::Error(format!("unrecognized token: \"{err_text}\""));
813            }
814            let hex_str = String::from_utf8_lossy(&self.src[hex_start..self.pos]).replace('_', "");
815            // Strip leading zeros then check significant digit count,
816            // matching C SQLite's sqlite3DecOrHexToI64 which rejects
817            // hex literals with >16 significant digits.
818            let significant = hex_str.trim_start_matches('0');
819            if significant.len() > 16 {
820                return TokenKind::Error(format!("hex literal out of range at byte {start}"));
821            }
822            let parse_str = if significant.is_empty() {
823                "0"
824            } else {
825                significant
826            };
827            // Parse as u64 and bitwise-cast to i64 — matching C SQLite's
828            // sqlite3DecOrHexToI64 which uses memcpy(pOut, &u, 8).
829            return match u64::from_str_radix(parse_str, 16) {
830                Ok(v) => {
831                    #[allow(clippy::cast_possible_wrap)]
832                    let i = v as i64;
833                    TokenKind::Integer(i)
834                }
835                Err(_) => TokenKind::Error(format!("hex literal out of range at byte {start}")),
836            };
837        }
838
839        // Decimal integer or float
840        let mut is_float = false;
841
842        // Integer part (may be empty for `.5` style). Allow `_` digit
843        // separators that are surrounded on both sides by a decimal digit.
844        self.consume_decimal_digit_run();
845
846        // Helper to check if the current position (+ offset) starts a valid exponent.
847        let is_valid_exponent = |lexer: &Self, mut offset: usize| -> bool {
848            if let Some(c) = lexer.peek_at(offset)
849                && (c == b'e' || c == b'E')
850            {
851                offset += 1;
852                if let Some(s) = lexer.peek_at(offset)
853                    && (s == b'+' || s == b'-')
854                {
855                    offset += 1;
856                }
857                if let Some(d) = lexer.peek_at(offset) {
858                    return d.is_ascii_digit();
859                }
860            }
861            false
862        };
863
864        // Fractional part
865        if self.pos < self.src.len()
866            && self.src[self.pos] == b'.'
867            && (self.peek_at(1).is_some_and(|c| c.is_ascii_digit()) || is_valid_exponent(self, 1))
868        {
869            is_float = true;
870            self.advance(); // skip dot
871            self.consume_decimal_digit_run();
872        } else if self.pos < self.src.len()
873            && self.src[self.pos] == b'.'
874            && start < self.pos // we had digits before the dot
875            && !self.peek_at(1).is_some_and(|c| c.is_ascii_alphanumeric() || c == b'_')
876        {
877            // e.g. `123.` with nothing meaningful after -- still a float
878            is_float = true;
879            self.advance(); // skip dot
880        }
881
882        // Handle case where input starts with '.'
883        if self.src[start] == b'.' {
884            is_float = true;
885        }
886
887        // Exponent
888        if is_valid_exponent(self, 0) {
889            is_float = true;
890            self.advance(); // skip e/E
891            if self.pos < self.src.len()
892                && (self.src[self.pos] == b'+' || self.src[self.pos] == b'-')
893            {
894                self.advance();
895            }
896            self.consume_decimal_digit_run();
897        }
898
899        // SQLite strictness: a number cannot be immediately followed by an alphabetical character or underscore.
900        // Doing so produces an "unrecognized token" error.
901        if let Some(c) = self.peek()
902            && (c.is_ascii_alphabetic()
903                || c == b'_'
904                || (c == b'.'
905                    && self
906                        .peek_at(1)
907                        .is_some_and(|n| n.is_ascii_alphabetic() || n == b'_')))
908        {
909            let err_start = start;
910            while self.pos < self.src.len() {
911                let ch = self.src[self.pos];
912                if ch.is_ascii_alphanumeric() || ch == b'_' || ch == b'.' {
913                    self.advance();
914                } else {
915                    break;
916                }
917            }
918            let err_text = String::from_utf8_lossy(&self.src[err_start..self.pos]);
919            return TokenKind::Error(format!("unrecognized token: \"{err_text}\""));
920        }
921
922        let text_raw = String::from_utf8_lossy(&self.src[start..self.pos]);
923        // Strip `_` digit separators before numeric parsing; they were only
924        // consumed when validly placed between two digits above.
925        let text: std::borrow::Cow<'_, str> = if text_raw.as_ref().contains('_') {
926            std::borrow::Cow::Owned(text_raw.replace('_', ""))
927        } else {
928            text_raw
929        };
930        if is_float {
931            // Overflowing literals (e.g. 9e999) become ±Infinity, exactly like
932            // C SQLite's text-to-real conversion; do NOT clamp to f64::MAX.
933            match text.parse::<f64>() {
934                Ok(v) => TokenKind::Float(v),
935                Err(_) => {
936                    // Rust's f64 parser rejects `.e4` but SQLite accepts it as 0.0.
937                    let mut text_fixed = text.clone().into_owned();
938                    if text_fixed.starts_with(".e") || text_fixed.starts_with(".E") {
939                        text_fixed.insert(0, '0');
940                    }
941                    match text_fixed.parse::<f64>() {
942                        Ok(v) => TokenKind::Float(v),
943                        Err(_) => TokenKind::Error(format!("invalid float: {text}")),
944                    }
945                }
946            }
947        } else {
948            match text.parse::<i64>() {
949                Ok(v) => TokenKind::Integer(v),
950                Err(_) => {
951                    // SQLite promotes oversized integers to REAL. We emit a special
952                    // token to allow the parser to fold `-9223372036854775808` correctly.
953                    TokenKind::OversizedInt(text.into_owned())
954                }
955            }
956        }
957    }
958
959    /// Consume a run of decimal digits, allowing single `_` digit separators
960    /// (SQLite 3.46+) that are surrounded on both sides by a decimal digit. An
961    /// underscore that is leading, trailing, doubled, or adjacent to a non-digit
962    /// (`.`, `e`, sign) terminates the run, leaving it to be flagged as an
963    /// unrecognized token by the trailing-character check in `lex_number`.
964    fn consume_decimal_digit_run(&mut self) {
965        while self.pos < self.src.len() {
966            let c = self.src[self.pos];
967            let is_separator = c == b'_'
968                && self.pos > 0
969                && self.src[self.pos - 1].is_ascii_digit()
970                && self.peek_at(1).is_some_and(|n| n.is_ascii_digit());
971            if c.is_ascii_digit() || is_separator {
972                self.advance();
973            } else {
974                break;
975            }
976        }
977    }
978
979    /// Lex an identifier or keyword.
980    fn lex_identifier(&mut self) -> TokenKind {
981        let start = self.pos;
982        self.advance(); // first character already validated
983
984        while self.pos < self.src.len() {
985            let ch = self.src[self.pos];
986            if ch.is_ascii_alphanumeric() || ch == b'_' || ch >= 0x80 {
987                self.advance();
988            } else {
989                break;
990            }
991        }
992
993        let ident_bytes = &self.src[start..self.pos];
994
995        // Check for keyword
996        if let Some(kw) = TokenKind::lookup_keyword_bytes(ident_bytes) {
997            kw
998        } else {
999            let text = String::from_utf8_lossy(ident_bytes);
1000            TokenKind::Id(self.interner.intern(&text))
1001        }
1002    }
1003
1004    /// Lex `?` or `?NNN`.
1005    fn lex_question(&mut self) -> TokenKind {
1006        self.advance(); // skip ?
1007        if self.pos < self.src.len() && self.src[self.pos].is_ascii_digit() {
1008            let num_start = self.pos;
1009            while self.pos < self.src.len() && self.src[self.pos].is_ascii_digit() {
1010                self.advance();
1011            }
1012            let text = String::from_utf8_lossy(&self.src[num_start..self.pos]);
1013            match text.parse::<u32>() {
1014                Ok(n) if (1..=MAX_VARIABLE_NUMBER).contains(&n) => TokenKind::QuestionNum(n),
1015                Ok(n) => TokenKind::Error(format!(
1016                    "variable number must be between ?1 and ?{MAX_VARIABLE_NUMBER}, got ?{n}"
1017                )),
1018                Err(_) => TokenKind::Error("invalid parameter number".to_owned()),
1019            }
1020        } else {
1021            TokenKind::Question
1022        }
1023    }
1024
1025    fn lex_alpha_param(&mut self, prefix: char, constructor: fn(String) -> TokenKind) -> TokenKind {
1026        self.advance(); // skip prefix
1027        let name_start = self.pos;
1028        while self.pos < self.src.len() {
1029            let ch = self.src[self.pos];
1030            if ch.is_ascii_alphanumeric() || ch == b'_' || ch >= 0x80 {
1031                self.advance();
1032            } else if ch == b':' && self.peek_at(1) == Some(b':') {
1033                self.advance();
1034                self.advance();
1035            } else if ch == b'(' {
1036                self.advance();
1037                while self.pos < self.src.len() && self.src[self.pos] != b')' {
1038                    self.advance();
1039                }
1040                if self.pos >= self.src.len() || self.src[self.pos] != b')' {
1041                    let name = String::from_utf8_lossy(&self.src[name_start..self.pos]);
1042                    return TokenKind::Error(format!("unrecognized token: \"{prefix}{name}\""));
1043                }
1044                self.advance();
1045                break; // Tcl array variable parameters end after the closing paren.
1046            } else {
1047                break;
1048            }
1049        }
1050        if self.pos == name_start {
1051            return TokenKind::Error(format!("empty parameter name after '{prefix}'"));
1052        }
1053        let name = String::from_utf8_lossy(&self.src[name_start..self.pos]).into_owned();
1054        constructor(name)
1055    }
1056
1057    /// Lex `:name`.
1058    fn lex_colon_param(&mut self) -> TokenKind {
1059        self.lex_alpha_param(':', TokenKind::ColonParam)
1060    }
1061
1062    /// Lex `@name`.
1063    fn lex_at_param(&mut self) -> TokenKind {
1064        self.lex_alpha_param('@', TokenKind::AtParam)
1065    }
1066
1067    /// Lex `$name`.
1068    fn lex_dollar_param(&mut self) -> TokenKind {
1069        self.lex_alpha_param('$', TokenKind::DollarParam)
1070    }
1071
1072    // -----------------------------------------------------------------------
1073    // Multi-character operator tokenizers
1074    // -----------------------------------------------------------------------
1075
1076    /// Lex `-`, `->`, or `->>`.
1077    fn lex_minus_or_arrow(&mut self) -> TokenKind {
1078        self.advance(); // skip -
1079        if self.peek() == Some(b'>') {
1080            self.advance(); // skip >
1081            if self.peek() == Some(b'>') {
1082                self.advance(); // skip >
1083                TokenKind::DoubleArrow
1084            } else {
1085                TokenKind::Arrow
1086            }
1087        } else {
1088            TokenKind::Minus
1089        }
1090    }
1091
1092    /// Lex `<`, `<=`, `<>`, or `<<`.
1093    fn lex_lt(&mut self) -> TokenKind {
1094        self.advance(); // skip <
1095        match self.peek() {
1096            Some(b'=') => {
1097                self.advance();
1098                TokenKind::Le
1099            }
1100            Some(b'>') => {
1101                self.advance();
1102                TokenKind::LtGt
1103            }
1104            Some(b'<') => {
1105                self.advance();
1106                TokenKind::ShiftLeft
1107            }
1108            _ => TokenKind::Lt,
1109        }
1110    }
1111
1112    /// Lex `>`, `>=`, or `>>`.
1113    fn lex_gt(&mut self) -> TokenKind {
1114        self.advance(); // skip >
1115        match self.peek() {
1116            Some(b'=') => {
1117                self.advance();
1118                TokenKind::Ge
1119            }
1120            Some(b'>') => {
1121                self.advance();
1122                TokenKind::ShiftRight
1123            }
1124            _ => TokenKind::Gt,
1125        }
1126    }
1127
1128    /// Lex `=` or `==`.
1129    fn lex_eq(&mut self) -> TokenKind {
1130        self.advance(); // skip =
1131        if self.peek() == Some(b'=') {
1132            self.advance();
1133            TokenKind::EqEq
1134        } else {
1135            TokenKind::Eq
1136        }
1137    }
1138
1139    /// Lex `!=`.
1140    fn lex_bang(&mut self) -> TokenKind {
1141        self.advance(); // skip !
1142        if self.peek() == Some(b'=') {
1143            self.advance();
1144            TokenKind::Ne
1145        } else {
1146            TokenKind::Error("unexpected '!', did you mean '!='?".to_owned())
1147        }
1148    }
1149
1150    /// Lex `|` or `||`.
1151    fn lex_pipe(&mut self) -> TokenKind {
1152        self.advance(); // skip |
1153        if self.peek() == Some(b'|') {
1154            self.advance();
1155            TokenKind::Concat
1156        } else {
1157            TokenKind::Pipe
1158        }
1159    }
1160}
1161
1162/// Convert an ASCII hex digit byte to its numeric value (0-15).
1163/// Returns `None` for non-hex bytes.
1164const fn hex_digit(b: u8) -> Option<u8> {
1165    match b {
1166        b'0'..=b'9' => Some(b - b'0'),
1167        b'a'..=b'f' => Some(b - b'a' + 10),
1168        b'A'..=b'F' => Some(b - b'A' + 10),
1169        _ => None,
1170    }
1171}
1172
1173#[cfg(test)]
1174mod tests {
1175    use super::*;
1176
1177    #[test]
1178    fn interner_incremental_bytes_equals_fold() {
1179        // bd-5310l: the incrementally-maintained `interned_bytes` must exactly equal the O(N) fold
1180        // over entries, for every intern/reset sequence, so `retained_bytes` (and thus the
1181        // reset-threshold behaviour) is byte-identical whichever path computes it.
1182        let mut interner = IdentifierInterner::default();
1183        for v in ["alpha", "beta", "gamma", "alpha", "delta", "beta"] {
1184            interner.intern(v);
1185        }
1186        // Deduped distinct set {alpha(5), beta(4), gamma(5), delta(5)} -> 19 bytes.
1187        assert_eq!(interner.interned_bytes, 19);
1188        set_force_interner_scan_bench(false);
1189        let incremental = interner.retained_bytes();
1190        set_force_interner_scan_bench(true);
1191        let folded = interner.retained_bytes();
1192        set_force_interner_scan_bench(false);
1193        assert_eq!(
1194            incremental, folded,
1195            "incremental retained_bytes must equal the O(N) fold"
1196        );
1197        interner.reset();
1198        assert_eq!(interner.interned_bytes, 0);
1199        assert_eq!(interner.retained_bytes(), 0);
1200    }
1201
1202    fn lex(src: &str) -> Vec<Token> {
1203        Lexer::tokenize(src)
1204    }
1205
1206    fn kinds(src: &str) -> Vec<TokenKind> {
1207        lex(src).into_iter().map(|t| t.kind).collect()
1208    }
1209
1210    #[test]
1211    fn test_lex_integer_literals() {
1212        let tokens = kinds("42 0 0xFF");
1213        assert_eq!(
1214            tokens,
1215            vec![
1216                TokenKind::Integer(42),
1217                TokenKind::Integer(0),
1218                TokenKind::Integer(255),
1219                TokenKind::Eof,
1220            ]
1221        );
1222    }
1223
1224    #[test]
1225    fn test_tokenize_into_reuses_caller_owned_capacity() {
1226        let mut scratch = Vec::new();
1227        Lexer::tokenize_into(
1228            "SELECT 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz';",
1229            &mut scratch,
1230        );
1231        let warmed_capacity = scratch.capacity();
1232        assert!(
1233            warmed_capacity > 0,
1234            "warm parse should allocate token scratch"
1235        );
1236
1237        Lexer::tokenize_into("SELECT 1;", &mut scratch);
1238        assert_eq!(
1239            scratch.capacity(),
1240            warmed_capacity,
1241            "smaller follow-up parse should reuse the warmed token buffer",
1242        );
1243        assert_eq!(
1244            scratch.last().map(|token| &token.kind),
1245            Some(&TokenKind::Eof),
1246            "tokenize_into should still terminate with EOF in reused scratch",
1247        );
1248    }
1249
1250    #[test]
1251    fn test_lex_float_literals() {
1252        let tokens = kinds("3.14 1e10 .5 1.0e-3 0.0");
1253        // Avoid clippy::approx_constant (3.14 is interpreted as an approximation of PI),
1254        // but keep the test input string stable.
1255        let expected = 3.0 + 0.14;
1256        assert!(matches!(
1257            tokens[0],
1258            TokenKind::Float(v) if (v - expected).abs() < 1e-10
1259        ));
1260        assert!(matches!(tokens[1], TokenKind::Float(v) if (v - 1e10).abs() < 1.0));
1261        assert!(matches!(tokens[2], TokenKind::Float(v) if (v - 0.5).abs() < 1e-10));
1262        assert!(matches!(tokens[3], TokenKind::Float(v) if (v - 0.001).abs() < 1e-10));
1263        assert!(matches!(tokens[4], TokenKind::Float(v) if v.abs() < 1e-10));
1264        assert_eq!(tokens[5], TokenKind::Eof);
1265    }
1266
1267    #[test]
1268    fn test_lex_string_literals() {
1269        let tokens = kinds("'hello' 'it''s' ''");
1270        assert_eq!(tokens[0], TokenKind::String("hello".to_owned()));
1271        assert_eq!(tokens[1], TokenKind::String("it's".to_owned()));
1272        assert_eq!(tokens[2], TokenKind::String(String::new()));
1273        assert_eq!(tokens[3], TokenKind::Eof);
1274    }
1275
1276    #[test]
1277    fn test_lex_blob_literals() {
1278        let tokens = kinds("X'CAFE' x'00ff' X''");
1279        assert_eq!(tokens[0], TokenKind::Blob(vec![0xCA, 0xFE]));
1280        assert_eq!(tokens[1], TokenKind::Blob(vec![0x00, 0xFF]));
1281        assert_eq!(tokens[2], TokenKind::Blob(vec![]));
1282        assert_eq!(tokens[3], TokenKind::Eof);
1283    }
1284
1285    #[test]
1286    fn test_lex_blob_odd_hex_error() {
1287        let tokens = kinds("X'CAF'");
1288        assert!(matches!(tokens[0], TokenKind::Error(_)));
1289    }
1290
1291    #[test]
1292    fn test_lex_blob_non_ascii_no_panic() {
1293        // bd-20gf regression: multi-byte UTF-8 inside a blob literal must
1294        // produce an error, not panic on string-slice boundary.
1295        let tokens = kinds("X'U\u{05fc} '");
1296        assert!(matches!(tokens[0], TokenKind::Error(_)));
1297
1298        // Also test with raw non-hex ASCII chars.
1299        let tokens2 = kinds("X'GG'");
1300        assert!(matches!(tokens2[0], TokenKind::Error(_)));
1301    }
1302
1303    #[test]
1304    fn test_lex_variables() {
1305        let tokens = kinds("?1 :name @param $var ?");
1306        assert_eq!(tokens[0], TokenKind::QuestionNum(1));
1307        assert_eq!(tokens[1], TokenKind::ColonParam("name".to_owned()));
1308        assert_eq!(tokens[2], TokenKind::AtParam("param".to_owned()));
1309        assert_eq!(tokens[3], TokenKind::DollarParam("var".to_owned()));
1310        assert_eq!(tokens[4], TokenKind::Question);
1311        assert_eq!(tokens[5], TokenKind::Eof);
1312    }
1313
1314    #[test]
1315    fn test_lex_quoted_identifiers() {
1316        let tokens = kinds("\"table_name\" [column] `backtick`");
1317        assert_eq!(tokens[0], TokenKind::QuotedId("table_name".into(), true));
1318        assert_eq!(tokens[1], TokenKind::QuotedId("column".into(), false));
1319        assert_eq!(tokens[2], TokenKind::QuotedId("backtick".into(), false));
1320    }
1321
1322    #[test]
1323    fn test_lex_dqs_flag() {
1324        let tokens = kinds("\"hello\"");
1325        // Double-quoted strings produce QuotedId with EP_DblQuoted=true
1326        assert_eq!(tokens[0], TokenKind::QuotedId("hello".into(), true));
1327    }
1328
1329    #[test]
1330    fn test_lex_keywords() {
1331        let tokens = kinds("SELECT FROM WHERE INSERT CREATE TABLE CONCURRENT");
1332        assert_eq!(tokens[0], TokenKind::KwSelect);
1333        assert_eq!(tokens[1], TokenKind::KwFrom);
1334        assert_eq!(tokens[2], TokenKind::KwWhere);
1335        assert_eq!(tokens[3], TokenKind::KwInsert);
1336        assert_eq!(tokens[4], TokenKind::KwCreate);
1337        assert_eq!(tokens[5], TokenKind::KwTable);
1338        assert_eq!(tokens[6], TokenKind::KwConcurrent);
1339
1340        // Case insensitivity
1341        let tokens2 = kinds("select from where");
1342        assert_eq!(tokens2[0], TokenKind::KwSelect);
1343        assert_eq!(tokens2[1], TokenKind::KwFrom);
1344        assert_eq!(tokens2[2], TokenKind::KwWhere);
1345    }
1346
1347    #[test]
1348    fn test_lex_operators() {
1349        let tokens = kinds("+ - * / % & | ~ << >> = < <= > >= == != <> || -> ->>");
1350        let expected = vec![
1351            TokenKind::Plus,
1352            TokenKind::Minus,
1353            TokenKind::Star,
1354            TokenKind::Slash,
1355            TokenKind::Percent,
1356            TokenKind::Ampersand,
1357            TokenKind::Pipe,
1358            TokenKind::Tilde,
1359            TokenKind::ShiftLeft,
1360            TokenKind::ShiftRight,
1361            TokenKind::Eq,
1362            TokenKind::Lt,
1363            TokenKind::Le,
1364            TokenKind::Gt,
1365            TokenKind::Ge,
1366            TokenKind::EqEq,
1367            TokenKind::Ne,
1368            TokenKind::LtGt,
1369            TokenKind::Concat,
1370            TokenKind::Arrow,
1371            TokenKind::DoubleArrow,
1372            TokenKind::Eof,
1373        ];
1374        assert_eq!(tokens, expected);
1375    }
1376
1377    #[test]
1378    fn test_lex_eq_vs_eqeq() {
1379        let tokens = kinds("= ==");
1380        assert_eq!(tokens[0], TokenKind::Eq);
1381        assert_eq!(tokens[1], TokenKind::EqEq);
1382    }
1383
1384    #[test]
1385    fn test_lex_ne_vs_ltgt() {
1386        let tokens = kinds("!= <>");
1387        assert_eq!(tokens[0], TokenKind::Ne);
1388        assert_eq!(tokens[1], TokenKind::LtGt);
1389    }
1390
1391    #[test]
1392    fn test_lex_error_unterminated_string() {
1393        // Unterminated tokens report stock's "unrecognized token: \"<text>\"" with
1394        // the full text (to end of input), not an internal "unterminated ... at
1395        // byte N": string, double-quoted/backtick/bracket identifiers, and blob.
1396        // bd-errmsg-parity-batch3-3brmm.
1397        for input in ["'hello", "\"abc", "`abc", "[abc", "x'12"] {
1398            let tokens = kinds(input);
1399            let expected = format!("unrecognized token: \"{input}\"");
1400            assert!(
1401                matches!(tokens[0], TokenKind::Error(ref e) if e.contains(&expected)),
1402                "expected {input:?} -> {expected:?}, got {:?}",
1403                tokens[0]
1404            );
1405        }
1406    }
1407
1408    #[test]
1409    fn test_lex_line_column_tracking() {
1410        let tokens = lex("SELECT\n  a,\n  b");
1411        assert_eq!(tokens[0].line, 1);
1412        assert_eq!(tokens[0].col, 1);
1413        // 'a' is on line 2, col 3
1414        assert_eq!(tokens[1].line, 2);
1415        assert_eq!(tokens[1].col, 3);
1416        // ',' is on line 2, col 4
1417        assert_eq!(tokens[2].line, 2);
1418        assert_eq!(tokens[2].col, 4);
1419        // 'b' is on line 3, col 3
1420        assert_eq!(tokens[3].line, 3);
1421        assert_eq!(tokens[3].col, 3);
1422    }
1423
1424    #[test]
1425    fn test_lex_whitespace_and_comments_skipped() {
1426        let tokens = kinds("SELECT -- this is a comment\n  a /* block */ FROM b");
1427        assert_eq!(tokens[0], TokenKind::KwSelect);
1428        assert_eq!(tokens[1], TokenKind::Id("a".into()));
1429        assert_eq!(tokens[2], TokenKind::KwFrom);
1430        assert_eq!(tokens[3], TokenKind::Id("b".into()));
1431        assert_eq!(tokens[4], TokenKind::Eof);
1432    }
1433
1434    #[test]
1435    fn test_lex_hex_large_values() {
1436        // C SQLite parses hex as u64 and memcpy to i64.
1437        // 0xFFFFFFFFFFFFFFFF = u64::MAX → i64 -1.
1438        let tokens = kinds("0xFFFFFFFFFFFFFFFF");
1439        assert_eq!(tokens[0], TokenKind::Integer(-1));
1440
1441        // 0x8000000000000000 = i64::MIN.
1442        let tokens = kinds("0x8000000000000000");
1443        assert_eq!(tokens[0], TokenKind::Integer(i64::MIN));
1444
1445        // 0x7FFFFFFFFFFFFFFF = i64::MAX.
1446        let tokens = kinds("0x7FFFFFFFFFFFFFFF");
1447        assert_eq!(tokens[0], TokenKind::Integer(i64::MAX));
1448    }
1449
1450    #[test]
1451    fn test_lex_hex_overflow_17_digits_rejects() {
1452        // 0x10000000000000000 has 17 significant hex digits → must error,
1453        // not silently truncate to 0.
1454        let tokens = kinds("0x10000000000000000");
1455        assert!(
1456            matches!(&tokens[0], TokenKind::Error(msg) if msg.contains("out of range")),
1457            "expected error for 17-digit hex, got {:?}",
1458            tokens[0]
1459        );
1460    }
1461
1462    #[test]
1463    fn test_lex_hex_leading_zeros_accepted() {
1464        // Leading zeros are stripped before the length check, so
1465        // 0x00000000000000001 (17 chars, 1 significant) is valid.
1466        let tokens = kinds("0x00000000000000001");
1467        assert_eq!(tokens[0], TokenKind::Integer(1));
1468    }
1469
1470    #[test]
1471    fn test_lex_number_hex() {
1472        let tokens = kinds("0x1A 0Xff 0x0");
1473        assert_eq!(tokens[0], TokenKind::Integer(26));
1474        assert_eq!(tokens[1], TokenKind::Integer(255));
1475        assert_eq!(tokens[2], TokenKind::Integer(0));
1476        assert_eq!(tokens[3], TokenKind::Eof);
1477    }
1478
1479    #[test]
1480    fn test_lex_number_unrecognized() {
1481        let tokens = kinds("123a 123.a");
1482        assert!(
1483            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("unrecognized token: \"123a\""))
1484        );
1485        assert!(
1486            matches!(tokens[1], TokenKind::Error(ref e) if e.contains("unrecognized token: \"123.a\""))
1487        );
1488    }
1489
1490    #[test]
1491    fn test_lex_number_hex_invalid() {
1492        // `0x`/`0xGG` with no hex digits is an "unrecognized token" reporting the
1493        // FULL offending text (matching SQLite), not an internal "empty hex
1494        // literal". bd-errmsg-parity-batch3-3brmm.
1495        let tokens = kinds("0x");
1496        assert!(
1497            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("unrecognized token: \"0x\"")),
1498            "expected 0x -> unrecognized token, got {:?}",
1499            tokens[0]
1500        );
1501        let tokens = kinds("0xGG");
1502        assert!(
1503            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("unrecognized token: \"0xGG\"")),
1504            "expected 0xGG -> unrecognized token, got {:?}",
1505            tokens[0]
1506        );
1507    }
1508
1509    #[test]
1510    fn test_lex_blob_invalid_is_unrecognized() {
1511        // A malformed (terminated) blob literal reports stock's
1512        // "unrecognized token: \"...\"" with the full `x'...'` text, not an
1513        // internal byte-offset diagnostic. bd-errmsg-parity-batch3-3brmm.
1514        let tokens = kinds("x'123'"); // odd number of hex digits
1515        assert!(
1516            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("unrecognized token: \"x'123'\"")),
1517            "expected x'123' -> unrecognized token, got {:?}",
1518            tokens[0]
1519        );
1520        let tokens = kinds("x'1G'"); // non-hex content
1521        assert!(
1522            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("unrecognized token: \"x'1G'\"")),
1523            "expected x'1G' -> unrecognized token, got {:?}",
1524            tokens[0]
1525        );
1526    }
1527
1528    #[test]
1529    fn test_lex_positional_params() {
1530        let tokens = kinds("? ?123");
1531        assert_eq!(tokens[0], TokenKind::Question);
1532        assert_eq!(tokens[1], TokenKind::QuestionNum(123));
1533        assert_eq!(tokens[2], TokenKind::Eof);
1534    }
1535
1536    #[test]
1537    fn test_lex_positional_params_reject_zero_and_out_of_range() {
1538        let tokens = kinds("?0 ?32767");
1539        assert!(
1540            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("between ?1 and ?32766")),
1541            "expected ?0 to be rejected, got {:?}",
1542            tokens[0]
1543        );
1544        assert!(
1545            matches!(tokens[1], TokenKind::Error(ref e) if e.contains("between ?1 and ?32766")),
1546            "expected ?32767 to be rejected, got {:?}",
1547            tokens[1]
1548        );
1549        assert_eq!(tokens[2], TokenKind::Eof);
1550    }
1551
1552    #[test]
1553    fn test_lex_named_params() {
1554        let tokens = kinds(":foo @bar $baz_123");
1555        assert_eq!(tokens[0], TokenKind::ColonParam("foo".to_owned()));
1556        assert_eq!(tokens[1], TokenKind::AtParam("bar".to_owned()));
1557        assert_eq!(tokens[2], TokenKind::DollarParam("baz_123".to_owned()));
1558        assert_eq!(tokens[3], TokenKind::Eof);
1559    }
1560
1561    #[test]
1562    fn test_lex_named_params_with_tcl_syntax() {
1563        let tokens = kinds("$::foo(bar) :a::b");
1564        assert_eq!(tokens[0], TokenKind::DollarParam("::foo(bar)".to_owned()));
1565        assert_eq!(tokens[1], TokenKind::ColonParam("a::b".to_owned()));
1566        assert_eq!(tokens[2], TokenKind::Eof);
1567    }
1568
1569    #[test]
1570    fn test_lex_named_params_with_unclosed_tcl_array_syntax() {
1571        let tokens = kinds("$::foo(bar");
1572        assert!(
1573            matches!(tokens[0], TokenKind::Error(ref e) if e.contains("unrecognized token")),
1574            "expected unterminated Tcl-style parameter to be rejected, got {:?}",
1575            tokens[0]
1576        );
1577        assert_eq!(tokens[1], TokenKind::Eof);
1578    }
1579
1580    fn histogram_total(hist: &TokenizeDurationSecondsHistogram) -> u64 {
1581        hist.le_100us + hist.le_250us + hist.le_500us + hist.le_1ms + hist.le_5ms + hist.gt_5ms
1582    }
1583
1584    #[test]
1585    fn test_tokenize_metrics_accumulate_tokens_and_histogram_samples() {
1586        let prev_metrics_enabled = tokenize_metrics_enabled();
1587        reset_tokenize_metrics();
1588        set_tokenize_metrics_enabled(true);
1589
1590        let first = lex("SELECT 1;");
1591        let second = lex("SELECT 2;");
1592
1593        let expected_total_tokens = u64::try_from(first.len() + second.len()).unwrap_or(u64::MAX);
1594        let snap = tokenize_metrics_snapshot();
1595        assert_eq!(snap.fsqlite_tokenize_tokens_total, expected_total_tokens);
1596        assert_eq!(snap.fsqlite_tokenize_duration_seconds_count, 2);
1597        assert_eq!(
1598            histogram_total(&snap.fsqlite_tokenize_duration_seconds),
1599            snap.fsqlite_tokenize_duration_seconds_count
1600        );
1601
1602        set_tokenize_metrics_enabled(prev_metrics_enabled);
1603        reset_tokenize_metrics();
1604    }
1605
1606    #[test]
1607    fn test_tokenize_metrics_reset_clears_all_fields() {
1608        let prev_metrics_enabled = tokenize_metrics_enabled();
1609        reset_tokenize_metrics();
1610        set_tokenize_metrics_enabled(true);
1611        let _ = lex("SELECT 42;");
1612
1613        let before = tokenize_metrics_snapshot();
1614        assert!(before.fsqlite_tokenize_tokens_total > 0);
1615        assert!(before.fsqlite_tokenize_duration_seconds_count > 0);
1616
1617        reset_tokenize_metrics();
1618        let after = tokenize_metrics_snapshot();
1619        assert_eq!(after.fsqlite_tokenize_tokens_total, 0);
1620        assert_eq!(after.fsqlite_tokenize_duration_seconds_count, 0);
1621        assert_eq!(after.fsqlite_tokenize_duration_seconds_sum_micros, 0);
1622        assert_eq!(histogram_total(&after.fsqlite_tokenize_duration_seconds), 0);
1623
1624        set_tokenize_metrics_enabled(prev_metrics_enabled);
1625    }
1626
1627    #[test]
1628    fn test_tokenize_metrics_can_be_disabled_off_hot_path() {
1629        let prev_metrics_enabled = tokenize_metrics_enabled();
1630        reset_tokenize_metrics();
1631        set_tokenize_metrics_enabled(false);
1632
1633        let _ = lex("SELECT 99;");
1634
1635        let snap = tokenize_metrics_snapshot();
1636        assert_eq!(snap.fsqlite_tokenize_tokens_total, 0);
1637        assert_eq!(snap.fsqlite_tokenize_duration_seconds_count, 0);
1638        assert_eq!(snap.fsqlite_tokenize_duration_seconds_sum_micros, 0);
1639        assert_eq!(histogram_total(&snap.fsqlite_tokenize_duration_seconds), 0);
1640
1641        set_tokenize_metrics_enabled(prev_metrics_enabled);
1642        reset_tokenize_metrics();
1643    }
1644}