Simplify text flow localisation by leveraging localisation manager

kryptine · Nov 1, 2021 · 31bebef · 31bebef
1 parent cbc5a71
commit 31bebef
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 58 deletions.
diff --git a/osu.Framework/Graphics/Containers/ITextPart.cs b/osu.Framework/Graphics/Containers/ITextPart.cs
@@ -18,12 +18,6 @@ public interface ITextPart
         /// </summary>
         IEnumerable<Drawable> Drawables { get; }
 
-        /// <summary>
-        /// Raised when the <see cref="ITextPart"/>'s content changed due to changing language, etc.
-        /// Signals to the parent <see cref="TextFlowContainer"/> that it needs to reload its contents in the following frame.
-        /// </summary>
-        event Action ContentChanged;
-
         /// <summary>
         /// Raised when <see cref="Drawables"/> is reconstructed (e.g. when the user language was changed).
         /// Can be used by consumers to re-apply manual adjustments to the appearance of <see cref="Drawables"/>.

diff --git a/osu.Framework/Graphics/Containers/TextChunk.cs b/osu.Framework/Graphics/Containers/TextChunk.cs
@@ -23,21 +23,6 @@ public class TextChunk<TSpriteText> : TextPart
         private readonly Func<TSpriteText> creationFunc;
         private readonly Action<TSpriteText>? creationParameters;
 
