codegraph-rust 0.2.1

Rust parser for CodeGraph - extracts code entities and relationships from Rust source files
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
//! AST extraction for Rust source code using tree-sitter
//!
//! This module parses Rust source code and extracts entities and relationships
//! into a CodeIR representation.

use codegraph_parser_api::{CodeIR, ModuleEntity, ParserConfig, ParserError};
use std::path::Path;
use tree_sitter::Parser;

use crate::visitor::RustVisitor;

/// Extract code entities and relationships from Rust source code
///
/// # Arguments
/// * `source` - Rust source code as a string
/// * `file_path` - Path to the source file
/// * `config` - Parser configuration
///
/// # Returns
/// CodeIR containing all extracted entities and relationships
pub fn extract(
    source: &str,
    file_path: &Path,
    config: &ParserConfig,
) -> Result<CodeIR, ParserError> {
    // Initialize tree-sitter parser
    let mut parser = Parser::new();
    parser
        .set_language(tree_sitter_rust::language())
        .map_err(|e| ParserError::ParseError(file_path.to_path_buf(), e.to_string()))?;

    // Parse the source code
    let tree = parser.parse(source, None).ok_or_else(|| {
        ParserError::ParseError(file_path.to_path_buf(), "Failed to parse".to_string())
    })?;

    let root_node = tree.root_node();
    if root_node.has_error() {
        // Find the first error node for better error reporting
        let mut cursor = root_node.walk();
        let error_node = root_node.children(&mut cursor).find(|n| n.is_error());

        if let Some(err) = error_node {
            return Err(ParserError::SyntaxError(
                file_path.to_path_buf(),
                err.start_position().row + 1,
                err.start_position().column,
                "Syntax error".to_string(),
            ));
        }

        return Err(ParserError::SyntaxError(
            file_path.to_path_buf(),
            0,
            0,
            "Syntax error".to_string(),
        ));
    }

    // Create IR for this file
    let mut ir = CodeIR::new(file_path.to_path_buf());

    // Create module entity for the file
    let module_name = file_path
        .file_stem()
        .and_then(|s| s.to_str())
        .unwrap_or("unknown")
        .to_string();

    let module = ModuleEntity {
        name: module_name.clone(),
        path: file_path.display().to_string(),
        language: "rust".to_string(),
        line_count: source.lines().count(),
        doc_comment: extract_file_doc(source, &tree),
        attributes: Vec::new(),
    };

    ir.module = Some(module);

    // Create visitor and walk the AST
    let mut visitor = RustVisitor::new(source.as_bytes(), config.clone());
    visitor.visit_node(root_node);

    // Transfer extracted entities to IR
    ir.functions = visitor.functions;
    ir.classes = visitor.classes;
    ir.traits = visitor.traits;
    ir.imports = visitor.imports;
    ir.calls = visitor.calls;
    ir.implementations = visitor.implementations;
    ir.inheritance = visitor.inheritance;

    Ok(ir)
}

