colorant 0.8.0

Per-directory terminal theme switcher with system dark/light mode support
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

//! OSC (Operating System Command) escape sequence emitter.
//!
//! These sequences are the standard xterm-flavored mechanism for setting and
//! resetting terminal colors at runtime. Every modern terminal supports them
//! to some degree — colorant currently drives Ghostty, iTerm2, and WezTerm;
//! Kitty and Alacritty are protocol-compatible and gated only on detection
//! (see [`super::utils::detect`]).
//!
//! Sequences used:
//! - `OSC 10 ; #rrggbb BEL` — set default foreground
//! - `OSC 11 ; #rrggbb BEL` — set default background
//! - `OSC 12 ; #rrggbb BEL` — set cursor color
//! - `OSC 4 ; N ; #rrggbb BEL` — set palette entry N (0..15)
//! - `OSC 110 BEL` / `OSC 111 BEL` / `OSC 112 BEL` — reset fg/bg/cursor
//! - `OSC 104 ; N BEL` — reset palette entry N
//!
//! Terminal-specific (iTerm2 only, via OSC 1337):
//! - `OSC 1337 ; SetColors=tab=rrggbb BEL` — set tab background color
//!   (6 hex chars, no `#`). iTerm2 derives tab text color from contrast,
//!   so there is no companion `tab_fg`.
//! - `OSC 1337 ; SetColors=tab=default BEL` — reset tab color to profile
//!   default.
//!
//! When running inside tmux (detected via `$TMUX`), each sequence is wrapped
//! in tmux's DCS passthrough so the outer terminal receives it verbatim —
//! tmux otherwise intercepts or filters most OSC sequences. For OSC 1337,
//! tmux additionally requires `set -g allow-passthrough on` in `tmux.conf`,
//! or the wrapped sequence is dropped before reaching iTerm2.

use super::utils::Terminal;
use crate::theme::model::ThemeLayer;
use std::io::Write;

/// Emit OSC sequences to set every populated field in `theme`. Unset fields
/// are left untouched. `terminal` gates terminal-specific emissions (today,
/// only iTerm2's tab-color escape).
pub fn emit<W: Write>(out: &mut W, terminal: Terminal, theme: &ThemeLayer) -> std::io::Result<()> {
    let in_tmux = std::env::var_os("TMUX").is_some();

    if let Some(c) = &theme.fg {
        write_osc(out, in_tmux, &format!("10;{}", c.as_str()))?;
    }
    if let Some(c) = &theme.bg {
        write_osc(out, in_tmux, &format!("11;{}", c.as_str()))?;
    }
    if let Some(c) = &theme.cursor {
        write_osc(out, in_tmux, &format!("12;{}", c.as_str()))?;
    }
    for (i, slot) in theme.palette.iter().enumerate() {
        if let Some(c) = slot {
            write_osc(out, in_tmux, &format!("4;{};{}", i, c.as_str()))?;
        }
    }
    if let Some(c) = &theme.tab_bg
        && let Some(payload) = tab_payload(terminal, c.as_str())
    {
        write_osc(out, in_tmux, &payload)?;
    }
    out.flush()
}

/// Emit OSC sequences resetting fg, bg, cursor, and all 16 palette entries.
/// Also resets the tab color on terminals that support one.
pub fn emit_reset<W: Write>(out: &mut W, terminal: Terminal) -> std::io::Result<()> {
    let in_tmux = std::env::var_os("TMUX").is_some();
    write_osc(out, in_tmux, "110")?;
    write_osc(out, in_tmux, "111")?;
    write_osc(out, in_tmux, "112")?;
    for i in 0..16 {
        write_osc(out, in_tmux, &format!("104;{}", i))?;
    }
    if let Some(payload) = tab_reset_payload(terminal) {
        write_osc(out, in_tmux, payload)?;
    }
    out.flush()
}

/// Emit only the tab-reset OSC for terminals that expose a tab-color knob.
/// Used by `apply` when `tab_follows_window` is enabled but the resolved
/// theme has no `bg` to derive from — without this, the tab color would
/// keep whatever the previous directory's apply left it as.
pub fn emit_tab_reset<W: Write>(out: &mut W, terminal: Terminal) -> std::io::Result<()> {
    if let Some(payload) = tab_reset_payload(terminal) {
        let in_tmux = std::env::var_os("TMUX").is_some();
        write_osc(out, in_tmux, payload)?;
        out.flush()?;
    }
    Ok(())
}

