Remove longform command-line arguments and add -D flag

Author: Elletra

Decompiler.cs

@@ -16,6 +16,7 @@
 using DSO.Util;
 using DSO.Versions;
 using static DSO.Constants.Decompiler;
+using static DSO.Util.CommandLineOptions;
 
 namespace DSO
 {
@@ -131,10 +132,19 @@ private Tuple<int, int> DecompileDirectory(string path)
 
 		private bool DecompileFile(string path)
 		{
-			Logger.LogMessage($"Decompiling file: \"{path}\"");
+			if (_options.OutputDisassembly == DisassemblyOutput.DisassemblyOnly)
+			{
+				Logger.LogMessage($"Disassembling file: \"{path}\"");
+			}
+			else
+			{
+				Logger.LogMessage($"Decompiling file: \"{path}\"");
+			}
 
 			if (_options.GameIdentifier != GameIdentifier.Auto)
 			{
+				Logger.LogMessage($"\tUsing game settings: \"{GameVersion.GetDisplayName(_options.GameIdentifier)}\"", ConsoleColor.DarkGray);
+
 				return DecompileFile(path, _options.GameIdentifier, silentError: false);
 			}
 
@@ -179,7 +189,9 @@ private bool DecompileFile(string path, GameIdentifier identifier, bool silentEr
 			GameVersion game = new();
 			FileData fileData;
 			Disassembly disassembly;
-			List<Node> nodes;
+			List<Node> nodes = [];
+
+			var disassemblyOnly = _options.OutputDisassembly == DisassemblyOutput.DisassemblyOnly;
 
 			try
 			{
@@ -192,7 +204,11 @@ private bool DecompileFile(string path, GameIdentifier identifier, bool silentEr
 				}
 
 				disassembly = new Disassembler.Disassembler().Disassemble(fileData, game.Ops);
-				nodes = new Builder().Build(new ControlFlowAnalyzer().Analyze(disassembly), disassembly);
+
+				if (!disassemblyOnly)
+				{
+					nodes = new Builder().Build(new ControlFlowAnalyzer().Analyze(disassembly), disassembly);
+				}
 			}
 			catch (Exception exception)
 			{
@@ -206,13 +222,17 @@ private bool DecompileFile(string path, GameIdentifier identifier, bool silentEr
 				return false;
 			}
 
-			var scriptPath = $"{Directory.GetParent(path)}/{Path.GetFileNameWithoutExtension(path)}";
 
-			Logger.LogMessage($"Writing output file: \"{scriptPath}\"");
+			if (!disassemblyOnly)
+			{
+				var scriptPath = $"{Directory.GetParent(path)}/{Path.GetFileNameWithoutExtension(path)}";
+
+				Logger.LogMessage($"Writing output file: \"{scriptPath}\"");
 
-			WriteScriptFile(scriptPath, nodes);
+				WriteScriptFile(scriptPath, nodes);
+			}
 
-			if (_options.OutputDisassembly)
+			if (_options.OutputDisassembly != DisassemblyOutput.None)
 			{
 				var disassemblyPath = $"{Directory.GetParent(path)}/{Path.GetFileNameWithoutExtension(path)}{DISASM_EXTENSION}";
 

README.md

@@ -30,16 +30,17 @@ There are two ways to use this program: either as a typical console program, or
 
 To use it normally, just drag a `.dso` file or a directory full of `.dso` files onto the program. It will try to automatically detect and decompile the file(s) that were passed in.
 
-You can also use it as a command-line interface: `usage: dso-sharp path1[, path2[, ...]] [-h] [-q] [-g game_version] [-d] [-X]`
+You can also use it as a command-line interface: `usage: dso-sharp path1[, path2[, ...]] [-h] [-q] [-g game] [-d | -D] [-X]`
 
 
 | Flag                   |   Description  |
 |:-----------------------|:---------------|
-| `-h`, `--help`         | Displays help. |
-| `-q`, `--quiet`        | Disables all messages (except command-line argument errors). |
-| `-g`, `--game`         | Specifies which game's scripts we are decompiling (default: `auto`). |
-| `-d`, `--disassembly`  | Writes a `.disasm` file containing the disassembly. |
-| `-X`, `--cli`          | Makes the program operate as a command-line interface that takes no keyboard input and closes immediately upon completion or failure. |
+| `-h` | Displays help. |
+| `-q` | Disables all messages (except command-line argument errors). |
+| `-g` | Specifies which game's scripts we are decompiling (default: `auto`). |
+| `-d` | Writes a `.disasm` file containing the disassembly. |
+| `-D` | Writes only the disassembly file and nothing else. |
+| `-X` | Makes the program operate as a command-line interface that takes no keyboard input and closes immediately upon completion or failure. |
 
 
 ### Supported Games

Util/CommandLineParser.cs

@@ -10,16 +10,24 @@
 
 using DSO.Versions;
 using static DSO.Constants.Decompiler;
+using static DSO.Util.CommandLineOptions;
 
 namespace DSO.Util
 {
 	public class CommandLineOptions
 	{
+		public enum DisassemblyOutput
+		{
+			None,
+			Disassembly,
+			DisassemblyOnly,
+		}
+
 		public readonly List<string> Paths = [];
 
 		public GameIdentifier GameIdentifier { get; set; } = GameIdentifier.Auto;
 		public bool Quiet { get; set; } = false;
-		public bool OutputDisassembly { get; set; } = false;
+		public DisassemblyOutput OutputDisassembly { get; set; } = DisassemblyOutput.None;
 		public bool CommandLineMode { get; set; } = false;
 	}
 
@@ -40,6 +48,7 @@ static public class CommandLineParser
 		static public Tuple<bool, CommandLineOptions> Parse(string[] args)
 		{
 			var firstFlagSet = false;
+			var unknownFlag = false;
 			var options = new CommandLineOptions();
 			var error = false;
 			var paths = new List<string>();
@@ -58,24 +67,36 @@ static public Tuple<bool, CommandLineOptions> Parse(string[] args)
 
 				switch (arg)
 				{
-					case "--help" or "-h":
+					case "-h":
 						DisplayHelp();
 						error = true;
 						break;
 
-					case "--cli" or "-X":
+					case "-X":
 						options.CommandLineMode = true;
 						break;
 
-					case "--quiet" or "-q":
+					case "-q":
 						options.Quiet = true;
 						break;
 
-					case "--disassembly" or "-d":
-						options.OutputDisassembly = true;
+					case "-d":
+						if (options.OutputDisassembly == DisassemblyOutput.None)
+						{
+							options.OutputDisassembly = DisassemblyOutput.Disassembly;
+						}
+
+						break;
+
+					case "-D":
+						if (options.OutputDisassembly != DisassemblyOutput.DisassemblyOnly)
+						{
+							options.OutputDisassembly = DisassemblyOutput.DisassemblyOnly;
+						}
+
 						break;
 
-					case "--game" or "-g":
+					case "-g":
 					{
 						error = i >= args.Length - 1 || args[i + 1].StartsWith('-');
 
@@ -127,9 +148,9 @@ static public Tuple<bool, CommandLineOptions> Parse(string[] args)
 						}
 						else
 						{
-							Logger.LogError($"Unknown or unsupported flag '{arg}'");
+							Logger.LogError($"Unknown or unsupported flag '{arg}'\n");
 
-							if (arg == "-H" || arg == "-Q" || arg == "-G" || arg == "-D")
+							if (arg == "-H" || arg == "-Q" || arg == "-G")
 							{
 								Logger.LogError($"Did you mean '{arg.ToLower()}'?");
 							}
@@ -138,6 +159,7 @@ static public Tuple<bool, CommandLineOptions> Parse(string[] args)
 								Logger.LogError($"Did you mean '{arg.ToUpper()}'?");
 							}
 
+							unknownFlag = true;
 							error = true;
 						}
 
@@ -151,7 +173,14 @@ static public Tuple<bool, CommandLineOptions> Parse(string[] args)
 				}
 			}
 
-			if (!error && options.Paths.Count <= 0)
+			if (error)
+			{
+				if (unknownFlag)
+				{
+					DisplayHelp();
+				}
+			}
+			else if (options.Paths.Count <= 0)
 			{
 				if (!options.Quiet && !options.CommandLineMode)
 				{
@@ -170,15 +199,15 @@ static public Tuple<bool, CommandLineOptions> Parse(string[] args)
 		static private void DisplayHelp()
 		{
 			Logger.LogMessage(
-				"usage: dso-sharp path1[, path2[, ...]] [-h] [-q] [-g game_version] [-d] [-X]\n" +
+				"usage: dso-sharp path1[, path2[, ...]] [-h] [-q] [-g game] [-d | -D] [-X]\n" +
 				"  options:\n" +
-				"    -h, --help           Displays help.\n" +
-				"    -q, --quiet          Disables all messages (except command-line argument errors).\n" +
-				"    -g, --game           Specifies which game settings to use (default: 'auto').\n" +
-				"    -d, --disassembly    Writes a `" + DISASM_EXTENSION + "` file containing the disassembly.\n" +
-				"    -X, --cli            Makes the program operate as a command-line interface\n" +
-				"                         that takes no keyboard input and closes immediately\n" +
-				"                         upon completion or failure.\n"
+				"    -h    Displays help.\n" +
+				"    -q    Disables all messages (except command-line argument errors).\n" +
+				"    -g    Specifies which game settings to use (default: 'auto').\n" +
+				"    -d    Writes a `" + DISASM_EXTENSION + "` file containing the disassembly.\n" +
+				"    -D    Writes only the disassembly file and nothing else.\n" +
+				"    -X    Makes the program operate as a command-line interface that takes\n" +
+				"          no keyboard input and closes immediately upon completion or failure.\n"
 			);
 
 			DisplayVersions();