Merge pull request #1728 from squidowl/feat/1693

Add `palette` support for nickname colors

Author: casperstorm

CHANGELOG.md

@@ -9,10 +9,12 @@ Added:
 - `buffer.server_messages.away` theme setting to control how automated away messages appear
 - Drafts are remembered across Halloy sessions. Can be disabled with `buffer.text_input.persist`
 - Animate typing dots
+- `buffer.nickname.color` now supports `{ palette = ["#RRGGBB", ...] }` for nickname colors from a fixed set
 
 Changed:
 
 - Moved `typing` settings from `buffer.channel.typing` to `buffer.typing` to clarify that they appliy to queries as well as channels
+- Moved nicklist nickname settings from `buffer.channel.nicklist` to `buffer.nickname` (`away` and `color`)
 
 Fixed:
 
@@ -25,6 +27,9 @@ Fixed:
 - `typing` settings for buffers could get in a stuck state without any way to control them
 - +typing=done should not be sent when the message is sent
 
+Removed:
+- `buffer.channel.message.nickname_color` in favor of `buffer.nickname.color`
+
 Thanks:
 
 - Contributions: @furudean, @omentic, @KaiKorla, @achille

data/src/appearance/theme.rs

@@ -546,6 +546,29 @@ pub fn randomize_color(original_color: Color, seed: &str) -> Color {
     from_hsl(randomized_hsl)
 }
 
+pub fn nickname_color(
+    original_color: Color,
+    kind: &crate::buffer::Color,
+    seed: Option<&str>,
+) -> Color {
+    match (kind, seed) {
+        (crate::buffer::Color::Solid, _) | (_, None) => original_color,
+        (crate::buffer::Color::Unique, Some(seed)) => {
+            randomize_color(original_color, seed)
+        }
+        (crate::buffer::Color::Palette(colors), Some(seed)) => {
+            if colors.is_empty() {
+                return original_color;
+            }
+
+            let index =
+                (seahash::hash(seed.as_bytes()) % colors.len() as u64) as usize;
+
+            colors[index]
+        }
+    }
+}
+
 pub fn to_hsl(color: Color) -> Okhsl {
     let mut hsl = Okhsl::from_color(to_rgb(color));
     if hsl.saturation.is_nan() {

data/src/buffer.rs

@@ -2,11 +2,13 @@ use core::fmt;
 use std::str::FromStr;
 
 use chrono::Locale;
+use iced_core::Color as IcedColor;
 use serde::{Deserialize, Deserializer, Serialize};
 
 pub mod timestamp;
 
 pub use self::timestamp::Timestamp;
+use crate::appearance::theme::hex_to_color;
 use crate::serde::deserialize_strftime_date;
 use crate::target::{self, Target};
 use crate::{Server, channel, config, message};
@@ -239,12 +241,56 @@ impl Brackets {
     }
 }
 
-#[derive(Debug, Clone, Copy, Default, Deserialize)]
-#[serde(rename_all = "kebab-case")]
+#[derive(Debug, Clone, Default)]
 pub enum Color {
     Solid,
     #[default]
     Unique,
+    Palette(Vec<IcedColor>),
+}
+
+impl<'de> Deserialize<'de> for Color {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        #[derive(Deserialize)]
+        #[serde(untagged)]
+        enum Repr {
+            String(String),
+            Palette { palette: Vec<String> },
+        }
+
+        match Repr::deserialize(deserializer)? {
+            Repr::String(value) => match value.as_str() {
+                "solid" => Ok(Self::Solid),
+                "unique" => Ok(Self::Unique),
+                _ => Err(serde::de::Error::custom(format!(
+                    "unknown color: {value}",
+                ))),
+            },
+            Repr::Palette { palette } => {
+                if palette.is_empty() {
+                    return Err(serde::de::Error::custom(
+                        "palette must contain at least one hex color",
+                    ));
+                }
+
+                let colors = palette
+                    .into_iter()
+                    .map(|hex| {
+                        hex_to_color(&hex).ok_or_else(|| {
+                            serde::de::Error::custom(format!(
+                                "invalid hex color in palette: {hex}",
+                            ))
+                        })
+                    })
+                    .collect::<Result<Vec<_>, _>>()?;
+
+                Ok(Self::Palette(colors))
+            }
+        }
+    }
 }
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize)]
@@ -287,6 +333,50 @@ impl Resize {
     }
 }
 
