dirk_build 0.1.0

Build script utilities for DirkEngine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

#![doc = include_str!("../README.md")]

use std::{collections::HashMap, path::PathBuf};

/// Setup build for platform configuration.
/// Run this function in build.rs of a crate that
/// runs platform specific code.
pub fn configure_platform() {
    // declare the config keys for platform specific conditional compilation
    println!("cargo:rustc-check-cfg=cfg(platform_windows)");
    println!("cargo:rustc-check-cfg=cfg(platform_linux)");
    println!("cargo:rustc-check-cfg=cfg(platform_macos)");
    println!("cargo:rustc-check-cfg=cfg(platform_android)");
    println!("cargo:rustc-check-cfg=cfg(platform_ios)");
}

/// Returns the directory of the current cargo workspace
///
/// # Panics
///
/// Will panic if it fails to run `cargo metadata`
#[must_use]
pub fn workspace_dir() -> PathBuf {
    let metadata = cargo_metadata::MetadataCommand::new()
        .exec()
        .expect("failed to run cargo metadata");

    metadata.workspace_root.into_std_path_buf()
}

/// Will add usefull relative paths to the compilation env.
///
/// Paths can be added in the function body inserting them into the [`HashMap`]
pub fn setup_paths() {
    println!(
        "cargo:rustc-env=WORKSPACE_ROOT={}",
        workspace_dir().display()
    );

    let workspace_root = PathBuf::from(".");

    let mut paths = HashMap::new();
    paths.insert("SAVED_PATH", "saved");
    paths.insert("ASSETS_PATH", "assets");

    for (name, path) in paths {
        println!(
            "cargo:rustc-env={name}={}",
            workspace_root.join(path).display()
        );
    }
}