Make KVFile extend KVObject

ValveResourceFormat · Feb 16, 2024 · c98ba96 · c98ba96
1 parent ed1f368
commit c98ba96
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 18 deletions.
diff --git a/ValveKeyValue/ValveKeyValue/Deserialization/IVisitingReader.cs b/ValveKeyValue/ValveKeyValue/Deserialization/IVisitingReader.cs
@@ -2,6 +2,6 @@ namespace ValveKeyValue.Deserialization
 {
     interface IVisitingReader : IDisposable
     {
-        void ReadObject();
+        KVHeader ReadHeader();
     }
 }
diff --git a/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues1/KV1BinaryReader.cs b/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues1/KV1BinaryReader.cs
@@ -29,7 +29,7 @@ public KV1BinaryReader(Stream stream, IVisitationListener listener)
         bool disposed;
         KV1BinaryNodeType endMarker = KV1BinaryNodeType.End;
 
-        public void ReadObject()
+        public KVHeader ReadHeader()
         {
             Require.NotDisposed(nameof(KV1TextReader), disposed);
 
@@ -51,6 +51,8 @@ public void ReadObject()
             {
                 throw new KeyValueException("Error while parsing binary KeyValues.", ex);
             }
+
+            return new KVHeader();
         }
 
         public void Dispose()

diff --git a/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues1/KV1TextReader.cs b/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues1/KV1TextReader.cs
@@ -27,7 +27,7 @@ public KV1TextReader(TextReader textReader, IParsingVisitationListener listener,
         readonly KV1TextReaderStateMachine stateMachine;
         bool disposed;
 
-        public void ReadObject()
+        public KVHeader ReadHeader()
         {
             Require.NotDisposed(nameof(KV1TextReader), disposed);
 
@@ -103,6 +103,8 @@ public void ReadObject()
                         throw new ArgumentOutOfRangeException(nameof(token.TokenType), token.TokenType, "Unhandled token type.");
                 }
             }
+
+            return new KVHeader();
         }
 
         public void Dispose()
@@ -224,7 +226,7 @@ void DoIncludeAndMerge(string filePath)
 
             using var stream = OpenFileForInclude(filePath);
             using var reader = new KV1TextReader(new StreamReader(stream), mergeListener, options);
-            reader.ReadObject();
+            reader.ReadHeader();
         }
 
         void DoIncludeAndAppend(string filePath)
@@ -233,7 +235,7 @@ void DoIncludeAndAppend(string filePath)
 
             using var stream = OpenFileForInclude(filePath);
             using var reader = new KV1TextReader(new StreamReader(stream), appendListener, options);
-            reader.ReadObject();
+            reader.ReadHeader();
         }
 
         Stream OpenFileForInclude(string filePath)

diff --git a/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues3/KV3TextReader.cs b/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues3/KV3TextReader.cs
@@ -24,11 +24,11 @@ public KV3TextReader(TextReader textReader, IParsingVisitationListener listener)
         readonly KV3TextReaderStateMachine stateMachine;
         bool disposed;
 
-        public void ReadObject()
+        public KVHeader ReadHeader()
         {
             Require.NotDisposed(nameof(KV3TextReader), disposed);
 
-            var file = tokenReader.ReadHeader();
+            var header = tokenReader.ReadHeader();
 
             while (stateMachine.IsInObject)
             {
@@ -108,6 +108,8 @@ public void ReadObject()
                         throw new ArgumentOutOfRangeException(nameof(token.TokenType), token.TokenType, "Unhandled token type.");
                 }
             }
+
+            return header;
         }
 
         public void Dispose()

diff --git a/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues3/KV3TokenReader.cs b/ValveKeyValue/ValveKeyValue/Deserialization/KeyValues3/KV3TokenReader.cs
@@ -139,7 +139,7 @@ KVToken ReadBinaryBlob()
             return new KVToken(KVTokenType.BinaryBlob, sb.ToString());
         }
 
-        public KVFile ReadHeader()
+        public KVHeader ReadHeader()
         {
             var str = ReadToken();
 
@@ -222,7 +222,7 @@ public KVFile ReadHeader()
                 throw new InvalidDataException($"Unrecognized encoding specifier, expected '{Format.Generic}' but got '{format}'.");
             }
 
-            return new KVFile
+            return new KVHeader
             {
                 Encoding = encoding,
                 Format = format,

diff --git a/ValveKeyValue/ValveKeyValue/KVFile.cs b/ValveKeyValue/ValveKeyValue/KVFile.cs
@@ -2,10 +2,13 @@
 
 namespace ValveKeyValue
 {
-    public class KVFile
+    public class KVFile : KVObject
     {
-        public Guid Encoding { get; set; }
-        public Guid Format { get; set; }
-        public KVObject Root { get; set; }
+        public KVHeader Header { get; }
+
+        public KVFile(KVHeader header, string name, KVValue value) : base(name, value)
+        {
+            Header = header;
+        }
     }
 }
diff --git a/ValveKeyValue/ValveKeyValue/KVHeader.cs b/ValveKeyValue/ValveKeyValue/KVHeader.cs
@@ -0,0 +1,10 @@
+using System;
+
+namespace ValveKeyValue
+{
+    public class KVHeader
+    {
+        public Guid Encoding { get; set; }
+        public Guid Format { get; set; }
+    }
+}
diff --git a/ValveKeyValue/ValveKeyValue/KVSerializer.cs b/ValveKeyValue/ValveKeyValue/KVSerializer.cs
@@ -38,13 +38,12 @@ public KVDocument Deserialize(Stream stream, KVSerializerOptions options = null)
             Require.NotNull(stream, nameof(stream));
             var builder = new KVObjectBuilder();
 
-            using (var reader = MakeReader(stream, builder, options ?? KVSerializerOptions.DefaultOptions))
-            {
-                reader.ReadObject();
-            }
+            using var reader = MakeReader(stream, builder, options ?? KVSerializerOptions.DefaultOptions);
 
+            var header = reader.ReadHeader();
             var root = builder.GetObject();
-            return new KVDocument(root.Name, root.Value);
+
+            return new KVDocument(header, root.Name, root.Value); // TODO
         }
 
         /// <summary>