ink-analyzer-ir 0.3.0

Intermediate representations (IRs) and abstractions of ink! smart contract code for ink! analyzer.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! ink! IR traits.

use ra_ap_syntax::ast::{Fn, Struct};
use ra_ap_syntax::{AstNode, SyntaxKind, SyntaxNode};

use crate::{utils, InkAttribute};

/// Implemented by IR items that wrap a syntax node.
pub trait FromSyntax {
    /// Returns the syntax node for the IR item.
    fn syntax(&self) -> &SyntaxNode;
}

/// Implemented by IR items that wrap an AST node.
pub trait FromAST {
    /// Associated AST node type.
    type AST: AstNode;

    /// Returns the AST node for the IR item.
    fn ast(&self) -> &Self::AST;
}

/// Blanket implementation of FromSyntax for ASTNode wrappers.
impl<T: FromAST> FromSyntax for T {
    fn syntax(&self) -> &SyntaxNode {
        self.ast().syntax()
    }
}

/// Implemented by IR items derived from an ink! attribute item.
pub trait FromInkAttribute {
    /// Returns true if the IR item can be derived for the ink! attribute.
    fn can_cast(attr: &InkAttribute) -> bool;

    /// Returns an IR item if one can be derived for the ink! attribute.
    fn cast(attr: InkAttribute) -> Option<Self>
    where
        Self: Sized;

    /// Returns the ink! attribute the IR item was derived from.
    fn ink_attr(&self) -> &InkAttribute;
}

/// Implemented by IR items whose valid AST node is a `struct`.
pub trait AsInkStruct {
    /// Returns the `struct` item (if any) for the ink! item.
    fn struct_item(&self) -> Option<&Struct>;
}

/// Implemented by IR items whose valid AST node is an `fn`.
pub trait AsInkFn {
    /// Returns the `fn` item (if any) for the ink! item.
    fn fn_item(&self) -> Option<&Fn>;
}

/// Convenience methods for navigating the IR that implemented by all IR items.
pub trait IRItem {
    /// Returns the syntax kind for the IR item.
    fn syntax_kind(&self) -> SyntaxKind;

    /// Returns the syntax tree parent for the IR item.
    fn syntax_parent(&self) -> Option<SyntaxNode>;

    /// Returns the kind of the syntax tree parent for the IR item.
    fn syntax_parent_kind(&self) -> Option<SyntaxKind>;

    /// Returns ink! attributes for the IR item.
    fn ink_attrs(&self) -> Vec<InkAttribute>;

    /// Returns ink! attributes for all the IR item's descendants.
    fn ink_attrs_descendants(&self) -> Vec<InkAttribute>;

    /// Returns ink! attributes in the IR item's scope.
    /// This includes both the nodes own ink! attributes and those of all of it's descendants.
    fn ink_attrs_in_scope(&self) -> Vec<InkAttribute>;

    /// Returns ink! attributes for all the IR item's descendants
    /// that don't have any ink! ancestors between them and the item.
    fn ink_attrs_closest_descendants(&self) -> Vec<InkAttribute>;

    /// Returns ink! attributes for all the IR item's ancestors.
    fn ink_attrs_ancestors(&self) -> Vec<InkAttribute>;

    /// Returns ink! attributes for all the IR item's ancestors
    /// that don't have any ink! ancestors between them and the item.
    fn ink_attrs_closest_ancestors(&self) -> Vec<InkAttribute>;
}

/// Blanket implementation of IRItem for syntax node wrappers.
impl<T> IRItem for T
where
    T: FromSyntax,
{
    fn syntax_kind(&self) -> SyntaxKind {
        self.syntax().kind()
    }

    fn syntax_parent(&self) -> Option<SyntaxNode> {
        self.syntax().parent()
    }

    fn syntax_parent_kind(&self) -> Option<SyntaxKind> {
        Some(self.syntax_parent()?.kind())
    }

    fn ink_attrs(&self) -> Vec<InkAttribute> {
        utils::ink_attrs(self.syntax())
    }

    fn ink_attrs_descendants(&self) -> Vec<InkAttribute> {
        utils::ink_attrs_descendants(self.syntax())
    }

    fn ink_attrs_in_scope(&self) -> Vec<InkAttribute> {
        utils::ink_attrs_in_scope(self.syntax())
    }

    fn ink_attrs_closest_descendants(&self) -> Vec<InkAttribute> {
        utils::ink_attrs_closest_descendants(self.syntax())
    }

    fn ink_attrs_ancestors(&self) -> Vec<InkAttribute> {
        utils::ink_attrs_ancestors(self.syntax())
    }

    fn ink_attrs_closest_ancestors(&self) -> Vec<InkAttribute> {
        utils::ink_attrs_closest_ancestors(self.syntax())
    }
}