sway_core/semantic_analysis/namespace/

lexical_scope.rs

use crate::{
    decl_engine::{parsed_engine::ParsedDeclEngineGet, parsed_id::ParsedDeclId, *},
    engine_threading::{Engines, PartialEqWithEngines, PartialEqWithEnginesContext},
    language::{
        parsed::{Declaration, FunctionDeclaration},
        ty::{self, TyDecl, TyStorageDecl},
        Visibility,
    },
    namespace::*,
    semantic_analysis::{ast_node::ConstShadowingMode, GenericShadowingMode},
    type_system::*,
};

use super::{root::ResolvedDeclaration, TraitMap};

use parking_lot::RwLock;
use sway_error::{
    error::{CompileError, ShadowingSource},
    handler::{ErrorEmitted, Handler},
};
use sway_types::{span::Span, IdentUnique, Named, Spanned};

use std::{collections::HashMap, sync::Arc};

pub enum ResolvedFunctionDecl {
    Parsed(ParsedDeclId<FunctionDeclaration>),
    Typed(DeclRefFunction),
}

impl ResolvedFunctionDecl {
    pub fn expect_typed(self) -> DeclRefFunction {
        match self {
            ResolvedFunctionDecl::Parsed(_) => panic!(),
            ResolvedFunctionDecl::Typed(fn_ref) => fn_ref,
        }
    }
}

// The following types were using im::OrdMap but it revealed to be
// much slower than using HashMap and sorting on iterationn.
pub(super) type SymbolMap = HashMap<Ident, ResolvedDeclaration>;
pub(super) type SymbolUniqueMap = HashMap<IdentUnique, ResolvedDeclaration>;

type SourceIdent = Ident;

pub(super) type GlobSynonyms =
    HashMap<Ident, Vec<(ModulePathBuf, ResolvedDeclaration, Visibility)>>;
pub(super) type ItemSynonyms = HashMap<
    Ident,
    (
        Option<SourceIdent>,
        ModulePathBuf,
        ResolvedDeclaration,
        Visibility,
    ),
>;

/// Represents a lexical scope integer-based identifier, which can be used to reference
/// specific a lexical scope.
pub type LexicalScopeId = usize;

/// Represents a lexical scope path, a vector of lexical scope identifiers, which specifies
/// the path from root to a specific lexical scope in the hierarchy.
pub type LexicalScopePath = Vec<LexicalScopeId>;

/// A `LexicalScope` contains a set of all items that exist within the lexical scope via declaration or
/// importing, along with all its associated hierarchical scopes.
#[derive(Clone, Debug, Default)]
pub struct LexicalScope {
    /// The set of symbols, implementations, synonyms and aliases present within this scope.
    pub items: Items,
    /// The set of available scopes defined inside this scope's hierarchy.
    pub children: Vec<LexicalScopeId>,
    /// The parent scope associated with this scope. Will be None for a root scope.
    pub parent: Option<LexicalScopeId>,
    /// The parent while visiting scopes and push popping scopes from a stack.
    /// This may differ from parent as we may revisit the scope in a different order during type check.
    pub visitor_parent: Option<LexicalScopeId>,
    /// The declaration associated with this scope. This will initially be a [ParsedDeclId],
    /// but can be replaced to be a [DeclId] once the declaration is type checked.
    pub declaration: Option<ResolvedDeclaration>,
}

/// The set of items that exist within some lexical scope via declaration or importing.
#[derive(Clone, Debug, Default)]
pub struct Items {
    /// An map from `Ident`s to their associated declarations.
    pub(crate) symbols: SymbolMap,

    /// An map from `IdentUnique`s to their associated declarations.
    /// This uses an Arc<RwLock<SymbolUniqueMap>> so it is shared between all
    /// Items clones. This is intended so we can keep the symbols of previous
    /// lexical scopes while collecting_unifications scopes.
    pub(crate) symbols_unique_while_collecting_unifications: Arc<RwLock<SymbolUniqueMap>>,