/// Build the terminal-specific tab-set payload, or `None` if the terminal
/// has no runtime tab-color knob. `hex` is `#rrggbb`; iTerm2's wire format
/// drops the leading `#`.
fn tab_payload(terminal: Terminal, hex: &str) -> Option<String> {
    match terminal {
        Terminal::ITerm2 => Some(format!(
            "1337;SetColors=tab={}",
            hex.trim_start_matches('#')
        )),
        Terminal::Ghostty | Terminal::WezTerm => None,
    }
}

/// Build the terminal-specific tab-reset payload, or `None` if the terminal
/// has no runtime tab-color knob. Returned as a `&'static str` so the reset
/// path never allocates.
fn tab_reset_payload(terminal: Terminal) -> Option<&'static str> {
    match terminal {
        Terminal::ITerm2 => Some("1337;SetColors=tab=default"),
        Terminal::Ghostty | Terminal::WezTerm => None,
    }
}

/// Write a single OSC payload, wrapping in tmux DCS passthrough if needed.
fn write_osc<W: Write>(out: &mut W, in_tmux: bool, payload: &str) -> std::io::Result<()> {
    if in_tmux {
        // tmux DCS passthrough: ESC P tmux ; ESC <doubled-ESC-payload> ESC \
        // Each ESC inside the inner payload must be doubled. Our inner payload
        // is `ESC ] <payload> BEL`, so we write the leading ESC as ESC ESC.
        write!(out, "\x1bPtmux;\x1b\x1b]{}\x07\x1b\\", payload)
    } else {
        write!(out, "\x1b]{}\x07", payload)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::theme::model::{HexColor, ThemeLayer};

    fn capture(theme: &ThemeLayer) -> String {
        let mut buf = Vec::new();
        // Test the no-tmux path directly to avoid env interactions.
        if let Some(c) = &theme.fg {
            write_osc(&mut buf, false, &format!("10;{}", c.as_str())).unwrap();
        }
        if let Some(c) = &theme.bg {
            write_osc(&mut buf, false, &format!("11;{}", c.as_str())).unwrap();
        }
        String::from_utf8(buf).unwrap()
    }

    #[test]
    fn emits_fg_and_bg() {
        let t = ThemeLayer {
            fg: Some(HexColor::parse("#cdd6f4").unwrap()),
            bg: Some(HexColor::parse("#1e1e2e").unwrap()),
            ..Default::default()
        };
        let s = capture(&t);
        assert!(s.contains("\x1b]10;#cdd6f4\x07"));
        assert!(s.contains("\x1b]11;#1e1e2e\x07"));
    }

    #[test]
    fn tmux_wraps_with_dcs() {
        let mut buf = Vec::new();
        write_osc(&mut buf, true, "10;#abcdef").unwrap();
        let s = String::from_utf8(buf).unwrap();
        assert!(s.starts_with("\x1bPtmux;\x1b\x1b]"));
        assert!(s.ends_with("\x07\x1b\\"));
    }

    #[test]
    fn tab_payload_strips_hash_for_iterm2() {
        assert_eq!(
            tab_payload(Terminal::ITerm2, "#abcdef").as_deref(),
            Some("1337;SetColors=tab=abcdef")
        );
    }

    #[test]
    fn tab_payload_is_none_for_ghostty() {
        assert!(tab_payload(Terminal::Ghostty, "#abcdef").is_none());
    }

    #[test]
    fn tab_payload_is_none_for_wezterm() {
        assert!(tab_payload(Terminal::WezTerm, "#abcdef").is_none());
    }

    #[test]
    fn tab_reset_payload_is_default_for_iterm2() {
        assert_eq!(
            tab_reset_payload(Terminal::ITerm2),
            Some("1337;SetColors=tab=default")
        );
    }

    #[test]
    fn tab_reset_payload_is_none_for_ghostty() {
        assert!(tab_reset_payload(Terminal::Ghostty).is_none());
    }

    #[test]
    fn tab_reset_payload_is_none_for_wezterm() {
        assert!(tab_reset_payload(Terminal::WezTerm).is_none());
    }
}