Files
OpenRA/OpenRA.Game/Widgets/WidgetLoader.cs
RoosterDragon b58c1ea5bc Provide names and pools when creating MiniYaml.
- 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.
2024-01-21 12:39:10 +02:00

89 lines
2.5 KiB
C#

#region Copyright & License Information
/*
* Copyright (c) The OpenRA Developers and Contributors
* This file is part of OpenRA, which is free software. It is made
* available to you under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version. For more
* information, see COPYING.
*/
#endregion
using System.Collections.Generic;
using System.IO;
using System.Linq;
using OpenRA.Widgets;
namespace OpenRA
{
public class WidgetLoader
{
readonly Dictionary<string, MiniYamlNode> widgets = new();
readonly ModData modData;
public WidgetLoader(ModData modData)
{
this.modData = modData;
var stringPool = new HashSet<string>(); // Reuse common strings in YAML
foreach (var file in modData.Manifest.ChromeLayout.Select(
a => MiniYaml.FromStream(modData.DefaultFileSystem.Open(a), a, stringPool: stringPool)))
foreach (var w in file)
{
var key = w.Key[(w.Key.IndexOf('@') + 1)..];
if (widgets.ContainsKey(key))
throw new InvalidDataException($"Widget has duplicate Key `{w.Key}` at {w.Location}");
widgets.Add(key, w);
}
}
public Widget LoadWidget(WidgetArgs args, Widget parent, string w)
{
if (!widgets.TryGetValue(w, out var ret))
throw new InvalidDataException($"Cannot find widget with Id `{w}`");
return LoadWidget(args, parent, ret);
}
public Widget LoadWidget(WidgetArgs args, Widget parent, MiniYamlNode node)
{
if (!args.ContainsKey("modData"))
args = new WidgetArgs(args) { { "modData", modData } };
var widget = NewWidget(node.Key, args);
parent?.AddChild(widget);
if (node.Key.Contains('@'))
FieldLoader.LoadField(widget, "Id", node.Key.Split('@')[1]);
foreach (var child in node.Value.Nodes)
if (child.Key != "Children")
FieldLoader.LoadField(widget, child.Key, child.Value.Value);
widget.Initialize(args);
foreach (var child in node.Value.Nodes)
if (child.Key == "Children")
foreach (var c in child.Value.Nodes)
LoadWidget(args, widget, c);
var logicNode = node.Value.NodeWithKeyOrDefault("Logic");
var logic = logicNode?.Value.ToDictionary();
args.Add("logicArgs", logic);
widget.PostInit(args);
args.Remove("logicArgs");
return widget;
}
static Widget NewWidget(string widgetType, WidgetArgs args)
{
widgetType = widgetType.Split('@')[0];
return Game.ModData.ObjectCreator.CreateObject<Widget>(widgetType + "Widget", args);
}
}
}