    pub(crate) implemented_traits: TraitMap,
    /// Contains symbols imported using star imports (`use foo::*`.).
    ///
    /// When star importing from multiple modules the same name may be imported more than once. This
    /// is not an error, but it is an error to use the name without a module path. To represent
    /// this, use_glob_synonyms maps identifiers to a vector of (module path, type declaration)
    /// tuples.
    pub(crate) use_glob_synonyms: GlobSynonyms,
    /// Contains symbols imported using item imports (`use foo::bar`).
    ///
    /// For aliased item imports `use ::foo::bar::Baz as Wiz` the map key is `Wiz`. `Baz` is stored
    /// as the optional source identifier for error reporting purposes.
    pub(crate) use_item_synonyms: ItemSynonyms,
    /// If there is a storage declaration (which are only valid in contracts), store it here.
    pub(crate) declared_storage: Option<DeclRefStorage>,
}

impl Items {
    /// Immutable access to the inner symbol map.
    pub fn symbols(&self) -> &SymbolMap {
        &self.symbols
    }

    #[allow(clippy::too_many_arguments)]
    pub fn apply_storage_load(
        &self,
        handler: &Handler,
        engines: &Engines,
        namespace: &Namespace,
        namespace_names: &[Ident],
        fields: &[Ident],
        storage_fields: &[ty::TyStorageField],
        storage_keyword_span: Span,
    ) -> Result<(ty::TyStorageAccess, TypeId), ErrorEmitted> {
        match self.declared_storage {
            Some(ref decl_ref) => {
                let storage = engines.de().get_storage(&decl_ref.id().clone());
                storage.apply_storage_load(
                    handler,
                    engines,
                    namespace,
                    namespace_names,
                    fields,
                    storage_fields,
                    storage_keyword_span,
                )
            }
            None => Err(handler.emit_err(CompileError::NoDeclaredStorage {
                span: fields[0].span(),
            })),
        }
    }

    pub fn set_storage_declaration(
        &mut self,
        handler: &Handler,
        decl_ref: DeclRefStorage,
    ) -> Result<(), ErrorEmitted> {
        if self.declared_storage.is_some() {
            return Err(handler.emit_err(CompileError::MultipleStorageDeclarations {
                span: decl_ref.span(),
            }));
        }
        self.declared_storage = Some(decl_ref);
        Ok(())
    }

    pub fn get_all_declared_symbols(&self) -> Vec<&Ident> {
        let mut keys: Vec<_> = self.symbols().keys().collect();
        keys.sort();
        keys
    }

    pub fn resolve_symbol(
        &self,
        handler: &Handler,
        engines: &Engines,
        symbol: &Ident,
        current_mod_path: &ModulePathBuf,
    ) -> Result<Option<(ResolvedDeclaration, ModulePathBuf)>, ErrorEmitted> {
        // Check locally declared items. Any name clash with imports will have already been reported as an error.
        if let Some(decl) = self.symbols.get(symbol) {
            return Ok(Some((decl.clone(), current_mod_path.clone())));
        }

        // Check item imports
        if let Some((_, decl_path, decl, _)) = self.use_item_synonyms.get(symbol) {
            return Ok(Some((decl.clone(), decl_path.clone())));
        }

        // Check glob imports
        if let Some(decls) = self.use_glob_synonyms.get(symbol) {
            if decls.len() == 1 {
                return Ok(Some((decls[0].1.clone(), decls[0].0.clone())));
            } else if decls.is_empty() {
                return Err(handler.emit_err(CompileError::Internal(
                    "The name {symbol} was bound in a star import, but no corresponding module paths were found",
                    symbol.span(),
                )));
            } else {
                return Err(handler.emit_err(CompileError::SymbolWithMultipleBindings {
                    name: symbol.clone(),
                    paths: decls
                        .iter()
                        .map(|(path, decl, _)| {
                            get_path_for_decl(path, decl, engines, &current_mod_path[0]).join("::")
                        })
                        .collect(),
                    span: symbol.span(),
                }));
            }
        }

        Ok(None)
    }

