Mercurial > wow > reaction

annotate State.lua @ 90:7cabc8ac6c16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updates for wow 3.0 - TOC update - updated changed APIs/frame names - rewrote state code per new SecureHandlers API - cleaned up Bar, ActionButton code - removed AceLibrary/Dewdrop, menu from bar right-click - fixed various small bugs Updated WowAce external locations Updated README.html
author Flick <flickerstreak@gmail.com>
date Wed, 15 Oct 2008 16:29:41 +0000
parents 1ad208c25618
children c2504a8b996c
rev   line source
flickerstreak@25 1 --[[
flickerstreak@62 2 ReAction bar state driver interface
flickerstreak@25 3
flickerstreak@25 4 --]]
flickerstreak@25 5
flickerstreak@25 6 -- local imports
flickerstreak@25 7 local ReAction = ReAction
flickerstreak@25 8 local L = ReAction.L
flickerstreak@25 9 local _G = _G
flickerstreak@90 10 local format = string.format
flickerstreak@25 11 local InCombatLockdown = InCombatLockdown
flickerstreak@90 12 local RegisterStateDriver = RegisterStateDriver
flickerstreak@25 13
flickerstreak@80 14 ReAction:UpdateRevision("$Revision$")
flickerstreak@77 15
flickerstreak@25 16 -- module declaration
flickerstreak@25 17 local moduleID = "State"
flickerstreak@65 18 local module = ReAction:NewModule( moduleID, "AceEvent-3.0" )
flickerstreak@62 19
flickerstreak@64 20 -- Utility --
flickerstreak@62 21
flickerstreak@62 22 -- traverse a table tree by key list and fetch the result or first nil
flickerstreak@62 23 local function tfetch(t, ...)
flickerstreak@62 24 for i = 1, select('#', ...) do
flickerstreak@62 25 t = t and t[select(i, ...)]
flickerstreak@62 26 end
flickerstreak@62 27 return t
flickerstreak@62 28 end
flickerstreak@62 29
flickerstreak@62 30 -- traverse a table tree by key list and build tree as necessary
flickerstreak@62 31 local function tbuild(t, ...)
flickerstreak@62 32 for i = 1, select('#', ...) do
flickerstreak@62 33 local key = select(i, ...)
flickerstreak@62 34 if not t[key] then t[key] = { } end
flickerstreak@62 35 t = t[key]
flickerstreak@62 36 end
flickerstreak@62 37 return t
flickerstreak@62 38 end
flickerstreak@62 39
flickerstreak@75 40 -- return a new array of keys of table 't', sorted by comparing
flickerstreak@75 41 -- sub-fields (obtained via tfetch) of the table values
flickerstreak@75 42 local function fieldsort( t, ... )
flickerstreak@75 43 local r = { }
flickerstreak@75 44 for k in pairs(t) do
flickerstreak@75 45 table.insert(r,k)
flickerstreak@75 46 end
flickerstreak@75 47 local path = { ... }
flickerstreak@75 48 table.sort(r, function(lhs, rhs)
flickerstreak@75 49 local olhs = tfetch(t[lhs], unpack(path)) or 0
flickerstreak@75 50 local orhs = tfetch(t[rhs], unpack(path)) or 0
flickerstreak@75 51 return olhs < orhs
flickerstreak@75 52 end)
flickerstreak@75 53 return r
flickerstreak@75 54 end
flickerstreak@75 55
flickerstreak@68 56
flickerstreak@90 57 local InitRules, ApplyStates, CleanupStates, SetProperty, GetProperty, RegisterProperty, ShowAll
flickerstreak@75 58
flickerstreak@75 59 -- PRIVATE --
flickerstreak@64 60 do
flickerstreak@90 61
flickerstreak@90 62 -- the field names must match the field names of the options table, below
flickerstreak@90 63 -- the field values are secure snippets
flickerstreak@90 64 local properties = {
flickerstreak@90 65 hide =
flickerstreak@90 66 [[
flickerstreak@90 67 local h = hide and hide[state] and not showAll
flickerstreak@90 68 if h ~= hidden then
flickerstreak@90 69 if h then
flickerstreak@90 70 self:Hide()
flickerstreak@90 71 else
flickerstreak@90 72 self:Show()
flickerstreak@90 73 end
flickerstreak@90 74 hidden = h
flickerstreak@90 75 end
flickerstreak@90 76 ]],
flickerstreak@90 77
flickerstreak@90 78 --keybindState TODO: broken
flickerstreak@90 79
flickerstreak@90 80 -- the anchoring is handled in a special handler
flickerstreak@90 81 anchorEnable = true,
flickerstreak@90 82 --anchorFrame = true, TODO: broken
flickerstreak@90 83 anchorPoint = true,
flickerstreak@90 84 anchorRelPoint = true,
flickerstreak@90 85 anchorX = true,
flickerstreak@90 86 anchorY = true,
flickerstreak@90 87 enableScale = true,
flickerstreak@90 88 scale = true,
flickerstreak@90 89 }
flickerstreak@90 90
flickerstreak@90 91
flickerstreak@90 92 --
flickerstreak@90 93 -- Secure Handler Snippets
flickerstreak@90 94 --
flickerstreak@90 95 local SetHandlerData, SetStateDriver, SetStateKeybind, RefreshState
flickerstreak@90 96 do
flickerstreak@90 97 local stateHandler_propInit =
flickerstreak@90 98 [[
flickerstreak@90 99 propfuncs = table.new()
flickerstreak@90 100 local proplist = self:GetAttribute("prop-func-list")
flickerstreak@90 101 for s in string.gmatch(proplist, "(%w+)") do
flickerstreak@90 102 table.insert(propfuncs, s)
flickerstreak@90 103 end
flickerstreak@90 104 ]]
flickerstreak@90 105
flickerstreak@90 106 local onStateHandler =
flickerstreak@90 107 -- function _onstate-reaction( self, stateid, newstate )
flickerstreak@90 108 [[
flickerstreak@90 109 print("received state",newstate,"on bar",self:GetName())
flickerstreak@90 110 set_state = newstate or set_state
flickerstreak@90 111
flickerstreak@90 112 local oldState = state
flickerstreak@90 113 state = state_override or set_state or state
flickerstreak@90 114
flickerstreak@90 115 for i = 1, #propfuncs do
flickerstreak@90 116 print("running state func",propfuncs[i])
flickerstreak@90 117 control:RunAttribute("func-"..propfuncs[i])
flickerstreak@90 118 end
flickerstreak@90 119
flickerstreak@90 120 if anchorEnable and anchorEnable[state] ~= anchorstate then
flickerstreak@90 121 anchorstate = anchorEnable[state]
flickerstreak@90 122 control:RunAttribute("func-doanchor")
flickerstreak@90 123 end
flickerstreak@90 124
flickerstreak@90 125 control:ChildUpdate()
flickerstreak@90 126 ]]
flickerstreak@90 127
flickerstreak@90 128 local anchorHandler =
flickerstreak@90 129 -- function func-doanchor( self )
flickerstreak@90 130 [[
flickerstreak@90 131 -- TODO
flickerstreak@90 132 if anchorstate then
flickerstreak@90 133 -- TODO: get anchor data from state tables
flickerstreak@90 134 else
flickerstreak@90 135 -- TODO: get anchor data from defaults
flickerstreak@90 136 end
flickerstreak@90 137 ]]
flickerstreak@90 138
flickerstreak@90 139 local onClickHandler =
flickerstreak@90 140 -- function OnClick( self, button, down )
flickerstreak@90 141 [[
flickerstreak@90 142 if state_override == button then
flickerstreak@90 143 state_override = nil -- toggle
flickerstreak@90 144 else
flickerstreak@90 145 state_override = button
flickerstreak@90 146 end
flickerstreak@90 147 ]] .. onStateHandler
flickerstreak@90 148
flickerstreak@90 149 local weak = { __mode = "k" }
flickerstreak@90 150 local statedrivers = setmetatable( { }, weak )
flickerstreak@90 151 local keybinds = setmetatable( { }, weak )
flickerstreak@90 152
flickerstreak@90 153 -- Construct a lua assignment as a code string and execute it within the header
flickerstreak@90 154 -- frame's sandbox. 'value' must be a string, boolean, number, or nil. If called
flickerstreak@90 155 -- with four arguments, then it treats 'varname' as an existing global table and
flickerstreak@90 156 -- sets a key-value pair. For a slight efficiency boost, pass the values in as
flickerstreak@90 157 -- attributes and fetch them as attributes from the snippet code, to leverage snippet
flickerstreak@90 158 -- caching.
flickerstreak@90 159 function SetHandlerData( bar, varname, value, key )
flickerstreak@90 160 local f = bar:GetFrame()
flickerstreak@90 161 f:SetAttribute("data-varname",varname)
flickerstreak@90 162 f:SetAttribute("data-value", value)
flickerstreak@90 163 f:SetAttribute("data-key", key)
flickerstreak@90 164 f:Execute(
flickerstreak@90 165 [[
flickerstreak@90 166 local name = self:GetAttribute("data-varname")
flickerstreak@90 167 local value = self:GetAttribute("data-value")
flickerstreak@90 168 local key = self:GetAttribute("data-key")
flickerstreak@90 169 if name then
flickerstreak@90 170 if key then
flickerstreak@90 171 if not _G[name] then
flickerstreak@90 172 _G[name] = table.new()
flickerstreak@90 173 end
flickerstreak@90 174 _G[name][key] = value
flickerstreak@90 175 else
flickerstreak@90 176 _G[name] = value
flickerstreak@90 177 end
flickerstreak@90 178 end
flickerstreak@90 179 ]])
flickerstreak@90 180 end
flickerstreak@90 181
flickerstreak@90 182 function SetDefaultAnchor( bar )
flickerstreak@90 183 local point, frame, relPoint, x, y = bar:GetAnchor()
flickerstreak@90 184 SetHandlerData(bar, "defaultAnchor", point, "point")
flickerstreak@90 185 SetHandlerData(bar, "defaultAnchor", relPoint, "relPoint")
flickerstreak@90 186 SetHandlerData(bar, "defaultAnchor", x, "x")
flickerstreak@90 187 SetHandlerData(bar, "defaultAnchor", y, "y")
flickerstreak@90 188
flickerstreak@90 189 if frame then
flickerstreak@90 190 local f = bar:GetFrame()
flickerstreak@90 191 f:SetFrameRef("defaultAnchor", f)
flickerstreak@90 192 f:Execute(
flickerstreak@90 193 [[
flickerstreak@90 194 defaultAnchor.frame = self:GetAttribute("frameref-defaultAnchor")
flickerstreak@90 195 ]])
flickerstreak@90 196 end
flickerstreak@90 197 end
flickerstreak@90 198
flickerstreak@90 199 function RefreshState( bar )
flickerstreak@90 200 SetDefaultAnchor(bar)
flickerstreak@90 201 bar:GetFrame():Execute([[control:RunAttribute("reaction-refresh")]])
flickerstreak@90 202 end
flickerstreak@90 203
flickerstreak@90 204 function SetStateDriver( bar, rule )
flickerstreak@90 205 local f = bar:GetFrame()
flickerstreak@90 206
flickerstreak@90 207 local props = { }
flickerstreak@90 208 for p, h in pairs(properties) do
flickerstreak@90 209 if type(h) == "string" then
flickerstreak@90 210 table.insert(props,p)
flickerstreak@90 211 f:SetAttribute("func-"..p, h)
flickerstreak@90 212 end
flickerstreak@90 213 end
flickerstreak@90 214 f:SetAttribute("prop-func-list", table.concat(props," "))
flickerstreak@90 215 f:Execute(stateHandler_propInit)
flickerstreak@90 216 f:SetAttribute("reaction-refresh", onStateHandler)
flickerstreak@90 217 f:SetAttribute("func-doanchor", anchorHandler)
flickerstreak@90 218
flickerstreak@90 219 if rule and #rule > 0 then
flickerstreak@90 220 f:SetAttribute( "_onstate-reaction", onStateHandler )
flickerstreak@90 221 RegisterStateDriver(f, "reaction", rule)
flickerstreak@90 222 statedrivers[bar] = rule
flickerstreak@90 223 elseif statedrivers[bar] then
flickerstreak@90 224 UnregisterStateDriver(f, "reaction")
flickerstreak@90 225 f:SetAttribute( "_onstate-reaction", nil )
flickerstreak@90 226 statedrivers[bar] = nil
flickerstreak@90 227 end
flickerstreak@90 228 end
flickerstreak@90 229
flickerstreak@90 230 function SetStateKeybind( bar, key, state )
flickerstreak@90 231 local f = bar:GetFrame()
flickerstreak@90 232
flickerstreak@90 233 local kb = keybinds[bar]
flickerstreak@90 234 if kb == nil then
flickerstreak@90 235 if key == nil then
flickerstreak@90 236 -- nothing to do
flickerstreak@90 237 return
flickerstreak@90 238 end
flickerstreak@90 239 kb = { }
flickerstreak@90 240 keybinds[bar] = kb
flickerstreak@90 241 end
flickerstreak@90 242
flickerstreak@90 243 -- clear the old binding, if any
flickerstreak@90 244 if kb[state] then
flickerstreak@90 245 SetOverrideBinding(f, false, kb[state], nil)
flickerstreak@90 246 end
flickerstreak@90 247 kb[state] = key
flickerstreak@90 248
flickerstreak@90 249 if key then
flickerstreak@90 250 f:SetAttribute("_onclick", onClickHandler)
flickerstreak@90 251 SetOverrideBindingClick(f, false, key, state, nil) -- state name is the virtual mouse button
flickerstreak@90 252 end
flickerstreak@90 253 end
flickerstreak@90 254 end
flickerstreak@90 255
flickerstreak@67 256 -- As far as I can tell the macro clauses are NOT locale-specific.
flickerstreak@67 257 local ruleformats = {
flickerstreak@67 258 stealth = "stealth",
flickerstreak@67 259 nostealth = "nostealth",
flickerstreak@67 260 shadowform = "form:1",
flickerstreak@67 261 noshadowform = "noform",
flickerstreak@67 262 pet = "pet",
flickerstreak@67 263 nopet = "nopet",
flickerstreak@67 264 harm = "target=target,harm",
flickerstreak@67 265 help = "target=target,help",
flickerstreak@67 266 notarget = "target=target,noexists",
flickerstreak@67 267 focusharm = "target=focus,harm",
flickerstreak@67 268 focushelp = "target=focus,help",
flickerstreak@67 269 nofocus = "target=focus,noexists",
flickerstreak@67 270 raid = "group:raid",
flickerstreak@67 271 party = "group:party",
flickerstreak@67 272 solo = "nogroup",
flickerstreak@67 273 combat = "combat",
flickerstreak@67 274 nocombat = "nocombat",
flickerstreak@75 275 possess = "bonusbar:5",
flickerstreak@67 276 }
flickerstreak@65 277
flickerstreak@67 278 -- Have to do these shenanigans instead of hardcoding the stances/forms because
flickerstreak@67 279 -- the ordering varies if the character is missing a form. For warriors
flickerstreak@67 280 -- this is rarely a problem (c'mon, who actually skips the level 10 def stance quest?)
flickerstreak@67 281 -- but for druids it can be. Some people never bother to do the aquatic form quest
flickerstreak@75 282 -- until well past when they get cat form, and stance 5/6 can be flight, tree, or moonkin
flickerstreak@67 283 -- depending on talents.
flickerstreak@65 284 function InitRules()
flickerstreak@65 285 local forms = { }
flickerstreak@67 286 -- sort by icon since it's locale-independent
flickerstreak@65 287 for i = 1, GetNumShapeshiftForms() do
flickerstreak@65 288 local icon = GetShapeshiftFormInfo(i)
flickerstreak@65 289 forms[icon] = i;
flickerstreak@65 290 end
flickerstreak@65 291 -- use 9 if not found since 9 is never a valid stance/form
flickerstreak@65 292 local defensive = forms["Interface\\Icons\\Ability_Warrior_DefensiveStance"] or 9
flickerstreak@65 293 local berserker = forms["Interface\\Icons\\Ability_Racial_Avatar"] or 9
flickerstreak@65 294 local bear = forms["Interface\\Icons\\Ability_Racial_BearForm"] or 9 -- bear and dire bear share the same icon
flickerstreak@65 295 local aquatic = forms["Interface\\Icons\\Ability_Druid_AquaticForm"] or 9
flickerstreak@65 296 local cat = forms["Interface\\Icons\\Ability_Druid_CatForm"] or 9
flickerstreak@65 297 local travel = forms["Interface\\Icons\\Ability_Druid_TravelForm"] or 9
flickerstreak@75 298 local tree = forms["Interface\\Icons\\Ability_Druid_TreeofLife"] or 9
flickerstreak@75 299 local moonkin = forms["Interface\\Icons\\Spell_Nature_ForceOfNature"] or 9
flickerstreak@67 300 local flight = forms["Interface\\Icons\\Ability_Druid_FlightForm"] or 9 -- flight and swift flight share the same icon
flickerstreak@65 301
flickerstreak@75 302 ruleformats.battle = "stance:1"
flickerstreak@75 303 ruleformats.defensive = format("stance:%d",defensive)
flickerstreak@75 304 ruleformats.berserker = format("stance:%d",berserker)
flickerstreak@75 305 ruleformats.caster = format("form:0/%d/%d/%d",aquatic, travel, flight)
flickerstreak@75 306 ruleformats.bear = format("form:%d",bear)
flickerstreak@75 307 ruleformats.cat = format("form:%d",cat)
flickerstreak@75 308 ruleformats.tree = format("form:%d",tree)
flickerstreak@75 309 ruleformats.moonkin = format("form:%d",moonkin)
flickerstreak@64 310 end
flickerstreak@62 311
flickerstreak@90 312 local function BuildRule(states)
flickerstreak@75 313 local rules = { }
flickerstreak@75 314 local default
flickerstreak@75 315
flickerstreak@75 316 for idx, state in ipairs(fieldsort(states, "rule", "order")) do
flickerstreak@75 317 local c = states[state].rule
flickerstreak@75 318 local type = c.type
flickerstreak@75 319 if type == "default" then
flickerstreak@75 320 default = default or state
flickerstreak@75 321 elseif type == "custom" then
flickerstreak@75 322 if c.custom then
flickerstreak@75 323 -- strip out all spaces from the custom rule
flickerstreak@75 324 table.insert(rules, format("%s %s", c.custom:gsub("%s",""), state))
flickerstreak@75 325 end
flickerstreak@75 326 elseif type == "any" then
flickerstreak@75 327 if c.values then
flickerstreak@75 328 local clauses = { }
flickerstreak@75 329 for key, value in pairs(c.values) do
flickerstreak@75 330 table.insert(clauses, format("[%s]", ruleformats[key]))
flickerstreak@75 331 end
flickerstreak@75 332 if #clauses > 0 then
flickerstreak@75 333 table.insert(rules, format("%s %s", table.concat(clauses), state))
flickerstreak@75 334 end
flickerstreak@75 335 end
flickerstreak@75 336 elseif type == "all" then
flickerstreak@75 337 if c.values then
flickerstreak@75 338 local clauses = { }
flickerstreak@75 339 for key, value in pairs(c.values) do
flickerstreak@75 340 table.insert(clauses, ruleformats[key])
flickerstreak@75 341 end
flickerstreak@75 342 if #clauses > 0 then
flickerstreak@75 343 table.insert(rules, format("%s %s", format("[%s]", table.concat(clauses, ",")), state))
flickerstreak@75 344 end
flickerstreak@75 345 end
flickerstreak@75 346 end
flickerstreak@75 347 end
flickerstreak@75 348 -- make sure that the default, if any, is last
flickerstreak@75 349 if default then
flickerstreak@75 350 table.insert(rules, default)
flickerstreak@75 351 end
flickerstreak@90 352 return table.concat(rules,";")
flickerstreak@90 353 end
flickerstreak@90 354
flickerstreak@90 355 local function BuildKeybinds( bar, states )
flickerstreak@90 356 for name, state in pairs(states) do
flickerstreak@90 357 local type = tfetch(state, "rule", "type")
flickerstreak@90 358 if type == "keybind" then
flickerstreak@90 359 local key = tfetch(state, "rule", "keybind")
flickerstreak@90 360 SetStateKeybind(bar, key, name)
flickerstreak@90 361 else
flickerstreak@90 362 SetStateKeybind(bar, nil, name) -- this clears an existing keybind
flickerstreak@90 363 end
flickerstreak@90 364 end
flickerstreak@90 365 end
flickerstreak@90 366
flickerstreak@90 367 function GetProperty( bar, state, propname )
flickerstreak@90 368 return tfetch(module.db.profile.bars, bar:GetName(), "states", state, propname)
flickerstreak@90 369 end
flickerstreak@90 370
flickerstreak@90 371 function SetProperty( bar, state, propname, value )
flickerstreak@90 372 local s = tbuild(module.db.profile.bars, bar:GetName(), "states", state)
flickerstreak@90 373 s[propname] = value
flickerstreak@90 374 SetHandlerData(bar, propname, value, state)
flickerstreak@90 375 RefreshState(bar)
flickerstreak@90 376 end
flickerstreak@90 377
flickerstreak@90 378 function RegisterProperty( propname, snippet )
flickerstreak@90 379 properties[propname] = snippet or true
flickerstreak@90 380 print("registered property",propname)
flickerstreak@90 381 for _, bar in ReAction:IterateBars() do
flickerstreak@90 382 local states = tfetch(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@90 383 if states then
flickerstreak@90 384 for name, s in pairs(states) do
flickerstreak@90 385 SetHandlerData(bar, propname, s[propname], name)
flickerstreak@90 386 end
flickerstreak@90 387 SetStateDriver(bar, BuildRule(states))
flickerstreak@90 388 RefreshState(bar)
flickerstreak@90 389 end
flickerstreak@90 390 end
flickerstreak@90 391 end
flickerstreak@90 392
flickerstreak@90 393 function UnregisterProperty( propname )
flickerstreak@90 394 properties[propname] = nil
flickerstreak@90 395 for _, bar in ReAction:IterateBars() do
flickerstreak@90 396 SetHandlerData(bar, propname, nil)
flickerstreak@90 397 SetStateDriver(bar, BuildRule(states))
flickerstreak@90 398 RefreshState(bar)
flickerstreak@90 399 end
flickerstreak@75 400 end
flickerstreak@75 401
flickerstreak@75 402 function ApplyStates( bar )
flickerstreak@75 403 local states = tfetch(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@75 404 if states then
flickerstreak@90 405 for propname in pairs(properties) do
flickerstreak@90 406 for name, s in pairs(states) do
flickerstreak@90 407 SetHandlerData(bar, propname, s[propname], name)
flickerstreak@90 408 end
flickerstreak@75 409 end
flickerstreak@90 410 BuildKeybinds(bar, states)
flickerstreak@90 411 SetStateDriver(bar, BuildRule(states))
flickerstreak@90 412 RefreshState(bar)
flickerstreak@68 413 end
flickerstreak@68 414 end
flickerstreak@68 415
flickerstreak@90 416 function CleanupStates( bar )
flickerstreak@90 417 SetStateDriver(bar, nil)
flickerstreak@90 418 end
flickerstreak@90 419
flickerstreak@90 420 function ShowAll( bar, show )
flickerstreak@90 421 SetHandlerData(bar, "showAll", show)
flickerstreak@90 422 RefreshState(bar)
flickerstreak@90 423 end
flickerstreak@64 424 end
flickerstreak@64 425
flickerstreak@64 426
flickerstreak@68 427
flickerstreak@68 428 -- module event handlers --
flickerstreak@68 429
flickerstreak@65 430 function module:OnInitialize()
flickerstreak@65 431 self.db = ReAction.db:RegisterNamespace( moduleID,
flickerstreak@65 432 {
flickerstreak@65 433 profile = {
flickerstreak@65 434 bars = { },
flickerstreak@65 435 }
flickerstreak@65 436 }
flickerstreak@65 437 )
flickerstreak@65 438
flickerstreak@65 439 InitRules()
flickerstreak@65 440 self:RegisterEvent("PLAYER_AURAS_CHANGED")
flickerstreak@65 441
flickerstreak@65 442 ReAction:RegisterBarOptionGenerator(self, "GetBarOptions")
flickerstreak@65 443
flickerstreak@65 444 ReAction.RegisterCallback(self, "OnCreateBar","OnRefreshBar")
flickerstreak@90 445 ReAction.RegisterCallback(self, "OnDestroyBar")
flickerstreak@65 446 ReAction.RegisterCallback(self, "OnRefreshBar")
flickerstreak@65 447 ReAction.RegisterCallback(self, "OnEraseBar")
flickerstreak@65 448 ReAction.RegisterCallback(self, "OnRenameBar")
flickerstreak@65 449 ReAction.RegisterCallback(self, "OnConfigModeChanged")
flickerstreak@65 450 end
flickerstreak@65 451
flickerstreak@65 452 function module:PLAYER_AURAS_CHANGED()
flickerstreak@65 453 self:UnregisterEvent("PLAYER_AURAS_CHANGED")
flickerstreak@66 454 -- on login the number of stances is 0 until this event fires during the init sequence.
flickerstreak@90 455 -- however if you just reload the UI the number of stances is correct immediately
flickerstreak@66 456 -- and this event won't fire until you gain/lose buffs/debuffs, at which point you might
flickerstreak@66 457 -- be in combat.
flickerstreak@66 458 if not InCombatLockdown() then
flickerstreak@66 459 InitRules()
flickerstreak@66 460 for name, bar in ReAction:IterateBars() do
flickerstreak@67 461 self:OnRefreshBar(nil,bar,name)
flickerstreak@66 462 end
flickerstreak@66 463 end
flickerstreak@65 464 end
flickerstreak@65 465
flickerstreak@65 466 function module:OnRefreshBar(event, bar, name)
flickerstreak@65 467 local c = self.db.profile.bars[name]
flickerstreak@65 468 if c then
flickerstreak@68 469 ApplyStates(bar)
flickerstreak@65 470 end
flickerstreak@65 471 end
flickerstreak@65 472
flickerstreak@90 473 function module:OnDestroyBar(event, bar, name)
flickerstreak@90 474 CleanupStates(bar)
flickerstreak@90 475 end
flickerstreak@90 476
flickerstreak@65 477 function module:OnEraseBar(event, bar, name)
flickerstreak@65 478 self.db.profile.bars[name] = nil
flickerstreak@65 479 end
flickerstreak@65 480
flickerstreak@65 481 function module:OnRenameBar(event, bar, oldname, newname)
flickerstreak@75 482 local bars = self.db.profile.bars
flickerstreak@65 483 bars[newname], bars[oldname] = bars[oldname], nil
flickerstreak@65 484 end
flickerstreak@65 485
flickerstreak@65 486 function module:OnConfigModeChanged(event, mode)
flickerstreak@90 487 for name, bar in ReAction:IterateBars() do
flickerstreak@90 488 if self.db.profile.bars[name] then
flickerstreak@90 489 ShowAll(bar, mode)
flickerstreak@90 490 end
flickerstreak@90 491 end
flickerstreak@65 492 end
flickerstreak@65 493
flickerstreak@64 494
flickerstreak@64 495
flickerstreak@64 496 -- Options --
flickerstreak@64 497
flickerstreak@79 498 local CreateBarOptions, RegisterPropertyOptions
flickerstreak@62 499 do
flickerstreak@79 500 local playerClass = select(2, UnitClass("player"))
flickerstreak@62 501 local function ClassCheck(...)
flickerstreak@62 502 for i = 1, select('#',...) do
flickerstreak@79 503 if playerClass == select(i,...) then
flickerstreak@62 504 return false
flickerstreak@62 505 end
flickerstreak@62 506 end
flickerstreak@62 507 return true
flickerstreak@62 508 end
flickerstreak@62 509
flickerstreak@64 510 -- pre-sorted by the order they should appear in
flickerstreak@64 511 local rules = {
flickerstreak@64 512 -- rule hidden fields
flickerstreak@64 513 { "stance", ClassCheck("WARRIOR"), { {battle = L["Battle Stance"]}, {defensive = L["Defensive Stance"]}, {berserker = L["Berserker Stance"]} } },
flickerstreak@75 514 { "form", ClassCheck("DRUID"), { {caster = L["Caster Form"]}, {bear = L["Bear Form"]}, {cat = L["Cat Form"]}, {tree = L["Tree of Life"]}, {moonkin = L["Moonkin Form"]} } },
flickerstreak@64 515 { "stealth", ClassCheck("ROGUE","DRUID"), { {stealth = L["Stealth"]}, {nostealth = L["No Stealth"]} } },
flickerstreak@64 516 { "shadow", ClassCheck("PRIEST"), { {shadowform = L["Shadowform"]}, {noshadowform = L["No Shadowform"]} } },
flickerstreak@64 517 { "pet", ClassCheck("HUNTER","WARLOCK"), { {pet = L["With Pet"]}, {nopet = L["Without Pet"]} } },
flickerstreak@64 518 { "target", false, { {harm = L["Hostile Target"]}, {help = L["Friendly Target"]}, {notarget = L["No Target"]} } },
flickerstreak@64 519 { "focus", false, { {focusharm = L["Hostile Focus"]}, {focushelp = L["Friendly Focus"]}, {nofocus = L["No Focus"]} } },
flickerstreak@75 520 { "possess", false, { {possess = L["Mind Control"]} } },
flickerstreak@64 521 { "group", false, { {raid = L["Raid"]}, {party = L["Party"]}, {solo = L["Solo"]} } },
flickerstreak@64 522 { "combat", false, { {combat = L["In Combat"]}, {nocombat = L["Out of Combat"]} } },
flickerstreak@62 523 }
flickerstreak@62 524
flickerstreak@64 525 local ruleSelect = { }
flickerstreak@64 526 local ruleMap = { }
flickerstreak@64 527 local optionMap = setmetatable({},{__mode="k"})
flickerstreak@62 528
flickerstreak@68 529 local pointTable = {
flickerstreak@68 530 NONE = " ",
flickerstreak@68 531 CENTER = L["Center"],
flickerstreak@68 532 LEFT = L["Left"],
flickerstreak@68 533 RIGHT = L["Right"],
flickerstreak@68 534 TOP = L["Top"],
flickerstreak@68 535 BOTTOM = L["Bottom"],
flickerstreak@68 536 TOPLEFT = L["Top Left"],
flickerstreak@68 537 TOPRIGHT = L["Top Right"],
flickerstreak@68 538 BOTTOMLEFT = L["Bottom Left"],
flickerstreak@68 539 BOTTOMRIGHT = L["Bottom Right"],
flickerstreak@68 540 }
flickerstreak@68 541
flickerstreak@64 542 -- unpack rules table into ruleSelect and ruleMap
flickerstreak@64 543 for _, c in ipairs(rules) do
flickerstreak@64 544 local rule, hidden, fields = unpack(c)
flickerstreak@64 545 if not hidden then
flickerstreak@64 546 for _, field in ipairs(fields) do
flickerstreak@64 547 local key, label = next(field)
flickerstreak@64 548 table.insert(ruleSelect, label)
flickerstreak@64 549 table.insert(ruleMap, key)
flickerstreak@62 550 end
flickerstreak@62 551 end
flickerstreak@62 552 end
flickerstreak@62 553
flickerstreak@79 554 local stateOptions = {
flickerstreak@79 555 ordering = {
flickerstreak@79 556 name = L["Info"],
flickerstreak@79 557 order = 1,
flickerstreak@79 558 type = "group",
flickerstreak@79 559 args = {
flickerstreak@79 560 delete = {
flickerstreak@79 561 name = L["Delete this State"],
flickerstreak@79 562 order = -1,
flickerstreak@79 563 type = "execute",
flickerstreak@79 564 func = "DeleteState",
flickerstreak@79 565 },
flickerstreak@79 566 rename = {
flickerstreak@79 567 name = L["Name"],
flickerstreak@79 568 order = 1,
flickerstreak@79 569 type = "input",
flickerstreak@79 570 get = "GetName",
flickerstreak@79 571 set = "SetStateName",
flickerstreak@79 572 pattern = "^%w*$",
flickerstreak@79 573 usage = L["State names must be alphanumeric without spaces"],
flickerstreak@79 574 },
flickerstreak@79 575 ordering = {
flickerstreak@79 576 name = L["Evaluation Order"],
flickerstreak@79 577 desc = L["State transitions are evaluated in the order listed:\nMove a state up or down to change the order"],
flickerstreak@79 578 order = 2,
flickerstreak@79 579 type = "group",
flickerstreak@79 580 inline = true,
flickerstreak@79 581 args = {
flickerstreak@79 582 up = {
flickerstreak@79 583 name = L["Up"],
flickerstreak@79 584 order = 1,
flickerstreak@79 585 type = "execute",
flickerstreak@79 586 width = "half",
flickerstreak@79 587 func = "MoveStateUp",
flickerstreak@79 588 },
flickerstreak@79 589 down = {
flickerstreak@79 590 name = L["Down"],
flickerstreak@79 591 order = 2,
flickerstreak@79 592 type = "execute",
flickerstreak@79 593 width = "half",
flickerstreak@79 594 func = "MoveStateDown",
flickerstreak@79 595 }
flickerstreak@79 596 }
flickerstreak@79 597 }
flickerstreak@79 598 }
flickerstreak@79 599 },
flickerstreak@79 600 properties = {
flickerstreak@79 601 name = L["Properties"],
flickerstreak@79 602 order = 2,
flickerstreak@79 603 type = "group",
flickerstreak@79 604 args = {
flickerstreak@79 605 desc = {
flickerstreak@79 606 name = L["Set the properties for the bar when in this state"],
flickerstreak@79 607 order = 1,
flickerstreak@79 608 type = "description"
flickerstreak@79 609 },
flickerstreak@79 610 hide = {
flickerstreak@79 611 name = L["Hide Bar"],
flickerstreak@81 612 order = 90,
flickerstreak@79 613 type = "toggle",
flickerstreak@79 614 set = "SetProp",
flickerstreak@79 615 get = "GetProp",
flickerstreak@79 616 },
flickerstreak@90 617 --[[ BROKEN
flickerstreak@90 618 keybindState = {
flickerstreak@79 619 name = L["Override Keybinds"],
flickerstreak@79 620 desc = L["Set this state to maintain its own set of keybinds which override the defaults when active"],
flickerstreak@81 621 order = 91,
flickerstreak@79 622 type = "toggle",
flickerstreak@79 623 set = "SetProp",
flickerstreak@79 624 get = "GetProp",
flickerstreak@90 625 }, ]]
flickerstreak@79 626 position = {
flickerstreak@79 627 name = L["Position"],
flickerstreak@81 628 order = 92,
flickerstreak@79 629 type = "group",
flickerstreak@79 630 inline = true,
flickerstreak@79 631 args = {
flickerstreak@90 632 anchorEnable = {
flickerstreak@79 633 name = L["Set New Position"],
flickerstreak@79 634 order = 1,
flickerstreak@79 635 type = "toggle",
flickerstreak@79 636 set = "SetProp",
flickerstreak@79 637 get = "GetProp",
flickerstreak@79 638 },
flickerstreak@90 639 --[[ TODO: broken
flickerstreak@90 640 anchorFrame = {
flickerstreak@90 641 name = L["Anchor Frame"],
flickerstreak@90 642 order = 2,
flickerstreak@90 643 type = "select",
flickerstreak@90 644 values = "GetAnchorFrames",
flickerstreak@90 645 set = ???
flickerstreak@90 646 get = ???
flickerstreak@90 647 }, ]]
flickerstreak@79 648 anchorPoint = {
flickerstreak@79 649 name = L["Point"],
flickerstreak@90 650 order = 3,
flickerstreak@79 651 type = "select",
flickerstreak@79 652 values = pointTable,
flickerstreak@79 653 set = "SetAnchorPointProp",
flickerstreak@79 654 get = "GetAnchorPointProp",
flickerstreak@79 655 disabled = "GetAnchorDisabled",
flickerstreak@79 656 hidden = "GetAnchorDisabled",
flickerstreak@79 657 },
flickerstreak@79 658 anchorRelPoint = {
flickerstreak@79 659 name = L["Relative Point"],
flickerstreak@90 660 order = 4,
flickerstreak@79 661 type = "select",
flickerstreak@79 662 values = pointTable,
flickerstreak@79 663 set = "SetAnchorPointProp",
flickerstreak@79 664 get = "GetAnchorPointProp",
flickerstreak@79 665 disabled = "GetAnchorDisabled",
flickerstreak@79 666 hidden = "GetAnchorDisabled",
flickerstreak@79 667 },
flickerstreak@79 668 anchorX = {
flickerstreak@79 669 name = L["X Offset"],
flickerstreak@90 670 order = 5,
flickerstreak@79 671 type = "range",
flickerstreak@79 672 min = -100,
flickerstreak@79 673 max = 100,
flickerstreak@79 674 step = 1,
flickerstreak@79 675 set = "SetProp",
flickerstreak@79 676 get = "GetProp",
flickerstreak@79 677 disabled = "GetAnchorDisabled",
flickerstreak@79 678 hidden = "GetAnchorDisabled",
flickerstreak@79 679 },
flickerstreak@79 680 anchorY = {
flickerstreak@79 681 name = L["Y Offset"],
flickerstreak@90 682 order = 6,
flickerstreak@79 683 type = "range",
flickerstreak@79 684 min = -100,
flickerstreak@79 685 max = 100,
flickerstreak@79 686 step = 1,
flickerstreak@79 687 set = "SetProp",
flickerstreak@79 688 get = "GetProp",
flickerstreak@79 689 disabled = "GetAnchorDisabled",
flickerstreak@79 690 hidden = "GetAnchorDisabled",
flickerstreak@79 691 },
flickerstreak@79 692 },
flickerstreak@79 693 },
flickerstreak@79 694 scale = {
flickerstreak@79 695 name = L["Scale"],
flickerstreak@81 696 order = 93,
flickerstreak@79 697 type = "group",
flickerstreak@79 698 inline = true,
flickerstreak@79 699 args = {
flickerstreak@79 700 enableScale = {
flickerstreak@79 701 name = L["Set New Scale"],
flickerstreak@79 702 order = 1,
flickerstreak@79 703 type = "toggle",
flickerstreak@79 704 set = "SetProp",
flickerstreak@79 705 get = "GetProp",
flickerstreak@79 706 },
flickerstreak@79 707 scale = {
flickerstreak@79 708 name = L["Scale"],
flickerstreak@79 709 order = 2,
flickerstreak@79 710 type = "range",
flickerstreak@79 711 min = 0.1,
flickerstreak@79 712 max = 2.5,
flickerstreak@79 713 step = 0.05,
flickerstreak@79 714 isPercent = true,
flickerstreak@79 715 set = "SetProp",
flickerstreak@79 716 get = "GetProp",
flickerstreak@79 717 disabled = "GetScaleDisabled",
flickerstreak@79 718 hidden = "GetScaleDisabled",
flickerstreak@79 719 },
flickerstreak@79 720 },
flickerstreak@79 721 },
flickerstreak@79 722 },
flickerstreak@79 723 plugins = { }
flickerstreak@79 724 },
flickerstreak@79 725 rules = {
flickerstreak@79 726 name = L["Rule"],
flickerstreak@79 727 order = 3,
flickerstreak@79 728 type = "group",
flickerstreak@79 729 args = {
flickerstreak@79 730 mode = {
flickerstreak@79 731 name = L["Select this state"],
flickerstreak@79 732 order = 2,
flickerstreak@79 733 type = "select",
flickerstreak@79 734 style = "radio",
flickerstreak@79 735 values = {
flickerstreak@79 736 default = L["by default"],
flickerstreak@79 737 any = L["when ANY of these"],
flickerstreak@79 738 all = L["when ALL of these"],
flickerstreak@79 739 custom = L["via custom rule"],
flickerstreak@79 740 keybind = L["via keybinding"],
flickerstreak@79 741 },
flickerstreak@79 742 set = "SetType",
flickerstreak@79 743 get = "GetType",
flickerstreak@79 744 },
flickerstreak@79 745 clear = {
flickerstreak@79 746 name = L["Clear All"],
flickerstreak@79 747 order = 3,
flickerstreak@79 748 type = "execute",
flickerstreak@79 749 hidden = "GetClearAllDisabled",
flickerstreak@79 750 disabled = "GetClearAllDisabled",
flickerstreak@79 751 func = "ClearAllConditions",
flickerstreak@79 752 },
flickerstreak@79 753 inputs = {
flickerstreak@79 754 name = L["Conditions"],
flickerstreak@79 755 order = 4,
flickerstreak@79 756 type = "multiselect",
flickerstreak@79 757 hidden = "GetConditionsDisabled",
flickerstreak@79 758 disabled = "GetConditionsDisabled",
flickerstreak@79 759 values = ruleSelect,
flickerstreak@79 760 set = "SetCondition",
flickerstreak@79 761 get = "GetCondition",
flickerstreak@79 762 },
flickerstreak@79 763 custom = {
flickerstreak@79 764 name = L["Custom Rule"],
flickerstreak@79 765 order = 5,
flickerstreak@79 766 type = "input",
flickerstreak@79 767 multiline = true,
flickerstreak@79 768 hidden = "GetCustomDisabled",
flickerstreak@79 769 disabled = "GetCustomDisabled",
flickerstreak@79 770 desc = L["Syntax like macro rules: see preset rules for examples"],
flickerstreak@79 771 set = "SetCustomRule",
flickerstreak@79 772 get = "GetCustomRule",
flickerstreak@79 773 validate = "ValidateCustomRule",
flickerstreak@79 774 },
flickerstreak@79 775 keybind = {
flickerstreak@79 776 name = L["Keybinding"],
flickerstreak@79 777 order = 6,
flickerstreak@79 778 inline = true,
flickerstreak@79 779 hidden = "GetKeybindDisabled",
flickerstreak@79 780 disabled = "GetKeybindDisabled",
flickerstreak@79 781 type = "group",
flickerstreak@79 782 args = {
flickerstreak@79 783 desc = {
flickerstreak@79 784 name = L["Invoking a state keybind toggles an override of all other transition rules."],
flickerstreak@79 785 order = 1,
flickerstreak@79 786 type = "description",
flickerstreak@79 787 },
flickerstreak@79 788 keybind = {
flickerstreak@79 789 name = L["State Hotkey"],
flickerstreak@79 790 desc = L["Define an override toggle keybind"],
flickerstreak@79 791 order = 2,
flickerstreak@79 792 type = "keybinding",
flickerstreak@79 793 set = "SetKeybind",
flickerstreak@79 794 get = "GetKeybind",
flickerstreak@79 795 },
flickerstreak@79 796 },
flickerstreak@79 797 },
flickerstreak@79 798 },
flickerstreak@79 799 },
flickerstreak@79 800 }
flickerstreak@79 801
flickerstreak@90 802 local handlers = { }
flickerstreak@90 803 local meta = {
flickerstreak@90 804 __index = function(self, key)
flickerstreak@90 805 for _, h in pairs(handlers) do
flickerstreak@90 806 if h[key] then
flickerstreak@90 807 return h[key]
flickerstreak@90 808 end
flickerstreak@90 809 end
flickerstreak@90 810 end,
flickerstreak@90 811 }
flickerstreak@90 812 local StateHandler = setmetatable({ }, meta)
flickerstreak@90 813 local proto = { __index = StateHandler }
flickerstreak@90 814
flickerstreak@90 815 function RegisterPropertyOptions( field, options, handler )
flickerstreak@90 816 stateOptions.properties.plugins[field] = options
flickerstreak@90 817 handlers[field] = handler
flickerstreak@90 818 end
flickerstreak@90 819
flickerstreak@90 820 function UnregisterPropertyOptions( field )
flickerstreak@90 821 stateOptions.properties.plugins[field] = nil
flickerstreak@90 822 handlers[field] = nil
flickerstreak@90 823 end
flickerstreak@79 824
flickerstreak@79 825 function StateHandler:New( bar, opts )
flickerstreak@90 826 local self = setmetatable(
flickerstreak@90 827 {
flickerstreak@90 828 bar = bar
flickerstreak@90 829 },
flickerstreak@90 830 proto )
flickerstreak@79 831
flickerstreak@79 832 function self:GetName()
flickerstreak@79 833 return opts.name
flickerstreak@79 834 end
flickerstreak@79 835
flickerstreak@79 836 function self:SetName(name)
flickerstreak@79 837 opts.name = name
flickerstreak@79 838 end
flickerstreak@79 839
flickerstreak@79 840 function self:GetOrder()
flickerstreak@79 841 return opts.order
flickerstreak@79 842 end
flickerstreak@79 843
flickerstreak@79 844 -- get reference to states table: even if the bar
flickerstreak@79 845 -- name changes the states table ref won't
flickerstreak@79 846 self.states = tbuild(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@90 847 self.state = tbuild(self.states, opts.name)
flickerstreak@79 848
flickerstreak@90 849 opts.order = self:GetRuleField("order")
flickerstreak@79 850 if opts.order == nil then
flickerstreak@79 851 -- add after the highest
flickerstreak@79 852 opts.order = 100
flickerstreak@79 853 for _, state in pairs(self.states) do
flickerstreak@79 854 local x = tonumber(tfetch(state, "rule", "order"))
flickerstreak@79 855 if x and x >= opts.order then
flickerstreak@79 856 opts.order = x + 1
flickerstreak@79 857 end
flickerstreak@79 858 end
flickerstreak@90 859 self:SetRuleField("order",opts.order)
flickerstreak@79 860 end
flickerstreak@79 861
flickerstreak@79 862 return self
flickerstreak@79 863 end
flickerstreak@79 864
flickerstreak@79 865 -- helper methods
flickerstreak@79 866
flickerstreak@90 867 function StateHandler:SetRuleField( key, value, ... )
flickerstreak@90 868 tbuild(self.state, "rule", ...)[key] = value
flickerstreak@79 869 end
flickerstreak@79 870
flickerstreak@90 871 function StateHandler:GetRuleField( ... )
flickerstreak@90 872 return tfetch(self.state, "rule", ...)
flickerstreak@79 873 end
flickerstreak@79 874
flickerstreak@79 875 function StateHandler:FixAll( setkey )
flickerstreak@79 876 -- if multiple selections in the same group are chosen when 'all' is selected,
flickerstreak@79 877 -- keep only one of them. If changing the mode, the first in the fields list will
flickerstreak@79 878 -- be chosen arbitrarily. Otherwise, if selecting a new checkbox from the field-set,
flickerstreak@79 879 -- it will be retained.
flickerstreak@79 880 local notified = false
flickerstreak@90 881 if self:GetRuleField("type") == "all" then
flickerstreak@79 882 for _, c in ipairs(rules) do
flickerstreak@79 883 local rule, hidden, fields = unpack(c)
flickerstreak@79 884 local once = false
flickerstreak@79 885 if setkey then
flickerstreak@79 886 for idx, field in ipairs(fields) do
flickerstreak@79 887 if next(field) == setkey then
flickerstreak@79 888 once = true
flickerstreak@79 889 end
flickerstreak@79 890 end
flickerstreak@79 891 end
flickerstreak@79 892 for idx, field in ipairs(fields) do
flickerstreak@79 893 local key = next(field)
flickerstreak@90 894 if self:GetRuleField("values",key) then
flickerstreak@79 895 if once and key ~= setkey then
flickerstreak@90 896 self:SetRuleField(key,false,"values")
flickerstreak@79 897 if not setkey and not notified then
flickerstreak@79 898 ReAction:UserError(L["Warning: one or more incompatible rules were turned off"])
flickerstreak@79 899 notified = true
flickerstreak@79 900 end
flickerstreak@79 901 end
flickerstreak@79 902 once = true
flickerstreak@79 903 end
flickerstreak@79 904 end
flickerstreak@79 905 end
flickerstreak@79 906 end
flickerstreak@79 907 end
flickerstreak@79 908
flickerstreak@79 909 function StateHandler:GetNeighbors()
flickerstreak@79 910 local before, after
flickerstreak@79 911 for k, v in pairs(self.states) do
flickerstreak@79 912 local o = tonumber(tfetch(v, "rule", "order"))
flickerstreak@79 913 if o and k ~= self:GetName() then
flickerstreak@79 914 local obefore = tfetch(self.states,before,"rule","order")
flickerstreak@79 915 local oafter = tfetch(self.states,after,"rule","order")
flickerstreak@79 916 if o < self:GetOrder() and (not obefore or obefore < o) then
flickerstreak@79 917 before = k
flickerstreak@79 918 end
flickerstreak@79 919 if o > self:GetOrder() and (not oafter or oafter > o) then
flickerstreak@79 920 after = k
flickerstreak@79 921 end
flickerstreak@79 922 end
flickerstreak@79 923 end
flickerstreak@79 924 return before, after
flickerstreak@79 925 end
flickerstreak@79 926
flickerstreak@79 927 function StateHandler:SwapOrder( a, b )
flickerstreak@79 928 -- do options table
flickerstreak@79 929 local args = optionMap[self.bar].args
flickerstreak@79 930 args[a].order, args[b].order = args[b].order, args[a].order
flickerstreak@79 931 -- do profile
flickerstreak@79 932 a = tbuild(self.states, a, "rule")
flickerstreak@79 933 b = tbuild(self.states, b, "rule")
flickerstreak@79 934 a.order, b.order = b.order, a.order
flickerstreak@79 935 end
flickerstreak@79 936
flickerstreak@79 937 -- handler methods
flickerstreak@79 938
flickerstreak@79 939 function StateHandler:GetProp( info )
flickerstreak@79 940 -- gets property of the same name as the options arg
flickerstreak@79 941 return GetProperty(self.bar, self:GetName(), info[#info])
flickerstreak@79 942 end
flickerstreak@79 943
flickerstreak@79 944 function StateHandler:SetProp( info, value )
flickerstreak@79 945 -- sets property of the same name as the options arg
flickerstreak@79 946 SetProperty(self.bar, self:GetName(), info[#info], value)
flickerstreak@79 947 end
flickerstreak@79 948
flickerstreak@79 949 function StateHandler:DeleteState()
flickerstreak@79 950 if self.states[self:GetName()] then
flickerstreak@79 951 self.states[self:GetName()] = nil
flickerstreak@79 952 ApplyStates(self.bar)
flickerstreak@79 953 end
flickerstreak@79 954 optionMap[self.bar].args[self:GetName()] = nil
flickerstreak@79 955 end
flickerstreak@79 956
flickerstreak@79 957 function StateHandler:SetStateName(info, value)
flickerstreak@79 958 -- check for existing state name
flickerstreak@79 959 if self.states[value] then
flickerstreak@79 960 ReAction:UserError(format(L["State named '%s' already exists"],value))
flickerstreak@79 961 return
flickerstreak@79 962 end
flickerstreak@79 963 local args = optionMap[self.bar].args
flickerstreak@79 964 local name = self:GetName()
flickerstreak@79 965 self.states[value], args[value], self.states[name], args[name] = self.states[name], args[name], nil, nil
flickerstreak@79 966 self:SetName(value)
flickerstreak@79 967 ApplyStates(self.bar)
flickerstreak@83 968 ReAction:ShowEditor(self.bar, moduleID, value)
flickerstreak@83 969 end
flickerstreak@79 970
flickerstreak@79 971 function StateHandler:MoveStateUp()
flickerstreak@79 972 local before, after = self:GetNeighbors()
flickerstreak@79 973 if before then
flickerstreak@79 974 self:SwapOrder(before, self:GetName())
flickerstreak@79 975 ApplyStates(self.bar)
flickerstreak@79 976 end
flickerstreak@79 977 end
flickerstreak@79 978
flickerstreak@79 979 function StateHandler:MoveStateDown()
flickerstreak@79 980 local before, after = self:GetNeighbors()
flickerstreak@79 981 if after then
flickerstreak@79 982 self:SwapOrder(self:GetName(), after)
flickerstreak@79 983 ApplyStates(self.bar)
flickerstreak@79 984 end
flickerstreak@79 985 end
flickerstreak@79 986
flickerstreak@79 987 function StateHandler:GetAnchorDisabled()
flickerstreak@79 988 return not GetProperty(self.bar, self:GetName(), "enableAnchor")
flickerstreak@79 989 end
flickerstreak@79 990
flickerstreak@79 991 function StateHandler:SetAnchorPointProp(info, value)
flickerstreak@79 992 self:SetProp(info, value ~= "NONE" and value or nil)
flickerstreak@79 993 end
flickerstreak@79 994
flickerstreak@79 995 function StateHandler:GetAnchorPointProp(info)
flickerstreak@79 996 return self:GetProp(info) or "NONE"
flickerstreak@79 997 end
flickerstreak@79 998
flickerstreak@79 999 function StateHandler:GetScaleDisabled()
flickerstreak@79 1000 return not GetProperty(self.bar, self:GetName(), "enableScale")
flickerstreak@79 1001 end
flickerstreak@79 1002
flickerstreak@79 1003 function StateHandler:SetType(info, value)
flickerstreak@90 1004 self:SetRuleField("type", value)
flickerstreak@79 1005 self:FixAll()
flickerstreak@79 1006 ApplyStates(self.bar)
flickerstreak@79 1007 end
flickerstreak@79 1008
flickerstreak@79 1009 function StateHandler:GetType()
flickerstreak@90 1010 return self:GetRuleField("type")
flickerstreak@79 1011 end
flickerstreak@79 1012
flickerstreak@79 1013 function StateHandler:GetClearAllDisabled()
flickerstreak@90 1014 local t = self:GetRuleField("type")
flickerstreak@79 1015 return not( t == "any" or t == "all" or t == "custom")
flickerstreak@79 1016 end
flickerstreak@79 1017
flickerstreak@79 1018 function StateHandler:ClearAllConditions()
flickerstreak@90 1019 local t = self:GetRuleField("type")
flickerstreak@79 1020 if t == "custom" then
flickerstreak@90 1021 self:SetRuleField("custom","")
flickerstreak@79 1022 elseif t == "any" or t == "all" then
flickerstreak@90 1023 self:SetRuleField("values", {})
flickerstreak@79 1024 end
flickerstreak@79 1025 ApplyStates(self.bar)
flickerstreak@79 1026 end
flickerstreak@79 1027
flickerstreak@79 1028 function StateHandler:GetConditionsDisabled()
flickerstreak@90 1029 local t = self:GetRuleField("type")
flickerstreak@79 1030 return not( t == "any" or t == "all")
flickerstreak@79 1031 end
flickerstreak@79 1032
flickerstreak@79 1033 function StateHandler:SetCondition(info, key, value)
flickerstreak@90 1034 self:SetRuleField(ruleMap[key], value or nil, "values")
flickerstreak@79 1035 if value then
flickerstreak@79 1036 self:FixAll(ruleMap[key])
flickerstreak@79 1037 end
flickerstreak@79 1038 ApplyStates(self.bar)
flickerstreak@79 1039 end
flickerstreak@79 1040
flickerstreak@79 1041 function StateHandler:GetCondition(info, key)
flickerstreak@90 1042 return self:GetRuleField("values", ruleMap[key]) or false
flickerstreak@79 1043 end
flickerstreak@79 1044
flickerstreak@79 1045 function StateHandler:GetCustomDisabled()
flickerstreak@90 1046 return self:GetRuleField("type") ~= "custom"
flickerstreak@79 1047 end
flickerstreak@79 1048
flickerstreak@79 1049 function StateHandler:SetCustomRule(info, value)
flickerstreak@90 1050 self:SetRuleField("custom",value)
flickerstreak@79 1051 ApplyStates(self.bar)
flickerstreak@79 1052 end
flickerstreak@79 1053
flickerstreak@79 1054 function StateHandler:GetCustomRule()
flickerstreak@90 1055 return self:GetRuleField("custom") or ""
flickerstreak@79 1056 end
flickerstreak@79 1057
flickerstreak@79 1058 function StateHandler:ValidateCustomRule(info, value)
flickerstreak@79 1059 local s = value:gsub("%s","") -- remove all spaces
flickerstreak@79 1060 -- unfortunately %b and captures don't support the '+' notation, or this would be considerably simpler
flickerstreak@79 1061 repeat
flickerstreak@79 1062 if s == "" then
flickerstreak@79 1063 return true
flickerstreak@79 1064 end
flickerstreak@79 1065 local c, r = s:match("(%b[])(.*)")
flickerstreak@79 1066 if c == nil and s and #s > 0 then
flickerstreak@79 1067 return format(L["Invalid custom rule '%s': each clause must appear within [brackets]"],value or "")
flickerstreak@79 1068 end
flickerstreak@79 1069 s = r
flickerstreak@79 1070 until c == nil
flickerstreak@79 1071 return true
flickerstreak@79 1072 end
flickerstreak@79 1073
flickerstreak@79 1074 function StateHandler:GetKeybindDisabled()
flickerstreak@90 1075 return self:GetRuleField("type") ~= "keybind"
flickerstreak@79 1076 end
flickerstreak@79 1077
flickerstreak@79 1078 function StateHandler:GetKeybind()
flickerstreak@90 1079 return self:GetRuleField("keybind")
flickerstreak@79 1080 end
flickerstreak@79 1081
flickerstreak@79 1082 function StateHandler:SetKeybind(info, value)
flickerstreak@79 1083 if value and #value == 0 then
flickerstreak@79 1084 value = nil
flickerstreak@79 1085 end
flickerstreak@90 1086 self:SetRuleField("keybind",value)
flickerstreak@79 1087 ApplyStates(self.bar)
flickerstreak@79 1088 end
flickerstreak@79 1089
flickerstreak@62 1090 local function CreateStateOptions(bar, name)
flickerstreak@62 1091 local opts = {
flickerstreak@62 1092 type = "group",
flickerstreak@62 1093 name = name,
flickerstreak@64 1094 childGroups = "tab",
flickerstreak@79 1095 args = stateOptions
flickerstreak@25 1096 }
flickerstreak@62 1097
flickerstreak@79 1098 opts.handler = StateHandler:New(bar,opts)
flickerstreak@64 1099
flickerstreak@62 1100 return opts
flickerstreak@25 1101 end
flickerstreak@62 1102
flickerstreak@79 1103 function module:GetBarOptions(bar)
flickerstreak@62 1104 local private = { }
flickerstreak@75 1105 local states = tbuild(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@62 1106 local options = {
flickerstreak@77 1107 name = L["Dynamic State"],
flickerstreak@62 1108 type = "group",
flickerstreak@77 1109 order = -1,
flickerstreak@64 1110 childGroups = "tree",
flickerstreak@62 1111 disabled = InCombatLockdown,
flickerstreak@62 1112 args = {
flickerstreak@64 1113 __desc__ = {
flickerstreak@68 1114 name = L["States are evaluated in the order they are listed"],
flickerstreak@68 1115 order = 1,
flickerstreak@64 1116 type = "description",
flickerstreak@64 1117 },
flickerstreak@64 1118 __new__ = {
flickerstreak@64 1119 name = L["New State..."],
flickerstreak@64 1120 order = 2,
flickerstreak@68 1121 type = "group",
flickerstreak@62 1122 args = {
flickerstreak@64 1123 name = {
flickerstreak@64 1124 name = L["State Name"],
flickerstreak@64 1125 desc = L["Set a name for the new state"],
flickerstreak@68 1126 order = 1,
flickerstreak@68 1127 type = "input",
flickerstreak@64 1128 get = function() return private.newstatename or "" end,
flickerstreak@64 1129 set = function(info,value) private.newstatename = value end,
flickerstreak@64 1130 pattern = "^%w*$",
flickerstreak@64 1131 usage = L["State names must be alphanumeric without spaces"],
flickerstreak@64 1132 },
flickerstreak@64 1133 create = {
flickerstreak@68 1134 name = L["Create State"],
flickerstreak@68 1135 order = 2,
flickerstreak@64 1136 type = "execute",
flickerstreak@64 1137 func = function ()
flickerstreak@64 1138 local name = private.newstatename
flickerstreak@68 1139 if states[name] then
flickerstreak@75 1140 ReAction:UserError(format(L["State named '%s' already exists"],name))
flickerstreak@68 1141 else
flickerstreak@68 1142 -- TODO: select default state options and pass as final argument
flickerstreak@68 1143 states[name] = { }
flickerstreak@68 1144 optionMap[bar].args[name] = CreateStateOptions(bar,name)
flickerstreak@81 1145 ReAction:ShowEditor(bar, moduleID, name)
flickerstreak@68 1146 private.newstatename = ""
flickerstreak@68 1147 end
flickerstreak@64 1148 end,
flickerstreak@64 1149 disabled = function()
flickerstreak@64 1150 local name = private.newstatename or ""
flickerstreak@64 1151 return #name == 0 or name:find("%W")
flickerstreak@64 1152 end,
flickerstreak@62 1153 }
flickerstreak@62 1154 }
flickerstreak@64 1155 }
flickerstreak@62 1156 }
flickerstreak@62 1157 }
flickerstreak@79 1158 for name, config in pairs(states) do
flickerstreak@79 1159 options.args[name] = CreateStateOptions(bar,name)
flickerstreak@62 1160 end
flickerstreak@64 1161 optionMap[bar] = options
flickerstreak@62 1162 return options
flickerstreak@62 1163 end
flickerstreak@25 1164 end
flickerstreak@25 1165
flickerstreak@79 1166 -- Module API --
flickerstreak@79 1167
flickerstreak@90 1168 -- Pass in a property field-name, an implementation secure snippet, a static options table, and an
flickerstreak@79 1169 -- optional options handler method-table
flickerstreak@79 1170 --
flickerstreak@79 1171 -- The options table is static, i.e. not bar-specific and should only reference handler method
flickerstreak@79 1172 -- strings (either existing ones or those added via optHandler). The existing options are ordered
flickerstreak@81 1173 -- 90-99. Order #1 is reserved for the heading.
flickerstreak@79 1174 --
flickerstreak@90 1175 -- The contents of optHandler, if provided, will be added to the existing StateHandler options metatable.
flickerstreak@79 1176 -- See above, for existing API. In particular see the properties set up in the New method: self.bar,
flickerstreak@79 1177 -- self.states, and self:GetName(), and the generic property handlers self:GetProp() and self:SetProp().
flickerstreak@79 1178 --
flickerstreak@90 1179 function module:RegisterStateProperty( field, snippetHandler, options, optHandler )
flickerstreak@90 1180 RegisterProperty(field, snippetHandler)
flickerstreak@79 1181 RegisterPropertyOptions(field, options, optHandler)
flickerstreak@25 1182 end
flickerstreak@79 1183
flickerstreak@90 1184 function module:UnregisterStateProperty( field )
flickerstreak@90 1185 UnregisterProperty(field)
flickerstreak@90 1186 UnregisterPropertyOptions(field)
flickerstreak@90 1187 end