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