erg/crates/erg_compiler/build_hir.rs

use erg_common::config::ErgConfig;
use erg_common::dict::Dict;
use erg_common::error::{ErrorDisplay, ErrorKind, MultiErrorDisplay};
use erg_common::traits::BlockKind;
use erg_common::traits::{ExitStatus, New, Runnable, Stream};
use erg_common::Str;

use erg_parser::ast::{VarName, AST};
use erg_parser::build_ast::{ASTBuildable, ASTBuilder as DefaultASTBuilder};
use erg_parser::ParserRunner;

use crate::artifact::{BuildRunnable, Buildable, CompleteArtifact, IncompleteArtifact};
use crate::context::{Context, ContextKind, ContextProvider, ModuleContext};
use crate::effectcheck::SideEffectChecker;
use crate::error::{CompileError, CompileErrors, LowerWarnings};
use crate::link_hir::HIRLinker;
use crate::lower::GenericASTLowerer;
use crate::module::SharedCompilerResource;
use crate::ownercheck::OwnershipChecker;
use crate::ty::VisibilityModifier;
use crate::varinfo::VarInfo;

/// Summarize lowering, side-effect checking, and ownership checking
///
/// NOTE: This does not perform dependency resolution, use `PackageBuilder` to build a package
#[derive(Debug)]
pub struct GenericHIRBuilder<ASTBuilder: ASTBuildable = DefaultASTBuilder> {
    pub(crate) lowerer: GenericASTLowerer<ASTBuilder>,
    ownership_checker: OwnershipChecker,
}

pub type HIRBuilder = GenericHIRBuilder<DefaultASTBuilder>;

impl<ASTBuilder: ASTBuildable> Default for GenericHIRBuilder<ASTBuilder> {
    fn default() -> Self {
        GenericHIRBuilder::new(ErgConfig::default())
    }
}

impl<A: ASTBuildable> New for GenericHIRBuilder<A> {
    fn new(cfg: ErgConfig) -> Self {
        GenericHIRBuilder::new_with_cache(
            cfg.copy(),
            Str::ever("<module>"),
            SharedCompilerResource::new(cfg),
        )
    }
}

impl<ASTBuilder: ASTBuildable> Runnable for GenericHIRBuilder<ASTBuilder> {
    type Err = CompileError;
    type Errs = CompileErrors;
    const NAME: &'static str = "Erg HIR builder";

    #[inline]
    fn cfg(&self) -> &ErgConfig {
        self.lowerer.cfg()
    }
    #[inline]
    fn cfg_mut(&mut self) -> &mut ErgConfig {
        self.lowerer.cfg_mut()
    }

    #[inline]
    fn finish(&mut self) {}

    fn initialize(&mut self) {
        self.lowerer.initialize();
        self.ownership_checker = OwnershipChecker::new(self.cfg().copy());
    }

    fn clear(&mut self) {
        self.lowerer.clear();
        // don't initialize the ownership checker
    }

    fn set_input(&mut self, input: erg_common::io::Input) {
        self.lowerer.set_input(input);
    }

    fn exec(&mut self) -> Result<ExitStatus, Self::Errs> {
        let mut builder = ASTBuilder::new(self.cfg().copy());
        let artifact = builder
            .build_ast(self.cfg_mut().input.read())
            .map_err(|arti| arti.errors)?;
        artifact.warns.write_all_stderr();
        let artifact = self
            .check(artifact.ast, "exec")
            .map_err(|arti| arti.errors)?;
        artifact.warns.write_all_stderr();
        println!("{}", artifact.object);
        Ok(ExitStatus::compile_passed(artifact.warns.len()))
    }

    fn eval(&mut self, src: String) -> Result<String, Self::Errs> {
        let mut builder = ASTBuilder::new(self.cfg().copy());
        let artifact = builder.build_ast(src).map_err(|arti| arti.errors)?;
        artifact.warns.write_all_stderr();
        let artifact = self
            .check(artifact.ast, "eval")
            .map_err(|arti| arti.errors)?;
        artifact.warns.write_all_stderr();
        Ok(artifact.object.to_string())
    }

    fn expect_block(&self, src: &str) -> BlockKind {
        let mut parser = ParserRunner::new(self.cfg().clone());
        match parser.eval(src.to_string()) {
            Err(errs) => {
                let kind = errs
                    .iter()
                    .filter(|e| e.core().kind == ErrorKind::ExpectNextLine)
                    .map(|e| {
                        let msg = e.core().sub_messages.last().unwrap();
                        // ExpectNextLine error must have msg otherwise it's a bug
                        msg.get_msg().first().unwrap().to_owned()
                    })
                    .next();
                if let Some(kind) = kind {
                    return BlockKind::from(kind.as_str());
                }
                if errs
                    .iter()
                    .any(|err| err.core.main_message.contains("\"\"\""))
                {
                    return BlockKind::MultiLineStr;
                }
                BlockKind::Error
            }
            Ok(_) => {
                if src.contains("Class") {
                    return BlockKind::ClassDef;
                }
                BlockKind::None
            }
        }
    }
}

