only-syntax 0.0.5

Syntax parsing and CST construction for the only task language.
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

use only_diagnostic::Diagnostic;

use crate::ast_view::DocumentNode;
use crate::parse::parse_tokens;
use crate::{LexToken, ParseResult, ParseResultExt, SyntaxNode, lex};

/// Immutable syntax snapshot shared by semantic analysis and editor hosts.
///
/// Args:
/// None.
///
/// Returns:
/// Token stream and parsed CST for a single in-memory source snapshot.
#[derive(Debug, Clone)]
pub struct SyntaxSnapshot {
    pub tokens: Vec<LexToken>,
    pub parse: ParseResult,
}

impl SyntaxSnapshot {
    /// Returns the typed document CST root.
    ///
    /// Args:
    /// None.
    ///
    /// Returns:
    /// Typed document wrapper for the snapshot root.
    pub fn document(&self) -> DocumentNode {
        self.parse.document()
    }

    /// Returns the CST root node for this snapshot.
    ///
    /// Args:
    /// None.
    ///
    /// Returns:
    /// Parsed rowan root node.
    pub fn root(&self) -> &SyntaxNode {
        &self.parse.root
    }

    /// Returns collected syntax diagnostics.
    ///
    /// Args:
    /// None.
    ///
    /// Returns:
    /// Borrowed parse diagnostics for this snapshot.
    pub fn diagnostics(&self) -> &[Diagnostic] {
        self.parse.diagnostics()
    }
}

/// Lexes and parses source text into an immutable syntax snapshot.
///
/// Args:
/// source: Raw Onlyfile source text.
///
/// Returns:
/// Snapshot containing tokens, CST and syntax diagnostics.
pub fn snapshot(source: &str) -> SyntaxSnapshot {
    let tokens = lex(source);
    let parse = parse_tokens(&tokens);

    SyntaxSnapshot { tokens, parse }
}