Skip to content

feat: disable hook check when not needed #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 14, 2024
Merged

feat: disable hook check when not needed #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1fba93
feat: disable hook check when not needed
Qubus0 Nov 14, 2024
f8f5170
feat: split off verbose hook preprocessing
Qubus0 Nov 14, 2024
683ac28
space
Qubus0 Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion addons/mod_loader/_export_plugin/export_plugin.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ func _export_file(path: String, type: String, features: PackedStringArray) -> vo
skip()
add_file(
path,
hook_pre_processor.process_script(path).to_utf8_buffer(),
hook_pre_processor.process_script(path, true).to_utf8_buffer(),
false
)
26 changes: 14 additions & 12 deletions addons/mod_loader/internal/mod_hook_preprocessor.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func process_begin() -> void:
hashmap.clear()


func process_script(path: String) -> String:
func process_script(path: String, enable_hook_check := false) -> String:
var start_time := Time.get_ticks_msec()
ModLoaderLog.debug("Start processing script at path: %s" % path, LOG_NAME)
var current_script := load(path) as GDScript
Expand Down Expand Up @@ -67,8 +67,8 @@ func process_script(path: String) -> String:

var hash_before := _ModLoaderHooks.get_hook_hash(path, method.name, true)
var hash_after := _ModLoaderHooks.get_hook_hash(path, method.name, false)
var hash_before_data := [path, method.name,true]
var hash_after_data := [path, method.name,false]
var hash_before_data := [path, method.name, true]
var hash_after_data := [path, method.name, false]
if hashmap.has(hash_before):
push_error(HASH_COLLISION_ERROR%[hashmap[hash_before], hash_before_data])
if hashmap.has(hash_after):
Expand All @@ -87,6 +87,7 @@ func process_script(path: String) -> String:
hash_before,
hash_after,
METHOD_PREFIX + class_prefix,
enable_hook_check
)

# Store the method name
Expand Down Expand Up @@ -261,24 +262,24 @@ static func get_mod_loader_hook(
return_prop_usage: int,
is_static: bool,
script_path: String,
hash_before:int,
hash_after:int,
method_prefix := METHOD_PREFIX
hash_before: int,
hash_after: int,
method_prefix := METHOD_PREFIX,
enable_hook_check := false,
) -> String:
var type_string := " -> %s" % method_type if not method_type.is_empty() else ""
var static_string := "static " if is_static else ""
# Cannot use "self" inside a static function.
var self_string := "null" if is_static else "self"
var return_var := "var %s = " % "return_var" if not method_type.is_empty() or return_prop_usage == 131072 else ""
var method_return := "return %s" % "return_var" if not method_type.is_empty() or return_prop_usage == 131072 else ""
var hook_check := 'if ModLoaderStore.get("any_mod_hooked") and ModLoaderStore.any_mod_hooked:\n\t\t' if enable_hook_check else ""

return """
{STATIC}func {METHOD_NAME}({METHOD_PARAMS}){RETURN_TYPE_STRING}:
if ModLoaderStore.get("any_mod_hooked") and ModLoaderStore.any_mod_hooked:
_ModLoaderHooks.call_hooks({SELF}, [{METHOD_ARGS}], {HOOK_ID_BEFORE})
{HOOKS_CHECK}_ModLoaderHooks.call_hooks({SELF}, [{METHOD_ARGS}], {HOOK_ID_BEFORE})
{METHOD_RETURN_VAR}{METHOD_PREFIX}_{METHOD_NAME}({METHOD_ARGS})
if ModLoaderStore.get("any_mod_hooked") and ModLoaderStore.any_mod_hooked:
_ModLoaderHooks.call_hooks({SELF}, [{METHOD_ARGS}], {HOOK_ID_AFTER})
{HOOK_CHECK}_ModLoaderHooks.call_hooks({SELF}, [{METHOD_ARGS}], {HOOK_ID_AFTER})
{METHOD_RETURN}""".format({
"METHOD_PREFIX": method_prefix,
"METHOD_NAME": method_name,
Expand All @@ -290,8 +291,9 @@ static func get_mod_loader_hook(
"METHOD_RETURN": method_return,
"STATIC": static_string,
"SELF": self_string,
"HOOK_ID_BEFORE" : hash_before,
"HOOK_ID_AFTER" : hash_after,
"HOOK_ID_BEFORE": hash_before,
"HOOK_ID_AFTER": hash_after,
"HOOK_CHECK": hook_check,
})


Expand Down