poshtree 0.4.2

PowerShell syntax tree: tokenizer, parser, AST, and unparser
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! C# tokens for the Add-Type dialect.
//!
//! The lexer discards trivia (whitespace and comments) and lexes each string
//! or character literal as a single token, so identifiers inside comments and
//! strings never appear as tokens. Every token carries an absolute source span
//! (already offset to the original file), so a token is a ready-made edit
//! target.

use crate::v2::span::Span;

/// The kind of a C# token. Identifier-like tokens are all [`Ident`]; the parser
/// classifies keywords by text, which also handles C#'s contextual keywords.
///
/// [`Ident`]: CsTokenKind::Ident
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CsTokenKind {
    /// An identifier or keyword (keywords are recognized by the parser).
    Ident,
    /// A numeric literal.
    Number,
    /// A string literal: regular, `@"verbatim"`, or `$"interpolated"`.
    Str,
    /// A character literal.
    Char,
    /// `{`
    LBrace,
    /// `}`
    RBrace,
    /// `(`
    LParen,
    /// `)`
    RParen,
    /// `[`
    LBracket,
    /// `]`
    RBracket,
    /// `;`
    Semicolon,
    /// `,`
    Comma,
    /// `.`
    Dot,
    /// `::`
    ColonColon,
    /// `:`
    Colon,
    /// `<`
    Lt,
    /// `>`
    Gt,
    /// `=`
    Assign,
    /// `=>`
    Arrow,
    /// Any other operator or punctuation.
    Op,
    /// End of input.
    Eof,
    /// A byte that did not start any known token.
    Unknown,
}

/// A C# token: its kind, exact source text, and absolute span.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CsToken {
    /// What kind of token this is.
    pub kind: CsTokenKind,
    /// The exact source text of the token.
    pub text: String,
    /// Absolute byte span in the original file.
    pub span: Span,
}

impl CsToken {
    /// Whether this token is an identifier whose text equals `kw` (a keyword
    /// check; C# is case-sensitive, so the comparison is exact).
    pub fn is_kw(&self, kw: &str) -> bool {
        self.kind == CsTokenKind::Ident && self.text == kw
    }
}