aozora 0.5.0

Aozora Bunko notation parser with incremental document snapshots
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

//! Lexer token types.
//!
//! The tokenize stage emits a `BumpVec<'a, Token>` (arena-backed) where
//! each token is either a plain [`Token::Text`] range (a run of source
//! bytes between triggers) or a [`Token::Trigger`] carrying the
//! specific delimiter kind that caused the break. The pair stage consumes
//! this stream and applies balanced-stack pairing to build
//! structured events.
//!
//! [`TriggerKind`] lives in [`crate::spec::TriggerKind`] and is
//! re-exported here for downstream consumers.

use crate::syntax::Span;

pub(crate) use crate::spec::TriggerKind;

/// A single lexer event.
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub(crate) enum Token {
    /// Text between triggers. `range` is a byte-offset span in the
    /// sanitized source (sanitize-stage output). May be empty if two
    /// triggers are adjacent.
    Text {
        /// Sanitized-source byte span of the run; may be empty.
        range: Span,
    },

    /// A delimiter character. `pos` is the start byte offset of the
    /// token in the sanitized source; `kind` carries its role. For
    /// multi-character triggers (`［＃`) the span covers
    /// all constituent characters.
    Trigger {
        /// Which delimiter this is (`｜`, `《`, `［＃`, …).
        kind: TriggerKind,
        /// Sanitized-source byte span covering every constituent
        /// character of the trigger.
        span: Span,
    },

    /// Line-feed (`\n`). Emitted as its own token rather than folded
    /// into the surrounding Text because line-structure matters for
    /// block-level container recognition (the pair stage pairs
    /// block-opener / block-closer lines by position).
    Newline {
        /// Sanitized-source byte offset of the `\n`.
        pos: u32,
    },
}

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

    #[test]
    fn single_char_trigger_byte_lens_match_utf8() {
        // Sanity that the re-export still works the same.
        assert_eq!(TriggerKind::Bar.source_byte_len(), 3);
        assert_eq!(TriggerKind::AngleQuoteOpen.source_byte_len(), 3);
    }
}