epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MiniYaml becomes an immutable data structure.

Browse Source 
This changeset is motivated by a simple concept - get rid of the MiniYaml.Clone and MiniYamlNode.Clone methods to avoid deep copying yaml trees during merging. MiniYaml becoming immutable allows the merge function to reuse existing yaml trees rather than cloning them, saving on memory and improving merge performance. On initial loading the YAML for all maps is processed, so this provides a small reduction in initial loading time.

The rest of the changeset is dealing with the change in the exposed API surface. Some With* helper methods are introduced to allow creating new YAML from existing YAML. Areas of code that generated small amounts of YAML are able to transition directly to the immutable model without too much ceremony. Some use cases are far less ergonomic even with these helper methods and so a MiniYamlBuilder is introduced to retain mutable creation functionality. This allows those areas to continue to use the old mutable structures. The main users are the update rules and linting capabilities.
This commit is contained in:
RoosterDragon
2023-05-06 10:39:15 +01:00
committed by Gustas
parent b6a5d19871
commit 949ba589c0
104 changed files with 722 additions and 393 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
OpenRA.Mods.Cnc/UtilityCommands/ImportGen1MapCommand.cs
View File

@@ -128,6 +128,26 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
public abstract void ValidateMapFormat(int format);
protected MiniYamlNodeBuilder GetWorldNodeBuilderFromRules()
{
var worldNode = Map.RuleDefinitions.Nodes.FirstOrDefault(n => n.Key == "World");
var worldNodeBuilder = worldNode != null
? new MiniYamlNodeBuilder(worldNode)
: new MiniYamlNodeBuilder("World", new MiniYamlBuilder("", new List<MiniYamlNode>()));
return worldNodeBuilder;
}
protected void SaveUpdatedWorldNodeToRules(MiniYamlNodeBuilder worldNodeBuilder)
{
var nodes = Map.RuleDefinitions.Nodes.ToList();
var worldNodeIndex = nodes.FindIndex(n => n.Key == "World");
if (worldNodeIndex != -1)
nodes[worldNodeIndex] = worldNodeBuilder.Build();
else
nodes.Add(worldNodeBuilder.Build());
Map.RuleDefinitions = Map.RuleDefinitions.WithNodes(nodes);
}
void LoadBriefing(IniFile file)
{
var briefingSection = file.GetSection("Briefing", true);
@@ -144,21 +164,18 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (briefing.Length == 0)
return;
var worldNode = Map.RuleDefinitions.Nodes.FirstOrDefault(n => n.Key == "World");
if (worldNode == null)
{
worldNode = new MiniYamlNode("World", new MiniYaml("", new List<MiniYamlNode>()));
Map.RuleDefinitions.Nodes.Add(worldNode);
}
var worldNodeBuilder = GetWorldNodeBuilderFromRules();
var missionData = worldNode.Value.Nodes.FirstOrDefault(n => n.Key == "MissionData");
var missionData = worldNodeBuilder.Value.Nodes.FirstOrDefault(n => n.Key == "MissionData");
if (missionData == null)
{
missionData = new MiniYamlNode("MissionData", new MiniYaml("", new List<MiniYamlNode>()));
worldNode.Value.Nodes.Add(missionData);
missionData = new MiniYamlNodeBuilder("MissionData", new MiniYamlBuilder("", new List<MiniYamlNode>()));
worldNodeBuilder.Value.Nodes.Add(missionData);
}
missionData.Value.Nodes.Add(new MiniYamlNode("Briefing", briefing.Replace("\n", " ").ToString()));
missionData.Value.Nodes.Add(new MiniYamlNodeBuilder("Briefing", briefing.Replace("\n", " ").ToString()));
SaveUpdatedWorldNodeToRules(worldNodeBuilder);
}
static void ReplaceInvalidTerrainTiles(Map map)
@@ -190,7 +207,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
void LoadVideos(IniFile file, string section)
{
var videos = new List<MiniYamlNode>();
var videos = new List<MiniYamlNodeBuilder>();
foreach (var s in file.GetSection(section))
{
if (s.Value != "x" && s.Value != "X" && s.Value != "<none>")
@@ -198,19 +215,19 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
switch (s.Key)
{
case "Intro":
videos.Add(new MiniYamlNode("BackgroundVideo", s.Value.ToLowerInvariant() + ".vqa"));
videos.Add(new MiniYamlNodeBuilder("BackgroundVideo", s.Value.ToLowerInvariant() + ".vqa"));
break;
case "Brief":
videos.Add(new MiniYamlNode("BriefingVideo", s.Value.ToLowerInvariant() + ".vqa"));
videos.Add(new MiniYamlNodeBuilder("BriefingVideo", s.Value.ToLowerInvariant() + ".vqa"));
break;
case "Action":
videos.Add(new MiniYamlNode("StartVideo", s.Value.ToLowerInvariant() + ".vqa"));
videos.Add(new MiniYamlNodeBuilder("StartVideo", s.Value.ToLowerInvariant() + ".vqa"));
break;
case "Win":
videos.Add(new MiniYamlNode("WinVideo", s.Value.ToLowerInvariant() + ".vqa"));
videos.Add(new MiniYamlNodeBuilder("WinVideo", s.Value.ToLowerInvariant() + ".vqa"));
break;
case "Lose":
videos.Add(new MiniYamlNode("LossVideo", s.Value.ToLowerInvariant() + ".vqa"));
videos.Add(new MiniYamlNodeBuilder("LossVideo", s.Value.ToLowerInvariant() + ".vqa"));
break;
}
}
@@ -218,21 +235,18 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (videos.Count > 0)
{
var worldNode = Map.RuleDefinitions.Nodes.FirstOrDefault(n => n.Key == "World");
if (worldNode == null)
{
worldNode = new MiniYamlNode("World", new MiniYaml("", new List<MiniYamlNode>()));
Map.RuleDefinitions.Nodes.Add(worldNode);
}
var worldNodeBuilder = GetWorldNodeBuilderFromRules();
var missionData = worldNode.Value.Nodes.FirstOrDefault(n => n.Key == "MissionData");
var missionData = worldNodeBuilder.Value.Nodes.FirstOrDefault(n => n.Key == "MissionData");
if (missionData == null)
{
missionData = new MiniYamlNode("MissionData", new MiniYaml("", new List<MiniYamlNode>()));
worldNode.Value.Nodes.Add(missionData);
missionData = new MiniYamlNodeBuilder("MissionData", new MiniYamlBuilder("", new List<MiniYamlNode>()));
worldNodeBuilder.Value.Nodes.Add(missionData);
}
missionData.Value.Nodes.AddRange(videos);
SaveUpdatedWorldNodeToRules(worldNodeBuilder);
}
}
@@ -264,13 +278,13 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
void LoadWaypoints(IniSection waypointSection)
{
var actorCount = Map.ActorDefinitions.Count;
var wps = waypointSection
.Where(kv => Exts.ParseIntegerInvariant(kv.Value) > 0)
.Select(kv => (WaypointNumber: Exts.ParseIntegerInvariant(kv.Key),
Location: LocationFromMapOffset(Exts.ParseIntegerInvariant(kv.Value), MapSize)));
// Add waypoint actors skipping duplicate entries
var nodes = new List<MiniYamlNode>();
foreach (var (waypointNumber, location) in wps.DistinctBy(location => location.Location))
{
if (!singlePlayer && waypointNumber <= 7)
@@ -281,7 +295,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
new OwnerInit("Neutral")
};
Map.ActorDefinitions.Add(new MiniYamlNode("Actor" + actorCount++, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (Map.ActorDefinitions.Count + nodes.Count), ar.Save()));
spawnCount++;
}
else
@@ -292,15 +306,17 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
new OwnerInit("Neutral")
};
SaveWaypoint(waypointNumber, ar);
nodes.Add(SaveWaypoint(waypointNumber, ar));
}
}
Map.ActorDefinitions = Map.ActorDefinitions.Concat(nodes).ToArray();
}
public virtual void SaveWaypoint(int waypointNumber, ActorReference waypointReference)
public virtual MiniYamlNode SaveWaypoint(int waypointNumber, ActorReference waypointReference)
{
var waypointName = "waypoint" + waypointNumber;
Map.ActorDefinitions.Add(new MiniYamlNode(waypointName, waypointReference.Save()));
return new MiniYamlNode(waypointName, waypointReference.Save());
}
void LoadSmudges(IniFile file, string section)
@@ -322,25 +338,24 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
craters.Add(node);
}
var worldNode = Map.RuleDefinitions.Nodes.FirstOrDefault(n => n.Key == "World");
worldNode ??= new MiniYamlNode("World", new MiniYaml("", new List<MiniYamlNode>()));
var worldNodeBuilder = GetWorldNodeBuilderFromRules();
if (scorches.Count > 0)
{
var initialScorches = new MiniYamlNode("InitialSmudges", new MiniYaml("", scorches));
var smudgeLayer = new MiniYamlNode("SmudgeLayer@SCORCH", new MiniYaml("", new List<MiniYamlNode>() { initialScorches }));
worldNode.Value.Nodes.Add(smudgeLayer);
var smudgeLayer = new MiniYamlNodeBuilder("SmudgeLayer@SCORCH", new MiniYamlBuilder("", new List<MiniYamlNode>() { initialScorches }));
worldNodeBuilder.Value.Nodes.Add(smudgeLayer);
}
if (craters.Count > 0)
{
var initialCraters = new MiniYamlNode("InitialSmudges", new MiniYaml("", craters));
var smudgeLayer = new MiniYamlNode("SmudgeLayer@CRATER", new MiniYaml("", new List<MiniYamlNode>() { initialCraters }));
worldNode.Value.Nodes.Add(smudgeLayer);
var smudgeLayer = new MiniYamlNodeBuilder("SmudgeLayer@CRATER", new MiniYamlBuilder("", new List<MiniYamlNode>() { initialCraters }));
worldNodeBuilder.Value.Nodes.Add(smudgeLayer);
}
if (worldNode.Value.Nodes.Count > 0 && !Map.RuleDefinitions.Nodes.Contains(worldNode))
Map.RuleDefinitions.Nodes.Add(worldNode);
if (worldNodeBuilder.Value.Nodes.Count > 0)
SaveUpdatedWorldNodeToRules(worldNodeBuilder);
}
// TODO: fix this -- will have bitrotted pretty badly.
@@ -395,6 +410,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
public void LoadActors(IniFile file, string section, List<string> players, Map map)
{
var nodes = new List<MiniYamlNode>();
foreach (var s in file.GetSection(section, true))
{
// Structures: num=owner,type,health,location,turret-facing,trigger
@@ -429,18 +445,18 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (section == "INFANTRY")
actor.Add(new SubCellInit((SubCell)Exts.ParseByte(parts[4])));
var actorCount = map.ActorDefinitions.Count;
if (!map.Rules.Actors.ContainsKey(parts[1].ToLowerInvariant()))
Console.WriteLine($"Ignoring unknown actor type: `{parts[1].ToLowerInvariant()}`");
else
map.ActorDefinitions.Add(new MiniYamlNode("Actor" + actorCount++, actor.Save()));
nodes.Add(new MiniYamlNode("Actor" + (map.ActorDefinitions.Count + nodes.Count), actor.Save()));
}
catch (Exception)
{
Console.WriteLine($"Malformed actor definition: `{s}`");
}
}
map.ActorDefinitions = map.ActorDefinitions.Concat(nodes).ToArray();
}
public abstract string ParseTreeActor(string input);
@@ -451,6 +467,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (terrain == null)
return;
var nodes = new List<MiniYamlNode>();
foreach (var kv in terrain)
{
var loc = Exts.ParseIntegerInvariant(kv.Key);
@@ -462,9 +479,10 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
new OwnerInit("Neutral")
};
var actorCount = Map.ActorDefinitions.Count;
Map.ActorDefinitions.Add(new MiniYamlNode("Actor" + actorCount++, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (Map.ActorDefinitions.Count + nodes.Count), ar.Save()));
}
Map.ActorDefinitions = Map.ActorDefinitions.Concat(nodes).ToArray();
}
}

