Mercurial > wow > reaction

annotate State.lua @ 95:168cae4aa8bd

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