ryo-source 0.1.0

High-speed Rust AST manipulation 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
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
//! Analysis operations for PureFile.
//!
//! Thread-safe analysis that can run in parallel across multiple files.

use std::collections::HashMap;

use super::ast::*;

/// Symbol information in PureFile.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PureSymbol {
    /// Symbol name.
    pub name: String,
    /// Kind of symbol.
    pub kind: PureSymbolKind,
    /// Number of references to this symbol.
    pub ref_count: usize,
}

/// Kind of symbol in PureFile.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PureSymbolKind {
    /// Function definition.
    Function,
    /// Struct definition.
    Struct,
    /// Enum definition.
    Enum,
    /// Trait definition.
    Trait,
    /// Type alias.
    TypeAlias,
    /// Const item.
    Const,
    /// Static item.
    Static,
    /// Local variable.
    LocalVar,
    /// Function parameter.
    Parameter,
    /// Module.
    Module,
    /// Impl block (for a type).
    Impl,
}

/// Symbol table for PureFile.
#[derive(Debug, Clone, Default)]
pub struct PureSymbolTable {
    /// All symbols indexed by name.
    pub symbols: HashMap<String, PureSymbol>,
}

impl PureSymbolTable {
    /// Create a new empty symbol table.
    pub fn new() -> Self {
        Self::default()
    }

    /// Get all symbols of a specific kind.
    pub fn by_kind(&self, kind: PureSymbolKind) -> Vec<&PureSymbol> {
        self.symbols.values().filter(|s| s.kind == kind).collect()
    }

    /// Get all function definitions.
    pub fn functions(&self) -> Vec<&PureSymbol> {
        self.by_kind(PureSymbolKind::Function)
    }

    /// Get all struct definitions.
    pub fn structs(&self) -> Vec<&PureSymbol> {
        self.by_kind(PureSymbolKind::Struct)
    }

    /// Get symbol by name.
    pub fn get(&self, name: &str) -> Option<&PureSymbol> {
        self.symbols.get(name)
    }
}

/// Definition and Reference analysis for PureFile.
pub struct PureDefRefs;

impl PureDefRefs {
    /// Analyze all symbols and their references in a PureFile.
    pub fn analyze(file: &PureFile) -> PureSymbolTable {
        let mut collector = SymbolCollector::new();
        collector.visit_file(file);
        collector.table
    }

    /// Find definition of a symbol by name.
    pub fn find_definition(file: &PureFile, name: &str) -> Option<PureSymbol> {
        let table = Self::analyze(file);
        table.symbols.get(name).cloned()
    }

    /// Count references to a symbol.
    pub fn count_references(file: &PureFile, name: &str) -> usize {
        let table = Self::analyze(file);
        table.symbols.get(name).map(|s| s.ref_count).unwrap_or(0)
    }

    /// Get all defined symbol names.
    pub fn all_definitions(file: &PureFile) -> Vec<String> {
        let table = Self::analyze(file);
        table.symbols.keys().cloned().collect()
    }
}

/// Collector for symbols in PureFile.
struct SymbolCollector {
    table: PureSymbolTable,
    /// Reference counts (collected during traversal).
    refs: HashMap<String, usize>,
}

impl SymbolCollector {
    fn new() -> Self {
        Self {
            table: PureSymbolTable::new(),
            refs: HashMap::new(),
        }
    }

    fn define(&mut self, name: &str, kind: PureSymbolKind) {
        self.table.symbols.insert(
            name.to_string(),
            PureSymbol {
                name: name.to_string(),
                kind,
                ref_count: 0,
            },
        );
    }

    fn add_ref(&mut self, name: &str) {
        *self.refs.entry(name.to_string()).or_insert(0) += 1;
    }

    fn finalize_refs(&mut self) {
        for (name, count) in &self.refs {
            if let Some(symbol) = self.table.symbols.get_mut(name) {
                symbol.ref_count = *count;
            }
        }
    }

    fn visit_file(&mut self, file: &PureFile) {
        for item in &file.items {
            self.visit_item(item);
        }
        self.finalize_refs();
    }

    fn visit_item(&mut self, item: &PureItem) {
        match item {
            PureItem::Fn(f) => self.visit_fn(f),
            PureItem::Struct(s) => self.visit_struct(s),
            PureItem::Enum(e) => self.visit_enum(e),
            PureItem::Impl(i) => self.visit_impl(i),
            PureItem::Trait(t) => self.visit_trait(t),
            PureItem::Const(c) => self.visit_const(c),
            PureItem::Static(s) => self.visit_static(s),
            PureItem::Type(t) => self.visit_type_alias(t),
            PureItem::Mod(m) => self.visit_mod(m),
            PureItem::Use(_) | PureItem::Macro(_) | PureItem::Other(_) => {}
        }
    }

