Refactor ChatLine username drawable creation

osu.Game.Tests/Visual/Online/TestSceneChatLink.cs

@@ -130,11 +130,11 @@ namespace osu.Game.Tests.Visual.Online
 
                     Color4 textColour = isAction && hasBackground ? Color4Extensions.FromHex(newLine.Message.Sender.Colour) : Color4.White;
 
-                    var linkCompilers = newLine.ContentFlow.Where(d => d is DrawableLinkCompiler).ToList();
+                    var linkCompilers = newLine.DrawableContentFlow.Where(d => d is DrawableLinkCompiler).ToList();
                     var linkSprites = linkCompilers.SelectMany(comp => ((DrawableLinkCompiler)comp).Parts);
 
                     return linkSprites.All(d => d.Colour == linkColour)
-                           && newLine.ContentFlow.Except(linkSprites.Concat(linkCompilers)).All(d => d.Colour == textColour);
+                           && newLine.DrawableContentFlow.Except(linkSprites.Concat(linkCompilers)).All(d => d.Colour == textColour);
                 }
             }
         }

osu.Game/Online/Chat/StandAloneChatDisplay.cs

@@ -189,7 +189,7 @@ namespace osu.Game.Online.Chat
 
         protected class StandAloneMessage : ChatLine
         {
-            protected override float TextSize => 15;
+            protected override float FontSize => 15;
             protected override float Spacing => 5;
             protected override float UsernameWidth => 75;
 

osu.Game/Overlays/Chat/ChatLine.cs

@@ -24,11 +24,15 @@ using osu.Game.Online.Chat;
 using osuTK;
 using osuTK.Graphics;
 using osu.Framework.Input.Events;
+using osu.Framework.Graphics.Sprites;
+using osu.Framework.Localisation;
 
 namespace osu.Game.Overlays.Chat
 {
     public class ChatLine : CompositeDrawable
     {
+        private Message message = null!;
+
         public Message Message
         {
             get => message;
@@ -45,55 +49,35 @@ namespace osu.Game.Overlays.Chat
             }
         }
 
-        public LinkFlowContainer ContentFlow { get; private set; } = null!;
+        public IReadOnlyCollection<Drawable> DrawableContentFlow => drawableContentFlow;
 
-        protected virtual float TextSize => 20;
+        protected virtual float FontSize => 20;
 
         protected virtual float Spacing => 15;
 
         protected virtual float UsernameWidth => 130;
 
-        private Color4 usernameColour;
-
-        private OsuSpriteText timestamp = null!;
-
-        private Message message = null!;
-
-        private OsuSpriteText username = null!;
-
-        private Drawable usernameColouredDrawable = null!;
-
-        private Container? highlight;
-
-        private readonly Bindable<bool> prefer24HourTime = new Bindable<bool>();
-
-        private bool senderHasColour => !string.IsNullOrEmpty(message.Sender.Colour);
-
-        private bool messageHasColour => Message.IsAction && senderHasColour;
-
         [Resolved]
         private ChannelManager? chatManager { get; set; }
 
         [Resolved]
-        private OsuColour colours { get; set; } = null!;
+        private OverlayColourProvider? colourProvider { get; set; }
+
+        private readonly OsuSpriteText drawableTimestamp;
+
+        private readonly DrawableUsername drawableUsername;
+
+        private readonly LinkFlowContainer drawableContentFlow;
+
+        private readonly Bindable<bool> prefer24HourTime = new Bindable<bool>();
+
+        private Container? highlight;
 
         public ChatLine(Message message)
         {
             Message = message;
             RelativeSizeAxes = Axes.X;
             AutoSizeAxes = Axes.Y;
-        }
-
-        [BackgroundDependencyLoader]
-        private void load(OverlayColourProvider? colourProvider, OsuConfigManager configManager)
-        {
-            usernameColour = senderHasColour
-                ? Color4Extensions.FromHex(message.Sender.Colour)
-                : username_colours[message.Sender.Id % username_colours.Length];
-
-            // this can be either the username sprite text or a container
-            // around it depending on which branch is taken in createUsername()
-            var usernameDrawable = createUsername();
 
             InternalChild = new GridContainer
             {
@@ -110,30 +94,24 @@ namespace osu.Game.Overlays.Chat
                 {
                     new Drawable[]
                     {
-                        timestamp = new OsuSpriteText
+                        drawableTimestamp = new OsuSpriteText
                         {
                             Shadow = false,
                             Anchor = Anchor.CentreLeft,
                             Origin = Anchor.CentreLeft,
-                            Font = OsuFont.GetFont(size: TextSize * 0.75f, weight: FontWeight.SemiBold, fixedWidth: true),
+                            Font = OsuFont.GetFont(size: FontSize * 0.75f, weight: FontWeight.SemiBold, fixedWidth: true),
-                            Colour = colourProvider?.Background1 ?? Colour4.White,
                             AlwaysPresent = true,
                         },
-                        new MessageSender(message.Sender, usernameColouredDrawable)
+                        drawableUsername = new DrawableUsername(message.Sender)
                         {
                             Width = UsernameWidth,
+                            FontSize = FontSize,
                             AutoSizeAxes = Axes.Y,
                             Origin = Anchor.TopRight,
                             Anchor = Anchor.TopRight,
-                            Child = usernameDrawable,
                             Margin = new MarginPadding { Horizontal = Spacing },
                         },
-                        ContentFlow = new LinkFlowContainer(t =>
+                        drawableContentFlow = new LinkFlowContainer(styleMessageContent)
-                        {
-                            t.Shadow = false;
-                            t.Font = t.Font.With(size: TextSize, italics: Message.IsAction);
-                            t.Colour = messageHasColour ? Color4Extensions.FromHex(message.Sender.Colour) : colourProvider?.Content1 ?? Colour4.White;
-                        })
                         {
                             AutoSizeAxes = Axes.Y,
                             RelativeSizeAxes = Axes.X,
@@ -141,18 +119,23 @@ namespace osu.Game.Overlays.Chat
                     },
                 }
             };
+        }
 
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager configManager)
+        {
             configManager.BindWith(OsuSetting.Prefer24HourTime, prefer24HourTime);
+            prefer24HourTime.BindValueChanged(_ => updateTimestamp());
         }
 
         protected override void LoadComplete()
         {
             base.LoadComplete();
 
+            drawableTimestamp.Colour = colourProvider?.Background1 ?? Colour4.White;
+
             updateMessageContent();
             FinishTransforms(true);
-
-            prefer24HourTime.BindValueChanged(_ => updateTimestamp());
         }
 
         /// <summary>
@@ -167,7 +150,7 @@ namespace osu.Game.Overlays.Chat
                     CornerRadius = 2f,
                     Masking = true,
                     RelativeSizeAxes = Axes.Both,
-                    Colour = usernameColour.Darken(1f),
+                    Colour = drawableUsername.Colour.Darken(1f),
                     Depth = float.MaxValue,
                     Child = new Box { RelativeSizeAxes = Axes.Both }
                 });
