debtmap 0.16.6

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

use serde::{Deserialize, Serialize};
use syn::spanned::Spanned;
use syn::{Expr, Item, Stmt, Type};

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct SourceLocation {
    pub line: usize,
    pub column: Option<usize>,
    pub end_line: Option<usize>,
    pub end_column: Option<usize>,
    pub confidence: LocationConfidence,
}

impl Default for SourceLocation {
    fn default() -> Self {
        Self {
            line: 1,
            column: None,
            end_line: None,
            end_column: None,
            confidence: LocationConfidence::Unavailable,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum LocationConfidence {
    Exact,       // Precise syn::Span information
    Approximate, // Estimated from surrounding context
    Unavailable, // No location information available
}

/// Common utilities for all detectors to extract source locations
#[derive(Clone)]
pub struct UnifiedLocationExtractor {}

impl UnifiedLocationExtractor {
    pub fn new(_source_content: &str) -> Self {
        Self {}
    }

    /// Extract location from any syn AST node that implements Spanned
    pub fn extract_location<T: Spanned>(&self, node: &T) -> SourceLocation {
        let span = node.span();
        self.span_to_location(span).unwrap_or_default()
    }

    /// Extract location from item definitions (structs, enums, functions)
    pub fn extract_item_location(&self, item: &Item) -> SourceLocation {
        self.extract_location(item)
    }

    /// Extract location from expressions
    pub fn extract_expr_location(&self, expr: &Expr) -> SourceLocation {
        self.extract_location(expr)
    }

    /// Extract location from type definitions
    pub fn extract_type_location(&self, ty: &Type) -> SourceLocation {
        self.extract_location(ty)
    }

    /// Extract location from statements
    pub fn extract_stmt_location(&self, stmt: &Stmt) -> SourceLocation {
        self.extract_location(stmt)
    }

    fn span_to_location(&self, span: proc_macro2::Span) -> Option<SourceLocation> {
        // syn::Span provides line and column information
        let start = span.start();
        let end = span.end();

        // syn line numbers are 1-based
        let line = start.line;
        let column = Some(start.column);
        let end_line = if end.line != start.line {
            Some(end.line)
        } else {
            None
        };
        let end_column = if end.line != start.line || end.column != start.column {
            Some(end.column)
        } else {
            None
        };

        Some(SourceLocation {
            line,
            column,
            end_line,
            end_column,
            confidence: LocationConfidence::Exact,
        })
    }
}