sentry-contrib-native-sys 0.3.1

#![warn(
    clippy::cargo,
    clippy::missing_docs_in_private_items,
    clippy::nursery,
    clippy::pedantic,
    missing_docs
)]

//!
//! - Warns if debug information isn't enabled.
//! - Looks for `SENTRY_NATIVE_INSTALL`.
//! - If `SENTRY_NATIVE_INSTALL` isn't found, compiles `sentry-native` for you.
//! - Exports path to `crashpad_handler(.exe)` as
//!   `DEP_SENTRY_NATIVE_CRASHPAD_HANDLER`.
//! - Links appropriate libraries.

use anyhow::Result;
use cmake::Config;
use std::{
    env, fs,
    path::{Path, PathBuf},
};

/// Represents used backend for `sentry-native`.
#[derive(Copy, Clone)]
enum Backend {
    /// Crashpad backend.
    Crashpad,
    /// Breakpad backend.
    Breakpad,
    /// In-process backend.
    InProc,
}

impl AsRef<str> for Backend {
    fn as_ref(&self) -> &str {
        match self {
            Self::Crashpad => "crashpad",
            Self::Breakpad => "breakpad",
            Self::InProc => "inproc",
        }
    }
}

impl Backend {
    /// Gets the backend we want to use, see <https://github.com/getsentry/sentry-native#compile-time-options>
    /// for details.
    #[allow(clippy::ifs_same_cond, clippy::same_functions_in_if_condition)]
    fn new(target_os: &str) -> Self {
        if cfg!(feature = "backend-crashpad")
            && (target_os == "linux" || target_os == "macos" || target_os == "windows")
        {
            Self::Crashpad
        } else if cfg!(feature = "backend-breakpad")
            && (target_os == "linux" || target_os == "macos" || target_os == "windows")
        {
            Self::Breakpad
        } else if cfg!(feature = "backend-inproc") {
            Self::InProc
        } else {
            match target_os {
                "windows" | "macos" | "linux" => Self::Crashpad,
                "android" => Self::InProc,
                _ => panic!("Unspported OS: {}", target_os),
            }
        }
    }
}

fn main() -> Result<()> {
    let target_os = env::var("CARGO_CFG_TARGET_OS")?;
    let backend = Backend::new(&target_os);

    // path to source.
    let source = PathBuf::from("sentry-native");

    // path to installation or to install to
    let install = if let Some(install) = env::var_os("SENTRY_NATIVE_INSTALL").map(PathBuf::from) {
        if fs::read_dir(&install)
            .ok()
            .and_then(|mut dir| dir.next())
            .is_none()
        {
            build(&source, Some(&install), backend, &target_os)?
        } else {
            install
        }
    } else {
        build(&source, None, backend, &target_os)?
    };

    println!("cargo:rerun-if-env-changed=SENTRY_NATIVE_INSTALL");

    if env::var("DEBUG")? == "false" {
        println!(
            "cargo:warning=not compiling with debug information, Sentry won't have source code access"
        );
    }

    // we need to check if there is a `lib64` instead of a `lib` dir, non-Debian
    // based distros will use that directory instead for 64-bit arches
    // see: https://cmake.org/cmake/help/v3.0/module/GNUInstallDirs.html
    let lib_dir = if install.join("lib64").exists() {
        "lib64"
    } else {
        "lib"
    };

    println!(
        "cargo:rustc-link-search={}",
        install.join(lib_dir).display()
    );
    println!("cargo:rustc-link-lib=sentry");

    match backend {
        Backend::Crashpad => {
            println!("cargo:rustc-link-lib=crashpad_client");
            println!("cargo:rustc-link-lib=crashpad_util");
            println!("cargo:rustc-link-lib=mini_chromium");

            let handler = if target_os == "windows" {
                "crashpad_handler.exe"
            } else {
                "crashpad_handler"
            };

            println!(
                "cargo:CRASHPAD_HANDLER={}",
                install.join("bin").join(handler).display()
            );
        }
        Backend::Breakpad => {
            println!("cargo:rustc-link-lib=breakpad_client");
        }
        Backend::InProc => {}
    }

    match target_os.as_str() {
        "windows" => {
            if cfg!(feature = "transport-default") {
                println!("cargo:rustc-link-lib=winhttp");
            }

            println!("cargo:rustc-link-lib=dbghelp");
            println!("cargo:rustc-link-lib=shlwapi");
            println!("cargo:rustc-link-lib=version");
        }
        "macos" => {
            if cfg!(feature = "transport-default") {
                println!("cargo:rustc-link-lib=curl");
            }

            println!("cargo:rustc-link-lib=framework=Foundation");
            println!("cargo:rustc-link-lib=dylib=c++");
        }
        "linux" => {
            if cfg!(feature = "transport-default") {
                println!("cargo:rustc-link-lib=curl");
            }

            println!("cargo:rustc-link-lib=dylib=stdc++");
        }
        "android" | "androideabi" => {
            println!("cargo:rustc-link-lib=unwindstack");
            println!("cargo:rustc-link-lib=c++_static");
        }
        other => unimplemented!("target platform {} not implemented", other),
    }

    Ok(())
}

