GORBIE 0.10.0

GORBIE! Is a minimalist notebook library for Rust.
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

use eframe::egui;
use egui_commonmark::CommonMarkCache;
use egui_commonmark::CommonMarkViewer;
use std::cell::Cell;
use std::cell::RefCell;

thread_local! {
    static GORBIE_MD_CACHE: RefCell<CommonMarkCache> = RefCell::new(CommonMarkCache::default());
    static GORBIE_MD_THEMES_INSTALLED: Cell<bool> = Cell::new(false);
}

const RAL_THEME_LIGHT: &str = "gorbie-ral-light";
const RAL_THEME_DARK: &str = "gorbie-ral-dark";
const RAL_THEME_LIGHT_BYTES: &[u8] = include_bytes!(concat!(
    env!("CARGO_MANIFEST_DIR"),
    "/assets/syntax/ral_light.tmTheme"
));
const RAL_THEME_DARK_BYTES: &[u8] = include_bytes!(concat!(
    env!("CARGO_MANIFEST_DIR"),
    "/assets/syntax/ral_dark.tmTheme"
));

fn ensure_ral_syntax_themes(cache: &mut CommonMarkCache) {
    GORBIE_MD_THEMES_INSTALLED.with(|installed| {
        if installed.get() {
            return;
        }
        if let Err(err) = cache.add_syntax_theme_from_bytes(RAL_THEME_LIGHT, RAL_THEME_LIGHT_BYTES)
        {
            log::warn!("failed to add RAL light syntax theme: {err}");
        }
        if let Err(err) = cache.add_syntax_theme_from_bytes(RAL_THEME_DARK, RAL_THEME_DARK_BYTES) {
            log::warn!("failed to add RAL dark syntax theme: {err}");
        }
        installed.set(true);
    });
}

/// Render a markdown string into the UI with RAL-themed syntax highlighting.
///
/// Uses a thread-local [`CommonMarkCache`] so repeated calls within the same
/// frame are cheap.
pub fn markdown(ui: &mut egui::Ui, text: &str) {
    // Use a thread-local cache (no locking) and render the formatted markdown.
    GORBIE_MD_CACHE.with(|c| {
        let mut cache = c.borrow_mut();
        ensure_ral_syntax_themes(&mut cache);
        CommonMarkViewer::new()
            .syntax_theme_light(RAL_THEME_LIGHT)
            .syntax_theme_dark(RAL_THEME_DARK)
            .show(ui, &mut cache, text);
    });
}

/// Render a formatted markdown string as a full-width grid cell.
///
/// Accepts `format!`-style arguments:
/// ```ignore
/// md!(ctx, "**Count:** {}", count);
/// ```
#[macro_export]
macro_rules! md {
    ($ctx:expr, $fmt:expr $(, $args:expr)*) => {
        {
            let text = format!($fmt $(, $args)*);
            $ctx.grid(|g| g.full(|ctx| ctx.markdown(&text)));
        }
    };
}