Merge pull request #7708 from pchote/sequence-utility

Add a utility command for checking sequences.

OpenRA.Game/Graphics/SequenceProvider.cs

@@ -39,6 +39,7 @@ namespace OpenRA.Graphics
 
 	public interface ISpriteSequenceLoader
 	{
+		Action<string> OnMissingSpriteError { get; set; }
 		IReadOnlyDictionary<string, ISpriteSequence> ParseSequences(ModData modData, TileSet tileSet, SpriteCache cache, MiniYamlNode node);
 	}
 

OpenRA.Game/ModData.cs

@@ -72,6 +72,7 @@ namespace OpenRA
 				throw new InvalidOperationException("Unable to find a sequence loader for type '{0}'.".F(sequenceFormat.Type));
 
 			SpriteSequenceLoader = (ISpriteSequenceLoader)ctor.Invoke(new[] { this });
+			SpriteSequenceLoader.OnMissingSpriteError = s => Log.Write("debug", s);
 
 			// HACK: Mount only local folders so we have a half-working environment for the asset installer
 			GlobalFileSystem.UnmountAll();

OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs

@@ -18,6 +18,7 @@ namespace OpenRA.Mods.Common.Graphics
 {
 	public class DefaultSpriteSequenceLoader : ISpriteSequenceLoader
 	{
+		public Action<string> OnMissingSpriteError { get; set; }
 		public DefaultSpriteSequenceLoader(ModData modData) { }
 
 		public virtual ISpriteSequence CreateSequence(ModData modData, TileSet tileSet, SpriteCache cache, string sequence, string animation, MiniYaml info)
@@ -48,7 +49,7 @@ namespace OpenRA.Mods.Common.Graphics
 					catch (FileNotFoundException ex)
 					{
 						// Eat the FileNotFound exceptions from missing sprites
-						Log.Write("debug", ex.Message);
+						OnMissingSpriteError(ex.Message);
 					}
 				}
 			}

OpenRA.Mods.Common/OpenRA.Mods.Common.csproj

@@ -616,6 +616,7 @@
     <Compile Include="Widgets\ViewportControllerWidget.cs" />
     <Compile Include="Widgets\VqaPlayerWidget.cs" />
     <Compile Include="Traits\Render\WithInfantryBody.cs" />
+    <Compile Include="UtilityCommands\CheckSequenceSprites.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <PropertyGroup>

OpenRA.Mods.Common/UtilityCommands/CheckSequenceSprites.cs

@@ -0,0 +1,51 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2015 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. For more information,
+ * see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using OpenRA.FileSystem;
+using OpenRA.Graphics;
+using OpenRA.Traits;
+using StyleCop;
+
+namespace OpenRA.Mods.Common.UtilityCommands
+{
+	class CheckSquenceSprites : IUtilityCommand
+	{
+		public string Name { get { return "--check-sequence-sprites"; } }
+
+		[Desc("Check the sequence definitions for missing sprite files.")]
+		public void Run(ModData modData, string[] args)
+		{
+			// HACK: The engine code assumes that Game.modData is set.
+			Game.ModData = modData;
+			GlobalFileSystem.LoadFromManifest(Game.ModData.Manifest);
+			Game.ModData.SpriteSequenceLoader.OnMissingSpriteError = s => Console.WriteLine("\t" + s);
+
+			foreach (var t in Game.ModData.Manifest.TileSets)
+			{
+				var ts = new TileSet(Game.ModData, t);
+				Console.WriteLine("Tileset: " + ts.Name);
+				var sc = new SpriteCache(modData.SpriteLoaders, ts.Extensions, new SheetBuilder(SheetType.Indexed));
+				var sequenceFiles = modData.Manifest.Sequences;
+
+				var nodes = sequenceFiles
+					.Select(s => MiniYaml.FromFile(s))
+					.Aggregate(MiniYaml.MergeLiberal);
+
+				foreach (var n in nodes)
+					Game.ModData.SpriteSequenceLoader.ParseSequences(Game.ModData, ts, sc, n);
+			}
+		}
+	}
+}