Fix throws exception when enum has same value #32

Cysharp · Jan 14, 2021 · f618dee · f618dee
1 parent 1c80aa4
commit f618dee
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 8 deletions.
diff --git a/src/ZString.Unity/Assets/Scripts/ZString/EnumUtil.cs b/src/ZString.Unity/Assets/Scripts/ZString/EnumUtil.cs
@@ -7,6 +7,8 @@ namespace Cysharp.Text
 {
     internal static class EnumUtil<T>
     {
+        const string InvalidName = "$";
+
         static readonly Dictionary<T, string> names;
         static readonly Dictionary<T, byte[]> utf8names;
 
@@ -18,14 +20,23 @@ static EnumUtil()
             utf8names = new Dictionary<T, byte[]>(enumNames.Length);
             for (int i = 0; i < enumNames.Length; i++)
             {
-                names.Add((T)values.GetValue(i), enumNames[i]);
-                utf8names.Add((T)values.GetValue(i), Encoding.UTF8.GetBytes(enumNames[i]));
+                if (names.ContainsKey((T)values.GetValue(i)))
+                {
+                    // already registered = invalid.
+                    names[(T)values.GetValue(i)] = InvalidName;
+                    utf8names[(T)values.GetValue(i)] = Array.Empty<byte>(); // byte[0] == Invalid.
+                }
+                else
+                {
+                    names.Add((T)values.GetValue(i), enumNames[i]);
+                    utf8names.Add((T)values.GetValue(i), Encoding.UTF8.GetBytes(enumNames[i]));
+                }
             }
         }
 
         public static bool TryFormatUtf16(T value, Span<char> dest, out int written, ReadOnlySpan<char> _)
         {
-            if (!names.TryGetValue(value, out var v))
+            if (!names.TryGetValue(value, out var v) || v == InvalidName)
             {
                 v = value.ToString();
             }
@@ -36,7 +47,7 @@ public static bool TryFormatUtf16(T value, Span<char> dest, out int written, Rea
 
         public static bool TryFormatUtf8(T value, Span<byte> dest, out int written, StandardFormat _)
         {
-            if (!utf8names.TryGetValue(value, out var v))
+            if (!utf8names.TryGetValue(value, out var v) || v.Length == 0)
             {
                 v = Encoding.UTF8.GetBytes(value.ToString());
             }

diff --git a/src/ZString/EnumUtil.cs b/src/ZString/EnumUtil.cs
@@ -7,6 +7,8 @@ namespace Cysharp.Text
 {
     internal static class EnumUtil<T>
     {
+        const string InvalidName = "$";
+
         static readonly Dictionary<T, string> names;
         static readonly Dictionary<T, byte[]> utf8names;
 
@@ -18,14 +20,23 @@ static EnumUtil()
             utf8names = new Dictionary<T, byte[]>(enumNames.Length);
             for (int i = 0; i < enumNames.Length; i++)
             {
-                names.Add((T)values.GetValue(i), enumNames[i]);
-                utf8names.Add((T)values.GetValue(i), Encoding.UTF8.GetBytes(enumNames[i]));
+                if (names.ContainsKey((T)values.GetValue(i)))
+                {
+                    // already registered = invalid.
+                    names[(T)values.GetValue(i)] = InvalidName;
+                    utf8names[(T)values.GetValue(i)] = Array.Empty<byte>(); // byte[0] == Invalid.
+                }
+                else
+                {
+                    names.Add((T)values.GetValue(i), enumNames[i]);
+                    utf8names.Add((T)values.GetValue(i), Encoding.UTF8.GetBytes(enumNames[i]));
+                }
             }
         }
 
         public static bool TryFormatUtf16(T value, Span<char> dest, out int written, ReadOnlySpan<char> _)
         {
-            if (!names.TryGetValue(value, out var v))
+            if (!names.TryGetValue(value, out var v) || v == InvalidName)
             {
                 v = value.ToString();
             }
@@ -36,7 +47,7 @@ public static bool TryFormatUtf16(T value, Span<char> dest, out int written, Rea
 
         public static bool TryFormatUtf8(T value, Span<byte> dest, out int written, StandardFormat _)
         {
-            if (!utf8names.TryGetValue(value, out var v))
+            if (!utf8names.TryGetValue(value, out var v) || v.Length == 0)
             {
                 v = Encoding.UTF8.GetBytes(value.ToString());
             }

diff --git a/tests/ZString.Tests/EnumTest.cs b/tests/ZString.Tests/EnumTest.cs
@@ -0,0 +1,78 @@
+using Cysharp.Text;
+using FluentAssertions;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Xunit;
+
+namespace ZStringTests
+{
+    public enum DuplicateEnum
+    {
+        A = 1,
+        B = 2,
+        BB = 2,
+        C = 3
+    }
+
+    public enum StandardEnum
+    {
+        Abc = 1,
+        Def = 2,
+        Ghi = 3,
+    }
+
+    [Flags]
+    public enum FlagsEnum
+    {
+        None = 0,
+        Abc = 1,
+        Bcd = 2,
+        Efg = 4,
+    }
+
+    public class EnumTest
+    {
+        [Fact]
+        public void Duplicate()
+        {
+            ZString.Format("{0}", DuplicateEnum.A).Should().Be("A");
+            ZString.Format("{0}", DuplicateEnum.B).Should().Be("B");
+            ZString.Format("{0}", DuplicateEnum.BB).Should().Be("B");
+            ZString.Format("{0}", DuplicateEnum.C).Should().Be("C");
+            Utf8(DuplicateEnum.A);
+            Utf8(DuplicateEnum.B);
+            Utf8(DuplicateEnum.BB);
+            Utf8(DuplicateEnum.C);
+        }
+
+        [Fact]
+        public void Standard()
+        {
+            ZString.Format("{0}", StandardEnum.Abc).Should().Be("Abc");
+            ZString.Format("{0}", StandardEnum.Def).Should().Be("Def");
+            ZString.Format("{0}", StandardEnum.Ghi).Should().Be("Ghi");
+            Utf8(StandardEnum.Abc);
+            Utf8(StandardEnum.Def);
+            Utf8(StandardEnum.Ghi);
+        }
+
+        [Fact]
+        public void Flags()
+        {
+            ZString.Format("{0}", FlagsEnum.Abc | FlagsEnum.Bcd).Should().Be("Abc, Bcd");
+            ZString.Format("{0}", FlagsEnum.None).Should().Be("None");
+            ZString.Format("{0}", FlagsEnum.Efg).Should().Be("Efg");
+            Utf8(FlagsEnum.Abc | FlagsEnum.Bcd);
+            Utf8(FlagsEnum.None);
+            Utf8(FlagsEnum.Efg);
+        }
+
+        static void Utf8<T>(T e) where T : Enum
+        {
+            var s = ZString.CreateUtf8StringBuilder();
+            s.AppendFormat("{0}", e);
+            s.AsSpan().SequenceEqual(Encoding.UTF8.GetBytes(e.ToString())).Should().BeTrue();
+        }
+    }
+}