erg/crates/erg_compiler/module/graph.rs

use std::fmt;
use std::path::{Path, PathBuf};

use erg_common::pathutil::NormalizedPathBuf;
use erg_common::set;
use erg_common::set::Set;
use erg_common::shared::{MappedRwLockReadGuard, RwLockReadGuard, Shared};
use erg_common::tsort::{tsort, Graph, Node, TopoSortError};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum IncRefError {
    CycleDetected,
}

impl IncRefError {
    pub const fn is_cycle_detected(&self) -> bool {
        matches!(self, Self::CycleDetected)
    }
}

#[derive(Debug, Clone, Default)]
pub struct ModuleGraph(Graph<NormalizedPathBuf, ()>);

impl fmt::Display for ModuleGraph {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "ModuleGraph {{")?;
        for node in self.0.iter() {
            writeln!(f, "{} depends on {{", node.id.display())?;
            for dep in node.depends_on.iter() {
                writeln!(f, "{}, ", dep.display())?;
            }
            writeln!(f, "}}, ")?;
        }
        write!(f, "}}")
    }
}

impl IntoIterator for ModuleGraph {
    type Item = Node<NormalizedPathBuf, ()>;
    type IntoIter = std::vec::IntoIter<Self::Item>;

    fn into_iter(self) -> Self::IntoIter {
        self.0.into_iter()
    }
}

impl ModuleGraph {
    pub fn new() -> Self {
        Self(Graph::new())
    }

    pub fn get_node(&self, path: &Path) -> Option<&Node<NormalizedPathBuf, ()>> {
        let path = NormalizedPathBuf::new(path.to_path_buf());
        self.0.iter().find(|n| n.id == path)
    }

    /// if `path` depends on `target`, returns `true`, else `false`.
    /// if `path` not found, returns `false`
    pub fn depends_on(&self, path: &Path, target: &Path) -> bool {
        let path = NormalizedPathBuf::new(path.to_path_buf());
        let target = NormalizedPathBuf::new(target.to_path_buf());
        self.0
            .iter()
            .find(|n| n.id == path)
            .map(|n| n.depends_on.contains(&target))
            .unwrap_or(false)
    }

    pub fn children(&self, path: &Path) -> Set<NormalizedPathBuf> {
        let path = NormalizedPathBuf::new(path.to_path_buf());
        self.0
            .iter()
            .filter(|n| n.depends_on.contains(&path))
            .map(|n| n.id.clone())
            .collect()
    }

    fn parents(&self, path: &Path) -> Option<&Set<NormalizedPathBuf>> {
        let path = NormalizedPathBuf::new(path.to_path_buf());
        self.0.iter().find(|n| n.id == path).map(|n| &n.depends_on)
    }

    /// ```erg
    /// # a.er
    /// b = import "b"
    /// ```
    /// -> a: child, b: parent
    pub fn ancestors(&self, path: &Path) -> Set<NormalizedPathBuf> {
        let mut ancestors = set! {};
        if let Some(parents) = self.parents(path) {
            for parent in parents.iter() {
                ancestors.insert(parent.clone());
                ancestors.extend(self.ancestors(parent));
            }
        }
        ancestors
    }

    pub fn add_node_if_none(&mut self, path: &Path) {
        let path = NormalizedPathBuf::new(path.to_path_buf());
        if self.0.iter().all(|n| n.id != path) {
            let node = Node::new(path, (), set! {});
            self.0.push(node);
        }
    }

    /// returns Err (and do nothing) if this operation makes a cycle
    pub fn inc_ref(&mut self, referrer: &Path, depends_on: PathBuf) -> Result<(), IncRefError> {
        let referrer = NormalizedPathBuf::new(referrer.to_path_buf());
        let depends_on = NormalizedPathBuf::new(depends_on);
        if self.ancestors(&depends_on).contains(&referrer) && referrer != depends_on {
            return Err(IncRefError::CycleDetected);
        }
        if let Some(node) = self.0.iter_mut().find(|n| n.id == referrer) {
            if referrer == depends_on {
                return Ok(());
            }
            node.push_dep(depends_on);
        } else {
            unreachable!("node not found: {}", referrer.display());
        }
        Ok(())
    }

