Added ModuleProviderType to specify the origin of the module

Renamed ModuleInfoExtendedWithPath to ModuleInfoExtendedWithMetadata Fixed the LoadOrder sorter Formatting
BUTR · Apr 19, 2024 · 433ed7c · 433ed7c
1 parent 033db78
commit 433ed7c
Show file tree

Hide file tree

Showing 50 changed files with 202 additions and 134 deletions.
diff --git a/src/Bannerlord.LauncherManager.Localization/BUTRLanguageData.cs b/src/Bannerlord.LauncherManager.Localization/BUTRLanguageData.cs
@@ -12,7 +12,7 @@ internal partial class BUTRLanguageData
 {
     public string StringId { get; }
     public string Title { get; private set; } = string.Empty;
-    public string[] SupportedIsoCodes { get; private set; } = Array.Empty<string>();
+    public string[] SupportedIsoCodes { get; private set; } = [];
     public bool IsUnderDevelopment { get; private set; } = true;
     public bool IsValid { get; private set; }
 

diff --git a/src/Bannerlord.LauncherManager.Models/IModuleViewModel.cs b/src/Bannerlord.LauncherManager.Models/IModuleViewModel.cs
@@ -2,7 +2,7 @@
 
 public interface IModuleViewModel
 {
-    ModuleInfoExtendedWithPath ModuleInfoExtended { get; }
+    ModuleInfoExtendedWithMetadata ModuleInfoExtended { get; }
     bool IsValid { get; }
     bool IsSelected { get; set; }
     bool IsDisabled { get; set; }

diff --git a/...ager.Models/ModuleInfoExtendedWithPath.cs → ....Models/ModuleInfoExtendedWithMetadata.cs b/...ager.Models/ModuleInfoExtendedWithPath.cs → ....Models/ModuleInfoExtendedWithMetadata.cs
@@ -4,15 +4,17 @@
 
 namespace Bannerlord.LauncherManager.Models;
 
-public record ModuleInfoExtendedWithPath : ModuleInfoExtended
+public record ModuleInfoExtendedWithMetadata : ModuleInfoExtended
 {
+    public ModuleProviderType ModuleProviderType { get; set; }
     public string Path { get; set; } = string.Empty;
 
-    public ModuleInfoExtendedWithPath() { }
-    public ModuleInfoExtendedWithPath(string path, string id, string name, bool isOfficial, ApplicationVersion version, bool isSingleplayerModule, bool isMultiplayerModule,
+    public ModuleInfoExtendedWithMetadata() { }
+    public ModuleInfoExtendedWithMetadata(ModuleProviderType moduleProviderType, string path, string id, string name, bool isOfficial, ApplicationVersion version, bool isSingleplayerModule, bool isMultiplayerModule,
         IReadOnlyList<SubModuleInfoExtended> subModules, IReadOnlyList<DependentModule> dependentModules, IReadOnlyList<DependentModule> modulesToLoadAfterThis,
         IReadOnlyList<DependentModule> incompatibleModules, IReadOnlyList<DependentModuleMetadata> dependentModuleMetadatas, string url)
     {
+        ModuleProviderType = moduleProviderType;
         Path = path;
         Id = id;
         Name = name;
@@ -27,8 +29,9 @@ public ModuleInfoExtendedWithPath(string path, string id, string name, bool isOf
         DependentModuleMetadatas = dependentModuleMetadatas;
         Url = url;
     }
-    public ModuleInfoExtendedWithPath(ModuleInfoExtended module, string path) : base(module)
+    public ModuleInfoExtendedWithMetadata(ModuleInfoExtended module, ModuleProviderType moduleProviderType, string path) : base(module)
     {
+        ModuleProviderType = moduleProviderType;
         Path = path;
     }
 }
diff --git a/src/Bannerlord.LauncherManager.Models/ModuleProviderType.cs b/src/Bannerlord.LauncherManager.Models/ModuleProviderType.cs
@@ -0,0 +1,7 @@
+namespace Bannerlord.LauncherManager.Models;
+
+public enum ModuleProviderType
+{
+    Default = 0,
+    Steam = 1,
+}
diff --git a/src/Bannerlord.LauncherManager.Models/SaveMetadata.cs b/src/Bannerlord.LauncherManager.Models/SaveMetadata.cs
@@ -31,7 +31,7 @@ public SaveMetadata(string name, TWSaveMetadata metadata) : base(metadata.List)
     }
 
     public string[] GetModules() =>
-        TryGetValue("Modules", out var text) ? text.Split(';') : Array.Empty<string>();
+        TryGetValue("Modules", out var text) ? text.Split(';') : [];
 
     public ApplicationVersion GetModuleVersion(string moduleName) =>
         TryGetValue($"Module_{moduleName}", out var versionRaw) ? ApplicationVersion.TryParse(versionRaw, out var versionVar) ? versionVar : ApplicationVersion.Empty : ApplicationVersion.Empty;

diff --git a/src/Bannerlord.LauncherManager.Native.TypeScript/src/Bannerlord.ModuleManager.hpp b/src/Bannerlord.LauncherManager.Native.TypeScript/src/Bannerlord.ModuleManager.hpp
@@ -273,6 +273,20 @@ namespace Bannerlord::ModuleManager
         const auto result = bmm_get_module_info_with_path(sourceCopy.get(), pathCopy.get());
         return ThrowOrReturnJson(env, result);
     }
+    Value GetModuleInfoWithMetadata(const CallbackInfo &info)
+    {
+        const auto env = info.Env();
+        const auto source = info[0].As<String>();
+        const auto moduleProvider = info[1].As<String>();
+        const auto path = info[2].As<String>();
+
+        const auto sourceCopy = CopyWithFree(source.Utf16Value());
+        const auto moduleProviderCopy = CopyWithFree(moduleProvider.Utf16Value());
+        const auto pathCopy = CopyWithFree(path.Utf16Value());
+
+        const auto result = bmm_get_module_info_with_metadata(sourceCopy.get(), moduleProviderCopy.get(), pathCopy.get());
+        return ThrowOrReturnJson(env, result);
+    }
     Value GetSubModuleInfo(const CallbackInfo &info)
     {
         const auto env = info.Env();
@@ -366,6 +380,7 @@ namespace Bannerlord::ModuleManager
 
         exports.Set("getModuleInfo", Function::New(env, GetModuleInfo));
         exports.Set("getModuleInfoWithPath", Function::New(env, GetModuleInfoWithPath));
+        exports.Set("getModuleInfoWithMetadata", Function::New(env, GetModuleInfoWithMetadata));
         exports.Set("getSubModuleInfo", Function::New(env, GetSubModuleInfo));
 
         exports.Set("parseApplicationVersion", Function::New(env, ParseApplicationVersion));

diff --git a/src/Bannerlord.LauncherManager.Native.TypeScript/src/lib/types/BannerlordModuleManager.ts b/src/Bannerlord.LauncherManager.Native.TypeScript/src/lib/types/BannerlordModuleManager.ts
@@ -15,6 +15,13 @@ export interface ModuleInfoExtended {
 export interface ModuleInfoExtendedWithPath extends ModuleInfoExtended {
     path: string;
 }
+export interface ModuleInfoExtendedWithMetadata extends ModuleInfoExtendedWithPath {
+    moduleProviderType: ModuleProviderType;
+}
+export enum ModuleProviderType {
+    Default = 'Default',
+    Steam = 'Steam',
+}
 export interface ApplicationVersion {
     applicationVersionType: ApplicationVersionType;
     major: number;
@@ -28,7 +35,7 @@ export enum ApplicationVersionType {
     EarlyAccess = 'EarlyAccess',
     Release = 'Release',
     Development = 'Development',
-    Invalid = 'Invalid'
+    Invalid = 'Invalid',
 }
 export interface SubModuleInfoExtended {
     name: string;

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/DialogProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/DialogProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.External.UI;
+using Bannerlord.LauncherManager.External.UI;
 using Bannerlord.LauncherManager.Models;
 
 using BUTR.NativeAOT.Shared;
@@ -25,7 +25,7 @@ public void SendDialog(DialogType type, string title, string message, IReadOnlyL
     {
         SendDialogNative(type.ToStringFast().ToLowerInvariant(), title, message, filters, onResult);
     }
-        
+
     private void SendDialogNative(ReadOnlySpan<char> type, ReadOnlySpan<char> title, ReadOnlySpan<char> message, IReadOnlyList<DialogFileFilter> filters, Action<string> onResult)
     {
         [UnmanagedCallersOnly(CallConvs = [typeof(CallConvCdecl)])]

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/FileSystemProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/FileSystemProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.External;
+using Bannerlord.LauncherManager.External;
 
 using BUTR.NativeAOT.Shared;
 
@@ -13,7 +13,7 @@ internal sealed unsafe class FileSystemProvider : IFileSystemProvider
     private readonly N_WriteFileContentDelegate _writeFileContent;
     private readonly N_ReadDirectoryFileList _readDirectoryFileList;
     private readonly N_ReadDirectoryList _readDirectoryList;
-        
+
     public FileSystemProvider(
         param_ptr* pOwner,
         N_ReadFileContentDelegate readFileContent,

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/GameInfoProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/GameInfoProvider.cs
@@ -14,7 +14,7 @@ public GameInfoProvider(param_ptr* pOwner, N_GetInstallPathDelegate getInstallPa
         _pOwner = pOwner;
         _getInstallPath = getInstallPath;
     }
-        
+
     public string GetInstallPath() => GetInstallPathNative();
 
     private string GetInstallPathNative()

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/LauncherStateProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/LauncherStateProvider.cs
@@ -26,7 +26,7 @@ public LauncherStateProvider(
         _getOptions = getOptions;
         _getState = getState;
     }
-        
+
     public void SetGameParameters(string executable, IReadOnlyList<string> gameParameters) => SetGameParametersNative(executable, gameParameters);
     public LauncherOptions GetOptions() => GetOptionsNative();
     public LauncherState GetState() => GetStateNative();

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/LoadOrderPersistenceProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/LoadOrderPersistenceProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.External;
+using Bannerlord.LauncherManager.External;
 using Bannerlord.LauncherManager.Models;
 
 using BUTR.NativeAOT.Shared;

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/LoadOrderStateProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/LoadOrderStateProvider.cs
@@ -28,12 +28,12 @@ public LoadOrderStateProvider(
         _getModuleViewModels = getModuleViewModels;
         _setModuleViewModels = setModuleViewModels;
     }
-        
+
     public IModuleViewModel[]? GetAllModuleViewModels() => GetAllModuleViewModelsNative();
     public IModuleViewModel[]? GetModuleViewModels() => GetModuleViewModelsNative();
     public void SetModuleViewModels(IReadOnlyList<IModuleViewModel> moduleViewModels) => SetModuleViewModelsNative(moduleViewModels);
 
-        
+
     private IModuleViewModel[]? GetAllModuleViewModelsNative()
     {
         Logger.LogInput();

diff --git a/src/Bannerlord.LauncherManager.Native/Adapters/NotificationProvider.cs b/src/Bannerlord.LauncherManager.Native/Adapters/NotificationProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.External.UI;
+using Bannerlord.LauncherManager.External.UI;
 using Bannerlord.LauncherManager.Models;
 
 using BUTR.NativeAOT.Shared;

diff --git a/src/Bannerlord.LauncherManager.Native/Bindings.Common.cs b/src/Bannerlord.LauncherManager.Native/Bindings.Common.cs
@@ -47,12 +47,12 @@ public override void Write(Utf8JsonWriter writer, IInstallInstruction value, Jso
             new JsonStringEnumConverter<GameStore>(),
             new JsonStringEnumConverter<InstallInstructionType>(),
             new JsonStringEnumConverter<NotificationType>(),
-            
+
             new JsonStringEnumConverter<ApplicationVersionType>(),
             new JsonStringEnumConverter<ModuleIssueType>(),
             new JsonStringEnumConverter<LoadType>(),
         }
     };
-    
+
     internal static readonly SourceGenerationContext CustomSourceGenerationContext = new(_options);
 }
diff --git a/src/Bannerlord.LauncherManager.Native/Bindings.LauncherManager.cs b/src/Bannerlord.LauncherManager.Native/Bindings.LauncherManager.cs
@@ -69,7 +69,7 @@ public static unsafe partial class Bindings
                     Marshal.GetDelegateForFunctionPointer<N_SetModuleViewModels>(new IntPtr(p_set_module_view_models))
                 )
             );
-            
+
             Logger.LogOutput();
             return return_value_ptr.AsValue(launcherManager.HandlePtr, false);
         }
@@ -180,7 +180,7 @@ public static unsafe partial class Bindings
                 return return_value_json.AsError(BUTR.NativeAOT.Shared.Utils.Copy("Handler is null or wrong!", false), false);
 
             var files = BUTR.NativeAOT.Shared.Utils.DeserializeJson(p_files, CustomSourceGenerationContext.StringArray);
-            var moduleInfos = BUTR.NativeAOT.Shared.Utils.DeserializeJson(p_module_infos, CustomSourceGenerationContext.ModuleInfoExtendedWithPathArray);
+            var moduleInfos = BUTR.NativeAOT.Shared.Utils.DeserializeJson(p_module_infos, CustomSourceGenerationContext.ModuleInfoExtendedWithMetadataArray);
 
             var result = handler.InstallModuleContent(files, moduleInfos);
             Logger.LogOutput(result);
@@ -336,7 +336,7 @@ public static unsafe partial class Bindings
             var result = handler.GetModules().ToArray();
 
             Logger.LogOutput(result);
-            return return_value_json.AsValue(result, CustomSourceGenerationContext.ModuleInfoExtendedWithPathArray, false);
+            return return_value_json.AsValue(result, CustomSourceGenerationContext.ModuleInfoExtendedWithMetadataArray, false);
         }
         catch (Exception e)
         {
@@ -507,7 +507,7 @@ public static unsafe partial class Bindings
 
             var moduleViewModel = BUTR.NativeAOT.Shared.Utils.DeserializeJson(p_module_view_model, CustomSourceGenerationContext.ModuleViewModel);
 
-            var modules = handler.GetModuleViewModels() ?? Array.Empty<IModuleViewModel>();
+            var modules = handler.GetModuleViewModels() ?? [];
             var lookup = modules.ToDictionary(x => x.ModuleInfoExtended.Id, x => x);
             SortHelper.ToggleModuleSelection(modules, lookup, moduleViewModel);
 
@@ -549,7 +549,7 @@ public static unsafe partial class Bindings
         }
     }
 
-    
+
     [UnmanagedCallersOnly(EntryPoint = "ve_get_save_files", CallConvs = [typeof(CallConvCdecl)])]
     public static return_value_json* GetSaveFiles(param_ptr* p_handle)
     {
@@ -742,7 +742,7 @@ public record OrderByLoadOrderResult(bool Result, IReadOnlyList<string>? Issues,
             return return_value_void.AsException(e, false);
         }
     }
-    
+
 
     [UnmanagedCallersOnly(EntryPoint = "ve_set_game_store", CallConvs = [typeof(CallConvCdecl)])]
     public static return_value_void* SetGameStore(param_ptr* p_handle, param_string* p_game_store)
@@ -767,7 +767,7 @@ public record OrderByLoadOrderResult(bool Result, IReadOnlyList<string>? Issues,
             return return_value_void.AsException(e, false);
         }
     }
-    
+
     [UnmanagedCallersOnly(EntryPoint = "ve_get_game_platform", CallConvs = [typeof(CallConvCdecl)])]
     public static return_value_string* GetGamePlatform(param_ptr* p_handle)
     {

diff --git a/src/Bannerlord.LauncherManager.Native/Bindings.ModuleManager.cs b/src/Bannerlord.LauncherManager.Native/Bindings.ModuleManager.cs
@@ -385,7 +385,28 @@ public static unsafe partial class Bindings
             doc.LoadXml(new string(param_string.ToSpan(p_xml_content)));
 
             var module = ModuleInfoExtended.FromXml(doc);
-            var result = new ModuleInfoExtendedWithPath(module, new string(param_string.ToSpan(p_path)));
+            var result = new ModuleInfoExtendedWithMetadata(module, ModuleProviderType.Default, new string(param_string.ToSpan(p_path)));
+
+            Logger.LogOutput(result);
+            return return_value_json.AsValue(result, CustomSourceGenerationContext.ModuleInfoExtended, false);
+        }
+        catch (Exception e)
+        {
+            Logger.LogException(e);
+            return return_value_json.AsException(e, false);
+        }
+    }
+    [UnmanagedCallersOnly(EntryPoint = "bmm_get_module_info_with_metadata", CallConvs = [typeof(CallConvCdecl)]), IsNotConst<IsPtrConst>]
+    public static return_value_json* GetModuleInfoWithMetadata([IsConst<IsPtrConst>] param_string* p_xml_content, [IsConst<IsPtrConst>] param_string* p_module_provider, [IsConst<IsPtrConst>] param_string* p_path)
+    {
+        Logger.LogInput(p_xml_content, p_path);
+        try
+        {
+            var doc = new XmlDocument();
+            doc.LoadXml(new string(param_string.ToSpan(p_xml_content)));
+
+            var module = ModuleInfoExtended.FromXml(doc);
+            var result = new ModuleInfoExtendedWithMetadata(module, Enum.TryParse<ModuleProviderType>(new string(param_string.ToSpan(p_path)), out var e) ? e : ModuleProviderType.Default, new string(param_string.ToSpan(p_path)));
 
             Logger.LogOutput(result);
             return return_value_json.AsValue(result, CustomSourceGenerationContext.ModuleInfoExtended, false);

diff --git a/src/Bannerlord.LauncherManager.Native/CallbackStorage.cs b/src/Bannerlord.LauncherManager.Native/CallbackStorage.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Bannerlord.LauncherManager.Native;
 

diff --git a/src/Bannerlord.LauncherManager.Native/LauncherManagerHandlerNative.cs b/src/Bannerlord.LauncherManager.Native/LauncherManagerHandlerNative.cs
@@ -64,13 +64,13 @@ public void Dispose()
     public new void SetGameParameterLoadOrder(LoadOrder loadOrder) => base.SetGameParameterLoadOrder(loadOrder);
 
 
-    public new IReadOnlyList<ModuleInfoExtendedWithPath> GetModules() => base.GetModules();
+    public new IReadOnlyList<ModuleInfoExtendedWithMetadata> GetModules() => base.GetModules();
 
     public new IModuleViewModel[]? GetModuleViewModels() => base.GetModuleViewModels();
 
     public new void ShowHint(BUTRTextObject message) => base.ShowHint(message);
     public new void ShowHint(string message) => base.ShowHint(message);
-    
+
     public new void SendDialog(DialogType type, string title, string message, IReadOnlyList<DialogFileFilter> filters, Action<string> onResult) => base.SendDialog(type, title, message, filters, onResult);
 
     public override SaveMetadata? GetSaveMetadata(string fileName, ReadOnlySpan<byte> data)
@@ -95,7 +95,7 @@ public override SaveMetadata[] GetSaveFiles()
     {
         IEnumerable<SaveMetadata> GetSaveFilesInternal()
         {
-            foreach (var filePath in ReadDirectoryFileList(SavePath) ?? Array.Empty<string>())
+            foreach (var filePath in ReadDirectoryFileList(SavePath) ?? [])
             {
                 if (ReadFileContent(filePath, 0, 4) is not { } lengthData) continue;
                 var length = BitConverter.ToInt32(lengthData, 0);

diff --git a/src/Bannerlord.LauncherManager.Native/Models/ModuleViewModel.cs b/src/Bannerlord.LauncherManager.Native/Models/ModuleViewModel.cs
@@ -7,7 +7,7 @@ namespace Bannerlord.LauncherManager.Native.Models;
 
 public sealed record ModuleViewModel : IModuleViewModel
 {
-    public required ModuleInfoExtendedWithPath ModuleInfoExtended { get; init; }
+    public required ModuleInfoExtendedWithMetadata ModuleInfoExtended { get; init; }
     public required bool IsValid { get; init; }
     public bool IsSelected { get; set; }
     public bool IsDisabled { get; set; }
@@ -16,7 +16,7 @@ public sealed record ModuleViewModel : IModuleViewModel
     public ModuleViewModel() { }
 
     [SetsRequiredMembers, JsonConstructor]
-    public ModuleViewModel(ModuleInfoExtendedWithPath moduleInfoExtended, bool isValid)
+    public ModuleViewModel(ModuleInfoExtendedWithMetadata moduleInfoExtended, bool isValid)
     {
         ModuleInfoExtended = moduleInfoExtended;
         IsValid = isValid;

diff --git a/src/Bannerlord.LauncherManager.Native/SourceGenerationContext.cs b/src/Bannerlord.LauncherManager.Native/SourceGenerationContext.cs
@@ -45,8 +45,8 @@ namespace Bannerlord.LauncherManager.Native;
 [JsonSerializable(typeof(SubModuleInfoExtended))]
 [JsonSerializable(typeof(ModuleInfoExtended))]
 [JsonSerializable(typeof(ModuleInfoExtended[]))]
-[JsonSerializable(typeof(ModuleInfoExtendedWithPath))]
-[JsonSerializable(typeof(ModuleInfoExtendedWithPath[]))]
+[JsonSerializable(typeof(ModuleInfoExtendedWithMetadata))]
+[JsonSerializable(typeof(ModuleInfoExtendedWithMetadata[]))]
 [JsonSerializable(typeof(ModuleSorterOptions))]
 [JsonSerializable(typeof(ModuleIssue[]))]
 [JsonSerializable(typeof(DependentModuleMetadata[]))]

diff --git a/src/Bannerlord.LauncherManager/External/CallbackFileSystemProvider.cs b/src/Bannerlord.LauncherManager/External/CallbackFileSystemProvider.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Bannerlord.LauncherManager.External;
 

diff --git a/src/Bannerlord.LauncherManager/External/CallbackGameInfoProvider.cs b/src/Bannerlord.LauncherManager/External/CallbackGameInfoProvider.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Bannerlord.LauncherManager.External;
 

diff --git a/src/Bannerlord.LauncherManager/External/CallbackLauncherStateProvider.cs b/src/Bannerlord.LauncherManager/External/CallbackLauncherStateProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.Models;
+using Bannerlord.LauncherManager.Models;
 
 using System;
 using System.Collections.Generic;

diff --git a/src/Bannerlord.LauncherManager/External/CallbackLoadOrderPersistenceProvider.cs b/src/Bannerlord.LauncherManager/External/CallbackLoadOrderPersistenceProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.Models;
+using Bannerlord.LauncherManager.Models;
 
 using System;
 

diff --git a/src/Bannerlord.LauncherManager/External/CallbackLoadOrderStateProvider.cs b/src/Bannerlord.LauncherManager/External/CallbackLoadOrderStateProvider.cs
@@ -1,4 +1,4 @@
-using Bannerlord.LauncherManager.Models;
+using Bannerlord.LauncherManager.Models;
 
 using System;
 using System.Collections.Generic;