irox-tools 0.10.3

Stuff that should have been in the Rust STL, but aren't
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

// SPDX-License-Identifier: MIT
// Copyright 2023 IROX Contributors
//

//!
//! List of some basic ANSI Console colors
//!

macro_rules! csi {
    () => {
        "\u{1B}["
    };
}

pub const DCS: &str = "\u{1B}P";
pub const CSI: &str = csi!();
pub const ST: &str = "\u{1B}\\";
pub const OSC: &str = "\u{1B}]";

macro_rules! sgr {
    ($($lit:expr)*) => {
        concat!(csi!(), $($lit,)* "m")
    };
}

macro_rules! def_item {
    ($name:ident,$value:expr) => {
        pub const $name: &str = $value;
    };
}

def_item!(FORMAT_RESET, sgr!(0));
def_item!(FORMAT_BOLD, sgr!(1));

def_item!(FORMAT_COLOR_FG_BLACK, sgr!(30));
def_item!(FORMAT_COLOR_FG_RED, sgr!(31));
def_item!(FORMAT_COLOR_FG_GREEN, sgr!(32));
def_item!(FORMAT_COLOR_FG_YELLOW, sgr!(33));
def_item!(FORMAT_COLOR_FG_BLUE, sgr!(34));
def_item!(FORMAT_COLOR_FG_MAGENTA, sgr!(35));
def_item!(FORMAT_COLOR_FG_CYAN, sgr!(36));
def_item!(FORMAT_COLOR_FG_WHITE, sgr!(37));
def_item!(FORMAT_COLOR_FG_DEFAULT, sgr!(39));

///
/// Creates a ANSI Terminal Foreground Color Code using the specified RGB values
/// ```
/// use irox_tools::format_fg_color;
/// pub const VARBL : &str = format_fg_color!(0x10,0x10,0x10);
///
/// assert_eq!("\u{1B}[38;2;16;16;16m", VARBL);
/// ```
#[macro_export]
macro_rules! format_fg_color {
    ($red:literal,$green:literal,$blue:literal) => {
        concat!("\u{1B}[38;2;", $red, ";", $green, ";", $blue, "m")
    };
}

def_item!(FORMAT_COLOR_BG_BLACK, sgr!(40));
def_item!(FORMAT_COLOR_BG_RED, sgr!(41));
def_item!(FORMAT_COLOR_BG_GREEN, sgr!(42));
def_item!(FORMAT_COLOR_BG_YELLOW, sgr!(43));
def_item!(FORMAT_COLOR_BG_BLUE, sgr!(44));
def_item!(FORMAT_COLOR_BG_MAGENTA, sgr!(45));
def_item!(FORMAT_COLOR_BG_CYAN, sgr!(46));
def_item!(FORMAT_COLOR_BG_WHITE, sgr!(47));
def_item!(FORMAT_COLOR_BG_DEFAULT, sgr!(49));

///
/// Creates a ANSI Terminal Background Color Code using the specified RGB values
/// ```
/// use irox_tools::format_bg_color;
/// pub const VARBL : &str = format_bg_color!(0x10,0x10,0x10);
///
/// assert_eq!("\u{1B}[48;2;16;16;16m", VARBL);
/// ```
#[macro_export]
macro_rules! format_bg_color {
    ($red:literal,$green:literal,$blue:literal) => {
        concat!("\u{1B}[48;2;", $red, ";", $green, ";", $blue, "m")
    };
}