car-ast 0.14.0

Tree-sitter AST parsing for code-aware inference
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
use super::{extract_doc_comment, node_text};
use crate::types::*;

pub fn extract(tree: &tree_sitter::Tree, source: &[u8]) -> (Vec<Symbol>, Vec<Import>) {
    let root = tree.root_node();
    let mut symbols = Vec::new();
    let mut imports = Vec::new();

    extract_children(&root, source, &mut symbols, &mut imports, None);

    (symbols, imports)
}

fn extract_children(
    node: &tree_sitter::Node,
    source: &[u8],
    symbols: &mut Vec<Symbol>,
    imports: &mut Vec<Import>,
    parent_name: Option<&str>,
) {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        match child.kind() {
            "import_declaration" => {
                let text = node_text(&child, source).trim().to_string();
                let path = text
                    .strip_prefix("import")
                    .unwrap_or(&text)
                    .trim()
                    .to_string();
                imports.push(Import {
                    path,
                    alias: None,
                    span: Span::from_node(&child),
                });
            }
            "function_declaration" => {
                if let Some(sym) = extract_function(&child, source, parent_name) {
                    symbols.push(sym);
                }
            }
            "protocol_function_declaration" => {
                if let Some(sym) = extract_function(&child, source, parent_name) {
                    symbols.push(sym);
                }
            }
            "class_declaration" => {
                // tree-sitter-swift uses class_declaration for struct, class, and enum
                let kind = detect_class_kind(&child, source);
                if let Some(sym) = extract_type_decl(&child, source, kind, parent_name) {
                    symbols.push(sym);
                }
            }
            "protocol_declaration" => {
                if let Some(sym) = extract_protocol(&child, source, parent_name) {
                    symbols.push(sym);
                }
            }
            "property_declaration" => {
                if let Some(sym) = extract_property(&child, source, parent_name) {
                    symbols.push(sym);
                }
            }
            "typealias_declaration" => {
                if let Some(sym) = extract_typealias(&child, source, parent_name) {
                    symbols.push(sym);
                }
            }
            // Recurse into body nodes
            "class_body" | "enum_class_body" | "protocol_body" | "source_file" => {
                extract_children(&child, source, symbols, imports, parent_name);
            }
            _ => {}
        }
    }
}

/// Detect whether a class_declaration is actually a struct, class, or enum
/// by looking at the keyword child node.
fn detect_class_kind(node: &tree_sitter::Node, _source: &[u8]) -> SymbolKind {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        match child.kind() {
            "struct" => return SymbolKind::Struct,
            "enum" => return SymbolKind::Enum,
            "class" => return SymbolKind::Class,
            _ => {}
        }
    }
    SymbolKind::Class
}

fn extract_function(
    node: &tree_sitter::Node,
    source: &[u8],
    parent_name: Option<&str>,
) -> Option<Symbol> {
    let name = find_first_child_of_kind(node, "simple_identifier", source)?;

    let kind = if parent_name.is_some() {
        SymbolKind::Method
    } else {
        SymbolKind::Function
    };

    // Try to get signature up to the body
    let signature = if let Some(body) = find_first_child_of_kind_node(node, "function_body") {
        let sig = &source[node.start_byte()..body.start_byte()];
        std::str::from_utf8(sig).unwrap_or("").trim().to_string()
    } else {
        // Protocol method declarations have no body
        node_text(node, source).trim().to_string()
    };

    Some(Symbol {
        name: name.to_string(),
        kind,
        span: Span::from_node(node),
        signature,
        doc_comment: extract_doc_comment(node, source),
        parent: parent_name.map(|s| s.to_string()),
        children: Vec::new(),
    })
}

