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
120
121
122

//! Nice QSym² output formatting.

use std::fmt;

use log;

const QSYM2_BANNER_LENGTH: usize = 103;

/// Logs an error to the `qsym2-output` logger.
macro_rules! qsym2_error {
    ($fmt:expr $(, $($arg:tt)*)?) => {
        log::error!($fmt, $($($arg)*)?);
        log::error!(target: "qsym2-output", $fmt, $($($arg)*)?);
    }
}

/// Logs a warning to the `qsym2-output` logger.
macro_rules! qsym2_warn {
    ($fmt:expr $(, $($arg:tt)*)?) => { log::warn!(target: "qsym2-output", $fmt, $($($arg)*)?); }
}

/// Logs a main output line to the `qsym2-output` logger.
macro_rules! qsym2_output {
    ($fmt:expr $(, $($arg:tt)*)?) => { log::info!(target: "qsym2-output", $fmt, $($($arg)*)?); }
}

pub(crate) use {qsym2_error, qsym2_output, qsym2_warn};

/// Writes a nicely formatted section title.
pub(crate) fn write_title(f: &mut fmt::Formatter<'_>, title: &str) -> fmt::Result {
    let length = title.chars().count().max(QSYM2_BANNER_LENGTH - 6);
    let bar = "─".repeat(length);
    writeln!(f, "┌──{bar}──┐")?;
    writeln!(f, "│§ {title:^length$} §│")?;
    writeln!(f, "└──{bar}──┘")?;
    Ok(())
}

/// Logs a nicely formatted section title to the `qsym2-output` logger.
pub(crate) fn log_title(title: &str) {
    let length = title.chars().count().max(QSYM2_BANNER_LENGTH - 6);
    let bar = "─".repeat(length);
    qsym2_output!("┌──{bar}──┐");
    qsym2_output!("│§ {title:^length$} §│");
    qsym2_output!("└──{bar}──┘");
}

/// Writes a nicely formatted subtitle.
pub(crate) fn write_subtitle(f: &mut fmt::Formatter<'_>, subtitle: &str) -> fmt::Result {
    let length = subtitle.chars().count();
    let bar = "═".repeat(length);
    writeln!(f, "{subtitle}")?;
    writeln!(f, "{bar}")?;
    Ok(())
}

/// Logs a nicely formatted subtitle to the `qsym2-output` logger.
pub(crate) fn log_subtitle(subtitle: &str) {
    let length = subtitle.chars().count();
    let bar = "═".repeat(length);
    qsym2_output!("{}", subtitle);
    qsym2_output!("{}", bar);
}

/// Logs a nicely formatted macro-section beginning to the `qsym2-output` logger.
pub(crate) fn log_macsec_begin(sectitle: &str) {
    let width = QSYM2_BANNER_LENGTH - 14;
    let sectitle_space = sectitle.to_string() + " ";
    qsym2_output!("❬❬❬❬❬ [Begin] {sectitle_space:❬<width$}");
}

/// Logs a nicely formatted macro-section ending to the `qsym2-output` logger.
pub(crate) fn log_macsec_end(sectitle: &str) {
    let width = QSYM2_BANNER_LENGTH - 14;
    let sectitle_space = sectitle.to_string() + " ";
    qsym2_output!("❭❭❭❭❭ [ End ] {sectitle_space:❭<width$}");
}

/// Logs a nicely formatted micro-section beginning to the `qsym2-output` logger.
pub(crate) fn log_micsec_begin(sectitle: &str) {
    let width = QSYM2_BANNER_LENGTH - 14;
    let sectitle_space = sectitle.to_string() + " ";
    qsym2_output!("‹‹‹‹‹ [Begin] {sectitle_space:‹<width$}");
}

/// Logs a nicely formatted micro-section ending to the `qsym2-output` logger.
pub(crate) fn log_micsec_end(sectitle: &str) {
    let width = QSYM2_BANNER_LENGTH - 14;
    let sectitle_space = sectitle.to_string() + " ";
    qsym2_output!("››››› [ End ] {sectitle_space:›<width$}");
}

/// Turns a boolean into a string of `yes` or `no`.
pub(crate) fn nice_bool(b: bool) -> String {
    if b {
        "yes".to_string()
    } else {
        "no".to_string()
    }
}

/// A trait for logging `QSym2` outputs nicely.
pub(crate) trait QSym2Output: fmt::Debug + fmt::Display {
    /// Logs display output nicely.
    fn log_output_display(&self) {
        let lines = self.to_string();
        lines.lines().for_each(|line| {
            qsym2_output!("{line}");
        })
    }

    /// Logs debug output nicely.
    fn log_output_debug(&self) {
        let lines = format!("{self:?}");
        lines.lines().for_each(|line| {
            qsym2_output!("{line}");
        })
    }
}

// Blanket implementation
impl<T> QSym2Output for T where T: fmt::Debug + fmt::Display {}