cargo-c 0.10.23+cargo-0.97.1

Helper program to build and install c-like libraries
Documentation
use std::ffi::{OsStr, OsString};
use std::path::PathBuf;

use camino::Utf8PathBuf;
use cargo::util::command_prelude::{flag, heading, multi_opt, opt};
use cargo::util::command_prelude::{get_ws_member_candidates, CommandExt};
use cargo::util::{style, CliError, CliResult};

use cargo_util::{ProcessBuilder, ProcessError};

use clap::builder::{StringValueParser, TypedValueParser};
use clap::{Arg, ArgAction, ArgMatches, Command, CommandFactory, Parser};
use clap_complete::ArgValueCandidates;

use crate::target::Target;

// TODO: convert to a function using cargo opt()
#[allow(dead_code)]
#[derive(Clone, Debug, Parser)]
struct Common {
    /// Path to directory where target should be copied to
    #[clap(long = "destdir")]
    destdir: Option<PathBuf>,
    /// Directory path used to construct the values of
    /// `bindir`, `datarootdir`, `includedir`, `libdir`
    ///
    /// If they are absolute the prefix is ignored.
    #[clap(long = "prefix", default_value = "/usr/local")]
    prefix: PathBuf,
    /// Path to directory for installing generated library files
    #[clap(long = "libdir", default_value = "lib")]
    libdir: PathBuf,
    /// Path to directory for installing generated headers files
    #[clap(long = "includedir", default_value = "include")]
    includedir: PathBuf,
    /// Path to directory for installing generated executable files
    #[clap(long = "bindir", default_value = "bin")]
    bindir: Option<PathBuf>,
    /// Path to directory for installing generated pkg-config .pc files
    ///
    /// [default: {libdir}/pkgconfig]
    #[clap(long = "pkgconfigdir")]
    pkgconfigdir: Option<PathBuf>,
    /// Path to directory for installing read-only data
    #[clap(long = "datarootdir", default_value = "share")]
    datarootdir: PathBuf,
    /// Path to directory for installing read-only application-specific data
    ///
    /// [default: {datarootdir}]
    #[clap(long = "datadir")]
    datadir: Option<PathBuf>,
    #[clap(long = "dlltool")]
    /// Use the provided dlltool when building for the windows-gnu targets. (deprecated and no-op)
    dlltool: Option<PathBuf>,
    #[clap(long = "crt-static")]
    /// Build the library embedding the C runtime
    crt_static: bool,
    /// Use the Linux/Meson library naming convention on Windows
    #[clap(long = "meson-paths", default_value = "false")]
    meson: bool,
}

trait CommandExtC: CommandExt {
    fn arg_manifest_path_alias_path(self, with_alias: bool) -> Self {
        let o = opt("manifest-path", "Path to Cargo.toml")
            .value_name("PATH")
            .help_heading(heading::MANIFEST_OPTIONS)
            .value_parser(StringValueParser::new().map(|p| {
                let mut p = Utf8PathBuf::from(p);
                if p.is_dir() {
                    p.push("Cargo.toml");
                }
                p.into_string()
            }))
            .add(clap_complete::engine::ArgValueCompleter::new(
                clap_complete::engine::PathCompleter::any().filter(|path| {
                    path.join("Cargo.toml").exists()
                        || path.file_name() == Some(OsStr::new("Cargo.toml"))
                        || cargo::util::toml::is_embedded(path)
                }),
            ));

        let o = if with_alias {
            o.visible_alias("path")
        } else {
            o
        };
        self._arg(o)
    }
}

impl CommandExtC for Command {}

pub fn main_cli() -> Command {
    let styles = {
        clap::builder::styling::Styles::styled()
            .header(style::HEADER)
            .usage(style::USAGE)
            .literal(style::LITERAL)
            .placeholder(style::PLACEHOLDER)
            .error(style::ERROR)
            .valid(style::VALID)
            .invalid(style::INVALID)
    };
    clap::command!()
        .dont_collapse_args_in_usage(true)
        .allow_external_subcommands(true)
        .styles(styles)
}

