bulloak-syntax 0.9.2

A Solidity test generator based on the Branching Tree Technique.
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! The AST for a bulloak tree file.

use crate::span::Span;

/// An Abstract Syntax Tree (AST) that describes the semantic
/// structure of a bulloak tree.
#[derive(Debug, PartialEq, Eq)]
pub enum Ast {
    /// The root node of the AST.
    Root(Root),
    /// A condition node of the AST.
    ///
    /// This node corresponds to a junction in the tree.
    Condition(Condition),
    /// An action node of the AST.
    ///
    /// This node corresponds to a leaf node of the tree.
    Action(Action),
    /// Additional action description.
    ///
    /// This node can only appear as a child of an action.
    ActionDescription(Description),
}

impl Ast {
    /// Return the span of this abstract syntax tree.
    #[must_use]
    pub fn span(&self) -> &Span {
        match self {
            Self::Root(x) => &x.span,
            Self::Condition(x) => &x.span,
            Self::Action(x) => &x.span,
            Self::ActionDescription(x) => &x.span,
        }
    }

    /// Whether the current node is an `Action` node.
    #[must_use]
    pub fn is_action(&self) -> bool {
        matches!(self, Self::Action(_))
    }
}

/// The root node of the AST.
#[derive(Debug, PartialEq, Eq)]
pub struct Root {
    /// The name that is used for the emitted contract.
    pub contract_name: String,
    /// The span that encompasses this node. It includes
    /// all of its children.
    pub span: Span,
    /// The children AST nodes of this node.
    pub children: Vec<Ast>,
}

/// A condition node of the AST.
#[derive(Debug, PartialEq, Eq)]
pub struct Condition {
    /// The title of this condition.
    ///
    /// For example: "when stuff happens".
    pub title: String,
    /// The span that encompasses this node. It includes
    /// all of its children.
    pub span: Span,
    /// The children AST nodes of this node.
    pub children: Vec<Ast>,
}

/// An action node of the AST.
#[derive(Debug, PartialEq, Eq)]
pub struct Action {
    /// The title of this action.
    ///
    /// For example: "It should revert."
    pub title: String,
    /// The span that encompasses this node.
    pub span: Span,
    /// The children AST nodes of this node.
    ///
    /// For now we only support action description
    /// nodes.
    pub children: Vec<Ast>,
}

/// A description node of the AST.
#[derive(Debug, PartialEq, Eq)]
pub struct Description {
    /// The text of this action.
    ///
    /// For example: "Describe your actions."
    pub text: String,
    /// The span that encompasses this node.
    pub span: Span,
}