fixed some ToString inconsistencies compared to regular enums

This commit is contained in:
Ell 2024-06-28 23:33:59 +02:00
parent eb2c87a462
commit 979cc03d98
3 changed files with 28 additions and 10 deletions

View file

@ -4,6 +4,7 @@ using System.Globalization;
using System.Linq; using System.Linq;
using System.Numerics; using System.Numerics;
using System.Reflection; using System.Reflection;
using System.Text;
#if NET6_0_OR_GREATER #if NET6_0_OR_GREATER
using System.Diagnostics.CodeAnalysis; using System.Diagnostics.CodeAnalysis;
@ -85,14 +86,25 @@ namespace DynamicEnums {
/// <returns>A string that represents the current object.</returns> /// <returns>A string that represents the current object.</returns>
public override string ToString() { public override string ToString() {
if (this.name == null) { if (this.name == null) {
var included = new List<DynamicEnum>(); // Enum ToString remarks: https://learn.microsoft.com/en-us/dotnet/api/system.enum.tostring
if (DynamicEnum.GetValue(this) != 0) { // If the FlagsAttribute is not applied to this enumerated type and there is a named constant equal to the value of this instance, then the return value is a string containing the name of the constant.
foreach (var v in DynamicEnum.GetValues(this.GetType())) { // If the FlagsAttribute is applied and there is a combination of one or more named constants equal to the value of this instance, then the return value is a string containing a delimiter-separated list of the names of the constants.
if (this.HasAllFlags(v) && DynamicEnum.GetValue(v) != 0) // Otherwise, the return value is the string representation of the numeric value of this instance.
included.Add(v);
var included = new StringBuilder();
var remain = DynamicEnum.GetValue(this);
foreach (var other in DynamicEnum.GetValues(this.GetType())) {
if (this.HasAllFlags(other)) {
var otherValue = DynamicEnum.GetValue(other);
if (otherValue != 0) {
if (included.Length > 0)
included.Append(" | ");
included.Append(other);
remain &= ~otherValue;
} }
} }
this.name = included.Count > 0 ? string.Join(" | ", included) : DynamicEnum.GetValue(this).ToString(); }
this.name = included.Length > 0 && remain == 0 ? included.ToString() : DynamicEnum.GetValue(this).ToString();
} }
return this.name; return this.name;
} }

View file

@ -32,6 +32,7 @@ public class EnumTests {
var flags = new TestDynamicEnum[100]; var flags = new TestDynamicEnum[100];
for (var i = 0; i < flags.Length; i++) for (var i = 0; i < flags.Length; i++)
flags[i] = DynamicEnum.AddFlag<TestDynamicEnum>("Flag" + i); flags[i] = DynamicEnum.AddFlag<TestDynamicEnum>("Flag" + i);
var zero = DynamicEnum.Add<TestDynamicEnum>("Zero", 0);
var combined = DynamicEnum.Add<TestDynamicEnum>("Combined", DynamicEnum.GetValue(DynamicEnum.Or(flags[7], flags[13]))); var combined = DynamicEnum.Add<TestDynamicEnum>("Combined", DynamicEnum.GetValue(DynamicEnum.Or(flags[7], flags[13])));
Assert.AreEqual(DynamicEnum.GetValue(flags[7]), BigInteger.One << 7); Assert.AreEqual(DynamicEnum.GetValue(flags[7]), BigInteger.One << 7);
@ -53,8 +54,13 @@ public class EnumTests {
Assert.AreEqual(DynamicEnum.Parse<TestDynamicEnum>("Flag24"), flags[24]); Assert.AreEqual(DynamicEnum.Parse<TestDynamicEnum>("Flag24"), flags[24]);
Assert.AreEqual(DynamicEnum.Parse<TestDynamicEnum>("Flag24 | Flag43"), DynamicEnum.Or(flags[24], flags[43])); Assert.AreEqual(DynamicEnum.Parse<TestDynamicEnum>("Flag24 | Flag43"), DynamicEnum.Or(flags[24], flags[43]));
Assert.AreEqual(flags[24].ToString(), "Flag24"); Assert.AreEqual(flags[24].ToString(), "Flag24");
Assert.AreEqual(zero.ToString(), "Zero");
Assert.AreEqual(DynamicEnum.GetEnumValue<TestDynamicEnum>(0).ToString(), "Zero");
Assert.AreEqual(DynamicEnum.Or(flags[24], flags[43]).ToString(), "Flag24 | Flag43"); Assert.AreEqual(DynamicEnum.Or(flags[24], flags[43]).ToString(), "Flag24 | Flag43");
Assert.AreEqual(DynamicEnum.Or(flags[24], DynamicEnum.GetEnumValue<TestDynamicEnum>(new BigInteger(1) << 99)).ToString(), "Flag24 | Flag99");
Assert.AreEqual(DynamicEnum.Or(flags[24], DynamicEnum.GetEnumValue<TestDynamicEnum>(new BigInteger(1) << 101)).ToString(), (DynamicEnum.GetValue(flags[24]) | new BigInteger(1) << 101).ToString());
Assert.True(DynamicEnum.IsDefined(flags[27])); Assert.True(DynamicEnum.IsDefined(flags[27]));
Assert.True(DynamicEnum.IsDefined(combined)); Assert.True(DynamicEnum.IsDefined(combined));
@ -63,7 +69,7 @@ public class EnumTests {
Assert.AreEqual( Assert.AreEqual(
new[] {flags[0], flags[7], flags[13], combined}, new[] {flags[0], flags[7], flags[13], combined},
DynamicEnum.GetFlags(DynamicEnum.Or(DynamicEnum.Or(flags[0], flags[13]), flags[7]))); DynamicEnum.GetFlags(DynamicEnum.Or(DynamicEnum.Or(flags[0], flags[13]), flags[7]), false));
Assert.AreEqual( Assert.AreEqual(
new[] {flags[0], flags[7], flags[13]}, new[] {flags[0], flags[7], flags[13]},