Compare commits

..

2 Commits

15 changed files with 378 additions and 603 deletions

View File

@ -1,10 +0,0 @@
#define LEAN_SYMBOLS_HEADER
#include "{{ headerPath }}"
// Thunk Template
template <auto *const *func>
decltype(auto) __thunk(auto... args) {
return (*func)->get_thunk_target()(std::forward<decltype(args)>(args)...);
}
{{ main }}

View File

@ -1,174 +0,0 @@
#pragma once
// Check Architecture
#ifndef __arm__
#error "Symbols Are ARM-Only"
#endif
// Headers
#include <variant>
#include <functional>
#include <cstddef>
#include <string>
#include <vector>
#include <map>
#include <type_traits>
#include <cstring>
// Internal Macros
#define __PREVENT_DESTRUCTION(self) \
~self() = delete
#define __PREVENT_CONSTRUCTION(self) \
self() = delete; \
__PREVENT_DESTRUCTION(self)
#define __PREVENT_COPY(self) \
self(const self &) = delete; \
self &operator=(const self &) = delete
// Virtual Function Information
struct __VirtualFunctionInfo {
// Constructors
template <typename Ret, typename Self, typename Super, typename... Args>
__VirtualFunctionInfo(Ret (**const addr_)(Self, Args...), Ret (*const parent_)(Super, Args...)):
addr((void **) addr_),
parent((void *) parent_) {}
template <typename T>
__VirtualFunctionInfo(T **const addr_, const std::nullptr_t parent_):
__VirtualFunctionInfo(addr_, (T *) parent_) {}
// Method
[[nodiscard]] bool can_overwrite() const {
return *addr != parent;
}
// Properties
void **const addr;
void *const parent;
};
// Thunks
typedef void *(*thunk_enabler_t)(void *target, void *thunk);
extern thunk_enabler_t thunk_enabler;
// Function Information
template <typename T>
class __Function;
template <typename Ret, typename... Args>
class __Function<Ret(Args...)> {
// Prevent Copying
__PREVENT_COPY(__Function);
__PREVENT_DESTRUCTION(__Function);
public:
// Types
typedef Ret (*ptr_type)(Args...);
typedef std::function<Ret(Args...)> type;
typedef std::function<Ret(const type &, Args...)> overwrite_type;
// Normal Function
__Function(const std::string name_, const ptr_type thunk_, const ptr_type func_):
func(func_),
enabled(true),
name(name_),
backup(func_),
thunk(thunk_) {}
// Virtual Function
template <typename Parent>
__Function(const std::string name_, const ptr_type thunk_, ptr_type *const func_, const Parent parent):
func(__VirtualFunctionInfo(func_, parent)),
enabled(std::get<__VirtualFunctionInfo>(func).can_overwrite()),
name(name_),
backup(*get_vtable_addr()),
thunk(thunk_) {}
// Overwrite Function
[[nodiscard]] bool overwrite(overwrite_type target) {
// Check If Enabled
if (!enabled) {
return false;
}
// Enable Thunk
enable_thunk();
// Overwrite
type original = get_thunk_target();
thunk_target = [original, target](Args... args) {
return target(original, std::forward<Args>(args)...);
};
return true;
}
// Getters
[[nodiscard]] ptr_type get(bool result_will_be_stored) {
if (!enabled) {
return nullptr;
} else {
if (result_will_be_stored) {
enable_thunk();
}
if (is_virtual()) {
return *get_vtable_addr();
} else {
return std::get<ptr_type>(func);
}
}
}
[[nodiscard]] ptr_type *get_vtable_addr() const {
return (ptr_type *) std::get<__VirtualFunctionInfo>(func).addr;
}
[[nodiscard]] type get_thunk_target() const {
if (thunk_target) {
return thunk_target;
} else {
return backup;
}
}
private:
// Current Function
std::variant<ptr_type, __VirtualFunctionInfo> func;
[[nodiscard]] bool is_virtual() const {
return func.index() == 1;
}
public:
// State
const bool enabled;
const std::string name;
// Backup Of Original Function Pointer
const ptr_type backup;
private:
// Thunk
const ptr_type thunk;
type thunk_target;
bool thunk_enabled = false;
void enable_thunk() {
if (!thunk_enabled && enabled) {
ptr_type real_thunk = (ptr_type) thunk_enabler((void *) backup, (void *) thunk);
if (!is_virtual()) {
func = real_thunk;
}
thunk_enabled = true;
}
}
};
// Shortcuts
typedef unsigned char uchar;
typedef unsigned short ushort;
typedef unsigned int uint;
// Forward Declarations
{{ forwardDeclarations }}
// Extra Headers
{{ extraHeaders }}
// Warnings
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Winvalid-offsetof"
#pragma GCC diagnostic ignored "-Wshadow"
{{ main }}
// Cleanup Warnings
#pragma GCC diagnostic pop

View File

