Struct SymbolMap 

pub struct SymbolMap { /* private fields */ }

A SymbolMap is a low-level datastructure used in implementing a SymbolTable operation.

It is primarily responsible for maintaining a mapping between symbol names, and the symbol operations registered to those names, within the body of the containing SymbolTable op.

In most circumstances, you will want to interact with this via SymbolManager or SymbolManagerMut, as the operations provided here are mostly low-level plumbing, and thus incomplete without functionality provided by higher-level abstractions.

Implementations

impl SymbolMap

pub fn build(op: &Operation) -> Self

Build a SymbolMap on the fly from the given operation.

It is assumed that the given operation is a SymbolTable op, but this is not checked, and does not affect the correctness - however, it has limited utility for non-symbol table ops.

pub fn get(&self, name: impl Into<SymbolName>) -> Option<SymbolRef>

Get the symbol named name, or None if undefined.

pub fn get_op(&self, name: impl Into<SymbolName>) -> Option<OperationRef>

Get the symbol named name as an OperationRef, or None if undefined.

pub fn resolve( &self, symbol_table: &Operation, attr: &SymbolPath, ) -> Option<OperationRef>

Get the symbol referenced by attr as an OperationRef, or None if undefined.

This function will search for the symbol path according to whether the path is absolute or relative:

• Absolute paths will be resolved by traversing up the operation tree to the root operation, which will be expected to be an anonymous SymbolTable, and then resolve path components from there.
• Relative paths will be resolved from the current SymbolTable

In the special case where a absolute path is given, but the root operation is also a Symbol, it is presumed that what we have found is not the absolute root which represents the global namespace, but rather a symbol defined in the global namespace. This means that only children of that symbol are possibly resolvable (as we have no way to reach other symbols defined in the global namespace). In short, we only attempt to resolve absolute paths where the first component matches the root symbol. If it matches, then the symbol is resolved normally from there, otherwise None is returned.

pub fn contains_key<K>(&self, name: &K) -> bool

where K: ?Sized + Hash + Equivalent<SymbolName>,

Returns true if a symbol named name is in the map

pub fn remove(&mut self, name: SymbolName) -> Option<SymbolRef>

Remove the entry for name from this map, if present.

pub fn insert_new(&mut self, name: SymbolName, symbol: SymbolRef) -> bool

Inserts symbol in the map, as name, so long as name is not already in the map.

pub fn insert(&mut self, name: SymbolName, symbol: SymbolRef) -> SymbolName

Inserts symbol in the map, with name if that name is not already registered in the map. Otherwise, a unique variation of name is generated, and symbol is inserted in the map with that name instead.

If name is modified to make it unique, symbol is updated with the new name on insertion.

Returns the name symbol has after insertion.

NOTE: If symbol is already in the map with name, this is a no-op.

pub fn make_unique( &mut self, op: &SymbolRef, tables: &[SymbolManager<'_>], ) -> SymbolName

Ensures that the given symbol name is unique within this symbol map, as well as all of the provided symbol managers.

Returns the unique name, but this function does not modify the map or rename the symbol itself, that is expected to be done from SymbolManagerMut.

pub fn symbols(&self) -> impl Iterator<Item = SymbolRef> + '_

Get an iterator of SymbolRef corresponding to the Symbol operations in this map

Trait Implementations

impl Debug for SymbolMap

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

Formats the value using the given formatter.

impl Default for SymbolMap

fn default() -> SymbolMap

Returns the “default value” for a type.

impl From<SymbolMap> for Symbols<'_>

fn from(value: SymbolMap) -> Self

Converts to this type from the input type.

impl From<SymbolMap> for SymbolsMut<'_>

fn from(value: SymbolMap) -> Self

Converts to this type from the input type.