impl<ASTBuilder: ASTBuildable> Buildable for GenericHIRBuilder<ASTBuilder> {
    fn inherit(cfg: ErgConfig, shared: SharedCompilerResource) -> Self {
        let mod_name = Str::from(cfg.input.file_stem());
        Self::new_with_cache(cfg, mod_name, shared)
    }
    fn inherit_with_name(cfg: ErgConfig, mod_name: Str, shared: SharedCompilerResource) -> Self {
        Self::new_with_cache(cfg, mod_name, shared)
    }
    fn build(&mut self, src: String, mode: &str) -> Result<CompleteArtifact, IncompleteArtifact> {
        self.build(src, mode)
    }
    fn build_from_ast(
        &mut self,
        ast: AST,
        mode: &str,
    ) -> Result<CompleteArtifact<crate::hir::HIR>, IncompleteArtifact<crate::hir::HIR>> {
        self.check(ast, mode)
    }
    fn pop_context(&mut self) -> Option<ModuleContext> {
        self.pop_mod_ctx()
    }
    fn get_context(&self) -> Option<&ModuleContext> {
        Some(&self.lowerer.module)
    }
}

impl<ASTBuilder: ASTBuildable + 'static> BuildRunnable for GenericHIRBuilder<ASTBuilder> {}

impl<ASTBuilder: ASTBuildable> ContextProvider for GenericHIRBuilder<ASTBuilder> {
    fn dir(&self) -> Dict<&VarName, &VarInfo> {
        self.lowerer.dir()
    }

    fn get_receiver_ctx(&self, receiver_name: &str) -> Option<&Context> {
        self.lowerer.get_receiver_ctx(receiver_name)
    }

    fn get_var_info(&self, name: &str) -> Option<(&VarName, &VarInfo)> {
        self.lowerer.get_var_info(name)
    }
}

impl<ASTBuilder: ASTBuildable> GenericHIRBuilder<ASTBuilder> {
    pub fn new(cfg: ErgConfig) -> Self {
        New::new(cfg)
    }

    pub fn new_with_cache<S: Into<Str>>(
        cfg: ErgConfig,
        mod_name: S,
        shared: SharedCompilerResource,
    ) -> Self {
        Self {
            lowerer: GenericASTLowerer::new_with_cache(cfg.copy(), mod_name, shared),
            ownership_checker: OwnershipChecker::new(cfg),
        }
    }

    pub fn new_with_ctx(mut mod_ctx: ModuleContext) -> Self {
        mod_ctx.context.grow(
            "<module>",
            ContextKind::Module,
            VisibilityModifier::Private,
            None,
        );
        Self {
            ownership_checker: OwnershipChecker::new(mod_ctx.get_top_cfg()),
            lowerer: GenericASTLowerer::new_with_ctx(mod_ctx),
        }
    }

    pub fn new_submodule(mut mod_ctx: ModuleContext, name: &str) -> Self {
        mod_ctx
            .context
            .grow(name, ContextKind::Module, VisibilityModifier::Private, None);
        Self {
            ownership_checker: OwnershipChecker::new(mod_ctx.get_top_cfg()),
            lowerer: GenericASTLowerer::new_with_ctx(mod_ctx),
        }
    }

    pub fn check(&mut self, ast: AST, mode: &str) -> Result<CompleteArtifact, IncompleteArtifact> {
        let mut artifact = self.lowerer.lower(ast, mode)?;
        let ctx = &self.lowerer.get_context().unwrap().context;
        let effect_checker = SideEffectChecker::new(self.cfg().clone(), ctx);
        let hir = if self.cfg().effect_check {
            effect_checker
                .check(artifact.object, self.lowerer.module.context.name.clone())
                .map_err(|(hir, errs)| {
                    self.lowerer.module.context.clear_invalid_vars();
                    IncompleteArtifact::new(Some(hir), errs, artifact.warns.take_all().into())
                })?
        } else {
            artifact.object
        };
        let hir = if self.cfg().ownership_check {
            self.ownership_checker.check(hir).map_err(|(hir, errs)| {
                self.lowerer.module.context.clear_invalid_vars();
                IncompleteArtifact::new(Some(hir), errs, artifact.warns.take_all().into())
            })?
        } else {
            hir
        };
        Ok(CompleteArtifact::new(hir, artifact.warns))
    }

    pub fn build(
        &mut self,
        src: String,
        mode: &str,
    ) -> Result<CompleteArtifact, IncompleteArtifact> {
        let mut ast_builder = ASTBuilder::new(self.cfg().copy());
        let artifact = ast_builder
            .build_ast(src)
            .map_err(|iart| IncompleteArtifact::new(None, iart.errors.into(), iart.warns.into()))?;
        self.lowerer
            .warns
            .extend(LowerWarnings::from(artifact.warns));
        self.check(artifact.ast, mode)
    }

    pub fn build_module(&mut self) -> Result<CompleteArtifact, IncompleteArtifact> {
        let src = self.cfg_mut().input.read();
        self.build(src, "exec")
    }

    pub fn build_linked_module(&mut self) -> Result<CompleteArtifact, IncompleteArtifact> {
        let artifact = self.build_module()?;
        let linker = HIRLinker::new(self.cfg(), self.lowerer.module.context.mod_cache());
        let hir = linker.link(artifact.object);
        Ok(CompleteArtifact::new(hir, artifact.warns))
    }

    pub fn pop_mod_ctx(&mut self) -> Option<ModuleContext> {
        self.lowerer.pop_mod_ctx()
    }

    pub fn dir(&mut self) -> Dict<&VarName, &VarInfo> {
        ContextProvider::dir(self)
    }

    pub fn get_receiver_ctx(&self, receiver_name: &str) -> Option<&Context> {
        ContextProvider::get_receiver_ctx(self, receiver_name)
    }

    pub fn get_var_info(&self, name: &str) -> Option<(&VarName, &VarInfo)> {
        ContextProvider::get_var_info(self, name)
    }

    pub fn current_ctx(&self) -> &Context {
        &self.lowerer.module.context
    }

    pub fn clear(&mut self) {
        Runnable::clear(self);
    }
}