if Debug then Debug.beginFile "Hook" end
--——————————————————————————————————————
-- Hook version 7.1 Preview
-- Created by: Bribe
-- Contributors: Eikonium, Jampion, MyPad, Wrda
--—————————————————————————————————————————————
---@class Hook
---@field next function|Hook --Call the next/native function. Also works with any given name (old/native/original/etc.). The args and return values match those of the original function.
---@field remove fun(all?: boolean) --Remove the hook. Pass the boolean "true" to remove all hooks.
---@field protected tree HookTree --Reference to the tree storing each hook on that particular key in that particular host.
---@field private delete fun(h: Hook, all?: boolean) --Does not extend to child instances of Hook.
---@field package priority number
---@field package index integer
---@field package basic function|false
Hook = {}
---@class HookTree: { [integer]: Hook } --For some reason, the extension doesn't recognize Hook[] as correct syntax.
---@field host table
---@field key any --What was the function indexed to (_G items are typically indexed via strings)
---@field package basic function|false
do
local mode_v = {__mode="v"}
local treeMap = setmetatable({ [_G] = setmetatable({}, mode_v) }, mode_v) ---@type table<table,table<any,HookTree>>
---@param tree HookTree
---@param index integer
---@param new? table
local function resizeTree(tree, index, new)
table[new and "insert" or "remove"](tree, index, new)
local top, prev = #tree, tree[index-1]
for i=index, top do
local h = tree[i]
h.index = i
h.next = (i > 1) and prev.basic or prev
prev = h
end
local basic = tree[top].basic
if basic then
if tree.basic ~= basic then
tree.basic = basic
tree.host[tree.key] = basic
end
elseif tree.basic ~= false then
tree.basic = false
tree.host[tree.key] = function(...) return tree[#tree](...) end
end
end
---@param h Hook
---@param all? boolean
function Hook.delete(h, all)
local tree = h.tree
h.tree = nil
if (all==true) or (#tree == 1) then
tree.host[tree.key] = (tree[0] ~= DoNothing) and tree[0] or nil
treeMap[tree.host][tree.key] = nil
else
resizeTree(tree, h.index)
end
end
local function getIndex(h, key) return (key == "remove") and function(all) Hook.delete(h, all) end or h.next end
---@param key any Usually a string (the name of the native you wish to hook)
---@param callback fun(Hook, ...):any The function you want to run when the native is called. The first parameter is type "Hook", and the remaining parameters (and return value(s)) align with the original function.
---@param priority? number Defaults to 0. Hooks are called in order of highest priority down to lowest priority. The native itself has the lowest priority.
---@param host? table Defaults to _G (the table that stores all global variables).
---@param default? function If the native does not exist in the host table, use this default instead.
---@param metatable? boolean Whether to store into the host's metatable instead. Defaults to true if the "default" parameter is given.
---@return Hook
function Hook.add(key, callback, priority, host, default, metatable, basic)
priority=priority or 0; host=host or _G
if metatable or (default and metatable==nil) then
host = getmetatable(host) or getmetatable(setmetatable(host, {}))
end
treeMap[host]=treeMap[host] or setmetatable({}, mode_v)
local index, tree = 1, treeMap[host][key]
if tree then
local exit = #tree
repeat if priority <= tree[index].priority then break end
index=index+1 until index > exit
else
tree = { host=host, key=key, [0] = rawget(host, key) or default or (host ~= _G or type(key)~="string") and DoNothing or (Debug and Debug.error or print)("No value found for key: "..key) }
treeMap[host][key] = tree
end
local new = { priority=priority, tree=tree, basic=callback } ---@type Hook
if not basic then
setmetatable(new, {__call=callback, __index=getIndex}).basic = false
end
resizeTree(tree, index, new)
return new
end
end
---@param k any Usually a string (the name of the native you wish to hook)
---@param c function The function you want to run when the native is called. The parameters and return values align with those of the original native.
---@param p? number Defaults to 0. Hooks are called in order of highest priority down to lowest priority. The native itself has the lowest priority.
---@param h? table Defaults to _G (the table that stores all global variables).
---@param d? function If the native does not exist in the host table, use this default instead.
---@param m? boolean Whether to store into the host's metatable instead. Defaults to true if the "default" parameter is given.
---@return fun(...):any next Calls the next (lower-priority) hook or the native function.
---@return fun(all?) remove
AddHook = function(k,c,p,h,d,m) local new = Hook.add(k,c,p,h,d,m,true); return function(...) return new.next(...) end, new.remove end
setmetatable(Hook, { __newindex = function(_, key, callback) Hook.add(key, callback) end } )
if Debug then Debug.endFile() end