34
OpenRA.Mods.Cnc/UtilityCommands/ImportGen2MapCommand.cs
View File

@@ -171,6 +171,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
}
}
var nodes = new List<MiniYamlNode>();
foreach (var cell in map.AllCells)
{
var overlayType = overlayPack[overlayIndex[cell]];
@@ -180,7 +181,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (TryHandleOverlayToActorInner(cell, overlayPack, overlayIndex, overlayType, out var ar))
{
if (ar != null)
map.ActorDefinitions.Add(new MiniYamlNode("Actor" + map.ActorDefinitions.Count, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (map.ActorDefinitions.Count + nodes.Count), ar.Save()));
continue;
}
@@ -196,10 +197,13 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
Console.WriteLine($"Cell {cell}: unknown overlay {overlayType}");
}
map.ActorDefinitions = map.ActorDefinitions.Concat(nodes).ToArray();
}
protected virtual void ReadWaypoints(Map map, IniFile file, int2 fullSize)
{
var nodes = new List<MiniYamlNode>();
var waypointsSection = file.GetSection("Waypoints", true);
foreach (var kv in waypointsSection)
{
@@ -214,12 +218,15 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
new OwnerInit("Neutral")
};
map.ActorDefinitions.Add(new MiniYamlNode("Actor" + map.ActorDefinitions.Count, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (map.ActorDefinitions.Count + nodes.Count), ar.Save()));
}
map.ActorDefinitions = map.ActorDefinitions.Concat(nodes).ToArray();
}
protected virtual void ReadTerrainActors(Map map, IniFile file, int2 fullSize)
{
var nodes = new List<MiniYamlNode>();
var terrainSection = file.GetSection("Terrain", true);
foreach (var kv in terrainSection)
{
@@ -238,12 +245,15 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (!map.Rules.Actors.ContainsKey(name))
Console.WriteLine($"Ignoring unknown actor type: `{name}`");
else
map.ActorDefinitions.Add(new MiniYamlNode("Actor" + map.ActorDefinitions.Count, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (map.ActorDefinitions.Count + nodes.Count), ar.Save()));
}
map.ActorDefinitions = map.ActorDefinitions.Concat(nodes).ToArray();
}
protected virtual void ReadActors(Map map, IniFile file, string type, int2 fullSize)
{
var nodes = new List<MiniYamlNode>();
var structuresSection = file.GetSection(type, true);
foreach (var kv in structuresSection)
{
@@ -296,8 +306,10 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (!map.Rules.Actors.ContainsKey(name))
Console.WriteLine($"Ignoring unknown actor type: `{name}`");
else
map.ActorDefinitions.Add(new MiniYamlNode("Actor" + map.ActorDefinitions.Count, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (map.ActorDefinitions.Count + nodes.Count), ar.Save()));
}
map.ActorDefinitions = map.ActorDefinitions.Concat(nodes).ToArray();
}
protected virtual void ReadLighting(Map map, IniFile file)
@@ -340,10 +352,13 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (lightingNodes.Count > 0)
{
map.RuleDefinitions.Nodes.Add(new MiniYamlNode("^BaseWorld", new MiniYaml("", new List<MiniYamlNode>()
map.RuleDefinitions = map.RuleDefinitions.WithNodesAppended(new[]
{
new MiniYamlNode("TerrainLighting", new MiniYaml("", lightingNodes))
})));
new MiniYamlNode("^BaseWorld", new MiniYaml("", new[]
{
new MiniYamlNode("TerrainLighting", new MiniYaml("", lightingNodes))
}))
});
}
}
@@ -357,6 +372,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
{ "LightBlueTint", "BlueTint" },
};
var nodes = new List<MiniYamlNode>();
foreach (var lamp in LampActors)
{
var lightingSection = file.GetSection(lamp, true);
@@ -380,12 +396,14 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (lightingNodes.Count > 0)
{
map.RuleDefinitions.Nodes.Add(new MiniYamlNode(lamp, new MiniYaml("", new List<MiniYamlNode>()
nodes.Add(new MiniYamlNode(lamp, new MiniYaml("", new[]
{
new MiniYamlNode("TerrainLightSource", new MiniYaml("", lightingNodes))
})));
}
}
map.RuleDefinitions = map.RuleDefinitions.WithNodesAppended(nodes);
}
protected virtual void SetInteractableBounds(Map map, int[] iniBounds)

10
OpenRA.Mods.Cnc/UtilityCommands/ImportRedAlertMapCommand.cs
View File

@@ -94,6 +94,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
void UnpackOverlayData(MemoryStream ms)
{
var nodes = new List<MiniYamlNode>();
for (var j = 0; j < MapSize; j++)
{
for (var i = 0; i < MapSize; i++)
@@ -115,11 +116,12 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
new OwnerInit("Neutral")
};
var actorCount = Map.ActorDefinitions.Count;
Map.ActorDefinitions.Add(new MiniYamlNode("Actor" + actorCount++, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (Map.ActorDefinitions.Count + nodes.Count), ar.Save()));
}
}
}
Map.ActorDefinitions = Map.ActorDefinitions.Concat(nodes).ToArray();
}
public override string ParseTreeActor(string input)
@@ -241,12 +243,12 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
LoadActors(file, "SHIPS", Players, Map);
}
public override void SaveWaypoint(int waypointNumber, ActorReference waypointReference)
public override MiniYamlNode SaveWaypoint(int waypointNumber, ActorReference waypointReference)
{
var waypointName = "waypoint" + waypointNumber;
if (waypointNumber == 98)
waypointName = "DefaultCameraPosition";
Map.ActorDefinitions.Add(new MiniYamlNode(waypointName, waypointReference.Save()));
return new MiniYamlNode(waypointName, waypointReference.Save());
}
}
}

