sqry-core 11.0.1

Core library for sqry - semantic code search engine
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

//! Scope types for context-aware search.

use serde::{Deserialize, Serialize};
use std::path::PathBuf;

/// Unique identifier for a scope within a file.
///
/// Scope IDs are assigned sequentially during scope extraction, starting from 0.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ScopeId(pub usize);

impl ScopeId {
    /// Create a new `ScopeId`.
    #[must_use]
    pub fn new(id: usize) -> Self {
        Self(id)
    }
}

impl From<usize> for ScopeId {
    fn from(id: usize) -> Self {
        Self(id)
    }
}

impl From<ScopeId> for usize {
    fn from(id: ScopeId) -> Self {
        id.0
    }
}

/// Scope information for context-aware search.
///
/// Represents a lexical scope in source code (function, class, module, etc.).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Scope {
    /// Unique identifier for this scope (file-local).
    ///
    /// Assigned during extraction, sequential starting from 0.
    pub id: ScopeId,

    /// Scope type (function, class, module, etc.).
    pub scope_type: String,

    /// Scope name.
    pub name: String,

    /// File path where scope is defined.
    pub file_path: PathBuf,

    /// Line number where scope starts (1-based).
    pub start_line: usize,

    /// Column where scope starts (0-based).
    pub start_column: usize,

    /// Line number where scope ends (1-based).
    pub end_line: usize,

    /// Column where scope ends (0-based).
    pub end_column: usize,

    /// Parent scope ID (immediate containing scope).
    ///
    /// Set by `link_nested_scopes()` algorithm.
    pub parent_id: Option<ScopeId>,
}

impl Scope {
    /// Create a new scope.
    #[must_use]
    pub fn new(scope_type: String, name: String, file_path: PathBuf) -> Self {
        Self {
            id: ScopeId::new(0),
            scope_type,
            name,
            file_path,
            start_line: 0,
            start_column: 0,
            end_line: 0,
            end_column: 0,
            parent_id: None,
        }
    }

    /// Set the location (start and end position).
    #[must_use]
    pub fn with_location(
        mut self,
        start_line: usize,
        start_column: usize,
        end_line: usize,
        end_column: usize,
    ) -> Self {
        self.start_line = start_line;
        self.start_column = start_column;
        self.end_line = end_line;
        self.end_column = end_column;
        self
    }

    /// Set the parent scope ID.
    #[must_use]
    pub fn with_parent(mut self, parent_id: ScopeId) -> Self {
        self.parent_id = Some(parent_id);
        self
    }
}