rust/crates/toolchain/src/lib.rs

//! Discovery of `cargo` & `rustc` executables.

#![warn(rust_2018_idioms, unused_lifetimes)]

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

#[derive(Copy, Clone)]
pub enum Tool {
    Cargo,
    Rustc,
    Rustup,
    Rustfmt,
}

impl Tool {
    pub fn path(self) -> PathBuf {
        get_path_for_executable(self.name())
    }

    pub fn path_in(self, path: &Path) -> Option<PathBuf> {
        probe_for_binary(path.join(self.name()))
    }

    pub fn path_in_or_discover(self, path: &Path) -> PathBuf {
        probe_for_binary(path.join(self.name())).unwrap_or_else(|| self.path())
    }

    pub fn name(self) -> &'static str {
        match self {
            Tool::Cargo => "cargo",
            Tool::Rustc => "rustc",
            Tool::Rustup => "rustup",
            Tool::Rustfmt => "rustfmt",
        }
    }
}

pub fn cargo() -> PathBuf {
    get_path_for_executable("cargo")
}

pub fn rustc() -> PathBuf {
    get_path_for_executable("rustc")
}

pub fn rustup() -> PathBuf {
    get_path_for_executable("rustup")
}

pub fn rustfmt() -> PathBuf {
    get_path_for_executable("rustfmt")
}

/// Return a `PathBuf` to use for the given executable.
///
/// E.g., `get_path_for_executable("cargo")` may return just `cargo` if that
/// gives a valid Cargo executable; or it may return a full path to a valid
/// Cargo.
fn get_path_for_executable(executable_name: &'static str) -> PathBuf {
    // The current implementation checks three places for an executable to use:
    // 1) Appropriate environment variable (erroring if this is set but not a usable executable)
    //      example: for cargo, this checks $CARGO environment variable; for rustc, $RUSTC; etc
    // 2) `$CARGO_HOME/bin/<executable_name>`
    //      where $CARGO_HOME defaults to ~/.cargo (see https://doc.rust-lang.org/cargo/guide/cargo-home.html)
    //      example: for cargo, this tries $CARGO_HOME/bin/cargo, or ~/.cargo/bin/cargo if $CARGO_HOME is unset.
    //      It seems that this is a reasonable place to try for cargo, rustc, and rustup
    // 3) `<executable_name>`
    //      example: for cargo, this tries just `cargo`, which will succeed if `cargo` is on the $PATH
    let env_var = executable_name.to_ascii_uppercase();
    if let Some(path) = env::var_os(env_var) {
        return path.into();
    }

    if let Some(mut path) = get_cargo_home() {
        path.push("bin");
        path.push(executable_name);
        if let Some(path) = probe_for_binary(path) {
            return path;
        }
    }

    if lookup_in_path(executable_name) {
        return executable_name.into();
    }

    executable_name.into()
}

fn lookup_in_path(exec: &str) -> bool {
    let paths = env::var_os("PATH").unwrap_or_default();
    env::split_paths(&paths).map(|path| path.join(exec)).find_map(probe_for_binary).is_some()
}

fn get_cargo_home() -> Option<PathBuf> {
    if let Some(path) = env::var_os("CARGO_HOME") {
        return Some(path.into());
    }

    if let Some(mut path) = home::home_dir() {
        path.push(".cargo");
        return Some(path);
    }

    None
}

pub fn probe_for_binary(path: PathBuf) -> Option<PathBuf> {
    let with_extension = match env::consts::EXE_EXTENSION {
        "" => None,
        it => Some(path.with_extension(it)),
    };
    iter::once(path).chain(with_extension).find(|it| it.is_file())
}