@@ -177,140 +160,182 @@ namespace osu.Game.Overlays.Chat
             highlight.Expire();
         }
 
+        private void styleMessageContent(SpriteText text)
+        {
+            text.Shadow = false;
+            text.Font = text.Font.With(size: FontSize, italics: Message.IsAction);
+
+            bool messageHasColour = Message.IsAction && !string.IsNullOrEmpty(message.Sender.Colour);
+            text.Colour = messageHasColour ? Color4Extensions.FromHex(message.Sender.Colour) : colourProvider?.Content1 ?? Colour4.White;
+        }
+
         private void updateMessageContent()
         {
             this.FadeTo(message is LocalEchoMessage ? 0.4f : 1.0f, 500, Easing.OutQuint);
-            timestamp.FadeTo(message is LocalEchoMessage ? 0 : 1, 500, Easing.OutQuint);
+            drawableTimestamp.FadeTo(message is LocalEchoMessage ? 0 : 1, 500, Easing.OutQuint);
 
             updateTimestamp();
-            username.Text = $@"{message.Sender.Username}";
+            drawableUsername.Text = $@"{message.Sender.Username}";
 
             // remove non-existent channels from the link list
             message.Links.RemoveAll(link => link.Action == LinkAction.OpenChannel && chatManager?.AvailableChannels.Any(c => c.Name == link.Argument.ToString()) != true);
 
-            ContentFlow.Clear();
+            drawableContentFlow.Clear();
-            ContentFlow.AddLinks(message.DisplayContent, message.Links);
+            drawableContentFlow.AddLinks(message.DisplayContent, message.Links);
         }
 
         private void updateTimestamp()
         {
-            timestamp.Text = prefer24HourTime.Value
+            drawableTimestamp.Text = prefer24HourTime.Value
                 ? $@"{message.Timestamp.LocalDateTime:HH:mm:ss}"
                 : $@"{message.Timestamp.LocalDateTime:hh:mm:ss tt}";
         }
 
