add CLI

diogotr7 · Jun 13, 2024 · 57e77cb · 57e77cb
1 parent 88962d0
commit 57e77cb
Show file tree

Hide file tree

Showing 8 changed files with 154 additions and 66 deletions.
diff --git a/StarBreaker.Forge/DataForge.cs b/StarBreaker.Forge/DataForge.cs
@@ -36,7 +36,7 @@ public DataForge(byte[] allBytes, string outputFolder)
         // }
     }
 
-    public void Export(Regex? fileNameFilter = null, IProgress<float>? progress = null)
+    public void Export(Regex? fileNameFilter = null, IProgress<double>? progress = null)
     {
         _progress = 0;
         var structsPerFileName = new Dictionary<string, List<DataForgeRecord>>();
@@ -57,7 +57,7 @@ public void Export(Regex? fileNameFilter = null, IProgress<float>? progress = nu
         }
 
         var total = structsPerFileName.Count;
-
+        
         Parallel.ForEach(structsPerFileName, data =>
         {
             var structs = _database.StructDefinitions.Span;
@@ -108,13 +108,14 @@ public void Export(Regex? fileNameFilter = null, IProgress<float>? progress = nu
                 writer.Write("__root");
                 writer.Write('>');
             }
-            
             var currentProgress = Interlocked.Increment(ref _progress);
-            progress?.Report(currentProgress * 100f / total);
+            //only report progress every 250 records and when we are done
+            if (currentProgress == total || currentProgress % 250 == 0)
+                progress?.Report(currentProgress / (double)total);
         });
     }
 
