Skip to main content

vtcode_commons/
color256_theme.rs

1//! Theme-aware 256-color helpers.
2//!
3//! The terminal 256-color palette can be "non-harmonious" on light themes when
4//! palette semantics are intentionally flipped for compatibility. In that mode,
5//! cube/gray indices need to be reflected to keep visual intent stable.
6
7use std::sync::atomic::{AtomicU8, Ordering};
8
9const HARMONIOUS_FALSE: u8 = 0;
10const HARMONIOUS_TRUE: u8 = 1;
11const HARMONIOUS_UNSET: u8 = 2;
12
13static RUNTIME_HARMONIOUS_HINT: AtomicU8 = AtomicU8::new(HARMONIOUS_UNSET);
14
15fn resolve_harmony(
16    is_light_theme: bool,
17    env_override: Option<bool>,
18    runtime_hint: Option<bool>,
19) -> bool {
20    env_override.or(runtime_hint).unwrap_or(!is_light_theme)
21}
22
23/// Determine harmony mode for the current theme.
24///
25/// Precedence:
26/// 1. `VTCODE_256_HARMONIOUS` environment override (`1/0`, `true/false`, `yes/no`, `on/off`)
27/// 2. Runtime hint (typically from OSC probe cached at startup)
28/// 3. Default behavior: light themes are treated as non-harmonious for compatibility.
29fn is_harmonious_for_theme(is_light_theme: bool) -> bool {
30    resolve_harmony(
31        is_light_theme,
32        harmonious_override(),
33        harmonious_runtime_hint(),
34    )
35}
36
37fn harmonious_runtime_hint() -> Option<bool> {
38    match RUNTIME_HARMONIOUS_HINT.load(Ordering::Relaxed) {
39        HARMONIOUS_TRUE => Some(true),
40        HARMONIOUS_FALSE => Some(false),
41        _ => None,
42    }
43}
44
45/// Store a runtime harmony hint.
46///
47/// This is intended to be populated once at startup by terminal OSC probing.
48/// Set `None` to clear the runtime hint.
49pub fn set_harmonious_runtime_hint(value: Option<bool>) {
50    let encoded = match value {
51        Some(true) => HARMONIOUS_TRUE,
52        Some(false) => HARMONIOUS_FALSE,
53        None => HARMONIOUS_UNSET,
54    };
55    RUNTIME_HARMONIOUS_HINT.store(encoded, Ordering::Relaxed);
56}
57
58/// Reflected gray-ramp index (maps `0..=23` onto `232..=255`).
59fn gray_index(level: u8) -> u8 {
60    232 + (23 - level.min(23))
61}
62
63/// Reflected cube index (maps `r,g,b` in `0..=5` onto `16..=231`).
64#[allow(clippy::cast_sign_loss)]
65fn cube_index(r: u8, g: u8, b: u8) -> u8 {
66    let r = r.min(5);
67    let g = g.min(5);
68    let b = b.min(5);
69
70    let max = r.max(g).max(b) as i16;
71    let min = r.min(g).min(b) as i16;
72    let offset = 5 - max - min;
73
74    let r = ((r as i16 + offset).clamp(0, 5)) as u8;
75    let g = ((g as i16 + offset).clamp(0, 5)) as u8;
76    let b = ((b as i16 + offset).clamp(0, 5)) as u8;
77
78    16 + 36 * r + 6 * g + b
79}
80
81/// Adjust an existing ANSI256 index for palette harmony.
82///
83/// - `16..=231` is treated as cube space.
84/// - `232..=255` is treated as grayscale ramp.
85/// - `0..=15` is left unchanged.
86fn adjust_index(index: u8, is_harmonious: bool) -> u8 {
87    if is_harmonious {
88        return index;
89    }
90
91    match index {
92        16..=231 => {
93            let adjusted = index - 16;
94            let r = adjusted / 36;
95            let g = (adjusted % 36) / 6;
96            let b = adjusted % 6;
97            cube_index(r, g, b)
98        }
99        232..=255 => gray_index(index - 232),
100        _ => index,
101    }
102}
103
104/// Adjust an ANSI256 index based on a light/dark theme hint.
105pub fn adjust_index_for_theme(index: u8, is_light_theme: bool) -> u8 {
106    adjust_index(index, is_harmonious_for_theme(is_light_theme))
107}
108
109/// Convert RGB to ANSI256 and apply theme-aware palette adjustment.
110pub fn rgb_to_ansi256_for_theme(r: u8, g: u8, b: u8, is_light_theme: bool) -> u8 {
111    let base_index = if r == g && g == b {
112        if r < 8 {
113            16
114        } else if r > 248 {
115            231
116        } else {
117            ((r as u16 - 8) / 10) as u8 + 232
118        }
119    } else {
120        let r_index = ((r as u16 * 5) / 255) as u8;
121        let g_index = ((g as u16 * 5) / 255) as u8;
122        let b_index = ((b as u16 * 5) / 255) as u8;
123        16 + 36 * r_index + 6 * g_index + b_index
124    };
125
126    adjust_index_for_theme(base_index, is_light_theme)
127}
128
129fn parse_bool(value: &str) -> Option<bool> {
130    match value.trim().to_ascii_lowercase().as_str() {
131        "1" | "true" | "yes" | "on" => Some(true),
132        "0" | "false" | "no" | "off" => Some(false),
133        _ => None,
134    }
135}
136
137fn harmonious_override() -> Option<bool> {
138    std::env::var("VTCODE_256_HARMONIOUS")
139        .ok()
140        .and_then(|value| parse_bool(&value))
141}
142
143#[cfg(test)]
144mod tests {
145    use super::*;
146
147    #[test]
148    fn harmonious_indices_are_identity() {
149        assert_eq!(adjust_index(16, true), 16);
150        assert_eq!(adjust_index(231, true), 231);
151        assert_eq!(adjust_index(232, true), 232);
152        assert_eq!(adjust_index(255, true), 255);
153        assert_eq!(adjust_index(194, true), 194);
154    }
155
156    #[test]
157    fn non_harmonious_gray_and_cube_reflect() {
158        assert_eq!(gray_index(0), 255);
159        assert_eq!(gray_index(23), 232);
160        assert_eq!(cube_index(0, 0, 0), 231);
161        assert_eq!(cube_index(5, 5, 5), 16);
162    }
163
164    #[test]
165    fn non_harmonious_adjusts_existing_indices() {
166        assert_eq!(adjust_index(194, false), 22);
167        assert_eq!(adjust_index(224, false), 52);
168        assert_eq!(adjust_index(233, false), 254);
169        assert_eq!(adjust_index(14, false), 14);
170    }
171
172    #[test]
173    fn rgb_to_ansi256_applies_theme_adjustment() {
174        assert_eq!(rgb_to_ansi256_for_theme(0, 0, 0, false), 16);
175        assert_eq!(rgb_to_ansi256_for_theme(0, 0, 0, true), 231);
176        assert_eq!(rgb_to_ansi256_for_theme(255, 255, 255, false), 231);
177        assert_eq!(rgb_to_ansi256_for_theme(255, 255, 255, true), 16);
178    }
179
180    #[test]
181    fn resolve_harmony_precedence_is_env_then_runtime_then_default() {
182        assert!(resolve_harmony(true, Some(true), Some(false)));
183        assert!(!resolve_harmony(false, Some(false), Some(true)));
184        assert!(resolve_harmony(true, None, Some(true)));
185        assert!(!resolve_harmony(true, None, None));
186        assert!(resolve_harmony(false, None, None));
187    }
188}