fixed bug with Stringify giving ToString output

SharpNBT/README.md

@@ -0,0 +1 @@
+../README.md

SharpNBT/SharpNBT.csproj

@@ -13,11 +13,13 @@
         <PackageTags>nbt;named binary tag;minecraft;serialization;java;bedrock;pocket edition;varint;varlong;zlib</PackageTags>
         <Copyright>Copyright © Eric Freed 2021</Copyright>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <PackageVersion>1.2.0</PackageVersion>
+        <PackageVersion>1.3.1</PackageVersion>
-        <AssemblyVersion>1.2.0</AssemblyVersion>
+        <AssemblyVersion>1.3.1</AssemblyVersion>
-        <FileVersion>1.2.0</FileVersion>
+        <FileVersion>1.3.1</FileVersion>
         <LangVersion>latestmajor</LangVersion>
         <Nullable>enable</Nullable>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageReleaseNotes>Hotfix to correct bug with Stringified output.</PackageReleaseNotes>
     </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
@@ -25,6 +27,7 @@
     </PropertyGroup>
     
     <ItemGroup>
+        <None Include="README.md" Pack="true" Visible="true" PackagePath="/"/>
         <None Include="icon.png" Pack="true" Visible="true" PackagePath="" />
     </ItemGroup>
     

SharpNBT/Tags/ArrayTag.cs

@@ -82,10 +82,12 @@ public abstract class ArrayTag<T> : Tag, IReadOnlyList<T> where T : unmanaged, I
     /// <returns>A reference to the first value in the underlying array.</returns>
     public ref T GetPinnableReference() => ref array[0] ;
     
-    private protected string Stringify(char prefix, char? suffix)
+    private protected string Stringify(bool named, char prefix, char? suffix)
     {
         var sb = new StringBuilder(32 + array.Length * 4);
-        sb.Append($"{StringifyName}:[{prefix};");
+        if (named)
+            sb.Append($"{StringifyName}:");
+        sb.Append($"[{prefix};");
 
         for (var i = 0; i < array.Length; i++)
         {

SharpNBT/Tags/BoolTag.cs

@@ -49,12 +49,12 @@ public class BoolTag : Tag
     /// <param name="tag">The tag to convert.</param>
     /// <returns>The tag represented as a <see cref="byte"/>.</returns>
     public static implicit operator bool(BoolTag tag) => tag.Value;
-        
+
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true)
-    /// </summary>
+    {
-    /// <returns>This NBT tag in SNBT format.</returns>
+        var value = Value ? "true" : "false";
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
+        return named ? $"{StringifyName}:{value}" : value;
-    public override string Stringify() => $"{StringifyName}:{(Value ? "true" : "false")}";
+    }
         
 }

SharpNBT/Tags/ByteArrayTag.cs

@@ -75,11 +75,7 @@ public class ByteArrayTag : ArrayTag<byte>
         var word = Count == 1 ? Strings.WordElement : Strings.WordElements;
         return $"TAG_Byte_Array({PrettyName}): [{Count} {word}]";
     }
-
+    
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => Stringify(named, 'B', 'b');
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => Stringify('B', 'b');
 }

SharpNBT/Tags/ByteTag.cs

@@ -132,10 +132,6 @@ public class ByteTag : NumericTag<byte>
     [CLSCompliant(false)]
     public static implicit operator sbyte(ByteTag tag) => unchecked((sbyte)tag.Value);
 
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => named ? $"{StringifyName}:{Value}B" : $"{Value}B"; 
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => $"{StringifyName}:{Value}B";
 }

SharpNBT/Tags/CompoundTag.cs

@@ -242,36 +242,35 @@ public class CompoundTag : Tag, IDictionary<string, Tag>, ICollection<Tag>
         buffer.AppendLine(space + "}");
     }
 
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true)
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify()
     {
         var sb = new StringBuilder();
-        sb.Append($"{StringifyName}:{{");
+        if (named)
+            sb.Append($"{StringifyName}:");
+        sb.Append('{');
 
         var i = 0;
         foreach (var value in dict.Values)
         {
             if (i++ > 0)
                 sb.Append(',');
-            sb.Append(value);
+            sb.Append(value.Stringify(true));
         }
         sb.Append('}');
         return sb.ToString();
     }
-        
+
     /// <summary>
     /// Gets the <i>string</i> representation of this NBT tag (SNBT).
     /// </summary>
     /// <param name="topLevel">Flag indicating if this is the top-level tag that should be wrapped in braces.</param>
+    /// <param name="named">Flag indicating if the name of the NBT should be written.</param>
     /// <returns>This NBT tag in SNBT format.</returns>
     /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public string Stringify(bool topLevel)
+    public string Stringify(bool topLevel, bool named)
     {
-        var str = Stringify();
+        var str = Stringify(named);
         return topLevel ? $"{{{str}}}" : str;
     }
 

SharpNBT/Tags/DoubleTag.cs

@@ -41,10 +41,6 @@ public class DoubleTag : NumericTag<double>
     /// <returns>The tag represented as a <see cref="double"/>.</returns>
     public static implicit operator double(DoubleTag tag) => tag.Value;
         
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => named ? $"{StringifyName}:{Value}D" : $"{Value}D"; 
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => $"{StringifyName}:{Value:0.0}D";
 }