    pub fn iter(&self) -> impl Iterator<Item = &Node<NormalizedPathBuf, ()>> {
        self.0.iter()
    }

    #[allow(clippy::result_unit_err)]
    pub fn sorted(self) -> Result<Self, TopoSortError> {
        tsort(self.0).map(Self)
    }

    #[allow(clippy::result_unit_err)]
    pub fn sort(&mut self) -> Result<(), TopoSortError> {
        *self = std::mem::take(self).sorted()?;
        Ok(())
    }

    /// Do not erase relationships with modules that depend on `path`
    pub fn remove(&mut self, path: &Path) {
        let path = NormalizedPathBuf::new(path.to_path_buf());
        self.0.retain(|n| n.id != path);
    }

    pub fn rename_path(&mut self, old: &Path, new: PathBuf) {
        let old = NormalizedPathBuf::new(old.to_path_buf());
        let new = NormalizedPathBuf::new(new);
        for node in self.0.iter_mut() {
            if node.id == old {
                node.id = new.clone();
            }
            if node.depends_on.contains(&old) {
                node.depends_on.insert(new.clone());
            }
            node.depends_on.retain(|p| *p != old);
        }
    }

    pub fn initialize(&mut self) {
        self.0.clear();
    }
}

#[derive(Debug, Clone, Default)]
pub struct SharedModuleGraph(Shared<ModuleGraph>);

impl fmt::Display for SharedModuleGraph {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0.borrow())
    }
}

impl IntoIterator for SharedModuleGraph {
    type Item = Node<NormalizedPathBuf, ()>;
    type IntoIter = std::vec::IntoIter<Self::Item>;

    fn into_iter(self) -> Self::IntoIter {
        self.0.into_inner().into_iter()
    }
}

impl SharedModuleGraph {
    pub fn new() -> Self {
        Self(Shared::new(ModuleGraph::new()))
    }

    pub fn get_node(
        &self,
        path: &Path,
    ) -> Option<MappedRwLockReadGuard<Node<NormalizedPathBuf, ()>>> {
        if self.0.borrow().get_node(path).is_some() {
            Some(RwLockReadGuard::map(self.0.borrow(), |graph| {
                graph.get_node(path).unwrap()
            }))
        } else {
            None
        }
    }

    pub fn depends_on(&self, path: &Path, target: &Path) -> bool {
        self.0.borrow().depends_on(path, target)
    }

    pub fn children(&self, path: &Path) -> Set<NormalizedPathBuf> {
        self.0.borrow().children(path)
    }

    pub fn ancestors(&self, path: &Path) -> Set<NormalizedPathBuf> {
        self.0.borrow().ancestors(path)
    }

    pub fn add_node_if_none(&self, path: &Path) {
        self.0.borrow_mut().add_node_if_none(path);
    }

    pub fn inc_ref(&self, referrer: &Path, depends_on: PathBuf) -> Result<(), IncRefError> {
        self.0.borrow_mut().inc_ref(referrer, depends_on)
    }

    pub fn ref_inner(&self) -> RwLockReadGuard<ModuleGraph> {
        self.0.borrow()
    }

    pub fn remove(&self, path: &Path) {
        self.0.borrow_mut().remove(path);
    }

    pub fn rename_path(&self, old: &Path, new: PathBuf) {
        self.0.borrow_mut().rename_path(old, new);
    }

    #[allow(clippy::result_unit_err)]
    pub fn sort(&self) -> Result<(), TopoSortError> {
        self.0.borrow_mut().sort()
    }

    pub fn initialize(&self) {
        self.0.borrow_mut().initialize();
    }
}