rambo 0.1.1

A tool to map ROM collateral damage
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

//! Generic 1-KiB-cell, 64-column heatmap.
//!
//! Every diagnostic renders a colored grid where each cell summarizes
//! a small chunk of memory. The grid is always 64 columns wide; one
//! visual row is therefore `64 * cell_bytes` of address space, so the
//! row address marches up by a constant per line and the layout stays
//! easy to scan.
//!
//! Callers supply a closure that turns a cell index into a color
//! (`owo_colors::Style`-friendly) — the cell-bytes-to-words math and
//! row/column layout live here so they don't have to be repeated.

use owo_colors::OwoColorize;

/// One colored cell glyph for a heatmap.
pub enum CellColor {
    Green,
    Red,
    Yellow,
    Magenta,
    Blue,
}

impl CellColor {
    fn paint(&self, glyph: &str) -> String {
        match self {
            CellColor::Green => glyph.green().to_string(),
            CellColor::Red => glyph.red().to_string(),
            CellColor::Yellow => glyph.yellow().to_string(),
            CellColor::Magenta => glyph.magenta().to_string(),
            CellColor::Blue => glyph.blue().to_string(),
        }
    }
}

/// Print a 64-column heatmap covering `[start, start + n_cells * cell_bytes)`.
///
/// The caller's `color` closure receives the 0-based cell index and
/// returns the color for that cell. Cell index `i` corresponds to the
/// byte range `[start + i*cell_bytes, start + (i+1)*cell_bytes)`.
///
/// The function prints:
/// 1. A blank line then the heading.
/// 2. A column ruler every 8 columns.
/// 3. `n_rows = ceil(n_cells / 64)` rows of glyphs, each row prefixed
///    by the byte address of the first cell in the row.
pub fn render(
    title: &str,
    subtitle: &str,
    start: u32,
    cell_bytes: u32,
    n_cells: usize,
    color: impl Fn(usize) -> CellColor,
) {
    const COLS: usize = 64;
    if crate::render::is_quiet() {
        return;
    }
    let row_bytes = COLS as u32 * cell_bytes;
    let n_rows = n_cells.div_ceil(COLS);

    println!();
    println!("{} {}", bold(title), dim(subtitle));

    // Column ruler. The 12 leading spaces line up with the row-address
    // prefix `"0x20000000 │ "`.
    print!("            ");
    for col in 0..COLS {
        if col % 8 == 0 {
            print!("{}", dim(&format!("{col:<8}")));
        }
    }
    println!();

    for row in 0..n_rows {
        let row_addr = start + (row as u32) * row_bytes;
        print!(
            "{} {} ",
            dim(&format!("0x{row_addr:08X}")),
            bright_black("│")
        );
        for col in 0..COLS {
            let cell = row * COLS + col;
            if cell >= n_cells {
                print!(" ");
                continue;
            }
            print!("{}", color(cell).paint("█"));
        }
        println!();
    }
}

/// Print a single legend line. Each entry is `(color, label)`.
pub fn legend(entries: &[(CellColor, &str)]) {
    if crate::render::is_quiet() {
        return;
    }
    print!("  Legend: ");
    for (i, (c, label)) in entries.iter().enumerate() {
        if i > 0 {
            print!("    ");
        }
        print!("{} {}", c.paint("█"), label);
    }
    println!();
}

// Small wrappers that keep the call sites short and consistent.
fn bold(s: &str) -> String {
    s.bold().to_string()
}
fn dim(s: &str) -> String {
    s.dimmed().to_string()
}
fn bright_black(s: &str) -> String {
    s.bright_black().to_string()
}