foundry_compilers/

config.rs

use crate::{
    cache::SOLIDITY_FILES_CACHE_FILENAME,
    compilers::{multi::MultiCompilerLanguage, Language},
    flatten::{collect_ordered_deps, combine_version_pragmas},
    resolver::{parse::SolParser, SolImportAlias},
    Graph,
};
use foundry_compilers_artifacts::{
    output_selection::ContractOutputSelection,
    remappings::Remapping,
    sources::{Source, Sources},
    Libraries, Settings, SolcLanguage,
};
use foundry_compilers_core::{
    error::{Result, SolcError, SolcIoError},
    utils::{self, strip_prefix_owned},
};
use serde::{Deserialize, Serialize};
use std::{
    collections::BTreeSet,
    fmt::{self, Formatter},
    fs,
    marker::PhantomData,
    path::{Component, Path, PathBuf},
};

/// Where to find all files or where to write them
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ProjectPathsConfig<L = MultiCompilerLanguage> {
    /// Project root
    pub root: PathBuf,
    /// Path to the cache, if any
    pub cache: PathBuf,
    /// Where to store build artifacts
    pub artifacts: PathBuf,
    /// Where to store the build info files
    pub build_infos: PathBuf,
    /// Where to find sources
    pub sources: PathBuf,
    /// Where to find tests
    pub tests: PathBuf,
    /// Where to find scripts
    pub scripts: PathBuf,
    /// Where to look for libraries
    pub libraries: Vec<PathBuf>,
    /// The compiler remappings
    pub remappings: Vec<Remapping>,
    /// Paths to use for solc's `--include-path`
    pub include_paths: BTreeSet<PathBuf>,
    /// The paths which will be allowed for library inclusion
    pub allowed_paths: BTreeSet<PathBuf>,

    pub _l: PhantomData<L>,
}

impl ProjectPathsConfig {
    pub fn builder() -> ProjectPathsConfigBuilder {
        ProjectPathsConfigBuilder::default()
    }

    /// Attempts to autodetect the artifacts directory based on the given root path
    ///
    /// Dapptools layout takes precedence over hardhat style.
    /// This will return:
    ///   - `<root>/out` if it exists or `<root>/artifacts` does not exist,
    ///   - `<root>/artifacts` if it exists and `<root>/out` does not exist.
    pub fn find_artifacts_dir(root: &Path) -> PathBuf {
        utils::find_fave_or_alt_path(root, "out", "artifacts")
    }

    /// Attempts to autodetect the source directory based on the given root path
    ///
    /// Dapptools layout takes precedence over hardhat style.
    /// This will return:
    ///   - `<root>/src` if it exists or `<root>/contracts` does not exist,
    ///   - `<root>/contracts` if it exists and `<root>/src` does not exist.
    pub fn find_source_dir(root: &Path) -> PathBuf {
        utils::find_fave_or_alt_path(root, "src", "contracts")
    }

    /// Attempts to autodetect the lib directory based on the given root path
    ///
    /// Dapptools layout takes precedence over hardhat style.
    /// This will return:
    ///   - `<root>/lib` if it exists or `<root>/node_modules` does not exist,
    ///   - `<root>/node_modules` if it exists and `<root>/lib` does not exist.
    pub fn find_libs(root: &Path) -> Vec<PathBuf> {
        vec![utils::find_fave_or_alt_path(root, "lib", "node_modules")]
    }
}

