tldr-core 0.1.2

Core analysis engine for TLDR code analysis tool
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
//! Java class extraction for inheritance analysis
//!
//! Extracts class, interface, enum, and record definitions from Java source code
//! using tree-sitter. Handles:
//! - Class inheritance (extends)
//! - Interface implementation (implements)
//! - Abstract classes
//! - Interface declarations (with extends)
//! - Enum declarations (with implements)
//! - Record declarations (with implements)
//! - Generic type parameters (stripped to base type)
//! - Scoped/qualified type names (e.g., Outer.Inner)

use std::path::Path;

use tree_sitter::{Node, Tree};

use crate::ast::parser::ParserPool;
use crate::types::{InheritanceNode, Language};
use crate::TldrResult;

/// Extract class, interface, enum, and record definitions from Java source code
pub fn extract_classes(
    source: &str,
    file_path: &Path,
    parser_pool: &ParserPool,
) -> TldrResult<Vec<InheritanceNode>> {
    let tree = parser_pool.parse(source, Language::Java)?;
    let mut classes = Vec::new();

    extract_declarations(&tree, source, file_path, &mut classes);

    Ok(classes)
}

fn extract_declarations(
    tree: &Tree,
    source: &str,
    file_path: &Path,
    classes: &mut Vec<InheritanceNode>,
) {
    let root = tree.root_node();
    visit_node(&root, source, file_path, classes);
}

fn visit_node(node: &Node, source: &str, file_path: &Path, classes: &mut Vec<InheritanceNode>) {
    match node.kind() {
        "class_declaration" => {
            if let Some(class) = extract_class(node, source, file_path) {
                classes.push(class);
            }
        }
        "interface_declaration" => {
            if let Some(iface) = extract_interface(node, source, file_path) {
                classes.push(iface);
            }
        }
        "enum_declaration" => {
            if let Some(enum_node) = extract_enum(node, source, file_path) {
                classes.push(enum_node);
            }
        }
        "record_declaration" => {
            if let Some(record) = extract_record(node, source, file_path) {
                classes.push(record);
            }
        }
        _ => {}
    }

    // Recurse into children
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        visit_node(&child, source, file_path, classes);
    }
}

/// Extract a class_declaration node.
///
/// Java grammar fields:
/// - `name` -> identifier
/// - `superclass` -> superclass node containing a type
/// - `interfaces` -> super_interfaces node containing a type_list
/// - modifiers child may contain "abstract" keyword
fn extract_class(node: &Node, source: &str, file_path: &Path) -> Option<InheritanceNode> {
    let name_node = node.child_by_field_name("name")?;
    let name = name_node.utf8_text(source.as_bytes()).ok()?.to_string();

    let line = node.start_position().row as u32 + 1;
    let mut class_node = InheritanceNode::new(name, file_path.to_path_buf(), line, Language::Java);

    let mut bases = Vec::new();

    // Extract superclass (extends)
    if let Some(superclass) = node.child_by_field_name("superclass") {
        extract_types_from_node(&superclass, source, &mut bases);
    }

    // Extract interfaces (implements)
    if let Some(interfaces) = node.child_by_field_name("interfaces") {
        extract_type_list_from_node(&interfaces, source, &mut bases);
    }

    class_node.bases = bases;

    // Check for abstract modifier
    if has_modifier(node, source, "abstract") {
        class_node.is_abstract = Some(true);
    }

    Some(class_node)
}

/// Extract an interface_declaration node.
///
/// Java grammar:
/// - `name` -> identifier
/// - child `extends_interfaces` containing a type_list
fn extract_interface(node: &Node, source: &str, file_path: &Path) -> Option<InheritanceNode> {
    let name_node = node.child_by_field_name("name")?;
    let name = name_node.utf8_text(source.as_bytes()).ok()?.to_string();

    let line = node.start_position().row as u32 + 1;
    let mut iface_node = InheritanceNode::new(name, file_path.to_path_buf(), line, Language::Java);
    iface_node.interface = Some(true);

    let mut bases = Vec::new();

    // Interface extends are in a child node called "extends_interfaces"
    for i in 0..node.child_count() {
        if let Some(child) = node.child(i) {
            if child.kind() == "extends_interfaces" {
                extract_type_list_from_node(&child, source, &mut bases);
            }
        }
    }

    iface_node.bases = bases;

    Some(iface_node)
}

/// Extract an enum_declaration node.
///
/// Java grammar:
/// - `name` -> identifier
/// - `interfaces` -> super_interfaces containing type_list
fn extract_enum(node: &Node, source: &str, file_path: &Path) -> Option<InheritanceNode> {
    let name_node = node.child_by_field_name("name")?;
    let name = name_node.utf8_text(source.as_bytes()).ok()?.to_string();

    let line = node.start_position().row as u32 + 1;
    let mut enum_node = InheritanceNode::new(name, file_path.to_path_buf(), line, Language::Java);

    let mut bases = Vec::new();

    // Enums can implement interfaces
    if let Some(interfaces) = node.child_by_field_name("interfaces") {
        extract_type_list_from_node(&interfaces, source, &mut bases);
    }

    enum_node.bases = bases;

    Some(enum_node)
}