-    public void ExportSingle(Regex? fileNameFilter = null, IProgress<float>? progress = null)
+    public void ExportSingle(Regex? fileNameFilter = null, IProgress<double>? progress = null)
     {
         var progressValue = 0;
         var total = _database.RecordDefinitions.Length;
@@ -141,7 +142,10 @@ public void ExportSingle(Regex? fileNameFilter = null, IProgress<float>? progres
             FillNode(child, structDef, reader, 0);
 
             child.WriteTo(writer, 1, _database, _offsets);
-            progress?.Report(progressValue++ * 100f / total);
+
+            ++progressValue;
+            if (progressValue % 250 == 0 || progressValue == total)
+                progress?.Report(progressValue / (double)total);
         }
 
         writer.WriteLine("</__root>");

diff --git a/StarBreaker.Forge/IDataForge.cs b/StarBreaker.Forge/IDataForge.cs
@@ -9,14 +9,14 @@ public interface IDataForge
     /// </summary>
     /// <param name="fileNameFilter">Regex to filter files to export</param>
     /// <param name="progress">Progress callback</param>
-    void Export(Regex? fileNameFilter = null, IProgress<float>? progress = null);
+    void Export(Regex? fileNameFilter = null, IProgress<double>? progress = null);
 
     /// <summary>
     ///     Export all records in the DataCoreBinary into a single XML file.
     /// </summary>
     /// <param name="fileNameFilter">Regex to filter files to export</param>
     /// <param name="progress">Progress callback</param>
-    void ExportSingle(Regex? fileNameFilter = null, IProgress<float>? progress = null);
+    void ExportSingle(Regex? fileNameFilter = null, IProgress<double>? progress = null);
 
     /// <summary>
     ///     Export all enums in the DataForge to a dictionary.

diff --git a/StarBreaker/ExtractCommand.cs b/StarBreaker/ExtractCommand.cs
@@ -0,0 +1,39 @@
+using System.Diagnostics;
+using System.Text.RegularExpressions;
+using CliFx;
+using CliFx.Attributes;
+using CliFx.Infrastructure;
+using StarBreaker.Forge;
+
+namespace StarBreaker;
+
+[Command("extract", Description = "Extracts a DataForge binary file into separate xml files")]
+public class ExtractCommand : ICommand
+{
+    [CommandOption("dcb", 'd', Description = "Path to the DataForge binary file")]
+    public required string DataForgeBinary { get; init; }
+
+    [CommandOption("output", 'o', Description = "Path to the output directory")]
+    public required string OutputDirectory { get; init; }
+
+    [CommandOption("filter", 'f', Description = "Regex pattern to filter entries")]
+    public Regex? RegexPattern { get; init; }
+
+    public ValueTask ExecuteAsync(IConsole console)
+    {
+        var bytes = File.ReadAllBytes(DataForgeBinary);
+        var dataForge = new DataForge(bytes, OutputDirectory);
+
+        console.Output.WriteLine("DataForge loaded.");
+        console.Output.WriteLine("Exporting...");
+
+        var sw = Stopwatch.StartNew();
+        dataForge.Export(RegexPattern, new ProgressBar(console));
+        sw.Stop();
+
+        console.Output.WriteLine();
+        console.Output.WriteLine($"Export completed in {sw.ElapsedMilliseconds}ms.");
+
+        return default;
+    }
+}
diff --git a/StarBreaker/ExtractSingleCommand.cs b/StarBreaker/ExtractSingleCommand.cs
@@ -0,0 +1,39 @@
+using System.Diagnostics;
+using System.Text.RegularExpressions;
+using CliFx;
+using CliFx.Attributes;
+using CliFx.Infrastructure;
+using StarBreaker.Forge;
+
+namespace StarBreaker;
+
+[Command("extract-single", Description = "Extracts a DataForge binary file into a single xml")]
+public class ExtractSingleCommand : ICommand
+{
+    [CommandOption("dcb", 'd', Description = "Path to the DataForge binary file")]
+    public required string DataForgeBinary { get; init; }
+
+    [CommandOption("output", 'o', Description = "Path to the output directory")]
+    public required string OutputDirectory { get; init; }
+
+    [CommandOption("filter", 'f', Description = "Regex pattern to filter entries")]
+    public Regex? RegexPattern { get; init; }
+
+    public ValueTask ExecuteAsync(IConsole console)
+    {
+        var bytes = File.ReadAllBytes(DataForgeBinary);
+        var dataForge = new DataForge(bytes, OutputDirectory);
+
+        console.Output.WriteLine("DataForge loaded.");
+        console.Output.WriteLine("Exporting...");
+
+        var sw = Stopwatch.StartNew();
+        dataForge.ExportSingle(RegexPattern, new ProgressBar(console));
+        sw.Stop();
+
+        console.Output.WriteLine();
+        console.Output.WriteLine($"Export completed in {sw.ElapsedMilliseconds}ms.");
+
+        return default;
+    }
+}
diff --git a/StarBreaker/Program.cs b/StarBreaker/Program.cs
@@ -1,59 +1,6 @@
-using System.Diagnostics;
-using StarBreaker.Forge;
+using CliFx;
 
-namespace StarBreaker;
-
-public static class Program
-{
-    private const string dcb = @"C:\Scratch\extract\Game.dcb";
-    private const string destDir = @"C:\Scratch\extract\stbr\";
-    private static DataForge dataForge = null!;
-
-    public static void Main()
-    {
-        var bytes = File.ReadAllBytes(dcb);
-
-        var sw1 = Stopwatch.StartNew();
-        dataForge = new DataForge(bytes, destDir);
-        Console.WriteLine($"DataForge Constructor took: {sw1.ElapsedMilliseconds}ms");
-
-        var printed1 = -1;
-        var exportProgress = new Progress<float>(percent =>
-        {
-            if (Math.Abs(percent % 10) < 1)
-            {
-                var part = (int)percent / 10;
-                if (part > printed1)
-                {
-                    printed1 = part;
-                    Console.WriteLine($"Export {percent}%");
-                }
-            }
-        });
-        var sw2 = Stopwatch.StartNew();
-        dataForge.Export(null, exportProgress);
-        Console.WriteLine($"Export took: {sw2.ElapsedMilliseconds}ms");
-
-        int printed = -1;
-        var exportProgress1 = new Progress<float>(percent =>
-        {
-            if (Math.Abs(percent % 10) < 1)
-            {
-                var part = (int)percent / 10;
-                if (part > printed)
-                {
-                    printed = part;
-                    Console.WriteLine($"ExportSingle {percent}%");
-                }
-            }
-        });
-        var sw = Stopwatch.StartNew();
-        dataForge.ExportSingle(null, exportProgress1);
-        Console.WriteLine($"ExportSingle took: {sw.ElapsedMilliseconds}ms");
-
-        // foreach (var x in dataForge.ExportEnums())
-        // {            
-        //     File.WriteAllText(Path.Combine(destDir, Path.ChangeExtension(x.Key, ".txt")), string.Join("\n", x.Value));
-        // }
-    }
-}
+return await new CliApplicationBuilder()
+    .AddCommandsFromThisAssembly()
+    .Build()
+    .RunAsync();
diff --git a/StarBreaker/ProgressBar.cs b/StarBreaker/ProgressBar.cs
@@ -0,0 +1,43 @@
+using CliFx.Infrastructure;
+
+namespace StarBreaker;
+
+public class ProgressBar : IProgress<double>
+{
+    private const int _totalBlocks = 20;
+    private readonly IConsole _console;
+    private int? _originalCursorLeft;
+    private int? _originalCursorTop;
+
+    public ProgressBar(IConsole console)
+    {
+        _console = console;
+    }
+
+    private void RenderProgress(double progress)
+    {
+        if (_originalCursorLeft != null && _originalCursorTop != null)
+        {
+            _console.CursorLeft = _originalCursorLeft.Value;
+            _console.CursorTop = _originalCursorTop.Value;
+        }
+        else
+        {
+            _originalCursorLeft = _console.CursorLeft;
+            _originalCursorTop = _console.CursorTop;
+        }
+
+        var completedBlocks = (int)(progress * _totalBlocks);
+        var progressBar = new string('#', completedBlocks) + new string('-', _totalBlocks - completedBlocks);
+
+        _console.Output.Write($"[{progressBar}] {progress:P0}");
+    }
+
+    public void Report(double progress)
+    {
+        if (!_console.IsOutputRedirected)
+        {
+            RenderProgress(progress);
+        }
+    }
+}
diff --git a/StarBreaker/Properties/launchSettings.json b/StarBreaker/Properties/launchSettings.json
@@ -0,0 +1,12 @@
+{
+  "profiles": {
+    "extract": {
+      "commandName": "Project",
+      "commandLineArgs": "extract --dcb \"C:\\Scratch\\extract\\Game.dcb\" --output \"C:\\Scratch\\extract\\stbr\" --filter \"^[0-9A-Za-z]{3}[0-9A-Za-z-]\\d{0,21}$\""
+    },
+    "extract-single": {
+      "commandName": "Project",
+      "commandLineArgs": "extract-single --dcb \"C:\\Scratch\\extract\\Game.dcb\" --output \"C:\\Scratch\\extract\\stbr\" --filter \"^[0-9A-Za-z]{3}[0-9A-Za-z-]\\d{0,21}$\""
+    }
+  }
+}
diff --git a/StarBreaker/StarBreaker.csproj b/StarBreaker/StarBreaker.csproj
@@ -10,4 +10,8 @@
     <ItemGroup>
       <ProjectReference Include="..\StarBreaker.Forge\StarBreaker.Forge.csproj" />
     </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="CliFx" Version="2.3.5" />
+    </ItemGroup>
 </Project>