    pub(crate) fn insert_parsed_symbol(
        handler: &Handler,
        engines: &Engines,
        module: &mut Module,
        name: Ident,
        item: Declaration,
        const_shadowing_mode: ConstShadowingMode,
        generic_shadowing_mode: GenericShadowingMode,
    ) -> Result<(), ErrorEmitted> {
        Self::insert_symbol(
            handler,
            engines,
            module,
            name,
            ResolvedDeclaration::Parsed(item),
            const_shadowing_mode,
            generic_shadowing_mode,
            false,
        )
    }

    #[allow(clippy::too_many_arguments)]
    pub(crate) fn insert_typed_symbol(
        handler: &Handler,
        engines: &Engines,
        module: &mut Module,
        name: Ident,
        item: ty::TyDecl,
        const_shadowing_mode: ConstShadowingMode,
        generic_shadowing_mode: GenericShadowingMode,
        collecting_unifications: bool,
    ) -> Result<(), ErrorEmitted> {
        Self::insert_symbol(
            handler,
            engines,
            module,
            name,
            ResolvedDeclaration::Typed(item),
            const_shadowing_mode,
            generic_shadowing_mode,
            collecting_unifications,
        )
    }

    #[allow(clippy::too_many_arguments)]
    pub(crate) fn insert_symbol(
        handler: &Handler,
        engines: &Engines,
        module: &mut Module,
        name: Ident,
        item: ResolvedDeclaration,
        const_shadowing_mode: ConstShadowingMode,
        generic_shadowing_mode: GenericShadowingMode,
        collecting_unifications: bool,
    ) -> Result<(), ErrorEmitted> {
        let parsed_decl_engine = engines.pe();
        let decl_engine = engines.de();

        #[allow(unused)]
        let append_shadowing_error_parsed =
            |ident: &Ident,
             decl: &Declaration,
             is_use: bool,
             is_alias: bool,
             item: &Declaration,
             const_shadowing_mode: ConstShadowingMode| {
                use Declaration::*;
                match (
                    ident,
                    decl,
                    is_use,
                    is_alias,
                    &item,
                    const_shadowing_mode,
                    generic_shadowing_mode,
                ) {
                    // A general remark for using the `ShadowingSource::LetVar`.
                    // If the shadowing is detected at this stage, the variable is for
                    // sure a local variable, because in the case of pattern matching
                    // struct field variables, the error is already reported and
                    // the compilation do not proceed to the point of inserting
                    // the pattern variable into the items.

                    // variable shadowing a constant
                    (
                        constant_ident,
                        ConstantDeclaration(decl_id),
                        is_imported_constant,
                        is_alias,
                        VariableDeclaration { .. },
                        _,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantsCannotBeShadowed {
                            shadowing_source: ShadowingSource::LetVar,
                            name: (&name).into(),
                            constant_span: constant_ident.span(),
                            constant_decl_span: if is_imported_constant {
                                parsed_decl_engine.get(decl_id).span.clone()
                            } else {
                                Span::dummy()
                            },
                            is_alias,
                        });
                    }
                    // variable shadowing a configurable
                    (
                        configurable_ident,
                        ConfigurableDeclaration(_),
                        _,
                        _,
                        VariableDeclaration { .. },
                        _,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConfigurablesCannotBeShadowed {
                            shadowing_source: ShadowingSource::LetVar,
                            name: (&name).into(),
                            configurable_span: configurable_ident.span(),
                        });
                    }
                    // constant shadowing a constant sequentially
                    (
                        constant_ident,
                        ConstantDeclaration(decl_id),
                        is_imported_constant,
                        is_alias,
                        ConstantDeclaration { .. },
                        ConstShadowingMode::Sequential,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantsCannotBeShadowed {
                            shadowing_source: ShadowingSource::Const,
                            name: (&name).into(),
                            constant_span: constant_ident.span(),
                            constant_decl_span: if is_imported_constant {
                                parsed_decl_engine.get(decl_id).span.clone()
                            } else {
                                Span::dummy()
                            },
                            is_alias,
                        });
                    }
                    // constant shadowing a configurable sequentially
                    (
                        configurable_ident,
                        ConfigurableDeclaration(_),
                        _,
                        _,
                        ConstantDeclaration { .. },
                        ConstShadowingMode::Sequential,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConfigurablesCannotBeShadowed {
                            shadowing_source: ShadowingSource::Const,
                            name: (&name).into(),
                            configurable_span: configurable_ident.span(),
                        });
                    }
                    // constant shadowing a variable
                    (_, VariableDeclaration(decl_id), _, _, ConstantDeclaration { .. }, _, _) => {
                        handler.emit_err(CompileError::ConstantShadowsVariable {
                            name: (&name).into(),
                            variable_span: parsed_decl_engine.get(decl_id).name.span(),
                        });
                    }
                    // constant shadowing a constant item-style (outside of a function body)
                    (
                        constant_ident,
                        ConstantDeclaration { .. },
                        _,
                        _,
                        ConstantDeclaration { .. },
                        ConstShadowingMode::ItemStyle,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantDuplicatesConstantOrConfigurable {
                            existing_constant_or_configurable: "Constant",
                            new_constant_or_configurable: "Constant",
                            name: (&name).into(),
                            existing_span: constant_ident.span(),
                        });
                    }
                    // constant shadowing a configurable item-style (outside of a function body)
                    (
                        configurable_ident,
                        ConfigurableDeclaration { .. },
                        _,
                        _,
                        ConstantDeclaration { .. },
                        ConstShadowingMode::ItemStyle,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantDuplicatesConstantOrConfigurable {
                            existing_constant_or_configurable: "Configurable",
                            new_constant_or_configurable: "Constant",
                            name: (&name).into(),
                            existing_span: configurable_ident.span(),
                        });
                    }
                    // configurable shadowing a constant item-style (outside of a function body)
                    (
                        constant_ident,
                        ConstantDeclaration { .. },
                        _,
                        _,
                        ConfigurableDeclaration { .. },
                        ConstShadowingMode::ItemStyle,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantDuplicatesConstantOrConfigurable {
                            existing_constant_or_configurable: "Constant",
                            new_constant_or_configurable: "Configurable",
                            name: (&name).into(),
                            existing_span: constant_ident.span(),
                        });
                    }
                    // type or type alias shadowing another type or type alias
                    // trait/abi shadowing another trait/abi
                    // type or type alias shadowing a trait/abi, or vice versa
                    (
                        _,
                        StructDeclaration { .. }
                        | EnumDeclaration { .. }
                        | TypeAliasDeclaration { .. }
                        | TraitDeclaration { .. }
                        | AbiDeclaration { .. },
                        _,
                        _,
                        StructDeclaration { .. }
                        | EnumDeclaration { .. }
                        | TypeAliasDeclaration { .. }
                        | TraitDeclaration { .. }
                        | AbiDeclaration { .. },
                        _,
                        _,
                    ) => {
                        handler.emit_err(CompileError::MultipleDefinitionsOfName {
                            name: name.clone(),
                            span: name.span(),
                        });
                    }
                    _ => {}
                }
            };

        let append_shadowing_error_typed =
            |ident: &Ident,
             decl: &ty::TyDecl,
             is_use: bool,
             is_alias: bool,
             item: &ty::TyDecl,
             const_shadowing_mode: ConstShadowingMode| {
                use ty::TyDecl::*;
                match (
                    ident,
                    decl,
                    is_use,
                    is_alias,
                    &item,
                    const_shadowing_mode,
                    generic_shadowing_mode,
                ) {
                    // A general remark for using the `ShadowingSource::LetVar`.
                    // If the shadowing is detected at this stage, the variable is for
                    // sure a local variable, because in the case of pattern matching
                    // struct field variables, the error is already reported and
                    // the compilation do not proceed to the point of inserting
                    // the pattern variable into the items.

                    // variable shadowing a constant
                    (
                        constant_ident,
                        ConstantDecl(constant_decl),
                        is_imported_constant,
                        is_alias,
                        VariableDecl { .. },
                        _,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantsCannotBeShadowed {
                            shadowing_source: ShadowingSource::LetVar,
                            name: (&name).into(),
                            constant_span: constant_ident.span(),
                            constant_decl_span: if is_imported_constant {
                                decl_engine.get(&constant_decl.decl_id).span.clone()
                            } else {
                                Span::dummy()
                            },
                            is_alias,
                        });
                    }
                    // variable shadowing a configurable
                    (configurable_ident, ConfigurableDecl(_), _, _, VariableDecl { .. }, _, _) => {
                        handler.emit_err(CompileError::ConfigurablesCannotBeShadowed {
                            shadowing_source: ShadowingSource::LetVar,
                            name: (&name).into(),
                            configurable_span: configurable_ident.span(),
                        });
                    }
                    // constant shadowing a constant sequentially
                    (
                        constant_ident,
                        ConstantDecl(constant_decl),
                        is_imported_constant,
                        is_alias,
                        ConstantDecl { .. },
                        ConstShadowingMode::Sequential,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantsCannotBeShadowed {
                            shadowing_source: ShadowingSource::Const,
                            name: (&name).into(),
                            constant_span: constant_ident.span(),
                            constant_decl_span: if is_imported_constant {
                                decl_engine.get(&constant_decl.decl_id).span.clone()
                            } else {
                                Span::dummy()
                            },
                            is_alias,
                        });
                    }
                    // constant shadowing a configurable sequentially
                    (
                        configurable_ident,
                        ConfigurableDecl(_),
                        _,
                        _,
                        ConstantDecl { .. },
                        ConstShadowingMode::Sequential,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConfigurablesCannotBeShadowed {
                            shadowing_source: ShadowingSource::Const,
                            name: (&name).into(),
                            configurable_span: configurable_ident.span(),
                        });
                    }
                    // constant shadowing a variable
                    (_, VariableDecl(variable_decl), _, _, ConstantDecl { .. }, _, _) => {
                        handler.emit_err(CompileError::ConstantShadowsVariable {
                            name: (&name).into(),
                            variable_span: variable_decl.name.span(),
                        });
                    }
                    // constant shadowing a constant item-style (outside of a function body)
                    (
                        constant_ident,
                        ConstantDecl { .. },
                        _,
                        _,
                        ConstantDecl { .. },
                        ConstShadowingMode::ItemStyle,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantDuplicatesConstantOrConfigurable {
                            existing_constant_or_configurable: "Constant",
                            new_constant_or_configurable: "Constant",
                            name: (&name).into(),
                            existing_span: constant_ident.span(),
                        });
                    }
                    // constant shadowing a configurable item-style (outside of a function body)
                    (
                        configurable_ident,
                        ConfigurableDecl { .. },
                        _,
                        _,
                        ConstantDecl { .. },
                        ConstShadowingMode::ItemStyle,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantDuplicatesConstantOrConfigurable {
                            existing_constant_or_configurable: "Configurable",
                            new_constant_or_configurable: "Constant",
                            name: (&name).into(),
                            existing_span: configurable_ident.span(),
                        });
                    }
                    // configurable shadowing a constant item-style (outside of a function body)
                    (
                        constant_ident,
                        ConstantDecl { .. },
                        _,
                        _,
                        ConfigurableDecl { .. },
                        ConstShadowingMode::ItemStyle,
                        _,
                    ) => {
                        handler.emit_err(CompileError::ConstantDuplicatesConstantOrConfigurable {
                            existing_constant_or_configurable: "Constant",
                            new_constant_or_configurable: "Configurable",
                            name: (&name).into(),
                            existing_span: constant_ident.span(),
                        });
                    }
                    // type or type alias shadowing another type or type alias
                    // trait/abi shadowing another trait/abi
                    // type or type alias shadowing a trait/abi, or vice versa
                    (
                        _,
                        StructDecl { .. }
                        | EnumDecl { .. }
                        | TypeAliasDecl { .. }
                        | TraitDecl { .. }
                        | AbiDecl { .. },
                        _,
                        _,
                        StructDecl { .. }
                        | EnumDecl { .. }
                        | TypeAliasDecl { .. }
                        | TraitDecl { .. }
                        | AbiDecl { .. },
                        _,
                        _,
                    ) => {
                        handler.emit_err(CompileError::MultipleDefinitionsOfName {
                            name: name.clone(),
                            span: name.span(),
                        });
                    }
                    // generic parameter shadowing another generic parameter
                    (
                        _,
                        GenericTypeForFunctionScope { .. },
                        _,
                        _,
                        GenericTypeForFunctionScope { .. },
                        _,
                        GenericShadowingMode::Disallow,
                    ) => {
                        handler.emit_err(CompileError::GenericShadowsGeneric {
                            name: (&name).into(),
                        });
                    }
                    _ => {}
                }
            };

        let append_shadowing_error =
            |ident: &Ident,
             decl: &ResolvedDeclaration,
             is_use: bool,
             is_alias: bool,
             item: &ResolvedDeclaration,
             const_shadowing_mode: ConstShadowingMode| {
                if const_shadowing_mode == ConstShadowingMode::Allow {
                    return;
                }
                match (decl, item) {
                    // TODO: Do not handle any shadowing errors while handling parsed declarations yet,
                    // or else we will emit errors in a different order from the source code order.
                    // Update this once the full AST resolving pass is in.
                    (ResolvedDeclaration::Typed(_decl), ResolvedDeclaration::Parsed(_item)) => {}
                    (ResolvedDeclaration::Parsed(_decl), ResolvedDeclaration::Parsed(_item)) => {}
                    (ResolvedDeclaration::Typed(decl), ResolvedDeclaration::Typed(item)) => {
                        append_shadowing_error_typed(
                            ident,
                            decl,
                            is_use,
                            is_alias,
                            item,
                            const_shadowing_mode,
                        )
                    }
                    _ => unreachable!(),
                }
            };

        let _ = module.walk_scope_chain_early_return(|lexical_scope| {
            if let Some((ident, decl)) = lexical_scope.items.symbols.get_key_value(&name) {
                append_shadowing_error(
                    ident,
                    decl,
                    false,
                    false,
                    &item.clone(),
                    const_shadowing_mode,
                );
            }

            if let Some((ident, (imported_ident, _, decl, _))) =
                lexical_scope.items.use_item_synonyms.get_key_value(&name)
            {
                append_shadowing_error(
                    ident,
                    decl,
                    true,
                    imported_ident.is_some(),
                    &item,
                    const_shadowing_mode,
                );
            }
            Ok(None::<()>)
        });

        if collecting_unifications {
            module
                .current_items_mut()
                .symbols_unique_while_collecting_unifications
                .write()
                .insert(name.clone().into(), item.clone());
        }

        module.current_items_mut().symbols.insert(name, item);

        Ok(())
    }

    // Add a new binding into use_glob_synonyms. The symbol may already be bound by an earlier
    // insertion, in which case the new binding is added as well so that multiple bindings exist.
    //
    // There are a few edge cases were a new binding will replace an old binding. These edge cases
    // are a consequence of the prelude reexports not being implemented properly. See comments in
    // the code for details.
    pub(crate) fn insert_glob_use_symbol(
        &mut self,
        engines: &Engines,
        symbol: Ident,
        src_path: ModulePathBuf,
        decl: &ResolvedDeclaration,
        visibility: Visibility,
    ) {
        if let Some(cur_decls) = self.use_glob_synonyms.get_mut(&symbol) {
            // Name already bound. Check if the decl is already imported
            let ctx = PartialEqWithEnginesContext::new(engines);
            match cur_decls
                .iter()
                .position(|(_cur_path, cur_decl, _cur_visibility)| cur_decl.eq(decl, &ctx))
            {
                Some(index) if matches!(visibility, Visibility::Public) => {
                    // The name is already bound to this decl. If the new symbol is more visible
                    // than the old one, then replace the old one.
                    cur_decls[index] = (src_path.to_vec(), decl.clone(), visibility);
                }
                Some(_) => {
                    // Same binding as the existing one. Do nothing.
                }
                None => {
                    // New decl for this name. Add it to the end
                    cur_decls.push((src_path.to_vec(), decl.clone(), visibility));
                }
            }
        } else {
            let new_vec = vec![(src_path.to_vec(), decl.clone(), visibility)];
            self.use_glob_synonyms.insert(symbol, new_vec);
        }
    }

    pub(crate) fn check_symbol(&self, name: &Ident) -> Result<ResolvedDeclaration, CompileError> {
        self.symbols
            .get(name)
            .cloned()
            .ok_or_else(|| CompileError::SymbolNotFound {
                name: name.clone(),
                span: name.span(),
            })
    }

    pub(crate) fn check_symbols_unique_while_collecting_unifications(
        &self,
        name: &Ident,
    ) -> Result<ResolvedDeclaration, CompileError> {
        self.symbols_unique_while_collecting_unifications
            .read()
            .get(&name.into())
            .cloned()
            .ok_or_else(|| CompileError::SymbolNotFound {
                name: name.clone(),
                span: name.span(),
            })
    }

    pub(crate) fn clear_symbols_unique_while_collecting_unifications(&self) {
        self.symbols_unique_while_collecting_unifications
            .write()
            .clear();
    }

    pub(crate) fn has_storage_declared(&self) -> bool {
        self.declared_storage.is_some()
    }

    pub fn get_declared_storage(&self, decl_engine: &DeclEngine) -> Option<TyStorageDecl> {
        self.declared_storage
            .as_ref()
            .map(|decl_ref| (*decl_engine.get_storage(decl_ref)).clone())
    }

    pub(crate) fn get_storage_field_descriptors(
        &self,
        handler: &Handler,
        decl_engine: &DeclEngine,
    ) -> Result<Vec<ty::TyStorageField>, ErrorEmitted> {
        match self.get_declared_storage(decl_engine) {
            Some(storage) => Ok(storage.fields.clone()),
            None => {
                let msg = "unknown source location";
                let span = Span::new(Arc::from(msg), 0, msg.len(), None).unwrap();
                Err(handler.emit_err(CompileError::NoDeclaredStorage { span }))
            }
        }
    }
}

pub(super) fn get_path_for_decl(
    path: &[sway_types::BaseIdent],
    decl: &ResolvedDeclaration,
    engines: &Engines,
    package_name: &Ident,
) -> Vec<String> {
    // Do not report the package name as part of the error if the path is in the current package.
    let skip_package_name = path[0] == *package_name;
    let mut path_names = path
        .iter()
        .skip(if skip_package_name { 1 } else { 0 })
        .map(|x| x.to_string())
        .collect::<Vec<_>>();
    match decl {
        ResolvedDeclaration::Parsed(decl) => {
            if let Declaration::EnumVariantDeclaration(decl) = decl {
                let enum_decl = engines.pe().get_enum(&decl.enum_ref);
                path_names.push(enum_decl.name().to_string())
            };
        }
        ResolvedDeclaration::Typed(decl) => {
            if let TyDecl::EnumVariantDecl(ty::EnumVariantDecl { enum_ref, .. }) = decl {
                path_names.push(enum_ref.name().to_string())
            };
        }
    }
    path_names
}