feat: use cmdline args as the args of BMap bindings.

- update testbench of PyBMap and BMapSharp. use command line arguments as the arguments of testbench, instead of hardcoded variables in code.

Author: yyc12345

BMapBindings/BMapSharp/BMapSharpTestbench/BMapSharpTestbench.csproj

@@ -4,6 +4,10 @@
     <ProjectReference Include="..\BMapSharp\BMapSharp.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
+  </ItemGroup>
+
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>net8.0</TargetFramework>

BMapBindings/BMapSharp/BMapSharpTestbench/Program.cs

@@ -3,11 +3,19 @@
 using System.Text;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.CommandLine;
 
 namespace BMapSharpTestbench {
     internal class Program {
 
         static void Main(string[] args) {
+            // Parse arguments
+            var resolved_args = ResolveArguments(args);
+            if (resolved_args is null) {
+                // just silent quit
+                Environment.Exit(0);
+            }
+
             // Check environment
             Console.OutputEncoding = Encoding.UTF8;
             if (!BMapSharp.BMapWrapper.Utils.IsBMapAvailable()) {
@@ -21,10 +29,10 @@ static void Main(string[] args) {
             Console.ReadKey(true);
 
             // Start testbench
-            string file_name = "LightCameraTest.nmo";
-            string temp_folder = "Temp";
-            string texture_folder = "F:\\Ballance\\Ballance\\Textures";
-            string[] encodings = ["cp1252", "gb2312"];
+            string file_name = resolved_args.mFileName; // "LightCameraTest.nmo";
+            string temp_folder = resolved_args.mTempFolder; // "Temp";
+            string texture_folder = resolved_args.mTextureFolder; // "F:\\Ballance\\Ballance\\Textures";
+            string[] encodings = resolved_args.mEncodings; // ["cp1252", "gb2312"];
 
             using (var reader = new BMapSharp.BMapWrapper.BMFileReader(file_name, temp_folder, texture_folder, encodings)) {
                 TestCommon(reader);
@@ -36,6 +44,53 @@ static void Main(string[] args) {
 
         }
 
+        class BMapSharpArguments {
+            public string mFileName;
+            public string mTempFolder;
+            public string mTextureFolder;
+            public string[] mEncodings;
+        }
+
+        static BMapSharpArguments ResolveArguments(string[] args) {
+            // define arguments
+            var fileNameOpt = new Option<string>
+                ("--file-path", "The path to input Virtools file.");
+            fileNameOpt.IsRequired = true;
+            var tempFolderOpt = new Option<string>
+                ("--temp-dir", "The temp folder used by BMap.");
+            tempFolderOpt.IsRequired = true;
+            var textureFolderOpt = new Option<string>
+                ("--texture-dir", "The texture folder containing Ballance texture resources.");
+            textureFolderOpt.IsRequired = true;
+            var encodingsOpt = new Option<IEnumerable<string>>
+                ("--encodings", "The encodings used to parse the names stroed in input Virtools file.");
+            encodingsOpt.IsRequired = true;
+            encodingsOpt.Arity = ArgumentArity.OneOrMore;
+            encodingsOpt.AllowMultipleArgumentsPerToken = true;
+
+            // init root command
+            var rootCommand = new RootCommand("The testbench of BMapSharp.");
+            rootCommand.Add(fileNameOpt);
+            rootCommand.Add(tempFolderOpt);
+            rootCommand.Add(textureFolderOpt);
+            rootCommand.Add(encodingsOpt);
+
+            // init result container
+            BMapSharpArguments ret = new BMapSharpArguments();
+            // set handler
+            rootCommand.SetHandler((context) => {
+                ret.mFileName = context.ParseResult.GetValueForOption(fileNameOpt);
+                ret.mTempFolder =  context.ParseResult.GetValueForOption(tempFolderOpt);
+                ret.mTextureFolder =  context.ParseResult.GetValueForOption(textureFolderOpt);
+                ret.mEncodings =  context.ParseResult.GetValueForOption(encodingsOpt).ToArray();
+                context.ExitCode = 61;
+            });
+
+            // execute root command and return value.
+            if (rootCommand.Invoke(args) != 61) return null;
+            return ret;
+        }
+
         static void TestCommon(BMapSharp.BMapWrapper.BMFileReader reader) {
             // Console.WriteLine("===== Groups =====");
             // foreach (var gp in reader.GetGroups()) {
@@ -137,7 +192,7 @@ static void TestIEquatable(BMapSharp.BMapWrapper.BMFileReader reader) {
                 );
                 return;
             }
-            
+
             // Prepare test variables
             var all_3dobjects = new List<BM3dObject>(reader.Get3dObjects());
             var first_3dobj = all_3dobjects[0];

BMapBindings/BMapSharp/README.md

@@ -5,3 +5,5 @@ The core of BMapSharp project is placed within `BMapSharp` subdirectory. This di
 The native BMap library should be placed together with managed `BMapSharp` dynamic library. I use gitignore file to filter all native binary so you need put them manually. The native BMap library must be named as `BMap.dll` (in Windows), `BMap.so` (in Linux or BSD), or `BMap.dylib` (in macOS). If you still can not load BMap or your system is not listed above, you should name it as `BMap.bin`.
 
 The most content of `VirtoolsTypes.cs` is generated by EnumsMigration, and the most content of `BMap.cs` is generated by BMapBindings. You should watch these file changes if corresponding C++ code or structures are changed.
+
+Since BMap 0.3.0, testbench use command line arguments, instead of hardcode variables in code, as the arguments of BMap. It is convenient that debug BMapSharp without any modification of source code. For a brief instruction, you may need to launch BMapSharpTestbench in following command (just an example. you can modify it as you wished): `dotnet run -- --file-path "LightCameraTest.nmo" --temp-dir "Temp" --texture-dir "F:/Ballance/Ballance/Textures" --encodings cp1252 gb2312`.

BMapBindings/PyBMap/README.md

@@ -5,3 +5,5 @@ The real scripts are placed in sub PyBMap folder. This folder is served for test
 The native BMap library should be placed in sub PyBMap folder, and I have used gitignore file to filter them. The native BMap library must be named as `BMap.dll` (in Windows), `BMap.so` (in Linux or BSD), or `BMap.dylib` (in macOS). If you still can not load BMap or your system is not listed above, you should name it as `BMap.bin`.
 
 Please note the most content of `virtools_types.py` are generated by EnumsMigration sub-project. Additionally the most content of `bmap.py` is generated by BMapBindings. So if some structs are updated, do not forget checking these files.
+
+Since BMap 0.3.0, testbench use command line arguments, instead of hardcode variables in code, as the arguments of BMap. It is convenient that debug BMapSharp without any modification of source code. For a brief instruction, you may need to launch BMapSharpTestbench in following command (just an example. you can modify it as you wished): `py testbench.py --file-path "LightCameraTest.nmo" --temp-dir "Temp" --texture-dir "F:/Ballance/Ballance/Textures" --encodings cp1252 gb2312`.

BMapBindings/PyBMap/testbench.py

@@ -1,13 +1,14 @@
 import os
+import argparse
 import PyBMap.bmap_wrapper as bmap
 
-def main() -> None:
+def main(file_name: str, temp_folder: str, texture_folder: str, encodings: tuple[str, ...]) -> None:
     input(f'Python PID is {os.getpid()}. Waiting for debugger, press any key to continue...')
 
-    file_name: str = 'LightCameraTest.nmo'
-    temp_folder: str = 'Temp'
-    texture_folder: str = 'F:\\Ballance\\Ballance\\Textures'
-    encodings: tuple[str, ...] = ('cp1252', )
+    # file_name: str = 'LightCameraTest.nmo'
+    # temp_folder: str = 'Temp'
+    # texture_folder: str = 'F:\\Ballance\\Ballance\\Textures'
+    # encodings: tuple[str, ...] = ('cp1252', )
     with bmap.BMFileReader(file_name, temp_folder, texture_folder, encodings) as reader:
         test_common(reader)
         test_equatable(reader)
@@ -146,4 +147,32 @@ def test_equatable(reader: bmap.BMFileReader):
     assert second_3dobj in test_dict
 
 if __name__ == '__main__':
-    main()
+    # parse argument
+    parser = argparse.ArgumentParser(
+        prog='PyBMap Testbench',
+        description='The testbench of PyBMap.'
+    )
+    parser.add_argument(
+        '--file-path',
+        action='store', dest='file_path', required=True,
+        help='The path to input Virtools file.'
+    )
+    parser.add_argument(
+        '--temp-dir',
+        action='store', dest='temp_dir', required=True,
+        help='The temp folder used by BMap.'
+    )
+    parser.add_argument(
+        '--texture-dir',
+        action='store', dest='texture_dir', required=True,
+        help='The texture folder containing Ballance texture resources.'
+    )
+    parser.add_argument(
+        '--encodings',
+        action='extend', nargs='+', dest='encodings', required=True,
+        help='The encodings used to parse the names stroed in input Virtools file.'
+    )
+    args = parser.parse_args()
+
+    # run main function
+    main(args.file_path, args.temp_dir, args.texture_dir, tuple(args.encodings))