impl ProjectPathsConfig<SolcLanguage> {
    /// Flattens the target solidity file into a single string suitable for verification.
    ///
    /// This method uses a dependency graph to resolve imported files and substitute
    /// import directives with the contents of target files. It will strip the pragma
    /// version directives and SDPX license identifiers from all imported files.
    ///
    /// NB: the SDPX license identifier will be removed from the imported file
    /// only if it is found at the beginning of the file.
    pub fn flatten(&self, target: &Path) -> Result<String> {
        trace!("flattening file");
        let mut input_files = self.input_files();

        // we need to ensure that the target is part of the input set, otherwise it's not
        // part of the graph if it's not imported by any input file
        let flatten_target = target.to_path_buf();
        if !input_files.contains(&flatten_target) {
            input_files.push(flatten_target.clone());
        }

        let sources = Source::read_all_files(input_files)?;
        let graph = Graph::<SolParser>::resolve_sources(self, sources)?;
        let ordered_deps = collect_ordered_deps(&flatten_target, self, &graph)?;

        #[cfg(windows)]
        let ordered_deps = {
            use path_slash::PathBufExt;

            let mut deps = ordered_deps;
            for p in &mut deps {
                *p = PathBuf::from(p.to_slash_lossy().to_string());
            }
            deps
        };

        let mut sources = Vec::new();
        let mut experimental_pragma = None;
        let mut version_pragmas = Vec::new();

        let mut result = String::new();

        for path in ordered_deps.iter() {
            let node_id = *graph.files().get(path).ok_or_else(|| {
                SolcError::msg(format!("cannot resolve file at {}", path.display()))
            })?;
            let node = graph.node(node_id);
            node.data.parse_result()?;
            let content = node.content();

            // Firstly we strip all licesnses, verson pragmas
            // We keep target file pragma and license placing them in the beginning of the result.
            let mut ranges_to_remove = Vec::new();

            if let Some(license) = &node.data.license {
                ranges_to_remove.push(license.span());
                if *path == flatten_target {
                    result.push_str(&content[license.span()]);
                    result.push('\n');
                }
            }
            if let Some(version) = &node.data.version {
                let content = &content[version.span()];
                ranges_to_remove.push(version.span());
                version_pragmas.push(content);
            }
            if let Some(experimental) = &node.data.experimental {
                ranges_to_remove.push(experimental.span());
                if experimental_pragma.is_none() {
                    experimental_pragma = Some(content[experimental.span()].to_owned());
                }
            }
            for import in &node.data.imports {
                ranges_to_remove.push(import.span());
            }
            ranges_to_remove.sort_by_key(|loc| loc.start);

            let mut content = content.as_bytes().to_vec();
            let mut offset = 0_isize;

            for range in ranges_to_remove {
                let repl_range = utils::range_by_offset(&range, offset);
                offset -= repl_range.len() as isize;
                content.splice(repl_range, std::iter::empty());
            }

            let mut content = String::from_utf8(content).map_err(|err| {
                SolcError::msg(format!("failed to convert extended bytes to string: {err}"))
            })?;

            // Iterate over all aliased imports, and replace alias with real name via regexes
            for alias in node.data.imports.iter().flat_map(|i| i.data().aliases()) {
                let (alias, target) = match alias {
                    SolImportAlias::Contract(alias, target) => (alias.clone(), target.clone()),
                    _ => continue,
                };
                let name_regex = utils::create_contract_or_lib_name_regex(&alias);
                let target_len = target.len() as isize;
                let mut replace_offset = 0;
                for cap in name_regex.captures_iter(&content.clone()) {
                    if cap.name("ignore").is_some() {
                        continue;
                    }
                    if let Some(name_match) =
                        ["n1", "n2", "n3"].iter().find_map(|name| cap.name(name))
                    {
                        let name_match_range =
                            utils::range_by_offset(&name_match.range(), replace_offset);
                        replace_offset += target_len - (name_match_range.len() as isize);
                        content.replace_range(name_match_range, &target);
                    }
                }
            }

            let content = format!(
                "// {}\n{}",
                path.strip_prefix(&self.root).unwrap_or(path).display(),
                content
            );

            sources.push(content);
        }

        if let Some(version) = combine_version_pragmas(&version_pragmas) {
            result.push_str(&version);
            result.push('\n');
        }
        if let Some(experimental) = experimental_pragma {
            result.push_str(&experimental);
            result.push('\n');
        }

        for source in sources {
            result.push_str("\n\n");
            result.push_str(&source);
        }

        Ok(format!("{}\n", utils::RE_THREE_OR_MORE_NEWLINES.replace_all(&result, "\n\n").trim()))
    }
}

impl<L> ProjectPathsConfig<L> {
    /// Creates a new hardhat style config instance which points to the canonicalized root path
    pub fn hardhat(root: &Path) -> Result<Self> {
        PathStyle::HardHat.paths(root)
    }

    /// Creates a new dapptools style config instance which points to the canonicalized root path
    pub fn dapptools(root: &Path) -> Result<Self> {
        PathStyle::Dapptools.paths(root)
    }

    /// Creates a new config with the current directory as the root
    pub fn current_hardhat() -> Result<Self> {
        Self::hardhat(&std::env::current_dir().map_err(|err| SolcError::io(err, "."))?)
    }

    /// Creates a new config with the current directory as the root
    pub fn current_dapptools() -> Result<Self> {
        Self::dapptools(&std::env::current_dir().map_err(|err| SolcError::io(err, "."))?)
    }

    /// Returns true if the given path is a test or script file.
    pub fn is_test_or_script(&self, path: &Path) -> bool {
        self.is_test(path) || self.is_script(path)
    }

    /// Returns true if the given path is a test file.
    pub fn is_test(&self, path: &Path) -> bool {
        path_starts_with_rooted(path, &self.tests, &self.root)
    }

    /// Returns true if the given path is a script file.
    pub fn is_script(&self, path: &Path) -> bool {
        path_starts_with_rooted(path, &self.scripts, &self.root)
    }

    /// Returns true if the given path is a test or script file.
    pub fn is_source_file(&self, path: &Path) -> bool {
        !self.is_test_or_script(path)
    }

    /// Returns a new [ProjectPaths] instance that contains all directories configured for this
    /// project
    pub fn paths(&self) -> ProjectPaths {
        ProjectPaths {
            artifacts: self.artifacts.clone(),
            build_infos: self.build_infos.clone(),
            sources: self.sources.clone(),
            tests: self.tests.clone(),
            scripts: self.scripts.clone(),
            libraries: self.libraries.iter().cloned().collect(),
        }
    }

    /// Same as [`paths`][ProjectPathsConfig::paths] but strips the `root` form all paths.
    ///
    /// See: [`ProjectPaths::strip_prefix_all`]
    pub fn paths_relative(&self) -> ProjectPaths {
        let mut paths = self.paths();
        paths.strip_prefix_all(&self.root);
        paths
    }

    /// Creates all configured dirs and files
    pub fn create_all(&self) -> std::result::Result<(), SolcIoError> {
        if let Some(parent) = self.cache.parent() {
            fs::create_dir_all(parent).map_err(|err| SolcIoError::new(err, parent))?;
        }
        fs::create_dir_all(&self.artifacts)
            .map_err(|err| SolcIoError::new(err, &self.artifacts))?;
        fs::create_dir_all(&self.sources).map_err(|err| SolcIoError::new(err, &self.sources))?;
        fs::create_dir_all(&self.tests).map_err(|err| SolcIoError::new(err, &self.tests))?;
        fs::create_dir_all(&self.scripts).map_err(|err| SolcIoError::new(err, &self.scripts))?;
        for lib in &self.libraries {
            fs::create_dir_all(lib).map_err(|err| SolcIoError::new(err, lib))?;
        }
        Ok(())
    }

