Mercurial > wow > askmrrobot

annotate libs/CallbackHandler-1.0/CallbackHandler-1.0.lua @ 0:ec731d2fe6ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Version 1.2.12.0
author Adam tegen <adam.tegen@gmail.com>
date Tue, 20 May 2014 21:43:23 -0500
parents
children
rev   line source
adam@0 1 --[[ $Id: CallbackHandler-1.0.lua 14 2010-08-09 00:43:38Z mikk $ ]]
adam@0 2 local MAJOR, MINOR = "CallbackHandler-1.0", 6
adam@0 3 local CallbackHandler = LibStub:NewLibrary(MAJOR, MINOR)
adam@0 4
adam@0 5 if not CallbackHandler then return end -- No upgrade needed
adam@0 6
adam@0 7 local meta = {__index = function(tbl, key) tbl[key] = {} return tbl[key] end}
adam@0 8
adam@0 9 -- Lua APIs
adam@0 10 local tconcat = table.concat
adam@0 11 local assert, error, loadstring = assert, error, loadstring
adam@0 12 local setmetatable, rawset, rawget = setmetatable, rawset, rawget
adam@0 13 local next, select, pairs, type, tostring = next, select, pairs, type, tostring
adam@0 14
adam@0 15 -- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
adam@0 16 -- List them here for Mikk's FindGlobals script
adam@0 17 -- GLOBALS: geterrorhandler
adam@0 18
adam@0 19 local xpcall = xpcall
adam@0 20
adam@0 21 local function errorhandler(err)
adam@0 22 return geterrorhandler()(err)
adam@0 23 end
adam@0 24
adam@0 25 local function CreateDispatcher(argCount)
adam@0 26 local code = [[
adam@0 27 local next, xpcall, eh = ...
adam@0 28
adam@0 29 local method, ARGS
adam@0 30 local function call() method(ARGS) end
adam@0 31
adam@0 32 local function dispatch(handlers, ...)
adam@0 33 local index
adam@0 34 index, method = next(handlers)
adam@0 35 if not method then return end
adam@0 36 local OLD_ARGS = ARGS
adam@0 37 ARGS = ...
adam@0 38 repeat
adam@0 39 xpcall(call, eh)
adam@0 40 index, method = next(handlers, index)
adam@0 41 until not method
adam@0 42 ARGS = OLD_ARGS
adam@0 43 end
adam@0 44
adam@0 45 return dispatch
adam@0 46 ]]
adam@0 47
adam@0 48 local ARGS, OLD_ARGS = {}, {}
adam@0 49 for i = 1, argCount do ARGS[i], OLD_ARGS[i] = "arg"..i, "old_arg"..i end
adam@0 50 code = code:gsub("OLD_ARGS", tconcat(OLD_ARGS, ", ")):gsub("ARGS", tconcat(ARGS, ", "))
adam@0 51 return assert(loadstring(code, "safecall Dispatcher["..argCount.."]"))(next, xpcall, errorhandler)
adam@0 52 end
adam@0 53
adam@0 54 local Dispatchers = setmetatable({}, {__index=function(self, argCount)
adam@0 55 local dispatcher = CreateDispatcher(argCount)
adam@0 56 rawset(self, argCount, dispatcher)
adam@0 57 return dispatcher
adam@0 58 end})
adam@0 59
adam@0 60 --------------------------------------------------------------------------
adam@0 61 -- CallbackHandler:New
adam@0 62 --
adam@0 63 -- target - target object to embed public APIs in
adam@0 64 -- RegisterName - name of the callback registration API, default "RegisterCallback"
adam@0 65 -- UnregisterName - name of the callback unregistration API, default "UnregisterCallback"
adam@0 66 -- UnregisterAllName - name of the API to unregister all callbacks, default "UnregisterAllCallbacks". false == don't publish this API.
adam@0 67
adam@0 68 function CallbackHandler:New(target, RegisterName, UnregisterName, UnregisterAllName, OnUsed, OnUnused)
adam@0 69 -- TODO: Remove this after beta has gone out
adam@0 70 assert(not OnUsed and not OnUnused, "ACE-80: OnUsed/OnUnused are deprecated. Callbacks are now done to registry.OnUsed and registry.OnUnused")
adam@0 71
adam@0 72 RegisterName = RegisterName or "RegisterCallback"
adam@0 73 UnregisterName = UnregisterName or "UnregisterCallback"
adam@0 74 if UnregisterAllName==nil then -- false is used to indicate "don't want this method"
adam@0 75 UnregisterAllName = "UnregisterAllCallbacks"
adam@0 76 end
adam@0 77
adam@0 78 -- we declare all objects and exported APIs inside this closure to quickly gain access
adam@0 79 -- to e.g. function names, the "target" parameter, etc
adam@0 80
adam@0 81
adam@0 82 -- Create the registry object
adam@0 83 local events = setmetatable({}, meta)
adam@0 84 local registry = { recurse=0, events=events }
adam@0 85
adam@0 86 -- registry:Fire() - fires the given event/message into the registry
adam@0 87 function registry:Fire(eventname, ...)
adam@0 88 if not rawget(events, eventname) or not next(events[eventname]) then return end
adam@0 89 local oldrecurse = registry.recurse
adam@0 90 registry.recurse = oldrecurse + 1
adam@0 91
adam@0 92 Dispatchers[select('#', ...) + 1](events[eventname], eventname, ...)
adam@0 93
adam@0 94 registry.recurse = oldrecurse
adam@0 95
adam@0 96 if registry.insertQueue and oldrecurse==0 then
adam@0 97 -- Something in one of our callbacks wanted to register more callbacks; they got queued
adam@0 98 for eventname,callbacks in pairs(registry.insertQueue) do
adam@0 99 local first = not rawget(events, eventname) or not next(events[eventname]) -- test for empty before. not test for one member after. that one member may have been overwritten.
adam@0 100 for self,func in pairs(callbacks) do
adam@0 101 events[eventname][self] = func
adam@0 102 -- fire OnUsed callback?
adam@0 103 if first and registry.OnUsed then
adam@0 104 registry.OnUsed(registry, target, eventname)
adam@0 105 first = nil
adam@0 106 end
adam@0 107 end
adam@0 108 end
adam@0 109 registry.insertQueue = nil
adam@0 110 end
adam@0 111 end
adam@0 112
adam@0 113 -- Registration of a callback, handles:
adam@0 114 -- self["method"], leads to self["method"](self, ...)
adam@0 115 -- self with function ref, leads to functionref(...)
adam@0 116 -- "addonId" (instead of self) with function ref, leads to functionref(...)
adam@0 117 -- all with an optional arg, which, if present, gets passed as first argument (after self if present)
adam@0 118 target[RegisterName] = function(self, eventname, method, ... --[[actually just a single arg]])
adam@0 119 if type(eventname) ~= "string" then
adam@0 120 error("Usage: "..RegisterName.."(eventname, method[, arg]): 'eventname' - string expected.", 2)
adam@0 121 end
adam@0 122
adam@0 123 method = method or eventname
adam@0 124
adam@0 125 local first = not rawget(events, eventname) or not next(events[eventname]) -- test for empty before. not test for one member after. that one member may have been overwritten.
adam@0 126
adam@0 127 if type(method) ~= "string" and type(method) ~= "function" then
adam@0 128 error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): 'methodname' - string or function expected.", 2)
adam@0 129 end
adam@0 130
adam@0 131 local regfunc
adam@0 132
adam@0 133 if type(method) == "string" then
adam@0 134 -- self["method"] calling style
adam@0 135 if type(self) ~= "table" then
adam@0 136 error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): self was not a table?", 2)
adam@0 137 elseif self==target then
adam@0 138 error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): do not use Library:"..RegisterName.."(), use your own 'self'", 2)
adam@0 139 elseif type(self[method]) ~= "function" then
adam@0 140 error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): 'methodname' - method '"..tostring(method).."' not found on self.", 2)
adam@0 141 end
adam@0 142
adam@0 143 if select("#",...)>=1 then -- this is not the same as testing for arg==nil!
adam@0 144 local arg=select(1,...)
adam@0 145 regfunc = function(...) self[method](self,arg,...) end
adam@0 146 else
adam@0 147 regfunc = function(...) self[method](self,...) end
adam@0 148 end
adam@0 149 else
adam@0 150 -- function ref with self=object or self="addonId" or self=thread
adam@0 151 if type(self)~="table" and type(self)~="string" and type(self)~="thread" then
adam@0 152 error("Usage: "..RegisterName.."(self or \"addonId\", eventname, method): 'self or addonId': table or string or thread expected.", 2)
adam@0 153 end
adam@0 154
adam@0 155 if select("#",...)>=1 then -- this is not the same as testing for arg==nil!
adam@0 156 local arg=select(1,...)
adam@0 157 regfunc = function(...) method(arg,...) end
adam@0 158 else
adam@0 159 regfunc = method
adam@0 160 end
adam@0 161 end
adam@0 162
adam@0 163
adam@0 164 if events[eventname][self] or registry.recurse<1 then
adam@0 165 -- if registry.recurse<1 then
adam@0 166 -- we're overwriting an existing entry, or not currently recursing. just set it.
adam@0 167 events[eventname][self] = regfunc
adam@0 168 -- fire OnUsed callback?
adam@0 169 if registry.OnUsed and first then
adam@0 170 registry.OnUsed(registry, target, eventname)
adam@0 171 end
adam@0 172 else
adam@0 173 -- we're currently processing a callback in this registry, so delay the registration of this new entry!
adam@0 174 -- yes, we're a bit wasteful on garbage, but this is a fringe case, so we're picking low implementation overhead over garbage efficiency
adam@0 175 registry.insertQueue = registry.insertQueue or setmetatable({},meta)
adam@0 176 registry.insertQueue[eventname][self] = regfunc
adam@0 177 end
adam@0 178 end
adam@0 179
adam@0 180 -- Unregister a callback
adam@0 181 target[UnregisterName] = function(self, eventname)
adam@0 182 if not self or self==target then
adam@0 183 error("Usage: "..UnregisterName.."(eventname): bad 'self'", 2)
adam@0 184 end
adam@0 185 if type(eventname) ~= "string" then
adam@0 186 error("Usage: "..UnregisterName.."(eventname): 'eventname' - string expected.", 2)
adam@0 187 end
adam@0 188 if rawget(events, eventname) and events[eventname][self] then
adam@0 189 events[eventname][self] = nil
adam@0 190 -- Fire OnUnused callback?
adam@0 191 if registry.OnUnused and not next(events[eventname]) then
adam@0 192 registry.OnUnused(registry, target, eventname)
adam@0 193 end
adam@0 194 end
adam@0 195 if registry.insertQueue and rawget(registry.insertQueue, eventname) and registry.insertQueue[eventname][self] then
adam@0 196 registry.insertQueue[eventname][self] = nil
adam@0 197 end
adam@0 198 end
adam@0 199
adam@0 200 -- OPTIONAL: Unregister all callbacks for given selfs/addonIds
adam@0 201 if UnregisterAllName then
adam@0 202 target[UnregisterAllName] = function(...)
adam@0 203 if select("#",...)<1 then
adam@0 204 error("Usage: "..UnregisterAllName.."([whatFor]): missing 'self' or \"addonId\" to unregister events for.", 2)
adam@0 205 end
adam@0 206 if select("#",...)==1 and ...==target then
adam@0 207 error("Usage: "..UnregisterAllName.."([whatFor]): supply a meaningful 'self' or \"addonId\"", 2)
adam@0 208 end
adam@0 209
adam@0 210
adam@0 211 for i=1,select("#",...) do
adam@0 212 local self = select(i,...)
adam@0 213 if registry.insertQueue then
adam@0 214 for eventname, callbacks in pairs(registry.insertQueue) do
adam@0 215 if callbacks[self] then
adam@0 216 callbacks[self] = nil
adam@0 217 end
adam@0 218 end
adam@0 219 end
adam@0 220 for eventname, callbacks in pairs(events) do
adam@0 221 if callbacks[self] then
adam@0 222 callbacks[self] = nil
adam@0 223 -- Fire OnUnused callback?
adam@0 224 if registry.OnUnused and not next(callbacks) then
adam@0 225 registry.OnUnused(registry, target, eventname)
adam@0 226 end
adam@0 227 end
adam@0 228 end
adam@0 229 end
adam@0 230 end
adam@0 231 end
adam@0 232
adam@0 233 return registry
adam@0 234 end
adam@0 235
adam@0 236
adam@0 237 -- CallbackHandler purposefully does NOT do explicit embedding. Nor does it
adam@0 238 -- try to upgrade old implicit embeds since the system is selfcontained and
adam@0 239 -- relies on closures to work.
adam@0 240