Mercurial > wow > hansgar_and_franzok_assist

annotate Libs/AceEvent-3.0/AceEvent-3.0.lua @ 58:0682d738499b v8.0.1.058

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- 8.0.1 Update.
author Tercio
date Fri, 20 Jul 2018 19:04:12 -0300
parents dbf04157d63e
children
rev   line source
Tercio@23 1 --- AceEvent-3.0 provides event registration and secure dispatching.
Tercio@23 2 -- All dispatching is done using **CallbackHandler-1.0**. AceEvent is a simple wrapper around
Tercio@23 3 -- CallbackHandler, and dispatches all game events or addon message to the registrees.
Tercio@23 4 --
Tercio@23 5 -- **AceEvent-3.0** can be embeded into your addon, either explicitly by calling AceEvent:Embed(MyAddon) or by
Tercio@23 6 -- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object
Tercio@23 7 -- and can be accessed directly, without having to explicitly call AceEvent itself.\\
Tercio@23 8 -- It is recommended to embed AceEvent, otherwise you'll have to specify a custom `self` on all calls you
Tercio@23 9 -- make into AceEvent.
Tercio@23 10 -- @class file
Tercio@23 11 -- @name AceEvent-3.0
Tercio@51 12 -- @release $Id: AceEvent-3.0.lua 1161 2017-08-12 14:30:16Z funkydude $
Tercio@51 13 local CallbackHandler = LibStub("CallbackHandler-1.0")
Tercio@51 14
Tercio@51 15 local MAJOR, MINOR = "AceEvent-3.0", 4
Tercio@23 16 local AceEvent = LibStub:NewLibrary(MAJOR, MINOR)
Tercio@23 17
Tercio@23 18 if not AceEvent then return end
Tercio@23 19
Tercio@23 20 -- Lua APIs
Tercio@23 21 local pairs = pairs
Tercio@23 22
Tercio@23 23 AceEvent.frame = AceEvent.frame or CreateFrame("Frame", "AceEvent30Frame") -- our event frame
Tercio@23 24 AceEvent.embeds = AceEvent.embeds or {} -- what objects embed this lib
Tercio@23 25
Tercio@23 26 -- APIs and registry for blizzard events, using CallbackHandler lib
Tercio@23 27 if not AceEvent.events then
Tercio@23 28 AceEvent.events = CallbackHandler:New(AceEvent,
Tercio@23 29 "RegisterEvent", "UnregisterEvent", "UnregisterAllEvents")
Tercio@23 30 end
Tercio@23 31
Tercio@23 32 function AceEvent.events:OnUsed(target, eventname)
Tercio@23 33 AceEvent.frame:RegisterEvent(eventname)
Tercio@23 34 end
Tercio@23 35
Tercio@23 36 function AceEvent.events:OnUnused(target, eventname)
Tercio@23 37 AceEvent.frame:UnregisterEvent(eventname)
Tercio@23 38 end
Tercio@23 39
Tercio@23 40
Tercio@23 41 -- APIs and registry for IPC messages, using CallbackHandler lib
Tercio@23 42 if not AceEvent.messages then
Tercio@23 43 AceEvent.messages = CallbackHandler:New(AceEvent,
Tercio@23 44 "RegisterMessage", "UnregisterMessage", "UnregisterAllMessages"
Tercio@23 45 )
Tercio@23 46 AceEvent.SendMessage = AceEvent.messages.Fire
Tercio@23 47 end
Tercio@23 48
Tercio@23 49 --- embedding and embed handling
Tercio@23 50 local mixins = {
Tercio@23 51 "RegisterEvent", "UnregisterEvent",
Tercio@23 52 "RegisterMessage", "UnregisterMessage",
Tercio@23 53 "SendMessage",
Tercio@23 54 "UnregisterAllEvents", "UnregisterAllMessages",
Tercio@23 55 }
Tercio@23 56
Tercio@23 57 --- Register for a Blizzard Event.
Tercio@23 58 -- The callback will be called with the optional `arg` as the first argument (if supplied), and the event name as the second (or first, if no arg was supplied)
Tercio@23 59 -- Any arguments to the event will be passed on after that.
Tercio@23 60 -- @name AceEvent:RegisterEvent
Tercio@23 61 -- @class function
Tercio@23 62 -- @paramsig event[, callback [, arg]]
Tercio@23 63 -- @param event The event to register for
Tercio@23 64 -- @param callback The callback function to call when the event is triggered (funcref or method, defaults to a method with the event name)
Tercio@23 65 -- @param arg An optional argument to pass to the callback function
Tercio@23 66
Tercio@23 67 --- Unregister an event.
Tercio@23 68 -- @name AceEvent:UnregisterEvent
Tercio@23 69 -- @class function
Tercio@23 70 -- @paramsig event
Tercio@23 71 -- @param event The event to unregister
Tercio@23 72
Tercio@23 73 --- Register for a custom AceEvent-internal message.
Tercio@23 74 -- The callback will be called with the optional `arg` as the first argument (if supplied), and the event name as the second (or first, if no arg was supplied)
Tercio@23 75 -- Any arguments to the event will be passed on after that.
Tercio@23 76 -- @name AceEvent:RegisterMessage
Tercio@23 77 -- @class function
Tercio@23 78 -- @paramsig message[, callback [, arg]]
Tercio@23 79 -- @param message The message to register for
Tercio@23 80 -- @param callback The callback function to call when the message is triggered (funcref or method, defaults to a method with the event name)
Tercio@23 81 -- @param arg An optional argument to pass to the callback function
Tercio@23 82
Tercio@23 83 --- Unregister a message
Tercio@23 84 -- @name AceEvent:UnregisterMessage
Tercio@23 85 -- @class function
Tercio@23 86 -- @paramsig message
Tercio@23 87 -- @param message The message to unregister
Tercio@23 88
Tercio@23 89 --- Send a message over the AceEvent-3.0 internal message system to other addons registered for this message.
Tercio@23 90 -- @name AceEvent:SendMessage
Tercio@23 91 -- @class function
Tercio@23 92 -- @paramsig message, ...
Tercio@23 93 -- @param message The message to send
Tercio@23 94 -- @param ... Any arguments to the message
Tercio@23 95
Tercio@23 96
Tercio@23 97 -- Embeds AceEvent into the target object making the functions from the mixins list available on target:..
Tercio@23 98 -- @param target target object to embed AceEvent in
Tercio@23 99 function AceEvent:Embed(target)
Tercio@23 100 for k, v in pairs(mixins) do
Tercio@23 101 target[v] = self[v]
Tercio@23 102 end
Tercio@23 103 self.embeds[target] = true
Tercio@23 104 return target
Tercio@23 105 end
Tercio@23 106
Tercio@23 107 -- AceEvent:OnEmbedDisable( target )
Tercio@23 108 -- target (object) - target object that is being disabled
Tercio@23 109 --
Tercio@23 110 -- Unregister all events messages etc when the target disables.
Tercio@23 111 -- this method should be called by the target manually or by an addon framework
Tercio@23 112 function AceEvent:OnEmbedDisable(target)
Tercio@23 113 target:UnregisterAllEvents()
Tercio@23 114 target:UnregisterAllMessages()
Tercio@23 115 end
Tercio@23 116
Tercio@23 117 -- Script to fire blizzard events into the event listeners
Tercio@23 118 local events = AceEvent.events
Tercio@23 119 AceEvent.frame:SetScript("OnEvent", function(this, event, ...)
Tercio@23 120 events:Fire(event, ...)
Tercio@23 121 end)
Tercio@23 122
Tercio@23 123 --- Finally: upgrade our old embeds
Tercio@23 124 for target, v in pairs(AceEvent.embeds) do
Tercio@23 125 AceEvent:Embed(target)
Tercio@23 126 end