chizui/Il2CppInspectorRedux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins: Add LoadPipelineStarting / LoadPipelineEnding, rename IsHandled to FullyProcessed

Browse Source
This commit is contained in:
Katy Coe
2020-12-25 22:29:31 +01:00
parent db4432061c
commit e929d8d97e
7 changed files with 66 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Il2CppInspector.Common/Plugins/API/V100/ILoadPipeline.cs
View File

@@ -6,6 +6,7 @@
using NoisyCowStudios.Bin2Object;
using Il2CppInspector.Reflection;
using System.Collections.Generic;
namespace Il2CppInspector.PluginAPI.V100
{
@@ -16,6 +17,11 @@ namespace Il2CppInspector.PluginAPI.V100
/// </summary>
public interface ILoadPipeline
{
/// <summary>
/// A new load task is about to start. Perform per-load initialization here
/// </summary>
void LoadPipelineStarting(PluginLoadPipelineStartingEventInfo info) { }
/// <summary>
/// Process global-metadata.dat when it is first opened as a sequence of bytes
/// Seek cursor will be at the start of the file
@@ -42,6 +48,13 @@ namespace Il2CppInspector.PluginAPI.V100
/// </summary>
void PostProcessPackage(Il2CppInspector package, PluginPostProcessPackageEventInfo data) { }
/// <summary>
/// The current load task has finished. Perform per-load teardown code here
/// One Il2CppInspector per sub-image in the binary is supplied
/// We have closed all open files but the .NET type model has not been created yet
/// </summary>
void LoadPipelineEnding(List<Il2CppInspector> packages, PluginLoadPipelineEndingEventInfo info) { }
/// <summary>
/// Post-process the .NET type model to make changes after it has been fully created
/// </summary>

22
Il2CppInspector.Common/Plugins/API/V100/PluginEventInfo.cs
View File

@@ -12,7 +12,7 @@ namespace Il2CppInspector.PluginAPI.V100
{
/// <summary>
/// Object which allows plugins to report on what has happened during a call
/// Changes made to this object propagate to the next plugin in the call chain until IsHandled is set to true
/// Changes made to this object propagate to the next plugin in the call chain until FullyProcessed is set to true
/// </summary>
public class PluginEventInfo
{
@@ -21,25 +21,25 @@ namespace Il2CppInspector.PluginAPI.V100
/// Generally, this will prevent other plugins from processing the data
/// Note that this should be set even if the processed data was invalid (<seealso cref="IsInvalid"/>)
/// If this is not set, the same event will be raised on the next available plugin
/// Note that you can still do processing but set IsHandled to false to allow additional processing from other plugins
/// Note that you can still do processing but set FullyProcessed to false to allow additional processing from other plugins
/// </summary>
public bool IsHandled { get; set; } = false;
public bool FullyProcessed { get; set; } = false;
/// <summary>
/// A plugin should set this when IsHandled = true but the data it processed was invalid, for example if the processing gave an unexpected result
/// A plugin should set this when the data it processed was invalid, for example if the processing gave an unexpected result
/// </summary>
public bool IsInvalid { get; set; } = false;
/// <summary>
/// A plugin should set this when it has directly modified the provided data structure (object)
/// This can be set even if IsHandled = false to indicate that changes have been made but more plugins can still be called
/// This can be set even if FullyProcessed = false to indicate that changes have been made but more plugins can still be called
/// Should be set to false if you have only queried (performed reads) on the data without changing it
/// </summary>
public bool IsDataModified { get; set; } = false;
/// <summary>
/// A plugin should set this when it has directly modified the supplied or underlying stream for the metadata or binary
/// This can be set even if IsHandled = false to indicate that changes have been made but more plugins can still be called
/// This can be set even if FullyProcessed = false to indicate that changes have been made but more plugins can still be called
/// Should be set to false if you have only queried (performed reads) on the stream without changing it
/// </summary>
public bool IsStreamModified { get; set; } = false;
@@ -50,6 +50,11 @@ namespace Il2CppInspector.PluginAPI.V100
public PluginErrorEventArgs Error { get; set; } = null;
}
/// <summary>
/// Event info for LoadPipelineStarting
/// </summary>
public class PluginLoadPipelineStartingEventInfo : PluginEventInfo { }
/// <summary>
/// Event info for PreProcessMetadata
/// </summary>
@@ -102,4 +107,9 @@ namespace Il2CppInspector.PluginAPI.V100
/// Event info for PostProcessTypeModel
/// </summary>
public class PluginPostProcessTypeModelEventInfo : PluginEventInfo { }
/// <summary>
/// Event info for LoadPipelineEnding
/// </summary>
public class PluginLoadPipelineEndingEventInfo : PluginEventInfo { }
}

8
Il2CppInspector.Common/Plugins/PluginHooks.cs
View File

@@ -4,6 +4,7 @@
All rights reserved.
*/
using System.Collections.Generic;
using Il2CppInspector.Reflection;
using NoisyCowStudios.Bin2Object;
@@ -16,6 +17,9 @@ namespace Il2CppInspector
// Does not include hooks that should be called individually, eg. OptionsChanged
internal static class PluginHooks
{
public static PluginLoadPipelineStartingEventInfo LoadPipelineStarting()
=> PluginManager.Try<ILoadPipeline, PluginLoadPipelineStartingEventInfo>((p, e) => p.LoadPipelineStarting(e));
public static PluginPreProcessMetadataEventInfo PreProcessMetadata(BinaryObjectStream stream)
=> PluginManager.Try<ILoadPipeline, PluginPreProcessMetadataEventInfo>((p, e) => {
stream.Position = 0;
@@ -34,8 +38,10 @@ namespace Il2CppInspector
public static PluginPostProcessPackageEventInfo PostProcessPackage(Il2CppInspector package)
=> PluginManager.Try<ILoadPipeline, PluginPostProcessPackageEventInfo>((p, e) => p.PostProcessPackage(package, e));
public static PluginLoadPipelineEndingEventInfo LoadPipelineEnding(List<Il2CppInspector> packages)
=> PluginManager.Try<ILoadPipeline, PluginLoadPipelineEndingEventInfo>((p, e) => p.LoadPipelineEnding(packages, e));
public static PluginPostProcessTypeModelEventInfo PostProcessTypeModel(TypeModel typeModel)
=> PluginManager.Try<ILoadPipeline, PluginPostProcessTypeModelEventInfo>((p, e) => p.PostProcessTypeModel(typeModel, e));
}
}

2
Il2CppInspector.Common/Plugins/PluginManager.cs
View File

@@ -258,7 +258,7 @@ namespace Il2CppInspector
try {
action(p, eventInfo);
if (eventInfo.IsHandled)
if (eventInfo.FullyProcessed)
break;
}
catch (Exception ex) {