/// Extract documentation from the file level (if any)
fn extract_file_doc(source: &str, tree: &tree_sitter::Tree) -> Option<String> {
    let root = tree.root_node();
    let mut cursor = root.walk();
    let mut docs = Vec::new();

    // Look for inner doc comments (//!) at the start of the file
    for child in root.children(&mut cursor) {
        if child.kind() == "line_comment" {
            let text = child.utf8_text(source.as_bytes()).unwrap_or("");
            if text.starts_with("//!") {
                docs.push(text[3..].trim().to_string());
            }
        } else if child.kind() != "attribute_item" {
            // Stop looking once we hit non-doc content
            break;
        }
    }

    if docs.is_empty() {
        None
    } else {
        Some(docs.join("\n"))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_extract_simple_function() {
        let source = r#"
fn hello() {
    println!("Hello, world!");
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.functions.len(), 1);
        assert_eq!(ir.functions[0].name, "hello");
        assert_eq!(ir.functions[0].line_start, 2);
    }

    #[test]
    fn test_extract_struct() {
        let source = r#"
pub struct MyStruct {
    field1: String,
    field2: i32,
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.classes.len(), 1);
        assert_eq!(ir.classes[0].name, "MyStruct");
        assert_eq!(ir.classes[0].line_start, 2);
    }

    #[test]
    fn test_extract_trait() {
        let source = r#"
pub trait MyTrait {
    fn method(&self);
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.traits.len(), 1);
        assert_eq!(ir.traits[0].name, "MyTrait");
    }

    #[test]
    fn test_syntax_error() {
        let source = "fn hello( { "; // Invalid syntax
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            ParserError::SyntaxError(_, _, _, _)
        ));
    }

    #[test]
    fn test_extract_enum() {
        let source = r#"
pub enum Color {
    Red,
    Green,
    Blue,
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.classes.len(), 1);
        assert_eq!(ir.classes[0].name, "Color");
    }

    #[test]
    fn test_extract_impl_block() {
        let source = r#"
struct Calculator;

impl Calculator {
    fn add(&self, a: i32, b: i32) -> i32 {
        a + b
    }
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.classes.len(), 1);
        // Method should be extracted
        assert!(!ir.functions.is_empty() || !ir.classes[0].methods.is_empty());
    }

    #[test]
    fn test_extract_async_function() {
        let source = r#"
async fn fetch_data() -> String {
    "data".to_string()
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.functions.len(), 1);
        assert_eq!(ir.functions[0].name, "fetch_data");
        assert!(ir.functions[0].is_async);
    }

    #[test]
    fn test_extract_use_statement() {
        let source = r#"
use std::collections::HashMap;
use std::fs;

fn test() {}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.imports.len(), 2);
    }

    #[test]
    fn test_extract_multiple_entities() {
        let source = r#"
use std::fmt;

pub trait Display {
    fn display(&self) -> String;
}

pub struct Person {
    name: String,
    age: u32,
}

impl Display for Person {
    fn display(&self) -> String {
        format!("{}: {}", self.name, self.age)
    }
}

pub fn greet(p: &Person) {
    println!("{}", p.display());
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.traits.len(), 1);
        assert_eq!(ir.traits[0].name, "Display");
        assert_eq!(ir.classes.len(), 1);
        assert_eq!(ir.classes[0].name, "Person");
        assert!(!ir.functions.is_empty()); // greet function
        assert!(!ir.imports.is_empty()); // use std::fmt
    }

    #[test]
    fn test_extract_generic_struct() {
        let source = r#"
pub struct Container<T> {
    value: T,
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.classes.len(), 1);
        assert_eq!(ir.classes[0].name, "Container");
    }

    #[test]
    fn test_extract_module_info() {
        let source = r#"
fn test() {
    println!("test");
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("module.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert!(ir.module.is_some());
        let module = ir.module.unwrap();
        assert_eq!(module.name, "module");
        assert_eq!(module.language, "rust");
        assert!(module.line_count > 0);
    }

    #[test]
    fn test_extract_visibility_modifiers() {
        let source = r#"
pub fn public_fn() {}
fn private_fn() {}
pub(crate) fn crate_fn() {}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.functions.len(), 3);
    }

    #[test]
    fn test_extract_trait_implementation() {
        let source = r#"
pub trait Speak {
    fn speak(&self);
}

pub struct Dog;

impl Speak for Dog {
    fn speak(&self) {
        println!("Woof!");
    }
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.traits.len(), 1);
        assert_eq!(ir.classes.len(), 1);
        assert!(!ir.implementations.is_empty() || !ir.classes[0].implemented_traits.is_empty());
    }

    #[test]
    fn test_extract_test_function() {
        let source = r#"
#[test]
fn test_something() {
    assert_eq!(2 + 2, 4);
}
"#;
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.functions.len(), 1);
        assert!(ir.functions[0].is_test);
    }

    #[test]
    fn test_accurate_line_numbers() {
        let source = "fn first() {}\n\nfn second() {}";
        let config = ParserConfig::default();
        let result = extract(source, Path::new("test.rs"), &config);

        assert!(result.is_ok());
        let ir = result.unwrap();
        assert_eq!(ir.functions.len(), 2);
        assert_eq!(ir.functions[0].name, "first");
        assert_eq!(ir.functions[0].line_start, 1);
        assert_eq!(ir.functions[1].name, "second");
        assert_eq!(ir.functions[1].line_start, 3);
    }
}