Add a lint check for cursor definitions.

OpenRA.Mods.Common/Lint/CheckCursors.cs

@@ -0,0 +1,55 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2020 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.Traits;
+
+namespace OpenRA.Mods.Common.Lint
+{
+	class CheckCursors : ILintRulesPass
+	{
+		public void Run(Action<string> emitError, Action<string> emitWarning, ModData modData, Ruleset rules)
+		{
+			var fileSystem = modData.DefaultFileSystem;
+			var sequenceYaml = MiniYaml.Merge(modData.Manifest.Cursors.Select(s => MiniYaml.FromStream(fileSystem.Open(s), s)));
+			var nodesDict = new MiniYaml(null, sequenceYaml).ToDictionary();
+
+			// Avoid using CursorProvider as it attempts to load palettes from the file system.
+			var cursors = new List<string>();
+			foreach (var s in nodesDict["Cursors"].Nodes)
+				foreach (var sequence in s.Value.Nodes)
+					cursors.Add(sequence.Key);
+
+			foreach (var actorInfo in rules.Actors)
+			{
+				foreach (var traitInfo in actorInfo.Value.TraitInfos<TraitInfo>())
+				{
+					var fields = traitInfo.GetType().GetFields();
+					foreach (var field in fields)
+					{
+						var cursorReference = field.GetCustomAttributes<CursorReferenceAttribute>(true).FirstOrDefault();
+						if (cursorReference == null)
+							continue;
+
+						var cursor = LintExts.GetFieldValues(traitInfo, field, emitError, cursorReference.DictionaryReference).FirstOrDefault();
+						if (string.IsNullOrEmpty(cursor))
+							continue;
+
+						if (!cursors.Contains(cursor))
+							emitError("Undefined cursor {0} for actor {1} with trait {2}.".F(cursor, actorInfo.Value.Name, traitInfo));
+					}
+				}
+			}
+		}
+	}
+}