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

Completely rewrite miniyaml tree outputting utility commands

Browse Source 
Rename --actor-yaml to --resolved-rules <actor name>
Implement --resolved-sequences <image name>
Implement --resolved-weapons <weapon name>
This commit is contained in:
Taryn Hill
2016-11-12 15:27:40 -06:00
committed by Taryn Hill
parent ddb22ec2bd
commit 213e5532f5
6 changed files with 196 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
OpenRA.Mods.Common/OpenRA.Mods.Common.csproj
View File

@@ -756,7 +756,6 @@
<Compile Include="UtilityCommands\ListMixContentsCommand.cs" />
<Compile Include="UtilityCommands\ListMSCabContentsCommand.cs" />
<Compile Include="FileFormats\MSCabCompression.cs" />
<Compile Include="UtilityCommands\OutputActorMiniYamlCommand.cs" />
<Compile Include="Traits\World\ScriptLobbyDropdown.cs" />
<Compile Include="Activities\DeliverUnit.cs" />
<Compile Include="Activities\PickupUnit.cs" />
@@ -781,6 +780,10 @@
<Compile Include="Traits\World\BridgeLayer.cs" />
<Compile Include="Traits\Render\WithBridgeSpriteBody.cs" />
<Compile Include="Traits\Render\WithDeadBridgeSpriteBody.cs" />
<Compile Include="UtilityCommands\OutputResolvedRulesCommand.cs" />
<Compile Include="UtilityCommands\Utilities.cs" />
<Compile Include="UtilityCommands\OutputResolvedSequencesCommand.cs" />
<Compile Include="UtilityCommands\OutputResolvedWeaponsCommand.cs" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Target Name="AfterBuild">

54
OpenRA.Mods.Common/UtilityCommands/OutputActorMiniYamlCommand.cs
View File

@@ -1,54 +0,0 @@
using System;
using System.IO;
using System.Linq;
using OpenRA.FileSystem;
namespace OpenRA.Mods.Common.UtilityCommands
{
public class OutputActorMiniYamlCommand : IUtilityCommand
{
string IUtilityCommand.Name { get { return "--actor-yaml"; } }
bool IUtilityCommand.ValidateArguments(string[] args)
{
return args.Length == 2 || args.Length == 3;
}
[Desc("ACTOR-TYPE [PATH/TO/MAP]", "Display the finalized, merged MiniYaml tree for the given actor type. Input values are case-sensitive.")]
void IUtilityCommand.Run(Utility utility, string[] args)
{
// HACK: The engine code assumes that Game.modData is set.
var modData = Game.ModData = utility.ModData;
var actorType = args[1];
string mapPath = null;
Map map = null;
if (args.Length == 3)
{
try
{
mapPath = args[2];
map = new Map(modData, modData.ModFiles.OpenPackage(mapPath, new Folder(".")));
}
catch (InvalidDataException)
{
Console.WriteLine("Could not load map '{0}'.", mapPath);
Environment.Exit(2);
}
}
var fs = map ?? modData.DefaultFileSystem;
var topLevelNodes = MiniYaml.Load(fs, modData.Manifest.Rules, map == null ? null : map.RuleDefinitions);
var result = topLevelNodes.FirstOrDefault(n => n.Key == actorType);
if (result == null)
{
Console.WriteLine("Could not find actor '{0}' (name is case-sensitive).", actorType);
Environment.Exit(1);
}
Console.WriteLine(result.Value.Nodes.WriteToString());
}
}
}

46
OpenRA.Mods.Common/UtilityCommands/OutputResolvedRulesCommand.cs Normal file
View File