-        private Drawable createUsername()
+        private class DrawableUsername : OsuClickableContainer, IHasContextMenu
         {
-            username = new OsuSpriteText
+            public new Color4 Colour { get; private set; }
-            {
-                Shadow = false,
-                Truncate = true,
-                EllipsisString = "…",
-                Font = OsuFont.GetFont(size: TextSize, weight: FontWeight.Bold, italics: true),
-                Anchor = Anchor.TopRight,
-                Origin = Anchor.TopRight,
-                MaxWidth = UsernameWidth,
-            };
 
-            if (!senderHasColour)
+            public float FontSize
             {
-                usernameColouredDrawable = username;
+                set => drawableText.Font = OsuFont.GetFont(size: value, weight: FontWeight.Bold, italics: true);
-                usernameColouredDrawable.Colour = usernameColour;
-                return username;
             }
 
-            username.Colour = colours.ChatBlue;
+            public LocalisableString Text
-
-            // Background effect
-            return new Container
             {
-                Anchor = Anchor.TopRight,
+                set => drawableText.Text = value;
-                Origin = Anchor.TopRight,
+            }
-                AutoSizeAxes = Axes.Both,
-                Masking = true,
-                CornerRadius = 4,
-                EdgeEffect = new EdgeEffectParameters
-                {
-                    Roundness = 1,
-                    Radius = 1,
-                    Colour = Color4.Black.Opacity(0.3f),
-                    Offset = new Vector2(0, 1),
-                    Type = EdgeEffectType.Shadow,
-                },
-                Child = new Container
-                {
-                    AutoSizeAxes = Axes.Both,
-                    Masking = true,
-                    CornerRadius = 4,
-                    Children = new Drawable[]
-                    {
-                        usernameColouredDrawable = new Box
-                        {
-                            RelativeSizeAxes = Axes.Both,
-                            Colour = usernameColour,
-                        },
-                        new Container
-                        {
-                            AutoSizeAxes = Axes.Both,
-                            Padding = new MarginPadding { Left = 4, Right = 4, Bottom = 1, Top = -2 },
-                            Child = username
-                        }
-                    }
-                }
-            };
-        }
 