    fn visit_fn(&mut self, f: &PureFn) {
        self.define(&f.name, PureSymbolKind::Function);

        // Define parameters
        for param in &f.params {
            if let PureParam::Typed { name, .. } = param {
                self.define(name, PureSymbolKind::Parameter);
            }
        }

        // Visit body
        self.visit_block(&f.body);
    }

    fn visit_struct(&mut self, s: &PureStruct) {
        self.define(&s.name, PureSymbolKind::Struct);
    }

    fn visit_enum(&mut self, e: &PureEnum) {
        self.define(&e.name, PureSymbolKind::Enum);
    }

    fn visit_impl(&mut self, i: &PureImpl) {
        // Record the impl target as being referenced
        self.add_ref(&i.self_ty);

        for item in &i.items {
            if let PureImplItem::Fn(f) = item {
                self.visit_fn(f);
            }
        }
    }

    fn visit_trait(&mut self, t: &PureTrait) {
        self.define(&t.name, PureSymbolKind::Trait);
    }

    fn visit_const(&mut self, c: &PureConst) {
        self.define(&c.name, PureSymbolKind::Const);
        if let Some(v) = &c.value {
            self.visit_expr(v);
        }
    }

    fn visit_static(&mut self, s: &PureStatic) {
        self.define(&s.name, PureSymbolKind::Static);
        self.visit_expr(&s.value);
    }

    fn visit_type_alias(&mut self, t: &PureTypeAlias) {
        self.define(&t.name, PureSymbolKind::TypeAlias);
    }

    fn visit_mod(&mut self, m: &PureMod) {
        self.define(&m.name, PureSymbolKind::Module);
        for item in &m.items {
            self.visit_item(item);
        }
    }

    fn visit_block(&mut self, block: &PureBlock) {
        for stmt in &block.stmts {
            self.visit_stmt(stmt);
        }
    }

    fn visit_stmt(&mut self, stmt: &PureStmt) {
        match stmt {
            PureStmt::Local { pattern, init, .. } => {
                // Visit init first (before defining the variable)
                if let Some(expr) = init {
                    self.visit_expr(expr);
                }
                // Define variables from pattern
                self.define_from_pattern(pattern);
            }
            PureStmt::Expr(expr) | PureStmt::Semi(expr) => {
                self.visit_expr(expr);
            }
            PureStmt::Item(item) => {
                self.visit_item(item);
            }
        }
    }

    fn define_from_pattern(&mut self, pattern: &PurePattern) {
        match pattern {
            PurePattern::Ident { name, .. } => {
                self.define(name, PureSymbolKind::LocalVar);
            }
            PurePattern::Tuple(pats) => {
                for pat in pats {
                    self.define_from_pattern(pat);
                }
            }
            PurePattern::Struct { fields, .. } => {
                for (_, pat) in fields {
                    self.define_from_pattern(pat);
                }
            }
            PurePattern::Ref { pattern, .. } => {
                self.define_from_pattern(pattern);
            }
            PurePattern::Or(pats) => {
                // All branches should define the same variables
                if let Some(first) = pats.first() {
                    self.define_from_pattern(first);
                }
            }
            PurePattern::Slice(pats) => {
                for pat in pats {
                    self.define_from_pattern(pat);
                }
            }
            PurePattern::Wild
            | PurePattern::Lit(_)
            | PurePattern::Path(_)
            | PurePattern::Range { .. }
            | PurePattern::Rest
            | PurePattern::Other(_) => {}
        }
    }