@@ -0,0 +1,46 @@
#region Copyright & License Information
/*
* Copyright 2007-2016 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;
namespace OpenRA.Mods.Common.UtilityCommands
{
public class OutputResolvedRulesCommand : IUtilityCommand
{
string IUtilityCommand.Name { get { return "--resolved-rules"; } }
bool IUtilityCommand.ValidateArguments(string[] args)
{
return args.Length == 2 || args.Length == 3;
}
[Desc("ACTOR [PATH/TO/MAP]", "Display the finalized, merged MiniYaml rules for the given actor. Input values are case-sensitive.")]
void IUtilityCommand.Run(Utility utility, string[] args)
{
// HACK: The engine code assumes that Game.ModData is set.
var modData = Game.ModData = utility.ModData;
var key = args[1];
var result = Utilities.GetTopLevelNodeByKey(modData, key,
manifest => manifest.Rules,
map => map.RuleDefinitions,
args.Length == 3 ? args[2] : null);
if (result == null)
{
Console.WriteLine("Could not find actor '{0}' (name is case-sensitive).", key);
Environment.Exit(1);
}
Console.WriteLine(result.Value.Nodes.WriteToString());
}
}
}

46
OpenRA.Mods.Common/UtilityCommands/OutputResolvedSequencesCommand.cs Normal file
View File

@@ -0,0 +1,46 @@
#region Copyright & License Information
/*
* Copyright 2007-2016 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;
namespace OpenRA.Mods.Common.UtilityCommands
{
public class OutputResolvedSequencesCommand : IUtilityCommand
{
string IUtilityCommand.Name { get { return "--resolved-sequences"; } }
bool IUtilityCommand.ValidateArguments(string[] args)
{
return args.Length == 2 || args.Length == 3;
}
[Desc("IMAGE-NAME [PATH/TO/MAP]", "Display the finalized, merged MiniYaml sequence tree for the given image. Input values are case-sensitive.")]
void IUtilityCommand.Run(Utility utility, string[] args)
{
// HACK: The engine code assumes that Game.ModData is set.
var modData = Game.ModData = utility.ModData;
var key = args[1];
var result = Utilities.GetTopLevelNodeByKey(modData, key,
manifest => manifest.Sequences,
map => map.SequenceDefinitions,
args.Length == 3 ? args[2] : null);
if (result == null)
{
Console.WriteLine("Could not find image '{0}' (name is case-sensitive).", key);
Environment.Exit(1);
}
Console.WriteLine(result.Value.Nodes.WriteToString());
}
}
}

46
OpenRA.Mods.Common/UtilityCommands/OutputResolvedWeaponsCommand.cs Normal file
View File

@@ -0,0 +1,46 @@
#region Copyright & License Information
/*
* Copyright 2007-2016 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;
namespace OpenRA.Mods.Common.UtilityCommands
{
public class OutputResolvedWeaponsCommand : IUtilityCommand
{
string IUtilityCommand.Name { get { return "--resolved-weapons"; } }
bool IUtilityCommand.ValidateArguments(string[] args)
{
return args.Length == 2 || args.Length == 3;
}
[Desc("WEAPON [PATH/TO/MAP]", "Display the finalized, merged MiniYaml tree for the given weapon. Input values are case-sensitive.")]
void IUtilityCommand.Run(Utility utility, string[] args)
{
// HACK: The engine code assumes that Game.ModData is set.
var modData = Game.ModData = utility.ModData;
var key = args[1];
var result = Utilities.GetTopLevelNodeByKey(modData, key,
manifest => manifest.Weapons,
map => map.WeaponDefinitions,
args.Length == 3 ? args[2] : null);
if (result == null)
{
Console.WriteLine("Could not find weapon '{0}' (name is case-sensitive).", key);
Environment.Exit(1);
}
Console.WriteLine(result.Value.Nodes.WriteToString());
}
}
}

54
OpenRA.Mods.Common/UtilityCommands/Utilities.cs Normal file
View File

@@ -0,0 +1,54 @@
#region Copyright & License Information
/*
* Copyright 2007-2016 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.IO;
using System.Linq;
using OpenRA.FileSystem;
namespace OpenRA.Mods.Common.UtilityCommands
{
public static class Utilities
{
/// <exception cref="ArgumentNullException">Thrown if manifestPropertySelector is null.</exception>
public static MiniYamlNode GetTopLevelNodeByKey(ModData modData, string key,
Func<Manifest, string[]> manifestPropertySelector,
Func<Map, MiniYaml> mapPropertySelector = null,
string mapPath = null)
{
if (manifestPropertySelector == null)
throw new ArgumentNullException("manifestPropertySelector", "Must pass a non-null manifestPropertySelector");
Map map = null;
if (mapPath != null)
{
try
{
map = new Map(modData, modData.ModFiles.OpenPackage(mapPath, new Folder(".")));
}
catch (InvalidDataException ex)
{
Console.WriteLine("Could not load map '{0}' so this data does not include the map's overrides.", mapPath);
Console.WriteLine(ex);
map = null;
}
}
var manifestNodes = manifestPropertySelector.Invoke(modData.Manifest);
var mapProperty = map == null || mapPropertySelector == null ? null
: mapPropertySelector.Invoke(map);
var fs = map ?? modData.DefaultFileSystem;
var topLevelNodes = MiniYaml.Load(fs, manifestNodes, mapProperty);
return topLevelNodes.FirstOrDefault(n => n.Key == key);
}
}
}