pedant-core 0.24.0

//! Filesystem candidates and lookup directories for module declarations.

use std::ffi::OsStr;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use super::super::error::{ClosureSite, SourceClosureFailure, SourceClosureFailureKind};
use super::super::failure::failure;
use super::super::store::SourceStore;
use super::walk::ChildContext;

/// Every directory an inline module's own `mod` items resolve from.
pub(super) fn inline_directories(context: &ChildContext<'_>) -> Box<[PathBuf]> {
    match &*context.declaration.declared_paths {
        [] => Box::from([context
            .frame
            .directory
            .join(module_file_name(&context.declaration.name))]),
        [first, rest @ ..] => declared_directories(context, (&**first, rest)),
    }
}

/// The declared directories this package actually ships, or the first
/// declared one when it ships none.
fn declared_directories(
    context: &ChildContext<'_>,
    declared: (&str, &[Arc<str>]),
) -> Box<[PathBuf]> {
    let (first, rest) = declared;
    let shipped: Box<[PathBuf]> = std::iter::once(first)
        .chain(rest.iter().map(|path| &**path))
        .map(|path| context.frame.declared_directory.join(path))
        .filter(|directory| directory.is_dir())
        .collect();
    match shipped.is_empty() {
        true => Box::from([context.frame.declared_directory.join(first)]),
        false => shipped,
    }
}

pub(super) fn candidate_paths(
    store: &SourceStore,
    context: &ChildContext<'_>,
    site: &ClosureSite,
) -> Result<Box<[PathBuf]>, SourceClosureFailure> {
    match &*context.declaration.declared_paths {
        [] => standard_candidate(store, context, site).map(|path| Box::from([path])),
        [declared] => {
            declared_candidate(store, context, (site, declared)).map(|path| Box::from([path]))
        }
        alternatives => declared_alternatives(store, context, (site, alternatives)),
    }
}

fn declared_candidate(
    store: &SourceStore,
    context: &ChildContext<'_>,
    request: (&ClosureSite, &str),
) -> Result<PathBuf, SourceClosureFailure> {
    let (site, declared) = request;
    let candidate = context.frame.declared_directory.join(declared);
    match candidate.is_file() {
        true => Ok(candidate),
        false => Err(missing(store, site, &candidate)),
    }
}

/// Every conditional alternative this package can reach within its root.
///
/// The failure names the first declared alternative, and it is read out of the
/// same slice rather than indexed into it: a caller's match arm currently
/// guarantees two or more, and nothing in this body says so. An empty list
/// states no alternative to name, so the refusal names the directory they would
/// all have been looked up in.
fn declared_alternatives(
    store: &SourceStore,
    context: &ChildContext<'_>,
    request: (&ClosureSite, &[Arc<str>]),
) -> Result<Box<[PathBuf]>, SourceClosureFailure> {
    let (site, alternatives) = request;
    let mut reachable: Vec<PathBuf> = Vec::new();
    for declared in alternatives {
        let candidate = context.frame.declared_directory.join(&**declared);
        if reachable_alternative(store, &candidate, site)? {
            reachable.push(candidate);
        }
    }
    match (reachable.is_empty(), alternatives.first()) {
        (false, _) => Ok(reachable.into_boxed_slice()),
        (true, Some(first)) => Err(missing(
            store,
            site,
            &context.frame.declared_directory.join(&**first),
        )),
        (true, None) => Err(missing(store, site, &context.frame.declared_directory)),
    }
}

/// Whether one declared alternative is a source this package ships inside its
/// own root.
///
/// Absence and refusal are different answers, and only one of them belongs to
/// this set. An alternative the package does not ship is absence: `#[path]`
/// alternatives are conditional, and the one a build selects is the one that
/// exists. An alternative it does ship that resolves outside the repository
/// root is a refusal, reported here exactly as the single-alternative form
/// reports it — dropping it instead would leave the caller reading a set it
/// takes for complete, with a link that escaped the root silently missing
/// from it.
fn reachable_alternative(
    store: &SourceStore,
    candidate: &Path,
    site: &ClosureSite,
) -> Result<bool, SourceClosureFailure> {
    match (
        lexically_inside(store.root(), candidate),
        candidate.is_file(),
    ) {
        (false, _) | (_, false) => Ok(false),
        (true, true) => store.canonical_inside(candidate, site).map(|_| true),
    }
}

