name strings in string table

Author: LeftofZen

OpenLocoTool/DatFileParsing/LocoAttributes.cs

@@ -24,11 +24,16 @@ public class LocoStructSizeAttribute : Attribute
 	}
 
 	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false)]
-	public class LocoStringCountAttribute : Attribute
+	public class LocoStringTableAttribute : Attribute
 	{
-		public LocoStringCountAttribute(int count) => Count = count;
+		public LocoStringTableAttribute(params string[] names)
+		{
+			Names = names;
+		}
 
-		public int Count { get; }
+		public string[] Names { get; }
+
+		public int Count => Names.Length;
 	}
 
 	// basically a 'skip' attribute to allow deferred loading for variable data

OpenLocoTool/DatFileParsing/ObjectAnnotator.cs

@@ -129,7 +129,6 @@ public static IList<Annotation> AnnotateG1Data(byte[] fullData, int runningCount
 					}
 
 					annotations.Add(new Annotation("Image " + (i + 1), g1ImageDataAnnotation, imageStart, imageSize));
-					//runningCount = imageDataStart + (int)g32elements[i].Offset;
 				}
 			}
 
@@ -141,8 +140,8 @@ public static int AnnotateStringTable(byte[] fullData, int runningCount, ILocoSt
 			var root = new Annotation("String Table", runningCount, 1);
 			annotations.Add(root);
 
-			var stringAttr = locoStruct.GetType().GetCustomAttribute(typeof(LocoStringCountAttribute), inherit: false) as LocoStringCountAttribute;
-			var stringsInTable = stringAttr?.Count ?? 1;
+			var stringAttr = locoStruct.GetType().GetCustomAttribute(typeof(LocoStringTableAttribute), inherit: false) as LocoStringTableAttribute;
+			var stringsInTable = stringAttr?.Count ?? 0;
 
 			for (var i = 0; i < stringsInTable; i++)
 			{
@@ -160,9 +159,9 @@ public static int AnnotateStringTable(byte[] fullData, int runningCount, ILocoSt
 					else
 					{
 						continuing = false;
-					}	
+					}
 				}
-				while (continuing); 
+				while (continuing);
 
 				var endIndexOfStringList = index + runningCount;
 				var nullIndex = 0;

OpenLocoTool/DatFileParsing/SawyerStreamReader.cs

@@ -48,8 +48,6 @@ public G1Dat LoadG1(string filename)
 		// load file
 		public ILocoObject LoadFull(string filename, bool loadExtra = true)
 		{
-			//LoadFullExperimental(filename);
-
 			ReadOnlySpan<byte> fullData = LoadBytesFromFile(filename);
 
 			// make openlocotool useful objects
@@ -111,18 +109,17 @@ public ILocoObject LoadFull(string filename, bool loadExtra = true)
 
 		static (StringTable table, int bytesRead) LoadStringTable(ReadOnlySpan<byte> data, ILocoStruct locoStruct)
 		{
-			var stringAttr = locoStruct.GetType().GetCustomAttribute(typeof(LocoStringCountAttribute), inherit: false) as LocoStringCountAttribute;
-			var stringsInTable = stringAttr?.Count ?? throw new ArgumentException($"Struct {locoStruct.GetType().Name} had no string count attribute");
-			var strings = new StringTable();
+			var stringTableAttr = locoStruct.GetType().GetCustomAttribute(typeof(LocoStringTableAttribute), inherit: false) as LocoStringTableAttribute;
+			var stringTable = new StringTable();
 
-			if (data.Length == 0 || stringsInTable == 0)
+			if (data.Length == 0 || stringTableAttr == null || stringTableAttr.Count == 0)
 			{
-				return (strings, 0);
+				return (stringTable, 0);
 			}
 
 			var ptr = 0;
 
-			for (var i = 0; i < stringsInTable; ++i)
+			for (var i = 0; i < stringTableAttr.Count; ++i)
 			{
 				for (; ptr < data.Length && data[ptr] != 0xFF;)
 				{
@@ -132,22 +129,22 @@ public ILocoObject LoadFull(string filename, bool loadExtra = true)
 					while (data[ptr++] != '\0') ;
 
 					var str = Encoding.ASCII.GetString(data[ini..(ptr - 1)]); // do -1 to exclude the \0
-
-					if (strings.ContainsKey((i, lang)))
+					var stringName = stringTableAttr.Names[i];
+					if (stringTable.ContainsKey((stringName, lang)))
 					{
 						//Logger.Error($"Key {(i, lang)} already exists (this shouldn't happen)");
 						break;
 					}
 					else
 					{
-						strings.Add((i, lang), str);
+						stringTable.Add((stringName, lang), str);
 					}
 				}
 
 				ptr++; // add one because we skipped the 0xFF byte at the end
 			}
 
-			return (strings, ptr);
+			return (stringTable, ptr);
 		}
 
 		static (G1Header header, List<G1Element32> table, int bytesRead) LoadImageTable(ReadOnlySpan<byte> data)

OpenLocoTool/DatFileParsing/Typedefs.cs

@@ -9,14 +9,13 @@
 global using Speed32 = System.Int32;
 global using MicroZ = System.Byte;
 global using SoundObjectId = System.Byte;
-global using StringTable = System.Collections.Generic.Dictionary<(int, OpenLocoTool.LanguageId), string>;
+global using StringTable = System.Collections.Generic.Dictionary<(string, OpenLocoTool.LanguageId), string>;
 using System.ComponentModel;
 
 namespace OpenLocoTool.DatFileParsing
 {
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0x04)]
-	[LocoStringCount(0)]
 	public record Pos2(
 		[property: LocoStructOffset(0x00)] int16_t X,
 		[property: LocoStructOffset(0x02)] int16_t Y

OpenLocoTool/Objects/AirportObject.cs

@@ -47,7 +47,7 @@ public record MovementEdge(
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0xBA)]
-	[LocoStringCount(1)]
+	[LocoStringTable("Name")]
 	public record AirportObject(
 		//[property: LocoStructOffset(0x00)] string_id Name,
 		[property: LocoStructOffset(0x02)] int16_t BuildCostFactor,

OpenLocoTool/Objects/BridgeObject.cs

@@ -8,7 +8,7 @@ namespace OpenLocoTool.Objects
 	// it works just the same but has more code.
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0x2C)]
-	[LocoStringCount(1)]
+	[LocoStringTable("Name")]
 	public class BridgeObject : ILocoStruct, ILocoStructVariableData
 	{
 		public const ObjectType ObjType = ObjectType.Bridge;

OpenLocoTool/Objects/BuildingObject.cs

@@ -16,7 +16,7 @@ public enum BuildingObjectFlags : uint8_t
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0xBE)]
-	[LocoStringCount(1)]
+	[LocoStringTable("Name")]
 	public record BuildingObject(
 			//[property: LocoStructOffset(0x00)] string_id Name,
 			//[property: LocoStructOffset(0x02)] uint32_t Image,

OpenLocoTool/Objects/CargoObject.cs

@@ -15,7 +15,7 @@ public enum CargoObjectFlags : uint8_t
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0x1F)]
-	[LocoStringCount(4)]
+	[LocoStringTable("Name", "UnitsAndCargoName", "UnitNameSingular", "UnitNamePlural")]
 	public record CargoObject(
 		//[property: LocoStructOffset(0x00)] string_id Name,
 		[property: LocoStructOffset(0x02)] uint16_t var_02,
@@ -40,19 +40,19 @@ public record CargoObject(
 		public static ObjectType ObjectType => ObjectType.Cargo;
 		public static int StructSize => 0x1F;
 
-		public string Name { get; set; }
-		public string UnitsAndCargoName { get; set; }
-
-		public string UnitNameSingular { get; set; }
-
-		public string UnitNamePlural { get; set; }
+		//public string Name { get; set; }
+		//public string UnitsAndCargoName { get; set; }
+		//
+		//public string UnitNameSingular { get; set; }
+		//
+		//public string UnitNamePlural { get; set; }
 
 		public void LoadPostStringTable(StringTable stringTable)
 		{
-			Name = stringTable[(0, (LanguageId)0)];
-			UnitsAndCargoName = stringTable[(1, (LanguageId)0)];
-			UnitNameSingular = stringTable[(2, (LanguageId)0)];
-			UnitNamePlural = stringTable[(3, (LanguageId)0)];
+			// Name = stringTable[(0, (LanguageId)0)];
+			// UnitsAndCargoName = stringTable[(1, (LanguageId)0)];
+			// UnitNameSingular = stringTable[(2, (LanguageId)0)];
+			// UnitNamePlural = stringTable[(3, (LanguageId)0)];
 		}
 	}
 }

OpenLocoTool/Objects/CliffEdgeObject.cs

@@ -6,7 +6,7 @@ namespace OpenLocoTool.Objects
 {
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0x06)]
-	[LocoStringCount(1)]
+	[LocoStringTable("Name")]
 	public class CliffEdgeObject : ILocoStruct
 	{
 		public const ObjectType ObjType = ObjectType.CliffEdge;

OpenLocoTool/Objects/ClimateObject.cs

@@ -6,7 +6,7 @@ namespace OpenLocoTool.Objects
 {
 	[TypeConverter(typeof(ExpandableObjectConverter))]
 	[LocoStructSize(0x0A)]
-	[LocoStringCount(1)]
+	[LocoStringTable("Name")]
 	public record ClimateObject(
 		//[property: LocoStructOffset(0x00)] string_id Name,
 		[property: LocoStructOffset(0x02)] uint8_t FirstSeason,