SharpNBT/Tags/EndTag.cs

@@ -31,11 +31,7 @@ public sealed class EndTag : Tag
     {
         // Do nothing
     }
-
+    
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => string.Empty;
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => string.Empty;
 }

SharpNBT/Tags/FloatTag.cs

@@ -41,10 +41,6 @@ public class FloatTag : NumericTag<float>
     /// <returns>The tag represented as a <see cref="float"/>.</returns>
     public static implicit operator float(FloatTag tag) => tag.Value;
         
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => named ? $"{StringifyName}:{Value}F" : $"{Value}F";
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => $"{StringifyName}:{Value:0.0}F";
 }

SharpNBT/Tags/IntArrayTag.cs

@@ -73,11 +73,7 @@ public class IntArrayTag : ArrayTag<int>
         var word = Count == 1 ? Strings.WordElement : Strings.WordElements;
         return $"TAG_Int_Array({PrettyName}): [{Count} {word}]";
     }
-        
+
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => Stringify(named, 'I', null);
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => Stringify('I', null);
 }

SharpNBT/Tags/IntTag.cs

@@ -69,10 +69,6 @@ public class IntTag : NumericTag<int>
     [CLSCompliant(false)]
     public static implicit operator uint(IntTag tag) => unchecked((uint)tag.Value);
         
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => named ? $"{StringifyName}:{Value}" : $"{Value}"; 
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => $"{StringifyName}:{Value}";
 }

SharpNBT/Tags/ListTag.cs

@@ -175,15 +175,21 @@ public class ListTag : Tag, IList<Tag>
     /// </summary>
     /// <returns>This NBT tag in SNBT format.</returns>
     /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify()
+    public override string Stringify(bool named = true)
     {
-        var strings = new string[Count];
+        var sb = new StringBuilder();
-        for (var i = 0; i < strings.Length; i++)
+        if (named)
-            strings[i] = this[i].Stringify();
+            sb.Append($"{StringifyName}:");
-            
+
-        // TODO: Use StringBuilder
+        sb.Append('[');
-        
+        for (var i = 0; i < list.Count; i++)
-        return $"{StringifyName}:[{string.Join(',', strings)}]";
+        {
+            if (i > 0)
+                sb.Append(',');
+            sb.Append(list[i].Stringify(false));
+        }
+        sb.Append(']');
+        return sb.ToString();
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]

SharpNBT/Tags/LongArrayTag.cs

@@ -71,10 +71,6 @@ public class LongArrayTag : ArrayTag<long>
         return $"TAG_Long_Array({PrettyName}): [{Count} {word}]";
     }
 
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => Stringify(named, 'L', 'l');
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => Stringify('L', 'l');
 }

SharpNBT/Tags/LongTag.cs

@@ -69,10 +69,6 @@ public class LongTag : NumericTag<long>
     [CLSCompliant(false)]
     public static implicit operator ulong(LongTag tag) => unchecked((ulong)tag.Value);
         
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => named ? $"{StringifyName}:{Value}L" : $"{Value}L"; 
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => $"{StringifyName}:{Value}L";
 }

SharpNBT/Tags/ShortTag.cs

@@ -75,10 +75,6 @@ public class ShortTag : NumericTag<short>
     [CLSCompliant(false)]
     public static implicit operator ushort(ShortTag tag) => unchecked((ushort)tag.Value);
         
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true) => named ? $"{StringifyName}:{Value}S" : $"{Value}S"; 
-    /// </summary>
-    /// <returns>This NBT tag in SNBT format.</returns>
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public override string Stringify() => $"{StringifyName}:{Value}S";
 }

SharpNBT/Tags/StringTag.cs

@@ -47,13 +47,12 @@ public class StringTag : Tag, IEquatable<StringTag>
     /// <param name="tag">The tag to convert.</param>
     /// <returns>The tag represented as a <see cref="string"/>.</returns>
     public static implicit operator string(StringTag tag) => tag.Value;
-        
+
-    /// <summary>
+    /// <inheritdoc />
-    /// Gets the <i>string</i> representation of this NBT tag (SNBT).
+    public override string Stringify(bool named = true)
-    /// </summary>
+    {
-    /// <returns>This NBT tag in SNBT format.</returns>
+        return named ? $"{StringifyName}:\"{Value}\"" : $"\"{Value}\"";
-    /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
+    }
-    public override string Stringify() => $"{StringifyName}:\"{Value}\""; // TODO: Does this get properly escaped?
 
     /// <inheritdoc />
     public bool Equals(StringTag? other)

SharpNBT/Tags/Tag.cs

@@ -212,9 +212,10 @@ public abstract class Tag : IEquatable<Tag>, ICloneable
     /// <summary>
     /// Gets the <i>string</i> representation of this NBT tag (SNBT).
     /// </summary>
+    /// <param name="named">Flag indicating if the name of the tag should be written.</param>
     /// <returns>This NBT tag in SNBT format.</returns>
     /// <seealso href="https://minecraft.fandom.com/wiki/NBT_format#SNBT_format"/>
-    public abstract string Stringify();
+    public abstract string Stringify(bool named = true);
 
     /// <summary>
     /// Gets the name in a formatted properly for SNBT.