Skip to main content

harn_lexer/
token.rs

1use std::fmt;
2
3/// A segment of an interpolated string.
4#[derive(Debug, Clone, PartialEq)]
5pub enum StringSegment {
6    Literal(String),
7    /// An interpolated expression with its source position (line, column).
8    Expression(String, usize, usize),
9}
10
11impl fmt::Display for StringSegment {
12    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
13        match self {
14            StringSegment::Literal(s) => write!(f, "{s}"),
15            StringSegment::Expression(e, _, _) => write!(f, "${{{e}}}"),
16        }
17    }
18}
19
20/// Source location for error reporting.
21#[derive(Debug, Clone, Copy, PartialEq, Eq)]
22pub struct Span {
23    /// Byte offset from start of source (inclusive).
24    pub start: usize,
25    /// Byte offset from start of source (exclusive).
26    pub end: usize,
27    /// 1-based line number of start position.
28    pub line: usize,
29    /// 1-based column number of start position.
30    pub column: usize,
31    /// 1-based line number of end position (for multiline span detection).
32    pub end_line: usize,
33}
34
35impl Span {
36    pub fn with_offsets(start: usize, end: usize, line: usize, column: usize) -> Self {
37        Self {
38            start,
39            end,
40            line,
41            column,
42            end_line: line,
43        }
44    }
45
46    /// Create a span covering two spans (from start of `a` to end of `b`).
47    pub fn merge(a: Span, b: Span) -> Span {
48        Span {
49            start: a.start,
50            end: b.end,
51            line: a.line,
52            column: a.column,
53            end_line: b.end_line,
54        }
55    }
56
57    /// A dummy span for synthetic/generated nodes.
58    pub fn dummy() -> Self {
59        Self {
60            start: 0,
61            end: 0,
62            line: 0,
63            column: 0,
64            end_line: 0,
65        }
66    }
67}
68
69impl fmt::Display for Span {
70    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
71        write!(f, "{}:{}", self.line, self.column)
72    }
73}
74
75/// Canonical list of Harn language keywords.
76///
77/// This is the single source of truth for keyword tokens. The lexer's
78/// identifier-to-keyword match in `lexer.rs` must stay in sync; the unit test
79/// `test_keywords_const_covers_lexer` verifies parity between the two.
80///
81/// Tooling that needs the keyword set (syntax highlighters, the LSP, etc.)
82/// should read `KEYWORDS` rather than hard-coding a duplicate list.
83pub const KEYWORDS: &[&str] = &[
84    "ask",
85    "break",
86    "catch",
87    "continue",
88    "deadline",
89    "else",
90    "enum",
91    "extends",
92    "false",
93    "finally",
94    "fn",
95    "for",
96    "from",
97    "guard",
98    "if",
99    "impl",
100    "import",
101    "in",
102    "interface",
103    "let",
104    "match",
105    "mutex",
106    "nil",
107    "override",
108    "parallel",
109    "parallel_map",
110    "parallel_settle",
111    "pipeline",
112    "pub",
113    "require",
114    "retry",
115    "return",
116    "select",
117    "spawn",
118    "struct",
119    "throw",
120    "thru",
121    "tool",
122    "true",
123    "try",
124    "type",
125    "upto",
126    "var",
127    "while",
128    "yield",
129];
130
131/// Token kinds produced by the lexer.
132#[derive(Debug, Clone, PartialEq)]
133pub enum TokenKind {
134    // Keywords
135    Pipeline,
136    Extends,
137    Override,
138    Let,
139    Var,
140    If,
141    Else,
142    For,
143    In,
144    Match,
145    Retry,
146    Parallel,
147    ParallelMap,
148    ParallelSettle,
149    Return,
150    Import,
151    True,
152    False,
153    Nil,
154    Try,
155    Catch,
156    Throw,
157    Finally,
158    Fn,
159    Spawn,
160    While,
161    TypeKw,
162    Enum,
163    Struct,
164    Interface,
165    Pub,
166    From,
167    Thru,
168    Tool,
169    Upto,
170    Guard,
171    Require,
172    Ask,
173    Deadline,
174    Yield,
175    Mutex,
176    Break,
177    Continue,
178    Select,
179    Impl,
180
181    // Literals
182    Identifier(String),
183    StringLiteral(String),
184    InterpolatedString(Vec<StringSegment>),
185    IntLiteral(i64),
186    FloatLiteral(f64),
187    /// Duration literal in milliseconds: 500ms, 5s, 30m, 2h
188    DurationLiteral(u64),
189
190    // Two-character operators
191    Eq,            // ==
192    Neq,           // !=
193    And,           // &&
194    Or,            // ||
195    Pipe,          // |>
196    NilCoal,       // ??
197    QuestionDot,   // ?.
198    Arrow,         // ->
199    Lte,           // <=
200    Gte,           // >=
201    PlusAssign,    // +=
202    MinusAssign,   // -=
203    StarAssign,    // *=
204    SlashAssign,   // /=
205    PercentAssign, // %=
206
207    // Single-character operators
208    Assign,   // =
209    Not,      // !
210    Dot,      // .
211    Plus,     // +
212    Minus,    // -
213    Star,     // *
214    Slash,    // /
215    Percent,  // %
216    Lt,       // <
217    Gt,       // >
218    Question, // ?
219    Bar,      // |  (for union types)
220
221    // Delimiters
222    LBrace,    // {
223    RBrace,    // }
224    LParen,    // (
225    RParen,    // )
226    LBracket,  // [
227    RBracket,  // ]
228    Comma,     // ,
229    Colon,     // :
230    Semicolon, // ;
231
232    // Comments
233    LineComment(String),  // // text
234    BlockComment(String), // /* text */
235
236    // Special
237    Newline,
238    Eof,
239}
240
241impl fmt::Display for TokenKind {
242    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
243        match self {
244            TokenKind::Pipeline => write!(f, "pipeline"),
245            TokenKind::Extends => write!(f, "extends"),
246            TokenKind::Override => write!(f, "override"),
247            TokenKind::Let => write!(f, "let"),
248            TokenKind::Var => write!(f, "var"),
249            TokenKind::If => write!(f, "if"),
250            TokenKind::Else => write!(f, "else"),
251            TokenKind::For => write!(f, "for"),
252            TokenKind::In => write!(f, "in"),
253            TokenKind::Match => write!(f, "match"),
254            TokenKind::Retry => write!(f, "retry"),
255            TokenKind::Parallel => write!(f, "parallel"),
256            TokenKind::ParallelMap => write!(f, "parallel_map"),
257            TokenKind::ParallelSettle => write!(f, "parallel_settle"),
258            TokenKind::Return => write!(f, "return"),
259            TokenKind::Import => write!(f, "import"),
260            TokenKind::True => write!(f, "true"),
261            TokenKind::False => write!(f, "false"),
262            TokenKind::Nil => write!(f, "nil"),
263            TokenKind::Try => write!(f, "try"),
264            TokenKind::Catch => write!(f, "catch"),
265            TokenKind::Throw => write!(f, "throw"),
266            TokenKind::Finally => write!(f, "finally"),
267            TokenKind::Fn => write!(f, "fn"),
268            TokenKind::Spawn => write!(f, "spawn"),
269            TokenKind::While => write!(f, "while"),
270            TokenKind::TypeKw => write!(f, "type"),
271            TokenKind::Enum => write!(f, "enum"),
272            TokenKind::Struct => write!(f, "struct"),
273            TokenKind::Interface => write!(f, "interface"),
274            TokenKind::Pub => write!(f, "pub"),
275            TokenKind::From => write!(f, "from"),
276            TokenKind::Thru => write!(f, "thru"),
277            TokenKind::Tool => write!(f, "tool"),
278            TokenKind::Upto => write!(f, "upto"),
279            TokenKind::Guard => write!(f, "guard"),
280            TokenKind::Require => write!(f, "require"),
281            TokenKind::Ask => write!(f, "ask"),
282            TokenKind::Deadline => write!(f, "deadline"),
283            TokenKind::Yield => write!(f, "yield"),
284            TokenKind::Mutex => write!(f, "mutex"),
285            TokenKind::Break => write!(f, "break"),
286            TokenKind::Continue => write!(f, "continue"),
287            TokenKind::Select => write!(f, "select"),
288            TokenKind::Impl => write!(f, "impl"),
289            TokenKind::Identifier(s) => write!(f, "id({s})"),
290            TokenKind::StringLiteral(s) => write!(f, "str({s})"),
291            TokenKind::InterpolatedString(_) => write!(f, "istr(...)"),
292            TokenKind::IntLiteral(n) => write!(f, "int({n})"),
293            TokenKind::FloatLiteral(n) => write!(f, "float({n})"),
294            TokenKind::DurationLiteral(ms) => write!(f, "duration({ms}ms)"),
295            TokenKind::Eq => write!(f, "=="),
296            TokenKind::Neq => write!(f, "!="),
297            TokenKind::And => write!(f, "&&"),
298            TokenKind::Or => write!(f, "||"),
299            TokenKind::Pipe => write!(f, "|>"),
300            TokenKind::NilCoal => write!(f, "??"),
301            TokenKind::QuestionDot => write!(f, "?."),
302            TokenKind::Arrow => write!(f, "->"),
303            TokenKind::Lte => write!(f, "<="),
304            TokenKind::Gte => write!(f, ">="),
305            TokenKind::PlusAssign => write!(f, "+="),
306            TokenKind::MinusAssign => write!(f, "-="),
307            TokenKind::StarAssign => write!(f, "*="),
308            TokenKind::SlashAssign => write!(f, "/="),
309            TokenKind::PercentAssign => write!(f, "%="),
310            TokenKind::Assign => write!(f, "="),
311            TokenKind::Not => write!(f, "!"),
312            TokenKind::Dot => write!(f, "."),
313            TokenKind::Plus => write!(f, "+"),
314            TokenKind::Minus => write!(f, "-"),
315            TokenKind::Star => write!(f, "*"),
316            TokenKind::Slash => write!(f, "/"),
317            TokenKind::Percent => write!(f, "%"),
318            TokenKind::Lt => write!(f, "<"),
319            TokenKind::Gt => write!(f, ">"),
320            TokenKind::Question => write!(f, "?"),
321            TokenKind::Bar => write!(f, "|"),
322            TokenKind::LBrace => write!(f, "{{"),
323            TokenKind::RBrace => write!(f, "}}"),
324            TokenKind::LParen => write!(f, "("),
325            TokenKind::RParen => write!(f, ")"),
326            TokenKind::LBracket => write!(f, "["),
327            TokenKind::RBracket => write!(f, "]"),
328            TokenKind::Comma => write!(f, ","),
329            TokenKind::Colon => write!(f, ":"),
330            TokenKind::Semicolon => write!(f, ";"),
331            TokenKind::LineComment(s) => write!(f, "// {s}"),
332            TokenKind::BlockComment(s) => write!(f, "/* {s} */"),
333            TokenKind::Newline => write!(f, "\\n"),
334            TokenKind::Eof => write!(f, "EOF"),
335        }
336    }
337}
338
339/// A token with its kind and source location.
340#[derive(Debug, Clone, PartialEq)]
341pub struct Token {
342    pub kind: TokenKind,
343    pub span: Span,
344}
345
346impl Token {
347    pub fn with_span(kind: TokenKind, span: Span) -> Self {
348        Self { kind, span }
349    }
350}