-        private class MessageSender : OsuClickableContainer, IHasContextMenu
+            public override float Width
-        {
+            {
-            private readonly APIUser sender;
+                get => base.Width;
-            private readonly Drawable colouredDrawable;
+                set => base.Width = drawableText.MaxWidth = value;
-            private readonly Color4 defaultColour;
+            }
 
-            private Action startChatAction = null!;
+            [Resolved(canBeNull: false)]
-
-            [Resolved]
             private IAPIProvider api { get; set; } = null!;
 
-            public MessageSender(APIUser sender, Drawable colouredDrawable)
+            [Resolved(canBeNull: false)]
+            private OsuColour osuColours { get; set; } = null!;
+
+            [Resolved]
+            private ChannelManager? chatManager { get; set; }
+
+            [Resolved]
+            private ChatOverlay? chatOverlay { get; set; }
+
+            [Resolved]
+            private UserProfileOverlay? profileOverlay { get; set; }
+
+            private readonly APIUser user;
+            private readonly OsuSpriteText drawableText;
+
+            private readonly Drawable colouredDrawable;
+
+            public DrawableUsername(APIUser user)
             {
-                this.sender = sender;
+                this.user = user;
-                this.colouredDrawable = colouredDrawable;
+
-                defaultColour = colouredDrawable.Colour;
+                Action = openUserProfile;
+
+                drawableText = new OsuSpriteText
+                {
+                    Shadow = false,
+                    Truncate = true,
+                    EllipsisString = "…",
+                    Anchor = Anchor.TopRight,
+                    Origin = Anchor.TopRight,
+                };
+
+                if (string.IsNullOrWhiteSpace(user.Colour))
+                {
+                    Colour = default_colours[user.Id % default_colours.Length];
+
+                    Child = colouredDrawable = drawableText;
+                }
+                else
+                {
+
+                    Colour = Color4Extensions.FromHex(user.Colour);
+
+                    Child = new Container
+                    {
+                        Anchor = Anchor.TopRight,
+                        Origin = Anchor.TopRight,
+                        AutoSizeAxes = Axes.Both,
+                        Masking = true,
+                        CornerRadius = 4,
+                        EdgeEffect = new EdgeEffectParameters
+                        {
+                            Roundness = 1,
+                            Radius = 1,
+                            Colour = Color4.Black.Opacity(0.3f),
+                            Offset = new Vector2(0, 1),
+                            Type = EdgeEffectType.Shadow,
+                        },
+                        Child = new Container
+                        {
+                            AutoSizeAxes = Axes.Both,
+                            Masking = true,
+                            CornerRadius = 4,
+                            Children = new[]
+                            {
+                                colouredDrawable = new Box
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                },
+                                new Container
+                                {
+                                    AutoSizeAxes = Axes.Both,
+                                    Padding = new MarginPadding { Left = 4, Right = 4, Bottom = 1, Top = -2 },
+                                    Child = drawableText,
+                                }
+                            }
+                        }
+                    };
+                }
             }
 
-            [BackgroundDependencyLoader]
+            protected override void LoadComplete()
-            private void load(UserProfileOverlay? profile, ChannelManager? chatManager, ChatOverlay? chatOverlay)
             {
-                Action = () => profile?.ShowUser(sender);
+                base.LoadComplete();
-                startChatAction = () =>
+
-                {
+                drawableText.Colour = osuColours.ChatBlue;
-                    chatManager?.OpenPrivateChannel(sender);
+                colouredDrawable.Colour = Colour;
-                    chatOverlay?.Show();
-                };
             }
 
             public MenuItem[] ContextMenuItems
             {
                 get
                 {
-                    if (sender.Equals(APIUser.SYSTEM_USER))
+                    if (user.Equals(APIUser.SYSTEM_USER))
                         return Array.Empty<MenuItem>();
 
                     List<MenuItem> items = new List<MenuItem>
                     {
-                        new OsuMenuItem("View Profile", MenuItemType.Highlighted, Action)
+                        new OsuMenuItem("View Profile", MenuItemType.Highlighted, openUserProfile)
                     };
 
-                    if (!sender.Equals(api.LocalUser.Value))
+                    if (!user.Equals(api.LocalUser.Value))
-                        items.Add(new OsuMenuItem("Start Chat", MenuItemType.Standard, startChatAction));
+                        items.Add(new OsuMenuItem("Start Chat", MenuItemType.Standard, openUserChannel));
 
                     return items.ToArray();
                 }
             }
 
+            private void openUserChannel()
+            {
+                chatManager?.OpenPrivateChannel(user);
+                chatOverlay?.Show();
+            }
+
+            private void openUserProfile()
+            {
+                profileOverlay?.ShowUser(user);
+            }
+
             protected override bool OnHover(HoverEvent e)
             {
-                colouredDrawable.FadeColour(defaultColour.Lighten(0.4f), 150, Easing.OutQuint);
+                colouredDrawable.FadeColour(Colour.Lighten(0.4f), 150, Easing.OutQuint);
 
                 return base.OnHover(e);
             }
