debtmap 0.21.1

Code complexity and technical debt 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use tree_sitter::Node;

use super::*;
use crate::analyzers::solidity::effects::{modifier_bodies_by_name, state_variable_names};
use crate::analyzers::solidity::types::{ContractInfo, ContractKind};

pub(super) fn legacy_analyze_ast(
    ast: &SolidityAst,
    config: &SolidityLanguageConfig,
) -> SolidityAnalysis {
    let root = ast.tree.root_node();
    let mut analysis = SolidityAnalysis {
        is_test_file: crate::analyzers::solidity::test_detection::is_test_context(
            &ast.path,
            &ast.source,
            None,
        ),
        has_floating_pragma: crate::analyzers::solidity::test_detection::has_floating_pragma(
            &ast.source,
        ),
        ..Default::default()
    };
    collect_contracts(root, ast, &mut analysis.contracts);
    let modifiers = modifier_bodies_by_name(root, &ast.source);
    collect_callables(
        root,
        ast,
        config,
        None,
        &analysis.contracts,
        &modifiers,
        &mut analysis.functions,
    );
    analysis
        .functions
        .sort_by(|a, b| a.line.cmp(&b.line).then_with(|| a.name.cmp(&b.name)));
    analysis
}

pub(super) fn count_advisory_callables(node: Node) -> usize {
    let mut count = usize::from(matches!(
        node.kind(),
        "function_definition" | "modifier_definition" | "constructor" | "fallback" | "receive"
    ));
    walk_children(node, |child| count += count_advisory_callables(child));
    count
}

fn collect_contracts(node: Node, ast: &SolidityAst, contracts: &mut Vec<ContractInfo>) {
    if let Some(contract) = contract_from_node(node, ast) {
        contracts.push(contract);
    }
    walk_children(node, |child| collect_contracts(child, ast, contracts));
}

fn contract_from_node(node: Node, ast: &SolidityAst) -> Option<ContractInfo> {
    let (kind, name) = match node.kind() {
        "contract_declaration" => (ContractKind::Contract, node.child_by_field_name("name")?),
        "interface_declaration" => (ContractKind::Interface, node.child_by_field_name("name")?),
        "library_declaration" => (ContractKind::Library, node.child_by_field_name("name")?),
        _ => return None,
    };
    Some(ContractInfo {
        name: node_text(&name, &ast.source).to_string(),
        kind,
        base_classes: inheritance_names(node, ast),
        state_variable_count: count_nodes(node, "state_variable_declaration"),
        function_count: count_visitor_callables(node),
        state_variables: state_variable_names(node, &ast.source),
    })
}

fn collect_callables<'tree>(
    node: Node<'tree>,
    ast: &SolidityAst,
    config: &SolidityLanguageConfig,
    contract_name: Option<String>,
    contracts: &[ContractInfo],
    modifiers: &std::collections::HashMap<String, Node<'tree>>,
    functions: &mut Vec<SolidityFunction>,
) {
    let current_contract = contract_name.or_else(|| ancestor_contract_name(node, ast));
    if let Some(function) = callable_from_node(
        node,
        ast,
        config,
        current_contract.clone(),
        contracts,
        modifiers,
    ) {
        functions.push(function);
    }
    let next_contract = next_contract(node, ast, current_contract);
    walk_children(node, |child| {
        collect_callables(
            child,
            ast,
            config,
            next_contract.clone(),
            contracts,
            modifiers,
            functions,
        )
    });
}

fn next_contract(node: Node, ast: &SolidityAst, current: Option<String>) -> Option<String> {
    if !is_contract_node(node) {
        return current;
    }
    node.child_by_field_name("name")
        .map(|name| node_text(&name, &ast.source).to_string())
        .or(current)
}

fn ancestor_contract_name(node: Node, ast: &SolidityAst) -> Option<String> {
    let mut current = node.parent();
    while let Some(parent) = current {
        if is_contract_node(parent)
            && let Some(name) = parent.child_by_field_name("name")
        {
            return Some(node_text(&name, &ast.source).to_string());
        }
        current = parent.parent();
    }
    None
}

fn inheritance_names(node: Node, ast: &SolidityAst) -> Vec<String> {
    let mut names = Vec::new();
    walk_children(node, |child| {
        if child.kind() == "inheritance_specifier"
            && let Some(name) = child.child_by_field_name("name")
        {
            names.push(node_text(&name, &ast.source).to_string());
        }
    });
    names
}

fn count_nodes(node: Node, kind: &str) -> usize {
    let mut count = usize::from(node.kind() == kind);
    walk_children(node, |child| count += count_nodes(child, kind));
    count
}

fn count_visitor_callables(node: Node) -> usize {
    let mut count = usize::from(matches!(
        node.kind(),
        "function_definition"
            | "modifier_definition"
            | "constructor"
            | "constructor_definition"
            | "fallback"
            | "receive"
    ));
    walk_children(node, |child| count += count_visitor_callables(child));
    count
}

fn is_contract_node(node: Node) -> bool {
    matches!(
        node.kind(),
        "contract_declaration" | "interface_declaration" | "library_declaration"
    )
}

fn walk_children(node: Node, mut visit: impl FnMut(Node)) {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        visit(child);
    }
}