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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

use crate::call_stack::CallStackNode;
use std::collections::HashMap;

/// Represents a call graph, which is a directed graph of function calls.
///
/// The `CallGraph` is used to represent the relationships between functions in a program,
/// where each node corresponds to a function and each edge represents a function call.
pub struct CallGraph {
    /// A map of node keys to their corresponding `CallStackNode`s.
    nodes: HashMap<String, CallStackNode>,
    /// A vector of edges, where each edge is a tuple of the caller and callee node keys.
    edges: Vec<(String, String)>,
}

impl CallGraph {
    /// Creates a new, empty `CallGraph`.
    pub fn new() -> Self {
        CallGraph {
            nodes: HashMap::new(),
            edges: Vec::new(),
        }
    }

    /// Adds a new node to the call graph.
    ///
    /// # Arguments
    ///
    /// * `node_key` - The unique key for the node.
    /// * `node` - The `CallStackNode` to add.
    pub fn add_node(&mut self, node_key: String, node: CallStackNode) {
        self.nodes.insert(node_key, node);
    }

    /// Adds a new edge to the call graph.
    ///
    /// # Arguments
    ///
    /// * `from` - The key of the caller node.
    /// * `to` - The key of the callee node.
    pub fn add_edge(&mut self, from: String, to: String) {
        self.edges.push((from, to));
    }

    /// Converts the `CallGraph` to a Graphviz DOT format string.
    ///
    /// # Returns
    ///
    /// A string containing the Graphviz DOT representation of the call graph.
    pub fn to_graphviz(&self) -> String {
        let mut graphviz = String::from("digraph CallGraph {\n");
        graphviz.push_str("  rankdir=LR;\n");
        graphviz.push_str("  node [shape=box];\n");

        for (node_key, node) in &self.nodes {
            let file_name = node.file_path.split('/').last().unwrap_or("");
            let mut node_label = format!("{}::{}", file_name, node.function_name);
            if let Some(class_name) = &node.class_name {
                node_label = format!(
                    "{}::{}",
                    file_name,
                    format!("{}::{}", class_name, node.function_name)
                );
            }
            graphviz.push_str(&format!("  \"{}\" [label=\"{}\"];\n", node_key, node_label));
        }

        for (from, to) in &self.edges {
            graphviz.push_str(&format!("  \"{}\" -> \"{}\";\n", from, to));
        }

        graphviz.push('}');
        graphviz
    }
}