annotate classes/Bar.lua @ 175:df68b5a40490

Remove ReAction global in favor of built in addon table (drycoded)
author Flick <flickerstreak@gmail.com>
date Wed, 20 Oct 2010 17:11:50 +0000
parents fe0c7be6f6ef
children d32c65d94009
rev   line source
flickerstreak@175 1 local addonName, addonTable = ...
flickerstreak@175 2 local ReAction = addonTable.ReAction
flickerstreak@122 3 local L = ReAction.L
flickerstreak@122 4 local _G = _G
flickerstreak@122 5 local CreateFrame = CreateFrame
flickerstreak@122 6 local floor = math.floor
flickerstreak@122 7 local fmod = math.fmod
flickerstreak@122 8 local format = string.format
flickerstreak@122 9
flickerstreak@171 10 local LKB = LibStub("LibKeyBound-1.0")
flickerstreak@171 11 local LSG = LibStub("LibShowGrid-1.0")
flickerstreak@147 12
flickerstreak@155 13 ---- Secure snippets ----
flickerstreak@155 14 local _reaction_init =
flickerstreak@155 15 [[
flickerstreak@155 16 anchorKeys = newtable("point","relPoint","x","y")
flickerstreak@155 17
flickerstreak@155 18 state = nil
flickerstreak@155 19 set_state = nil
flickerstreak@155 20 state_override = nil
flickerstreak@156 21 unit_exists = nil
flickerstreak@155 22
flickerstreak@155 23 showAll = false
flickerstreak@155 24 hidden = false
flickerstreak@155 25
flickerstreak@155 26 defaultAlpha = 1.0
flickerstreak@155 27 defaultScale = 1.0
flickerstreak@155 28 defaultAnchor = newtable()
flickerstreak@155 29
flickerstreak@155 30 activeStates = newtable()
flickerstreak@155 31 settings = newtable()
flickerstreak@155 32 extensions = newtable()
flickerstreak@155 33 ]]
flickerstreak@155 34
flickerstreak@155 35 local _reaction_refresh =
flickerstreak@155 36 [[
flickerstreak@155 37 local oldState = state
flickerstreak@155 38 state = state_override or set_state or state
flickerstreak@155 39
flickerstreak@156 40 local hide = nil
flickerstreak@155 41 if state then
flickerstreak@155 42 local settings = settings[state]
flickerstreak@155 43 if settings then
flickerstreak@155 44 -- show/hide
flickerstreak@156 45 hide = settings.hide
flickerstreak@155 46 -- re-anchor
flickerstreak@155 47 local old_anchor = activeStates.anchor
flickerstreak@155 48 activeStates.anchor = settings.anchorEnable and state
flickerstreak@155 49 if old_anchor ~= activeStates.anchor or not set_state then
flickerstreak@155 50 if activeStates.anchor then
flickerstreak@155 51 if settings.anchorPoint then
flickerstreak@155 52 self:ClearAllPoints()
flickerstreak@155 53 local f = self:GetAttribute("frameref-anchor-"..state)
flickerstreak@155 54 if f then
flickerstreak@155 55 self:SetPoint(settings.anchorPoint, f, settings.anchorRelPoint, settings.anchorX, settings.anchorY)
flickerstreak@155 56 end
flickerstreak@155 57 end
flickerstreak@155 58 elseif defaultAnchor.point then
flickerstreak@155 59 self:ClearAllPoints()
flickerstreak@155 60 self:SetPoint(defaultAnchor.point, defaultAnchor.frame,
flickerstreak@155 61 defaultAnchor.relPoint, defaultAnchor.x, defaultAnchor.y)
flickerstreak@155 62 end
flickerstreak@155 63 end
flickerstreak@155 64 -- re-scale
flickerstreak@155 65 local old_scale = activeStates.scale
flickerstreak@155 66 activeStates.scale = settings.enableScale and state
flickerstreak@155 67 if old_scale ~= activeStates.scale or not set_state then
flickerstreak@155 68 self:SetScale(activeStates.scale and settings.scale or defaultScale)
flickerstreak@155 69 end
flickerstreak@155 70 -- alpha
flickerstreak@155 71 local old_alpha = activeStates.alpha
flickerstreak@155 72 activeStates.alpha = settings.enableAlpha and state
flickerstreak@155 73 if old_alpha ~= activeStates.alpha or not set_state then
flickerstreak@155 74 self:SetAlpha(activeStates.alpha and settings.alpha or defaultAlpha)
flickerstreak@155 75 end
flickerstreak@155 76 end
flickerstreak@155 77 end
flickerstreak@155 78
flickerstreak@156 79 -- hide if state or unit_exists says to
flickerstreak@156 80 hide = not showAll and (hide or unithide)
flickerstreak@156 81 if hide ~= hidden then
flickerstreak@156 82 hidden = hide
flickerstreak@156 83 if hide then
flickerstreak@156 84 self:Hide()
flickerstreak@156 85 else
flickerstreak@156 86 self:Show()
flickerstreak@156 87 end
flickerstreak@156 88 end
flickerstreak@156 89
flickerstreak@155 90 for _, attr in pairs(extensions) do
flickerstreak@155 91 control:RunAttribute(attr)
flickerstreak@155 92 end
flickerstreak@155 93
flickerstreak@155 94 control:ChildUpdate()
flickerstreak@155 95
flickerstreak@155 96 if showAll then
flickerstreak@155 97 control:CallMethod("UpdateHiddenLabel", state and settings[state] and settings[state].hide)
flickerstreak@155 98 end
flickerstreak@155 99
flickerstreak@155 100 if oldState ~= state then
flickerstreak@155 101 control:CallMethod("StateRefresh", state)
flickerstreak@155 102 end
flickerstreak@155 103 ]]
flickerstreak@155 104
flickerstreak@155 105 local _onstate_reaction = -- function( self, stateid, newstate )
flickerstreak@155 106 [[
flickerstreak@155 107 set_state = newstate
flickerstreak@155 108 ]] .. _reaction_refresh
flickerstreak@155 109
flickerstreak@155 110 local _onstate_showgrid = -- function( self, stateid, newstate )
flickerstreak@155 111 [[
flickerstreak@155 112 control:ChildUpdate(stateid,newstate)
flickerstreak@155 113 control:CallMethod("UpdateShowGrid")
flickerstreak@155 114 ]]
flickerstreak@155 115
flickerstreak@155 116 local _onstate_unitexists = -- function( self, stateid, newstate )
flickerstreak@155 117 [[
flickerstreak@159 118 unithide = not newstate or newstate == "hide"
flickerstreak@155 119 ]] .. _reaction_refresh
flickerstreak@155 120
flickerstreak@155 121 local _onclick = -- function( self, button, down )
flickerstreak@155 122 [[
flickerstreak@155 123 if state_override == button then
flickerstreak@155 124 state_override = nil -- toggle
flickerstreak@155 125 else
flickerstreak@155 126 state_override = button
flickerstreak@155 127 end
flickerstreak@155 128 ]] .. _reaction_refresh
flickerstreak@155 129
flickerstreak@157 130 -- For reference
flickerstreak@157 131 -- the option field names must match the field names of the options table, below
flickerstreak@157 132 local stateProperties = {
flickerstreak@157 133 hide = true,
flickerstreak@157 134 --keybindState = true, TODO: broken
flickerstreak@157 135 anchorEnable = true,
flickerstreak@157 136 anchorFrame = true,
flickerstreak@157 137 anchorPoint = true,
flickerstreak@157 138 anchorRelPoint = true,
flickerstreak@157 139 anchorX = true,
flickerstreak@157 140 anchorY = true,
flickerstreak@157 141 enableScale = true,
flickerstreak@157 142 scale = true,
flickerstreak@157 143 enableAlpha = true,
flickerstreak@157 144 alpha = true,
flickerstreak@157 145 }
flickerstreak@157 146
flickerstreak@157 147
flickerstreak@157 148 ---- Utility functions ----
flickerstreak@157 149
flickerstreak@157 150 -- traverse a table tree by key list and fetch the result or first nil
flickerstreak@157 151 local function tfetch(t, ...)
flickerstreak@157 152 for i = 1, select('#', ...) do
flickerstreak@157 153 t = t and t[select(i, ...)]
flickerstreak@157 154 end
flickerstreak@157 155 return t
flickerstreak@157 156 end
flickerstreak@157 157
flickerstreak@157 158 -- traverse a table tree by key list and build tree as necessary
flickerstreak@157 159 local function tbuild(t, ...)
flickerstreak@157 160 for i = 1, select('#', ...) do
flickerstreak@157 161 local key = select(i, ...)
flickerstreak@157 162 if not t[key] then t[key] = { } end
flickerstreak@157 163 t = t[key]
flickerstreak@157 164 end
flickerstreak@157 165 return t
flickerstreak@157 166 end
flickerstreak@157 167
flickerstreak@157 168 -- return a new array of keys of table 't', sorted by comparing
flickerstreak@157 169 -- sub-fields (obtained via tfetch) of the table values
flickerstreak@157 170 local function fieldsort( t, ... )
flickerstreak@157 171 local r = { }
flickerstreak@157 172 for k in pairs(t) do
flickerstreak@157 173 table.insert(r,k)
flickerstreak@157 174 end
flickerstreak@157 175 local path = { ... }
flickerstreak@157 176 table.sort(r, function(lhs, rhs)
flickerstreak@157 177 local olhs = tfetch(t[lhs], unpack(path)) or 0
flickerstreak@157 178 local orhs = tfetch(t[rhs], unpack(path)) or 0
flickerstreak@157 179 return olhs < orhs
flickerstreak@157 180 end)
flickerstreak@157 181 return r
flickerstreak@157 182 end
flickerstreak@157 183
flickerstreak@155 184
flickerstreak@147 185 ---- Bar class ----
flickerstreak@122 186 local Bar = { }
flickerstreak@122 187 local weak = { __mode = "k" }
flickerstreak@147 188 local frameList = { }
flickerstreak@122 189
flickerstreak@122 190 ReAction.Bar = Bar -- export to ReAction
flickerstreak@122 191
flickerstreak@122 192 function Bar:New( name, config )
flickerstreak@122 193 if type(config) ~= "table" then
flickerstreak@122 194 error("ReAction.Bar: config table required")
flickerstreak@122 195 end
flickerstreak@122 196
flickerstreak@122 197 -- create new self
flickerstreak@122 198 self = setmetatable(
flickerstreak@122 199 {
flickerstreak@122 200 config = config,
flickerstreak@122 201 name = name,
flickerstreak@122 202 buttons = setmetatable( { }, weak ),
flickerstreak@122 203 width = config.width or 480,
flickerstreak@147 204 height = config.height or 40,
flickerstreak@122 205 },
flickerstreak@147 206 {__index = self} )
flickerstreak@122 207
flickerstreak@122 208 -- The frame type is 'Button' in order to have an OnClick handler. However, the frame itself is
flickerstreak@122 209 -- not mouse-clickable by the user.
flickerstreak@122 210 local parent = config.parent and (ReAction:GetBar(config.parent) or _G[config.parent]) or UIParent
flickerstreak@147 211 name = name and "ReAction-"..name
flickerstreak@147 212 local f = name and frameList[name]
flickerstreak@147 213 if not f then
flickerstreak@147 214 f = CreateFrame("Button", name, parent, "SecureHandlerStateTemplate, SecureHandlerClickTemplate")
flickerstreak@147 215 if name then
flickerstreak@147 216 frameList[name] = f
flickerstreak@147 217 end
flickerstreak@147 218 end
flickerstreak@122 219 f:SetFrameStrata("MEDIUM")
flickerstreak@122 220 f:SetWidth(self.width)
flickerstreak@146 221 f:SetHeight(self.height)
flickerstreak@122 222 f:SetAlpha(config.alpha or 1.0)
flickerstreak@122 223 f:Show()
flickerstreak@122 224 f:EnableMouse(false)
flickerstreak@122 225 f:SetClampedToScreen(true)
flickerstreak@171 226 LSG:AddFrame(f)
flickerstreak@122 227
flickerstreak@155 228 -- secure handlers
flickerstreak@155 229 f:Execute(_reaction_init)
flickerstreak@155 230 f:SetAttribute("_onstate-reaction", _onstate_reaction)
flickerstreak@155 231 f:SetAttribute("_onstate-showgrid", _onstate_showgrid)
flickerstreak@155 232 f:SetAttribute("_onstate-unitexists", _onstate_unitexists)
flickerstreak@155 233 f:SetAttribute("_onclick", _onclick)
flickerstreak@155 234
flickerstreak@155 235 -- secure handler CallMethod()s
flickerstreak@155 236 f.UpdateShowGrid = function() self:UpdateShowGrid() end
flickerstreak@155 237 f.StateRefresh = function() self:RefreshControls() end
flickerstreak@155 238 f.UpdateHiddenLabel = function(f,hidden) self:SetLabelSubtext(hidden and L["Hidden"]) end
flickerstreak@122 239
flickerstreak@122 240 -- Override the default frame accessor to provide strict read-only access
flickerstreak@122 241 function self:GetFrame()
flickerstreak@122 242 return f
flickerstreak@122 243 end
flickerstreak@122 244
flickerstreak@122 245 self:ApplyAnchor()
flickerstreak@147 246 self:SetConfigMode(ReAction:GetConfigMode())
flickerstreak@147 247 self:SetKeybindMode(ReAction:GetKeybindMode())
flickerstreak@147 248
flickerstreak@122 249 ReAction.RegisterCallback(self, "OnConfigModeChanged")
flickerstreak@171 250 LKB.RegisterCallback(self, "LIBKEYBOUND_ENABLED")
flickerstreak@171 251 LKB.RegisterCallback(self, "LIBKEYBOUND_DISABLED")
flickerstreak@171 252 LKB.RegisterCallback(self, "LIBKEYBOUND_MODE_COLOR_CHANGED","LIBKEYBOUND_ENABLED")
flickerstreak@122 253
flickerstreak@122 254 return self
flickerstreak@122 255 end
flickerstreak@122 256
flickerstreak@122 257 function Bar:Destroy()
flickerstreak@122 258 local f = self:GetFrame()
flickerstreak@122 259 f:UnregisterAllEvents()
flickerstreak@125 260 self:ShowControls(false)
flickerstreak@122 261 ReAction.UnregisterAllCallbacks(self)
flickerstreak@171 262 LKB.UnregisterAllCallbacks(self)
flickerstreak@171 263 LSG:RemoveFrame(f)
flickerstreak@122 264 f:SetParent(UIParent)
flickerstreak@122 265 f:ClearAllPoints()
flickerstreak@147 266 f:Hide()
flickerstreak@122 267 end
flickerstreak@122 268
flickerstreak@147 269 --
flickerstreak@147 270 -- Events
flickerstreak@147 271 --
flickerstreak@147 272
flickerstreak@147 273 function Bar:OnConfigModeChanged(event, mode)
flickerstreak@147 274 self:SetConfigMode(mode)
flickerstreak@123 275 end
flickerstreak@123 276
flickerstreak@147 277 function Bar:LIBKEYBOUND_ENABLED(evt)
flickerstreak@147 278 self:SetKeybindMode(true)
flickerstreak@147 279 end
flickerstreak@147 280
flickerstreak@147 281 function Bar:LIBKEYBOUND_DISABLED(evt)
flickerstreak@147 282 self:SetKeybindMode(false)
flickerstreak@122 283 end
flickerstreak@122 284
flickerstreak@153 285 --
flickerstreak@153 286 -- Accessors
flickerstreak@153 287 --
flickerstreak@153 288
flickerstreak@153 289 function Bar:GetName()
flickerstreak@153 290 return self.name
flickerstreak@153 291 end
flickerstreak@153 292
flickerstreak@153 293 -- only ReAction:RenameBar() should call this function. Calling from any other
flickerstreak@153 294 -- context will desync the bar list in the ReAction class.
flickerstreak@153 295 function Bar:SetName(name)
flickerstreak@153 296 self.name = name
flickerstreak@154 297 if self.overlay then
flickerstreak@154 298 self.overlay:SetLabel(self.name)
flickerstreak@154 299 end
flickerstreak@153 300 end
flickerstreak@153 301
flickerstreak@153 302 function Bar:GetFrame()
flickerstreak@153 303 -- this method is included for documentation purposes. It is overridden
flickerstreak@153 304 -- for each object in the :New() method.
flickerstreak@153 305 error("Invalid Bar object: used without initialization")
flickerstreak@153 306 end
flickerstreak@153 307
flickerstreak@153 308 function Bar:GetConfig()
flickerstreak@153 309 return self.config
flickerstreak@153 310 end
flickerstreak@153 311
flickerstreak@153 312 function Bar:GetAnchor()
flickerstreak@122 313 local c = self.config
flickerstreak@153 314 return (c.point or "CENTER"),
flickerstreak@153 315 (c.anchor or self:GetFrame():GetParent():GetName()),
flickerstreak@153 316 (c.relpoint or c.point or "CENTER"),
flickerstreak@153 317 (c.x or 0),
flickerstreak@153 318 (c.y or 0)
flickerstreak@122 319 end
flickerstreak@122 320
flickerstreak@122 321 function Bar:SetAnchor(point, frame, relativePoint, x, y)
flickerstreak@122 322 local c = self.config
flickerstreak@122 323 c.point = point or c.point
flickerstreak@122 324 c.anchor = frame or c.anchor
flickerstreak@122 325 c.relpoint = relativePoint or c.relpoint
flickerstreak@122 326 c.x = x or c.x
flickerstreak@122 327 c.y = y or c.y
flickerstreak@122 328 self:ApplyAnchor()
flickerstreak@122 329 ReAction:RefreshBar(self)
flickerstreak@122 330 end
flickerstreak@122 331
flickerstreak@122 332 function Bar:GetSize()
flickerstreak@122 333 local f = self:GetFrame()
flickerstreak@122 334 return f:GetWidth(), f:GetHeight()
flickerstreak@122 335 end
flickerstreak@122 336
flickerstreak@122 337 function Bar:SetSize(w,h)
flickerstreak@122 338 local f = self:GetFrame()
flickerstreak@122 339 self.config.width = w
flickerstreak@122 340 self.config.height = h
flickerstreak@122 341 f:SetWidth(w)
flickerstreak@122 342 f:SetHeight(h)
flickerstreak@122 343 end
flickerstreak@122 344
flickerstreak@122 345 function Bar:GetButtonSize()
flickerstreak@122 346 local w = self.config.btnWidth or 32
flickerstreak@122 347 local h = self.config.btnHeight or 32
flickerstreak@122 348 -- TODO: get from modules?
flickerstreak@122 349 return w,h
flickerstreak@122 350 end
flickerstreak@122 351
flickerstreak@122 352 function Bar:SetButtonSize(w,h)
flickerstreak@122 353 if w > 0 and h > 0 then
flickerstreak@122 354 self.config.btnWidth = w
flickerstreak@122 355 self.config.btnHeight = h
flickerstreak@122 356 end
flickerstreak@122 357 ReAction:RefreshBar(self)
flickerstreak@122 358 end
flickerstreak@122 359
flickerstreak@153 360 function Bar:GetNumButtons()
flickerstreak@153 361 local r,c = self:GetButtonGrid()
flickerstreak@153 362 return r*c
flickerstreak@153 363 end
flickerstreak@153 364
flickerstreak@122 365 function Bar:GetButtonGrid()
flickerstreak@122 366 local cfg = self.config
flickerstreak@122 367 local r = cfg.btnRows or 1
flickerstreak@122 368 local c = cfg.btnColumns or 1
flickerstreak@122 369 local s = cfg.spacing or 4
flickerstreak@122 370 return r,c,s
flickerstreak@122 371 end
flickerstreak@122 372
flickerstreak@122 373 function Bar:SetButtonGrid(r,c,s)
flickerstreak@122 374 if r > 0 and c > 0 and s > 0 then
flickerstreak@122 375 local cfg = self.config
flickerstreak@122 376 cfg.btnRows = r
flickerstreak@122 377 cfg.btnColumns = c
flickerstreak@122 378 cfg.spacing = s
flickerstreak@122 379 end
flickerstreak@122 380 ReAction:RefreshBar(self)
flickerstreak@122 381 end
flickerstreak@122 382
flickerstreak@122 383 function Bar:GetAlpha()
flickerstreak@122 384 return self.config.alpha or 1.0
flickerstreak@122 385 end
flickerstreak@122 386
flickerstreak@122 387 function Bar:SetAlpha(value)
flickerstreak@122 388 self.config.alpha = value
flickerstreak@122 389 self:GetFrame():SetAlpha(value or 1.0)
flickerstreak@155 390 self:UpdateDefaultStateAlpha()
flickerstreak@122 391 ReAction:RefreshBar(self)
flickerstreak@122 392 end
flickerstreak@122 393
flickerstreak@122 394 function Bar:IterateButtons()
flickerstreak@155 395 -- iterator returns button, idx and does NOT iterate in index order
flickerstreak@122 396 return pairs(self.buttons)
flickerstreak@122 397 end
flickerstreak@122 398
flickerstreak@153 399 --
flickerstreak@153 400 -- Methods
flickerstreak@153 401 --
flickerstreak@153 402
flickerstreak@147 403 function Bar:SetConfigMode(mode)
flickerstreak@155 404 self:SetSecureData("showAll",mode)
flickerstreak@147 405 self:ShowControls(mode)
flickerstreak@147 406 for b in self:IterateButtons() do
flickerstreak@147 407 b:ShowGridTemp(mode)
flickerstreak@147 408 b:UpdateActionIDLabel(mode)
flickerstreak@147 409 end
flickerstreak@147 410 end
flickerstreak@147 411
flickerstreak@147 412 function Bar:SetKeybindMode(mode)
flickerstreak@155 413 self:SetSecureData("showAll",mode)
flickerstreak@147 414 for b in self:IterateButtons() do
flickerstreak@147 415 b:SetKeybindMode(mode)
flickerstreak@147 416 end
flickerstreak@147 417 end
flickerstreak@147 418
flickerstreak@153 419 function Bar:ApplyAnchor()
flickerstreak@153 420 local f = self:GetFrame()
flickerstreak@153 421 local c = self.config
flickerstreak@153 422 local p = c.point
flickerstreak@153 423
flickerstreak@153 424 f:SetWidth(c.width)
flickerstreak@153 425 f:SetHeight(c.height)
flickerstreak@153 426 f:ClearAllPoints()
flickerstreak@153 427
flickerstreak@153 428 if p then
flickerstreak@153 429 local a = f:GetParent()
flickerstreak@153 430 if c.anchor then
flickerstreak@153 431 local bar = ReAction:GetBar(c.anchor)
flickerstreak@153 432 if bar then
flickerstreak@153 433 a = bar:GetFrame()
flickerstreak@153 434 else
flickerstreak@153 435 a = _G[c.anchor]
flickerstreak@153 436 end
flickerstreak@153 437 end
flickerstreak@153 438 local fr = a or f:GetParent()
flickerstreak@153 439 f:SetPoint(p, a or f:GetParent(), c.relpoint, c.x or 0, c.y or 0)
flickerstreak@153 440 else
flickerstreak@153 441 f:SetPoint("CENTER")
flickerstreak@153 442 end
flickerstreak@155 443
flickerstreak@155 444 self:UpdateDefaultStateAnchor()
flickerstreak@153 445 end
flickerstreak@153 446
flickerstreak@153 447 function Bar:ClipNButtons( n )
flickerstreak@153 448 local cfg = self.config
flickerstreak@153 449 local r = cfg.btnRows or 1
flickerstreak@153 450 local c = cfg.btnColumns or 1
flickerstreak@153 451
flickerstreak@153 452 cfg.btnRows = ceil(n/c)
flickerstreak@153 453 cfg.btnColumns = min(n,c)
flickerstreak@153 454 end
flickerstreak@153 455
flickerstreak@153 456 function Bar:AddButton(idx, button)
flickerstreak@153 457 local f = self:GetFrame()
flickerstreak@153 458
flickerstreak@153 459 -- store in a weak reverse-index array
flickerstreak@153 460 self.buttons[button] = idx
flickerstreak@153 461
flickerstreak@153 462 -- Store a properly wrapped reference to the child frame as an attribute
flickerstreak@153 463 -- (accessible via "frameref-btn#")
flickerstreak@153 464 f:SetFrameRef(format("btn%d",idx), button:GetFrame())
flickerstreak@153 465 end
flickerstreak@153 466
flickerstreak@153 467 function Bar:RemoveButton(button)
flickerstreak@153 468 local idx = self.buttons[button]
flickerstreak@153 469 if idx then
flickerstreak@153 470 self:GetFrame():SetAttribute(format("frameref-btn%d",idx),nil)
flickerstreak@153 471 self.buttons[button] = nil
flickerstreak@153 472 end
flickerstreak@153 473 end
flickerstreak@153 474
flickerstreak@122 475 function Bar:PlaceButton(button, baseW, baseH)
flickerstreak@122 476 local idx = self.buttons[button]
flickerstreak@122 477 if idx then
flickerstreak@122 478 local r, c, s = self:GetButtonGrid()
flickerstreak@122 479 local bh, bw = self:GetButtonSize()
flickerstreak@122 480 local row, col = floor((idx-1)/c), fmod((idx-1),c) -- zero-based
flickerstreak@122 481 local x, y = col*bw + (col+0.5)*s, -(row*bh + (row+0.5)*s)
flickerstreak@122 482 local scale = bw/baseW
flickerstreak@122 483 local b = button:GetFrame()
flickerstreak@122 484
flickerstreak@122 485 b:ClearAllPoints()
flickerstreak@122 486 b:SetPoint("TOPLEFT",x/scale,y/scale)
flickerstreak@122 487 b:SetScale(scale)
flickerstreak@122 488 end
flickerstreak@122 489 end
flickerstreak@122 490
flickerstreak@122 491 function Bar:SkinButton()
flickerstreak@122 492 -- does nothing by default
flickerstreak@147 493 end
flickerstreak@148 494
flickerstreak@155 495 function Bar:UpdateShowGrid()
flickerstreak@155 496 for button in self:IterateButtons() do
flickerstreak@155 497 button:UpdateShowGrid()
flickerstreak@155 498 end
flickerstreak@155 499 end
flickerstreak@155 500
flickerstreak@154 501 function Bar:ShowControls(show)
flickerstreak@154 502 if show then
flickerstreak@155 503 if not self.overlay then
flickerstreak@155 504 self.overlay = Bar.Overlay:New(self) -- see Overlay.lua
flickerstreak@154 505 end
flickerstreak@155 506 self.overlay:Show()
flickerstreak@155 507 self:RefreshSecureState()
flickerstreak@155 508 elseif self.overlay then
flickerstreak@155 509 self.overlay:Hide()
flickerstreak@154 510 end
flickerstreak@154 511 end
flickerstreak@154 512
flickerstreak@154 513 function Bar:RefreshControls()
flickerstreak@154 514 if self.overlay and self.overlay:IsShown() then
flickerstreak@154 515 self.overlay:RefreshControls()
flickerstreak@154 516 end
flickerstreak@154 517 end
flickerstreak@154 518
flickerstreak@154 519 function Bar:SetLabelSubtext(text)
flickerstreak@154 520 if self.overlay then
flickerstreak@154 521 self.overlay:SetLabelSubtext(text)
flickerstreak@154 522 end
flickerstreak@154 523 end
flickerstreak@154 524
flickerstreak@154 525 --
flickerstreak@154 526 -- Secure state functions
flickerstreak@154 527 --
flickerstreak@154 528
flickerstreak@155 529 function Bar:GetSecureState()
flickerstreak@155 530 local env = GetManagedEnvironment(self:GetFrame())
flickerstreak@155 531 return env and env.state
flickerstreak@155 532 end
flickerstreak@155 533
flickerstreak@155 534 function Bar:GetStateProperty(state, propname)
flickerstreak@155 535 -- override in modules/State.lua for now
flickerstreak@155 536 end
flickerstreak@155 537
flickerstreak@155 538 function Bar:SetStateProperty(state, propname, value)
flickerstreak@155 539 -- override in modules/State.lua for now
flickerstreak@155 540 end
flickerstreak@155 541
flickerstreak@155 542 function Bar:RefreshSecureState()
flickerstreak@155 543 self:GetFrame():Execute(_reaction_refresh)
flickerstreak@155 544 end
flickerstreak@155 545
flickerstreak@155 546 -- usage: SetSecureData(globalname, [tblkey1, tblkey2, ...], value)
flickerstreak@155 547 function Bar:SetSecureData( ... )
flickerstreak@155 548 local n = select('#',...)
flickerstreak@155 549 if n < 2 then
flickerstreak@155 550 error("ReAction.Bar:SetSecureData() requires at least 2 arguments")
flickerstreak@155 551 end
flickerstreak@155 552 local f = self:GetFrame()
flickerstreak@155 553 f:SetAttribute("data-depth",n-1)
flickerstreak@155 554 f:SetAttribute("data-value",select(n,...))
flickerstreak@155 555 for i = 1, n-1 do
flickerstreak@155 556 local key = select(i,...)
flickerstreak@155 557 if key == nil then
flickerstreak@155 558 error("ReAction.Bar:SetSecureData() - nil table key in argument list (#"..i..")")
flickerstreak@155 559 end
flickerstreak@155 560 f:SetAttribute("data-key-"..i, key)
flickerstreak@155 561 end
flickerstreak@155 562 f:Execute(
flickerstreak@155 563 [[
flickerstreak@155 564 local n = self:GetAttribute("data-depth")
flickerstreak@155 565 if n > 0 then
flickerstreak@155 566 local value = self:GetAttribute("data-value")
flickerstreak@155 567 local t = _G
flickerstreak@155 568 for i = 1, n do
flickerstreak@155 569 local key = self:GetAttribute("data-key-"..i)
flickerstreak@155 570 if not key then return end
flickerstreak@155 571 if not t[key] then
flickerstreak@155 572 t[key] = newtable()
flickerstreak@155 573 end
flickerstreak@155 574 if i == n then
flickerstreak@155 575 t[key] = value
flickerstreak@155 576 else
flickerstreak@155 577 t = t[key]
flickerstreak@155 578 end
flickerstreak@155 579 end
flickerstreak@155 580 end
flickerstreak@155 581 ]])
flickerstreak@155 582 self:RefreshSecureState()
flickerstreak@155 583 end
flickerstreak@155 584
flickerstreak@155 585 function Bar:SetSecureStateData( state, key, value )
flickerstreak@155 586 self:SetSecureData("settings",state,key,value)
flickerstreak@155 587 end
flickerstreak@155 588
flickerstreak@155 589 -- sets a snippet to be run as an extension to _onstate-reaction
flickerstreak@155 590 function Bar:SetSecureStateExtension( id, snippet )
flickerstreak@155 591 if id == nil then
flickerstreak@155 592 error("ReAction.Bar:SetSecureStateExtension() requires an id")
flickerstreak@155 593 end
flickerstreak@155 594 local f = self:GetFrame()
flickerstreak@155 595 f:SetAttribute("input-secure-ext-id",id)
flickerstreak@155 596 f:SetAttribute("secure-ext-"..id,snippet)
flickerstreak@155 597 f:Execute(
flickerstreak@155 598 [[
flickerstreak@155 599 local id = self:GetAttribute("input-secure-ext-id")
flickerstreak@155 600 if id then
flickerstreak@155 601 extensions[id] = self:GetAttribute("secure-ext-"..id) or nil
flickerstreak@155 602 end
flickerstreak@155 603 ]])
flickerstreak@155 604 self:RefreshSecureState()
flickerstreak@155 605 end
flickerstreak@155 606
flickerstreak@155 607 function Bar:SetFrameRef( name, refFrame )
flickerstreak@155 608 if refFrame then
flickerstreak@155 609 local _, explicit = refFrame:IsProtected()
flickerstreak@155 610 if not explicit then
flickerstreak@155 611 refFrame = nil
flickerstreak@155 612 end
flickerstreak@155 613 end
flickerstreak@155 614 if refFrame then
flickerstreak@155 615 self:GetFrame():SetFrameRef(name,refFrame)
flickerstreak@155 616 else
flickerstreak@155 617 self:GetFrame():SetAttribute("frameref-"..name,nil)
flickerstreak@155 618 end
flickerstreak@155 619 end
flickerstreak@155 620
flickerstreak@157 621 function Bar:SetStateDriver( states )
flickerstreak@157 622 if states then
flickerstreak@157 623 for state, props in pairs(states) do
flickerstreak@157 624 self:SetSecureStateData(state, "active_", true) -- make sure there's a 'settings' field for this state
flickerstreak@157 625 for propname, value in pairs(props) do
flickerstreak@157 626 if propname == "anchorFrame" then
flickerstreak@157 627 self:SetFrameRef("anchor-"..state, _G[value])
flickerstreak@157 628 elseif propname == "rule" then
flickerstreak@157 629 -- do nothing
flickerstreak@157 630 else
flickerstreak@157 631 self:SetSecureStateData(state, propname, value)
flickerstreak@157 632 end
flickerstreak@157 633 end
flickerstreak@157 634 end
flickerstreak@157 635 end
flickerstreak@157 636 local rule = states and self:BuildStateRule(states)
flickerstreak@155 637 if rule then
flickerstreak@155 638 RegisterStateDriver(self:GetFrame(),"reaction",rule)
flickerstreak@155 639 elseif self.statedriver then
flickerstreak@155 640 UnregisterStateDriver(self:GetFrame(),"reaction")
flickerstreak@155 641 end
flickerstreak@155 642 self.statedriver = rule
flickerstreak@157 643 self:BuildStateKeybinds(states)
flickerstreak@155 644 self:RefreshSecureState()
flickerstreak@155 645 end
flickerstreak@155 646
flickerstreak@148 647 -- pass unit=nil to set up the unit elsewhere, if you want something more complex
flickerstreak@148 648 function Bar:RegisterUnitWatch( unit, enable )
flickerstreak@148 649 local f = self:GetFrame()
flickerstreak@148 650 if unit then
flickerstreak@148 651 f:SetAttribute("unit",unit)
flickerstreak@148 652 end
flickerstreak@156 653 if enable then
flickerstreak@156 654 RegisterUnitWatch(self:GetFrame(),true)
flickerstreak@156 655 elseif self.unitwatch then
flickerstreak@156 656 UnregisterUnitWatch(self:GetFrame())
flickerstreak@156 657 end
flickerstreak@148 658 self.unitwatch = enable
flickerstreak@156 659 self:RefreshSecureState()
flickerstreak@148 660 end
flickerstreak@148 661
flickerstreak@155 662 function Bar:SetStateKeybind( key, state )
flickerstreak@155 663 local f = self:GetFrame()
flickerstreak@155 664 local binds = self.statebinds
flickerstreak@155 665 if not binds then
flickerstreak@155 666 binds = { }
flickerstreak@155 667 self.statebinds = binds
flickerstreak@155 668 end
flickerstreak@155 669
flickerstreak@155 670 -- clear the old binding, if any
flickerstreak@155 671 if binds[state] then
flickerstreak@155 672 SetOverrideBinding(f, false, binds[state], nil)
flickerstreak@155 673 end
flickerstreak@155 674
flickerstreak@155 675 if key then
flickerstreak@157 676 SetOverrideBindingClick(f, false, key, f:GetName(), state) -- state name is virtual mouse button
flickerstreak@155 677 end
flickerstreak@155 678 binds[state] = key
flickerstreak@155 679 end
flickerstreak@155 680
flickerstreak@155 681 function Bar:GetStateKeybind( state )
flickerstreak@155 682 if self.statebinds and state then
flickerstreak@155 683 return self.statebinds[state]
flickerstreak@155 684 end
flickerstreak@155 685 end
flickerstreak@155 686
flickerstreak@155 687 function Bar:UpdateDefaultStateAnchor()
flickerstreak@155 688 local point, frame, relPoint, x, y = self:GetAnchor()
flickerstreak@155 689 local f = self:GetFrame()
flickerstreak@155 690 f:SetAttribute("defaultAnchor-point",point)
flickerstreak@155 691 f:SetAttribute("defaultAnchor-relPoint",relPoint)
flickerstreak@155 692 f:SetAttribute("defaultAnchor-x",x)
flickerstreak@155 693 f:SetAttribute("defaultAnchor-y",y)
flickerstreak@155 694 self:SetFrameRef("defaultAnchor",_G[frame or "UIParent"])
flickerstreak@155 695 f:Execute([[
flickerstreak@155 696 for _, k in pairs(anchorKeys) do
flickerstreak@155 697 defaultAnchor[k] = self:GetAttribute("defaultAnchor-"..k)
flickerstreak@155 698 end
flickerstreak@155 699 defaultAnchor.frame = self:GetAttribute("frameref-defaultAnchor")
flickerstreak@155 700 ]])
flickerstreak@155 701 end
flickerstreak@155 702
flickerstreak@155 703 function Bar:UpdateDefaultStateAlpha()
flickerstreak@155 704 local f = self:GetFrame()
flickerstreak@155 705 f:SetAttribute("defaultAlpha",self:GetAlpha())
flickerstreak@155 706 f:Execute([[
flickerstreak@155 707 defaultAlpha = self:GetAttribute("defaultAlpha")
flickerstreak@155 708 ]])
flickerstreak@155 709 end
flickerstreak@157 710
flickerstreak@157 711 ---- secure state driver rules ----
flickerstreak@157 712
flickerstreak@157 713 local playerClass = select(2, UnitClass("player"))
flickerstreak@157 714 local function ClassFilter(...)
flickerstreak@157 715 for i = 1, select('#',...) do
flickerstreak@157 716 if playerClass == select(i,...) then
flickerstreak@157 717 return false
flickerstreak@157 718 end
flickerstreak@157 719 end
flickerstreak@157 720 return true
flickerstreak@157 721 end
flickerstreak@157 722
flickerstreak@157 723 local ruleformats = {
flickerstreak@157 724 stealth = { format = "stealth", filter = ClassFilter("ROGUE","DRUID") },
flickerstreak@157 725 nostealth = { format = "nostealth", filter = ClassFilter("ROGUE","DRUID") },
flickerstreak@157 726 shadowdance = { format = "bonusbar:2", filter = ClassFilter("ROGUE") },
flickerstreak@157 727 shadowform = { format = "form:1", filter = ClassFilter("PRIEST") },
flickerstreak@157 728 noshadowform = { format = "noform", filter = ClassFilter("PRIEST") },
flickerstreak@157 729 battle = { format = "stance:1", filter = ClassFilter("WARRIOR") },
flickerstreak@157 730 defensive = { format = "stance:2", filter = ClassFilter("WARRIOR") },
flickerstreak@157 731 berserker = { format = "stance:3", filter = ClassFilter("WARRIOR") },
flickerstreak@157 732 caster = { format = "form:0/2/4/5/6", filter = ClassFilter("DRUID") },
flickerstreak@157 733 bear = { format = "form:1", filter = ClassFilter("DRUID") },
flickerstreak@157 734 cat = { format = "form:3", filter = ClassFilter("DRUID") },
flickerstreak@157 735 tree = { format = "form:5", filter = ClassFilter("DRUID") },
flickerstreak@157 736 moonkin = { format = "form:5", filter = ClassFilter("DRUID") },
flickerstreak@157 737 pet = { format = "pet" },
flickerstreak@157 738 nopet = { format = "nopet" },
flickerstreak@157 739 harm = { format = "target=target,harm" },
flickerstreak@157 740 help = { format = "target=target,help" },
flickerstreak@157 741 notarget = { format = "target=target,noexists" },
flickerstreak@157 742 focusharm = { format = "target=focus,harm" },
flickerstreak@157 743 focushelp = { format = "target=focus,help" },
flickerstreak@157 744 nofocus = { format = "target=focus,noexists" },
flickerstreak@157 745 raid = { format = "group:raid" },
flickerstreak@157 746 party = { format = "group:party" },
flickerstreak@157 747 solo = { format = "nogroup" },
flickerstreak@157 748 combat = { format = "combat" },
flickerstreak@157 749 nocombat = { format = "nocombat" },
flickerstreak@157 750 possess = { format = "target=vehicle,noexists,bonusbar:5" },
flickerstreak@157 751 vehicle = { format = "target=vehicle,exists,bonusbar:5" },
flickerstreak@157 752 }
flickerstreak@157 753
flickerstreak@157 754 function Bar.InitRuleFormats()
flickerstreak@157 755 local forms = { }
flickerstreak@157 756 for i = 1, GetNumShapeshiftForms() do
flickerstreak@157 757 local _, name = GetShapeshiftFormInfo(i)
flickerstreak@157 758 forms[name] = i;
flickerstreak@157 759 end
flickerstreak@157 760 -- use 9 if not found since 9 is never a valid stance/form
flickerstreak@157 761 local defensive = forms[GetSpellInfo(71)] or 9
flickerstreak@157 762 local berserker = forms[GetSpellInfo(2458)] or 9
flickerstreak@157 763 local bear = forms[GetSpellInfo(9634)] or forms[GetSpellInfo(5487)] or 9
flickerstreak@157 764 local aquatic = forms[GetSpellInfo(1066)] or 9
flickerstreak@157 765 local cat = forms[GetSpellInfo(768)] or 9
flickerstreak@157 766 local travel = forms[GetSpellInfo(783)] or 9
flickerstreak@157 767 local tree = forms[GetSpellInfo(33891)] or 9
flickerstreak@157 768 local moonkin = forms[GetSpellInfo(24858)] or 9
flickerstreak@157 769 local flight = forms[GetSpellInfo(40120)] or forms[GetSpellInfo(33943)] or 9
flickerstreak@157 770
flickerstreak@157 771 ruleformats.defensive.format = "stance:"..defensive
flickerstreak@157 772 ruleformats.berserker.format = "stance:"..berserker
flickerstreak@157 773 ruleformats.caster.format = format("form:0/%d/%d/%d", aquatic, travel, flight)
flickerstreak@157 774 ruleformats.bear.format = "form:"..bear
flickerstreak@157 775 ruleformats.cat.format = "form:"..cat
flickerstreak@157 776 ruleformats.tree.format = "form:"..tree
flickerstreak@157 777 ruleformats.moonkin.format = "form:"..moonkin
flickerstreak@157 778 end
flickerstreak@157 779
flickerstreak@157 780 function Bar:BuildStateRule(states)
flickerstreak@157 781 -- states is a table :
flickerstreak@157 782 -- states[statename].rule = {
flickerstreak@157 783 -- order = #,
flickerstreak@157 784 -- type = "default"/"custom"/"any"/"all",
flickerstreak@157 785 -- values = { ... }, -- keys of ruleformats[]
flickerstreak@157 786 -- custom = "...",
flickerstreak@157 787 -- }
flickerstreak@157 788 local rules = { }
flickerstreak@157 789 local default
flickerstreak@157 790
flickerstreak@157 791 for idx, state in ipairs(fieldsort(states, "rule", "order")) do
flickerstreak@157 792 local c = states[state].rule
flickerstreak@157 793 local type = c.type
flickerstreak@157 794 if type == "default" then
flickerstreak@157 795 default = default or state
flickerstreak@157 796 elseif type == "custom" then
flickerstreak@157 797 if c.custom then
flickerstreak@157 798 -- strip out all spaces from the custom rule
flickerstreak@157 799 table.insert(rules, format("%s %s", c.custom:gsub("%s",""), state))
flickerstreak@157 800 end
flickerstreak@157 801 elseif type == "any" or type == "all" then
flickerstreak@157 802 if c.values then
flickerstreak@157 803 local clauses = { }
flickerstreak@157 804 for key, value in pairs(c.values) do
flickerstreak@157 805 if ruleformats[key] and not ruleformats[key].filter then
flickerstreak@157 806 table.insert(clauses, ruleformats[key].format)
flickerstreak@157 807 end
flickerstreak@157 808 end
flickerstreak@157 809 if #clauses > 0 then
flickerstreak@157 810 local sep = (type == "any") and "][" or ","
flickerstreak@157 811 table.insert(rules, format("[%s] %s", table.concat(clauses,sep), state))
flickerstreak@157 812 end
flickerstreak@157 813 end
flickerstreak@157 814 end
flickerstreak@157 815 end
flickerstreak@157 816 -- make sure that the default, if any, is last
flickerstreak@157 817 if default then
flickerstreak@157 818 table.insert(rules, default)
flickerstreak@157 819 end
flickerstreak@157 820 return table.concat(rules,";")
flickerstreak@157 821 end
flickerstreak@157 822
flickerstreak@157 823 function Bar:BuildStateKeybinds( states )
flickerstreak@157 824 if states then
flickerstreak@157 825 for name, state in pairs(states) do
flickerstreak@157 826 local rule = tfetch(state, "rule")
flickerstreak@157 827 if rule and rule.type == "keybind" then
flickerstreak@157 828 self:SetStateKeybind(rule.keybind, name)
flickerstreak@157 829 else
flickerstreak@157 830 self:SetStateKeybind(nil, name) -- this clears an existing keybind
flickerstreak@157 831 end
flickerstreak@157 832 end
flickerstreak@157 833 end
flickerstreak@157 834 end
flickerstreak@157 835