fn extract_type_decl(
    node: &tree_sitter::Node,
    source: &[u8],
    kind: SymbolKind,
    parent_name: Option<&str>,
) -> Option<Symbol> {
    let name = find_first_child_of_kind(node, "type_identifier", source)?;

    // Signature: everything before the body
    let body_node = find_first_child_of_kind_node(node, "class_body")
        .or_else(|| find_first_child_of_kind_node(node, "enum_class_body"));
    let signature = if let Some(body) = body_node {
        let sig = &source[node.start_byte()..body.start_byte()];
        std::str::from_utf8(sig).unwrap_or("").trim().to_string()
    } else {
        node_text(node, source)
            .lines()
            .next()
            .unwrap_or("")
            .trim()
            .to_string()
    };

    // Recurse into body to find children
    let mut children = Vec::new();
    let mut child_imports = Vec::new();
    let body = find_first_child_of_kind_node(node, "class_body")
        .or_else(|| find_first_child_of_kind_node(node, "enum_class_body"));
    if let Some(body) = body {
        extract_children(&body, source, &mut children, &mut child_imports, Some(name));
    }

    Some(Symbol {
        name: name.to_string(),
        kind,
        span: Span::from_node(node),
        signature,
        doc_comment: extract_doc_comment(node, source),
        parent: parent_name.map(|s| s.to_string()),
        children,
    })
}

fn extract_protocol(
    node: &tree_sitter::Node,
    source: &[u8],
    parent_name: Option<&str>,
) -> Option<Symbol> {
    let name = find_first_child_of_kind(node, "type_identifier", source)?;

    let body = find_first_child_of_kind_node(node, "protocol_body");
    let signature = if let Some(ref body) = body {
        let sig = &source[node.start_byte()..body.start_byte()];
        std::str::from_utf8(sig).unwrap_or("").trim().to_string()
    } else {
        node_text(node, source)
            .lines()
            .next()
            .unwrap_or("")
            .trim()
            .to_string()
    };

    let mut children = Vec::new();
    let mut child_imports = Vec::new();
    if let Some(body) = body {
        extract_children(&body, source, &mut children, &mut child_imports, Some(name));
    }

    Some(Symbol {
        name: name.to_string(),
        kind: SymbolKind::Interface,
        span: Span::from_node(node),
        signature,
        doc_comment: extract_doc_comment(node, source),
        parent: parent_name.map(|s| s.to_string()),
        children,
    })
}

fn extract_property(
    node: &tree_sitter::Node,
    source: &[u8],
    parent_name: Option<&str>,
) -> Option<Symbol> {
    let name = find_property_name(node, source)?;

    let signature = node_text(node, source)
        .lines()
        .next()
        .unwrap_or("")
        .trim()
        .to_string();

    Some(Symbol {
        name: name.to_string(),
        kind: SymbolKind::Const,
        span: Span::from_node(node),
        signature,
        doc_comment: extract_doc_comment(node, source),
        parent: parent_name.map(|s| s.to_string()),
        children: Vec::new(),
    })
}

fn extract_typealias(
    node: &tree_sitter::Node,
    source: &[u8],
    parent_name: Option<&str>,
) -> Option<Symbol> {
    let name = find_first_child_of_kind(node, "type_identifier", source)?;

    Some(Symbol {
        name: name.to_string(),
        kind: SymbolKind::TypeAlias,
        span: Span::from_node(node),
        signature: node_text(node, source).trim().to_string(),
        doc_comment: extract_doc_comment(node, source),
        parent: parent_name.map(|s| s.to_string()),
        children: Vec::new(),
    })
}

/// Find the first child node of a given kind and return its text.
fn find_first_child_of_kind<'a>(
    node: &tree_sitter::Node,
    kind: &str,
    source: &'a [u8],
) -> Option<&'a str> {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if child.kind() == kind {
            return Some(node_text(&child, source));
        }
    }
    None
}

/// Find the first child node of a given kind and return the node.
fn find_first_child_of_kind_node<'a>(
    node: &'a tree_sitter::Node,
    kind: &str,
) -> Option<tree_sitter::Node<'a>> {
    let mut cursor = node.walk();
    for child in node.children(&mut cursor) {
        if child.kind() == kind {
            return Some(child);
        }
    }
    None
}

/// Extract property name from a property_declaration node.
/// Swift property declarations use pattern bindings: `let/var name: Type = value`
fn find_property_name<'a>(node: &tree_sitter::Node, source: &'a [u8]) -> Option<&'a str> {
    fn search_for_identifier<'b>(node: &tree_sitter::Node, source: &'b [u8]) -> Option<&'b str> {
        let mut cursor = node.walk();
        for child in node.children(&mut cursor) {
            if child.kind() == "simple_identifier" {
                return Some(node_text(&child, source));
            }
            if child.kind() == "pattern" || child.kind() == "directly_assignable_expression" {
                if let Some(name) = search_for_identifier(&child, source) {
                    return Some(name);
                }
            }
        }
        None
    }
    search_for_identifier(node, source)
}

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

    fn parse_swift(source: &str) -> (Vec<Symbol>, Vec<Import>) {
        let mut parser = tree_sitter::Parser::new();
        parser
            .set_language(&tree_sitter_swift::LANGUAGE.into())
            .unwrap();
        let tree = parser.parse(source, None).unwrap();
        extract(&tree, source.as_bytes())
    }

    #[test]
    fn test_struct_and_protocol() {
        let source = r#"
import Foundation
import UIKit

protocol Drawable {
    func draw()
}

struct Point {
    let x: Double
    let y: Double

    func distance(to other: Point) -> Double {
        let dx = x - other.x
        let dy = y - other.y
        return (dx * dx + dy * dy).squareRoot()
    }
}
"#;
        let (symbols, imports) = parse_swift(source);

        // Imports
        assert_eq!(imports.len(), 2);
        assert_eq!(imports[0].path, "Foundation");
        assert_eq!(imports[1].path, "UIKit");

        // Protocol
        let proto = symbols.iter().find(|s| s.name == "Drawable");
        assert!(
            proto.is_some(),
            "missing Drawable in {:?}",
            symbols.iter().map(|s| &s.name).collect::<Vec<_>>()
        );
        assert_eq!(proto.unwrap().kind, SymbolKind::Interface);

        // Struct
        let point = symbols.iter().find(|s| s.name == "Point");
        assert!(
            point.is_some(),
            "missing Point in {:?}",
            symbols.iter().map(|s| &s.name).collect::<Vec<_>>()
        );
        let point = point.unwrap();
        assert_eq!(point.kind, SymbolKind::Struct);

        // Children of Point: x, y (properties), distance (method)
        let child_names: Vec<&str> = point.children.iter().map(|s| s.name.as_str()).collect();
        assert!(
            child_names.contains(&"distance"),
            "missing distance in {:?}",
            child_names
        );
        assert!(child_names.contains(&"x"), "missing x in {:?}", child_names);
        assert!(child_names.contains(&"y"), "missing y in {:?}", child_names);

        let dist = point
            .children
            .iter()
            .find(|s| s.name == "distance")
            .unwrap();
        assert_eq!(dist.kind, SymbolKind::Method);

        let x = point.children.iter().find(|s| s.name == "x").unwrap();
        assert_eq!(x.kind, SymbolKind::Const);
    }

    #[test]
    fn test_class_and_enum() {
        let source = r#"
class Vehicle {
    var speed: Int

    func accelerate() {
        speed += 10
    }
}

enum Direction {
    case north
    case south
    case east
    case west
}

func freeFunction() -> String {
    return "hello"
}

typealias Speed = Double
"#;
        let (symbols, _imports) = parse_swift(source);

        let names: Vec<&str> = symbols.iter().map(|s| s.name.as_str()).collect();

        // Class
        let vehicle = symbols.iter().find(|s| s.name == "Vehicle");
        assert!(vehicle.is_some(), "missing Vehicle in {:?}", names);
        assert_eq!(vehicle.unwrap().kind, SymbolKind::Class);

        // Enum
        let dir = symbols.iter().find(|s| s.name == "Direction");
        assert!(dir.is_some(), "missing Direction in {:?}", names);
        assert_eq!(dir.unwrap().kind, SymbolKind::Enum);

        // Free function
        let func = symbols.iter().find(|s| s.name == "freeFunction");
        assert!(func.is_some(), "missing freeFunction in {:?}", names);
        assert_eq!(func.unwrap().kind, SymbolKind::Function);

        // TypeAlias
        let ta = symbols.iter().find(|s| s.name == "Speed");
        assert!(ta.is_some(), "missing Speed typealias in {:?}", names);
        assert_eq!(ta.unwrap().kind, SymbolKind::TypeAlias);
    }
}