ink-analyzer-ir 0.16.1

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

//! Common traits for ink! entities.

use ra_ap_syntax::{AstNode, SyntaxNode, TextSize};

use crate::attrs::InkAttribute;
use crate::tree::{InkTree, ItemAtOffset};

/// Generic representation of an ink! entity (e.g. Contract, Storage, Event, Constructor e.t.c).
pub trait InkEntity {
    /// Associated AST node type.
    type AST: AstNode;

    /// Returns true if an ink! entity can be derived from the syntax node.
    ///
    /// The input syntax node can either be an attribute or an item.
    fn can_cast(node: &SyntaxNode) -> bool;

    /// Returns an ink! entity if one can be derived for the syntax node.
    ///
    /// The input syntax node can either be an attribute or an item.
    fn cast(node: SyntaxNode) -> Option<Self>
    where
        Self: Sized;

    /// Returns the root syntax node for the ink! entity.
    fn syntax(&self) -> &SyntaxNode;

    /// Returns the AST node for the ink! entity.
    fn ast(&self) -> Option<&Self::AST>;

    /// Returns the ink! attribute the ink! entity was derived from (if any).
    fn ink_attr(&self) -> Option<&InkAttribute>;

    /// Returns ink! entity tree.
    fn tree(&self) -> InkTree<'_> {
        InkTree::new(self.syntax())
    }

    /// Returns a representation of a token in the subtree which covers the position.
    fn item_at_offset(&self, offset: TextSize) -> ItemAtOffset {
        ItemAtOffset::new(self.syntax(), offset)
    }
}