    /// Converts all `\\` separators in _all_ paths to `/`
    pub fn slash_paths(&mut self) {
        #[cfg(windows)]
        {
            use path_slash::PathBufExt;

            let slashed = |p: &mut PathBuf| {
                *p = p.to_slash_lossy().as_ref().into();
            };
            slashed(&mut self.root);
            slashed(&mut self.cache);
            slashed(&mut self.artifacts);
            slashed(&mut self.build_infos);
            slashed(&mut self.sources);
            slashed(&mut self.tests);
            slashed(&mut self.scripts);

            self.libraries.iter_mut().for_each(slashed);
            self.remappings.iter_mut().for_each(Remapping::slash_path);

            self.include_paths = std::mem::take(&mut self.include_paths)
                .into_iter()
                .map(|mut p| {
                    slashed(&mut p);
                    p
                })
                .collect();
            self.allowed_paths = std::mem::take(&mut self.allowed_paths)
                .into_iter()
                .map(|mut p| {
                    slashed(&mut p);
                    p
                })
                .collect();
        }
    }

    /// Returns true if the `file` belongs to a `library`, See [`Self::find_library_ancestor()`]
    pub fn has_library_ancestor(&self, file: &Path) -> bool {
        self.find_library_ancestor(file).is_some()
    }

    /// Returns the library the file belongs to
    ///
    /// Returns the first library that is an ancestor of the given `file`.
    ///
    /// **Note:** this does not resolve remappings [`Self::resolve_import()`], instead this merely
    /// checks if a `library` is a parent of `file`
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use foundry_compilers::ProjectPathsConfig;
    /// use std::path::Path;
    ///
    /// let config: ProjectPathsConfig = ProjectPathsConfig::builder().lib("lib").build()?;
    /// assert_eq!(
    ///     config.find_library_ancestor("lib/src/Greeter.sol".as_ref()),
    ///     Some(Path::new("lib"))
    /// );
    /// Ok::<_, Box<dyn std::error::Error>>(())
    /// ```
    pub fn find_library_ancestor(&self, file: &Path) -> Option<&Path> {
        for lib in &self.libraries {
            if lib.is_relative()
                && file.is_absolute()
                && file.starts_with(&self.root)
                && file.starts_with(self.root.join(lib))
                || file.is_relative()
                    && lib.is_absolute()
                    && lib.starts_with(&self.root)
                    && self.root.join(file).starts_with(lib)
            {
                return Some(lib);
            }
            if file.starts_with(lib) {
                return Some(lib);
            }
        }

        None
    }

    /// Attempts to resolve an `import` from the given working directory.
    ///
    /// The `cwd` path is the parent dir of the file that includes the `import`
    ///
    /// This will also populate the `include_paths` with any nested library root paths that should
    /// be provided to solc via `--include-path` because it uses absolute imports.
    pub fn resolve_import_and_include_paths(
        &self,
        cwd: &Path,
        import: &Path,
        include_paths: &mut BTreeSet<PathBuf>,
    ) -> Result<PathBuf> {
        let component = import
            .components()
            .next()
            .ok_or_else(|| SolcError::msg(format!("Empty import path {}", import.display())))?;

        if component == Component::CurDir || component == Component::ParentDir {
            // if the import is relative we assume it's already part of the processed input
            // file set
            let resolved = utils::normalize_solidity_import_path(cwd, import).map_err(|err| {
                SolcError::msg(format!("failed to resolve relative import \"{err:?}\""))
            })?;
            // Check if the resolved path matches a remapping and should be redirected
            Ok(self.apply_remapping_to_path(cwd, &resolved))
        } else {
            // resolve library file
            let resolved = self.resolve_library_import(cwd.as_ref(), import.as_ref());

            if resolved.is_none() {
                // absolute paths in solidity are a thing for example `import
                // "src/interfaces/IConfig.sol"` which could either point to `cwd +
                // src/interfaces/IConfig.sol`, or make use of a remapping (`src/=....`)
                if let Some(lib) = self.find_library_ancestor(cwd) {
                    if let Some((include_path, import)) =
                        utils::resolve_absolute_library(lib, cwd, import)
                    {
                        // track the path for this absolute import inside a nested library
                        include_paths.insert(include_path);
                        return Ok(import);
                    }
                }
                // also try to resolve absolute imports from the project paths
                for path in [&self.root, &self.sources, &self.tests, &self.scripts] {
                    if cwd.starts_with(path) {
                        if let Ok(import) = utils::normalize_solidity_import_path(path, import) {
                            return Ok(import);
                        }
                    }
                }
            }

            resolved.ok_or_else(|| {
                SolcError::msg(format!(
                    "failed to resolve library import \"{:?}\"",
                    import.display()
                ))
            })
        }
    }

    /// Attempts to resolve an `import` from the given working directory.
    ///
    /// The `cwd` path is the parent dir of the file that includes the `import`
    pub fn resolve_import(&self, cwd: &Path, import: &Path) -> Result<PathBuf> {
        self.resolve_import_and_include_paths(cwd, import, &mut Default::default())
    }

