-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSimpleCore.lua
505 lines (421 loc) · 11 KB
/
SimpleCore.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
local AddonName, Addon = ...
local AddonFrame = CreateFrame("Frame", AddonName .. "AddonFrame", UIParent)
local AddonObject = {}
local DebugEnabled = false
local EventHandlers = {}
local MessageHandlers = {}
local Timers = {}
local Modules = {}
---------------------------------------
-- Utility Functions
---------------------------------------
local function CreateAddonObject(name, base)
local name = name
local base = base or {}
if name then
name = "(" .. name .. ")"
else
name = ""
end
base.name = name
base.enabled = true
base.printHeader = "|cff33ff99" .. AddonName .. name .. "|r: "
base.debugHeader = "|cff33ff99" .. AddonName .. name .. "|cfffffb00" .. "(DEBUG)" .. "|r: "
return setmetatable(base, { __index = AddonObject })
end
local function DispatchMethod(func, ...)
if type(func) == "string" and Addon[func] then
Addon[func](Addon, ...)
elseif type(func) == "function" then
func(...)
end
end
function Addon:DispatchModuleMethod(func, ...)
for name, obj in pairs(Modules) do
if obj[func] and obj.enabled then
obj[func](obj, ...)
end
end
end
function AddonObject:GetFormattedString(header, ...)
if select("#", ...) > 1 then
local success, txt = pcall(string.format, ...)
if success then
return (header .. txt)
else
if DebugEnabled then --INFO: We will only make it here if a nil value was passed so only show if debug mode is enabled
return (self.debugHeader .. string.gsub(txt, "'%?'", string.format("'%s'", "GetFormattedString")))
end
end
else
local txt = ...
if txt then
return (header .. txt)
else
return (self.debugHeader .. "Nil value was passed to GetFormattedString!")
end
end
end
function AddonObject:Print(...)
print(self:GetFormattedString(self.printHeader, ...))
end
---------------------------------------
-- Debug Functions
---------------------------------------
local function DebugPrint(msg) --INFO: If AdiDebug is enabled this function will be overridden with AdiDebug's function
print(msg)
end
function AddonObject:DebugPrint(...)
if DebugEnabled then
DebugPrint(self:GetFormattedString(self.debugHeader, ...))
end
end
function Addon:IsDebugEnabled()
return DebugEnabled
end
function Addon:EnableDebug(enable)
DebugEnabled = enable
end
---------------------------------------
-- Event Registration Functions
---------------------------------------
local function OnEvent(frame, event, ...)
local handlers = EventHandlers[event]
if handlers then
for obj, func in pairs(handlers) do
if type(func) == "string" then
if type(obj[func]) == "function" then
obj[func](obj, event, ...)
end
else
func(event, ...)
end
end
end
end
AddonFrame:SetScript("OnEvent", OnEvent)
function AddonObject:RegisterEvent(eventName, handler)
if not handler then
handler = eventName
end
if type(eventName) == "table" then
for _, name in pairs(eventName) do
if not EventHandlers[name] then
EventHandlers[name] = {}
end
AddonFrame:RegisterEvent(name)
EventHandlers[name][self] = handler
end
else
if not EventHandlers[eventName] then
EventHandlers[eventName] = {}
end
AddonFrame:RegisterEvent(eventName)
EventHandlers[eventName][self] = handler
end
end
function AddonObject:UnregisterEvent(eventName)
local obj = EventHandlers[eventName]
if obj then
obj[self] = nil
if not next(obj) then
EventHandlers[eventName] = nil
AddonFrame:UnregisterEvent(eventName)
end
end
end
function AddonObject:UnregisterAllEvents()
for eventName, obj in pairs(EventHandlers) do
obj[self] = nil
if not next(obj) then
EventHandlers[eventName] = nil
AddonFrame:UnregisterEvent(eventName)
end
end
end
--------------------------------------
-- Message Event Functions
---------------------------------------
function AddonObject:DispatchMessage(messageName, ...)
local handlers = MessageHandlers[messageName]
if handlers then
for obj, func in pairs(handlers) do
if type(func) == "string" then
if type(obj[func]) == "function" then
obj[func](obj, messageName, ...)
end
else
func(messageName, ...)
end
end
end
end
function AddonObject:RegisterMessage(messageName, handler)
if not handler then
handler = messageName
end
if type(messageName) == "table" then
for _, name in pairs(messageName) do
if not MessageHandlers[name] then
MessageHandlers[name] = {}
end
MessageHandlers[name][self] = handler
end
else
if not MessageHandlers[messageName] then
MessageHandlers[messageName] = {}
end
MessageHandlers[messageName][self] = handler
end
end
function AddonObject:UnregisterMessage(messageName)
local obj = MessageHandlers[messageName]
if obj then
obj[self] = nil
if not next(obj) then
MessageHandlers[messageName] = nil
end
end
end
function AddonObject:UnregisterAllMessages()
for messageName, obj in pairs(MessageHandlers) do
obj[self] = nil
if not next(obj) then
MessageHandlers[messageName] = nil
end
end
end
--------------------------------------
-- Timer Functions
---------------------------------------
local function StartTimer(object, delay, func, repeating, name)
local timer = {}
local name = name or tostring(timer) -- NOTE: If you are going to create more than one timer you should really name it
if delay < 0.01 then
delay = 0.01 -- INFO: The lowest time C_Timer API allows.
end
timer.object = object
timer.delay = delay or 60
timer.repeating = repeating
timer.func = func or "OnTimer"
timer.name = name
timer.paused = false
Timers[name] = timer
timer.callback = function()
if not timer.stopped and not timer.paused then
timer.object[timer.func](timer.object, timer.name)
--if timer.repeating and not timer.stopped then
if timer.repeating and not timer.stopped and not timer.paused then
C_Timer.After(timer.delay, timer.callback)
else
Timers[name] = nil
end
end
end
C_Timer.After(delay, timer.callback)
return name
end
function AddonObject:StartTimer(delay, func, name)
return StartTimer(self, delay, func, false, name)
end
function AddonObject:StartRepeatingTimer(delay, func, name)
return StartTimer(self, delay, func, true, name)
end
function AddonObject:StopTimer(name)
local timer = Timers[name]
if timer then
timer.stopped = true
Timers[name] = nil
DispatchMethod("OnTimerStop", name)
end
end
function AddonObject:StopAllTimers()
for name, _ in pairs(Timers) do
self:StopTimer(name)
end
wipe(Timers)
DispatchMethod("OnStopAllTimers")
end
function AddonObject:PauseTimer(name)
local timer = Timers[name]
if timer then
timer.paused = true
DispatchMethod("OnTimerPause", name)
end
end
function AddonObject:PauseAllTimers()
for name, _ in pairs(Timers) do
self:PauseTimer(name)
end
DispatchMethod("OnPauseAllTimers")
end
function AddonObject:ResumeTimer(name)
local timer = Timers[name]
if timer then
timer.paused = false
timer.callback()
DispatchMethod("OnTimerResume", name)
end
end
function AddonObject:ResumeAllTimers()
for name, _ in pairs(Timers) do
self:ResumeTimer(name)
end
DispatchMethod("OnResumeAllTimers")
end
function AddonObject:SetTimerDelay(name, delay)
Timers[name].delay = delay
end
---------------------------------------
-- Slash Command Functions
---------------------------------------
local function HandleDebugToggle(msg)
local command, enable = strsplit(" ", msg)
if command == "debug" then
if enable == "enable" then
Addon:EnableDebug(true)
Addon:DispatchModuleMethod("EnableDebug", true)
Addon:DebugPrint("Enabling debug mode!")
else
Addon:DebugPrint("Disabling debug mode!")
Addon:EnableDebug(false)
Addon:DispatchModuleMethod("EnableDebug", false)
end
end
end
function Addon:RegisterSlashCommand(name, func)
if SlashCmdList[name] then
self:DebugPrint("Error: Slash command " .. command .. " already exists!")
else
_G["SLASH_".. name:upper().."1"] = "/" .. name
if type(func) == "string" then
--INFO: Register a custom function to handle slash commands
SlashCmdList[name:upper()] = function(msg)
HandleDebugToggle(msg)
DispatchMethod(func, strsplit(" ", msg))
end
else
SlashCmdList[name:upper()] = function(msg)
HandleDebugToggle(msg)
DispatchMethod("OnSlashCommand", strsplit(" ", msg))
end
end
end
end
---------------------------------------
-- SavedVariables(Database) Functions
---------------------------------------
local function CopyDefaults(src, dest)
for k, v in pairs(src) do
if type(v) == "table" then
if not rawget(dest, k) then rawset(dest, k, {}) end
if type(dest[k]) == "table" then
CopyDefaults(dest[k], v)
end
else
if rawget(dest, k) == nil then
rawset(dest, k, v)
end
end
end
end
function Addon:InitializeDB(defaults)
local name = AddonName .. "DB"
local db = {}
if defaults then
CopyDefaults(defaults, db)
end
_G[name] = db
self.db = _G[name]
return self.db
end
---------------------------------------
-- Defer Function Calls
---------------------------------------
local DeferFrame = CreateFrame("Frame", AddonName .. "DeferFrame", UIParent)
DeferFrame.Queue = {}
function AddonObject:DeferFunctionCall(func, ...)
local args = { ... }
if InCombatLockdown() then
DeferFrame.Queue[func] = { ... }
return true
else
DispatchMethod(func, ...)
return false
end
end
DeferFrame:RegisterEvent("PLAYER_REGEN_ENABLED")
DeferFrame:SetScript("OnEvent", function(self, event, ...)
for func, args in pairs(DeferFrame.Queue) do
DispatchMethod(func, unpack(args))
end
table.wipe(DeferFrame.Queue)
end)
---------------------------------------
-- Module System
---------------------------------------
function Addon:NewModule(name)
local obj = CreateAddonObject(name, nil)
Modules[name] = obj
return obj
end
function Addon:IsModuleEnabled(name)
if Modules[name] then
return Modules[name].enabled
end
return false
end
function Addon:EnableModule(name)
local obj = Modules[name]
if obj then
if obj["OnEnable"] then
obj:OnEnable()
end
obj.enabled = true
else
self:DebugPrint("Module, %s, is already enabled or not loaded!", name)
end
end
function Addon:DisableModule(name)
local obj = Modules[name]
if obj then
if obj["OnDisable"] then
obj:OnDisable()
end
--FIXME: Timers might keep going after disabling.
obj:UnregisterAllEvents()
obj.enabled = false
else
self:DebugPrint("Module, %s, is already disabled or not loaded!", name)
end
end
function Addon:IterateModules()
return Modules
end
---------------------------------------
-- Initialization Functions
---------------------------------------
function Addon:PLAYER_LOGIN()
if self["OnSlashCommand"] then
self:RegisterSlashCommand(AddonName)
end
DispatchMethod("OnEnable")
self:DispatchModuleMethod("OnEnable")
end
function Addon:ADDON_LOADED(event, ...)
if AdiDebug then
DebugPrint = AdiDebug:GetSink(AddonName)
end
if ... == AddonName then
DispatchMethod("OnInitialize")
self:DispatchModuleMethod("OnInitialize")
if IsLoggedIn() then
self:PLAYER_LOGIN()
end
else
DispatchMethod("OnAddonLoaded", ...)
end
end
Addon = CreateAddonObject(nil, Addon)
Addon:RegisterEvent("PLAYER_LOGIN")
Addon:RegisterEvent("ADDON_LOADED")