Optimize MapPreview rule loading.

2021-04-06 14:01:14 +01:00
parent 0bbb32e8ac
commit 9770967b04
2 changed files with 130 additions and 8 deletions
--- a/OpenRA.Mods.Common/Lint/CheckWorldAndPlayerInherits.cs
+++ b/OpenRA.Mods.Common/Lint/CheckWorldAndPlayerInherits.cs
@@ -0,0 +1,96 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2021 The OpenRA Developers (see AUTHORS)
+ * 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;
+using System.Collections.Generic;
+using System.Linq;
+using OpenRA.FileSystem;
+using OpenRA.Mods.Common.UpdateRules;
+using OpenRA.Server;
+
+namespace OpenRA.Mods.Common.Lint
+{
+	public class CheckWorldAndPlayerInherits : ILintPass, ILintMapPass, ILintServerMapPass
+	{
+		void ILintPass.Run(Action<string> emitError, Action<string> emitWarning, ModData modData)
+		{
+			var nodes = new List<MiniYamlNode>();
+			foreach (var f in modData.Manifest.Rules)
+				nodes.AddRange(MiniYaml.FromStream(modData.DefaultFileSystem.Open(f), f));
+
+			Run(emitError, nodes);
+		}
+
+		void ILintMapPass.Run(Action<string> emitError, Action<string> emitWarning, ModData modData, Map map)
+		{
+			CheckMapYaml(emitError, modData, map, map.RuleDefinitions);
+		}
+
+		void ILintServerMapPass.Run(Action<string> emitError, Action<string> emitWarning, ModData modData, MapPreview map, Ruleset mapRules)
+		{
+			CheckMapYaml(emitError, modData, map, map.RuleDefinitions);
+		}
+
+		void CheckMapYaml(Action<string> emitError, ModData modData, IReadOnlyFileSystem fileSystem, MiniYaml ruleDefinitions)
+		{
+			if (ruleDefinitions == null)
+				return;
+
+			var files = modData.Manifest.Rules.AsEnumerable();
+			if (ruleDefinitions.Value != null)
+			{
+				var mapFiles = FieldLoader.GetValue<string[]>("value", ruleDefinitions.Value);
+				files = files.Append(mapFiles);
+			}
+
+			var nodes = new List<MiniYamlNode>();
+			foreach (var f in files)
+				nodes.AddRange(MiniYaml.FromStream(fileSystem.Open(f), f));
+
+			nodes.AddRange(ruleDefinitions.Nodes);
+			Run(emitError, nodes);
+		}
+
+		void Run(Action<string> emitError, List<MiniYamlNode> nodes)
+		{
+			// Build a list of all inheritance relationships
+			var inheritsMap = new Dictionary<string, List<string>>();
+			foreach (var actorNode in nodes)
+			{
+				var inherits = inheritsMap.GetOrAdd(actorNode.Key, _ => new List<string>());
+				foreach (var inheritsNode in actorNode.ChildrenMatching("Inherits"))
+					inherits.Add(inheritsNode.Value.Value);
+			}
+
+			CheckInheritance(emitError, "World", inheritsMap);
+			CheckInheritance(emitError, "Player", inheritsMap);
+		}
+
+		void CheckInheritance(Action<string> emitError, string actor, Dictionary<string, List<string>> inheritsMap)
+		{
+			var toResolve = new Queue<string>(inheritsMap.Keys.Where(k => k.ToLowerInvariant() == actor.ToLowerInvariant()));
+			while (toResolve.TryDequeue(out var key))
+			{
+				// Missing keys are a fatal merge error, so will have already been reported by other lint checks
+				if (!inheritsMap.TryGetValue(key, out var inherits))
+					continue;
+
+				foreach (var inherit in inherits)
+				{
+					if (inherit[0] != '^')
+						emitError("{0} definition inherits from {1}, which is not an abstract template.".F(actor, inherit));
+
+					toResolve.Enqueue(inherit);
+				}
+			}
+		}
+	}
+}