Merge pull request #1246 from squidowl/dim-server-messages

Author: andymandias

CHANGELOG.md

@@ -9,7 +9,7 @@ Added:
 - Support for USERINFO CTCP query
 - Configurable anti-flood protection for servers that do not advertise SAFERATE
 - Channel modes will be retrieved on joining a channel (to be shown in the pane title bar)
-- Display own nickname next to text input field
+- Server messages can be dimmed (enabled by default), to lessen their visual impact relative to user messages
 
 Fixed:
 

book/src/configuration/buffer.md

@@ -752,6 +752,19 @@ If you pass `["#halloy"]`, the channel `#halloy` will receive the server message
 include = ["#halloy"]
 ```
 
+### `dimmed`
+
+Dim condensed server message.  Either automatically, based on text/background colors (by setting to `true`), or specify a dimming value in the range `0.0` (transparent) to `1.0` (no dimming).
+
+```toml
+# Type: bool or float
+# Values: true, false, or float
+# Default: true
+
+[buffer.server_messages.<server_message>]
+dimmed = true
+```
+
 ### `username_format`
 
 Adjust the amount of information displayed for a username in server messages. If you choose `"short"`, only the nickname will be shown. If you choose `"full"`, the nickname, username, and hostname (if available) will be displayed.
@@ -800,7 +813,7 @@ Dim condensed messages.  Either automatically, based on text/background colors (
 ```toml
 # Type: bool or float
 # Values: true, false, or float
-# Default: false
+# Default: true
 
 [buffer.server_messages.condense]
 dimmed = true

data/src/config/buffer.rs

@@ -259,9 +259,15 @@ impl ServerMessages {
             source::server::Kind::ChangeTopic => Some(&self.change_topic),
         }
     }
+
+    pub fn dimmed(&self, server: Option<&source::Server>) -> Option<&Dimmed> {
+        server.and_then(|server| {
+            self.get(server).and_then(|kind| kind.dimmed.as_ref())
+        })
+    }
 }
 
-#[derive(Debug, Default, Clone, Deserialize)]
+#[derive(Debug, Clone, Deserialize)]
 #[serde(default)]
 pub struct Condensation {
     pub messages: HashSet<CondensationMessage>,
@@ -270,6 +276,16 @@ pub struct Condensation {
     pub dimmed: Option<Dimmed>,
 }
 
+impl Default for Condensation {
+    fn default() -> Self {
+        Self {
+            messages: HashSet::new(),
+            format: CondensationFormat::default(),
+            dimmed: Some(Dimmed(None)),
+        }
+    }
+}
+
 impl Condensation {
     pub fn kind(&self, server: &source::Server) -> bool {
         match server.kind() {
@@ -328,6 +344,8 @@ pub struct ServerMessage {
     pub username_format: UsernameFormat,
     pub exclude: Vec<String>,
     pub include: Vec<String>,
+    #[serde(deserialize_with = "deserialize_dimmed_maybe")]
+    pub dimmed: Option<Dimmed>,
 }
 
 impl Default for ServerMessage {
@@ -338,6 +356,7 @@ impl Default for ServerMessage {
             username_format: UsernameFormat::default(),
             exclude: Vec::default(),
             include: Vec::default(),
+            dimmed: Some(Dimmed(None)),
         }
     }
 }

src/buffer/message_view.rs

@@ -1,9 +1,8 @@
 use data::config::buffer::nickname::ShownStatus;
 use data::isupport::{CaseMap, PrefixMap};
 use data::server::Server;
-use data::target::{self};
 use data::user::ChannelUsers;
-use data::{Config, User, message};
+use data::{Config, User, message, target};
 use iced::Color;
 use iced::advanced::text;
 use iced::widget::{column, container, row};
@@ -245,54 +244,79 @@ impl<'a> ChannelQueryLayout<'a> {
         max_nick_width: Option<f32>,
         server: Option<&'a message::source::Server>,
     ) -> (Element<'a, Message>, Element<'a, Message>) {
+        let formatter = *self;
+
+        let dimmed = formatter.config.buffer.server_messages.dimmed(server);
+
         let message_style = move |message_theme: &Theme| {
-            theme::selectable_text::server(message_theme, server)
+            let mut style =
+                theme::selectable_text::server(message_theme, server);
+
+            if let Some(dimmed) = dimmed {
+                style.color = style.color.map(|color| {
+                    dimmed.transform_color(
+                        color,
+                        formatter.theme.styles().buffer.background,
+                    )
+                });
+            }
+
+            style
         };
         let message_font_style = move |message_theme: &Theme| {
             theme::font_style::server(message_theme, server)
         };
+
         let marker = message_marker(
             max_nick_width,
             self.theme,
             message_style,
             message_font_style,
         );
 
-        let fm = *self;
         let message_content = message_content::with_context(
             &message.content,
-            fm.chantypes,
-            fm.casemapping,
+            formatter.chantypes,
+            formatter.casemapping,
             self.theme,
             Message::Link,
             message_style,
             message_font_style,
-            Option::<fn(Color) -> Color>::None,
+            Some(|color: Color| -> Color {
+                if let Some(dimmed) = dimmed {
+                    dimmed.transform_color(
+                        color,
+                        formatter.theme.styles().buffer.background,
+                    )
+                } else {
+                    color
+                }
+            }),
             move |link| match link {
                 message::Link::User(_) => context_menu::Entry::user_list(
-                    fm.target.is_channel(),
-                    fm.target.our_user(),
+                    formatter.target.is_channel(),
+                    formatter.target.our_user(),
                 ),
                 message::Link::Url(_) => context_menu::Entry::url_list(),
                 _ => vec![],
             },
             move |link, entry, length| {
                 let user = link.user();
                 let current_user = user.and_then(|u| {
-                    fm.target.users().and_then(|users| users.resolve(u))
+                    formatter.target.users().and_then(|users| users.resolve(u))
                 });
 
                 entry
                     .view(
-                        fm.server,
-                        fm.prefix,
-                        fm.target.channel(),
+                        formatter.server,
+                        formatter.prefix,
+                        formatter.target.channel(),
                         user,
                         current_user,
                         link.url(),
                         length,
-                        fm.config,
-                        fm.theme,
+                        formatter.config,
+                        formatter.theme,
                     )
                     .map(Message::ContextMenu)
             },