/// Extract a record_declaration node.
///
/// Java grammar:
/// - `name` -> identifier
/// - `interfaces` -> super_interfaces containing type_list
fn extract_record(node: &Node, source: &str, file_path: &Path) -> Option<InheritanceNode> {
    let name_node = node.child_by_field_name("name")?;
    let name = name_node.utf8_text(source.as_bytes()).ok()?.to_string();

    let line = node.start_position().row as u32 + 1;
    let mut record_node = InheritanceNode::new(name, file_path.to_path_buf(), line, Language::Java);

    let mut bases = Vec::new();

    // Records can implement interfaces
    if let Some(interfaces) = node.child_by_field_name("interfaces") {
        extract_type_list_from_node(&interfaces, source, &mut bases);
    }

    record_node.bases = bases;

    Some(record_node)
}

/// Extract types directly from a node (e.g., superclass node contains a single type)
fn extract_types_from_node(node: &Node, source: &str, bases: &mut Vec<String>) {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if let Some(name) = extract_type_name(&child, source) {
            bases.push(name);
        }
    }
}

/// Extract types from a node that contains a type_list child (e.g., super_interfaces, extends_interfaces)
fn extract_type_list_from_node(node: &Node, source: &str, bases: &mut Vec<String>) {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if child.kind() == "type_list" {
            let mut inner_cursor = child.walk();
            for type_child in child.children(&mut inner_cursor) {
                if let Some(name) = extract_type_name(&type_child, source) {
                    bases.push(name);
                }
            }
        } else if let Some(name) = extract_type_name(&child, source) {
            // Direct type child (fallback)
            bases.push(name);
        }
    }
}

/// Extract a type name from a type node.
///
/// Handles:
/// - `type_identifier` -> "Animal"
/// - `generic_type` -> "List" (strips type parameters)
/// - `scoped_type_identifier` -> "Outer.Inner" (qualified name)
fn extract_type_name(node: &Node, source: &str) -> Option<String> {
    match node.kind() {
        "type_identifier" => node
            .utf8_text(source.as_bytes())
            .ok()
            .map(|s| s.to_string()),
        "generic_type" => {
            // Generic<T> -> just the base type name
            // First named child should be type_identifier or scoped_type_identifier
            for i in 0..node.child_count() {
                if let Some(child) = node.child(i) {
                    match child.kind() {
                        "type_identifier" => {
                            return child
                                .utf8_text(source.as_bytes())
                                .ok()
                                .map(|s| s.to_string());
                        }
                        "scoped_type_identifier" => {
                            return extract_scoped_type_name(&child, source);
                        }
                        _ => {}
                    }
                }
            }
            None
        }
        "scoped_type_identifier" => extract_scoped_type_name(node, source),
        _ => None,
    }
}

/// Extract a scoped type identifier like `java.util.List` or `Outer.Inner`.
/// Returns the full dotted name.
fn extract_scoped_type_name(node: &Node, source: &str) -> Option<String> {
    node.utf8_text(source.as_bytes())
        .ok()
        .map(|s| s.to_string())
}