    fn visit_expr(&mut self, expr: &PureExpr) {
        match expr {
            PureExpr::Path(path) if !path.contains("::") => {
                // Simple path is a reference
                self.add_ref(path);
            }
            PureExpr::Binary { left, right, .. } => {
                self.visit_expr(left);
                self.visit_expr(right);
            }
            PureExpr::Unary { expr, .. } => {
                self.visit_expr(expr);
            }
            PureExpr::Call { func, args } => {
                self.visit_expr(func);
                for arg in args {
                    self.visit_expr(arg);
                }
            }
            PureExpr::MethodCall { receiver, args, .. } => {
                self.visit_expr(receiver);
                for arg in args {
                    self.visit_expr(arg);
                }
            }
            PureExpr::Field { expr, .. } => {
                self.visit_expr(expr);
            }
            PureExpr::Index { expr, index } => {
                self.visit_expr(expr);
                self.visit_expr(index);
            }
            PureExpr::Block { block, .. } => {
                self.visit_block(block);
            }
            PureExpr::If {
                cond,
                then_branch,
                else_branch,
            } => {
                self.visit_expr(cond);
                self.visit_block(then_branch);
                if let Some(else_expr) = else_branch {
                    self.visit_expr(else_expr);
                }
            }
            PureExpr::Match { expr, arms } => {
                self.visit_expr(expr);
                for arm in arms {
                    self.define_from_pattern(&arm.pattern);
                    if let Some(guard) = &arm.guard {
                        self.visit_expr(guard);
                    }
                    self.visit_expr(&arm.body);
                }
            }
            PureExpr::Loop { body: block, .. } | PureExpr::While { body: block, .. } => {
                self.visit_block(block);
            }
            PureExpr::For {
                pat, expr, body, ..
            } => {
                self.visit_expr(expr);
                self.define_from_pattern(pat);
                self.visit_block(body);
            }
            PureExpr::Return(Some(expr))
            | PureExpr::Break {
                expr: Some(expr), ..
            } => {
                self.visit_expr(expr);
            }
            PureExpr::Closure { params, body, .. } => {
                for param in params {
                    self.define_from_pattern(&param.pattern);
                }
                self.visit_expr(body);
            }
            PureExpr::Struct { fields, .. } => {
                for (_, expr) in fields {
                    self.visit_expr(expr);
                }
            }
            PureExpr::Tuple(exprs) | PureExpr::Array(exprs) => {
                for expr in exprs {
                    self.visit_expr(expr);
                }
            }
            PureExpr::Ref { expr, .. } => {
                self.visit_expr(expr);
            }
            PureExpr::Await(expr) | PureExpr::Try(expr) => {
                self.visit_expr(expr);
            }
            _ => {}
        }
    }
}

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

    #[test]
    fn test_analyze_functions() {
        let file = PureFile::from_source(
            r#"
            fn foo() {}
            fn bar() {}
            fn baz() {}
            "#,
        )
        .unwrap();

        let table = PureDefRefs::analyze(&file);
        assert_eq!(table.functions().len(), 3);
        assert!(table.get("foo").is_some());
        assert!(table.get("bar").is_some());
        assert!(table.get("baz").is_some());
    }

    #[test]
    fn test_analyze_structs() {
        let file = PureFile::from_source(
            r#"
            struct Point { x: i32, y: i32 }
            struct Line { start: Point, end: Point }
            "#,
        )
        .unwrap();

        let table = PureDefRefs::analyze(&file);
        assert_eq!(table.structs().len(), 2);
    }

    #[test]
    fn test_count_references() {
        let file = PureFile::from_source(
            r#"
            fn main() {
                let x = 1;
                let y = x + 1;
                let z = x + y;
            }
            "#,
        )
        .unwrap();

        let x_refs = PureDefRefs::count_references(&file, "x");
        assert_eq!(x_refs, 2); // Used twice

        let y_refs = PureDefRefs::count_references(&file, "y");
        assert_eq!(y_refs, 1); // Used once
    }

    #[test]
    fn test_find_definition() {
        let file = PureFile::from_source("fn my_function() {}").unwrap();

        let symbol = PureDefRefs::find_definition(&file, "my_function");
        assert!(symbol.is_some());
        assert_eq!(symbol.unwrap().kind, PureSymbolKind::Function);
    }

    #[test]
    fn test_all_definitions() {
        let file = PureFile::from_source(
            r#"
            struct Foo {}
            enum Bar {}
            fn baz() {}
            const QUX: i32 = 1;
            "#,
        )
        .unwrap();

        let defs = PureDefRefs::all_definitions(&file);
        assert!(defs.contains(&"Foo".to_string()));
        assert!(defs.contains(&"Bar".to_string()));
        assert!(defs.contains(&"baz".to_string()));
        assert!(defs.contains(&"QUX".to_string()));
    }

    #[test]
    fn test_parallel_analysis() {
        use std::sync::Arc;
        use std::thread;

        let file = PureFile::from_source(
            r#"
            fn alpha() {}
            fn beta() {}
            fn gamma() {}
            "#,
        )
        .unwrap();

        let shared = Arc::new(file);

        let handles: Vec<_> = (0..4)
            .map(|_| {
                let f = Arc::clone(&shared);
                thread::spawn(move || PureDefRefs::analyze(&f).functions().len())
            })
            .collect();

        for handle in handles {
            assert_eq!(handle.join().unwrap(), 3);
        }
    }
}