feat(tui): add support for named themes (#1779)

Author: fujiapple852

crates/trippy-tui/build.rs

@@ -1,3 +1,4 @@
 pub fn main() {
     println!("cargo:rerun-if-changed=locales.toml");
+    println!("cargo:rerun-if-changed=themes");
 }

crates/trippy-tui/src/config.rs

@@ -21,7 +21,7 @@ mod constants;
 mod file;
 mod theme;
 
-use crate::config::file::{ConfigBindings, ConfigTui};
+use crate::config::file::{ConfigBindings, ConfigThemeColors, ConfigTui};
 pub use binding::{TuiBindings, TuiCommandItem, TuiKeyBinding};
 pub use cmd::Args;
 pub use columns::{TuiColumn, TuiColumns};
@@ -253,6 +253,8 @@ pub enum TrippyAction {
     Trippy(Box<TrippyConfig>),
     /// Print all TUI theme items and exit.
     PrintTuiThemeItems,
+    /// Print all built-in TUI themes and exit.
+    PrintTuiThemes,
     /// Print all TUI commands that can be bound and exit.
     PrintTuiBindingCommands,
     /// Print a template toml config file and exit.
@@ -269,6 +271,8 @@ impl TrippyAction {
     pub fn from(args: Args, privilege: &Privilege, pid: u16) -> anyhow::Result<Self> {
         Ok(if args.print_tui_theme_items {
             Self::PrintTuiThemeItems
+        } else if args.print_tui_themes {
+            Self::PrintTuiThemes
         } else if args.print_tui_binding_commands {
             Self::PrintTuiBindingCommands
         } else if args.print_config_template {
@@ -551,6 +555,11 @@ impl TrippyConfig {
             .as_deref()
             .map(chrono_tz::Tz::from_str)
             .transpose()?;
+        let tui_theme = cfg_layer(
+            args.tui_theme,
+            cfg_file_tui.tui_theme,
+            String::from(constants::DEFAULT_TUI_THEME),
+        );
         let dns_lookup_as_info = cfg_layer_bool_flag(
             args.dns_lookup_as_info,
             cfg_file_dns.dns_lookup_as_info,
@@ -664,7 +673,10 @@ impl TrippyConfig {
             .tui_theme_colors
             .into_iter()
             .collect::<HashMap<TuiThemeItem, TuiColor>>();
-        let tui_theme = TuiTheme::from((tui_theme_items, cfg_file_tui_theme_colors));
+        let cli_tui_theme_colors = ConfigThemeColors::from(tui_theme_items);
+        let tui_theme = TuiTheme::for_name(&tui_theme)?
+            .overlay(&cfg_file_tui_theme_colors)
+            .overlay(&cli_tui_theme_colors);
         let tui_binding_items = args
             .tui_key_bindings
             .into_iter()
@@ -1569,11 +1581,13 @@ mod tests {
         compare(parse_config(cmd), expected);
     }
 
+    // TODO add --tui-theme tests
     #[test_case("trip example.com", Ok(cfg().tui_theme(TuiTheme::default()).build()); "default tui theme")]
     #[test_case("trip example.com --tui-theme-colors bg-color=red", Ok(cfg().tui_theme(TuiTheme { bg: TuiColor::Red, ..Default::default() }).build()); "custom tui theme named color")]
     #[test_case("trip example.com --tui-theme-colors bg-color=010203", Ok(cfg().tui_theme(TuiTheme { bg: TuiColor::Rgb(1, 2, 3), ..Default::default() }).build()); "custom tui theme hex color")]
     #[test_case("trip example.com --tui-theme-colors bg-color=#010203", Ok(cfg().tui_theme(TuiTheme { bg: TuiColor::Rgb(1, 2, 3), ..Default::default() }).build()); "custom tui theme hex color with hash prefix")]
     #[test_case("trip example.com --tui-theme-colors bg-color=red,text-color=blue", Ok(cfg().tui_theme(TuiTheme { bg: TuiColor::Red, text: TuiColor::Blue, ..Default::default() }).build()); "custom tui theme multiple")]
+    #[test_case("trip example.com --tui-theme foo", Err(anyhow!("error: invalid value 'foo' for '--tui-theme <TUI_THEME>': unknown theme: foo (available themes: light, trippy) For more information, try '--help'.")); "invalid tui theme name")]
     #[test_case("trip example.com --tui-theme-colors bg-color=0", Err(anyhow!("error: invalid value 'bg-color=0' for '--tui-theme-colors <TUI_THEME_COLORS>': unknown color: 0 For more information, try '--help'.")); "invalid tui theme truncated hex value")]
     #[test_case("trip example.com --tui-theme-colors bg-color=foo", Err(anyhow!("error: invalid value 'bg-color=foo' for '--tui-theme-colors <TUI_THEME_COLORS>': unknown color: foo For more information, try '--help'. ")); "invalid tui theme invalid named color")]
     #[test_case("trip example.com --tui-theme-colors foo-color=red", Err(anyhow!("error: invalid value 'foo-color=red' for '--tui-theme-colors <TUI_THEME_COLORS>': Matching variant not found For more information, try '--help'.")); "invalid tui theme invalid item")]
@@ -1669,6 +1683,7 @@ mod tests {
     #[test_case("trip --print-config-template", Ok(TrippyAction::PrintConfigTemplate); "print config template")]
     #[test_case("trip --print-tui-binding-commands", Ok(TrippyAction::PrintTuiBindingCommands); "print the tui binding commands")]
     #[test_case("trip --print-tui-theme-items", Ok(TrippyAction::PrintTuiThemeItems); "print the tui theme items")]
+    #[test_case("trip --print-tui-themes", Ok(TrippyAction::PrintTuiThemes); "print the tui themes")]
     #[test_case("trip --generate elvish", Ok(TrippyAction::PrintShellCompletions(Shell::Elvish)); "generate elvish shell completions")]
     #[test_case("trip --generate fish", Ok(TrippyAction::PrintShellCompletions(Shell::Fish)); "generate fish shell completions")]
     #[test_case("trip --generate powershell", Ok(TrippyAction::PrintShellCompletions(Shell::PowerShell)); "generate powershell shell completions")]

crates/trippy-tui/src/config/cmd.rs

@@ -3,7 +3,7 @@ use crate::config::theme::TuiThemeItem;
 use crate::config::{
     AddressFamilyConfig, AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, IcmpExtensionMode,
     LogFormat, LogSpanEvents, Mode, MultipathStrategyConfig, ProtocolConfig, TuiColor,
-    TuiKeyBinding,
+    TuiKeyBinding, TuiTheme,
 };
 use anyhow::anyhow;
 use clap::Parser;
@@ -18,7 +18,7 @@ use std::time::Duration;
 #[command(name = "trip", author, version, about, long_about = None, arg_required_else_help(true), styles=clap_cargo::style::CLAP_STYLING)]
 pub struct Args {
     /// A space delimited list of hostnames and IPs to trace
-    #[arg(required_unless_present_any(["print_tui_theme_items", "print_tui_binding_commands", "print_config_template", "generate", "generate_man", "print_locales"]), env = "TRIP_TARGETS")]
+    #[arg(required_unless_present_any(["print_tui_theme_items", "print_tui_themes", "print_tui_binding_commands", "print_config_template", "generate", "generate_man", "print_locales"]), env = "TRIP_TARGETS")]
     pub targets: Vec<String>,
 
     /// Config file
@@ -236,6 +236,10 @@ pub struct Args {
     #[arg(long, env = "TRIP_TUI_TIMEZONE")]
     pub tui_timezone: Option<String>,
 
+    /// The TUI theme [default: trippy]
+    #[arg(long, value_parser = parse_tui_theme, env = "TRIP_TUI_THEME")]
+    pub tui_theme: Option<String>,
+
     /// The TUI theme colors [item=color,item=color,..]
     #[arg(long, value_delimiter(','), value_parser = parse_tui_theme_color_value, env = "TRIP_TUI_THEME_COLORS")]
     pub tui_theme_colors: Vec<(TuiThemeItem, TuiColor)>,
@@ -244,6 +248,10 @@ pub struct Args {
     #[arg(long, env = "TRIP_PRINT_TUI_THEME_ITEMS")]
     pub print_tui_theme_items: bool,
 
+    /// Print all built-in TUI themes and exit
+    #[arg(long, env = "TRIP_PRINT_TUI_THEMES")]
+    pub print_tui_themes: bool,
+
     /// The TUI key bindings [command=key,command=key,..]
     #[arg(long, value_delimiter(','), value_parser = parse_tui_binding_value, env = "TRIP_TUI_KEY_BINDINGS")]
     pub tui_key_bindings: Vec<(TuiCommandItem, TuiKeyBinding)>,
@@ -302,6 +310,18 @@ fn parse_tui_theme_color_value(value: &str) -> anyhow::Result<(TuiThemeItem, Tui
     Ok((item, color))
 }
 
+fn parse_tui_theme(value: &str) -> anyhow::Result<String> {
+    let themes = TuiTheme::available();
+    if themes.contains(&value) {
+        Ok(value.to_string())
+    } else {
+        Err(anyhow!(
+            "unknown theme: {value} (available themes: {})",
+            themes.join(", ")
+        ))
+    }
+}
+
 fn parse_tui_binding_value(value: &str) -> anyhow::Result<(TuiCommandItem, TuiKeyBinding)> {
     let pos = value
         .find('=')

crates/trippy-tui/src/config/constants.rs

@@ -43,6 +43,9 @@ pub const DEFAULT_TUI_ADDRESS_MODE: AddressMode = AddressMode::Host;
 /// The default value for `tui-refresh-rate`.
 pub const DEFAULT_TUI_REFRESH_RATE: Duration = Duration::from_millis(100);
 
+/// The default value for `tui-theme`.
+pub const DEFAULT_TUI_THEME: &str = "trippy";
+
 /// The default value for `dns-resolve-method`.
 pub const DEFAULT_DNS_RESOLVE_METHOD: DnsResolveMethodConfig = DnsResolveMethodConfig::System;
 

crates/trippy-tui/src/config/file.rs

@@ -252,6 +252,7 @@ pub struct ConfigTui {
     pub tui_custom_columns: Option<String>,
     pub tui_locale: Option<String>,
     pub tui_timezone: Option<String>,
+    pub tui_theme: Option<String>,
     #[serde(rename = "tui-max-samples")]
     pub deprecated_tui_max_samples: Option<usize>,
     #[serde(rename = "tui-max-flows")]
@@ -272,14 +273,15 @@ impl Default for ConfigTui {
             tui_max_addrs: Some(super::constants::DEFAULT_TUI_MAX_ADDRS),
             tui_locale: None,
             tui_timezone: None,
+            tui_theme: Some(String::from(super::constants::DEFAULT_TUI_THEME)),
             geoip_mmdb_file: None,
             deprecated_tui_max_samples: None,
             deprecated_tui_max_flows: None,
         }
     }
 }
 
-#[derive(Debug, Eq, PartialEq, Deserialize)]
+#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Default)]
 #[serde(rename_all = "kebab-case", deny_unknown_fields)]
 #[expect(clippy::struct_field_names)]
 pub struct ConfigThemeColors {
@@ -323,58 +325,6 @@ pub struct ConfigThemeColors {
     pub info_bar_text_color: Option<TuiColor>,
 }
 
-impl Default for ConfigThemeColors {
-    fn default() -> Self {
-        let theme = super::theme::TuiTheme::default();
-        Self {
-            bg_color: Some(theme.bg),
-            border_color: Some(theme.border),
-            text_color: Some(theme.text),
-            tab_text_color: Some(theme.tab_text),
-            hops_table_header_bg_color: Some(theme.hops_table_header_bg),
-            hops_table_header_text_color: Some(theme.hops_table_header_text),
-            hops_table_row_active_text_color: Some(theme.hops_table_row_active_text),
-            hops_table_row_inactive_text_color: Some(theme.hops_table_row_inactive_text),
-            hops_table_row_active_selected_bg_color: Some(theme.hops_table_row_active_selected_bg),
-            hops_table_row_active_selected_text_color: Some(
-                theme.hops_table_row_active_selected_text,
-            ),
-            hops_table_row_inactive_selected_bg_color: Some(
-                theme.hops_table_row_inactive_selected_bg,
-            ),
-            hops_table_row_inactive_selected_text_color: Some(
-                theme.hops_table_row_inactive_selected_text,
-            ),
-            hops_chart_selected_color: Some(theme.hops_chart_selected),
-            hops_chart_unselected_color: Some(theme.hops_chart_unselected),
-            hops_chart_axis_color: Some(theme.hops_chart_axis),
-            frequency_chart_bar_color: Some(theme.frequency_chart_bar),
-            frequency_chart_text_color: Some(theme.frequency_chart_text),
-            flows_chart_bar_selected_color: Some(theme.flows_chart_bar_selected),
-            flows_chart_bar_unselected_color: Some(theme.flows_chart_bar_unselected),
-            flows_chart_text_current_color: Some(theme.flows_chart_text_current),
-            flows_chart_text_non_current_color: Some(theme.flows_chart_text_non_current),
-            samples_chart_color: Some(theme.samples_chart),
-            samples_chart_lost_color: Some(theme.samples_chart_lost),
-            help_dialog_bg_color: Some(theme.help_dialog_bg),
-            help_dialog_text_color: Some(theme.help_dialog_text),
-            settings_dialog_bg_color: Some(theme.settings_dialog_bg),
-            settings_tab_text_color: Some(theme.settings_tab_text),
-            settings_table_header_text_color: Some(theme.settings_table_header_text),
-            settings_table_header_bg_color: Some(theme.settings_table_header_bg),
-            settings_table_row_text_color: Some(theme.settings_table_row_text),
-            map_world_color: Some(theme.map_world),
-            map_radius_color: Some(theme.map_radius),
-            map_selected_color: Some(theme.map_selected),
-            map_info_panel_border_color: Some(theme.map_info_panel_border),
-            map_info_panel_bg_color: Some(theme.map_info_panel_bg),
-            map_info_panel_text_color: Some(theme.map_info_panel_text),
-            info_bar_bg_color: Some(theme.info_bar_bg),
-            info_bar_text_color: Some(theme.info_bar_text),
-        }
-    }
-}
-
 #[derive(Debug, Eq, PartialEq, Deserialize)]
 #[serde(rename_all = "kebab-case", deny_unknown_fields)]
 pub struct ConfigBindings {