Merge pull request #20645 from frenzibyte/flag-markdown

Add support for inline country flags in wiki overlay

osu.Android.props

@@ -52,7 +52,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="ppy.osu.Game.Resources" Version="2022.1008.0" />
-    <PackageReference Include="ppy.osu.Framework.Android" Version="2022.1005.0" />
+    <PackageReference Include="ppy.osu.Framework.Android" Version="2022.1011.0" />
   </ItemGroup>
   <ItemGroup Label="Transitive Dependencies">
     <!-- Realm needs to be directly referenced in all Xamarin projects, as it will not pull in its transitive dependencies otherwise. -->

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

@@ -189,6 +189,16 @@ Line after image";
             });
         }
 
+        [Test]
+        public void TestFlag()
+        {
+            AddStep("Add flag", () =>
+            {
+                markdownContainer.CurrentPath = @"https://dev.ppy.sh";
+                markdownContainer.Text = "::{flag=\"AU\"}:: ::{flag=\"ZZ\"}::";
+            });
+        }
+
         private class TestMarkdownContainer : WikiMarkdownContainer
         {
             public LinkInline Link;

osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainer.cs

@@ -5,6 +5,7 @@
 
 using Markdig;
 using Markdig.Extensions.AutoLinks;
+using Markdig.Extensions.CustomContainers;
 using Markdig.Extensions.EmphasisExtras;
 using Markdig.Extensions.Footnotes;
 using Markdig.Extensions.Tables;
@@ -32,6 +33,12 @@ namespace osu.Game.Graphics.Containers.Markdown
         /// <seealso cref="AutoLinkExtension"/>
         protected virtual bool Autolinks => false;
 
+        /// <summary>
+        /// Allows this markdown container to parse custom containers (used for flags and infoboxes).
+        /// </summary>
+        /// <seealso cref="CustomContainerExtension"/>
+        protected virtual bool CustomContainers => false;
+
         public OsuMarkdownContainer()
         {
             LineSpacing = 21;
@@ -107,6 +114,9 @@ namespace osu.Game.Graphics.Containers.Markdown
             if (Autolinks)
                 pipeline = pipeline.UseAutoLinks();
 
+            if (CustomContainers)
+                pipeline.UseCustomContainers();
+
             return pipeline.Build();
         }
     }

osu.Game/Graphics/Containers/Markdown/OsuMarkdownTextFlowContainer.cs

@@ -3,6 +3,9 @@
 
 #nullable disable
 
+using System;
+using System.Linq;
+using Markdig.Extensions.CustomContainers;
 using Markdig.Syntax.Inlines;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
@@ -11,6 +14,9 @@ using osu.Framework.Graphics.Containers.Markdown;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Graphics.Sprites;
 using osu.Game.Overlays;
+using osu.Game.Users;
+using osu.Game.Users.Drawables;
+using osuTK;
 
 namespace osu.Game.Graphics.Containers.Markdown
 {
@@ -33,6 +39,31 @@ namespace osu.Game.Graphics.Containers.Markdown
         protected override SpriteText CreateEmphasisedSpriteText(bool bold, bool italic)
             => CreateSpriteText().With(t => t.Font = t.Font.With(weight: bold ? FontWeight.Bold : FontWeight.Regular, italics: italic));
 
+        protected override void AddCustomComponent(CustomContainerInline inline)
+        {
+            if (!(inline.FirstChild is LiteralInline literal))
+            {
+                base.AddCustomComponent(inline);
+                return;
+            }
+
+            string[] attributes = literal.Content.ToString().Trim(' ', '{', '}').Split();
+            string flagAttribute = attributes.SingleOrDefault(a => a.StartsWith(@"flag", StringComparison.Ordinal));
+
+            if (flagAttribute == null)
+            {
+                base.AddCustomComponent(inline);
+                return;
+            }
+
+            string flag = flagAttribute.Split('=').Last().Trim('"');
+
+            if (!Enum.TryParse<CountryCode>(flag, out var countryCode))
+                countryCode = CountryCode.Unknown;
+
+            AddDrawable(new DrawableFlag(countryCode) { Size = new Vector2(20, 15) });
+        }
+
         private class OsuMarkdownInlineCode : Container
         {
             [Resolved]

osu.Game/Overlays/Wiki/Markdown/WikiMarkdownContainer.cs

@@ -4,6 +4,7 @@
 #nullable disable
 
 using System.Linq;
+using Markdig.Extensions.CustomContainers;
 using Markdig.Extensions.Yaml;
 using Markdig.Syntax;
 using Markdig.Syntax.Inlines;
@@ -16,6 +17,7 @@ namespace osu.Game.Overlays.Wiki.Markdown
     public class WikiMarkdownContainer : OsuMarkdownContainer
     {
         protected override bool Footnotes => true;
+        protected override bool CustomContainers => true;
 
         public string CurrentPath
         {
@@ -26,6 +28,11 @@ namespace osu.Game.Overlays.Wiki.Markdown
         {
             switch (markdownObject)
             {
+                case CustomContainer:
+                    // infoboxes are parsed into CustomContainer objects, but we don't have support for infoboxes yet.
+                    // todo: add support for infobox.
+                    break;
+
                 case YamlFrontMatterBlock yamlFrontMatterBlock:
                     container.Add(new WikiNoticeContainer(yamlFrontMatterBlock));
                     break;

osu.Game/osu.Game.csproj

@@ -35,7 +35,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Realm" Version="10.17.0" />
-    <PackageReference Include="ppy.osu.Framework" Version="2022.1005.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2022.1011.0" />
     <PackageReference Include="ppy.osu.Game.Resources" Version="2022.1008.0" />
     <PackageReference Include="Sentry" Version="3.22.0" />
     <PackageReference Include="SharpCompress" Version="0.32.2" />

osu.iOS.props

@@ -62,7 +62,7 @@
   </ItemGroup>
   <ItemGroup Label="Package References">
     <PackageReference Include="ppy.osu.Game.Resources" Version="2022.1008.0" />
-    <PackageReference Include="ppy.osu.Framework.iOS" Version="2022.1005.0" />
+    <PackageReference Include="ppy.osu.Framework.iOS" Version="2022.1011.0" />
   </ItemGroup>
   <!-- See https://github.com/dotnet/runtime/issues/35988 (can be removed after Xamarin uses net6.0) -->
   <PropertyGroup>
@@ -82,7 +82,7 @@
     <PackageReference Include="DiffPlex" Version="1.7.1" />
     <PackageReference Include="Humanizer" Version="2.14.1" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
-    <PackageReference Include="ppy.osu.Framework" Version="2022.1005.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2022.1011.0" />
     <PackageReference Include="SharpCompress" Version="0.32.2" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />