Cache more properties using the field keyword

mnadareski · mnadareski · commit 60e46e580d28 · 2025-11-14T10:14:50.000-05:00
diff --git a/SabreTools.Serialization/Wrappers/AACSMediaKeyBlock.cs b/SabreTools.Serialization/Wrappers/AACSMediaKeyBlock.cs
@@ -27,13 +27,21 @@ public string? Version
         {
             get
             {
+                // Use the cached value, if it exists
+                if (field != null)
+                    return field;
+
+                // Find the type and version record, if possible
                 var record = Array.Find(Records, r => r.RecordType == RecordType.TypeAndVersion);
                 if (record is TypeAndVersionRecord tavr)
-                    return tavr.VersionNumber.ToString();
+                {
+                    field = tavr.VersionNumber.ToString();
+                    return field;
+                }
 
-                return null;
+                return field;
             }
-        }
+        } = null;
 
         #endregion
 
diff --git a/SabreTools.Serialization/Wrappers/CFB.cs b/SabreTools.Serialization/Wrappers/CFB.cs
@@ -41,7 +41,7 @@ public byte[] MiniStreamData
                     return field;
 
                 // If there are no directory entries
-                if (DirectoryEntries == null || DirectoryEntries.Length == 0)
+                if (DirectoryEntries.Length == 0)
                     return [];
 
                 // Get the mini stream offset from root object
@@ -56,12 +56,12 @@ public byte[] MiniStreamData
         /// <summary>
         /// Normal sector size in bytes
         /// </summary>
-        public long SectorSize => (long)Math.Pow(2, Header?.SectorShift ?? 0);
+        public long SectorSize => (long)Math.Pow(2, Header.SectorShift);
 
         /// <summary>
         /// Mini sector size in bytes
         /// </summary>
-        public long MiniSectorSize => (long)Math.Pow(2, Header?.MiniSectorShift ?? 0);
+        public long MiniSectorSize => (long)Math.Pow(2, Header.MiniSectorShift);
 
         #endregion
 
diff --git a/SabreTools.Serialization/Wrappers/GCF.cs b/SabreTools.Serialization/Wrappers/GCF.cs
@@ -24,7 +24,7 @@ public long[]? DataBlockOffsets
         {
             get
             {
-                // Use the cached value if we have it
+                // Use the cached value, if it exists
                 if (field != null)
                     return field;
 
@@ -48,14 +48,10 @@ public FileInfo[]? Files
         {
             get
             {
-                // Use the cached value if we have it
+                // Use the cached value, if it exists
                 if (field != null)
                     return field;
 
-                // If we don't have a required property
-                if (Model.DirectoryEntries == null || Model.DirectoryMapEntries == null)
-                    return null;
-
                 // Otherwise, scan and build the files
                 var files = new List<FileInfo>();
                 for (int i = 0; i < Model.DirectoryEntries.Length; i++)
@@ -82,15 +78,15 @@ public FileInfo[]? Files
                         Encrypted = directoryEntry.DirectoryFlags.HasFlag(Data.Models.GCF.HL_GCF_FLAG.HL_GCF_FLAG_ENCRYPTED),
 #endif
                     };
-                    var pathParts = new List<string> { Model.DirectoryNames![directoryEntry.NameOffset] ?? string.Empty };
+                    var pathParts = new List<string> { Model.DirectoryNames[directoryEntry.NameOffset] ?? string.Empty };
                     var blockEntries = new List<Data.Models.GCF.BlockEntry>();
 
                     // Traverse the parent tree
                     uint index = directoryEntry.ParentIndex;
                     while (index != 0xFFFFFFFF)
                     {
                         var parentDirectoryEntry = Model.DirectoryEntries[index];
-                        pathParts.Add(Model.DirectoryNames![parentDirectoryEntry.NameOffset] ?? string.Empty);
+                        pathParts.Add(Model.DirectoryNames[parentDirectoryEntry.NameOffset] ?? string.Empty);
                         index = parentDirectoryEntry.ParentIndex;
                     }
 
diff --git a/SabreTools.Serialization/Wrappers/GZip.cs b/SabreTools.Serialization/Wrappers/GZip.cs
@@ -27,11 +27,16 @@ public byte[]? ContentCrc32
                 if (!IsTorrentGZip)
                     return null;
 
+                // Use the cached value, if it exists
+                if (field != null)
+                    return field;
+
                 // CRC-32 is the second packed field
                 int extraIndex = 0x10;
-                return Header.ExtraFieldBytes.ReadBytes(ref extraIndex, 0x04);
+                field = Header.ExtraFieldBytes.ReadBytes(ref extraIndex, 0x04);
+                return field;
             }
-        }
+        } = null;
 
         /// <summary>
         /// Content MD5 as stored in the extra field
@@ -45,11 +50,16 @@ public byte[]? ContentMd5
                 if (!IsTorrentGZip)
                     return null;
 
+                // Use the cached value, if it exists
+                if (field != null)
+                    return field;
+
                 // MD5 is the first packed field
                 int extraIndex = 0x00;
-                return Header.ExtraFieldBytes.ReadBytes(ref extraIndex, 0x10);
+                field = Header.ExtraFieldBytes.ReadBytes(ref extraIndex, 0x10);
+                return field;
             }
-        }
+        } = null;
 
         /// <summary>
         /// Content size as stored in the extra field
@@ -63,11 +73,16 @@ public ulong ContentSize
                 if (!IsTorrentGZip)
                     return 0;
 
-                // MD5 is the first packed field
-                int extraIndex = 0x00;
-                return Header.ExtraFieldBytes.ReadUInt64LittleEndian(ref extraIndex);
+                // Use the cached value, if it exists
+                if (field > 0)
+                    return field;
+
+                // Size is the third packed field
+                int extraIndex = 0x14;
+                field = Header.ExtraFieldBytes.ReadUInt64LittleEndian(ref extraIndex);
+                return field;
             }
-        }
+        } = 0;
 
         /// <summary>
         /// Offset to the compressed data
@@ -77,6 +92,7 @@ public long DataOffset
         {
             get
             {
+                // Use the cached value, if it exists
                 if (field > -1)
                     return field;
 
diff --git a/SabreTools.Serialization/Wrappers/LinearExecutable.cs b/SabreTools.Serialization/Wrappers/LinearExecutable.cs
@@ -17,16 +17,49 @@ public partial class LinearExecutable : WrapperBase<Executable>
         #region Extension Properties
 
         /// <inheritdoc cref="Executable.ObjectPageMap"/>
-        public InformationBlock? InformationBlock => Model.InformationBlock;
+        public InformationBlock InformationBlock => Model.InformationBlock;
 
         /// <inheritdoc cref="Executable.ObjectPageMap"/>
-        public ObjectPageMapEntry[]? ObjectPageMap => Model.ObjectPageMap;
+        public ObjectPageMapEntry[] ObjectPageMap => Model.ObjectPageMap;
 
         /// <inheritdoc cref="Executable.ResourceTable"/>
-        public ResourceTableEntry[]? ResourceTable => Model.ResourceTable;
+        public ResourceTableEntry[] ResourceTable => Model.ResourceTable;
 
         /// <inheritdoc cref="Executable.Stub"/>
-        public Data.Models.MSDOS.Executable? Stub => Model.Stub;
+        public Data.Models.MSDOS.Executable Stub => Model.Stub;
+
+        /// <summary>
+        /// Stub executable data, if it exists
+        /// </summary>
+        public byte[] StubExecutableData
+        {
+            get
+            {
+                lock (_stubExecutableDataLock)
+                {
+                    // If we already have cached data, just use that immediately
+                    if (field != null)
+                        return field;
+
+                    // Populate the raw stub executable data based on the source
+                    int endOfStubHeader = 0x40;
+                    int lengthOfStubExecutableData = (int)Stub.Header.NewExeHeaderAddr - endOfStubHeader;
+                    field = ReadRangeFromSource(endOfStubHeader, lengthOfStubExecutableData);
+
+                    // Cache and return the stub executable data, even if null
+                    return field;
+                }
+            }
+        } = null;
+
+        #endregion
+
+        #region Instance Variables
+
+        /// <summary>
+        /// Lock object for <see cref="StubExecutableData"/>
+        /// </summary>
+        private readonly object _stubExecutableDataLock = new();
 
         #endregion
 
diff --git a/SabreTools.Serialization/Wrappers/PortableExecutable.cs b/SabreTools.Serialization/Wrappers/PortableExecutable.cs
@@ -34,19 +34,19 @@ public Dictionary<int, object> DebugData
                 lock (_debugDataLock)
                 {
                     // Use the cached data if possible
-                    if (_debugData.Count != 0)
-                        return _debugData;
+                    if (field.Count != 0)
+                        return field;
 
                     // If we have no resource table, just return
                     if (DebugDirectoryTable == null || DebugDirectoryTable.Length == 0)
-                        return _debugData;
+                        return field;
 
                     // Otherwise, build and return the cached dictionary
-                    ParseDebugTable();
-                    return _debugData;
+                    field = ParseDebugTable();
+                    return field;
                 }
             }
-        }
+        } = [];
 
         /// <inheritdoc cref="Models.PortableExecutable.DebugData.Table.Table"/>
         public Data.Models.PortableExecutable.DebugData.Entry[]? DebugDirectoryTable
@@ -822,12 +822,7 @@ public string? AssemblyVersion
         #region Instance Variables
 
         /// <summary>
-        /// Cached debug data
-        /// </summary>
-        private readonly Dictionary<int, object> _debugData = [];
-
-        /// <summary>
-        /// Lock object for <see cref="_debugData"/>
+        /// Lock object for <see cref="DebugData"/>
         /// </summary>
         private readonly object _debugDataLock = new();
 
@@ -1200,11 +1195,14 @@ public PortableExecutable(Executable model, Stream data, long offset, long lengt
         /// <summary>
         /// Parse the debug directory table information
         /// </summary>
-        private void ParseDebugTable()
+        private Dictionary<int, object> ParseDebugTable()
         {
             // If there is no debug table
             if (DebugDirectoryTable == null || DebugDirectoryTable.Length == 0)
-                return;
+                return [];
+
+            // Create a new debug table
+            Dictionary<int, object> debugData = [];
 
             // Loop through all debug table entries
             for (int i = 0; i < DebugDirectoryTable.Length; i++)
@@ -1223,7 +1221,7 @@ private void ParseDebugTable()
                 }
                 catch (EndOfStreamException)
                 {
-                    return;
+                    return debugData;
                 }
 
                 // If we have CodeView debug data, try to parse it
@@ -1242,7 +1240,7 @@ private void ParseDebugTable()
                         var nb10ProgramDatabase = entryData.ParseNB10ProgramDatabase(ref offset);
                         if (nb10ProgramDatabase != null)
                         {
-                            _debugData[i] = nb10ProgramDatabase;
+                            debugData[i] = nb10ProgramDatabase;
                             continue;
                         }
                     }
@@ -1253,16 +1251,18 @@ private void ParseDebugTable()
                         var rsdsProgramDatabase = entryData.ParseRSDSProgramDatabase(ref offset);
                         if (rsdsProgramDatabase != null)
                         {
-                            _debugData[i] = rsdsProgramDatabase;
+                            debugData[i] = rsdsProgramDatabase;
                             continue;
                         }
                     }
                 }
                 else
                 {
-                    _debugData[i] = entryData;
+                    debugData[i] = entryData;
                 }
             }
+
+            return debugData;
         }
 
         #endregion
diff --git a/SabreTools.Serialization/Wrappers/VPK.cs b/SabreTools.Serialization/Wrappers/VPK.cs
@@ -22,7 +22,7 @@ public string[]? ArchiveFilenames
         {
             get
             {
-                // Use the cached value if we have it
+                // Use the cached value, if it exists
                 if (field != null)
                     return field;
 

Original file line number	Diff line number	Diff line change
`@@ -34,19 +34,19 @@ public Dictionary<int, object> DebugData`
`34`	`34`	`lock (_debugDataLock)`
`35`	`35`	`{`
`36`	`36`	`// Use the cached data if possible`
`37`		`- if (_debugData.Count != 0)`
`38`		`- return _debugData;`
	`37`	`+ if (field.Count != 0)`
	`38`	`+ return field;`
`39`	`39`
`40`	`40`	`// If we have no resource table, just return`
`41`	`41`	`if (DebugDirectoryTable == null \|\| DebugDirectoryTable.Length == 0)`
`42`		`- return _debugData;`
	`42`	`+ return field;`
`43`	`43`
`44`	`44`	`// Otherwise, build and return the cached dictionary`
`45`		`- ParseDebugTable();`
`46`		`- return _debugData;`
	`45`	`+ field = ParseDebugTable();`
	`46`	`+ return field;`
`47`	`47`	`}`
`48`	`48`	`}`
`49`		`- }`
	`49`	`+ } = [];`
`50`	`50`
`51`	`51`	`/// <inheritdoc cref="Models.PortableExecutable.DebugData.Table.Table"/>`
`52`	`52`	`public Data.Models.PortableExecutable.DebugData.Entry[]? DebugDirectoryTable`
`@@ -822,12 +822,7 @@ public string? AssemblyVersion`
`822`	`822`	`#region Instance Variables`
`823`	`823`
`824`	`824`	`/// <summary>`
`825`		`- /// Cached debug data`
`826`		`- /// </summary>`
`827`		`- private readonly Dictionary<int, object> _debugData = [];`
`828`		`-`
`829`		`- /// <summary>`
`830`		`- /// Lock object for <see cref="_debugData"/>`
	`825`	`+ /// Lock object for <see cref="DebugData"/>`
`831`	`826`	`/// </summary>`
`832`	`827`	`private readonly object _debugDataLock = new();`
`833`	`828`
`@@ -1200,11 +1195,14 @@ public PortableExecutable(Executable model, Stream data, long offset, long lengt`
`1200`	`1195`	`/// <summary>`
`1201`	`1196`	`/// Parse the debug directory table information`
`1202`	`1197`	`/// </summary>`
`1203`		`- private void ParseDebugTable()`
	`1198`	`+ private Dictionary<int, object> ParseDebugTable()`
`1204`	`1199`	`{`
`1205`	`1200`	`// If there is no debug table`
`1206`	`1201`	`if (DebugDirectoryTable == null \|\| DebugDirectoryTable.Length == 0)`
`1207`		`- return;`
	`1202`	`+ return [];`
	`1203`	`+`
	`1204`	`+ // Create a new debug table`
	`1205`	`+ Dictionary<int, object> debugData = [];`
`1208`	`1206`
`1209`	`1207`	`// Loop through all debug table entries`
`1210`	`1208`	`for (int i = 0; i < DebugDirectoryTable.Length; i++)`
`@@ -1223,7 +1221,7 @@ private void ParseDebugTable()`
`1223`	`1221`	`}`
`1224`	`1222`	`catch (EndOfStreamException)`
`1225`	`1223`	`{`
`1226`		`- return;`
	`1224`	`+ return debugData;`
`1227`	`1225`	`}`
`1228`	`1226`
`1229`	`1227`	`// If we have CodeView debug data, try to parse it`
`@@ -1242,7 +1240,7 @@ private void ParseDebugTable()`
`1242`	`1240`	`var nb10ProgramDatabase = entryData.ParseNB10ProgramDatabase(ref offset);`
`1243`	`1241`	`if (nb10ProgramDatabase != null)`
`1244`	`1242`	`{`
`1245`		`- _debugData[i] = nb10ProgramDatabase;`
	`1243`	`+ debugData[i] = nb10ProgramDatabase;`
`1246`	`1244`	`continue;`
`1247`	`1245`	`}`
`1248`	`1246`	`}`
`@@ -1253,16 +1251,18 @@ private void ParseDebugTable()`
`1253`	`1251`	`var rsdsProgramDatabase = entryData.ParseRSDSProgramDatabase(ref offset);`
`1254`	`1252`	`if (rsdsProgramDatabase != null)`
`1255`	`1253`	`{`
`1256`		`- _debugData[i] = rsdsProgramDatabase;`
	`1254`	`+ debugData[i] = rsdsProgramDatabase;`
`1257`	`1255`	`continue;`
`1258`	`1256`	`}`
`1259`	`1257`	`}`
`1260`	`1258`	`}`
`1261`	`1259`	`else`
`1262`	`1260`	`{`
`1263`		`- _debugData[i] = entryData;`
	`1261`	`+ debugData[i] = entryData;`
`1264`	`1262`	`}`
`1265`	`1263`	`}`
	`1264`	`+`
	`1265`	`+ return debugData;`
`1266`	`1266`	`}`
`1267`	`1267`
`1268`	`1268`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public string[]? ArchiveFilenames`
`22`	`22`	`{`
`23`	`23`	`get`
`24`	`24`	`{`
`25`		`- // Use the cached value if we have it`
	`25`	`+ // Use the cached value, if it exists`
`26`	`26`	`if (field != null)`
`27`	`27`	`return field;`
`28`	`28`