Struct SymbolReferences 

pub struct SymbolReferences { /* private fields */ }

Stores various maps tracking references between symbols (classes, functions, etc.) and class-like members (methods, properties, constants, etc.) within the codebase.

This is primarily used for dependency analysis, understanding code structure, and potentially for tasks like dead code detection or impact analysis.

Implementations

impl SymbolReferences

pub fn new() -> Self

Creates a new, empty SymbolReferences collection.

pub fn count_body_references(&self) -> usize

Counts the total number of symbol-to-symbol body references.

pub fn count_signature_references(&self) -> usize

Counts the total number of symbol-to-symbol signature references.

pub fn count_referencing_symbols( &self, symbol: &SymbolIdentifier, in_signature: bool, ) -> usize

Counts how many symbols reference the given symbol.

Arguments

• symbol - The symbol to check references to
• in_signature - If true, count signature references; if false, count body references

Returns

The number of symbols that reference the given symbol

pub fn count_property_reads(&self, property: &SymbolIdentifier) -> usize

Counts how many symbols have a read reference to the given property.

Arguments

• property - The property symbol identifier (ClassName, PropertyName) to check

Returns

The number of symbols that read the given property

pub fn count_property_writes(&self, property: &SymbolIdentifier) -> usize

Counts how many symbols have a write reference to the given property.

Arguments

• property - The property symbol identifier (ClassName, PropertyName) to check

Returns

The number of symbols that write to the given property

pub fn add_symbol_reference_to_class_member( &mut self, referencing_symbol: Atom, class_member: SymbolIdentifier, in_signature: bool, )

Records that a top-level symbol (e.g., a function) references a class member.

Automatically adds a reference from the referencing symbol to the member’s class.

Arguments

• referencing_symbol: The FQN of the function or global const making the reference.
• class_member: A tuple (ClassName, MemberName) being referenced.
• in_signature: true if the reference occurs in a signature context, false if in the body.

pub fn add_symbol_reference_to_symbol( &mut self, referencing_symbol: Atom, symbol: Atom, in_signature: bool, )

Records that a top-level symbol references another top-level symbol.

Skips self-references. Skips body references if already referenced in signature.

Arguments

• referencing_symbol: The FQN of the symbol making the reference.
• symbol: The FQN of the symbol being referenced.
• in_signature: true if the reference occurs in a signature context, false if in the body.

pub fn add_class_member_reference_to_class_member( &mut self, referencing_class_member: SymbolIdentifier, class_member: SymbolIdentifier, in_signature: bool, )

Records that a class member references another class member.

Automatically adds references from the referencing member’s class to the referenced member’s class, and from the referencing member to the referenced member’s class. Skips self-references.

Arguments

• referencing_class_member: Tuple (ClassName, MemberName) making the reference.
• class_member: Tuple (ClassName, MemberName) being referenced.
• in_signature: true if the reference occurs in a signature context, false if in the body.

pub fn add_class_member_reference_to_symbol( &mut self, referencing_class_member: SymbolIdentifier, symbol: Atom, in_signature: bool, )

Records that a class member references a top-level symbol.

Automatically adds a reference from the referencing member’s class to the referenced symbol. Skips references to the member’s own class. Skips body references if already referenced in signature.

Arguments

• referencing_class_member: Tuple (ClassName, MemberName) making the reference.
• symbol: The FQN of the symbol being referenced.
• in_signature: true if the reference occurs in a signature context, false if in the body.

pub fn add_file_reference_to_class_member( &mut self, file_hash: Atom, class_member: SymbolIdentifier, in_signature: bool, )

Adds a file-level reference to a class member. This is used for references from global/top-level scope that aren’t within any symbol.