-        private ILocalisedBindableString? currentBacking;
-
-        private ILocalisedBindableString? current
-        {
-            get => currentBacking;
-            set
-            {
-                if (value == null)
-                    return;
-
-                currentBacking = value;
-                currentBacking.BindValueChanged(_ => RaiseContentChanged());
-            }
-        }
-
         public TextChunk(LocalisableString text, bool newLineIsParagraph, Func<TSpriteText> creationFunc, Action<TSpriteText>? creationParameters = null)
         {
             this.text = text;
@@ -48,7 +33,7 @@ public TextChunk(LocalisableString text, bool newLineIsParagraph, Func<TSpriteTe
 
         protected override IEnumerable<Drawable> CreateDrawablesFor(TextFlowContainer textFlowContainer)
         {
-            current ??= textFlowContainer.Localisation?.GetLocalisedBindableString(text);
+            string currentContent = textFlowContainer.Localisation?.GetLocalisedString(text) ?? text.ToString();
 
             var drawables = new List<Drawable>();
 
@@ -61,7 +46,7 @@ protected override IEnumerable<Drawable> CreateDrawablesFor(TextFlowContainer te
                 drawables.AddRange(newLine.Drawables);
             }
 
-            drawables.AddRange(CreateDrawablesFor(current?.Value ?? text.ToString(), textFlowContainer));
+            drawables.AddRange(CreateDrawablesFor(currentContent, textFlowContainer));
             return drawables;
         }
 

diff --git a/osu.Framework/Graphics/Containers/TextFlowContainer.cs b/osu.Framework/Graphics/Containers/TextFlowContainer.cs
@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using osu.Framework.Allocation;
+using osu.Framework.Bindables;
 using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Extensions.IEnumerableExtensions;
 using osu.Framework.Localisation;
@@ -123,7 +124,7 @@ public LocalisableString Text
             set
             {
                 Clear();
-                clearParts();
+                parts.Clear();
 
                 AddText(value);
             }
@@ -132,6 +133,8 @@ public LocalisableString Text
         [Resolved]
         internal LocalisationManager Localisation { get; private set; }
 
+        private readonly IBindable<LocalisationParameters> localisationParameters = new Bindable<LocalisationParameters>();
+
         public TextFlowContainer(Action<SpriteText> defaultCreationParameters = null)
         {
             this.defaultCreationParameters = defaultCreationParameters;
@@ -140,7 +143,9 @@ public TextFlowContainer(Action<SpriteText> defaultCreationParameters = null)
         protected override void LoadComplete()
         {
             base.LoadComplete();
-            recreateAllParts();
+
+            localisationParameters.BindTo(Localisation.CurrentParameters);
+            localisationParameters.BindValueChanged(_ => recreateAllParts(), true);
         }
 
         private void recreateAllParts()
@@ -157,8 +162,6 @@ private void recreateAllParts()
                 recreatePart(part);
         }
 
-        private void scheduleRecreateAllParts() => Scheduler.AddOnce(recreateAllParts);
-
         private void recreatePart(ITextPart part)
         {
             part.RecreateDrawablesFor(this);
@@ -320,7 +323,6 @@ public override void Clear(bool disposeChildren)
         protected internal ITextPart AddPart(ITextPart part)
         {
             parts.Add(part);
-            part.ContentChanged += scheduleRecreateAllParts;
 
             if (IsLoaded)
                 recreatePart(part);
@@ -337,27 +339,12 @@ public bool RemovePart(ITextPart partToRemove)
             if (!parts.Remove(partToRemove))
                 return false;
 
-            partToRemove.ContentChanged -= scheduleRecreateAllParts;
-
             if (IsLoaded)
                 recreateAllParts();
 
             return true;
         }
 
-        protected override void Dispose(bool isDisposing)
-        {
-            base.Dispose(isDisposing);
-            clearParts();
-        }
-
-        private void clearParts()
-        {
-            foreach (var part in parts)
-                part.ContentChanged -= scheduleRecreateAllParts;
-            parts.Clear();
-        }
-
         private readonly Cached layout = new Cached();
 
         private void computeLayout()

diff --git a/osu.Framework/Graphics/Containers/TextPart.cs b/osu.Framework/Graphics/Containers/TextPart.cs
@@ -15,7 +15,6 @@ public abstract class TextPart : ITextPart
     {
         public IEnumerable<Drawable> Drawables { get; }
         public event Action<IEnumerable<Drawable>> DrawablePartsRecreated;
-        public event Action ContentChanged;
 
         private readonly List<Drawable> drawables = new List<Drawable>();
 
@@ -36,11 +35,5 @@ public void RecreateDrawablesFor(TextFlowContainer textFlowContainer)
         /// to be appended to the <paramref name="textFlowContainer"/>.
         /// </summary>
         protected abstract IEnumerable<Drawable> CreateDrawablesFor(TextFlowContainer textFlowContainer);
-
-        /// <summary>
-        /// Raises <see cref="ContentChanged"/>, signalling to the parent <see cref="TextFlowContainer"/>
-        /// that the contents of this part have changed.
-        /// </summary>
-        protected void RaiseContentChanged() => ContentChanged?.Invoke();
     }
 }
diff --git a/osu.Framework/Graphics/Containers/TextPartManual.cs b/osu.Framework/Graphics/Containers/TextPartManual.cs
@@ -21,12 +21,6 @@ public event Action<IEnumerable<Drawable>> DrawablePartsRecreated
             remove { }
         }
 
-        public event Action ContentChanged
-        {
-            add { }
-            remove { }
-        }
-
         public TextPartManual(IEnumerable<Drawable> drawables)
         {
             Drawables = drawables.ToImmutableArray();

diff --git a/osu.Framework/Localisation/LocalisationManager.cs b/osu.Framework/Localisation/LocalisationManager.cs
@@ -12,13 +12,15 @@ namespace osu.Framework.Localisation
 {
     public partial class LocalisationManager
     {
+        public IBindable<LocalisationParameters> CurrentParameters => currentParameters;
+
+        private readonly Bindable<LocalisationParameters> currentParameters = new Bindable<LocalisationParameters>(new LocalisationParameters(null, false));
+
         private readonly List<LocaleMapping> locales = new List<LocaleMapping>();
 
         private readonly Bindable<string> configLocale = new Bindable<string>();
         private readonly Bindable<bool> configPreferUnicode = new BindableBool();
 
-        private readonly Bindable<LocalisationParameters> currentParameters = new Bindable<LocalisationParameters>(new LocalisationParameters(null, false));
-
         public LocalisationManager(FrameworkConfigManager config)
         {
             config.BindWith(FrameworkSetting.Locale, configLocale);