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

Provide names and pools when creating MiniYaml.

Browse Source 
- Rename the filename parameter to name and make it mandatory. Review all callers and ensure a useful string is provided as input, to ensure sufficient context is included for logging and debugging. This can be a filename, url, or any arbitrary text so include whatever context seems reasonable.
- When several MiniYamls are created that have similar content, provide a shared string pool. This allows strings that are common between all the yaml to be shared, reducing long term memory usage. We also change the pool from a dictionary to a set. Originally a Dictionary had to be used so we could call TryGetValue to get a reference to the pooled string. Now that more recent versions of dotnet provide a TryGetValue on HashSet, we can use a set directly without the memory wasted by having to store both keys and values in a dictionary.
This commit is contained in:
RoosterDragon
2024-01-13 11:24:41 +00:00
committed by Gustas
parent ca6aa5ebf1
commit b58c1ea5bc
39 changed files with 146 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
OpenRA.Mods.Common/UpdateRules/Rules/20210321/RemovePlaceBuildingPalette.cs
View File

@@ -64,7 +64,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
}
if (removed > 0)
locations.Add($"{actorNode.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key} ({actorNode.Location.Name})");
yield break;
}

2
OpenRA.Mods.Common/UpdateRules/Rules/20210321/RemoveRenderSpritesScale.cs
View File

@@ -23,7 +23,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
foreach (var renderSprites in actorNode.ChildrenMatching("RenderSprites"))
if (renderSprites.RemoveNodes("Scale") > 0)
yield return $"The actor-level scaling has been removed from {actorNode.Key} ({actorNode.Location.Filename}).\n" +
yield return $"The actor-level scaling has been removed from {actorNode.Key} ({actorNode.Location.Name}).\n" +
"You must manually define Scale on its sequences instead.";
}
}

2
OpenRA.Mods.Common/UpdateRules/Rules/20210321/RemoveSmokeTrailWhenDamaged.cs
View File

@@ -40,7 +40,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
{
var locationKey = $"{actorNode.Key} ({actorNode.Location.Filename})";
var locationKey = $"{actorNode.Key} ({actorNode.Location.Name})";
var anyConditionalSmokeTrail = false;
foreach (var smokeTrail in actorNode.ChildrenMatching("SmokeTrailWhenDamaged"))

6
OpenRA.Mods.Common/UpdateRules/Rules/20210321/ReplaceShadowPalette.cs
View File

@@ -37,7 +37,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
foreach (var projectileNode in weaponNode.ChildrenMatching("Projectile"))
if (projectileNode.RemoveNodes("ShadowPalette") > 0)
locations.Add($"{weaponNode.Key}: {weaponNode.Key} ({weaponNode.Location.Filename})");
locations.Add($"{weaponNode.Key}: {weaponNode.Key} ({weaponNode.Location.Name})");
yield break;
}
@@ -46,11 +46,11 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
foreach (var node in actorNode.ChildrenMatching("WithShadow"))
if (node.RemoveNodes("Palette") > 0)
locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Name})");
foreach (var node in actorNode.ChildrenMatching("WithParachute"))
if (node.RemoveNodes("ShadowPalette") > 0)
locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Name})");
yield break;
}

2
OpenRA.Mods.Common/UpdateRules/Rules/20210321/ReplaceWithColoredOverlayPalette.cs
View File

@@ -35,7 +35,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
foreach (var node in actorNode.ChildrenMatching("WithColoredOverlay"))
if (node.RemoveNodes("Palette") > 0)
locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Name})");
yield break;
}

2
OpenRA.Mods.Common/UpdateRules/Rules/20210321/UnhardcodeVeteranProductionIconOverlay.cs
View File

@@ -40,7 +40,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
}
foreach (var producibleWithLevel in actorNode.ChildrenMatching("ProducibleWithLevel"))
locations.Add($"{actorNode.Key}: {producibleWithLevel.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key}: {producibleWithLevel.Key} ({actorNode.Location.Name})");
yield break;
}

5
OpenRA.Mods.Common/UpdateRules/Rules/20230225/ExplicitSequenceFilenames.cs
View File

@@ -37,7 +37,8 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
// Keep a resolved copy of the sequences so we can account for values imported through inheritance or Defaults.
// This will be modified during processing, so take a deep copy to avoid side-effects on other update rules.
this.resolvedImagesNodes = MiniYaml.FromString(resolvedImagesNodes.WriteToString()).ConvertAll(n => new MiniYamlNodeBuilder(n));
this.resolvedImagesNodes = MiniYaml.FromString(resolvedImagesNodes.WriteToString(), nameof(BeforeUpdateSequences))
.ConvertAll(n => new MiniYamlNodeBuilder(n));
var requiredMetadata = new HashSet<string>();
foreach (var imageNode in resolvedImagesNodes)
@@ -285,7 +286,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
imageNode.Value.Nodes.Insert(inheritsNodeIndex, defaultsNode);
}
var nodes = MiniYaml.FromString(duplicateTilesetCount.First(kv => kv.Value == maxDuplicateTilesetCount).Key);
var nodes = MiniYaml.FromString(duplicateTilesetCount.First(kv => kv.Value == maxDuplicateTilesetCount).Key, nameof(UpdateSequenceNode));
defaultTilesetFilenamesNode = new MiniYamlNodeBuilder("TilesetFilenames", "", nodes);
defaultsNode.Value.Nodes.Insert(0, defaultTilesetFilenamesNode);
}