@ -1,5 +1,4 @@
import * as fs from 'node:fs'; import * as fs from 'node:fs';
import * as path from 'node:path';
export const INDENT = ' '; export const INDENT = ' ';
export const POINTER_SIZE = 4; export const POINTER_SIZE = 4;
@ -24,13 +23,12 @@ export function parseTypeAndName(piece: string) {
let name = piece.substring(index + 1)!; let name = piece.substring(index + 1)!;
let type = piece.substring(0, index)!; let type = piece.substring(0, index)!;
// Move Asterisks From Name To Type // Move Asterisks From Name To Type
while (name.startsWith('*') || name.startsWith('&')) { while (name.startsWith('*')) {
const x = name.substring(0, 1);
name = name.substring(1); name = name.substring(1);
if (!type.endsWith('*') && !type.endsWith('&')) { if (!type.endsWith('*')) {
type += ' '; type += ' ';
} }
type += x; type += '*';
} }
// Return // Return
return {type, name}; return {type, name};
@ -58,7 +56,7 @@ export function toUpperSnakeCase(str: string) {
return out; return out;
} }
export function formatType(type: string) { export function formatType(type: string) {
if (!type.endsWith('*') && !type.endsWith('&')) { if (!type.endsWith('*')) {
type += ' '; type += ' ';
} }
return type; return type;
@ -68,7 +66,14 @@ export function toHex(x: number) {
return '0x' + x.toString(16); return '0x' + x.toString(16);
} }
export function assertSize(name: string, size: number) { export function assertSize(name: string, size: number) {
return `static_assert(sizeof(${name}) == ${toHex(size)}, "Invalid Size");\n`; let out = '';
// Define Size Macro
const macro = toUpperSnakeCase(name) + '_SIZE';
out += `#define ${macro} ${toHex(size)}\n`;
// Check Size
out += `static_assert(sizeof(${name}) == ${macro}, "Invalid Size");\n`;
// Return
return out;
} }
export function safeParseInt(str: string) { export function safeParseInt(str: string) {
const x = parseInt(str); const x = parseInt(str);
@ -80,28 +85,39 @@ export function safeParseInt(str: string) {
export function getSelfArg(type: string) { export function getSelfArg(type: string) {
return `${type} *self`; return `${type} *self`;
} }
export function getArgNames(args: string) {
// Remove Parentheses
args = args.substring(1, args.length - 1);
if (args.length === 0) {
return [];
}
// Split
const argsList = args.split(',');
// Parse
const out = [];
for (let arg of argsList) {
arg = arg.trim();
// Remove Type
const nameStart = Math.max(arg.lastIndexOf(' '), arg.lastIndexOf('*')) + 1;
arg = arg.substring(nameStart);
// Collect
out.push(arg);
}
// Return
return out;
}
export function prependArg(args: string, arg: string) { export function prependArg(args: string, arg: string) {
if (args !== '()') { if (args !== '()') {
arg += ', '; arg += ', ';
} }
return '(' + arg + args.substring(1); return '(' + arg + args.substring(1);
} }
export function getDataDir() { export function removeFirstArg(args: string) {
return path.join(__dirname, '..', 'data'); let index = args.indexOf(',');
if (index === -1) {
index = args.indexOf(')');
} else {
index++;
} }
export function formatFile(file: string, options: {[key: string]: string}) { return '(' + args.substring(index).trim();
file = path.join(getDataDir(), file);
let data = fs.readFileSync(file, {encoding: 'utf8'});
for (const key in options) {
data = data.replace(`{{ ${key} }}`, options[key]!);
} }
return data.trim() + '\n';
}
export const INTERNAL = '__';
export function preventConstruction(self: string) {
let out = '';
out += `${INDENT}${INTERNAL}PREVENT_CONSTRUCTION(${self});\n`;
out += `${INDENT}${INTERNAL}PREVENT_COPY(${self});\n`;
return out;
}
export const LEAN_HEADER_GUARD = '#ifndef LEAN_SYMBOLS_HEADER\n';

View File

@ -1,6 +1,5 @@
import * as fs from 'node:fs'; import * as fs from 'node:fs';
import * as path from 'node:path'; import { STRUCTURE_FILES, EXTENSION, INDENT } from './common';
import { STRUCTURE_FILES, EXTENSION, formatFile, getDataDir } from './common';
import { getStructure } from './map'; import { getStructure } from './map';
import { Struct } from './struct'; import { Struct } from './struct';
@ -15,13 +14,14 @@ function invalidFileType(file: string) {
throw new Error(`Invalid File Type: ${file}`); throw new Error(`Invalid File Type: ${file}`);
} }
const sourceOutput = process.argv.shift()!; const sourceOutput = process.argv.shift()!;
fs.rmSync(sourceOutput, {force: true, recursive: true}); if (!sourceOutput.endsWith('.cpp')) {
fs.mkdirSync(sourceOutput, {recursive: true}); invalidFileType(sourceOutput);
}
const headerOutput = process.argv.shift()!; const headerOutput = process.argv.shift()!;
if (!headerOutput.endsWith('.h')) { if (!headerOutput.endsWith('.h')) {
invalidFileType(headerOutput); invalidFileType(headerOutput);
} }
const extraHeaderFiles: string[] = []; const extraHeaders: string[] = [];
while (process.argv.length > 0) { while (process.argv.length > 0) {
const file = process.argv.shift()!; const file = process.argv.shift()!;
if (file.endsWith(EXTENSION)) { if (file.endsWith(EXTENSION)) {
@ -36,7 +36,7 @@ while (process.argv.length > 0) {
STRUCTURE_FILES[name] = file; STRUCTURE_FILES[name] = file;
} else if (file.endsWith('.h')) { } else if (file.endsWith('.h')) {
// Extra Headers // Extra Headers
extraHeaderFiles.push(file); extraHeaders.push(file);
} else { } else {
// Invalid File Type // Invalid File Type
invalidFileType(file); invalidFileType(file);
@ -52,9 +52,9 @@ function loadSymbols() {
} }
// Sort // Sort
structureObjects.sort((a, b) => { structureObjects.sort((a, b) => {
if (a.name > b.name) { if (a.getName() > b.getName()) {
return 1; return 1;
} else if (a.name < b.name) { } else if (a.getName() < b.getName()) {
return -1; return -1;
} else { } else {
return 0; return 0;
@ -112,8 +112,14 @@ function makeHeaderPart() {
// Generate Code // Generate Code
let structures = ''; let structures = '';
let isFirst = true;
for (const structure of structureObjects) { for (const structure of structureObjects) {
const name = structure.name; const name = structure.getName();
if (isFirst) {
isFirst = false;
} else {
structures += '\n';
}
structures += `// ${name}\n`; structures += `// ${name}\n`;
try { try {
structures += structure.generate(); structures += structure.generate();
@ -121,68 +127,90 @@ function makeHeaderPart() {
console.log(`Error Generating Header: ${name}: ${e instanceof Error ? e.stack : e}`); console.log(`Error Generating Header: ${name}: ${e instanceof Error ? e.stack : e}`);
process.exit(1); process.exit(1);
} }
structures += '\n';
} }
// Return // Return
return structures; let result = '';
result += '// Init\n';
result += 'void init_symbols();\n\n';
result += structures;
return result;
} }
// Create Main Header // Create Main Header
function makeMainHeader(output: string) { function makeMainHeader(output: string) {
// Forward Declarations let result = '';
let forwardDeclarations = ''; result += '#pragma once\n';
result += '\n// Check Architecture\n';
result += '#ifndef __arm__\n';
result += '#error "Symbols Are ARM-Only"\n';
result += '#endif\n';
result += '\n// Shortcuts\n';
result += 'typedef unsigned char uchar;\n';
result += 'typedef unsigned short ushort;\n';
result += 'typedef unsigned int uint;\n';
result += '\n// Forward Declarations\n';
for (const name in STRUCTURE_FILES) { for (const name in STRUCTURE_FILES) {
forwardDeclarations += `typedef struct ${name} ${name};\n`; result += `typedef struct ${name} ${name};\n`;
} }
forwardDeclarations = forwardDeclarations.trim(); result += '\n// Extra Headers\n';
// Extra Headers for (const file of extraHeaders) {
let extraHeaders = ''; result += fs.readFileSync(file, {encoding: 'utf8'});
for (const file of extraHeaderFiles) {
extraHeaders += fs.readFileSync(file, {encoding: 'utf8'});
} }
extraHeaders = extraHeaders.trim(); result += '\n// Headers\n';
// Main result += '#include <cstddef>\n';
const main = makeHeaderPart().trim(); result += '#include <string>\n';
// Write result += '#include <vector>\n';
const result = formatFile('out.h', {forwardDeclarations, extraHeaders, main, data: getDataDir()}); result += '#include <map>\n';
result += '\n// Warnings\n';
result += '#pragma GCC diagnostic push\n';
result += '#pragma GCC diagnostic ignored "-Winvalid-offsetof"\n';
result += '#pragma GCC diagnostic ignored "-Wshadow"\n\n';
result += makeHeaderPart();
result += '\n// Cleanup Warnings\n';
result += '#pragma GCC diagnostic pop\n';
fs.writeFileSync(output, result); fs.writeFileSync(output, result);
} }
makeMainHeader(headerOutput); makeMainHeader(headerOutput);
// Generate Compiled Code // Generate Compiled Code
function makeCompiledCode(outputDir: string) { function makeCompiledCode(output: string) {
// Load Symbols // Load Symbols
const structureObjects = loadSymbols(); const structureObjects = loadSymbols();
// Generate // Generate
let first = true;
for (const structure of structureObjects) {
// Thunks
let declarations = ''; let declarations = '';
if (first) { let init = '';
first = false; let isFirst = true;
declarations += '// Thunk Enabler\n'; for (const structure of structureObjects) {
declarations += 'thunk_enabler_t thunk_enabler;\n\n'; const name = structure.getName();
if (isFirst) {
isFirst = false;
} else {
declarations += '\n';
init += '\n';
} }
// Structure
const name = structure.name;
declarations += `// ${name}\n`; declarations += `// ${name}\n`;
init += `${INDENT}// ${name}\n`;
try { try {
declarations += structure.generateCode().trim(); const code = structure.generateCode();
declarations += code.functions;
init += code.init;
} catch (e) { } catch (e) {
console.log(`Error Generating Code: ${name}: ${e instanceof Error ? e.stack : e}`); console.log(`Error Generating Code: ${name}: ${e instanceof Error ? e.stack : e}`);
process.exit(1); process.exit(1);
} }
declarations += '\n'; }
// Write // Write
const headerPath = fs.realpathSync(headerOutput); let result = '';
const main = declarations.trim(); result += `#include "${fs.realpathSync(headerOutput)}"\n`;
const result = formatFile('out.cpp', {headerPath, main, data: getDataDir()}); result += '\n#include <cstring>\n';
const output = path.join(outputDir, name + '.cpp'); result += '\n// Init\n';
result += 'void init_symbols() {\n';
result += init;
result += '}\n\n';
result += declarations;
fs.writeFileSync(output, result); fs.writeFileSync(output, result);
} }
}
makeCompiledCode(sourceOutput); makeCompiledCode(sourceOutput);

View File

@ -116,29 +116,29 @@ export function load(target: Struct, name: string, isExtended: boolean) {
case 'vtable-size': { case 'vtable-size': {
// Set VTable Size // Set VTable Size
if (!isExtended) { if (!isExtended) {
target.getVTable().setSize(safeParseInt(args)); target.setVTableSize(safeParseInt(args));
} }
break; break;
} }
case 'vtable': { case 'vtable': {
// Set VTable Address // Set VTable Address
const vtable = target.getVTable(); target.ensureVTable();
if (!isExtended && args.length > 0) { if (!isExtended && args.length > 0) {
vtable.setAddress(safeParseInt(args)); target.setVTableAddress(safeParseInt(args));
} }
break; break;
} }
case 'property': { case 'property': {
// Add Property // Add Property
const info = parseProperty(args); const info = parseProperty(args);
target.addProperty(new Property(info.offset, info.type, info.name, target.name)); target.addProperty(new Property(info.offset, info.type, info.name, target.getName()));
break; break;
} }
case 'static-property': { case 'static-property': {
// Add Static Property // Add Static Property
if (!isExtended) { if (!isExtended) {
const info = parseProperty(args); const info = parseProperty(args);
target.addStaticProperty(new StaticProperty(info.offset, info.type, info.name, target.name)); target.addStaticProperty(new StaticProperty(info.offset, info.type, info.name, target.getName()));
} }
break; break;
} }
@ -150,14 +150,14 @@ export function load(target: Struct, name: string, isExtended: boolean) {
} }
case 'virtual-method': { case 'virtual-method': {
// Add Virtual Method // Add Virtual Method
const method = parseMethod(args, target.name, true, isExtended); const method = parseMethod(args, target.getName(), true, isExtended);
target.addMethod(method, true); target.addMethod(method, true);
break; break;
} }
case 'static-method': { case 'static-method': {
// Add Static Method // Add Static Method
if (!isExtended) { if (!isExtended) {
const method = parseMethod(args, target.name, false, false); const method = parseMethod(args, target.getName(), false, false);
target.addMethod(method, false); target.addMethod(method, false);
} }
break; break;
@ -165,7 +165,7 @@ export function load(target: Struct, name: string, isExtended: boolean) {
case 'constructor': { case 'constructor': {
// Constructor // Constructor
if (!isExtended) { if (!isExtended) {
let data = `${target.name} *constructor`; let data = `${target.getName()} *constructor`;
if (args.startsWith('(')) { if (args.startsWith('(')) {
// No Custom Name // No Custom Name
data += ' '; data += ' ';
@ -174,22 +174,14 @@ export function load(target: Struct, name: string, isExtended: boolean) {
data += '_'; data += '_';
} }
data += args; data += args;
const method = parseMethod(data, target.name, true, false); const method = parseMethod(data, target.getName(), true, false);
target.addMethod(method, false); target.addMethod(method, false);
} }
break; break;
} }
case 'vtable-destructor-offset': { case 'vtable-destructor-offset': {
// Set VTable Destructor Offset // Set VTable Destructor Offset
target.getVTable().setDestructorOffset(safeParseInt(args)); target.setVTableDestructorOffset(safeParseInt(args));
break;
}
case 'mark-as-simple': {
// Mark As Simple
if (isExtended) {
throw new Error('Cannot Extend Simple Structure');
}
target.markAsSimple();
break; break;
} }
default: { default: {

View File

@ -1,4 +1,4 @@
import { INDENT, INTERNAL, formatType, toHex } from './common'; import { INDENT, formatType, getArgNames } from './common';
export class Method { export class Method {
readonly self: string; readonly self: string;
@ -7,6 +7,7 @@ export class Method {
readonly args: string; readonly args: string;
readonly address: number; readonly address: number;
readonly isInherited: boolean; readonly isInherited: boolean;
readonly hasVarargs: boolean;
readonly isStatic: boolean; readonly isStatic: boolean;
// Constructor // Constructor
@ -17,55 +18,56 @@ export class Method {
this.args = args; this.args = args;
this.address = address; this.address = address;
this.isInherited = isInherited; this.isInherited = isInherited;
this.hasVarargs = this.args.includes('...');
this.isStatic = isStatic; this.isStatic = isStatic;
} }
// Getters // Get Type
getName(separator: string = '_') { getNameWithCustomSelf(self: string) {
return this.self + separator + this.shortName; return `${self}_${this.shortName}`;
}
getName() {
return this.getNameWithCustomSelf(this.self);
} }
getType() { getType() {
return this.getName() + '_t'; return `${this.getName()}_t`;
}
#getRawType() {
return INTERNAL + 'raw_' + this.getType();
}
getProperty() {
return `${INDENT}${this.#getRawType()} *${this.shortName};\n`;
}
#getFullType() {
return `${INTERNAL}Function<${this.#getRawType()}>`;
} }
// Typedefs // Generate Type Definition
generateTypedefs() { generateTypedef() {
let out = ''; let out = '';
out += `typedef ${formatType(this.returnType.trim())}${this.#getRawType()}${this.args.trim()};\n`;
out += `typedef const std::function<${this.#getRawType()}> &${this.getType()};\n`;
return out;
}
// Normal Definition
const returnType = formatType(this.returnType);
out += `typedef ${returnType}(*${this.getType()})${this.args};\n`;
// Fancy Overwrite Does Not Support Varargs
if (!this.hasVarargs) {
// Overwrite Helper // Overwrite Helper
#getVirtualCall(self: string = this.self) { out += `#define __overwrite_helper_for_${this.getName()}(method, original) \\\n`;
return `${self}_vtable::base->${this.shortName}`; out += `${INDENT}[]${this.args} { \\\n`;
out += `${INDENT}${INDENT}${returnType.trim() === 'void' ? '' : 'return '}method(${['original'].concat(getArgNames(this.args)).join(', ')}); \\\n`;
out += `${INDENT}}\n`;
} }
generate(code: boolean, isVirtual: boolean, parentSelf?: string) {
let out = ''; // Return
out += 'extern '; return out;
const type = this.#getFullType(); }
out += `${type} *const ${this.getName()}`;
if (code) { // Generate Variable Definition
out += ` = new ${type}(${JSON.stringify(this.getName('::'))}, `; generateDefinition(nameSuffix?: string) {
out += `${INTERNAL}thunk<&${this.getName()}>, `; return `${this.getType()} ${this.getName()}${nameSuffix !== undefined ? nameSuffix : ''};\n`;
if (isVirtual) { }
const parentMethod = parentSelf ? this.#getVirtualCall(parentSelf) : 'nullptr';
out += `&${this.#getVirtualCall()}, ${parentMethod}`; // Generate "New Method" Test
generateNewMethodTest(parent: string | null, prefix: string, suffix: string) {
let out = `#define __is_new_method_${this.getName()}() (`;
if (!this.isInherited) {
out += 'true';
} else { } else {
out += `(${this.#getRawType()} *) ${toHex(this.address)}`; out += `((void *) ${prefix}${this.getName()}${suffix}) != ((void *) ${prefix}${this.getNameWithCustomSelf(parent!)}${suffix})`;
} }
out += ')'; out += ')\n';
}
out += ';\n';
return out; return out;
} }
} }

View File

@ -1,4 +1,4 @@
import { INTERNAL, formatType } from './common'; import { formatType } from './common';
export class Property { export class Property {
readonly offset: number; readonly offset: number;
@ -16,7 +16,7 @@ export class Property {
// Getters // Getters
type() { type() {
return `${INTERNAL}type_${this.fullName()}`; return `__type_${this.fullName()}`;
} }
typedef() { typedef() {
let arrayInfo = ''; let arrayInfo = '';
@ -34,14 +34,8 @@ export class Property {
} }
return name; return name;
} }
#fullName(separator: string) {
return this.#self + separator + this.name();
}
fullName() { fullName() {
return this.#fullName('_'); return `${this.#self}_${this.name()}`;
}
prettyName() {
return this.#fullName('::');
} }
rawType() { rawType() {
return this.#type; return this.#type;
@ -54,8 +48,13 @@ export class StaticProperty extends Property {
super(address, type, name, self); super(address, type, name, self);
} }
// Reference // Generate Variable Definition
referenceDefinition(addSelf: boolean) { globalPointerDefinition() {
return `${this.type()} &${addSelf ? this.prettyName() : this.name()}`; return `${this.type()} *${this.fullName()}_pointer;\n`;
}
// Generate Macro
macro() {
return `#define ${this.fullName()} (*${this.fullName()}_pointer)\n`;
} }
} }

View File

@ -1,10 +1,10 @@
import { INDENT, STRUCTURE_FILES, toHex, assertSize, INTERNAL, preventConstruction, LEAN_HEADER_GUARD } from './common'; import { INDENT, STRUCTURE_FILES, toHex, assertSize, formatType, getArgNames, removeFirstArg } from './common';
import { Method } from './method'; import { Method } from './method';
import { Property, StaticProperty } from './property'; import { Property, StaticProperty } from './property';
import { VTable } from './vtable'; import { VTable } from './vtable';
export class Struct { export class Struct {
readonly name: string; readonly #name: string;
#vtable: VTable | null; #vtable: VTable | null;
readonly #methods: Method[]; readonly #methods: Method[];
readonly #properties: Property[]; readonly #properties: Property[];
@ -12,11 +12,10 @@ export class Struct {
readonly #dependencies: string[]; readonly #dependencies: string[];
readonly #staticProperties: StaticProperty[]; readonly #staticProperties: StaticProperty[];
#directParent: string | null; #directParent: string | null;
#isSimple: boolean;
// Constructor // Constructor
constructor(name: string) { constructor(name: string) {
this.name = name; this.#name = name;
this.#methods = []; this.#methods = [];
this.#properties = []; this.#properties = [];
this.#vtable = null; this.#vtable = null;
@ -24,7 +23,6 @@ export class Struct {
this.#dependencies = []; this.#dependencies = [];
this.#staticProperties = []; this.#staticProperties = [];
this.#directParent = null; this.#directParent = null;
this.#isSimple = false;
} }
// Dependencies // Dependencies
@ -36,29 +34,39 @@ export class Struct {
} }
// Ensure VTable Exists // Ensure VTable Exists
getVTable() { ensureVTable() {
if (this.#vtable === null) { if (this.#vtable === null) {
this.#vtable = new VTable(this.name); this.#vtable = new VTable(this.#name);
this.addProperty(this.#vtable.property); this.addProperty(this.#vtable.property);
} }
return this.#vtable; }
// Set VTable Destructor Offset
setVTableDestructorOffset(offset: number) {
this.ensureVTable();
this.#vtable!.setDestructorOffset(offset);
} }
// Setters // Setters
setSize(size: number) { setSize(size: number) {
this.#size = size; this.#size = size;
} }
// Getters
getName() {
return this.#name;
}
// Add Method // Add Method
addMethod(method: Method, isVirtual: boolean) { addMethod(method: Method, isVirtual: boolean) {
if (method.returnType !== this.name && method.returnType in STRUCTURE_FILES) { if (method.returnType !== this.#name && method.returnType in STRUCTURE_FILES) {
this.#addDependency(method.returnType); this.#addDependency(method.returnType);
} }
if (isVirtual) { if (isVirtual) {
if (method.self !== this.name) { if (method.self !== this.#name) {
throw new Error(); throw new Error();
} }
this.getVTable().add(method); this.ensureVTable();
this.#vtable!.add(method);
} else { } else {
if (method.isInherited) { if (method.isInherited) {
this.#addDependency(method.self); this.#addDependency(method.self);
@ -80,21 +88,14 @@ export class Struct {
this.#staticProperties.push(property); this.#staticProperties.push(property);
} }
// "Simple" Structures // Configure VTable
markAsSimple() { setVTableSize(size: number) {
this.#isSimple = true; this.ensureVTable();
} this.#vtable!.setSize(size);
#checkSimple() {
const checks = [
['Cannot Inherit', this.#directParent !== null],
['Must Have A Defined Size', this.#size === null],
['Cannot Have A VTable', this.#vtable !== null]
];
for (const check of checks) {
if (check[1]) {
throw new Error('Simple Structures ' + check[0]);
}
} }
setVTableAddress(address: number) {
this.ensureVTable();
this.#vtable!.setAddress(address);
} }
// Generate Properties // Generate Properties
@ -126,9 +127,7 @@ export class Struct {
if (lastProperty) { if (lastProperty) {
paddingSize += ` - sizeof(${lastProperty.type()})`; paddingSize += ` - sizeof(${lastProperty.type()})`;
} }
if (!this.#isSimple) { out += `${INDENT}uchar __padding${i}[${paddingSize}];\n`;
out += `${INDENT}uchar ${INTERNAL}padding${i}[${paddingSize}];\n`;
}
// The Actual Property // The Actual Property
if (property !== sizeProperty) { if (property !== sizeProperty) {
@ -139,52 +138,51 @@ export class Struct {
} }
// Generate C++ Method Shortcuts // Generate C++ Method Shortcuts
#generateMethod(method: Method, isVirtual: boolean) {
let out = '';
out += INDENT;
if (method.isStatic) {
out += 'static ';
}
out += `decltype(auto) ${method.shortName}(auto&&... args) {\n`;
out += `${INDENT}${INDENT}return `;
if (isVirtual) {
out += `this->vtable->${method.shortName}`;
} else {
out += `${method.getName()}->get(false)`;
}
out += '(';
if (!method.isStatic) {
out += `(${method.self} *) this, `;
}
out += 'std::forward<decltype(args)>(args)...);\n';
out += `${INDENT}}\n`;
return out;
}
#generateMethods() { #generateMethods() {
let out = ''; let out = '';
out += LEAN_HEADER_GUARD;
// Normal Methods // Normal Methods
const getArgsOuter = (method: Method) => {
let out = method.args;
if (!method.isStatic) {
// Remove "self"
out = removeFirstArg(out);
}
return out;
};
const getArgsInner = (method: Method) => {
const list = getArgNames(method.args);
if (!method.isStatic) {
// Replace "self" With "this"
list[0] = `(${method.self} *) this`;
}
return list.join(', ');
};
for (const method of this.#methods) { for (const method of this.#methods) {
out += this.#generateMethod(method, false); if (!method.hasVarargs) {
const returnType = method.returnType;
const shortName = method.shortName;
const fullName = method.getName();
const args = getArgsOuter(method);
out += `${INDENT}inline ${formatType(returnType)}${shortName}${args} { \\\n`;
out += `${INDENT}${INDENT}${returnType.trim() === 'void' ? '' : 'return '}${fullName}(${getArgsInner(method)});\n`;
out += `${INDENT}}\n`;
}
} }
// Virtual Methods // Virtual Methods
if (this.#vtable !== null) { if (this.#vtable !== null) {
const virtualMethods = this.#vtable.getMethods(); const virtualMethods = this.#vtable.getMethods();
for (const method of virtualMethods) { for (const method of virtualMethods) {
if (method) { if (method && !method.hasVarargs) {
out += this.#generateMethod(method, true); const returnType = method.returnType;
} const shortName = method.shortName;
} const args = getArgsOuter(method);
} out += `${INDENT}inline ${formatType(returnType)}${shortName}${args} { \\\n`;
// Allocation Method out += `${INDENT}${INDENT}${returnType.trim() === 'void' ? '' : 'return '}this->vtable->${shortName}(${getArgsInner(method)});\n`;
if (this.#size !== null) {
// THIS DOES NOT CONSTRUCT THE OBJECT
out += `${INDENT}static ${this.name} *allocate() {\n`;
out += `${INDENT}${INDENT}return (${this.name} *) ::operator new(sizeof(${this.name}));\n`;
out += `${INDENT}}\n`; out += `${INDENT}}\n`;
} }
}
}
// Return // Return
out += '#endif\n';
return out; return out;
} }
@ -192,19 +190,26 @@ export class Struct {
generate() { generate() {
let out = ''; let out = '';
// Check "Simple" Status // Static Properties
if (this.#isSimple) { for (const property of this.#staticProperties) {
this.#checkSimple(); out += property.typedef();
out += `extern ${property.globalPointerDefinition()}`;
out += property.macro();
}
// Methods
for (const method of this.#methods) {
if (!method.isInherited) {
out += method.generateTypedef();
out += `extern ${method.generateDefinition()}`;
out += `extern ${method.generateDefinition('_unedited')}`;
out += method.generateNewMethodTest(this.#directParent, '', '');
}
} }
// VTable // VTable
if (this.#vtable !== null) { if (this.#vtable !== null) {
out += this.#vtable.generate(); out += this.#vtable.generate(this.#directParent);
}
// Static Properties
for (const property of this.#staticProperties) {
out += property.typedef();
} }
// Property Typedefs // Property Typedefs
@ -212,32 +217,10 @@ export class Struct {
out += property.typedef(); out += property.typedef();
} }
// Method Wrappers
let typedefs = '';
let methodsOut = '';
for (const method of this.#methods) {
if (!method.isInherited) {
typedefs += method.generateTypedefs();
methodsOut += method.generate(false, false);
}
}
out += typedefs;
out += LEAN_HEADER_GUARD;
out += methodsOut;
out += '#endif\n';
// Structure // Structure
out += `struct ${this.name} final {\n`; out += `struct ${this.#name} {\n`;
out += this.#generateProperties(); out += this.#generateProperties();
out += this.#generateMethods(); out += this.#generateMethods();
for (const property of this.#staticProperties) {
// Static Property References
out += `${INDENT}static ${property.referenceDefinition(false)};\n`;
}
if (!this.#isSimple) {
// Disable Construction Of Complex Structures
out += preventConstruction(this.name);
}
out += `};\n`; out += `};\n`;
// Sanity Check Offsets // Sanity Check Offsets
@ -245,12 +228,17 @@ export class Struct {
const property = this.#properties[i]!; const property = this.#properties[i]!;
const name = property.name(); const name = property.name();
const offset = property.offset; const offset = property.offset;
out += `static_assert(offsetof(${this.name}, ${name}) == ${toHex(offset)}, "Invalid Offset");\n`; out += `static_assert(offsetof(${this.#name}, ${name}) == ${toHex(offset)}, "Invalid Offset");\n`;
} }
// Sanity Check Size // Sanity Check Size
if (this.#size !== null) { if (this.#size !== null) {
out += assertSize(this.name, this.#size); out += assertSize(this.#name, this.#size);
}
// Allocation Function
if (this.#size !== null) {
out += `${this.#name} *alloc_${this.#name}();\n`;
} }
// Return // Return
@ -259,28 +247,41 @@ export class Struct {
// Generate Compiled Code // Generate Compiled Code
generateCode() { generateCode() {
let out = ''; let declarations = '';
let init = '';
// Static Properties // Static Properties
for (const property of this.#staticProperties) { for (const property of this.#staticProperties) {
out += `${property.referenceDefinition(true)} = *(${property.type()} *) ${toHex(property.offset)};\n`; init += `${INDENT}${property.fullName()}_pointer = (${property.type()} *) ${toHex(property.offset)};\n`;
declarations += property.globalPointerDefinition();
} }
// Methods // Methods
for (const method of this.#methods) { for (const method of this.#methods) {
if (!method.isInherited) { if (!method.isInherited) {
out += method.generate(true, false); init += `${INDENT}${method.getName()} = (${method.getType()}) ${toHex(method.address)};\n`;
declarations += method.generateDefinition();
init += `${INDENT}${method.getName()}_unedited = (${method.getType()}) ${toHex(method.address)};\n`;
declarations += method.generateDefinition('_unedited');
} }
} }
// VTable // VTable
if (this.#vtable !== null) { if (this.#vtable !== null) {
const vtable = this.#vtable.generateCode(this.#directParent); const vtable = this.#vtable.generateCode();
out += vtable; declarations += vtable.declarations;
init += vtable.init;
}
// Allocation Function
if (this.#size !== null) {
declarations += `${this.#name} *alloc_${this.#name}() {\n`;
declarations += `${INDENT}return new ${this.#name};\n`;
declarations += '}\n';
} }
// Return // Return
return out; return {functions: declarations, init};
} }
// Set Direct Parent (Used For "New Method" Testing) // Set Direct Parent (Used For "New Method" Testing)

View File

@ -1,8 +1,7 @@
import { INDENT, LEAN_HEADER_GUARD, POINTER_SIZE, assertSize, getSelfArg, preventConstruction, toHex } from './common'; import { INDENT, POINTER_SIZE, RTTI_SIZE, assertSize, getSelfArg, toHex } from './common';
import { Method } from './method'; import { Method } from './method';
import { Property } from './property'; import { Property } from './property';
const structuresWithVTableAddress: string[] = [];
export class VTable { export class VTable {
readonly #self: string; readonly #self: string;
#address: number | null; #address: number | null;
@ -25,7 +24,6 @@ export class VTable {
// Setters // Setters
setAddress(address: number) { setAddress(address: number) {
this.#address = address; this.#address = address;
structuresWithVTableAddress.push(this.#self);
} }
setSize(size: number) { setSize(size: number) {
this.#size = size; this.#size = size;
@ -86,69 +84,34 @@ export class VTable {
return out; return out;
} }
// Get Parent Method
#getParentSelf(method: Method, parent: string | null) {
if (method.isInherited) {
// Parent Exists
let out: string;
if (structuresWithVTableAddress.includes(parent!)) {
out = parent!;
} else {
// Unable To Determine
out = this.#self;
}
return out;
} else {
// Method Has No Parent
return undefined;
}
}
// Generate Header Code // Generate Header Code
canGenerateWrappers() { generate(directParent: string | null) {
return this.#address !== null;
}
generate() {
let out = ''; let out = '';
// Check // Check
this.#check(); this.#check();
// Wrappers // Method Prototypes
const methods = this.getMethods(); const methods = this.getMethods();
let typedefs = '';
let methodsOut = '';
for (const info of methods) {
if (info) {
typedefs += info.generateTypedefs();
if (this.canGenerateWrappers()) {
methodsOut += info.generate(false, true);
}
}
}
out += typedefs;
out += LEAN_HEADER_GUARD;
out += methodsOut;
out += '#endif\n';
// Structure
out += `typedef struct ${this.#getName()} ${this.#getName()};\n`;
out += `struct ${this.#getName()} final {\n`;
for (let i = 0; i < methods.length; i++) { for (let i = 0; i < methods.length; i++) {
const info = methods[i]; const info = methods[i];
if (info) { if (info) {
out += info.getProperty(); out += info.generateTypedef();
} else {
out += `${INDENT}void *unknown${i};\n`;
} }
} }
if (this.#size === null) {
// Prevent Construction // Structure
out += preventConstruction(this.#getName()); out += `typedef struct ${this.#getName()} ${this.#getName()};\n`;
out += `struct ${this.#getName()} {\n`;
for (let i = 0; i < methods.length; i++) {
let name = `unknown${i}`;
let type = 'void *';
const info = methods[i];
if (info) {
name = info.shortName;
type = info.getType() + ' ';
} }
if (this.#address !== null) { out += `${INDENT}${type}${name};\n`;
// Base
out += `${INDENT}static ${this.#getName()} *base;\n`;
} }
out += `};\n`; out += `};\n`;
@ -157,13 +120,35 @@ export class VTable {
out += assertSize(this.#getName(), this.#size); out += assertSize(this.#getName(), this.#size);
} }
// Pointers
if (this.#address !== null) {
// Base
out += `extern ${this.#getName()} *${this.#getName()}_base;\n`;
// Methods
for (let i = 0; i < methods.length; i++) {
const info = methods[i];
if (info) {
const type = `${info.getType()} *`;
out += `extern ${type}${info.getName()}_vtable_addr;\n`;
out += `extern ${info.generateDefinition('_non_virtual')}`;
out += info.generateNewMethodTest(directParent, '*', '_vtable_addr');
}
}
}
// Duplication Method
if (this.#size !== null) {
out += `${this.#getName()} *dup_${this.#getName()}(${this.#getName()} *vtable);\n`;
}
// Return // Return
return out; return out;
} }
// Generate Compiled Code // Generate Compiled Code
generateCode(directParent: string | null) { generateCode() {
let out = ''; let declarations = '';
let init = '';
// Check // Check
this.#check(); this.#check();
@ -171,20 +156,40 @@ export class VTable {
// Pointers // Pointers
if (this.#address !== null) { if (this.#address !== null) {
// Base // Base
out += `${this.#getName()} *${this.#getName()}::base = (${this.#getName()} *) ${toHex(this.#address)};\n`; init += `${INDENT}${this.#getName()}_base = (${this.#getName()} *) ${toHex(this.#address)};\n`;
declarations += `${this.#getName()} *${this.#getName()}_base;\n`;
// Methods
const methods = this.getMethods();
for (let i = 0; i < methods.length; i++) {
const info = methods[i];
if (info) {
const vtableAddress = this.#address + (i * POINTER_SIZE);
const type = `${info.getType()} *`;
init += `${INDENT}${info.getName()}_vtable_addr = (${type}) ${toHex(vtableAddress)};\n`;
declarations += `${type}${info.getName()}_vtable_addr;\n`;
init += `${INDENT}${info.getName()}_non_virtual = *${info.getName()}_vtable_addr;\n`;
declarations += info.generateDefinition('_non_virtual');
}
}
} }
// Method Wrappers // Duplication Method
if (this.canGenerateWrappers()) { if (this.#size !== null) {
const methods = this.getMethods(); declarations += `${this.#getName()} *dup_${this.#getName()}(${this.#getName()} *vtable) {\n`;
for (const info of methods) { declarations += `${INDENT}uchar *real_vtable = (uchar *) vtable;\n`;
if (info) { declarations += `${INDENT}real_vtable -= ${RTTI_SIZE};\n`;
out += info.generate(true, true, this.#getParentSelf(info, directParent)); declarations += `${INDENT}size_t real_vtable_size = sizeof(${this.#getName()}) + ${RTTI_SIZE};\n`;
} declarations += `${INDENT}uchar *new_vtable = (uchar *) ::operator new(real_vtable_size);\n`;
} declarations += `${INDENT}if (new_vtable == NULL) {\n`;
declarations += `${INDENT}${INDENT}return NULL;\n`;
declarations += `${INDENT}}\n`;
declarations += `${INDENT}memcpy((void *) new_vtable, (void *) real_vtable, real_vtable_size);\n`;
declarations += `${INDENT}new_vtable += ${RTTI_SIZE};\n`;
declarations += `${INDENT}return (${this.#getName()} *) new_vtable;\n`;
declarations += '}\n';
} }
// Return // Return
return out; return {declarations, init};
} }
} }

View File

@ -0,0 +1,34 @@
syntax def "\.def$"
comment "//"
# Mistakes
# Missing semicolon
color red "[^;]$"
# Missing type
color red "^(((static|virtual)-)?method|property|static-property(-array)?) [a-zA-Z_][a-zA-Z0-9_]* ?(\(|=)"
# Missing prefix
color red "^[^ ]+"
# Missing vtable
color red "^(vtable(-size|-destructor-offset))? .+$"
# Reset
color normal "(\(|\))"
# Commands
color magenta "^(extends|size|vtable(-size|-destructor-offset)?|property|static-property|((static|virtual)-)?method|constructor)\>"
# Types
color green "\<((u?(char|short|int))|float|bool|void|std::(string|vector|map))\>"
# Numbers
color yellow "0x[a-f0-9]+"
# Non-hex numbers
color red " [0-9][a-f0-9]+;"
# Comments
color brightblue "//.*"
# Whitespace.
color normal "[[:space:]]+"
# Trailing whitespace.
color ,green "[[:space:]]+$"

View File

@ -13,10 +13,8 @@
<item>static-method</item> <item>static-method</item>
<item>constructor</item> <item>constructor</item>
<item>vtable-destructor-offset</item> <item>vtable-destructor-offset</item>
<item>mark-as-simple</item>
</list> </list>
<list name="types"> <list name="types">
<item>const</item>
<item>char</item> <item>char</item>
<item>uchar</item> <item>uchar</item>
<item>short</item> <item>short</item>

View File

@ -1,21 +0,0 @@
syntax def "\.def$"
comment "//"
# Commands
color magenta "\<(extends|size|vtable(-size|-destructor-offset)?|property|static-property|((static|virtual)-)?method|constructor|mark-as-simple)\>"
# Types
color green "\<((u?(char|short|int))|float|bool|void|std::(string|vector|map))\>"
# Numbers
color yellow "0x[a-f0-9]+"
# Non-hex numbers
color red " [0-9][a-f0-9]+;"
# Comments
color brightblue "//.*"
# Whitespace.
color normal "[[:space:]]+"
# Trailing whitespace.
color ,green "[[:space:]]+$"

View File

@ -1,24 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>name</key>
<string>Comments</string>
<key>scope</key>
<string>source.toml</string>
<key>settings</key>
<dict>
<key>shellVariables</key>
<array>
<dict>
<key>name</key>
<string>TM_COMMENT_START</string>
<key>value</key>
<string>//</string>
</dict>
</array>
</dict>
<key>uuid</key>
<string>C5C885D7-2733-4632-B709-B5B9DD518F90</string>
</dict>
</plist>

View File

@ -1,55 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>fileTypes</key>
<array>
<string>def</string>
</array>
<key>scopeName</key>
<string>source.symbol-processor</string>
<key>name</key>
<string>Symbol Processor Definition</string>
<key>patterns</key>
<array>
<dict>
<key>name</key>
<string>comment.line.double-slash.symbol-processor</string>
<key>match</key>
<string>//.*$</string>
</dict>
<dict>
<key>name</key>
<string>constant.numeric.symbol-processor.hex</string>
<key>match</key>
<string>\b0[xX][0-9a-fA-F]+</string>
</dict>
<dict>
<key>name</key>
<string>constant.numeric.symbol-processor.decimal</string>
<key>match</key>
<string>\b[0-9]+</string>
</dict>
<dict>
<key>name</key>
<string>keyword.control.symbol-processor</string>
<key>match</key>
<string>\b(extends|size|vtable-size|vtable-destructor-offset|vtable|property|static-property|method|virtual-method|static-method|constructor|mark-as-simple)\b</string>
</dict>
<dict>
<key>name</key>
<string>storage.type.symbol-processor</string>
<key>match</key>
<string>\b(const|char|uchar|short|ushort|int|uint|float|bool|void|std::string|std::vector|std::map|unsigned|long)\b</string>
</dict>
<dict>
<key>name</key>
<string>keyword.operator.symbol-processor</string>
<key>match</key>
<string>(=|;)</string>
</dict>
</array>
<key>uuid</key>
<string>D44198D4-5AEB-40E5-B4E4-0E11C69FFA42</string>
</dict>
</plist>

View File

@ -1,16 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>contactEmailRot13</key>
<string>connor24nolan@live.com</string>
<key>contactName</key>
<string>TheBrokenRail</string>
<key>description</key>
<string>Symbol Processor Definition File</string>
<key>name</key>
<string>Symbol Processor</string>
<key>uuid</key>
<string>8209EEB8-4193-4E63-BDBB-0407E47ADF50</string>
</dict>
</plist>