fish-shell/fish-rust/build.rs

use rsconf::{LinkType, Target};
use std::env;
use std::error::Error;
use std::path::{Path, PathBuf};
use std::process::Stdio;

fn main() {
    for key in ["DOCDIR", "DATADIR", "SYSCONFDIR", "BINDIR", "LOCALEDIR"] {
        if let Ok(val) = env::var(key) {
            // Forward some CMake config
            println!("cargo:rustc-env={key}={val}");
        }
    }

    let build_dir = PathBuf::from(
        std::env::var("FISH_BUILD_DIR")
            // Add our default to enable tools that don't go through CMake, like "cargo test"
            // and the language server.
            .unwrap_or("./build".into()),
    );

    let cached_curses_libnames = Path::join(&build_dir, "cached-curses-libnames");
    let curses_libnames: Vec<String> = if let Ok(lib_path_list) = env::var("CURSES_LIBRARY_LIST") {
        let lib_paths = lib_path_list
            .split(',')
            .filter(|s| !s.is_empty())
            .map(|s| s.to_string());
        let curses_libnames: Vec<_> = lib_paths
            .map(|libpath| {
                let stem = Path::new(&libpath).file_stem().unwrap().to_str().unwrap();
                // Ubuntu-32bit-fetched-pcre2's ncurses doesn't have the "lib" prefix.
                stem.strip_prefix("lib").unwrap_or(stem).to_owned()
            })
            .collect();
        std::fs::write(cached_curses_libnames, curses_libnames.join("\n") + "\n").unwrap();
        curses_libnames
    } else {
        let lib_cache = std::fs::read(cached_curses_libnames).unwrap_or_default();
        let lib_cache = String::from_utf8(lib_cache).unwrap();
        lib_cache
            .split('\n')
            .filter(|s| !s.is_empty())
            .map(|s| s.to_owned())
            .collect()
    };
    rsconf::link_libraries(&curses_libnames, LinkType::Default);

    cc::Build::new()
        .file("fish-rust/src/compat.c")
        .include(&build_dir)
        .compile("libcompat.a");

    if compiles("fish-rust/src/cfg/w_exitcode.cpp") {
        println!("cargo:rustc-cfg=HAVE_WAITSTATUS_SIGNAL_RET");
    }
    if compiles("fish-rust/src/cfg/eventfd.c") {
        println!("cargo:rustc-cfg=HAVE_EVENTFD");
    }
    if compiles("fish-rust/src/cfg/pipe2.c") {
        println!("cargo:rustc-cfg=HAVE_PIPE2");
    }
    if compiles("fish-rust/src/cfg/spawn.c") {
        println!("cargo:rustc-cfg=FISH_USE_POSIX_SPAWN");
    }

    let rust_dir = env!("CARGO_MANIFEST_DIR");
    let target_dir =
        std::env::var("FISH_RUST_TARGET_DIR").unwrap_or(format!("{}/{}", rust_dir, "target/"));
    let cpp_fish_src_dir = format!("{}/{}", rust_dir, "src/");

    // Where cxx emits its header.
    let cxx_include_dir = format!("{}/{}", target_dir, "cxxbridge/rust/");

    // If FISH_BUILD_DIR is given by CMake, then use it; otherwise assume it's at build.
    let fish_build_dir =
        std::env::var("FISH_BUILD_DIR").unwrap_or(format!("{}/{}", rust_dir, "build/"));
    println!("cargo:rustc-env=FISH_BUILD_DIR={fish_build_dir}");

    // Where autocxx should put its stuff.
    let autocxx_gen_dir = std::env::var("FISH_AUTOCXX_GEN_DIR")
        .unwrap_or(format!("{}/{}", fish_build_dir, "fish-autocxx-gen/"));

    let mut build = cc::Build::new();
    // Add to the default library search path
    build.flag_if_supported("-L/usr/local/lib/");
    rsconf::add_library_search_path("/usr/local/lib");
    let mut detector = Target::new_from(build).unwrap();
    // Keep verbose mode on until we've ironed out rust build script stuff
    // Note that if autocxx fails to compile any rust code, you'll see the full and unredacted
    // stdout/stderr output, which will include things that LOOK LIKE compilation errors as rsconf
    // tries to build various test files to try and figure out which libraries and symbols are
    // available. IGNORE THESE and scroll to the very bottom of the build script output, past all
    // these errors, to see the actual issue.
    detector.set_verbose(true);
    detect_features(detector);

    // Emit cxx junk.
    // This allows "Rust to be used from C++"
    // This must come before autocxx so that cxx can emit its cxx.h header.
    let source_files = vec![
        "fish-rust/src/abbrs.rs",
        "fish-rust/src/ast.rs",
        "fish-rust/src/builtins/shared.rs",
        "fish-rust/src/common.rs",
        "fish-rust/src/complete.rs",
        "fish-rust/src/editable_line.rs",
        "fish-rust/src/env_dispatch.rs",
        "fish-rust/src/env/env_ffi.rs",
        "fish-rust/src/event.rs",
        "fish-rust/src/exec.rs",
        "fish-rust/src/expand.rs",
        "fish-rust/src/fd_monitor.rs",
        "fish-rust/src/fd_readable_set.rs",
        "fish-rust/src/fds.rs",
        "fish-rust/src/ffi_init.rs",
        "fish-rust/src/ffi_tests.rs",
        "fish-rust/src/fish_indent.rs",
        "fish-rust/src/fish_key_reader.rs",
        "fish-rust/src/fish.rs",
        "fish-rust/src/function.rs",
        "fish-rust/src/future_feature_flags.rs",
        "fish-rust/src/highlight.rs",
        "fish-rust/src/history.rs",
        "fish-rust/src/input_ffi.rs",
        "fish-rust/src/io.rs",
        "fish-rust/src/job_group.rs",
        "fish-rust/src/kill.rs",
        "fish-rust/src/operation_context.rs",
        "fish-rust/src/output.rs",
        "fish-rust/src/pager.rs",
        "fish-rust/src/parse_constants.rs",
        "fish-rust/src/parser.rs",
        "fish-rust/src/parse_tree.rs",
        "fish-rust/src/parse_util.rs",
        "fish-rust/src/print_help.rs",
        "fish-rust/src/proc.rs",
        "fish-rust/src/reader.rs",
        "fish-rust/src/redirection.rs",
        "fish-rust/src/screen.rs",
        "fish-rust/src/signal.rs",
        "fish-rust/src/smoke.rs",
        "fish-rust/src/termsize.rs",
        "fish-rust/src/threads.rs",
        "fish-rust/src/timer.rs",
        "fish-rust/src/tokenizer.rs",
        "fish-rust/src/trace.rs",
        "fish-rust/src/util.rs",
        "fish-rust/src/universal_notifier/mod.rs",
        "fish-rust/src/wildcard.rs",
    ];
    cxx_build::bridges(&source_files)
        .flag_if_supported("-std=c++11")
        .include(&cpp_fish_src_dir)
        .include(&fish_build_dir) // For config.h
        .include(&cxx_include_dir) // For cxx.h
        .flag("-Wno-comment")
        .compile("fish-rust");

    // Emit autocxx junk.
    // This allows "C++ to be used from Rust."
    let include_paths = [&cpp_fish_src_dir, &fish_build_dir, &cxx_include_dir];
    let mut builder = autocxx_build::Builder::new("fish-rust/src/ffi.rs", include_paths);
    // Use autocxx's custom output directory unless we're being called by `rust-analyzer` and co.,
    // in which case stick to the default target directory so code intelligence continues to work.
    if std::env::var("RUSTC_WRAPPER").map_or(true, |wrapper| {
        !(wrapper.contains("rust-analyzer") || wrapper.contains("intellij-rust-native-helper"))
    }) {
        // We need this reassignment because of how the builder pattern works
        builder = builder.custom_gendir(autocxx_gen_dir.into());
    }
    let mut b = builder.build().unwrap();
    b.flag_if_supported("-std=c++11")
        .flag("-Wno-comment")
        .compile("fish-rust-autocxx");
    rsconf::rebuild_if_paths_changed(&source_files);
}

