annotate State.lua @ 94:39265b16d208

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