+#[cfg(test)]
+mod tests {
+    use super::Color;
+
+    #[derive(Debug, serde::Deserialize)]
+    struct Root {
+        color: Color,
+    }
+
+    #[test]
+    fn color_deserializes_palette() {
+        let root: Root = toml::from_str(
+            r##"color = { palette = ["#112233", "#445566", "#778899"] }"##,
+        )
+        .expect("valid palette color");
+
+        match root.color {
+            Color::Palette(colors) => assert_eq!(colors.len(), 3),
+            _ => panic!("expected palette color"),
+        }
+    }
+
+    #[test]
+    fn color_rejects_empty_palette() {
+        let err = toml::from_str::<Root>(r#"color = { palette = [] }"#)
+            .expect_err("empty palette should be rejected");
+
+        assert!(
+            err.to_string()
+                .contains("palette must contain at least one")
+        );
+    }
+
+    #[test]
+    fn color_rejects_invalid_palette_hex() {
+        let err = toml::from_str::<Root>(
+            r##"color = { palette = ["#112233", "not-a-color"] }"##,
+        )
+        .expect_err("invalid palette hex should be rejected");
+
+        assert!(err.to_string().contains("invalid hex color in palette"));
+    }
+}
+
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub enum SkinTone {

data/src/config/buffer/channel.rs

@@ -1,9 +1,8 @@
 use serde::Deserialize;
 
 use super::NicknameClickAction;
-use crate::buffer::Color;
 use crate::channel::Position;
-use crate::config::buffer::{AccessLevelFormat, Away};
+use crate::config::buffer::AccessLevelFormat;
 use crate::isupport;
 use crate::serde::deserialize_u32_positive_integer;
 
@@ -34,7 +33,6 @@ impl ChannelNameCasing {
 #[derive(Debug, Clone, Deserialize)]
 #[serde(default)]
 pub struct Message {
-    pub nickname_color: Color,
     pub show_emoji_reacts: bool,
     #[serde(deserialize_with = "deserialize_u32_positive_integer")]
     pub max_reaction_display: u32,
@@ -45,7 +43,6 @@ pub struct Message {
 impl Default for Message {
     fn default() -> Self {
         Self {
-            nickname_color: Color::default(),
             show_emoji_reacts: true,
             max_reaction_display: 5,
             max_reaction_chars: 64,
@@ -56,10 +53,8 @@ impl Default for Message {
 #[derive(Debug, Clone, Deserialize)]
 #[serde(default)]
 pub struct Nicklist {
-    pub away: Away,
     pub enabled: bool,
     pub position: Position,
-    pub color: Color,
     pub width: Option<f32>,
     pub alignment: Alignment,
     pub show_access_levels: AccessLevelFormat,
@@ -69,10 +64,8 @@ pub struct Nicklist {
 impl Default for Nicklist {
     fn default() -> Self {
         Self {
-            away: Away::default(),
             enabled: true,
             position: Position::default(),
-            color: Color::default(),
             width: None,
             alignment: Alignment::default(),
             show_access_levels: AccessLevelFormat::default(),

docs/configuration/buffer.md

@@ -79,19 +79,6 @@ channel_name_casing = "lowercase"
 
 Message settings within a channel buffer.
 
-#### `nickname_color`
-
-Nickname colors in the message. `"unique"` generates colors by randomizing the hue, while keeping the saturation and lightness from the theme's nickname color.
-
-```toml
-# Type: string
-# Values: "solid", "unique"
-# Default: "unique"
-
-[buffer.channel.message]
-nickname_color = "unique"
-```
-
 #### `show_emoji_reacts`
 
 Whether to display emoji reactions on messages (if [IRCv3 React](https://ircv3.net/specs/client-tags/react) is supported by the server).
@@ -150,39 +137,6 @@ Horizontal alignment of nicknames.
 alignment = "left"
 ```
 
-#### `away`
-
-Controls the appearance of away nicknames.
-
-```toml
-# Type: string or object
-# Values: "dimmed", "none" or { dimmed = float }
-# Default: "dimmed"
-[buffer.channel.nicklist]
-away = "dimmed"
-
-# with custom dimming alpha value (0.0-1.0)
-[buffer.channel.nicklist]
-away = { dimmed = 0.5 }
-
-# no away indication
-[buffer.channel.nicklist]
-away = "none"
-```
-
-#### `color`
-
-Nickname colors in the nicklist. `"unique"` generates colors by randomizing the hue, while keeping the saturation and lightness from the theme's nickname color.
-
-```toml
-# Type: string
-# Values: "solid", "unique"
-# Default: "unique"
-
-[buffer.channel.nicklist]
-color = "unique"
-```
-
 #### `enabled`
 
 Control if nicklist should be shown or not by default.
@@ -815,15 +769,18 @@ brackets = { left = "<", right = ">" }
 
 ### `color`
 
-Nickname colors in a channel buffer. `"unique"` generates colors by randomizing the hue, while keeping the saturation and lightness from the theme's nickname color.
+Nickname colors across nickname UI, including channel messages, nicklists, and nickname-related controls. `"unique"` generates colors by randomizing the hue, while keeping the saturation and lightness from the theme's nickname color. `{ palette = [...] }` assigns each nickname one of the provided hex colors.
 
 ```toml
-# Type: string
-# Values: "solid", "unique"
+# Type: string or object
+# Values: "solid", "unique", or { palette = ["#RRGGBB", ...] }
 # Default: "unique"
 
 [buffer.nickname]
 color = "unique"
+
+[buffer.nickname]
+color = { palette = ["#B11E3A", "#2A7FFF", "#1E9E5A"] }
 ```
 
 ### `offline`

src/appearance/theme/selectable_text.rs

@@ -123,9 +123,9 @@ pub fn server(
 pub fn nicklist_nickname(theme: &Theme, config: &Config, user: &User) -> Style {
     nickname_style(
         theme,
-        config.buffer.channel.nicklist.color,
+        &config.buffer.nickname.color,
         user,
-        config.buffer.channel.nicklist.away.is_away(user.is_away()),
+        config.buffer.nickname.away.is_away(user.is_away()),
         false,
     )
 }
@@ -138,7 +138,7 @@ pub fn nickname(
 ) -> Style {
     nickname_style(
         theme,
-        config.buffer.channel.message.nickname_color,
+        &config.buffer.nickname.color,
         user,
         config
             .buffer
@@ -155,28 +155,19 @@ pub fn topic_nickname(
     user: &User,
     is_offline: bool,
 ) -> Style {
-    nickname_style(
-        theme,
-        config.buffer.channel.message.nickname_color,
-        user,
-        None,
-        is_offline,
-    )
+    nickname_style(theme, &config.buffer.nickname.color, user, None, is_offline)
 }
 
 fn nickname_style(
     theme: &Theme,
-    kind: data::buffer::Color,
+    kind: &data::buffer::Color,
     user: &User,
     is_away: Option<buffer::Away>,
     is_offline: bool,
 ) -> Style {
-    let seed = match kind {
-        data::buffer::Color::Solid => None,
-        data::buffer::Color::Unique => Some(user.seed()),
-    };
-
-    let color = text::nickname(theme, seed, is_away, is_offline).color;
+    let color =
+        text::nickname(theme, kind, Some(user.seed()), is_away, is_offline)
+            .color;
 
     Style {
         color,

src/appearance/theme/text.rs

@@ -1,4 +1,4 @@
-use data::appearance::theme::randomize_color;
+use data::appearance::theme::nickname_color;
 use data::config::buffer;
 use iced::widget::text::{Catalog, Style, StyleFn};
 
@@ -96,9 +96,10 @@ pub fn url(theme: &Theme) -> Style {
     }
 }
 
-pub fn nickname<T: AsRef<str>>(
+pub fn nickname(
     theme: &Theme,
-    seed: Option<T>,
+    kind: &data::buffer::Color,
+    seed: Option<&str>,
     is_away: Option<buffer::Away>,
     is_offline: bool,
 ) -> Style {
@@ -121,14 +122,8 @@ pub fn nickname<T: AsRef<str>>(
 
     let nickname = theme.styles().buffer.nickname;
 
-    // If we have a seed we randomize the color based on the seed before adding any alpha value.
-    let color = match seed {
-        Some(seed) => calculate_alpha_color(randomize_color(
-            nickname.color,
-            seed.as_ref(),
-        )),
-        None => calculate_alpha_color(nickname.color),
-    };
+    let color =
+        calculate_alpha_color(nickname_color(nickname.color, kind, seed));
 
     Style { color: Some(color) }
 }