/// Build `sentry_native` with `CMake`.
fn build(
    source: &Path,
    install: Option<&Path>,
    backend: Backend,
    target_os: &str,
) -> Result<PathBuf> {
    let mut cmake_config = Config::new(source);
    cmake_config
        .define("BUILD_SHARED_LIBS", "OFF")
        .define("SENTRY_BUILD_TESTS", "OFF")
        .define("SENTRY_BUILD_EXAMPLES", "OFF")
        .profile("RelWithDebInfo");

    let target_arch = env::var("CARGO_CFG_TARGET_ARCH")?;

    // fix CMake cross compile
    // see <https://github.com/alexcrichton/cmake-rs/issues/87> for details
    if target_os == "macos" {
        let host_arch = if cfg!(target_arch = "x86_64") {
            "x86_64"
        } else if cfg!(target_arch = "aarch64") {
            "aarch64"
        } else {
            panic!("Unspported OS")
        };

        if host_arch != target_arch {
            let target_arch = if target_arch == "aarch64" {
                "arm64"
            } else {
                &target_arch
            };
            cmake_config.define("CMAKE_OSX_ARCHITECTURES", target_arch);
        }
    }

    if let Some(install) = install {
        fs::create_dir_all(install).expect("failed to create install directory");
        cmake_config.out_dir(install);
    }

    if cfg!(feature = "transport-default") {
        if target_os == "android" || target_os == "androideabi" {
            cmake_config.define("SENTRY_TRANSPORT", "curl");
        }
    } else {
        cmake_config.define("SENTRY_TRANSPORT", "none");
    }

    cmake_config.define("SENTRY_BACKEND", backend.as_ref());

    if let Backend::Crashpad = backend {
        cmake_config.define("CRASHPAD_ZLIB_SYSTEM", "OFF");
    }

    if let Ok(true) = env::var("CARGO_CFG_TARGET_FEATURE").map(|var| var.contains("crt-static")) {
        cmake_config.define("SENTRY_BUILD_RUNTIMESTATIC", "ON");
    }

    // if we're targetting android, we need to set the CMAKE_TOOLCHAIN_FILE
    // which properly sets up the build environment, and we also need to set
    // ANDROID_ABI based on our target-triple
    // it seems there is not really a good standard for the NDK, so we try several
    // environment variables to find it
    // see https://developer.android.com/ndk/guides/cmake for details
    if target_os == "android" || target_os == "androideabi" {
        let ndk_root = env::var("ANDROID_NDK_ROOT")
            .or_else(|_| env::var("ANDROID_NDK_HOME"))
            .expect("unable to find ANDROID_NDK_ROOT nor ANDROID_NDK_HOME");

        let mut toolchain = PathBuf::from(ndk_root);
        toolchain.push("build/cmake/android.toolchain.cmake");

        if !toolchain.exists() {
            panic!(
                "Unable to find cmake toolchain file {}",
                toolchain.display()
            );
        }

        let abi = match target_arch.as_ref() {
            "aarch64" => "arm64-v8a",
            "arm" | "armv7" => "armeabi-v7a",
            "thumbv7neon" => "armeabi-v7a with NEON",
            "x86_64" => "x86_64",
            "i686" => "x86",
            arch => panic!("Unknown Android TARGET_ARCH: {}", arch),
        };

        cmake_config.define("CMAKE_TOOLCHAIN_FILE", toolchain);
        cmake_config.define("ANDROID_ABI", abi);
    }

    Ok(cmake_config.build())
}