Skip to main content

panproto_parse/
walker.rs

1//! Generic tree-sitter AST walker that converts parse trees to panproto schemas.
2//!
3//! Because theories are auto-derived from the grammar, the walker is fully generic:
4//! one implementation works for all languages. The node's `kind()` IS the panproto
5//! vertex kind; the field name IS the edge kind.
6//!
7//! Named-scope detection (functions, classes, methods, modules, types) is driven
8//! by the grammar's `queries/tags.scm` file via [`ScopeDetector`], not by a
9//! hardcoded node-kind list. This makes scope detection uniformly correct across
10//! every tree-sitter grammar that ships a tags query. See the [`scope_detector`]
11//! module for the full rationale.
12//!
13//! [`scope_detector`]: crate::scope_detector
14//! [`ScopeDetector`]: crate::scope_detector::ScopeDetector
15
16use std::collections::BTreeMap;
17
18use panproto_schema::{Protocol, Schema, SchemaBuilder};
19use rustc_hash::FxHashSet;
20
21use crate::error::ParseError;
22use crate::id_scheme::IdGenerator;
23use crate::scope_detector::{NamedScope, ScopeDetector};
24use crate::theory_extract::ExtractedTheoryMeta;
25
26/// Nodes whose kind names suggest they contain ordered statement sequences.
27///
28/// Unlike scope detection (which is grammar-driven via `tags.scm`), block
29/// grouping is a structural concern: we want sibling statements inside a
30/// block to get positional IDs (`$0`, `$1`, ...) so insertions don't
31/// cascade. Per-language [`WalkerConfig`] overrides extend this list.
32const BLOCK_KINDS: &[&str] = &[
33    "block",
34    "statement_block",
35    "compound_statement",
36    "declaration_list",
37    "field_declaration_list",
38    "enum_body",
39    "class_body",
40    "interface_body",
41    "module_body",
42];
43
44/// Configuration for the walker, allowing per-language customization.
45#[derive(Debug, Clone, Default)]
46pub struct WalkerConfig {
47    /// Additional node kinds that contain ordered statement sequences.
48    ///
49    /// Named-scope detection is handled by [`ScopeDetector`] from the
50    /// grammar's `tags.scm`; no per-language scope configuration is
51    /// required here.
52    ///
53    /// [`ScopeDetector`]: crate::scope_detector::ScopeDetector
54    pub extra_block_kinds: Vec<String>,
55    /// Whether to capture comment nodes as constraints on the following sibling.
56    pub capture_comments: bool,
57    /// Whether to capture whitespace/formatting as constraints.
58    pub capture_formatting: bool,
59}
60
61impl WalkerConfig {
62    /// Construct a config with formatting and comment capture enabled (the
63    /// common default; [`WalkerConfig::default`] returns all-false).
64    #[must_use]
65    pub const fn standard() -> Self {
66        Self {
67            extra_block_kinds: Vec::new(),
68            capture_comments: true,
69            capture_formatting: true,
70        }
71    }
72}
73
74/// Generic AST walker that converts a tree-sitter parse tree to a panproto [`Schema`].
75///
76/// The walker uses the auto-derived theory to determine vertex and edge kinds directly
77/// from the tree-sitter AST, requiring no manual mapping table. Named-scope identity
78/// (the part of the vertex ID that survives insertions) is driven by [`ScopeDetector`]
79/// from the grammar's `tags.scm` query.
80///
81/// [`ScopeDetector`]: crate::scope_detector::ScopeDetector
82pub struct AstWalker<'a> {
83    /// The source code bytes (needed for extracting text of leaf nodes).
84    source: &'a [u8],
85    /// The auto-derived theory metadata. The `vertex_kinds` set is used to
86    /// filter anonymous/internal tree-sitter nodes that are not part of the
87    /// language's public grammar.
88    theory_meta: &'a ExtractedTheoryMeta,
89    /// The protocol definition (for `SchemaBuilder` validation).
90    protocol: &'a Protocol,
91    /// Per-language configuration.
92    config: WalkerConfig,
93    /// Known block kinds (merged from defaults + config).
94    block_kinds: FxHashSet<String>,
95    /// Named scopes indexed by `(start_byte, end_byte)` for O(log n) lookup
96    /// during the tree walk. Derived from a [`ScopeDetector`] run over the
97    /// full source before the walk begins.
98    scope_map: BTreeMap<(usize, usize), NamedScope>,
99}
100
101impl<'a> AstWalker<'a> {
102    /// Create a new walker for the given source, theory, and protocol.
103    ///
104    /// Runs an optional [`ScopeDetector`] over the source to build a
105    /// per-file scope map. Pass `None` to disable named-scope detection
106    /// (every non-root vertex gets a positional ID). Pass `Some(detector)`
107    /// whose [`has_query`] is `false` for the same effect; the detector
108    /// short-circuits to an empty scope list.
109    ///
110    /// [`ScopeDetector`]: crate::scope_detector::ScopeDetector
111    /// [`has_query`]: crate::scope_detector::ScopeDetector::has_query
112    #[must_use]
113    pub fn new(
114        source: &'a [u8],
115        theory_meta: &'a ExtractedTheoryMeta,
116        protocol: &'a Protocol,
117        config: WalkerConfig,
118        scope_detector: Option<&mut ScopeDetector>,
119    ) -> Self {
120        let mut block_kinds: FxHashSet<String> =
121            BLOCK_KINDS.iter().map(|s| (*s).to_owned()).collect();
122        for kind in &config.extra_block_kinds {
123            block_kinds.insert(kind.clone());
124        }
125
126        let mut scope_map: BTreeMap<(usize, usize), NamedScope> = BTreeMap::new();
127        if let Some(det) = scope_detector {
128            for scope in det.scopes(source) {
129                scope_map.insert((scope.node_range.start, scope.node_range.end), scope);
130            }
131        }
132
133        Self {
134            source,
135            theory_meta,
136            protocol,
137            config,
138            block_kinds,
139            scope_map,
140        }
141    }
142
143    /// Walk the entire parse tree and produce a [`Schema`].
144    ///
145    /// # Errors
146    ///
147    /// Returns [`ParseError::SchemaConstruction`] if schema building fails.
148    pub fn walk(&self, tree: &tree_sitter::Tree, file_path: &str) -> Result<Schema, ParseError> {
149        let mut id_gen = IdGenerator::new(file_path);
150        let builder = SchemaBuilder::new(self.protocol);
151        let root = tree.root_node();
152
153        let builder = self.walk_node(root, builder, &mut id_gen, None)?;
154
155        builder.build().map_err(|e| ParseError::SchemaConstruction {
156            reason: e.to_string(),
157        })
158    }
159
160    /// Look up a node's named-scope entry, if any.
161    fn scope_for(&self, node: tree_sitter::Node<'_>) -> Option<&NamedScope> {
162        self.scope_map.get(&(node.start_byte(), node.end_byte()))
163    }
164
165    /// Recursively walk a single node, emitting vertices and edges.
166    fn walk_node(
167        &self,
168        node: tree_sitter::Node<'_>,
169        mut builder: SchemaBuilder,
170        id_gen: &mut IdGenerator,
171        parent_vertex_id: Option<&str>,
172    ) -> Result<SchemaBuilder, ParseError> {
173        // Skip anonymous tokens (punctuation, keywords like `{`, `}`, `,`, etc.).
174        if !node.is_named() {
175            return Ok(builder);
176        }
177
178        let kind = node.kind();
179
180        // Skip the root "program"/"source_file"/"module" wrapper if it just wraps children.
181        // We still process it to emit its children, but do so by iterating directly.
182        let is_root_wrapper = parent_vertex_id.is_none()
183            && (kind == "program"
184                || kind == "source_file"
185                || kind == "module"
186                || kind == "translation_unit");
187
188        let named_scope = if is_root_wrapper {
189            None
190        } else {
191            self.scope_for(node)
192        };
193
194        // Determine vertex ID.
195        //
196        // For a node that is *both* named-scope and scope-introducing
197        // (the common case: a `function_definition`, `class_definition`,
198        // `module`, etc.) we must disambiguate the name exactly once
199        // and reuse the same disambiguated leaf for both the vertex ID
200        // here and the scope-stack frame pushed below. The
201        // `record_name` / `push_recorded_scope` split on `IdGenerator`
202        // makes that explicit: `record_name` is the side-effecting
203        // step that bumps the parent frame's `seen` counter, the leaf
204        // it returns becomes the trailing component of the vertex ID,
205        // and `push_recorded_scope` later takes the same leaf without
206        // re-recording.
207        let (vertex_id, recorded_named_leaf) = if is_root_wrapper {
208            // Root wrappers get the file path as their ID.
209            (id_gen.current_prefix(), None)
210        } else if let Some(scope) = named_scope {
211            let leaf = id_gen.record_name(&scope.name);
212            let prefix = id_gen.current_prefix();
213            (format!("{prefix}::{leaf}"), Some(leaf))
214        } else {
215            // All other nodes get positional IDs.
216            (id_gen.anonymous_id(), None)
217        };
218
219        // Determine the effective vertex kind. If the theory has extracted vertex kinds,
220        // use those for validation. If the kind is unknown to the theory AND the protocol
221        // has a closed obj_kinds list, fall back to "node".
222        let effective_kind = if self.protocol.obj_kinds.is_empty() {
223            // Open protocol: accept all kinds.
224            kind
225        } else if self.protocol.obj_kinds.iter().any(|k| k == kind) {
226            kind
227        } else if !self.theory_meta.vertex_kinds.is_empty()
228            && self.theory_meta.vertex_kinds.iter().any(|k| k == kind)
229        {
230            // Known in the auto-derived theory even if not in the protocol's obj_kinds.
231            kind
232        } else {
233            "node"
234        };
235
236        builder = builder
237            .vertex(&vertex_id, effective_kind, None)
238            .map_err(|e| ParseError::SchemaConstruction {
239                reason: format!("vertex '{vertex_id}' ({kind}): {e}"),
240            })?;
241
242        // Emit edge from parent to this node.
243        if let Some(parent_id) = parent_vertex_id {
244            // Determine edge kind: use the tree-sitter field name if this node
245            // was accessed via a field, otherwise use "child_of".
246            let edge_kind = node
247                .parent()
248                .and_then(|p| {
249                    // Find which field of the parent this node corresponds to.
250                    for i in 0..p.child_count() {
251                        if let Some(child) = p.child(i) {
252                            if child.id() == node.id() {
253                                return u32::try_from(i)
254                                    .ok()
255                                    .and_then(|idx| p.field_name_for_child(idx));
256                            }
257                        }
258                    }
259                    None
260                })
261                .unwrap_or("child_of");
262
263            builder = builder
264                .edge(parent_id, &vertex_id, edge_kind, None)
265                .map_err(|e| ParseError::SchemaConstruction {
266                    reason: format!("edge {parent_id} -> {vertex_id} ({edge_kind}): {e}"),
267                })?;
268        }
269
270        // Store byte range for position-aware emission.
271        builder = builder.constraint(&vertex_id, "start-byte", &node.start_byte().to_string());
272        builder = builder.constraint(&vertex_id, "end-byte", &node.end_byte().to_string());
273
274        // Emit constraints for leaf nodes (literals, identifiers, operators).
275        if node.named_child_count() == 0 {
276            if let Ok(text) = node.utf8_text(self.source) {
277                builder = builder.constraint(&vertex_id, "literal-value", text);
278            }
279        }
280
281        // Capture field-keyed anonymous-token children as `field:<name>`
282        // constraints on this vertex. Tree-sitter rules of the form
283        // `field('op', choice('+', '-', '*', '/'))` produce children
284        // that are field-named but not themselves named nodes, so they
285        // are skipped by the named-child walk above and would otherwise
286        // be invisible to downstream consumers. Emitting the value here
287        // lets consumers read `schema.field_text(vid, name)` directly
288        // rather than reconstructing the text via start-byte / end-byte
289        // arithmetic against the source buffer.
290        builder = self.capture_anonymous_field_constraints(node, &vertex_id, builder);
291
292        // Emit formatting constraints if enabled.
293        if self.config.capture_formatting {
294            builder = self.emit_formatting_constraints(node, &vertex_id, builder);
295        }
296
297        // Enter scope if this is a scope-introducing node. For a
298        // named scope we reuse the disambiguated leaf computed above
299        // (so the frame name matches the trailing component of
300        // `vertex_id`); for an anonymous block we push a fresh
301        // positional frame.
302        let entered_scope = if let Some(leaf) = recorded_named_leaf {
303            id_gen.push_recorded_scope(leaf);
304            true
305        } else if !is_root_wrapper && self.block_kinds.contains(kind) {
306            id_gen.push_anonymous_scope();
307            true
308        } else {
309            false
310        };
311
312        builder = self.walk_children_with_interstitials(node, builder, id_gen, &vertex_id)?;
313
314        if entered_scope {
315            id_gen.pop_scope();
316        }
317
318        Ok(builder)
319    }
320
321    /// Walk named children, capturing interstitial text between them.
322    ///
323    /// Also computes a `chose-alt-fingerprint` constraint by trimming
324    /// and joining every non-empty interstitial run. This is the
325    /// categorical discriminator for the parent vertex's CHOICE alt:
326    /// it survives the byte-position-stripping that
327    /// `emit_pretty_roundtrip`'s by-construction simulation applies,
328    /// so the CHOICE picker can dispatch deterministically against
329    /// the recorded alternative even after interstitials are removed.
330    /// A by-construction schema can populate this constraint directly
331    /// to control which alternative the emitter picks.
332    fn walk_children_with_interstitials(
333        &self,
334        node: tree_sitter::Node<'_>,
335        mut builder: SchemaBuilder,
336        id_gen: &mut IdGenerator,
337        vertex_id: &str,
338    ) -> Result<SchemaBuilder, ParseError> {
339        let cursor = &mut node.walk();
340        let children: Vec<_> = node.named_children(cursor).collect();
341        let mut interstitial_idx = 0;
342        let mut prev_end = node.start_byte();
343        let mut fingerprint_parts: Vec<String> = Vec::new();
344        let mut child_kinds: Vec<String> = Vec::new();
345
346        for child in &children {
347            let gap_start = prev_end;
348            let gap_end = child.start_byte();
349            builder = self.capture_interstitial(
350                builder,
351                vertex_id,
352                gap_start,
353                gap_end,
354                &mut interstitial_idx,
355                &mut fingerprint_parts,
356            );
357            // Record the named child's kind separately from the
358            // literal-token fingerprint. The CHOICE picker reads the
359            // kind sequence as a secondary, tiebreaker witness when
360            // literal tokens alone don't discriminate alternatives.
361            // Hidden-rule kinds (`_`-prefixed) are tree-sitter
362            // implementation detail and never authored by humans;
363            // omitting them keeps the witness language-clean and
364            // matches the convention that hidden rules are inlined
365            // by the emitter rather than dispatched against.
366            let child_kind = child.kind();
367            if !child_kind.starts_with('_') {
368                child_kinds.push(child_kind.to_owned());
369            }
370            builder = self.walk_node(*child, builder, id_gen, Some(vertex_id))?;
371            prev_end = child.end_byte();
372        }
373
374        // Trailing interstitial after the last child.
375        builder = self.capture_interstitial(
376            builder,
377            vertex_id,
378            prev_end,
379            node.end_byte(),
380            &mut interstitial_idx,
381            &mut fingerprint_parts,
382        );
383
384        if !fingerprint_parts.is_empty() {
385            builder = builder.constraint(
386                vertex_id,
387                "chose-alt-fingerprint",
388                &fingerprint_parts.join(" "),
389            );
390        }
391        if !child_kinds.is_empty() {
392            builder =
393                builder.constraint(vertex_id, "chose-alt-child-kinds", &child_kinds.join(" "));
394        }
395
396        Ok(builder)
397    }
398
399    /// Capture interstitial text between `gap_start` and `gap_end` as a constraint.
400    /// Walk all children of `node` (including anonymous tokens), and for
401    /// each anonymous-token child that was reached through a tree-sitter
402    /// `field('<name>', ...)` accessor, emit a `field:<name>` constraint
403    /// on the parent vertex carrying the token's text.
404    ///
405    /// Tree-sitter rules like `field('direction', choice('/', '\\'))` or
406    /// `field('func', choice('sigmoid','exp','log','abs'))` attach a
407    /// field name to an unnamed token alternative. The named-children
408    /// walk in [`walk_children_with_interstitials`] omits these (they
409    /// are not named nodes), and downstream consumers previously had
410    /// to recover the value by reading the source buffer between
411    /// recorded byte offsets. This emits the value as a structural
412    /// constraint so [`Schema::field_text`] can return it directly.
413    fn capture_anonymous_field_constraints(
414        &self,
415        node: tree_sitter::Node<'_>,
416        vertex_id: &str,
417        mut builder: SchemaBuilder,
418    ) -> SchemaBuilder {
419        let child_count = node.child_count();
420        for i in 0..child_count {
421            let Some(child) = node.child(i) else { continue };
422            // Named children carry their own vertex (and surface as edges
423            // keyed by the field name in walk_node). We only need to
424            // handle the unnamed tokens here.
425            if child.is_named() {
426                continue;
427            }
428            let Some(field_name) = u32::try_from(i)
429                .ok()
430                .and_then(|idx| node.field_name_for_child(idx))
431            else {
432                continue;
433            };
434            let Ok(text) = child.utf8_text(self.source) else {
435                continue;
436            };
437            let sort = format!("field:{field_name}");
438            builder = builder.constraint(vertex_id, &sort, text);
439        }
440        builder
441    }
442
443    fn capture_interstitial(
444        &self,
445        mut builder: SchemaBuilder,
446        vertex_id: &str,
447        gap_start: usize,
448        gap_end: usize,
449        idx: &mut usize,
450        fingerprint: &mut Vec<String>,
451    ) -> SchemaBuilder {
452        if gap_end > gap_start && gap_end <= self.source.len() {
453            if let Ok(gap_text) = std::str::from_utf8(&self.source[gap_start..gap_end]) {
454                if !gap_text.is_empty() {
455                    let sort = format!("interstitial-{}", *idx);
456                    builder = builder.constraint(vertex_id, &sort, gap_text);
457                    builder = builder.constraint(
458                        vertex_id,
459                        &format!("{sort}-start-byte"),
460                        &gap_start.to_string(),
461                    );
462                    *idx += 1;
463                    let trimmed = gap_text.trim();
464                    if !trimmed.is_empty() {
465                        fingerprint.push(trimmed.to_owned());
466                    }
467                }
468            }
469        }
470        builder
471    }
472
473    /// Emit formatting constraints for a node (indentation, position).
474    fn emit_formatting_constraints(
475        &self,
476        node: tree_sitter::Node<'_>,
477        vertex_id: &str,
478        mut builder: SchemaBuilder,
479    ) -> SchemaBuilder {
480        let start = node.start_position();
481
482        // Capture indentation (column of first character on the line).
483        if start.column > 0 {
484            // Extract the actual indentation characters from the source.
485            let line_start = node.start_byte().saturating_sub(start.column);
486            if line_start < self.source.len() {
487                let indent_end = line_start + start.column.min(self.source.len() - line_start);
488                if let Ok(indent) = std::str::from_utf8(&self.source[line_start..indent_end]) {
489                    // Only capture if the extracted region is pure whitespace.
490                    if !indent.is_empty() && indent.trim().is_empty() {
491                        builder = builder.constraint(vertex_id, "indent", indent);
492                    }
493                }
494            }
495        }
496
497        // Count blank lines before this node by looking at source between
498        // previous sibling's end and this node's start.
499        if let Some(prev) = node.prev_named_sibling() {
500            let gap_start = prev.end_byte();
501            let gap_end = node.start_byte();
502            if gap_start < gap_end && gap_end <= self.source.len() {
503                let gap = &self.source[gap_start..gap_end];
504                let blank_lines = memchr::memchr_iter(b'\n', gap).count().saturating_sub(1);
505                if blank_lines > 0 {
506                    builder = builder.constraint(
507                        vertex_id,
508                        "blank-lines-before",
509                        &blank_lines.to_string(),
510                    );
511                }
512            }
513        }
514
515        builder
516    }
517}
518
519#[cfg(test)]
520#[allow(clippy::unwrap_used)]
521mod tests {
522    use super::*;
523
524    fn make_test_protocol() -> Protocol {
525        Protocol {
526            name: "test".into(),
527            schema_theory: "ThTest".into(),
528            instance_theory: "ThTestInst".into(),
529            schema_composition: None,
530            instance_composition: None,
531            obj_kinds: vec![], // Empty = open protocol, accepts all kinds.
532            edge_rules: vec![],
533            constraint_sorts: vec![],
534            has_order: true,
535            has_coproducts: false,
536            has_recursion: false,
537            has_causal: false,
538            nominal_identity: false,
539            has_defaults: false,
540            has_coercions: false,
541            has_mergers: false,
542            has_policies: false,
543        }
544    }
545
546    fn make_test_meta() -> ExtractedTheoryMeta {
547        use panproto_gat::{Sort, Theory};
548        ExtractedTheoryMeta {
549            theory: Theory::new("ThTest", vec![Sort::simple("Vertex")], vec![], vec![]),
550            supertypes: FxHashSet::default(),
551            subtype_map: Vec::new(),
552            optional_fields: FxHashSet::default(),
553            ordered_fields: FxHashSet::default(),
554            vertex_kinds: Vec::new(),
555            edge_kinds: Vec::new(),
556        }
557    }
558
559    /// Helper to get a grammar by name from panproto-grammars.
560    #[cfg(feature = "grammars")]
561    fn get_grammar(name: &str) -> panproto_grammars::Grammar {
562        panproto_grammars::grammars()
563            .into_iter()
564            .find(|g| g.name == name)
565            .unwrap_or_else(|| panic!("grammar '{name}' not enabled in features"))
566    }
567
568    #[test]
569    #[cfg(feature = "grammars")]
570    fn walk_simple_typescript() {
571        let source = b"function greet(name: string): string { return name; }";
572        let grammar = get_grammar("typescript");
573
574        let mut parser = tree_sitter::Parser::new();
575        parser.set_language(&grammar.language).unwrap();
576        let tree = parser.parse(source, None).unwrap();
577
578        let protocol = make_test_protocol();
579        let meta = make_test_meta();
580        let mut detector =
581            crate::scope_detector::ScopeDetector::new(&grammar.language, grammar.tags_query, None)
582                .unwrap();
583        let walker = AstWalker::new(
584            source,
585            &meta,
586            &protocol,
587            WalkerConfig::standard(),
588            Some(&mut detector),
589        );
590
591        let schema = walker.walk(&tree, "test.ts").unwrap();
592
593        // Should have produced some vertices.
594        assert!(
595            schema.vertices.len() > 1,
596            "expected multiple vertices, got {}",
597            schema.vertices.len()
598        );
599
600        // The root should be the file.
601        let root_name: panproto_gat::Name = "test.ts".into();
602        assert!(
603            schema.vertices.contains_key(&root_name),
604            "missing root vertex"
605        );
606
607        // When tags.scm is present, the function name should appear in a vertex ID.
608        if detector.has_query() {
609            let has_greet = schema
610                .vertices
611                .keys()
612                .any(|n| n.to_string().ends_with("::greet"));
613            assert!(
614                has_greet,
615                "expected a vertex ID ending in ::greet, got: {:?}",
616                schema
617                    .vertices
618                    .keys()
619                    .map(ToString::to_string)
620                    .collect::<Vec<_>>()
621            );
622        }
623    }
624
625    #[test]
626    #[cfg(feature = "grammars")]
627    fn walk_simple_python() {
628        let source = b"def add(a, b):\n    return a + b\n";
629        let grammar = get_grammar("python");
630
631        let mut parser = tree_sitter::Parser::new();
632        parser.set_language(&grammar.language).unwrap();
633        let tree = parser.parse(source, None).unwrap();
634
635        let protocol = make_test_protocol();
636        let meta = make_test_meta();
637        let mut detector =
638            crate::scope_detector::ScopeDetector::new(&grammar.language, grammar.tags_query, None)
639                .unwrap();
640        let walker = AstWalker::new(
641            source,
642            &meta,
643            &protocol,
644            WalkerConfig::standard(),
645            Some(&mut detector),
646        );
647
648        let schema = walker.walk(&tree, "test.py").unwrap();
649
650        assert!(
651            schema.vertices.len() > 1,
652            "expected multiple vertices, got {}",
653            schema.vertices.len()
654        );
655
656        if detector.has_query() {
657            let has_add = schema
658                .vertices
659                .keys()
660                .any(|n| n.to_string().ends_with("::add"));
661            assert!(has_add, "expected ::add vertex");
662        }
663    }
664
665    #[test]
666    #[cfg(feature = "grammars")]
667    fn walk_simple_rust() {
668        let source = b"fn verify_push() {}\nstruct Foo;\nimpl Foo { fn bar(&self) {} }\n";
669        let grammar = get_grammar("rust");
670
671        let mut parser = tree_sitter::Parser::new();
672        parser.set_language(&grammar.language).unwrap();
673        let tree = parser.parse(source, None).unwrap();
674
675        let protocol = make_test_protocol();
676        let meta = make_test_meta();
677        let mut detector =
678            crate::scope_detector::ScopeDetector::new(&grammar.language, grammar.tags_query, None)
679                .unwrap();
680        let walker = AstWalker::new(
681            source,
682            &meta,
683            &protocol,
684            WalkerConfig::standard(),
685            Some(&mut detector),
686        );
687
688        let schema = walker.walk(&tree, "test.rs").unwrap();
689
690        assert!(
691            schema.vertices.len() > 1,
692            "expected multiple vertices, got {}",
693            schema.vertices.len()
694        );
695
696        if detector.has_query() {
697            let vertex_ids: Vec<String> = schema.vertices.keys().map(ToString::to_string).collect();
698
699            // Rust's function_item — the regression from issue #34 — must be
700            // detected as a named scope now.
701            assert!(
702                vertex_ids.iter().any(|id| id.ends_with("::verify_push")),
703                "expected ::verify_push named scope, got: {vertex_ids:?}"
704            );
705            assert!(
706                vertex_ids.iter().any(|id| id.ends_with("::Foo")),
707                "expected ::Foo named scope, got: {vertex_ids:?}"
708            );
709        }
710    }
711
712    /// Helper: parse source with a grammar, walk to Schema, emit back, compare.
713    #[cfg(feature = "group-data")]
714    fn assert_roundtrip(grammar_name: &str, source: &[u8], file_path: &str) {
715        use crate::registry::AstParser;
716        let grammar = panproto_grammars::grammars()
717            .into_iter()
718            .find(|g| g.name == grammar_name)
719            .unwrap_or_else(|| panic!("grammar '{grammar_name}' not enabled"));
720
721        let config = crate::languages::walker_configs::walker_config_for(grammar_name);
722        let lang_parser = crate::languages::common::LanguageParser::from_language(
723            grammar_name,
724            grammar.extensions.to_vec(),
725            grammar.language,
726            grammar.node_types,
727            grammar.tags_query,
728            config,
729        )
730        .unwrap();
731
732        let schema = lang_parser.parse(source, file_path).unwrap();
733        let emitted = lang_parser.emit(&schema).unwrap();
734
735        assert_eq!(
736            std::str::from_utf8(source).unwrap(),
737            std::str::from_utf8(&emitted).unwrap(),
738            "round-trip failed for {grammar_name}: emitted bytes differ from source"
739        );
740    }
741
742    #[test]
743    #[cfg(feature = "group-data")]
744    fn roundtrip_json_simple() {
745        assert_roundtrip("json", br#"{"name": "test", "value": 42}"#, "test.json");
746    }
747
748    #[test]
749    #[cfg(feature = "group-data")]
750    fn roundtrip_json_formatted() {
751        let source =
752            b"{\n  \"name\": \"test\",\n  \"value\": 42,\n  \"nested\": {\n    \"a\": true\n  }\n}";
753        assert_roundtrip("json", source, "test.json");
754    }
755
756    #[test]
757    #[cfg(feature = "group-data")]
758    fn roundtrip_json_array() {
759        let source = b"[\n  1,\n  2,\n  3\n]";
760        assert_roundtrip("json", source, "test.json");
761    }
762
763    #[test]
764    #[cfg(feature = "group-data")]
765    fn roundtrip_xml_simple() {
766        let source = b"<root>\n  <child attr=\"val\">text</child>\n</root>";
767        assert_roundtrip("xml", source, "test.xml");
768    }
769
770    #[test]
771    #[cfg(feature = "group-data")]
772    fn roundtrip_yaml_simple() {
773        let source = b"name: test\nvalue: 42\nnested:\n  a: true\n";
774        assert_roundtrip("yaml", source, "test.yaml");
775    }
776
777    #[test]
778    #[cfg(feature = "group-data")]
779    fn roundtrip_toml_simple() {
780        let source = b"[package]\nname = \"test\"\nversion = \"0.1.0\"\n";
781        assert_roundtrip("toml", source, "test.toml");
782    }
783
784    #[cfg(feature = "group-data")]
785    fn parse_with(grammar_name: &str, source: &[u8], file_path: &str) -> panproto_schema::Schema {
786        use crate::registry::AstParser;
787        let grammar = panproto_grammars::grammars()
788            .into_iter()
789            .find(|g| g.name == grammar_name)
790            .unwrap_or_else(|| panic!("grammar '{grammar_name}' not enabled"));
791        let config = crate::languages::walker_configs::walker_config_for(grammar_name);
792        let lang_parser = crate::languages::common::LanguageParser::from_language(
793            grammar_name,
794            grammar.extensions.to_vec(),
795            grammar.language,
796            grammar.node_types,
797            grammar.tags_query,
798            config,
799        )
800        .unwrap();
801        lang_parser.parse(source, file_path).unwrap()
802    }
803
804    #[test]
805    #[cfg(feature = "group-data")]
806    fn fingerprint_and_child_kinds_emitted_separately() {
807        // The walker must emit `chose-alt-fingerprint` and
808        // `chose-alt-child-kinds` as TWO distinct constraints. The
809        // CHOICE picker reads them independently: literal-token
810        // matches drive primary scoring, child-kind matches act as a
811        // tiebreaker. Mixing them would let punctuation in kind names
812        // contaminate the literal score.
813        let schema = parse_with("json", br#"{"a": 1}"#, "test.json");
814
815        let saw_fingerprint = schema.constraints.values().any(|cs| {
816            cs.iter()
817                .any(|c| c.sort.as_ref() == "chose-alt-fingerprint")
818        });
819        let saw_child_kinds = schema.constraints.values().any(|cs| {
820            cs.iter()
821                .any(|c| c.sort.as_ref() == "chose-alt-child-kinds")
822        });
823
824        assert!(
825            saw_fingerprint,
826            "walker must emit chose-alt-fingerprint (literal-token witness)"
827        );
828        assert!(
829            saw_child_kinds,
830            "walker must emit chose-alt-child-kinds (named-kind witness)"
831        );
832    }
833
834    #[test]
835    #[cfg(feature = "group-data")]
836    fn child_kinds_excludes_hidden_rules() {
837        // Hidden rules (`_`-prefixed) are tree-sitter implementation
838        // detail and must not appear in the kind witness.
839        let schema = parse_with("json", br#"{"k": "v"}"#, "test.json");
840
841        for cs in schema.constraints.values() {
842            for c in cs {
843                if c.sort.as_ref() == "chose-alt-child-kinds" {
844                    for kind in c.value.split_whitespace() {
845                        assert!(
846                            !kind.starts_with('_'),
847                            "hidden-rule kind '{kind}' must not appear in chose-alt-child-kinds"
848                        );
849                    }
850                }
851            }
852        }
853    }
854}