    /// Attempts to find the path to the real solidity file that's imported via the given `import`
    /// path by applying the configured remappings and checking the library dirs
    ///
    /// # Examples
    ///
    /// Following `@aave` dependency in the `lib` folder `node_modules`
    ///
    /// ```text
    /// <root>/node_modules/@aave
    /// ├── aave-token
    /// │   ├── contracts
    /// │   │   ├── open-zeppelin
    /// │   │   ├── token
    /// ├── governance-v2
    ///     ├── contracts
    ///         ├── interfaces
    /// ```
    ///
    /// has this remapping: `@aave/=@aave/` (name:path) so contracts can be imported as
    ///
    /// ```solidity
    /// import "@aave/governance-v2/contracts/governance/Executor.sol";
    /// ```
    ///
    /// So that `Executor.sol` can be found by checking each `lib` folder (`node_modules`) with
    /// applied remappings. Applying remapping works by checking if the import path of an import
    /// statement starts with the name of a remapping and replacing it with the remapping's `path`.
    ///
    /// There are some caveats though, dapptools style remappings usually include the `src` folder
    /// `ds-test/=lib/ds-test/src/` so that imports look like `import "ds-test/test.sol";` (note the
    /// missing `src` in the import path).
    ///
    /// For hardhat/npm style that's not always the case, most notably for [openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) if installed via npm.
    /// The remapping is detected as `'@openzeppelin/=node_modules/@openzeppelin/contracts/'`, which
    /// includes the source directory `contracts`, however it's common to see import paths like:
    ///
    /// `import "@openzeppelin/contracts/token/ERC20/IERC20.sol";`
    ///
    /// instead of
    ///
    /// `import "@openzeppelin/token/ERC20/IERC20.sol";`
    ///
    /// There is no strict rule behind this, but because
    /// [`foundry_compilers_artifacts::remappings::Remapping::find_many`] returns `'@
    /// openzeppelin/=node_modules/@openzeppelin/contracts/'` we should handle the case if the
    /// remapping path ends with `contracts` and the import path starts with `<remapping
    /// name>/contracts`. Otherwise we can end up with a resolved path that has a
    /// duplicate `contracts` segment:
    /// `@openzeppelin/contracts/contracts/token/ERC20/IERC20.sol` we check for this edge case
    /// here so that both styles work out of the box.
    pub fn resolve_library_import(&self, cwd: &Path, import: &Path) -> Option<PathBuf> {
        // if the import path starts with the name of the remapping then we get the resolved path by
        // removing the name and adding the remainder to the path of the remapping
        let cwd = cwd.strip_prefix(&self.root).unwrap_or(cwd);
        if let Some(path) = self
            .remappings
            .iter()
            .filter(|r| {
                // only check remappings that are either global or for `cwd`
                if let Some(ctx) = r.context.as_ref() {
                    cwd.starts_with(ctx)
                } else {
                    true
                }
            })
            .find_map(|r| {
                import.strip_prefix(&r.name).ok().map(|stripped_import| {
                    let lib_path =
                        if stripped_import.as_os_str().is_empty() && r.path.ends_with(".sol") {
                            r.path.clone().into()
                        } else {
                            Path::new(&r.path).join(stripped_import)
                        };

                    // we handle the edge case where the path of a remapping ends with "contracts"
                    // (`<name>/=.../contracts`) and the stripped import also starts with
                    // `contracts`
                    if let Ok(adjusted_import) = stripped_import.strip_prefix("contracts/") {
                        if r.path.ends_with("contracts/") && !self.root.join(&lib_path).exists() {
                            return Path::new(&r.path).join(adjusted_import);
                        }
                    }
                    lib_path
                })
            })
        {
            Some(self.root.join(path))
        } else {
            utils::resolve_library(&self.libraries, import)
        }
    }

    /// Applies remappings to a resolved absolute path.
    ///
    /// When a file is resolved via relative imports, the resulting path might match a remapping
    /// pattern. This method checks if the resolved path (relative to the project root) matches
    /// any remapping and returns the remapped path if so.
    ///
    /// This is important for contract verification where the standard JSON input must use
    /// remapped paths that match what the Solidity compiler expects.
    ///
    /// # Arguments
    /// * `cwd` - The current working directory (parent of the importing file)
    /// * `resolved_path` - The absolute path that was resolved
    ///
    /// # Returns
    /// The remapped path if a matching remapping exists and the target file exists,
    /// otherwise returns the original path.
    pub fn apply_remapping_to_path(&self, cwd: &Path, resolved_path: &Path) -> PathBuf {
        // Get the path relative to root
        let relative_path = match resolved_path.strip_prefix(&self.root) {
            Ok(p) => p,
            Err(_) => return resolved_path.to_path_buf(),
        };

        let cwd_relative = cwd.strip_prefix(&self.root).unwrap_or(cwd);

        // Check if any remapping matches this path
        for r in &self.remappings {
            // Check context
            if let Some(ctx) = r.context.as_ref() {
                if !cwd_relative.starts_with(ctx) {
                    continue;
                }
            }

            // Check if the relative path starts with the remapping name
            if let Ok(stripped) = relative_path.strip_prefix(&r.name) {
                let remapped_relative = Path::new(&r.path).join(stripped);
                let remapped_absolute = self.root.join(&remapped_relative);

                // Only use remapped path if the target file exists
                if remapped_absolute.exists() {
                    return remapped_absolute;
                }
            }
        }

        resolved_path.to_path_buf()
    }

    pub fn with_language_ref<Lang>(&self) -> &ProjectPathsConfig<Lang> {
        // SAFETY: `Lang` is `PhantomData`.
        unsafe { std::mem::transmute(self) }
    }

    pub fn with_language<Lang>(self) -> ProjectPathsConfig<Lang> {
        // SAFETY: `Lang` is `PhantomData`.
        unsafe { std::mem::transmute(self) }
    }

    pub fn apply_lib_remappings(&self, mut libraries: Libraries) -> Libraries {
        libraries.libs = libraries.libs
            .into_iter()
            .map(|(file, target)| {
                let file = self.resolve_import(&self.root, &file).unwrap_or_else(|err| {
                    warn!(target: "libs", "Failed to resolve library `{}` for linking: {:?}", file.display(), err);
                    file
                });
                (file, target)
            })
            .collect();
        libraries
    }
}

