oak-tcl 0.0.11

Tcl language parser with support for scripting, command substitution, and procedural programming features.
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

#![doc = include_str!("readme.md")]
use core::range::Range;

/// The root of a Tcl Abstract Syntax Tree.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TclRoot {
    /// The span of the entire Tcl script in the source file.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The items (commands or comments) in the script.
    pub items: Vec<TclItem>,
}

/// A top-level item in a Tcl script.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TclItem {
    /// A Tcl command.
    Command(TclCommand),
    /// A Tcl comment.
    Comment(TclComment),
}

/// A Tcl command.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TclCommand {
    /// The span of the command in the source file.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The words (arguments) of the command.
    pub words: Vec<TclWord>,
}

/// A Tcl word (an argument or command name).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TclWord {
    /// A simple string word.
    Simple(String),
    /// A variable substitution word.
    Variable(String),
    /// A script substitution word.
    Script(TclRoot),
    /// A braced string word.
    Braced(String),
}

/// A Tcl comment.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TclComment {
    /// The span of the comment in the source file.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
    /// The text of the comment.
    pub text: String,
}

impl TclRoot {
    /// Creates a new Tcl root node with the given span.
    pub fn new(span: Range<usize>) -> Self {
        Self { span, items: Vec::new() }
    }
}