ublx 0.1.2

TUI to index once, enrich with metadata, and browse a flat snapshot in a 3-pane layout with multiple modes.
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

//! Terminal background control via OSC **11** (set) and **111** (reset).
//!
//! When page opacity is below [`OPACITY_SOLID_MIN`], [`sync_osc11_page_background`] writes OSC 11 so
//! the **default background** matches the active theme RGB and the configured opacity. Terminals that
//! support it composite that color with the window’s own transparency, so the desktop wallpaper can
//! show through. Opacity at or above that threshold sends OSC 111 instead, restoring the terminal’s
//! usual dynamic background handling (aligned with solid fills in the Ratatui layer).
//!
//! Payload shape comes from [`crate::config::Osc11BackgroundFormat`]: `rgba(r,g,b,a)` (default) or
//! `#RRGGBBAA`. Some terminals (notably `WezTerm`) handle `rgba(...)` reliably; plain `#RRGGBBAA` may be
//! ignored depending on build—prefer `rgba` if blending misbehaves.

use std::io::{self, Write};

use crate::config::Osc11BackgroundFormat;
use crate::themes;

/// Minimum opacity treated as fully solid (`1.0` within float drift). Also used for TUI background fills and chrome when opacity is below this threshold.
pub const OPACITY_SOLID_MIN: f32 = 1.0 - 1e-4;

/// `true` when `v` counts as full opacity (omit from overlay, show as `1` in settings) — matches [`OPACITY_SOLID_MIN`].
#[inline]
#[must_use]
pub fn opacity_is_solid(v: f32) -> bool {
    v >= OPACITY_SOLID_MIN
}

/// Sync OSC 11 with page opacity: solid (`opacity` ≥ ~1) resets dynamic background; otherwise sets
/// `rgba(r,g,b,a)` from the active theme’s [`themes::Palette::background`].
///
/// `format`: config `opacity_format` (`rgba` default, `hex8` for `#RRGGBBAA`).
///
/// # Errors
///
/// Returns [`std::io::Error`] if writing or flushing **stdout** fails (broken pipe, etc.).
pub fn sync_osc11_page_background(
    theme_name: Option<&str>,
    opacity: f32,
    format: Osc11BackgroundFormat,
) -> io::Result<()> {
    let mut out = io::stdout();
    if opacity >= OPACITY_SOLID_MIN {
        return reset_osc_dynamic_background(&mut out);
    }
    let name = themes::theme_name_from_config(theme_name);
    let palette = themes::get(Some(name));
    let payload: Option<String> = match format {
        Osc11BackgroundFormat::Rgba => {
            themes::color_to_osc11_rgba_payload(palette.background, opacity)
        }
        Osc11BackgroundFormat::Hex8 => themes::color_to_osc11_hex8(palette.background, opacity),
    };
    let Some(payload) = payload else {
        return reset_osc_dynamic_background(&mut out);
    };
    write_osc11_background_payload(&mut out, &payload)
}

/// Set dynamic background via OSC 11 (`;` + payload, e.g. `rgba(10,25,47,0.1)`).
///
/// # Errors
///
/// Returns [`std::io::Error`] if the writer returns an error or [`Write::flush`] fails.
pub fn write_osc11_background_payload(w: &mut impl Write, payload: &str) -> io::Result<()> {
    write!(w, "\x1b]11;{payload}\x07")?;
    w.flush()
}

/// Reset dynamic text background (OSC 111). Pair with [`write_osc11_background_payload`].
///
/// # Errors
///
/// Returns [`std::io::Error`] if the writer returns an error or [`Write::flush`] fails.
pub fn reset_osc_dynamic_background(w: &mut impl Write) -> io::Result<()> {
    write!(w, "\x1b]111\x07")?;
    w.flush()
}