pub fn add_reference_to_class_member( &mut self, scope: &ScopeContext<'_>, class_member: SymbolIdentifier, in_signature: bool, )

Convenience method to add a reference from the current function context to a class member. Delegates to appropriate add_* methods based on the function context.

pub fn add_reference_to_class_member_with_file( &mut self, scope: &ScopeContext<'_>, class_member: SymbolIdentifier, in_signature: bool, file_hash: Option<Atom>, )

Convenience method to add a reference from the current function context to a class member. Delegates to appropriate add_* methods based on the function context. If file_hash is provided and the reference is from global scope, uses file-level tracking.

Note on Normalization

This method assumes that symbol names (class_member, function_name, class_name) are already normalized to lowercase, as they come from the codebase which stores all symbols in lowercase form. No additional normalization is performed to avoid redundant overhead.

pub fn add_reference_for_method_call( &mut self, scope: &ScopeContext<'_>, method: &MethodIdentifier, )

pub fn add_reference_for_property_read( &mut self, scope: &ScopeContext<'_>, class_name: Atom, property_name: Atom, )

Records a read reference to a property (e.g., $this->prop used as a value).

pub fn add_reference_for_property_write( &mut self, scope: &ScopeContext<'_>, class_name: Atom, property_name: Atom, )

Records a write reference to a property (e.g., $this->prop = value). This is tracked separately from read references to enable write-only property detection.

pub fn add_reference_to_overridden_class_member( &mut self, scope: &ScopeContext<'_>, class_member: SymbolIdentifier, )

Convenience method to add a reference from the current function context to an overridden class member (e.g., parent::foo). Delegates based on the function context.

pub fn add_reference_to_symbol( &mut self, scope: &ScopeContext<'_>, symbol: Atom, in_signature: bool, )

Convenience method to add a reference from the current function context to a top-level symbol. Delegates to appropriate add_* methods based on the function context.

pub fn add_reference_to_functionlike_return( &mut self, referencing_functionlike: FunctionLikeIdentifier, referenced_functionlike: FunctionLikeIdentifier, )

Records that one function/method references the return value of another. Used for dead code analysis.

pub fn extend(&mut self, other: Self)

Merges references from another SymbolReferences instance into this one. Existing references are extended, not replaced.

pub fn get_referenced_symbols_and_members(&self) -> HashSet<&SymbolIdentifier>

Computes the set of all unique symbols and members that are referenced by any symbol/member tracked in the body or signature reference maps.

Returns

A HashSet containing &(SymbolName, MemberName) tuples of all referenced items.

pub fn get_back_references( &self, ) -> HashMap<SymbolIdentifier, HashSet<SymbolIdentifier>>

Computes the inverse of the body and signature reference maps.

Returns

A HashMap where the key is the referenced symbol/member (Symbol, Member) and the value is a HashSet of referencing symbols/members (RefSymbol, RefMember).

pub fn get_references_to_symbol( &self, target_symbol: SymbolIdentifier, ) -> HashSet<&SymbolIdentifier>

Finds all symbols/members that reference a specific target symbol/member. Checks both body and signature references.

Arguments

• target_symbol: The (SymbolName, MemberName) tuple being referenced.

Returns

A HashSet containing &(RefSymbol, RefMember) tuples of all items referencing the target.

pub fn get_referenced_symbols_and_members_with_counts( &self, ) -> HashMap<SymbolIdentifier, u32>

Computes the count of references for each unique symbol/member referenced in bodies or signatures.

Returns

A HashMap where the key is the referenced symbol/member (Symbol, Member) and the value is the total count (u32) of references to it.

pub fn get_referenced_overridden_class_members( &self, ) -> HashMap<SymbolIdentifier, HashSet<SymbolIdentifier>>

Computes the inverse of the overridden member reference map.

Returns

A HashMap where the key is the overridden member (ParentSymbol, Member) and the value is a HashSet of referencing symbols/members (RefSymbol, RefMember) that call it via parent::.

pub fn get_invalid_symbols( &self, codebase_diff: &CodebaseDiff, ) -> Option<(HashSet<SymbolIdentifier>, AtomSet)>

Calculates sets of invalid symbols and members based on detected code changes (CodebaseDiff). Propagates invalidation through the dependency graph stored in signature references. Limits propagation expense to avoid excessive computation on large changes.

Arguments

• codebase_diff: Information about added, deleted, or modified symbols/signatures.

Returns

Some((invalid_signatures, partially_invalid)) on success, where invalid_signatures contains all symbol/member pairs whose signature is invalid (including propagated ones), and partially_invalid contains symbols with at least one invalid member. Returns None if the propagation exceeds an expense limit (currently 5000 steps).

pub fn remove_references_from_invalid_symbols( &mut self, invalid_symbols_and_members: &HashSet<SymbolIdentifier>, )

Removes all references originating from symbols/members that are marked as invalid.

Arguments

• invalid_symbols_and_members: A set containing (SymbolName, MemberName) tuples for invalid items.

pub fn get_symbol_references_to_symbols( &self, ) -> &HashMap<SymbolIdentifier, HashSet<SymbolIdentifier>>

Returns a reference to the map tracking references within symbol/member bodies.

pub fn get_symbol_references_to_symbols_in_signature( &self, ) -> &HashMap<SymbolIdentifier, HashSet<SymbolIdentifier>>

Returns a reference to the map tracking references within symbol/member signatures.

pub fn get_symbol_references_to_overridden_members( &self, ) -> &HashMap<SymbolIdentifier, HashSet<SymbolIdentifier>>

Returns a reference to the map tracking references to overridden members.

pub fn get_functionlike_references_to_functionlike_returns( &self, ) -> &HashMap<FunctionLikeIdentifier, HashSet<FunctionLikeIdentifier>>

Returns a reference to the map tracking references to function-like return values.

pub fn get_file_references_to_symbols( &self, ) -> &HashMap<Atom, HashSet<SymbolIdentifier>>

Returns a reference to the map tracking file-level references to symbols (body).

pub fn get_file_references_to_symbols_in_signature( &self, ) -> &HashMap<Atom, HashSet<SymbolIdentifier>>

Returns a reference to the map tracking file-level references to symbols (signature).

Trait Implementations

impl Clone for SymbolReferences

fn clone(&self) -> SymbolReferences

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SymbolReferences

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SymbolReferences

fn default() -> SymbolReferences

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SymbolReferences

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SymbolReferences

fn eq(&self, other: &SymbolReferences) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SymbolReferences

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SymbolReferences