Refactor snapshot tests to include Nop statements and adjust span start positions

- Updated multiple snapshot tests for string interpolation and trait adaptation to include Nop statements at the beginning of the program.
- Adjusted the start position of spans in the program structure to reflect the new Nop statements.
- Added a new test file for symbol table functionality, covering function, class, and enum symbol resolution.

Author: wudi

Cargo.lock

@@ -0,0 +1,81 @@
+use crate::ast::visitor::{Visitor, walk_class_member, walk_expr, walk_stmt};
+use crate::ast::*;
+use crate::span::Span;
+
+#[derive(Debug, Clone, Copy)]
+pub enum AstNode<'ast> {
+    Stmt(StmtId<'ast>),
+    Expr(ExprId<'ast>),
+    ClassMember(&'ast ClassMember<'ast>),
+}
+
+impl<'ast> AstNode<'ast> {
+    pub fn span(&self) -> Span {
+        match self {
+            AstNode::Stmt(s) => s.span(),
+            AstNode::Expr(e) => e.span(),
+            AstNode::ClassMember(m) => match m {
+                ClassMember::Property { span, .. } => *span,
+                ClassMember::PropertyHook { span, .. } => *span,
+                ClassMember::Method { span, .. } => *span,
+                ClassMember::Const { span, .. } => *span,
+                ClassMember::TraitUse { span, .. } => *span,
+                ClassMember::Case { span, .. } => *span,
+            },
+        }
+    }
+}
+
+pub struct Locator<'ast> {
+    target: usize,
+    pub path: Vec<AstNode<'ast>>,
+}
+
+impl<'ast> Locator<'ast> {
+    pub fn new(target: usize) -> Self {
+        Self {
+            target,
+            path: Vec::new(),
+        }
+    }
+
+    pub fn find(program: &'ast Program<'ast>, target: usize) -> Vec<AstNode<'ast>> {
+        let mut locator = Self::new(target);
+        locator.visit_program(program);
+        locator.path
+    }
+}
+
+impl<'ast> Visitor<'ast> for Locator<'ast> {
+    fn visit_stmt(&mut self, stmt: StmtId<'ast>) {
+        let span = stmt.span();
+        if span.start <= self.target && self.target <= span.end {
+            self.path.push(AstNode::Stmt(stmt));
+            walk_stmt(self, stmt);
+        }
+    }
+
+    fn visit_expr(&mut self, expr: ExprId<'ast>) {
+        let span = expr.span();
+        if span.start <= self.target && self.target <= span.end {
+            self.path.push(AstNode::Expr(expr));
+            walk_expr(self, expr);
+        }
+    }
+
+    fn visit_class_member(&mut self, member: &'ast ClassMember<'ast>) {
+        let span = match member {
+            ClassMember::Property { span, .. } => *span,
+            ClassMember::PropertyHook { span, .. } => *span,
+            ClassMember::Method { span, .. } => *span,
+            ClassMember::Const { span, .. } => *span,
+            ClassMember::TraitUse { span, .. } => *span,
+            ClassMember::Case { span, .. } => *span,
+        };
+
+        if span.start <= self.target && self.target <= span.end {
+            self.path.push(AstNode::ClassMember(member));
+            walk_class_member(self, member);
+        }
+    }
+}

src/ast/locator.rs

@@ -2,7 +2,9 @@ use crate::lexer::token::Token;
 use crate::span::{LineInfo, Span};
 use serde::Serialize;
 
+pub mod locator;
 pub mod sexpr;
+pub mod symbol_table;
 pub mod visitor;
 
 pub type ExprId<'ast> = &'ast Expr<'ast>;
@@ -117,6 +119,7 @@ pub enum Stmt<'ast> {
         params: &'ast [Param<'ast>],
         return_type: Option<&'ast Type<'ast>>,
         body: &'ast [StmtId<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Class {
@@ -126,19 +129,22 @@ pub enum Stmt<'ast> {
         extends: Option<Name<'ast>>,
         implements: &'ast [Name<'ast>],
         members: &'ast [ClassMember<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Interface {
         attributes: &'ast [AttributeGroup<'ast>],
         name: &'ast Token,
         extends: &'ast [Name<'ast>],
         members: &'ast [ClassMember<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Trait {
         attributes: &'ast [AttributeGroup<'ast>],
         name: &'ast Token,
         members: &'ast [ClassMember<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Enum {
@@ -147,6 +153,7 @@ pub enum Stmt<'ast> {
         backed_type: Option<&'ast Type<'ast>>,
         implements: &'ast [Name<'ast>],
         members: &'ast [ClassMember<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Namespace {
@@ -177,6 +184,7 @@ pub enum Stmt<'ast> {
     Const {
         attributes: &'ast [AttributeGroup<'ast>],
         consts: &'ast [ClassConst<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Break {
@@ -325,6 +333,10 @@ pub enum Expr<'ast> {
         name: Span,
         span: Span,
     },
+    IndirectVariable {
+        name: ExprId<'ast>,
+        span: Span,
+    },
     Integer {
         value: &'ast [u8],
         span: Span,
@@ -559,6 +571,7 @@ impl<'ast> Expr<'ast> {
             Expr::NullsafeMethodCall { span, .. } => *span,
             Expr::VariadicPlaceholder { span } => *span,
             Expr::Error { span } => *span,
+            Expr::IndirectVariable { span, .. } => *span,
         }
     }
 }
@@ -683,6 +696,7 @@ pub enum ClassMember<'ast> {
         modifiers: &'ast [Token],
         ty: Option<&'ast Type<'ast>>,
         entries: &'ast [PropertyEntry<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     PropertyHook {
@@ -692,6 +706,7 @@ pub enum ClassMember<'ast> {
         name: &'ast Token,
         default: Option<ExprId<'ast>>,
         hooks: &'ast [PropertyHook<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Method {
@@ -701,25 +716,29 @@ pub enum ClassMember<'ast> {
         params: &'ast [Param<'ast>],
         return_type: Option<&'ast Type<'ast>>,
         body: &'ast [StmtId<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Const {
         attributes: &'ast [AttributeGroup<'ast>],
         modifiers: &'ast [Token],
         ty: Option<&'ast Type<'ast>>,
         consts: &'ast [ClassConst<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     TraitUse {
         attributes: &'ast [AttributeGroup<'ast>],
         traits: &'ast [Name<'ast>],
         adaptations: &'ast [TraitAdaptation<'ast>],
+        doc_comment: Option<Span>,
         span: Span,
     },
     Case {
         attributes: &'ast [AttributeGroup<'ast>],
         name: &'ast Token,
         value: Option<ExprId<'ast>>,
+        doc_comment: Option<Span>,
         span: Span,
     },
 }

src/ast/mod.rs

@@ -651,6 +651,11 @@ impl<'a, 'ast> Visitor<'ast> for SExprFormatter<'a> {
                 self.write(&String::from_utf8_lossy(name.as_str(self.source)));
                 self.write("\")");
             }
+            Expr::IndirectVariable { name, .. } => {
+                self.write("(indirect-variable ");
+                self.visit_expr(name);
+                self.write(")");
+            }
             Expr::Unary { op, expr, .. } => {
                 self.write("(");
                 self.write(match op {