asterisk 0.1.0

Universal language-agnostic AST walking and accurate call stack generation with tree-sitter
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

use serde::{Deserialize, Serialize};

/// Represents the type of a code block.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum BlockType {
    /// A block that represents a function.
    Function,
    /// A block that does not represent a function.
    NonFunction,
}

/// Represents a block of code, which can be a function or a non-function block.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Block {
    /// The unique key for the block.
    pub node_key: String,
    /// The type of the block (function or non-function).
    pub block_type: BlockType,
    /// The content of the block (i.e., the code).
    pub content: String,
    /// The name of the function, if the block is a function block.
    pub function_name: Option<String>,
    /// The name of the class containing the block, if applicable.
    pub class_name: Option<String>,
    /// The keys of the blocks called by this block.
    pub outgoing_calls: Vec<String>,
}

impl Block {
    /// Creates a new `Block` with the given parameters.
    ///
    /// # Arguments
    ///
    /// * `node_key` - The unique key for the block.
    /// * `block_type` - The type of the block (function or non-function).
    /// * `content` - The content of the block (i.e., the code).
    /// * `function_name` - The name of the function, if the block is a function block.
    /// * `class_name` - The name of the class containing the block, if applicable.
    ///
    /// # Returns
    ///
    /// A new `Block` instance with the specified parameters and an empty `outgoing_calls` vector.
    pub fn new(
        node_key: String,
        block_type: BlockType,
        content: String,
        function_name: Option<String>,
        class_name: Option<String>,
    ) -> Self {
        Block {
            node_key,
            block_type,
            content,
            function_name,
            class_name,
            outgoing_calls: Vec::new(),
        }
    }
}