fn base_cli() -> Command {
    let default_target = Target::new::<&str>(None, false);
    let app = Common::command()
        .allow_external_subcommands(true)
        .arg(flag("version", "Print version info and exit").short('V'))
        .arg(flag("list", "List installed commands"))
        .arg(opt("explain", "Run `rustc --explain CODE`").value_name("CODE"))
        .arg(
            opt(
                "verbose",
                "Use verbose output (-vv very verbose/build.rs output)",
            )
            .short('v')
            .action(ArgAction::Count)
            .global(true),
        )
        .arg_silent_suggestion()
        .arg(
            opt("color", "Coloring: auto, always, never")
                .value_name("WHEN")
                .global(true),
        )
        .arg(flag("frozen", "Require Cargo.lock and cache are up to date").global(true))
        .arg(flag("locked", "Require Cargo.lock is up to date").global(true))
        .arg(flag("offline", "Run without accessing the network").global(true))
        .arg(multi_opt("config", "KEY=VALUE", "Override a configuration value").global(true))
        .arg(
            Arg::new("unstable-features")
                .help("Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details")
                .short('Z')
                .value_name("FLAG")
                .action(ArgAction::Append)
                .global(true),
        )
        .arg_parallel()
        .arg_targets_all(
            "Build only this package's library",
            "Build only the specified binary",
            "Build all binaries",
            "Build only the specified example",
            "Build all examples",
            "Build only the specified test target",
            "Build all tests",
            "Build only the specified bench target",
            "Build all benches",
            "Build all targets",
        )
        .arg(
            multi_opt(
                "library-type",
                "LIBRARY-TYPE",
                "Build only a type of library",
            )
            .global(true)
            .ignore_case(true)
            .value_parser(["cdylib", "staticlib"]),
        )
        .arg_profile("Build artifacts with the specified profile")
        .arg_features()
        .arg_target_triple("Build for the target triple")
        .arg_target_dir()
        .arg_message_format();

    if let Ok(t) = default_target {
        app.mut_arg("prefix", |a| {
            a.default_value(t.default_prefix().as_os_str().to_os_string())
        })
        .mut_arg("libdir", |a| {
            a.default_value(t.default_libdir().as_os_str().to_os_string())
        })
        .mut_arg("datadir", |a| {
            a.default_value(t.default_datadir().as_os_str().to_os_string())
        })
        .mut_arg("includedir", |a| {
            a.default_value(t.default_includedir().as_os_str().to_os_string())
        })
    } else {
        app
    }
}

pub fn subcommand_build(name: &'static str, about: &'static str) -> Command {
    base_cli()
        .name(name)
        .about(about)
        .arg_release("Build artifacts in release mode, with optimizations")
        .arg_package_spec_no_all(
            "Package to build (see `cargo help pkgid`)",
            "Build all packages in the workspace",
            "Exclude packages from the build",
            ArgValueCandidates::new(get_ws_member_candidates),
        )
        .arg_manifest_path_alias_path(false)
        .after_help(
            "
Compilation can be configured via the use of profiles which are configured in
the manifest. The default profile for this command is `dev`, but passing
the --release flag will use the `release` profile instead.
",
        )
}

pub fn subcommand_install(name: &'static str, about: &'static str) -> Command {
    base_cli()
        .name(name)
        .about(about)
        .arg(flag("debug", "Build in debug mode instead of release mode"))
        .arg_release(
            "Build artifacts in release mode, with optimizations. This is the default behavior.",
        )
        .arg_package_spec_no_all(
            "Package to install (see `cargo help pkgid`)",
            "Install all packages in the workspace",
            "Exclude packages from being installed",
            ArgValueCandidates::new(get_ws_member_candidates),
        )
        .arg_manifest_path_alias_path(true)
        .after_help(
            "
Compilation can be configured via the use of profiles which are configured in
the manifest. The default profile for this command is `release`, but passing
the --debug flag will use the `dev` profile instead.
",
        )
}

pub fn subcommand_test(name: &'static str) -> Command {
    base_cli()
        .name(name)
        .about("Test the crate C-API")
        .arg(
            Arg::new("TESTNAME")
                .action(ArgAction::Set)
                .help("If specified, only run tests containing this string in their names"),
        )
        .arg(
            Arg::new("args")
                .help("Arguments for the test binary")
                .num_args(0..)
                .last(true),
        )
        .arg_release("Build artifacts in release mode, with optimizations")
        .arg_package_spec_no_all(
            "Package to run tests for",
            "Test all packages in the workspace",
            "Exclude packages from the test",
            ArgValueCandidates::new(get_ws_member_candidates),
        )
        .arg_manifest_path_alias_path(false)
        .arg(flag("no-run", "Compile, but don't run tests"))
        .arg(flag("no-fail-fast", "Run all tests regardless of failure"))
}

pub fn run_cargo_fallback(subcommand: &str, subcommand_args: &ArgMatches) -> CliResult {
    let cargo = std::env::var("CARGO_C_CARGO").unwrap_or_else(|_| "cargo".to_owned());
    let mut args = vec![OsStr::new(subcommand)];

    args.extend(
        subcommand_args
            .get_many::<OsString>("")
            .unwrap_or_default()
            .map(OsStr::new),
    );
    let err = match ProcessBuilder::new(cargo).args(&args).exec_replace() {
        Ok(()) => return Ok(()),
        Err(e) => e,
    };

    if let Some(perr) = err.downcast_ref::<ProcessError>() {
        if let Some(code) = perr.code {
            return Err(CliError::code(code));
        }
    }
    Err(CliError::new(err, 101))
}