/// Check if a declaration node has a specific modifier (e.g., "abstract", "final")
fn has_modifier(node: &Node, source: &str, modifier: &str) -> bool {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if child.kind() == "modifiers" {
            let mut mod_cursor = child.walk();
            for mod_child in child.children(&mut mod_cursor) {
                if let Ok(text) = mod_child.utf8_text(source.as_bytes()) {
                    if text == modifier {
                        return true;
                    }
                }
            }
        }
    }
    false
}

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

    fn parse_and_extract(source: &str) -> Vec<InheritanceNode> {
        let pool = ParserPool::new();
        extract_classes(source, &PathBuf::from("Test.java"), &pool).unwrap()
    }

    #[test]
    fn test_simple_class() {
        let source = r#"
public class Animal {
    public void speak() {}
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 1);
        assert_eq!(classes[0].name, "Animal");
        assert!(classes[0].bases.is_empty());
        assert_eq!(classes[0].language, Language::Java);
    }

    #[test]
    fn test_class_extends() {
        let source = r#"
public class Animal {}

public class Dog extends Animal {
    public void bark() {}
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 2);

        let dog = classes.iter().find(|c| c.name == "Dog").unwrap();
        assert!(dog.bases.contains(&"Animal".to_string()));
    }

    #[test]
    fn test_class_implements() {
        let source = r#"
public interface Serializable {
    String serialize();
}

public class Dog implements Serializable {
    public String serialize() { return "{}"; }
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 2);

        let serializable = classes.iter().find(|c| c.name == "Serializable").unwrap();
        assert_eq!(serializable.interface, Some(true));

        let dog = classes.iter().find(|c| c.name == "Dog").unwrap();
        assert!(dog.bases.contains(&"Serializable".to_string()));
    }

    #[test]
    fn test_class_extends_and_implements() {
        let source = r#"
public class Animal {}

public interface Serializable {}
public interface Runnable {}

public class Dog extends Animal implements Serializable, Runnable {
}
"#;
        let classes = parse_and_extract(source);
        let dog = classes.iter().find(|c| c.name == "Dog").unwrap();
        assert!(dog.bases.contains(&"Animal".to_string()));
        assert!(dog.bases.contains(&"Serializable".to_string()));
        assert!(dog.bases.contains(&"Runnable".to_string()));
        assert_eq!(dog.bases.len(), 3);
    }

    #[test]
    fn test_abstract_class() {
        let source = r#"
public abstract class Shape {
    abstract double area();
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 1);
        assert_eq!(classes[0].name, "Shape");
        assert_eq!(classes[0].is_abstract, Some(true));
    }

    #[test]
    fn test_interface_extends() {
        let source = r#"
public interface Comparable<T> {}

public interface Sortable extends Comparable<String> {
    void sort();
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 2);

        let sortable = classes.iter().find(|c| c.name == "Sortable").unwrap();
        assert_eq!(sortable.interface, Some(true));
        assert!(sortable.bases.contains(&"Comparable".to_string()));
    }

    #[test]
    fn test_interface_extends_multiple() {
        let source = r#"
public interface A {}
public interface B {}

public interface C extends A, B {
}
"#;
        let classes = parse_and_extract(source);
        let c = classes.iter().find(|c| c.name == "C").unwrap();
        assert_eq!(c.interface, Some(true));
        assert!(c.bases.contains(&"A".to_string()));
        assert!(c.bases.contains(&"B".to_string()));
        assert_eq!(c.bases.len(), 2);
    }

    #[test]
    fn test_enum_implements() {
        let source = r#"
public interface Displayable {}

public enum Color implements Displayable {
    RED, GREEN, BLUE
}
"#;
        let classes = parse_and_extract(source);
        let color = classes.iter().find(|c| c.name == "Color").unwrap();
        assert!(color.bases.contains(&"Displayable".to_string()));
    }

    #[test]
    fn test_generic_extends() {
        let source = r#"
public class ArrayList<E> extends AbstractList<E> implements List<E> {
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 1);
        assert!(classes[0].bases.contains(&"AbstractList".to_string()));
        assert!(classes[0].bases.contains(&"List".to_string()));
    }

    #[test]
    fn test_nested_class() {
        let source = r#"
public class Outer {
    public class Inner extends Outer {
    }
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 2);

        let inner = classes.iter().find(|c| c.name == "Inner").unwrap();
        assert!(inner.bases.contains(&"Outer".to_string()));
    }

    #[test]
    fn test_scoped_type_extends() {
        let source = r#"
public class Child extends com.example.Parent {
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 1);
        assert!(classes[0].bases.contains(&"com.example.Parent".to_string()));
    }

    #[test]
    fn test_record_implements() {
        let source = r#"
public interface Printable {}

public record Point(int x, int y) implements Printable {
}
"#;
        let classes = parse_and_extract(source);
        let point = classes.iter().find(|c| c.name == "Point").unwrap();
        assert!(point.bases.contains(&"Printable".to_string()));
    }

    #[test]
    fn test_class_no_abstract_without_modifier() {
        let source = r#"
public class Concrete {
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 1);
        assert_eq!(classes[0].is_abstract, None);
    }

    #[test]
    fn test_enum_no_bases() {
        let source = r#"
public enum Direction {
    NORTH, SOUTH, EAST, WEST
}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 1);
        assert_eq!(classes[0].name, "Direction");
        assert!(classes[0].bases.is_empty());
    }

    #[test]
    fn test_complex_hierarchy() {
        let source = r#"
public interface Serializable {}
public interface Comparable<T> {}
public abstract class AbstractEntity implements Serializable {}
public class User extends AbstractEntity implements Comparable<User> {}
"#;
        let classes = parse_and_extract(source);
        assert_eq!(classes.len(), 4);

        let entity = classes.iter().find(|c| c.name == "AbstractEntity").unwrap();
        assert_eq!(entity.is_abstract, Some(true));
        assert!(entity.bases.contains(&"Serializable".to_string()));

        let user = classes.iter().find(|c| c.name == "User").unwrap();
        assert!(user.bases.contains(&"AbstractEntity".to_string()));
        assert!(user.bases.contains(&"Comparable".to_string()));
    }
}