annotate classes/Bar.lua @ 207:c24ac8ee1e45

kb mode and config mode now mutually exclusive
author Flick <flickerstreak@gmail.com>
date Tue, 16 Nov 2010 21:49:54 -0800
parents 576c50e51fc5
children 8ba8ab8bf6dd
rev   line source
flickerstreak@175 1 local addonName, addonTable = ...
flickerstreak@175 2 local ReAction = addonTable.ReAction
flickerstreak@122 3 local L = ReAction.L
flickerstreak@183 4 local LKB = ReAction.LKB
flickerstreak@122 5 local _G = _G
flickerstreak@122 6 local CreateFrame = CreateFrame
flickerstreak@122 7 local floor = math.floor
flickerstreak@122 8 local fmod = math.fmod
flickerstreak@122 9 local format = string.format
flickerstreak@122 10
flickerstreak@193 11 local LSG = LibStub("ReAction-LibShowActionGrid-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@122 250
flickerstreak@122 251 return self
flickerstreak@122 252 end
flickerstreak@122 253
flickerstreak@122 254 function Bar:Destroy()
flickerstreak@122 255 local f = self:GetFrame()
flickerstreak@122 256 f:UnregisterAllEvents()
flickerstreak@125 257 self:ShowControls(false)
flickerstreak@122 258 ReAction.UnregisterAllCallbacks(self)
flickerstreak@171 259 LKB.UnregisterAllCallbacks(self)
flickerstreak@171 260 LSG:RemoveFrame(f)
flickerstreak@122 261 f:SetParent(UIParent)
flickerstreak@122 262 f:ClearAllPoints()
flickerstreak@147 263 f:Hide()
flickerstreak@122 264 end
flickerstreak@122 265
flickerstreak@147 266 --
flickerstreak@147 267 -- Events
flickerstreak@147 268 --
flickerstreak@147 269
flickerstreak@147 270 function Bar:OnConfigModeChanged(event, mode)
flickerstreak@147 271 self:SetConfigMode(mode)
flickerstreak@123 272 end
flickerstreak@123 273
flickerstreak@153 274 --
flickerstreak@153 275 -- Accessors
flickerstreak@153 276 --
flickerstreak@153 277
flickerstreak@153 278 function Bar:GetName()
flickerstreak@153 279 return self.name
flickerstreak@153 280 end
flickerstreak@153 281
flickerstreak@153 282 -- only ReAction:RenameBar() should call this function. Calling from any other
flickerstreak@153 283 -- context will desync the bar list in the ReAction class.
flickerstreak@153 284 function Bar:SetName(name)
flickerstreak@153 285 self.name = name
flickerstreak@154 286 if self.overlay then
flickerstreak@154 287 self.overlay:SetLabel(self.name)
flickerstreak@154 288 end
flickerstreak@153 289 end
flickerstreak@153 290
flickerstreak@153 291 function Bar:GetFrame()
flickerstreak@153 292 -- this method is included for documentation purposes. It is overridden
flickerstreak@153 293 -- for each object in the :New() method.
flickerstreak@153 294 error("Invalid Bar object: used without initialization")
flickerstreak@153 295 end
flickerstreak@153 296
flickerstreak@153 297 function Bar:GetConfig()
flickerstreak@153 298 return self.config
flickerstreak@153 299 end
flickerstreak@153 300
flickerstreak@153 301 function Bar:GetAnchor()
flickerstreak@122 302 local c = self.config
flickerstreak@153 303 return (c.point or "CENTER"),
flickerstreak@153 304 (c.anchor or self:GetFrame():GetParent():GetName()),
flickerstreak@153 305 (c.relpoint or c.point or "CENTER"),
flickerstreak@153 306 (c.x or 0),
flickerstreak@153 307 (c.y or 0)
flickerstreak@122 308 end
flickerstreak@122 309
flickerstreak@122 310 function Bar:SetAnchor(point, frame, relativePoint, x, y)
flickerstreak@122 311 local c = self.config
flickerstreak@122 312 c.point = point or c.point
flickerstreak@122 313 c.anchor = frame or c.anchor
flickerstreak@122 314 c.relpoint = relativePoint or c.relpoint
flickerstreak@122 315 c.x = x or c.x
flickerstreak@122 316 c.y = y or c.y
flickerstreak@122 317 self:ApplyAnchor()
flickerstreak@122 318 ReAction:RefreshBar(self)
flickerstreak@122 319 end
flickerstreak@122 320
flickerstreak@122 321 function Bar:GetSize()
flickerstreak@122 322 local f = self:GetFrame()
flickerstreak@122 323 return f:GetWidth(), f:GetHeight()
flickerstreak@122 324 end
flickerstreak@122 325
flickerstreak@122 326 function Bar:SetSize(w,h)
flickerstreak@122 327 local f = self:GetFrame()
flickerstreak@122 328 self.config.width = w
flickerstreak@122 329 self.config.height = h
flickerstreak@122 330 f:SetWidth(w)
flickerstreak@122 331 f:SetHeight(h)
flickerstreak@122 332 end
flickerstreak@122 333
flickerstreak@122 334 function Bar:GetButtonSize()
flickerstreak@122 335 local w = self.config.btnWidth or 32
flickerstreak@122 336 local h = self.config.btnHeight or 32
flickerstreak@122 337 -- TODO: get from modules?
flickerstreak@122 338 return w,h
flickerstreak@122 339 end
flickerstreak@122 340
flickerstreak@122 341 function Bar:SetButtonSize(w,h)
flickerstreak@122 342 if w > 0 and h > 0 then
flickerstreak@122 343 self.config.btnWidth = w
flickerstreak@122 344 self.config.btnHeight = h
flickerstreak@122 345 end
flickerstreak@122 346 ReAction:RefreshBar(self)
flickerstreak@122 347 end
flickerstreak@122 348
flickerstreak@153 349 function Bar:GetNumButtons()
flickerstreak@153 350 local r,c = self:GetButtonGrid()
flickerstreak@153 351 return r*c
flickerstreak@153 352 end
flickerstreak@153 353
flickerstreak@122 354 function Bar:GetButtonGrid()
flickerstreak@122 355 local cfg = self.config
flickerstreak@122 356 local r = cfg.btnRows or 1
flickerstreak@122 357 local c = cfg.btnColumns or 1
flickerstreak@122 358 local s = cfg.spacing or 4
flickerstreak@122 359 return r,c,s
flickerstreak@122 360 end
flickerstreak@122 361
flickerstreak@122 362 function Bar:SetButtonGrid(r,c,s)
flickerstreak@122 363 if r > 0 and c > 0 and s > 0 then
flickerstreak@122 364 local cfg = self.config
flickerstreak@122 365 cfg.btnRows = r
flickerstreak@122 366 cfg.btnColumns = c
flickerstreak@122 367 cfg.spacing = s
flickerstreak@122 368 end
flickerstreak@122 369 ReAction:RefreshBar(self)
flickerstreak@122 370 end
flickerstreak@122 371
flickerstreak@122 372 function Bar:GetAlpha()
flickerstreak@122 373 return self.config.alpha or 1.0
flickerstreak@122 374 end
flickerstreak@122 375
flickerstreak@122 376 function Bar:SetAlpha(value)
flickerstreak@122 377 self.config.alpha = value
flickerstreak@122 378 self:GetFrame():SetAlpha(value or 1.0)
flickerstreak@155 379 self:UpdateDefaultStateAlpha()
flickerstreak@122 380 ReAction:RefreshBar(self)
flickerstreak@122 381 end
flickerstreak@122 382
flickerstreak@122 383 function Bar:IterateButtons()
flickerstreak@155 384 -- iterator returns button, idx and does NOT iterate in index order
flickerstreak@122 385 return pairs(self.buttons)
flickerstreak@122 386 end
flickerstreak@122 387
flickerstreak@153 388 --
flickerstreak@153 389 -- Methods
flickerstreak@153 390 --
flickerstreak@153 391
flickerstreak@147 392 function Bar:SetConfigMode(mode)
flickerstreak@155 393 self:SetSecureData("showAll",mode)
flickerstreak@147 394 self:ShowControls(mode)
flickerstreak@147 395 for b in self:IterateButtons() do
flickerstreak@147 396 b:ShowGridTemp(mode)
flickerstreak@147 397 b:UpdateActionIDLabel(mode)
flickerstreak@147 398 end
flickerstreak@147 399 end
flickerstreak@147 400
flickerstreak@147 401 function Bar:SetKeybindMode(mode)
flickerstreak@155 402 self:SetSecureData("showAll",mode)
flickerstreak@147 403 for b in self:IterateButtons() do
flickerstreak@147 404 b:SetKeybindMode(mode)
flickerstreak@147 405 end
flickerstreak@147 406 end
flickerstreak@147 407
flickerstreak@153 408 function Bar:ApplyAnchor()
flickerstreak@153 409 local f = self:GetFrame()
flickerstreak@153 410 local c = self.config
flickerstreak@153 411 local p = c.point
flickerstreak@153 412
flickerstreak@153 413 f:SetWidth(c.width)
flickerstreak@153 414 f:SetHeight(c.height)
flickerstreak@153 415 f:ClearAllPoints()
flickerstreak@153 416
flickerstreak@153 417 if p then
flickerstreak@153 418 local a = f:GetParent()
flickerstreak@153 419 if c.anchor then
flickerstreak@153 420 local bar = ReAction:GetBar(c.anchor)
flickerstreak@153 421 if bar then
flickerstreak@153 422 a = bar:GetFrame()
flickerstreak@153 423 else
flickerstreak@153 424 a = _G[c.anchor]
flickerstreak@153 425 end
flickerstreak@153 426 end
flickerstreak@153 427 local fr = a or f:GetParent()
flickerstreak@153 428 f:SetPoint(p, a or f:GetParent(), c.relpoint, c.x or 0, c.y or 0)
flickerstreak@153 429 else
flickerstreak@153 430 f:SetPoint("CENTER")
flickerstreak@153 431 end
flickerstreak@155 432
flickerstreak@155 433 self:UpdateDefaultStateAnchor()
flickerstreak@153 434 end
flickerstreak@153 435
flickerstreak@153 436 function Bar:ClipNButtons( n )
flickerstreak@153 437 local cfg = self.config
flickerstreak@153 438 local r = cfg.btnRows or 1
flickerstreak@153 439 local c = cfg.btnColumns or 1
flickerstreak@153 440
flickerstreak@153 441 cfg.btnRows = ceil(n/c)
flickerstreak@153 442 cfg.btnColumns = min(n,c)
flickerstreak@153 443 end
flickerstreak@153 444
flickerstreak@153 445 function Bar:AddButton(idx, button)
flickerstreak@153 446 local f = self:GetFrame()
flickerstreak@153 447
flickerstreak@153 448 -- store in a weak reverse-index array
flickerstreak@153 449 self.buttons[button] = idx
flickerstreak@153 450
flickerstreak@153 451 -- Store a properly wrapped reference to the child frame as an attribute
flickerstreak@153 452 -- (accessible via "frameref-btn#")
flickerstreak@153 453 f:SetFrameRef(format("btn%d",idx), button:GetFrame())
flickerstreak@153 454 end
flickerstreak@153 455
flickerstreak@153 456 function Bar:RemoveButton(button)
flickerstreak@153 457 local idx = self.buttons[button]
flickerstreak@153 458 if idx then
flickerstreak@153 459 self:GetFrame():SetAttribute(format("frameref-btn%d",idx),nil)
flickerstreak@153 460 self.buttons[button] = nil
flickerstreak@153 461 end
flickerstreak@153 462 end
flickerstreak@153 463
flickerstreak@122 464 function Bar:PlaceButton(button, baseW, baseH)
flickerstreak@122 465 local idx = self.buttons[button]
flickerstreak@122 466 if idx then
flickerstreak@122 467 local r, c, s = self:GetButtonGrid()
flickerstreak@122 468 local bh, bw = self:GetButtonSize()
flickerstreak@122 469 local row, col = floor((idx-1)/c), fmod((idx-1),c) -- zero-based
flickerstreak@122 470 local x, y = col*bw + (col+0.5)*s, -(row*bh + (row+0.5)*s)
flickerstreak@122 471 local scale = bw/baseW
flickerstreak@122 472 local b = button:GetFrame()
flickerstreak@122 473
flickerstreak@122 474 b:ClearAllPoints()
flickerstreak@122 475 b:SetPoint("TOPLEFT",x/scale,y/scale)
flickerstreak@122 476 b:SetScale(scale)
flickerstreak@122 477 end
flickerstreak@122 478 end
flickerstreak@122 479
flickerstreak@122 480 function Bar:SkinButton()
flickerstreak@122 481 -- does nothing by default
flickerstreak@147 482 end
flickerstreak@148 483
flickerstreak@155 484 function Bar:UpdateShowGrid()
flickerstreak@155 485 for button in self:IterateButtons() do
flickerstreak@155 486 button:UpdateShowGrid()
flickerstreak@155 487 end
flickerstreak@155 488 end
flickerstreak@155 489
flickerstreak@154 490 function Bar:ShowControls(show)
flickerstreak@154 491 if show then
flickerstreak@155 492 if not self.overlay then
flickerstreak@155 493 self.overlay = Bar.Overlay:New(self) -- see Overlay.lua
flickerstreak@154 494 end
flickerstreak@155 495 self.overlay:Show()
flickerstreak@155 496 self:RefreshSecureState()
flickerstreak@155 497 elseif self.overlay then
flickerstreak@155 498 self.overlay:Hide()
flickerstreak@154 499 end
flickerstreak@154 500 end
flickerstreak@154 501
flickerstreak@154 502 function Bar:RefreshControls()
flickerstreak@154 503 if self.overlay and self.overlay:IsShown() then
flickerstreak@154 504 self.overlay:RefreshControls()
flickerstreak@154 505 end
flickerstreak@154 506 end
flickerstreak@154 507
flickerstreak@154 508 function Bar:SetLabelSubtext(text)
flickerstreak@154 509 if self.overlay then
flickerstreak@154 510 self.overlay:SetLabelSubtext(text)
flickerstreak@154 511 end
flickerstreak@154 512 end
flickerstreak@154 513
flickerstreak@154 514 --
flickerstreak@154 515 -- Secure state functions
flickerstreak@154 516 --
flickerstreak@154 517
flickerstreak@155 518 function Bar:GetSecureState()
flickerstreak@155 519 local env = GetManagedEnvironment(self:GetFrame())
flickerstreak@155 520 return env and env.state
flickerstreak@155 521 end
flickerstreak@155 522
flickerstreak@155 523 function Bar:GetStateProperty(state, propname)
flickerstreak@155 524 -- override in modules/State.lua for now
flickerstreak@155 525 end
flickerstreak@155 526
flickerstreak@155 527 function Bar:SetStateProperty(state, propname, value)
flickerstreak@155 528 -- override in modules/State.lua for now
flickerstreak@155 529 end
flickerstreak@155 530
flickerstreak@155 531 function Bar:RefreshSecureState()
flickerstreak@155 532 self:GetFrame():Execute(_reaction_refresh)
flickerstreak@155 533 end
flickerstreak@155 534
flickerstreak@155 535 -- usage: SetSecureData(globalname, [tblkey1, tblkey2, ...], value)
flickerstreak@155 536 function Bar:SetSecureData( ... )
flickerstreak@155 537 local n = select('#',...)
flickerstreak@155 538 if n < 2 then
flickerstreak@155 539 error("ReAction.Bar:SetSecureData() requires at least 2 arguments")
flickerstreak@155 540 end
flickerstreak@155 541 local f = self:GetFrame()
flickerstreak@155 542 f:SetAttribute("data-depth",n-1)
flickerstreak@155 543 f:SetAttribute("data-value",select(n,...))
flickerstreak@155 544 for i = 1, n-1 do
flickerstreak@155 545 local key = select(i,...)
flickerstreak@155 546 if key == nil then
flickerstreak@155 547 error("ReAction.Bar:SetSecureData() - nil table key in argument list (#"..i..")")
flickerstreak@155 548 end
flickerstreak@155 549 f:SetAttribute("data-key-"..i, key)
flickerstreak@155 550 end
flickerstreak@155 551 f:Execute(
flickerstreak@155 552 [[
flickerstreak@155 553 local n = self:GetAttribute("data-depth")
flickerstreak@155 554 if n > 0 then
flickerstreak@155 555 local value = self:GetAttribute("data-value")
flickerstreak@155 556 local t = _G
flickerstreak@155 557 for i = 1, n do
flickerstreak@155 558 local key = self:GetAttribute("data-key-"..i)
flickerstreak@155 559 if not key then return end
flickerstreak@155 560 if not t[key] then
flickerstreak@155 561 t[key] = newtable()
flickerstreak@155 562 end
flickerstreak@155 563 if i == n then
flickerstreak@155 564 t[key] = value
flickerstreak@155 565 else
flickerstreak@155 566 t = t[key]
flickerstreak@155 567 end
flickerstreak@155 568 end
flickerstreak@155 569 end
flickerstreak@155 570 ]])
flickerstreak@155 571 self:RefreshSecureState()
flickerstreak@155 572 end
flickerstreak@155 573
flickerstreak@155 574 function Bar:SetSecureStateData( state, key, value )
flickerstreak@155 575 self:SetSecureData("settings",state,key,value)
flickerstreak@155 576 end
flickerstreak@155 577
flickerstreak@155 578 -- sets a snippet to be run as an extension to _onstate-reaction
flickerstreak@155 579 function Bar:SetSecureStateExtension( id, snippet )
flickerstreak@155 580 if id == nil then
flickerstreak@155 581 error("ReAction.Bar:SetSecureStateExtension() requires an id")
flickerstreak@155 582 end
flickerstreak@155 583 local f = self:GetFrame()
flickerstreak@155 584 f:SetAttribute("input-secure-ext-id",id)
flickerstreak@155 585 f:SetAttribute("secure-ext-"..id,snippet)
flickerstreak@155 586 f:Execute(
flickerstreak@155 587 [[
flickerstreak@155 588 local id = self:GetAttribute("input-secure-ext-id")
flickerstreak@155 589 if id then
flickerstreak@155 590 extensions[id] = self:GetAttribute("secure-ext-"..id) or nil
flickerstreak@155 591 end
flickerstreak@155 592 ]])
flickerstreak@155 593 self:RefreshSecureState()
flickerstreak@155 594 end
flickerstreak@155 595
flickerstreak@155 596 function Bar:SetFrameRef( name, refFrame )
flickerstreak@155 597 if refFrame then
flickerstreak@155 598 local _, explicit = refFrame:IsProtected()
flickerstreak@155 599 if not explicit then
flickerstreak@155 600 refFrame = nil
flickerstreak@155 601 end
flickerstreak@155 602 end
flickerstreak@155 603 if refFrame then
flickerstreak@155 604 self:GetFrame():SetFrameRef(name,refFrame)
flickerstreak@155 605 else
flickerstreak@155 606 self:GetFrame():SetAttribute("frameref-"..name,nil)
flickerstreak@155 607 end
flickerstreak@155 608 end
flickerstreak@155 609
flickerstreak@157 610 function Bar:SetStateDriver( states )
flickerstreak@157 611 if states then
flickerstreak@157 612 for state, props in pairs(states) do
flickerstreak@157 613 self:SetSecureStateData(state, "active_", true) -- make sure there's a 'settings' field for this state
flickerstreak@157 614 for propname, value in pairs(props) do
flickerstreak@157 615 if propname == "anchorFrame" then
flickerstreak@157 616 self:SetFrameRef("anchor-"..state, _G[value])
flickerstreak@157 617 elseif propname == "rule" then
flickerstreak@157 618 -- do nothing
flickerstreak@157 619 else
flickerstreak@157 620 self:SetSecureStateData(state, propname, value)
flickerstreak@157 621 end
flickerstreak@157 622 end
flickerstreak@157 623 end
flickerstreak@157 624 end
flickerstreak@157 625 local rule = states and self:BuildStateRule(states)
flickerstreak@155 626 if rule then
flickerstreak@155 627 RegisterStateDriver(self:GetFrame(),"reaction",rule)
flickerstreak@155 628 elseif self.statedriver then
flickerstreak@155 629 UnregisterStateDriver(self:GetFrame(),"reaction")
flickerstreak@155 630 end
flickerstreak@155 631 self.statedriver = rule
flickerstreak@157 632 self:BuildStateKeybinds(states)
flickerstreak@155 633 self:RefreshSecureState()
flickerstreak@155 634 end
flickerstreak@155 635
flickerstreak@148 636 -- pass unit=nil to set up the unit elsewhere, if you want something more complex
flickerstreak@148 637 function Bar:RegisterUnitWatch( unit, enable )
flickerstreak@148 638 local f = self:GetFrame()
flickerstreak@148 639 if unit then
flickerstreak@148 640 f:SetAttribute("unit",unit)
flickerstreak@148 641 end
flickerstreak@156 642 if enable then
flickerstreak@156 643 RegisterUnitWatch(self:GetFrame(),true)
flickerstreak@156 644 elseif self.unitwatch then
flickerstreak@156 645 UnregisterUnitWatch(self:GetFrame())
flickerstreak@156 646 end
flickerstreak@148 647 self.unitwatch = enable
flickerstreak@156 648 self:RefreshSecureState()
flickerstreak@148 649 end
flickerstreak@148 650
flickerstreak@155 651 function Bar:SetStateKeybind( key, state )
flickerstreak@155 652 local f = self:GetFrame()
flickerstreak@155 653 local binds = self.statebinds
flickerstreak@155 654 if not binds then
flickerstreak@155 655 binds = { }
flickerstreak@155 656 self.statebinds = binds
flickerstreak@155 657 end
flickerstreak@155 658
flickerstreak@155 659 -- clear the old binding, if any
flickerstreak@155 660 if binds[state] then
flickerstreak@155 661 SetOverrideBinding(f, false, binds[state], nil)
flickerstreak@155 662 end
flickerstreak@155 663
flickerstreak@155 664 if key then
flickerstreak@157 665 SetOverrideBindingClick(f, false, key, f:GetName(), state) -- state name is virtual mouse button
flickerstreak@155 666 end
flickerstreak@155 667 binds[state] = key
flickerstreak@155 668 end
flickerstreak@155 669
flickerstreak@155 670 function Bar:GetStateKeybind( state )
flickerstreak@155 671 if self.statebinds and state then
flickerstreak@155 672 return self.statebinds[state]
flickerstreak@155 673 end
flickerstreak@155 674 end
flickerstreak@155 675
flickerstreak@155 676 function Bar:UpdateDefaultStateAnchor()
flickerstreak@155 677 local point, frame, relPoint, x, y = self:GetAnchor()
flickerstreak@155 678 local f = self:GetFrame()
flickerstreak@155 679 f:SetAttribute("defaultAnchor-point",point)
flickerstreak@155 680 f:SetAttribute("defaultAnchor-relPoint",relPoint)
flickerstreak@155 681 f:SetAttribute("defaultAnchor-x",x)
flickerstreak@155 682 f:SetAttribute("defaultAnchor-y",y)
flickerstreak@155 683 self:SetFrameRef("defaultAnchor",_G[frame or "UIParent"])
flickerstreak@155 684 f:Execute([[
flickerstreak@155 685 for _, k in pairs(anchorKeys) do
flickerstreak@155 686 defaultAnchor[k] = self:GetAttribute("defaultAnchor-"..k)
flickerstreak@155 687 end
flickerstreak@155 688 defaultAnchor.frame = self:GetAttribute("frameref-defaultAnchor")
flickerstreak@155 689 ]])
flickerstreak@155 690 end
flickerstreak@155 691
flickerstreak@155 692 function Bar:UpdateDefaultStateAlpha()
flickerstreak@155 693 local f = self:GetFrame()
flickerstreak@155 694 f:SetAttribute("defaultAlpha",self:GetAlpha())
flickerstreak@155 695 f:Execute([[
flickerstreak@155 696 defaultAlpha = self:GetAttribute("defaultAlpha")
flickerstreak@155 697 ]])
flickerstreak@155 698 end
flickerstreak@157 699
flickerstreak@157 700 ---- secure state driver rules ----
flickerstreak@157 701
flickerstreak@157 702 local playerClass = select(2, UnitClass("player"))
flickerstreak@157 703 local function ClassFilter(...)
flickerstreak@157 704 for i = 1, select('#',...) do
flickerstreak@157 705 if playerClass == select(i,...) then
flickerstreak@157 706 return false
flickerstreak@157 707 end
flickerstreak@157 708 end
flickerstreak@157 709 return true
flickerstreak@157 710 end
flickerstreak@157 711
flickerstreak@157 712 local ruleformats = {
flickerstreak@157 713 stealth = { format = "stealth", filter = ClassFilter("ROGUE","DRUID") },
flickerstreak@157 714 nostealth = { format = "nostealth", filter = ClassFilter("ROGUE","DRUID") },
flickerstreak@157 715 shadowdance = { format = "bonusbar:2", filter = ClassFilter("ROGUE") },
flickerstreak@157 716 shadowform = { format = "form:1", filter = ClassFilter("PRIEST") },
flickerstreak@157 717 noshadowform = { format = "noform", filter = ClassFilter("PRIEST") },
flickerstreak@157 718 battle = { format = "stance:1", filter = ClassFilter("WARRIOR") },
flickerstreak@157 719 defensive = { format = "stance:2", filter = ClassFilter("WARRIOR") },
flickerstreak@157 720 berserker = { format = "stance:3", filter = ClassFilter("WARRIOR") },
flickerstreak@157 721 caster = { format = "form:0/2/4/5/6", filter = ClassFilter("DRUID") },
flickerstreak@157 722 bear = { format = "form:1", filter = ClassFilter("DRUID") },
flickerstreak@157 723 cat = { format = "form:3", filter = ClassFilter("DRUID") },
flickerstreak@157 724 tree = { format = "form:5", filter = ClassFilter("DRUID") },
flickerstreak@157 725 moonkin = { format = "form:5", filter = ClassFilter("DRUID") },
flickerstreak@178 726 demon = { format = "form:2", filter = ClassFilter("WARLOCK") },
flickerstreak@178 727 nodemon = { format = "noform", filter = ClassFilter("WARLOCK") },
flickerstreak@157 728 pet = { format = "pet" },
flickerstreak@157 729 nopet = { format = "nopet" },
flickerstreak@176 730 harm = { format = "@target,harm" },
flickerstreak@176 731 help = { format = "@target,help" },
flickerstreak@176 732 notarget = { format = "@target,noexists" },
flickerstreak@176 733 focusharm = { format = "@focus,harm" },
flickerstreak@176 734 focushelp = { format = "@focus,help" },
flickerstreak@176 735 nofocus = { format = "@focus,noexists" },
flickerstreak@157 736 raid = { format = "group:raid" },
flickerstreak@157 737 party = { format = "group:party" },
flickerstreak@157 738 solo = { format = "nogroup" },
flickerstreak@157 739 combat = { format = "combat" },
flickerstreak@157 740 nocombat = { format = "nocombat" },
flickerstreak@176 741 possess = { format = "@vehicle,noexists,bonusbar:5" },
flickerstreak@176 742 vehicle = { format = "@vehicle,exists,bonusbar:5" },
flickerstreak@157 743 }
flickerstreak@157 744
flickerstreak@157 745 function Bar.InitRuleFormats()
flickerstreak@157 746 local forms = { }
flickerstreak@157 747 for i = 1, GetNumShapeshiftForms() do
flickerstreak@157 748 local _, name = GetShapeshiftFormInfo(i)
flickerstreak@157 749 forms[name] = i;
flickerstreak@157 750 end
flickerstreak@157 751 -- use 9 if not found since 9 is never a valid stance/form
flickerstreak@157 752 local defensive = forms[GetSpellInfo(71)] or 9
flickerstreak@157 753 local berserker = forms[GetSpellInfo(2458)] or 9
flickerstreak@176 754 local bear = forms[GetSpellInfo(5487)] or 9
flickerstreak@157 755 local aquatic = forms[GetSpellInfo(1066)] or 9
flickerstreak@157 756 local cat = forms[GetSpellInfo(768)] or 9
flickerstreak@157 757 local travel = forms[GetSpellInfo(783)] or 9
flickerstreak@157 758 local tree = forms[GetSpellInfo(33891)] or 9
flickerstreak@157 759 local moonkin = forms[GetSpellInfo(24858)] or 9
flickerstreak@157 760 local flight = forms[GetSpellInfo(40120)] or forms[GetSpellInfo(33943)] or 9
flickerstreak@157 761
flickerstreak@157 762 ruleformats.defensive.format = "stance:"..defensive
flickerstreak@157 763 ruleformats.berserker.format = "stance:"..berserker
flickerstreak@157 764 ruleformats.caster.format = format("form:0/%d/%d/%d", aquatic, travel, flight)
flickerstreak@157 765 ruleformats.bear.format = "form:"..bear
flickerstreak@157 766 ruleformats.cat.format = "form:"..cat
flickerstreak@157 767 ruleformats.tree.format = "form:"..tree
flickerstreak@157 768 ruleformats.moonkin.format = "form:"..moonkin
flickerstreak@157 769 end
flickerstreak@157 770
flickerstreak@157 771 function Bar:BuildStateRule(states)
flickerstreak@157 772 -- states is a table :
flickerstreak@157 773 -- states[statename].rule = {
flickerstreak@157 774 -- order = #,
flickerstreak@157 775 -- type = "default"/"custom"/"any"/"all",
flickerstreak@157 776 -- values = { ... }, -- keys of ruleformats[]
flickerstreak@157 777 -- custom = "...",
flickerstreak@157 778 -- }
flickerstreak@157 779 local rules = { }
flickerstreak@157 780 local default
flickerstreak@157 781
flickerstreak@157 782 for idx, state in ipairs(fieldsort(states, "rule", "order")) do
flickerstreak@157 783 local c = states[state].rule
flickerstreak@157 784 local type = c.type
flickerstreak@157 785 if type == "default" then
flickerstreak@157 786 default = default or state
flickerstreak@157 787 elseif type == "custom" then
flickerstreak@157 788 if c.custom then
flickerstreak@157 789 -- strip out all spaces from the custom rule
flickerstreak@157 790 table.insert(rules, format("%s %s", c.custom:gsub("%s",""), state))
flickerstreak@157 791 end
flickerstreak@157 792 elseif type == "any" or type == "all" then
flickerstreak@157 793 if c.values then
flickerstreak@157 794 local clauses = { }
flickerstreak@157 795 for key, value in pairs(c.values) do
flickerstreak@157 796 if ruleformats[key] and not ruleformats[key].filter then
flickerstreak@157 797 table.insert(clauses, ruleformats[key].format)
flickerstreak@157 798 end
flickerstreak@157 799 end
flickerstreak@157 800 if #clauses > 0 then
flickerstreak@157 801 local sep = (type == "any") and "][" or ","
flickerstreak@157 802 table.insert(rules, format("[%s] %s", table.concat(clauses,sep), state))
flickerstreak@157 803 end
flickerstreak@157 804 end
flickerstreak@157 805 end
flickerstreak@157 806 end
flickerstreak@157 807 -- make sure that the default, if any, is last
flickerstreak@157 808 if default then
flickerstreak@157 809 table.insert(rules, default)
flickerstreak@157 810 end
flickerstreak@157 811 return table.concat(rules,";")
flickerstreak@157 812 end
flickerstreak@157 813
flickerstreak@157 814 function Bar:BuildStateKeybinds( states )
flickerstreak@157 815 if states then
flickerstreak@157 816 for name, state in pairs(states) do
flickerstreak@157 817 local rule = tfetch(state, "rule")
flickerstreak@157 818 if rule and rule.type == "keybind" then
flickerstreak@157 819 self:SetStateKeybind(rule.keybind, name)
flickerstreak@157 820 else
flickerstreak@157 821 self:SetStateKeybind(nil, name) -- this clears an existing keybind
flickerstreak@157 822 end
flickerstreak@157 823 end
flickerstreak@157 824 end
flickerstreak@157 825 end
flickerstreak@157 826