5715760e8b
* Overhaul diassembler scripts: - No longer defines top level functions - Split into three classes: StatusHandler (like before), DisassemblerInterface (for interfacing with the used program API), ScriptContext (for definiting general functions that use the disassembler interface) - Add type annotations to all class methods and remove 2.7 compatibility stuff (Ghidra now supports Python 3 so this is unnecessary anymore) - Disassembler backends are now responsible for launching metadata/script processing, to better support disassembler differences - String handling is back in the base ScriptContext class, disassembler interfaces opt into the fake string segment creation and fall back to the old method if it isn't supported * Add Binary Ninja disassembler script backend This uses the new backend-controlled execution to launch metadata processing on a background thread to keep the ui responsive * make binary ninja script use own _BINARYNINJA_ define and add define helpers to header * Update README to account for new script and binary ninja backend * implement fake string segment functions for binary ninja but don't advertise support * also cache API function types in binary ninja backend * fix ida script and disable folders again
83 lines
3.9 KiB
C#
83 lines
3.9 KiB
C#
// Copyright (c) 2019-2020 Carter Bush - https://github.com/carterbush
|
|
// Copyright (c) 2020-2021 Katy Coe - http://www.djkaty.com - https://github.com/djkaty
|
|
// Copyright 2020 Robert Xiao - https://robertxiao.ca/
|
|
// All rights reserved
|
|
|
|
using System.Linq;
|
|
using System.IO;
|
|
using Il2CppInspector.Reflection;
|
|
using Il2CppInspector.Model;
|
|
using System.Collections.Generic;
|
|
using System;
|
|
|
|
namespace Il2CppInspector.Outputs
|
|
{
|
|
public class PythonScript
|
|
{
|
|
private readonly AppModel model;
|
|
|
|
public PythonScript(AppModel model) => this.model = model;
|
|
|
|
// Get list of available script targets
|
|
public static IEnumerable<string> GetAvailableTargets() {
|
|
var ns = typeof(PythonScript).Namespace + ".ScriptResources.Targets";
|
|
var res = ResourceHelper.GetNamesForNamespace(ns);
|
|
return res
|
|
.Select(s => Path.GetFileNameWithoutExtension(s[(ns.Length + 1)..]))
|
|
.OrderBy(s => s);
|
|
}
|
|
|
|
// Output script file
|
|
public void WriteScriptToFile(string outputFile, string target, string existingTypeHeaderFIle = null, string existingJsonMetadataFile = null) {
|
|
|
|
// Check that target script API is valid
|
|
if (!GetAvailableTargets().Contains(target))
|
|
throw new InvalidOperationException("Unknown script API target: " + target);
|
|
|
|
// Write types file first if it hasn't been specified
|
|
var typeHeaderFile = Path.Combine(Path.GetDirectoryName(outputFile), Path.GetFileNameWithoutExtension(outputFile) + ".h");
|
|
|
|
if (string.IsNullOrEmpty(existingTypeHeaderFIle))
|
|
writeTypes(typeHeaderFile);
|
|
else
|
|
typeHeaderFile = existingTypeHeaderFIle;
|
|
|
|
var typeHeaderRelativePath = getRelativePath(outputFile, typeHeaderFile);
|
|
|
|
// Write JSON metadata if it hasn't been specified
|
|
var jsonMetadataFile = Path.Combine(Path.GetDirectoryName(outputFile), Path.GetFileNameWithoutExtension(outputFile) + ".json");
|
|
|
|
if (string.IsNullOrEmpty(existingJsonMetadataFile))
|
|
writeJsonMetadata(jsonMetadataFile);
|
|
else
|
|
jsonMetadataFile = existingJsonMetadataFile;
|
|
|
|
var jsonMetadataRelativePath = getRelativePath(outputFile, jsonMetadataFile);
|
|
|
|
var ns = $"{typeof(PythonScript).Namespace}.ScriptResources";
|
|
var baseScipt = ResourceHelper.GetText($"{ns}.shared_base.py");
|
|
var impl = ResourceHelper.GetText($"{ns}.Targets.{target}.py");
|
|
|
|
var script = string.Join("\n", baseScipt, impl)
|
|
.Replace("%SCRIPTFILENAME%", Path.GetFileName(outputFile))
|
|
.Replace("%TYPE_HEADER_RELATIVE_PATH%", typeHeaderRelativePath.ToEscapedString())
|
|
.Replace("%JSON_METADATA_RELATIVE_PATH%", jsonMetadataRelativePath.ToEscapedString())
|
|
.Replace("%TARGET_UNITY_VERSION%", model.UnityHeaders.ToString());
|
|
|
|
File.WriteAllText(outputFile, script);
|
|
}
|
|
|
|
private void writeTypes(string typeHeaderFile) => new CppScaffolding(model, useBetterArraySize: true).WriteTypes(typeHeaderFile);
|
|
|
|
private void writeJsonMetadata(string jsonMetadataFile) => new JSONMetadata(model).Write(jsonMetadataFile);
|
|
|
|
private string getRelativePath(string from, string to) =>
|
|
Path.GetRelativePath(Path.GetDirectoryName(Path.GetFullPath(from))!,
|
|
Path.GetDirectoryName(Path.GetFullPath(to))!)
|
|
+ '/'
|
|
// We do not use Path.DirectorySeparatorChar here as scripts might be generated on windows then ran on linux,
|
|
// and / is cross-compatible
|
|
+ Path.GetFileName(to);
|
|
}
|
|
}
|