Files
ClassicAPI/AddOns/!!!ClassicAPI/Util/EventUtil.lua
T
2026-05-30 14:53:45 -05:00

164 lines
4.8 KiB
Lua

-- Backport of 3.3.5 FrameXML/EventUtil.lua to vanilla 1.12 / Lua 5.0.
--
-- Implementation differences from the 3.3.5 source:
-- - Lua 5.0 has no select(); we work off the implicit `arg` table
-- in vararg functions.
-- - 1.12 has no C_AddOns; the legacy global IsAddOnLoaded(name)
-- fills the same role.
-- - 1.12 has no secureexecuterange; queued callbacks are dispatched
-- by a plain ipairs loop.
-- - AreVariablesLoaded in 3.3.5 sniffs GlueParent / UIParent.firstTimeLoaded.
-- 1.12 has neither; we track a private flag flipped on VARIABLES_LOADED.
EventUtil = {}
local ContinueAfterAllEventsMixin = {}
function ContinueAfterAllEventsMixin:Init(callback, ...)
self.events = {}
for index = 1, arg.n do
local event = arg[index]
assert(C_EventUtils.IsEventValid(event), "Unknown event \"" .. event .. "\"")
self.events[event] = false
local function OnEventReceived()
self.events[event] = true
EventRegistry:UnregisterFrameEventAndCallback(event, self)
if self:HaveReceivedAllEvents() then
callback()
end
end
EventRegistry:RegisterFrameEventAndCallback(event, OnEventReceived, self)
end
end
function ContinueAfterAllEventsMixin:HaveReceivedAllEvents()
for event, received in pairs(self.events) do
if not received then
return false
end
end
return true
end
function EventUtil.ContinueAfterAllEvents(callback, ...)
local obj = CreateFromMixins(ContinueAfterAllEventsMixin)
obj:Init(callback, unpack(arg))
end
-- Tracked locally because 1.12 has no GlueParent / UIParent.firstTimeLoaded.
-- Bootstrap frame at the bottom of the file listens for VARIABLES_LOADED
-- and flips the flag, then drains the queued callbacks via the
-- TriggerOnVariablesLoaded path.
local variablesLoaded = false
function EventUtil.AreVariablesLoaded()
return variablesLoaded
end
local eventUtilVariablesLoadedCallbacks = {}
function EventUtil.ContinueOnVariablesLoaded(callback)
if EventUtil.AreVariablesLoaded() then
callback()
return
end
table.insert(eventUtilVariablesLoadedCallbacks, callback)
end
local eventUtilContinueOnVariablesLoadedTriggered = false
function EventUtil.TriggerOnVariablesLoaded()
if eventUtilContinueOnVariablesLoadedTriggered then
return
end
eventUtilContinueOnVariablesLoadedTriggered = true
variablesLoaded = true
for _, callback in ipairs(eventUtilVariablesLoadedCallbacks) do
callback()
end
end
function EventUtil.ContinueOnAddOnLoaded(addOnName, callback)
local isLoadedOrLoading, isLoaded = C_AddOns.IsAddOnLoaded(addOnName)
if isLoaded then
callback();
return;
end
EventUtil.RegisterOnceFrameEventAndCallback("ADDON_LOADED", callback, addOnName)
end
function EventUtil.ContinueOnPlayerLogin(callback)
if IsLoggedIn() then
callback()
return
end
EventUtil.RegisterOnceFrameEventAndCallback("PLAYER_LOGIN", callback)
end
-- `...` are optional event arguments that must match before the callback fires.
function EventUtil.RegisterOnceFrameEventAndCallback(frameEvent, callback, ...)
local handle = nil
local requiredEventArgs = SafePack(unpack(arg))
local CallbackWrapper = function(callbackHandlerID, ...)
for i = 1, requiredEventArgs.n do
if arg[i] ~= requiredEventArgs[i] then
return
end
end
handle:Unregister()
callback(unpack(arg))
end
handle = EventRegistry:RegisterFrameEventAndCallbackWithHandle(frameEvent, CallbackWrapper)
end
CallbackHandleContainerMixin = {}
function CallbackHandleContainerMixin:Init()
self.handles = {}
end
function CallbackHandleContainerMixin:RegisterCallback(cbr, event, callback, owner)
self:AddHandle(cbr:RegisterCallbackWithHandle(event, callback, owner))
end
function CallbackHandleContainerMixin:AddHandle(handle)
table.insert(self.handles, handle)
end
function CallbackHandleContainerMixin:Unregister()
for index, handle in ipairs(self.handles) do
handle:Unregister()
end
self.handles = {}
end
function CallbackHandleContainerMixin:IsEmpty()
return table.getn(self.handles) == 0
end
function EventUtil.CreateCallbackHandleContainer()
local cbrHandles = CreateFromMixins(CallbackHandleContainerMixin)
cbrHandles:Init()
return cbrHandles
end
-- VARIABLES_LOADED bootstrap. Drains anything queued via
-- ContinueOnVariablesLoaded the first time the event fires. We use a
-- dedicated frame so we don't pollute EventRegistry's payload routing.
do
local f = CreateFrame("Frame")
f:RegisterEvent("VARIABLES_LOADED")
f:SetScript("OnEvent", function()
EventUtil.TriggerOnVariablesLoaded()
f:UnregisterEvent("VARIABLES_LOADED")
end)
end