cairo-lang-project 2.17.0

//! Cairo project specification. For example, crates and flags used for compilation.
#[cfg(test)]
mod test;

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

use cairo_lang_filesystem::db::{CrateIdentifier, CrateSettings};
use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
use serde::{Deserialize, Serialize};

#[derive(thiserror::Error, Debug)]
pub enum DeserializationError {
    #[error(transparent)]
    TomlError(#[from] toml::de::Error),
    #[error(transparent)]
    IoError(#[from] std::io::Error),
    #[error("PathError")]
    PathError,
}
pub const PROJECT_FILE_NAME: &str = "cairo_project.toml";

/// Cairo project config, including its file content and metadata about the file.
/// This file is expected to be at a root of a crate and specify the crate name and location
/// of its dependency crates.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ProjectConfig {
    pub base_path: PathBuf,
    pub content: ProjectConfigContent,
}

/// Contents of a Cairo project config file.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ProjectConfigContent {
    pub crate_roots: OrderedHashMap<CrateIdentifier, PathBuf>,
    /// Additional configurations for the crates.
    #[serde(default)]
    #[serde(rename = "config")]
    pub crates_config: AllCratesConfig,
}

/// Additional configurations for all crates.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct AllCratesConfig {
    /// The configuration for non overridden crates.
    #[serde(default)]
    pub global: CrateSettings,
    /// Configuration override per crate.
    #[serde(default)]
    #[serde(rename = "override")]
    pub override_map: OrderedHashMap<CrateIdentifier, CrateSettings>,
}

impl AllCratesConfig {
    /// Returns the configuration for the given crate.
    pub fn get(&self, crate_identifier: &CrateIdentifier) -> &CrateSettings {
        self.override_map.get(crate_identifier).unwrap_or(&self.global)
    }
}

impl ProjectConfig {
    pub fn from_directory(directory: &Path) -> Result<Self, DeserializationError> {
        Self::from_file(&directory.join(PROJECT_FILE_NAME))
    }
    pub fn from_file(filename: &Path) -> Result<Self, DeserializationError> {
        let base_path = filename
            .parent()
            .and_then(|p| p.to_str())
            .ok_or(DeserializationError::PathError)?
            .into();
        let content = toml::from_str(&std::fs::read_to_string(filename)?)?;
        Ok(ProjectConfig { base_path, content })
    }

    /// Returns the crate root's absolute path, according to the base path of this project.
    pub fn absolute_crate_root(&self, root: &Path) -> PathBuf {
        if root.is_relative() { self.base_path.join(root) } else { root.to_owned() }
    }
}