/// Whether a conditional candidate has a spelling beneath this package root.
///
/// Cargo packages may retain a workspace-only `cfg_attr` path beside the path
/// their archive ships. A vendor tree can make that sibling happen to exist,
/// but existence beside the package does not make it package source. A path
/// spelled inside the root is still canonicalized afterwards, so an in-root
/// symlink cannot use this lexical decision to escape confinement.
fn lexically_inside(root: &Path, candidate: &Path) -> bool {
    let relative = match candidate.strip_prefix(root) {
        Ok(relative) => relative,
        Err(_) => return false,
    };
    relative
        .components()
        .try_fold(0_usize, |depth, component| match component {
            std::path::Component::Normal(_) => Some(depth.saturating_add(1)),
            std::path::Component::CurDir => Some(depth),
            std::path::Component::ParentDir => depth.checked_sub(1),
            std::path::Component::Prefix(_) | std::path::Component::RootDir => None,
        })
        .is_some()
}

fn standard_candidate(
    store: &SourceStore,
    context: &ChildContext<'_>,
    site: &ClosureSite,
) -> Result<PathBuf, SourceClosureFailure> {
    let name = module_file_name(&context.declaration.name);
    let flat = context.frame.directory.join(format!("{name}.rs"));
    let nested = context.frame.directory.join(name).join("mod.rs");
    match (flat.is_file(), nested.is_file()) {
        (true, true) => Err(ambiguous(store, site, &flat)),
        (true, false) => Ok(flat),
        (false, true) => Ok(nested),
        (false, false) => Err(missing(store, site, &flat)),
    }
}

fn missing(store: &SourceStore, site: &ClosureSite, attempted: &Path) -> SourceClosureFailure {
    failure(
        SourceClosureFailureKind::MissingModule,
        (site, store.relative_of(attempted)),
        format!("{site}: no source exists for the declared module"),
    )
}

fn ambiguous(store: &SourceStore, site: &ClosureSite, attempted: &Path) -> SourceClosureFailure {
    failure(
        SourceClosureFailureKind::AmbiguousModule,
        (site, store.relative_of(attempted)),
        format!("{site}: both name.rs and name/mod.rs exist"),
    )
}

/// The directory a source file lives in.
pub(super) fn file_directory(file: &Path) -> PathBuf {
    file.parent().map(Path::to_path_buf).unwrap_or_default()
}

/// The directory a module's external children are looked up in.
///
/// `declared` is the caller's [`file_directory`] result for the same file. Crate
/// roots and `mod.rs` files resolve children from that directory.
pub(super) fn child_directory(file: &Path, declared: &Arc<Path>, crate_root: bool) -> Arc<Path> {
    match crate_root {
        true => Arc::clone(declared),
        false => nested_directory(file, declared),
    }
}

/// The directory a non-root module's own external children resolve from.
fn nested_directory(file: &Path, declared: &Arc<Path>) -> Arc<Path> {
    let stem = file.file_stem().and_then(OsStr::to_str).unwrap_or_default();
    match stem == "mod" {
        true => Arc::clone(declared),
        false => Arc::from(declared.join(stem)),
    }
}

/// The directory an external module's own external children resolve from.
pub(super) fn external_child_directory(
    file: &Path,
    context: &ChildContext<'_>,
    declared: &Arc<Path>,
) -> Arc<Path> {
    match context.declaration.declared_paths.is_empty() {
        true => child_directory(file, declared, false),
        false => Arc::clone(declared),
    }
}

/// Strip the raw-identifier prefix that is syntax rather than a file name.
fn module_file_name(name: &str) -> &str {
    name.strip_prefix("r#").unwrap_or(name)
}