devela 0.27.0

A development layer of coherence.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

// devela::build::namespace
//
//! Defines the [`Build`] namespace.
//
// TOC
// - directories
// - print
// - other

use std::{env, fmt, path::PathBuf};

#[doc = crate::_TAG_NAMESPACE!()] // NOTE: use tag directly to work from /build
/// Build-related operations.
#[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
#[derive(Debug)]
pub struct Build;

impl Build {
    /// Returns the current crate's name.
    pub fn crate_name() -> String {
        env::var("CARGO_CRATE_NAME").expect("CARGO_CRATE_NAME not set")
    }

    /* directories */

    /// Retuns the path of `OUT_DIR`.
    pub fn out_dir() -> PathBuf {
        PathBuf::from(env::var("OUT_DIR").expect("OUT_DIR not set"))
    }

    /// Retuns the path of `CARGO_MANIFEST_DIR`.
    pub fn manifest_dir() -> PathBuf {
        PathBuf::from(env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR not set"))
    }

    /// Retuns the path of `CARGO_MANIFEST_PATH`.
    pub fn manifest_path() -> PathBuf {
        PathBuf::from(env::var("CARGO_MANIFEST_PATH").expect("CARGO_MANIFEST_PATH not set"))
    }

    /* print */

    /// Prints a message to *stdout* from the build script.
    pub fn println(msg: impl fmt::Display) {
        println!("cargo:warning={}", msg);
    }

    /// Prints a heading message to *stdout*, underlined.
    pub fn println_heading(msg: &str) {
        Self::println("");
        Self::println(msg);
        Self::println("-".repeat(msg.len()));
    }

    /// Prints the value of an environment variable.
    pub fn println_var(var: &str) {
        if let Ok(v) = env::var(var) {
            Self::println(fmt::from_fn(|f| write!(f, "· {var}: {v}")));
        } else {
            Self::println(fmt::from_fn(|f| write!(f, "x {var}:")));
        }
    }
    /// Prints the value of an encoded environment variable,
    /// replacing unit separator characters `'0x1f'` with spaces.
    ///
    /// It accepts a new name to show for the decoded variable.
    pub fn println_var_encoded(var: &str, new_var_name: &str) {
        if let Ok(ev) = env::var(var) {
            let v = ev.replace('\x1f', " ");
            Self::println(format!["· {new_var_name}(*): {v}"]);
        } else {
            Self::println(format!["x {new_var_name}:"]);
        }
    }

    /// Prints the build script `start` or end message to *stdout*.
    pub fn println_start_end(name: &str, start: bool) {
        let msg = if start {
            format!("~ Start of {name} ~")
        } else {
            Self::println("");
            format!("~ End of {name} ~")
        };
        let line = "~".repeat(msg.len());
        Self::println(&line);
        Self::println(&msg);
        Self::println(&line);
    }
}

// RETHINK IMPROVE
#[rustfmt::skip]
impl Build {
    /// `n` tabs, `n`*4 spaces.
    pub const fn tab(n: usize) -> &'static str {
        match n {
            0 => "",
            1 => "    ",
            2 => "        ",
            3 => "            ",
            4 => "                ",
            5 => "                    ",
            6 => "                        ",
            7 => "                            ",
            8 => "                                ",
            _ => "                                    ",
        }
    }
    #[doc = "0 tabs, 0 spaces."]  pub const TAB0: &str = "";
    #[doc = "1 tabs, 4 spaces."]  pub const TAB1: &str = "    ";
    #[doc = "2 tabs, 8 spaces."]  pub const TAB2: &str = "        ";
    #[doc = "3 tabs, 12 spaces."] pub const TAB3: &str = "            ";
    #[doc = "4 tabs, 16 spaces."] pub const TAB4: &str = "                ";
    #[doc = "5 tabs, 20 spaces."] pub const TAB5: &str = "                    ";
    #[doc = "6 tabs, 24 spaces."] pub const TAB6: &str = "                        ";
    #[doc = "7 tabs, 28 spaces."] pub const TAB7: &str = "                            ";
    #[doc = "8 tabs, 32 spaces."] pub const TAB8: &str = "                                ";
    #[doc = "9 tabs, 36 spaces."] pub const TAB9: &str = "                                    ";
}