impl<L: Language> ProjectPathsConfig<L> {
    /// Returns all sources found under the project's configured `sources` path
    pub fn read_sources(&self) -> Result<Sources> {
        trace!("reading all sources from \"{}\"", self.sources.display());
        Ok(Source::read_all_from(&self.sources, L::FILE_EXTENSIONS)?)
    }

    /// Returns all sources found under the project's configured `test` path
    pub fn read_tests(&self) -> Result<Sources> {
        trace!("reading all tests from \"{}\"", self.tests.display());
        Ok(Source::read_all_from(&self.tests, L::FILE_EXTENSIONS)?)
    }

    /// Returns all sources found under the project's configured `script` path
    pub fn read_scripts(&self) -> Result<Sources> {
        trace!("reading all scripts from \"{}\"", self.scripts.display());
        Ok(Source::read_all_from(&self.scripts, L::FILE_EXTENSIONS)?)
    }

    /// Returns true if the there is at least one solidity file in this config.
    ///
    /// See also, `Self::input_files()`
    pub fn has_input_files(&self) -> bool {
        self.input_files_iter().next().is_some()
    }

    /// Returns an iterator that yields all solidity file paths for `Self::sources`, `Self::tests`
    /// and `Self::scripts`
    pub fn input_files_iter(&self) -> impl Iterator<Item = PathBuf> + '_ {
        utils::source_files_iter(&self.sources, L::FILE_EXTENSIONS)
            .chain(utils::source_files_iter(&self.tests, L::FILE_EXTENSIONS))
            .chain(utils::source_files_iter(&self.scripts, L::FILE_EXTENSIONS))
    }

    /// Returns the combined set solidity file paths for `Self::sources`, `Self::tests` and
    /// `Self::scripts`
    pub fn input_files(&self) -> Vec<PathBuf> {
        self.input_files_iter().collect()
    }

    /// Returns the combined set of `Self::read_sources` + `Self::read_tests` + `Self::read_scripts`
    pub fn read_input_files(&self) -> Result<Sources> {
        Ok(Source::read_all(self.input_files_iter())?)
    }
}

impl fmt::Display for ProjectPathsConfig {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        writeln!(f, "root: {}", self.root.display())?;
        writeln!(f, "contracts: {}", self.sources.display())?;
        writeln!(f, "artifacts: {}", self.artifacts.display())?;
        writeln!(f, "tests: {}", self.tests.display())?;
        writeln!(f, "scripts: {}", self.scripts.display())?;
        writeln!(f, "libs:")?;
        for lib in &self.libraries {
            writeln!(f, "    {}", lib.display())?;
        }
        writeln!(f, "remappings:")?;
        for remapping in &self.remappings {
            writeln!(f, "    {remapping}")?;
        }
        Ok(())
    }
}

/// This is a subset of [ProjectPathsConfig] that contains all relevant folders in the project
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ProjectPaths {
    pub artifacts: PathBuf,
    pub build_infos: PathBuf,
    pub sources: PathBuf,
    pub tests: PathBuf,
    pub scripts: PathBuf,
    pub libraries: BTreeSet<PathBuf>,
}

impl ProjectPaths {
    /// Joins the folders' location with `root`
    pub fn join_all(&mut self, root: &Path) -> &mut Self {
        self.artifacts = root.join(&self.artifacts);
        self.build_infos = root.join(&self.build_infos);
        self.sources = root.join(&self.sources);
        self.tests = root.join(&self.tests);
        self.scripts = root.join(&self.scripts);
        let libraries = std::mem::take(&mut self.libraries);
        self.libraries.extend(libraries.into_iter().map(|p| root.join(p)));
        self
    }

    /// Removes `base` from all folders
    pub fn strip_prefix_all(&mut self, base: &Path) -> &mut Self {
        if let Ok(stripped) = self.artifacts.strip_prefix(base) {
            self.artifacts = stripped.to_path_buf();
        }
        if let Ok(stripped) = self.build_infos.strip_prefix(base) {
            self.build_infos = stripped.to_path_buf();
        }
        if let Ok(stripped) = self.sources.strip_prefix(base) {
            self.sources = stripped.to_path_buf();
        }
        if let Ok(stripped) = self.tests.strip_prefix(base) {
            self.tests = stripped.to_path_buf();
        }
        if let Ok(stripped) = self.scripts.strip_prefix(base) {
            self.scripts = stripped.to_path_buf();
        }
        self.libraries = std::mem::take(&mut self.libraries)
            .into_iter()
            .map(|path| strip_prefix_owned(path, base))
            .collect();
        self
    }

    /// Returns true if the given path is a test or script file.
    pub fn is_test_or_script(&self, path: &Path) -> bool {
        self.is_test(path) || self.is_script(path)
    }

    /// Returns true if the given path is a test file.
    pub fn is_test(&self, path: &Path) -> bool {
        path.starts_with(&self.tests)
    }

    /// Returns true if the given path is a script file.
    pub fn is_script(&self, path: &Path) -> bool {
        path.starts_with(&self.scripts)
    }

    /// Returns true if the given path is a test or script file.
    pub fn is_source_file(&self, path: &Path) -> bool {
        !self.is_test_or_script(path)
    }
}