/// Dynamically enables certain features at build-time, without their having to be explicitly
/// enabled in the `cargo build --features xxx` invocation.
///
/// This can be used to enable features that we check for and conditionally compile according to in
/// our own codebase, but [can't be used to pull in dependencies](0) even if they're gated (in
/// `Cargo.toml`) behind a feature we just enabled.
///
/// [0]: https://github.com/rust-lang/cargo/issues/5499
fn detect_features(target: Target) {
    for (feature, handler) in [
        // Ignore the first entry, it just sets up the type inference. Model new entries after the
        // second line.
        (
            "",
            &(|_: &Target| Ok(false)) as &dyn Fn(&Target) -> Result<bool, Box<dyn Error>>,
        ),
        ("bsd", &detect_bsd),
        ("gettext", &have_gettext),
    ] {
        match handler(&target) {
            Err(e) => rsconf::warn!("{}: {}", feature, e),
            Ok(true) => rsconf::enable_feature(feature),
            Ok(false) => (),
        }
    }
}

fn compiles(file: &str) -> bool {
    let mut command = cc::Build::new()
        .flag("-fsyntax-only")
        .get_compiler()
        .to_command();
    command.arg(file);
    command.stdout(Stdio::null());
    command.stderr(Stdio::null());
    command.status().unwrap().success()
}