10
OpenRA.Mods.Cnc/UtilityCommands/ImportTiberianDawnMapCommand.cs
View File

@@ -86,6 +86,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
if (overlay == null)
return;
var nodes = new List<MiniYamlNode>();
foreach (var kv in overlay)
{
var loc = Exts.ParseIntegerInvariant(kv.Key);
@@ -105,10 +106,11 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
new OwnerInit("Neutral")
};
var actorCount = Map.ActorDefinitions.Count;
Map.ActorDefinitions.Add(new MiniYamlNode("Actor" + actorCount++, ar.Save()));
nodes.Add(new MiniYamlNode("Actor" + (Map.ActorDefinitions.Count + nodes.Count), ar.Save()));
}
}
Map.ActorDefinitions = Map.ActorDefinitions.Concat(nodes).ToArray();
}
public override string ParseTreeActor(string input)
@@ -170,7 +172,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
ReadOverlay(file);
}
public override void SaveWaypoint(int waypointNumber, ActorReference waypointReference)
public override MiniYamlNode SaveWaypoint(int waypointNumber, ActorReference waypointReference)
{
var waypointName = "waypoint" + waypointNumber;
if (waypointNumber == 25)
@@ -179,7 +181,7 @@ namespace OpenRA.Mods.Cnc.UtilityCommands
waypointName = "DefaultCameraPosition";
else if (waypointNumber == 27)
waypointName = "DefaultChinookTarget";
Map.ActorDefinitions.Add(new MiniYamlNode(waypointName, waypointReference.Save()));
return new MiniYamlNode(waypointName, waypointReference.Save());
}
}
}