impl Default for ProjectPaths {
    fn default() -> Self {
        Self {
            artifacts: "out".into(),
            build_infos: ["out", "build-info"].iter().collect::<PathBuf>(),
            sources: "src".into(),
            tests: "test".into(),
            scripts: "script".into(),
            libraries: Default::default(),
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum PathStyle {
    HardHat,
    Dapptools,
}

impl PathStyle {
    /// Convert into a `ProjectPathsConfig` given the root path and based on the styled
    pub fn paths<C>(&self, root: &Path) -> Result<ProjectPathsConfig<C>> {
        let root = utils::canonicalize(root)?;

        Ok(match self {
            Self::Dapptools => ProjectPathsConfig::builder()
                .sources(root.join("src"))
                .artifacts(root.join("out"))
                .build_infos(root.join("out").join("build-info"))
                .lib(root.join("lib"))
                .remappings(Remapping::find_many(&root.join("lib")))
                .root(root)
                .build()?,
            Self::HardHat => ProjectPathsConfig::builder()
                .sources(root.join("contracts"))
                .artifacts(root.join("artifacts"))
                .build_infos(root.join("artifacts").join("build-info"))
                .lib(root.join("node_modules"))
                .root(root)
                .build()?,
        })
    }
}

#[derive(Clone, Debug, Default)]
pub struct ProjectPathsConfigBuilder {
    root: Option<PathBuf>,
    cache: Option<PathBuf>,
    artifacts: Option<PathBuf>,
    build_infos: Option<PathBuf>,
    sources: Option<PathBuf>,
    tests: Option<PathBuf>,
    scripts: Option<PathBuf>,
    libraries: Option<Vec<PathBuf>>,
    remappings: Option<Vec<Remapping>>,
    include_paths: BTreeSet<PathBuf>,
    allowed_paths: BTreeSet<PathBuf>,
}

impl ProjectPathsConfigBuilder {
    pub fn root(mut self, root: impl Into<PathBuf>) -> Self {
        self.root = Some(utils::canonicalized(root));
        self
    }

    pub fn cache(mut self, cache: impl Into<PathBuf>) -> Self {
        self.cache = Some(utils::canonicalized(cache));
        self
    }

    pub fn artifacts(mut self, artifacts: impl Into<PathBuf>) -> Self {
        self.artifacts = Some(utils::canonicalized(artifacts));
        self
    }

    pub fn build_infos(mut self, build_infos: impl Into<PathBuf>) -> Self {
        self.build_infos = Some(utils::canonicalized(build_infos));
        self
    }

    pub fn sources(mut self, sources: impl Into<PathBuf>) -> Self {
        self.sources = Some(utils::canonicalized(sources));
        self
    }

    pub fn tests(mut self, tests: impl Into<PathBuf>) -> Self {
        self.tests = Some(utils::canonicalized(tests));
        self
    }

    pub fn scripts(mut self, scripts: impl Into<PathBuf>) -> Self {
        self.scripts = Some(utils::canonicalized(scripts));
        self
    }

    /// Specifically disallow additional libraries
    pub fn no_libs(mut self) -> Self {
        self.libraries = Some(Vec::new());
        self
    }

    pub fn lib(mut self, lib: impl Into<PathBuf>) -> Self {
        self.libraries.get_or_insert_with(Vec::new).push(utils::canonicalized(lib));
        self
    }

    pub fn libs(mut self, libs: impl IntoIterator<Item = impl Into<PathBuf>>) -> Self {
        let libraries = self.libraries.get_or_insert_with(Vec::new);
        for lib in libs.into_iter() {
            libraries.push(utils::canonicalized(lib));
        }
        self
    }

    pub fn remapping(mut self, remapping: Remapping) -> Self {
        self.remappings.get_or_insert_with(Vec::new).push(remapping);
        self
    }

    pub fn remappings(mut self, remappings: impl IntoIterator<Item = Remapping>) -> Self {
        let our_remappings = self.remappings.get_or_insert_with(Vec::new);
        for remapping in remappings.into_iter() {
            our_remappings.push(remapping);
        }
        self
    }

    /// Adds an allowed-path to the solc executable
    pub fn allowed_path<P: Into<PathBuf>>(mut self, path: P) -> Self {
        self.allowed_paths.insert(path.into());
        self
    }

    /// Adds multiple allowed-path to the solc executable
    pub fn allowed_paths<I, S>(mut self, args: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<PathBuf>,
    {
        for arg in args {
            self = self.allowed_path(arg);
        }
        self
    }

    /// Adds an `--include-path` to the solc executable
    pub fn include_path<P: Into<PathBuf>>(mut self, path: P) -> Self {
        self.include_paths.insert(path.into());
        self
    }

    /// Adds multiple include-path to the solc executable
    pub fn include_paths<I, S>(mut self, args: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<PathBuf>,
    {
        for arg in args {
            self = self.include_path(arg);
        }
        self
    }

    pub fn build_with_root<C>(self, root: impl Into<PathBuf>) -> ProjectPathsConfig<C> {
        let root = utils::canonicalized(root);

        let libraries = self.libraries.unwrap_or_else(|| ProjectPathsConfig::find_libs(&root));
        let artifacts =
            self.artifacts.unwrap_or_else(|| ProjectPathsConfig::find_artifacts_dir(&root));

        let mut allowed_paths = self.allowed_paths;
        // allow every contract under root by default
        allowed_paths.insert(root.clone());

        ProjectPathsConfig {
            cache: self
                .cache
                .unwrap_or_else(|| root.join("cache").join(SOLIDITY_FILES_CACHE_FILENAME)),
            build_infos: self.build_infos.unwrap_or_else(|| artifacts.join("build-info")),
            artifacts,
            sources: self.sources.unwrap_or_else(|| ProjectPathsConfig::find_source_dir(&root)),
            tests: self.tests.unwrap_or_else(|| root.join("test")),
            scripts: self.scripts.unwrap_or_else(|| root.join("script")),
            remappings: self.remappings.unwrap_or_else(|| {
                libraries.iter().flat_map(|p| Remapping::find_many(p)).collect()
            }),
            libraries,
            root,
            include_paths: self.include_paths,
            allowed_paths,
            _l: PhantomData,
        }
    }

    pub fn build<C>(self) -> std::result::Result<ProjectPathsConfig<C>, SolcIoError> {
        let root = self
            .root
            .clone()
            .map(Ok)
            .unwrap_or_else(std::env::current_dir)
            .map_err(|err| SolcIoError::new(err, "."))?;
        Ok(self.build_with_root(root))
    }
}

/// The config to use when compiling the contracts
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct SolcConfig {
    /// How the file was compiled
    pub settings: Settings,
}

impl SolcConfig {
    /// Creates a new [`SolcConfig`] builder.
    ///
    /// # Examples
    ///
    /// Autodetect solc version and default settings
    ///
    /// ```
    /// use foundry_compilers::SolcConfig;
    ///
    /// let config = SolcConfig::builder().build();
    /// ```
    pub fn builder() -> SolcConfigBuilder {
        SolcConfigBuilder::default()
    }
}

impl From<SolcConfig> for Settings {
    fn from(config: SolcConfig) -> Self {
        config.settings
    }
}

#[derive(Default)]
pub struct SolcConfigBuilder {
    settings: Option<Settings>,

    /// additionally selected outputs that should be included in the `Contract` that solc creates.
    output_selection: Vec<ContractOutputSelection>,

    /// whether to include the AST in the output
    ast: bool,
}

impl SolcConfigBuilder {
    pub fn settings(mut self, settings: Settings) -> Self {
        self.settings = Some(settings);
        self
    }

    /// Adds another `ContractOutputSelection` to the set
    #[must_use]
    pub fn additional_output(mut self, output: impl Into<ContractOutputSelection>) -> Self {
        self.output_selection.push(output.into());
        self
    }

    /// Adds multiple `ContractOutputSelection` to the set
    #[must_use]
    pub fn additional_outputs<I, S>(mut self, outputs: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<ContractOutputSelection>,
    {
        for out in outputs {
            self = self.additional_output(out);
        }
        self
    }

    pub fn ast(mut self, yes: bool) -> Self {
        self.ast = yes;
        self
    }

    /// Creates the solc settings
    pub fn build(self) -> Settings {
        let Self { settings, output_selection, ast } = self;
        let mut settings = settings.unwrap_or_default();
        settings.push_all(output_selection);
        if ast {
            settings = settings.with_ast();
        }
        settings
    }
}

/// Return true if `a` starts with `b` or `b - root`.
fn path_starts_with_rooted(a: &Path, b: &Path, root: &Path) -> bool {
    if a.starts_with(b) {
        return true;
    }
    if let Ok(b) = b.strip_prefix(root) {
        return a.starts_with(b);
    }
    false
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn can_autodetect_dirs() {
        let root = utils::tempdir("root").unwrap();
        let out = root.path().join("out");
        let artifacts = root.path().join("artifacts");
        let build_infos = artifacts.join("build-info");
        let contracts = root.path().join("contracts");
        let src = root.path().join("src");
        let lib = root.path().join("lib");
        let node_modules = root.path().join("node_modules");

        let root = root.path();
        assert_eq!(ProjectPathsConfig::find_source_dir(root), src,);
        std::fs::create_dir_all(&contracts).unwrap();
        assert_eq!(ProjectPathsConfig::find_source_dir(root), contracts,);
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).sources,
            utils::canonicalized(contracts),
        );
        std::fs::create_dir_all(&src).unwrap();
        assert_eq!(ProjectPathsConfig::find_source_dir(root), src,);
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).sources,
            utils::canonicalized(src),
        );

        assert_eq!(ProjectPathsConfig::find_artifacts_dir(root), out,);
        std::fs::create_dir_all(&artifacts).unwrap();
        assert_eq!(ProjectPathsConfig::find_artifacts_dir(root), artifacts,);
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).artifacts,
            utils::canonicalized(artifacts),
        );
        std::fs::create_dir_all(&build_infos).unwrap();
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).build_infos,
            utils::canonicalized(build_infos)
        );

        std::fs::create_dir_all(&out).unwrap();
        assert_eq!(ProjectPathsConfig::find_artifacts_dir(root), out,);
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).artifacts,
            utils::canonicalized(out),
        );

        assert_eq!(ProjectPathsConfig::find_libs(root), vec![lib.clone()],);
        std::fs::create_dir_all(&node_modules).unwrap();
        assert_eq!(ProjectPathsConfig::find_libs(root), vec![node_modules.clone()],);
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).libraries,
            vec![utils::canonicalized(node_modules)],
        );
        std::fs::create_dir_all(&lib).unwrap();
        assert_eq!(ProjectPathsConfig::find_libs(root), vec![lib.clone()],);
        assert_eq!(
            ProjectPathsConfig::builder().build_with_root::<()>(root).libraries,
            vec![utils::canonicalized(lib)],
        );
    }

    #[test]
    fn can_have_sane_build_info_default() {
        let root = utils::tempdir("root").unwrap();
        let root = root.path();
        let artifacts = root.join("forge-artifacts");

        // Set the artifacts directory without setting the
        // build info directory
        let paths = ProjectPathsConfig::builder().artifacts(&artifacts).build_with_root::<()>(root);

        // The artifacts should be set correctly based on the configured value
        assert_eq!(paths.artifacts, utils::canonicalized(artifacts));

        // The build infos should by default in the artifacts directory
        assert_eq!(paths.build_infos, utils::canonicalized(paths.artifacts.join("build-info")));
    }

    #[test]
    #[cfg_attr(windows, ignore = "Windows remappings #2347")]
    fn can_find_library_ancestor() {
        let mut config = ProjectPathsConfig::builder().lib("lib").build::<()>().unwrap();
        config.root = "/root/".into();

        assert_eq!(
            config.find_library_ancestor("lib/src/Greeter.sol".as_ref()).unwrap(),
            Path::new("lib")
        );

        assert_eq!(
            config.find_library_ancestor("/root/lib/src/Greeter.sol".as_ref()).unwrap(),
            Path::new("lib")
        );

        config.libraries.push("/root/test/".into());

        assert_eq!(
            config.find_library_ancestor("test/src/Greeter.sol".as_ref()).unwrap(),
            Path::new("/root/test/")
        );

        assert_eq!(
            config.find_library_ancestor("/root/test/src/Greeter.sol".as_ref()).unwrap(),
            Path::new("/root/test/")
        );
    }

    #[test]
    fn can_resolve_import() {
        let dir = tempfile::tempdir().unwrap();
        let config = ProjectPathsConfig::builder().root(dir.path()).build::<()>().unwrap();
        config.create_all().unwrap();

        fs::write(config.sources.join("A.sol"), r"pragma solidity ^0.8.0; contract A {}").unwrap();

        // relative import
        assert_eq!(
            config
                .resolve_import_and_include_paths(
                    &config.sources,
                    Path::new("./A.sol"),
                    &mut Default::default(),
                )
                .unwrap(),
            config.sources.join("A.sol")
        );

        // direct import
        assert_eq!(
            config
                .resolve_import_and_include_paths(
                    &config.sources,
                    Path::new("src/A.sol"),
                    &mut Default::default(),
                )
                .unwrap(),
            config.sources.join("A.sol")
        );
    }

    #[test]
    fn can_resolve_remapped_import() {
        let dir = tempfile::tempdir().unwrap();
        let mut config = ProjectPathsConfig::builder().root(dir.path()).build::<()>().unwrap();
        config.create_all().unwrap();

        let dependency = config.root.join("dependency");
        fs::create_dir(&dependency).unwrap();
        fs::write(dependency.join("A.sol"), r"pragma solidity ^0.8.0; contract A {}").unwrap();

        config.remappings.push(Remapping {
            context: None,
            name: "@dependency/".into(),
            path: "dependency/".into(),
        });

        assert_eq!(
            config
                .resolve_import_and_include_paths(
                    &config.sources,
                    Path::new("@dependency/A.sol"),
                    &mut Default::default(),
                )
                .unwrap(),
            dependency.join("A.sol")
        );
    }

    #[test]
    fn can_resolve_single_file_mapped_import() {
        let dir = tempfile::tempdir().unwrap();
        let mut config = ProjectPathsConfig::builder().root(dir.path()).build::<()>().unwrap();
        config.create_all().unwrap();

        fs::write(
            config.sources.join("A.sol"),
            r#"pragma solidity ^0.8.0; import "@my-lib/B.sol"; contract A is B {}"#,
        )
        .unwrap();

        let dependency = config.root.join("my-lib");
        fs::create_dir(&dependency).unwrap();
        fs::write(dependency.join("B.sol"), r"pragma solidity ^0.8.0; contract B {}").unwrap();

        config.remappings.push(Remapping {
            context: None,
            name: "@my-lib/B.sol".into(),
            path: "my-lib/B.sol".into(),
        });

        // Test that single file import / remapping resolves to file.
        assert!(config
            .resolve_import_and_include_paths(
                &config.sources,
                Path::new("@my-lib/B.sol"),
                &mut Default::default(),
            )
            .unwrap()
            .to_str()
            .unwrap()
            .ends_with("my-lib/B.sol"));
    }

    #[test]
    fn can_apply_remapping_to_relative_import() {
        // This test verifies the fix for foundry-rs/foundry#12667
        // When a relative import resolves to a path that matches a remapping,
        // the remapped path should be used instead.
        let dir = tempfile::tempdir().unwrap();
        let mut config = ProjectPathsConfig::builder().root(dir.path()).build::<()>().unwrap();
        config.create_all().unwrap();

        // Create lib/external/utils/LibMem/LibMem.sol (the original external file)
        let lib_dir = config.root.join("lib/external/utils/LibMem");
        fs::create_dir_all(&lib_dir).unwrap();
        fs::write(
            lib_dir.join("LibMem.sol"),
            r"pragma solidity ^0.8.0; library LibMem { bool constant EXTERNAL = true; }",
        )
        .unwrap();

        // Create src/utils/LibMem.sol (the local override)
        let local_dir = config.root.join("src/utils");
        fs::create_dir_all(&local_dir).unwrap();
        fs::write(
            local_dir.join("LibMem.sol"),
            r"pragma solidity ^0.8.0; library LibMem { bool constant LOCAL = true; }",
        )
        .unwrap();

        // Create a file that uses relative import
        let importing_file = config.root.join("lib/external/utils/BytesUtils.sol");
        fs::write(&importing_file, r#"pragma solidity ^0.8.0; import "./LibMem/LibMem.sol";"#)
            .unwrap();

        // Add remapping: lib/external/utils/LibMem/=src/utils/
        config.remappings.push(Remapping {
            context: None,
            name: "lib/external/utils/LibMem/".into(),
            path: "src/utils/".into(),
        });

        // Resolve the relative import from BytesUtils.sol
        let cwd = importing_file.parent().unwrap();
        let resolved = config
            .resolve_import_and_include_paths(
                cwd,
                Path::new("./LibMem/LibMem.sol"),
                &mut Default::default(),
            )
            .unwrap();

        // The resolved path should be the local override, not the external file
        assert_eq!(resolved, local_dir.join("LibMem.sol"));
    }
}