/// Detect if we're being compiled for a BSD-derived OS, allowing targeting code conditionally with
/// `#[cfg(feature = "bsd")]`.
///
/// Rust offers fine-grained conditional compilation per-os for the popular operating systems, but
/// doesn't necessarily include less-popular forks nor does it group them into families more
/// specific than "windows" vs "unix" so we can conditionally compile code for BSD systems.
fn detect_bsd(_: &Target) -> Result<bool, Box<dyn Error>> {
    // Instead of using `uname`, we can inspect the TARGET env variable set by Cargo. This lets us
    // support cross-compilation scenarios.
    let mut target = std::env::var("TARGET").unwrap();
    if !target.chars().all(|c| c.is_ascii_lowercase()) {
        target = target.to_ascii_lowercase();
    }
    let result = target.ends_with("bsd") || target.ends_with("dragonfly");
    #[cfg(any(
        target_os = "dragonfly",
        target_os = "freebsd",
        target_os = "netbsd",
        target_os = "openbsd",
    ))]
    assert!(result, "Target incorrectly detected as not BSD!");
    Ok(result)
}

/// Detect libintl/gettext and its needed symbols to enable internationalization/localization
/// support.
fn have_gettext(target: &Target) -> Result<bool, Box<dyn Error>> {
    // The following script correctly detects and links against gettext, but so long as we are using
    // C++ and generate a static library linked into the C++ binary via CMake, we need to account
    // for the CMake option WITH_GETTEXT being explicitly disabled.
    rsconf::rebuild_if_env_changed("CMAKE_WITH_GETTEXT");
    if let Some(with_gettext) = std::env::var_os("CMAKE_WITH_GETTEXT") {
        if with_gettext.eq_ignore_ascii_case("0") {
            return Ok(false);
        }
    }

    // In order for fish to correctly operate, we need some way of notifying libintl to invalidate
    // its localizations when the locale environment variables are modified. Without the libintl
    // symbol _nl_msg_cat_cntr, we cannot use gettext even if we find it.
    let mut libraries = Vec::new();
    let mut found = 0;
    let symbols = ["gettext", "_nl_msg_cat_cntr"];
    for symbol in &symbols {
        // Historically, libintl was required in order to use gettext() and co, but that
        // functionality was subsumed by some versions of libc.
        if target.has_symbol_in::<&str>(symbol, &[]) {
            // No need to link anything special for this symbol
            found += 1;
            continue;
        }
        for library in ["intl", "gettextlib"] {
            if target.has_symbol(symbol, library) {
                libraries.push(library);
                found += 1;
                continue;
            }
        }
    }
    match found {
        0 => Ok(false),
        1 => Err(format!("gettext found but cannot be used without {}", symbols[1]).into()),
        _ => {
            rsconf::link_libraries(&libraries, LinkType::Default);
            Ok(true)
        }
    }
}