@@ -319,47 +344,47 @@ namespace osu.Game.Overlays.Chat
             {
                 base.OnHoverLost(e);
 
-                colouredDrawable.FadeColour(defaultColour, 250, Easing.OutQuint);
+                colouredDrawable.FadeColour(Colour, 250, Easing.OutQuint);
             }
+
+            private static readonly Color4[] default_colours =
+            {
+                Color4Extensions.FromHex("588c7e"),
+                Color4Extensions.FromHex("b2a367"),
+                Color4Extensions.FromHex("c98f65"),
+                Color4Extensions.FromHex("bc5151"),
+                Color4Extensions.FromHex("5c8bd6"),
+                Color4Extensions.FromHex("7f6ab7"),
+                Color4Extensions.FromHex("a368ad"),
+                Color4Extensions.FromHex("aa6880"),
+
+                Color4Extensions.FromHex("6fad9b"),
+                Color4Extensions.FromHex("f2e394"),
+                Color4Extensions.FromHex("f2ae72"),
+                Color4Extensions.FromHex("f98f8a"),
+                Color4Extensions.FromHex("7daef4"),
+                Color4Extensions.FromHex("a691f2"),
+                Color4Extensions.FromHex("c894d3"),
+                Color4Extensions.FromHex("d895b0"),
+
+                Color4Extensions.FromHex("53c4a1"),
+                Color4Extensions.FromHex("eace5c"),
+                Color4Extensions.FromHex("ea8c47"),
+                Color4Extensions.FromHex("fc4f4f"),
+                Color4Extensions.FromHex("3d94ea"),
+                Color4Extensions.FromHex("7760ea"),
+                Color4Extensions.FromHex("af52c6"),
+                Color4Extensions.FromHex("e25696"),
+
+                Color4Extensions.FromHex("677c66"),
+                Color4Extensions.FromHex("9b8732"),
+                Color4Extensions.FromHex("8c5129"),
+                Color4Extensions.FromHex("8c3030"),
+                Color4Extensions.FromHex("1f5d91"),
+                Color4Extensions.FromHex("4335a5"),
+                Color4Extensions.FromHex("812a96"),
+                Color4Extensions.FromHex("992861"),
+            };
         }
-
-        private static readonly Color4[] username_colours =
-        {
-            Color4Extensions.FromHex("588c7e"),
-            Color4Extensions.FromHex("b2a367"),
-            Color4Extensions.FromHex("c98f65"),
-            Color4Extensions.FromHex("bc5151"),
-            Color4Extensions.FromHex("5c8bd6"),
-            Color4Extensions.FromHex("7f6ab7"),
-            Color4Extensions.FromHex("a368ad"),
-            Color4Extensions.FromHex("aa6880"),
-
-            Color4Extensions.FromHex("6fad9b"),
-            Color4Extensions.FromHex("f2e394"),
-            Color4Extensions.FromHex("f2ae72"),
-            Color4Extensions.FromHex("f98f8a"),
-            Color4Extensions.FromHex("7daef4"),
-            Color4Extensions.FromHex("a691f2"),
-            Color4Extensions.FromHex("c894d3"),
-            Color4Extensions.FromHex("d895b0"),
-
-            Color4Extensions.FromHex("53c4a1"),
-            Color4Extensions.FromHex("eace5c"),
-            Color4Extensions.FromHex("ea8c47"),
-            Color4Extensions.FromHex("fc4f4f"),
-            Color4Extensions.FromHex("3d94ea"),
-            Color4Extensions.FromHex("7760ea"),
-            Color4Extensions.FromHex("af52c6"),
-            Color4Extensions.FromHex("e25696"),
-
-            Color4Extensions.FromHex("677c66"),
-            Color4Extensions.FromHex("9b8732"),
-            Color4Extensions.FromHex("8c5129"),
-            Color4Extensions.FromHex("8c3030"),
-            Color4Extensions.FromHex("1f5d91"),
-            Color4Extensions.FromHex("4335a5"),
-            Color4Extensions.FromHex("812a96"),
-            Color4Extensions.FromHex("992861"),
-        };
     }
 }