annotate ReAction.lua @ 43:dc898780fea8

handle profile resets
author Flick <flickerstreak@gmail.com>
date Thu, 03 Apr 2008 23:15:32 +0000
parents e0d8074a5bc7
children aa0b7fd68462
rev   line source
flickerstreak@28 1 -- ReAction.lua
flickerstreak@28 2 -- See modules/ReAction_ModuleTemplate for Module API listing
flickerstreak@28 3 -- See Bar.lua for Bar object listing
flickerstreak@27 4
flickerstreak@27 5 ------ CORE ------
flickerstreak@30 6 local ReAction = LibStub("AceAddon-3.0"):NewAddon( "ReAction",
flickerstreak@33 7 "AceConsole-3.0",
flickerstreak@33 8 "AceEvent-3.0"
flickerstreak@30 9 )
flickerstreak@33 10 ReAction.version = GetAddOnMetadata("ReAction","Version")
flickerstreak@33 11 ReAction.revision = tonumber(("$Revision$"):match("%d+"))
flickerstreak@27 12
flickerstreak@28 13 ------ GLOBALS ------
flickerstreak@28 14 _G["ReAction"] = ReAction
flickerstreak@27 15
flickerstreak@28 16 ------ DEBUGGING ------
flickerstreak@25 17 ReAction.debug = true
flickerstreak@36 18 local dbprint
flickerstreak@25 19 if ReAction.debug then
flickerstreak@36 20 dbprint = function(msg)
flickerstreak@25 21 DEFAULT_CHAT_FRAME:AddMessage(msg)
flickerstreak@25 22 end
flickerstreak@36 23 --seterrorhandler(dbprint)
flickerstreak@25 24 else
flickerstreak@36 25 dbprint = function() end
flickerstreak@25 26 end
flickerstreak@36 27 ReAction.dbprint = dbprint
flickerstreak@25 28
flickerstreak@33 29 ------ LIBRARIES ------
flickerstreak@33 30 local L = LibStub("AceLocale-3.0"):GetLocale("ReAction")
flickerstreak@33 31 ReAction.L = L
flickerstreak@33 32
flickerstreak@28 33 ------ PRIVATE ------
flickerstreak@30 34 local SelectBar, DestroyBar, InitializeBars, TearDownBars, DeepCopy, SafeCall, CheckMethod, SlashHandler
flickerstreak@28 35 do
flickerstreak@28 36 local pcall = pcall
flickerstreak@28 37 local geterrorhandler = geterrorhandler
flickerstreak@28 38
flickerstreak@28 39 SelectBar = function(x)
flickerstreak@28 40 local bar, name
flickerstreak@28 41 if type(x) == "string" then
flickerstreak@28 42 name = x
flickerstreak@28 43 bar = ReAction:GetBar(name)
flickerstreak@28 44 elseif ReAction.Bar:IsInstance(x) then
flickerstreak@28 45 bar = x
flickerstreak@28 46 for k,v in pairs(ReAction.bars) do
flickerstreak@28 47 if v == bar then
flickerstreak@28 48 name = k
flickerstreak@28 49 end
flickerstreak@28 50 end
flickerstreak@28 51 else
flickerstreak@28 52 error("bad argument to SelectBar")
flickerstreak@28 53 end
flickerstreak@28 54 return bar, name
flickerstreak@28 55 end
flickerstreak@28 56
flickerstreak@28 57 DestroyBar = function(x)
flickerstreak@28 58 local bar, name = SelectBar(x)
flickerstreak@28 59 if name and bar then
flickerstreak@28 60 ReAction.bars[name] = nil
flickerstreak@28 61 ReAction:CallMethodOnAllModules("RemoveFromBar", bar)
flickerstreak@28 62 bar:Destroy()
flickerstreak@28 63 end
flickerstreak@28 64 end
flickerstreak@28 65
flickerstreak@28 66 InitializeBars = function ()
flickerstreak@28 67 if not(ReAction.inited) then
flickerstreak@28 68 for name, config in pairs(ReAction.db.profile.bars) do
flickerstreak@28 69 if config then
flickerstreak@28 70 ReAction:CreateBar(name, config)
flickerstreak@28 71 end
flickerstreak@28 72 end
flickerstreak@28 73 ReAction:CallMethodOnAllBars("ApplyAnchor") -- re-anchor in the case of oddball ordering
flickerstreak@28 74 ReAction.inited = true
flickerstreak@28 75 end
flickerstreak@28 76 end
flickerstreak@28 77
flickerstreak@28 78 TearDownBars = function()
flickerstreak@28 79 for name, bar in pairs(ReAction.bars) do
flickerstreak@28 80 if bar then
flickerstreak@28 81 ReAction.bars[name] = DestroyBar(bar)
flickerstreak@28 82 end
flickerstreak@28 83 end
flickerstreak@28 84 ReAction.inited = false
flickerstreak@28 85 end
flickerstreak@28 86
flickerstreak@28 87 DeepCopy = function(x)
flickerstreak@28 88 if type(x) ~= "table" then
flickerstreak@28 89 return x
flickerstreak@28 90 end
flickerstreak@28 91 local r = {}
flickerstreak@28 92 for k,v in pairs(x) do
flickerstreak@28 93 r[k] = DeepCopy(v)
flickerstreak@28 94 end
flickerstreak@28 95 return r
flickerstreak@28 96 end
flickerstreak@28 97
flickerstreak@28 98 SafeCall = function(f, ...)
flickerstreak@28 99 if f then
flickerstreak@28 100 local success, err = pcall(f,...)
flickerstreak@28 101 if not success then
flickerstreak@28 102 geterrorhandler()(err)
flickerstreak@28 103 end
flickerstreak@28 104 end
flickerstreak@28 105 end
flickerstreak@28 106
flickerstreak@28 107 CheckMethod = function(m)
flickerstreak@28 108 if type(m) == "function" then
flickerstreak@28 109 return m
flickerstreak@28 110 end
flickerstreak@28 111 if type(m) ~= "string" then
flickerstreak@28 112 error("Invalid method")
flickerstreak@28 113 end
flickerstreak@28 114 end
flickerstreak@30 115
flickerstreak@30 116 SlashHandler = function(option)
flickerstreak@30 117 if option == "config" then
flickerstreak@38 118 ReAction:ShowConfig()
flickerstreak@30 119 elseif option == "unlock" then
flickerstreak@33 120 ReAction:SetConfigMode(true)
flickerstreak@30 121 elseif option == "lock" then
flickerstreak@33 122 ReAction:SetConfigMode(false)
flickerstreak@30 123 else
flickerstreak@36 124 ReAction:Print(("%3.1f.%d"):format(ReAction.version,ReAction.revision))
flickerstreak@30 125 ReAction:Print("/reaction config")
flickerstreak@30 126 ReAction:Print("/reaction unlock")
flickerstreak@30 127 ReAction:Print("/reaction lock")
flickerstreak@30 128 end
flickerstreak@30 129 end
flickerstreak@28 130 end
flickerstreak@28 131
flickerstreak@28 132
flickerstreak@28 133 ------ HANDLERS ------
flickerstreak@28 134 function ReAction:OnInitialize()
flickerstreak@28 135 self.db = LibStub("AceDB-3.0"):New("ReAction_DB",
flickerstreak@28 136 {
flickerstreak@28 137 profile = {
flickerstreak@28 138 bars = { },
flickerstreak@28 139 defaultBar = { }
flickerstreak@28 140 }
flickerstreak@28 141 }
flickerstreak@28 142 -- default profile is character-specific
flickerstreak@28 143 )
flickerstreak@28 144 self.db.RegisterCallback(self,"OnProfileChanged")
flickerstreak@43 145 self.db.RegisterCallback(self,"OnProfileReset","OnProfileChanged")
flickerstreak@30 146 self.callbacks = LibStub("CallbackHandler-1.0"):New(self)
flickerstreak@30 147 self:RegisterChatCommand("reaction", SlashHandler)
flickerstreak@30 148 self:RegisterChatCommand("rxn", SlashHandler)
flickerstreak@33 149 self:RegisterEvent("PLAYER_REGEN_DISABLED")
flickerstreak@28 150
flickerstreak@28 151 self.bars = {}
flickerstreak@28 152 end
flickerstreak@28 153
flickerstreak@28 154 function ReAction:OnEnable()
flickerstreak@28 155 InitializeBars()
flickerstreak@28 156 end
flickerstreak@28 157
flickerstreak@28 158 function ReAction:OnDisable()
flickerstreak@28 159 TearDownBars()
flickerstreak@28 160 end
flickerstreak@28 161
flickerstreak@28 162 function ReAction:OnProfileChanged()
flickerstreak@33 163 TearDownBars()
flickerstreak@33 164 InitializeBars()
flickerstreak@28 165 end
flickerstreak@28 166
flickerstreak@28 167 function ReAction:OnModuleEnable(module)
flickerstreak@28 168 if module.ApplyToBar then
flickerstreak@28 169 for _, b in pairs(bars) do
flickerstreak@28 170 if b then
flickerstreak@28 171 module:ApplyToBar(b)
flickerstreak@28 172 end
flickerstreak@28 173 end
flickerstreak@28 174 end
flickerstreak@28 175 end
flickerstreak@28 176
flickerstreak@28 177 function ReAction:OnModuleDisable(module)
flickerstreak@28 178 if module.RemoveFromBar then
flickerstreak@28 179 for _, b in pairs(bars) do
flickerstreak@28 180 if b then
flickerstreak@28 181 module:RemoveFromBar(b)
flickerstreak@28 182 end
flickerstreak@28 183 end
flickerstreak@28 184 end
flickerstreak@28 185 end
flickerstreak@28 186
flickerstreak@33 187 function ReAction:PLAYER_REGEN_DISABLED()
flickerstreak@33 188 if self.configMode == true then
flickerstreak@33 189 UIErrorsFrame:AddMessage(L["ReAction config mode disabled during combat."])
flickerstreak@33 190 self:SetConfigMode(false)
flickerstreak@33 191 end
flickerstreak@33 192 end
flickerstreak@33 193
flickerstreak@33 194
flickerstreak@28 195
flickerstreak@28 196 ------ API ------
flickerstreak@28 197 function ReAction:CallMethodOnAllModules(method, ...)
flickerstreak@28 198 local m = CheckMethod(method)
flickerstreak@28 199 for _, x in self:IterateModules() do
flickerstreak@28 200 if x then
flickerstreak@28 201 SafeCall(m or x[method], x, ...)
flickerstreak@28 202 end
flickerstreak@28 203 end
flickerstreak@28 204 end
flickerstreak@28 205
flickerstreak@28 206 function ReAction:CallMethodOnAllBars(method,...)
flickerstreak@28 207 local m = CheckMethod(method)
flickerstreak@28 208 for _, x in pairs(self.bars) do
flickerstreak@28 209 if x then
flickerstreak@28 210 SafeCall(m or x[method], x, ...)
flickerstreak@28 211 end
flickerstreak@28 212 end
flickerstreak@28 213 end
flickerstreak@28 214
flickerstreak@38 215 function ReAction:CallModuleMethod(modulename, method, ...)
flickerstreak@38 216 local m = self:GetModule(modulename,true)
flickerstreak@38 217 if not m then
flickerstreak@38 218 LoadAddOn(("ReAction_%s"):format(modulename))
flickerstreak@38 219 m = self:GetModule(modulename,true)
flickerstreak@43 220 if m then
flickerstreak@43 221 dbprint(("succesfully loaded LOD module: %s"):format(modulename))
flickerstreak@43 222 end
flickerstreak@38 223 end
flickerstreak@38 224 if m then
flickerstreak@38 225 if type(m) == "table" and type(m[method]) == "function" then
flickerstreak@38 226 m[method](m,...)
flickerstreak@38 227 else
flickerstreak@38 228 dbprint(("Bad call '%s' to %s module"):format(tostring(method),modulename));
flickerstreak@38 229 end
flickerstreak@38 230 else
flickerstreak@38 231 self:Print(("Module '%s' not found"):format(tostring(modulename)))
flickerstreak@38 232 end
flickerstreak@38 233 end
flickerstreak@38 234
flickerstreak@38 235
flickerstreak@28 236 function ReAction:CreateBar(name, defaultConfig, prefix)
flickerstreak@28 237 local profile = self.db.profile
flickerstreak@28 238 defaultConfig = defaultConfig or profile.defaultBar
flickerstreak@28 239 prefix = prefix or L["Bar "]
flickerstreak@28 240 if not name then
flickerstreak@28 241 i = 1
flickerstreak@28 242 repeat
flickerstreak@28 243 name = prefix..i
flickerstreak@28 244 i = i + 1
flickerstreak@28 245 until self.bars[name] == nil
flickerstreak@28 246 end
flickerstreak@28 247 profile.bars[name] = profile.bars[name] or DeepCopy(defaultConfig)
flickerstreak@28 248 local bar = self.Bar:new( name, profile.bars[name] ) -- ReAction.Bar defined in Bar.lua
flickerstreak@28 249 self:CallMethodOnAllModules("ApplyToBar", bar)
flickerstreak@28 250 self.bars[name] = bar
flickerstreak@30 251 self.callbacks:Fire("OnCreateBar", bar)
flickerstreak@33 252 if self.configMode then
flickerstreak@33 253 bar:ShowControls(true)
flickerstreak@33 254 end
flickerstreak@33 255
flickerstreak@28 256 return bar
flickerstreak@28 257 end
flickerstreak@28 258
flickerstreak@28 259 function ReAction:EraseBar(x)
flickerstreak@28 260 local bar, name = SelectBar(x)
flickerstreak@28 261 if name and bar then
flickerstreak@28 262 DestroyBar(bar)
flickerstreak@28 263 self.db.profile.bars[name] = nil
flickerstreak@28 264 self:CallMethodOnAllModules("EraseBarConfig", name)
flickerstreak@30 265 self.callbacks:Fire("OnEraseBar",name)
flickerstreak@28 266 end
flickerstreak@28 267 end
flickerstreak@28 268
flickerstreak@28 269 function ReAction:GetBar(name)
flickerstreak@28 270 return self.bars[name]
flickerstreak@28 271 end
flickerstreak@28 272
flickerstreak@28 273 function ReAction:RenameBar(x, newname)
flickerstreak@28 274 local bar, name = SelectBar(x)
flickerstreak@28 275 if bar and name and newname then
flickerstreak@28 276 if self.bars[newname] then
flickerstreak@28 277 error(L["ReAction: name already in use"])
flickerstreak@28 278 end
flickerstreak@28 279 self.bars[newname] = self.bars[name]
flickerstreak@28 280 self.bars[name] = nil
flickerstreak@39 281 bar:SetName(newname or "")
flickerstreak@28 282 local cfg = self.db.profile.bars
flickerstreak@28 283 cfg[newname], cfg[name] = cfg[name], nil
flickerstreak@28 284 self:CallMethodOnAllModules("RenameBarConfig", name, newname)
flickerstreak@30 285 self.callbacks:Fire("OnRenameBar", name, newname)
flickerstreak@28 286 end
flickerstreak@28 287 end
flickerstreak@28 288
flickerstreak@30 289 ReAction.options = {}
flickerstreak@30 290 -- See modules/ReAction_ConfigUI for valid options contexts.
flickerstreak@30 291 function ReAction:RegisterOptions(context, module, opts)
flickerstreak@30 292 if module == nil or context == nil then
flickerstreak@30 293 error("ReAction:RegisterOptions requires a module object and context ID")
flickerstreak@30 294 end
flickerstreak@30 295 if not self.options[context] then
flickerstreak@30 296 self.options[context] = {}
flickerstreak@30 297 end
flickerstreak@30 298 self.options[context][module] = opts
flickerstreak@30 299 self.callbacks:Fire("OnOptionsRegistered", context, module, opts)
flickerstreak@30 300 end
flickerstreak@28 301
flickerstreak@30 302 function ReAction:GetOptions(context)
flickerstreak@30 303 if context then
flickerstreak@30 304 if not self.options[context] then
flickerstreak@30 305 self.options[context] = { }
flickerstreak@30 306 end
flickerstreak@30 307 return self.options[context]
flickerstreak@30 308 end
flickerstreak@30 309 end
flickerstreak@30 310
flickerstreak@30 311 function ReAction:GetOptionContextList()
flickerstreak@30 312 local c = {}
flickerstreak@30 313 for k in self.options do
flickerstreak@30 314 tinsert(c,k)
flickerstreak@30 315 end
flickerstreak@30 316 return c
flickerstreak@30 317 end
flickerstreak@30 318
flickerstreak@30 319 function ReAction:RefreshOptions()
flickerstreak@30 320 self.callbacks:Fire("OnOptionsRefreshed")
flickerstreak@30 321 end
flickerstreak@33 322
flickerstreak@33 323 function ReAction:SetConfigMode( mode )
flickerstreak@33 324 self:CallMethodOnAllBars("ShowControls",mode)
flickerstreak@33 325 self:CallMethodOnAllModules("ApplyConfigMode",mode,self.bars)
flickerstreak@33 326 self.configMode = mode
flickerstreak@33 327 end
flickerstreak@38 328
flickerstreak@38 329 function ReAction:ShowConfig()
flickerstreak@38 330 self:CallModuleMethod("ConfigUI","OpenConfig")
flickerstreak@38 331 end
flickerstreak@38 332