2
OpenRA.Mods.Common/UpdateRules/Rules/20230225/RemoveExperienceFromInfiltrates.cs
View File

@@ -40,7 +40,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
removed = true;
if (removed)
locations.Add($"{actorNode.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key} ({actorNode.Location.Name})");
yield break;
}

2
OpenRA.Mods.Common/UpdateRules/Rules/20230225/RemoveSequenceHasEmbeddedPalette.cs
View File

@@ -48,7 +48,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
traitNode.RemoveNodes("Image");
traitNode.RemoveNodes("Sequence");
locations.Add($"{actorNode.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key} ({actorNode.Location.Name})");
}
yield break;

2
OpenRA.Mods.Common/UpdateRules/Rules/20231010/RemoveValidRelationsFromCapturable.cs
View File

@@ -36,7 +36,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
foreach (var capturable in actorNode.ChildrenMatching("Capturable"))
{
if (capturable.RemoveNodes("ValidRelations") > 0)
locations.Add($"{actorNode.Key}: {capturable.Key} ({actorNode.Location.Filename})");
locations.Add($"{actorNode.Key}: {capturable.Key} ({actorNode.Location.Name})");
}
yield break;

12
OpenRA.Mods.Common/UpdateRules/UpdateUtils.cs
View File

@@ -35,7 +35,7 @@ namespace OpenRA.Mods.Common.UpdateRules
continue;
}
yaml.Add(((IReadWritePackage)package, name, MiniYaml.FromStream(package.GetStream(name), name, false).ConvertAll(n => new MiniYamlNodeBuilder(n))));
yaml.Add(((IReadWritePackage)package, name, MiniYaml.FromStream(package.GetStream(name), $"{package.Name}:{name}", false).ConvertAll(n => new MiniYamlNodeBuilder(n))));
}
return yaml;
@@ -68,7 +68,7 @@ namespace OpenRA.Mods.Common.UpdateRules
{
// Ignore any files that aren't in the map bundle
if (!filename.Contains('|') && mapPackage.Contains(filename))
fileSet.Add((mapPackage, filename, MiniYaml.FromStream(mapPackage.GetStream(filename), filename, false).ConvertAll(n => new MiniYamlNodeBuilder(n))));
fileSet.Add((mapPackage, filename, MiniYaml.FromStream(mapPackage.GetStream(filename), $"{mapPackage.Name}:{filename}", false).ConvertAll(n => new MiniYamlNodeBuilder(n))));
else if (modData.ModFiles.Exists(filename))
externalFilenames.Add(filename);
}
@@ -94,7 +94,7 @@ namespace OpenRA.Mods.Common.UpdateRules
return manualSteps;
}
var yaml = new MiniYamlBuilder(null, MiniYaml.FromStream(mapStream, mapPackage.Name, false));
var yaml = new MiniYamlBuilder(null, MiniYaml.FromStream(mapStream, $"{mapPackage.Name}:map.yaml", false));
files = new YamlFileSet() { (mapPackage, "map.yaml", yaml.Nodes) };
manualSteps.AddRange(rule.BeforeUpdate(modData));
@@ -170,9 +170,9 @@ namespace OpenRA.Mods.Common.UpdateRules
{
// Explicit package paths never refer to a map
if (!filename.Contains('|') && mapPackage.Contains(filename))
return MiniYaml.FromStream(mapPackage.GetStream(filename));
return MiniYaml.FromStream(mapPackage.GetStream(filename), $"{mapPackage.Name}:{filename}");
return MiniYaml.FromStream(fileSystem.Open(filename));
return MiniYaml.FromStream(fileSystem.Open(filename), filename);
}));
}
@@ -215,7 +215,7 @@ namespace OpenRA.Mods.Common.UpdateRules
if (mapStream == null)
continue;
var yaml = new MiniYamlBuilder(new MiniYaml(null, MiniYaml.FromStream(mapStream, package.Name, false)));
var yaml = new MiniYamlBuilder(new MiniYaml(null, MiniYaml.FromStream(mapStream, $"{package.Name}:map.yaml", false)));
var mapRulesNode = yaml.NodeWithKeyOrDefault("Rules");
if (mapRulesNode != null)
foreach (var f in LoadExternalMapYaml(modData, mapRulesNode.Value, externalFilenames))