Mercurial > wow > reaction

annotate modules/State.lua @ 157:e77f716af1b7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Pushed state rule logic from State.lua to Bar.lua
author Flick <flickerstreak@gmail.com>
date Fri, 12 Jun 2009 21:44:44 +0000
parents 806a61b331a0
children 8cc187143acd
rev   line source
flickerstreak@109 1 --[[
flickerstreak@109 2 ReAction bar state driver interface
flickerstreak@109 3
flickerstreak@109 4 --]]
flickerstreak@109 5
flickerstreak@109 6 -- local imports
flickerstreak@109 7 local ReAction = ReAction
flickerstreak@109 8 local L = ReAction.L
flickerstreak@109 9 local _G = _G
flickerstreak@109 10 local format = string.format
flickerstreak@109 11 local InCombatLockdown = InCombatLockdown
flickerstreak@109 12 local RegisterStateDriver = RegisterStateDriver
flickerstreak@109 13
flickerstreak@109 14 ReAction:UpdateRevision("$Revision$")
flickerstreak@109 15
flickerstreak@109 16 -- module declaration
flickerstreak@109 17 local moduleID = "State"
flickerstreak@109 18 local module = ReAction:NewModule( moduleID, "AceEvent-3.0" )
flickerstreak@109 19
flickerstreak@109 20 -- Utility --
flickerstreak@109 21
flickerstreak@109 22 -- traverse a table tree by key list and fetch the result or first nil
flickerstreak@109 23 local function tfetch(t, ...)
flickerstreak@109 24 for i = 1, select('#', ...) do
flickerstreak@109 25 t = t and t[select(i, ...)]
flickerstreak@109 26 end
flickerstreak@109 27 return t
flickerstreak@109 28 end
flickerstreak@109 29
flickerstreak@109 30 -- traverse a table tree by key list and build tree as necessary
flickerstreak@109 31 local function tbuild(t, ...)
flickerstreak@109 32 for i = 1, select('#', ...) do
flickerstreak@109 33 local key = select(i, ...)
flickerstreak@109 34 if not t[key] then t[key] = { } end
flickerstreak@109 35 t = t[key]
flickerstreak@109 36 end
flickerstreak@109 37 return t
flickerstreak@109 38 end
flickerstreak@109 39
flickerstreak@109 40 -- return a new array of keys of table 't', sorted by comparing
flickerstreak@109 41 -- sub-fields (obtained via tfetch) of the table values
flickerstreak@109 42 local function fieldsort( t, ... )
flickerstreak@109 43 local r = { }
flickerstreak@109 44 for k in pairs(t) do
flickerstreak@109 45 table.insert(r,k)
flickerstreak@109 46 end
flickerstreak@109 47 local path = { ... }
flickerstreak@109 48 table.sort(r, function(lhs, rhs)
flickerstreak@109 49 local olhs = tfetch(t[lhs], unpack(path)) or 0
flickerstreak@109 50 local orhs = tfetch(t[rhs], unpack(path)) or 0
flickerstreak@109 51 return olhs < orhs
flickerstreak@109 52 end)
flickerstreak@109 53 return r
flickerstreak@109 54 end
flickerstreak@109 55
flickerstreak@109 56
flickerstreak@157 57 local ApplyStates, CleanupStates, SetProperty, GetProperty, RegisterProperty
flickerstreak@109 58
flickerstreak@109 59 -- PRIVATE --
flickerstreak@109 60 do
flickerstreak@109 61 function GetProperty( bar, state, propname )
flickerstreak@109 62 return tfetch(module.db.profile.bars, bar:GetName(), "states", state, propname)
flickerstreak@109 63 end
flickerstreak@109 64
flickerstreak@109 65 function SetProperty( bar, state, propname, value )
flickerstreak@109 66 local s = tbuild(module.db.profile.bars, bar:GetName(), "states", state)
flickerstreak@109 67 s[propname] = value
flickerstreak@155 68 bar:SetSecureStateData(state, propname, value)
flickerstreak@109 69 end
flickerstreak@109 70
flickerstreak@109 71 function RegisterProperty( propname, snippet )
flickerstreak@109 72 for _, bar in ReAction:IterateBars() do
flickerstreak@155 73 if type(snippet) == "string" then
flickerstreak@155 74 bar:SetSecureStateExtension(propname,snippet)
flickerstreak@109 75 end
flickerstreak@157 76 ApplyStates(bar)
flickerstreak@109 77 end
flickerstreak@109 78 end
flickerstreak@109 79
flickerstreak@109 80 function UnregisterProperty( propname )
flickerstreak@109 81 for _, bar in ReAction:IterateBars() do
flickerstreak@155 82 bar:SetSecureStateExtension(propname,nil)
flickerstreak@157 83 ApplyStates(bar)
flickerstreak@109 84 end
flickerstreak@109 85 end
flickerstreak@109 86
flickerstreak@109 87 function ApplyStates( bar )
flickerstreak@109 88 local states = tfetch(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@109 89 if states then
flickerstreak@157 90 bar:SetStateDriver(states)
flickerstreak@109 91 end
flickerstreak@109 92 end
flickerstreak@109 93
flickerstreak@109 94 function CleanupStates( bar )
flickerstreak@155 95 bar:SetStateDriver(nil)
flickerstreak@109 96 end
flickerstreak@109 97 end
flickerstreak@109 98
flickerstreak@109 99
flickerstreak@109 100
flickerstreak@109 101 -- module event handlers --
flickerstreak@109 102
flickerstreak@109 103 function module:OnInitialize()
flickerstreak@109 104 self.db = ReAction.db:RegisterNamespace( moduleID,
flickerstreak@109 105 {
flickerstreak@109 106 profile = {
flickerstreak@109 107 bars = { },
flickerstreak@109 108 }
flickerstreak@109 109 }
flickerstreak@109 110 )
flickerstreak@109 111
flickerstreak@109 112 self:RegisterEvent("UPDATE_SHAPESHIFT_FORMS")
flickerstreak@109 113
flickerstreak@109 114 ReAction:RegisterBarOptionGenerator(self, "GetBarOptions")
flickerstreak@109 115
flickerstreak@109 116 ReAction.RegisterCallback(self, "OnCreateBar","OnRefreshBar")
flickerstreak@109 117 ReAction.RegisterCallback(self, "OnDestroyBar")
flickerstreak@109 118 ReAction.RegisterCallback(self, "OnRefreshBar")
flickerstreak@109 119 ReAction.RegisterCallback(self, "OnEraseBar")
flickerstreak@109 120 ReAction.RegisterCallback(self, "OnRenameBar")
flickerstreak@109 121 end
flickerstreak@109 122
flickerstreak@109 123 function module:OnEnable()
flickerstreak@109 124 self:UPDATE_SHAPESHIFT_FORMS() -- it doesn't fire on a /reloadui
flickerstreak@109 125 end
flickerstreak@109 126
flickerstreak@109 127 function module:UPDATE_SHAPESHIFT_FORMS()
flickerstreak@109 128 -- Re-parse the rules table according to the new form list.
flickerstreak@109 129 -- This happens both at initial login (after PLAYER_ENTERING_WORLD)
flickerstreak@109 130 -- as well as when gaining new abilities.
flickerstreak@157 131 ReAction.Bar.InitRuleFormats()
flickerstreak@155 132 for _, bar in ReAction:IterateBars() do
flickerstreak@155 133 ApplyStates(bar)
flickerstreak@109 134 end
flickerstreak@109 135 end
flickerstreak@109 136
flickerstreak@109 137 function module:OnRefreshBar(event, bar, name)
flickerstreak@109 138 local c = self.db.profile.bars[name]
flickerstreak@109 139 if c then
flickerstreak@109 140 ApplyStates(bar)
flickerstreak@109 141 end
flickerstreak@109 142 end
flickerstreak@109 143
flickerstreak@109 144 function module:OnDestroyBar(event, bar, name)
flickerstreak@109 145 CleanupStates(bar)
flickerstreak@109 146 end
flickerstreak@109 147
flickerstreak@109 148 function module:OnEraseBar(event, bar, name)
flickerstreak@109 149 self.db.profile.bars[name] = nil
flickerstreak@109 150 end
flickerstreak@109 151
flickerstreak@109 152 function module:OnRenameBar(event, bar, oldname, newname)
flickerstreak@109 153 local bars = self.db.profile.bars
flickerstreak@109 154 bars[newname], bars[oldname] = bars[oldname], nil
flickerstreak@109 155 end
flickerstreak@109 156
flickerstreak@109 157
flickerstreak@109 158
flickerstreak@109 159 -- Options --
flickerstreak@109 160
flickerstreak@109 161 local CreateBarOptions, RegisterPropertyOptions
flickerstreak@109 162 do
flickerstreak@109 163 -- pre-sorted by the order they should appear in
flickerstreak@109 164 local rules = {
flickerstreak@118 165 -- rule fields
flickerstreak@118 166 { "stance", { {battle = L["Battle Stance"]}, {defensive = L["Defensive Stance"]}, {berserker = L["Berserker Stance"]} } },
flickerstreak@118 167 { "form", { {caster = L["Caster Form"]}, {bear = L["Bear Form"]}, {cat = L["Cat Form"]}, {tree = L["Tree of Life"]}, {moonkin = L["Moonkin Form"]} } },
flickerstreak@118 168 { "stealth", { {stealth = L["Stealth"]}, {nostealth = L["No Stealth"]} } },
flickerstreak@118 169 { "shadow", { {shadowform = L["Shadowform"]}, {noshadowform = L["No Shadowform"]} } },
flickerstreak@118 170 { "pet", { {pet = L["With Pet"]}, {nopet = L["Without Pet"]} } },
flickerstreak@118 171 { "target", { {harm = L["Hostile Target"]}, {help = L["Friendly Target"]}, {notarget = L["No Target"]} } },
flickerstreak@118 172 { "focus", { {focusharm = L["Hostile Focus"]}, {focushelp = L["Friendly Focus"]}, {nofocus = L["No Focus"]} } },
flickerstreak@118 173 { "possess", { {possess = L["Mind Control"]} } },
flickerstreak@118 174 { "vehicle", { {vehicle = L["In a Vehicle"]} } },
flickerstreak@118 175 { "group", { {raid = L["Raid"]}, {party = L["Party"]}, {solo = L["Solo"]} } },
flickerstreak@118 176 { "combat", { {combat = L["In Combat"]}, {nocombat = L["Out of Combat"]} } },
flickerstreak@109 177 }
flickerstreak@109 178
flickerstreak@109 179 local ruleSelect = { }
flickerstreak@109 180 local ruleMap = { }
flickerstreak@109 181 local optionMap = setmetatable({},{__mode="k"})
flickerstreak@109 182
flickerstreak@109 183 local pointTable = {
flickerstreak@109 184 NONE = " ",
flickerstreak@109 185 CENTER = L["Center"],
flickerstreak@109 186 LEFT = L["Left"],
flickerstreak@109 187 RIGHT = L["Right"],
flickerstreak@109 188 TOP = L["Top"],
flickerstreak@109 189 BOTTOM = L["Bottom"],
flickerstreak@109 190 TOPLEFT = L["Top Left"],
flickerstreak@109 191 TOPRIGHT = L["Top Right"],
flickerstreak@109 192 BOTTOMLEFT = L["Bottom Left"],
flickerstreak@109 193 BOTTOMRIGHT = L["Bottom Right"],
flickerstreak@109 194 }
flickerstreak@109 195
flickerstreak@109 196 -- unpack rules table into ruleSelect and ruleMap
flickerstreak@109 197 for _, c in ipairs(rules) do
flickerstreak@118 198 local rule, fields = unpack(c)
flickerstreak@118 199 for _, field in ipairs(fields) do
flickerstreak@118 200 local key, label = next(field)
flickerstreak@118 201 table.insert(ruleSelect, label)
flickerstreak@118 202 table.insert(ruleMap, key)
flickerstreak@109 203 end
flickerstreak@109 204 end
flickerstreak@109 205
flickerstreak@109 206 local stateOptions = {
flickerstreak@109 207 ordering = {
flickerstreak@109 208 name = L["Info"],
flickerstreak@109 209 order = 1,
flickerstreak@109 210 type = "group",
flickerstreak@109 211 args = {
flickerstreak@109 212 delete = {
flickerstreak@109 213 name = L["Delete this State"],
flickerstreak@109 214 order = -1,
flickerstreak@109 215 type = "execute",
flickerstreak@109 216 func = "DeleteState",
flickerstreak@109 217 },
flickerstreak@109 218 rename = {
flickerstreak@109 219 name = L["Name"],
flickerstreak@109 220 order = 1,
flickerstreak@109 221 type = "input",
flickerstreak@109 222 get = "GetName",
flickerstreak@109 223 set = "SetStateName",
flickerstreak@109 224 pattern = "^%w*$",
flickerstreak@109 225 usage = L["State names must be alphanumeric without spaces"],
flickerstreak@109 226 },
flickerstreak@109 227 ordering = {
flickerstreak@109 228 name = L["Evaluation Order"],
flickerstreak@109 229 desc = L["State transitions are evaluated in the order listed:\nMove a state up or down to change the order"],
flickerstreak@109 230 order = 2,
flickerstreak@109 231 type = "group",
flickerstreak@109 232 inline = true,
flickerstreak@109 233 args = {
flickerstreak@109 234 up = {
flickerstreak@109 235 name = L["Up"],
flickerstreak@109 236 order = 1,
flickerstreak@109 237 type = "execute",
flickerstreak@109 238 width = "half",
flickerstreak@109 239 func = "MoveStateUp",
flickerstreak@109 240 },
flickerstreak@109 241 down = {
flickerstreak@109 242 name = L["Down"],
flickerstreak@109 243 order = 2,
flickerstreak@109 244 type = "execute",
flickerstreak@109 245 width = "half",
flickerstreak@109 246 func = "MoveStateDown",
flickerstreak@109 247 }
flickerstreak@109 248 }
flickerstreak@109 249 }
flickerstreak@109 250 }
flickerstreak@109 251 },
flickerstreak@109 252 properties = {
flickerstreak@109 253 name = L["Properties"],
flickerstreak@109 254 order = 2,
flickerstreak@109 255 type = "group",
flickerstreak@109 256 args = {
flickerstreak@109 257 desc = {
flickerstreak@109 258 name = L["Set the properties for the bar when in this state"],
flickerstreak@109 259 order = 1,
flickerstreak@109 260 type = "description"
flickerstreak@109 261 },
flickerstreak@109 262 hide = {
flickerstreak@109 263 name = L["Hide Bar"],
flickerstreak@109 264 order = 90,
flickerstreak@109 265 type = "toggle",
flickerstreak@109 266 set = "SetProp",
flickerstreak@109 267 get = "GetProp",
flickerstreak@109 268 },
flickerstreak@109 269 --[[ BROKEN
flickerstreak@109 270 keybindState = {
flickerstreak@109 271 name = L["Override Keybinds"],
flickerstreak@109 272 desc = L["Set this state to maintain its own set of keybinds which override the defaults when active"],
flickerstreak@109 273 order = 91,
flickerstreak@109 274 type = "toggle",
flickerstreak@109 275 set = "SetProp",
flickerstreak@109 276 get = "GetProp",
flickerstreak@109 277 }, ]]
flickerstreak@109 278 position = {
flickerstreak@109 279 name = L["Position"],
flickerstreak@109 280 order = 92,
flickerstreak@109 281 type = "group",
flickerstreak@109 282 inline = true,
flickerstreak@109 283 args = {
flickerstreak@109 284 anchorEnable = {
flickerstreak@109 285 name = L["Reposition"],
flickerstreak@109 286 order = 1,
flickerstreak@109 287 type = "toggle",
flickerstreak@109 288 set = "SetProp",
flickerstreak@109 289 get = "GetProp",
flickerstreak@109 290 },
flickerstreak@109 291 anchorFrame = {
flickerstreak@109 292 name = L["Anchor Frame"],
flickerstreak@109 293 order = 2,
flickerstreak@109 294 type = "select",
flickerstreak@109 295 values = "GetAnchorFrames",
flickerstreak@109 296 set = "SetAnchorFrame",
flickerstreak@109 297 get = "GetAnchorFrame",
flickerstreak@109 298 disabled = "GetAnchorDisabled",
flickerstreak@109 299 hidden = "GetAnchorDisabled",
flickerstreak@109 300 },
flickerstreak@109 301 anchorPoint = {
flickerstreak@109 302 name = L["Point"],
flickerstreak@109 303 order = 3,
flickerstreak@109 304 type = "select",
flickerstreak@109 305 values = pointTable,
flickerstreak@109 306 set = "SetAnchorPointProp",
flickerstreak@109 307 get = "GetAnchorPointProp",
flickerstreak@109 308 disabled = "GetAnchorDisabled",
flickerstreak@109 309 hidden = "GetAnchorDisabled",
flickerstreak@109 310 },
flickerstreak@109 311 anchorRelPoint = {
flickerstreak@109 312 name = L["Relative Point"],
flickerstreak@109 313 order = 4,
flickerstreak@109 314 type = "select",
flickerstreak@109 315 values = pointTable,
flickerstreak@109 316 set = "SetAnchorPointProp",
flickerstreak@109 317 get = "GetAnchorPointProp",
flickerstreak@109 318 disabled = "GetAnchorDisabled",
flickerstreak@109 319 hidden = "GetAnchorDisabled",
flickerstreak@109 320 },
flickerstreak@109 321 anchorX = {
flickerstreak@109 322 name = L["X Offset"],
flickerstreak@109 323 order = 5,
flickerstreak@109 324 type = "range",
flickerstreak@109 325 min = -100,
flickerstreak@109 326 max = 100,
flickerstreak@109 327 step = 1,
flickerstreak@109 328 set = "SetProp",
flickerstreak@109 329 get = "GetProp",
flickerstreak@109 330 disabled = "GetAnchorDisabled",
flickerstreak@109 331 hidden = "GetAnchorDisabled",
flickerstreak@109 332 },
flickerstreak@109 333 anchorY = {
flickerstreak@109 334 name = L["Y Offset"],
flickerstreak@109 335 order = 6,
flickerstreak@109 336 type = "range",
flickerstreak@109 337 min = -100,
flickerstreak@109 338 max = 100,
flickerstreak@109 339 step = 1,
flickerstreak@109 340 set = "SetProp",
flickerstreak@109 341 get = "GetProp",
flickerstreak@109 342 disabled = "GetAnchorDisabled",
flickerstreak@109 343 hidden = "GetAnchorDisabled",
flickerstreak@109 344 },
flickerstreak@109 345 },
flickerstreak@109 346 },
flickerstreak@109 347 scale = {
flickerstreak@109 348 name = L["Scale"],
flickerstreak@109 349 order = 93,
flickerstreak@109 350 type = "group",
flickerstreak@109 351 inline = true,
flickerstreak@109 352 args = {
flickerstreak@109 353 enableScale = {
flickerstreak@109 354 name = L["Set New Scale"],
flickerstreak@109 355 order = 1,
flickerstreak@109 356 type = "toggle",
flickerstreak@109 357 set = "SetProp",
flickerstreak@109 358 get = "GetProp",
flickerstreak@109 359 },
flickerstreak@109 360 scale = {
flickerstreak@109 361 name = L["Scale"],
flickerstreak@109 362 order = 2,
flickerstreak@109 363 type = "range",
flickerstreak@109 364 min = 0.25,
flickerstreak@109 365 max = 2.5,
flickerstreak@109 366 step = 0.05,
flickerstreak@109 367 isPercent = true,
flickerstreak@109 368 set = "SetProp",
flickerstreak@109 369 get = "GetScale",
flickerstreak@109 370 disabled = "GetScaleDisabled",
flickerstreak@109 371 hidden = "GetScaleDisabled",
flickerstreak@109 372 },
flickerstreak@109 373 },
flickerstreak@109 374 },
flickerstreak@109 375 alpha = {
flickerstreak@109 376 name = L["Transparency"],
flickerstreak@109 377 order = 94,
flickerstreak@109 378 type = "group",
flickerstreak@109 379 inline = true,
flickerstreak@109 380 args = {
flickerstreak@109 381 enableAlpha = {
flickerstreak@109 382 name = L["Set Transparency"],
flickerstreak@109 383 order = 1,
flickerstreak@109 384 type = "toggle",
flickerstreak@109 385 set = "SetProp",
flickerstreak@109 386 get = "GetProp",
flickerstreak@109 387 },
flickerstreak@109 388 alpha = {
flickerstreak@109 389 name = L["Transparency"],
flickerstreak@109 390 order = 2,
flickerstreak@109 391 type = "range",
flickerstreak@109 392 min = 0,
flickerstreak@109 393 max = 1,
flickerstreak@109 394 step = 0.01,
flickerstreak@109 395 bigStep = 0.05,
flickerstreak@109 396 isPercent = true,
flickerstreak@109 397 set = "SetProp",
flickerstreak@109 398 get = "GetAlpha",
flickerstreak@109 399 disabled = "GetAlphaDisabled",
flickerstreak@109 400 hidden = "GetAlphaDisabled",
flickerstreak@109 401 },
flickerstreak@109 402 },
flickerstreak@109 403 },
flickerstreak@109 404 },
flickerstreak@109 405 plugins = { }
flickerstreak@109 406 },
flickerstreak@109 407 rules = {
flickerstreak@109 408 name = L["Rule"],
flickerstreak@109 409 order = 3,
flickerstreak@109 410 type = "group",
flickerstreak@109 411 args = {
flickerstreak@109 412 mode = {
flickerstreak@109 413 name = L["Select this state"],
flickerstreak@109 414 order = 2,
flickerstreak@109 415 type = "select",
flickerstreak@109 416 style = "radio",
flickerstreak@109 417 values = {
flickerstreak@109 418 default = L["by default"],
flickerstreak@109 419 any = L["when ANY of these"],
flickerstreak@109 420 all = L["when ALL of these"],
flickerstreak@109 421 custom = L["via custom rule"],
flickerstreak@109 422 keybind = L["via keybinding"],
flickerstreak@109 423 },
flickerstreak@109 424 set = "SetType",
flickerstreak@109 425 get = "GetType",
flickerstreak@109 426 },
flickerstreak@109 427 clear = {
flickerstreak@109 428 name = L["Clear All"],
flickerstreak@109 429 order = 3,
flickerstreak@109 430 type = "execute",
flickerstreak@109 431 hidden = "GetClearAllDisabled",
flickerstreak@109 432 disabled = "GetClearAllDisabled",
flickerstreak@109 433 func = "ClearAllConditions",
flickerstreak@109 434 },
flickerstreak@109 435 inputs = {
flickerstreak@109 436 name = L["Conditions"],
flickerstreak@109 437 order = 4,
flickerstreak@109 438 type = "multiselect",
flickerstreak@109 439 hidden = "GetConditionsDisabled",
flickerstreak@109 440 disabled = "GetConditionsDisabled",
flickerstreak@109 441 values = ruleSelect,
flickerstreak@109 442 set = "SetCondition",
flickerstreak@109 443 get = "GetCondition",
flickerstreak@109 444 },
flickerstreak@109 445 custom = {
flickerstreak@109 446 name = L["Custom Rule"],
flickerstreak@109 447 order = 5,
flickerstreak@109 448 type = "input",
flickerstreak@109 449 multiline = true,
flickerstreak@109 450 hidden = "GetCustomDisabled",
flickerstreak@109 451 disabled = "GetCustomDisabled",
flickerstreak@109 452 desc = L["Syntax like macro rules: see preset rules for examples"],
flickerstreak@109 453 set = "SetCustomRule",
flickerstreak@109 454 get = "GetCustomRule",
flickerstreak@109 455 validate = "ValidateCustomRule",
flickerstreak@109 456 },
flickerstreak@109 457 keybind = {
flickerstreak@109 458 name = L["Keybinding"],
flickerstreak@109 459 order = 6,
flickerstreak@109 460 inline = true,
flickerstreak@109 461 hidden = "GetKeybindDisabled",
flickerstreak@109 462 disabled = "GetKeybindDisabled",
flickerstreak@109 463 type = "group",
flickerstreak@109 464 args = {
flickerstreak@109 465 desc = {
flickerstreak@109 466 name = L["Invoking a state keybind toggles an override of all other transition rules."],
flickerstreak@109 467 order = 1,
flickerstreak@109 468 type = "description",
flickerstreak@109 469 },
flickerstreak@109 470 keybind = {
flickerstreak@109 471 name = L["State Hotkey"],
flickerstreak@109 472 desc = L["Define an override toggle keybind"],
flickerstreak@109 473 order = 2,
flickerstreak@109 474 type = "keybinding",
flickerstreak@109 475 set = "SetKeybind",
flickerstreak@109 476 get = "GetKeybind",
flickerstreak@109 477 },
flickerstreak@109 478 },
flickerstreak@109 479 },
flickerstreak@109 480 },
flickerstreak@109 481 },
flickerstreak@109 482 }
flickerstreak@109 483
flickerstreak@109 484 local handlers = { }
flickerstreak@109 485 local meta = {
flickerstreak@109 486 __index = function(self, key)
flickerstreak@109 487 for _, h in pairs(handlers) do
flickerstreak@109 488 if h[key] then
flickerstreak@109 489 return h[key]
flickerstreak@109 490 end
flickerstreak@109 491 end
flickerstreak@109 492 end,
flickerstreak@109 493 }
flickerstreak@109 494 local StateHandler = setmetatable({ }, meta)
flickerstreak@109 495 local proto = { __index = StateHandler }
flickerstreak@109 496
flickerstreak@109 497 function RegisterPropertyOptions( field, options, handler )
flickerstreak@109 498 stateOptions.properties.plugins[field] = options
flickerstreak@109 499 handlers[field] = handler
flickerstreak@109 500 end
flickerstreak@109 501
flickerstreak@109 502 function UnregisterPropertyOptions( field )
flickerstreak@109 503 stateOptions.properties.plugins[field] = nil
flickerstreak@109 504 handlers[field] = nil
flickerstreak@109 505 end
flickerstreak@109 506
flickerstreak@109 507 function StateHandler:New( bar, opts )
flickerstreak@109 508 local self = setmetatable(
flickerstreak@109 509 {
flickerstreak@109 510 bar = bar
flickerstreak@109 511 },
flickerstreak@109 512 proto )
flickerstreak@109 513
flickerstreak@109 514 function self:GetName()
flickerstreak@109 515 return opts.name
flickerstreak@109 516 end
flickerstreak@109 517
flickerstreak@109 518 function self:SetName(name)
flickerstreak@109 519 opts.name = name
flickerstreak@109 520 end
flickerstreak@109 521
flickerstreak@109 522 function self:GetOrder()
flickerstreak@109 523 return opts.order
flickerstreak@109 524 end
flickerstreak@109 525
flickerstreak@109 526 -- get reference to states table: even if the bar
flickerstreak@109 527 -- name changes the states table ref won't
flickerstreak@109 528 self.states = tbuild(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@109 529 self.state = tbuild(self.states, opts.name)
flickerstreak@109 530
flickerstreak@109 531 opts.order = self:GetRuleField("order")
flickerstreak@109 532 if opts.order == nil then
flickerstreak@109 533 -- add after the highest
flickerstreak@109 534 opts.order = 100
flickerstreak@109 535 for _, state in pairs(self.states) do
flickerstreak@109 536 local x = tonumber(tfetch(state, "rule", "order"))
flickerstreak@109 537 if x and x >= opts.order then
flickerstreak@109 538 opts.order = x + 1
flickerstreak@109 539 end
flickerstreak@109 540 end
flickerstreak@109 541 self:SetRuleField("order",opts.order)
flickerstreak@109 542 end
flickerstreak@109 543
flickerstreak@109 544 return self
flickerstreak@109 545 end
flickerstreak@109 546
flickerstreak@109 547 -- helper methods
flickerstreak@109 548
flickerstreak@109 549 function StateHandler:SetRuleField( key, value, ... )
flickerstreak@109 550 tbuild(self.state, "rule", ...)[key] = value
flickerstreak@109 551 end
flickerstreak@109 552
flickerstreak@109 553 function StateHandler:GetRuleField( ... )
flickerstreak@109 554 return tfetch(self.state, "rule", ...)
flickerstreak@109 555 end
flickerstreak@109 556
flickerstreak@109 557 function StateHandler:FixAll( setkey )
flickerstreak@109 558 -- if multiple selections in the same group are chosen when 'all' is selected,
flickerstreak@109 559 -- keep only one of them. If changing the mode, the first in the fields list will
flickerstreak@109 560 -- be chosen arbitrarily. Otherwise, if selecting a new checkbox from the field-set,
flickerstreak@109 561 -- it will be retained.
flickerstreak@109 562 local notified = false
flickerstreak@109 563 if self:GetRuleField("type") == "all" then
flickerstreak@109 564 for _, c in ipairs(rules) do
flickerstreak@118 565 local rule, fields = unpack(c)
flickerstreak@109 566 local once = false
flickerstreak@109 567 if setkey then
flickerstreak@109 568 for idx, field in ipairs(fields) do
flickerstreak@109 569 if next(field) == setkey then
flickerstreak@109 570 once = true
flickerstreak@109 571 end
flickerstreak@109 572 end
flickerstreak@109 573 end
flickerstreak@109 574 for idx, field in ipairs(fields) do
flickerstreak@109 575 local key = next(field)
flickerstreak@109 576 if self:GetRuleField("values",key) then
flickerstreak@109 577 if once and key ~= setkey then
flickerstreak@109 578 self:SetRuleField(key,false,"values")
flickerstreak@109 579 if not setkey and not notified then
flickerstreak@109 580 ReAction:UserError(L["Warning: one or more incompatible rules were turned off"])
flickerstreak@109 581 notified = true
flickerstreak@109 582 end
flickerstreak@109 583 end
flickerstreak@109 584 once = true
flickerstreak@109 585 end
flickerstreak@109 586 end
flickerstreak@109 587 end
flickerstreak@109 588 end
flickerstreak@109 589 end
flickerstreak@109 590
flickerstreak@109 591 function StateHandler:GetNeighbors()
flickerstreak@109 592 local before, after
flickerstreak@109 593 for k, v in pairs(self.states) do
flickerstreak@109 594 local o = tonumber(tfetch(v, "rule", "order"))
flickerstreak@109 595 if o and k ~= self:GetName() then
flickerstreak@109 596 local obefore = tfetch(self.states,before,"rule","order")
flickerstreak@109 597 local oafter = tfetch(self.states,after,"rule","order")
flickerstreak@109 598 if o < self:GetOrder() and (not obefore or obefore < o) then
flickerstreak@109 599 before = k
flickerstreak@109 600 end
flickerstreak@109 601 if o > self:GetOrder() and (not oafter or oafter > o) then
flickerstreak@109 602 after = k
flickerstreak@109 603 end
flickerstreak@109 604 end
flickerstreak@109 605 end
flickerstreak@109 606 return before, after
flickerstreak@109 607 end
flickerstreak@109 608
flickerstreak@109 609 function StateHandler:SwapOrder( a, b )
flickerstreak@109 610 -- do options table
flickerstreak@109 611 local args = optionMap[self.bar].args
flickerstreak@109 612 args[a].order, args[b].order = args[b].order, args[a].order
flickerstreak@109 613 -- do profile
flickerstreak@109 614 a = tbuild(self.states, a, "rule")
flickerstreak@109 615 b = tbuild(self.states, b, "rule")
flickerstreak@109 616 a.order, b.order = b.order, a.order
flickerstreak@109 617 end
flickerstreak@109 618
flickerstreak@109 619 -- handler methods
flickerstreak@109 620
flickerstreak@109 621 function StateHandler:GetProp( info )
flickerstreak@109 622 -- gets property of the same name as the options arg
flickerstreak@109 623 return GetProperty(self.bar, self:GetName(), info[#info])
flickerstreak@109 624 end
flickerstreak@109 625
flickerstreak@109 626 function StateHandler:SetProp( info, value )
flickerstreak@109 627 -- sets property of the same name as the options arg
flickerstreak@109 628 SetProperty(self.bar, self:GetName(), info[#info], value)
flickerstreak@109 629 end
flickerstreak@109 630
flickerstreak@109 631 function StateHandler:DeleteState()
flickerstreak@109 632 if self.states[self:GetName()] then
flickerstreak@109 633 self.states[self:GetName()] = nil
flickerstreak@109 634 ApplyStates(self.bar)
flickerstreak@109 635 end
flickerstreak@109 636 optionMap[self.bar].args[self:GetName()] = nil
flickerstreak@109 637 end
flickerstreak@109 638
flickerstreak@109 639 function StateHandler:SetStateName(info, value)
flickerstreak@109 640 -- check for existing state name
flickerstreak@109 641 if self.states[value] then
flickerstreak@109 642 ReAction:UserError(format(L["State named '%s' already exists"],value))
flickerstreak@109 643 return
flickerstreak@109 644 end
flickerstreak@109 645 local args = optionMap[self.bar].args
flickerstreak@109 646 local name = self:GetName()
flickerstreak@109 647 self.states[value], args[value], self.states[name], args[name] = self.states[name], args[name], nil, nil
flickerstreak@109 648 self:SetName(value)
flickerstreak@109 649 ApplyStates(self.bar)
flickerstreak@109 650 ReAction:ShowEditor(self.bar, moduleID, value)
flickerstreak@109 651 end
flickerstreak@109 652
flickerstreak@109 653 function StateHandler:MoveStateUp()
flickerstreak@109 654 local before, after = self:GetNeighbors()
flickerstreak@109 655 if before then
flickerstreak@109 656 self:SwapOrder(before, self:GetName())
flickerstreak@109 657 ApplyStates(self.bar)
flickerstreak@109 658 end
flickerstreak@109 659 end
flickerstreak@109 660
flickerstreak@109 661 function StateHandler:MoveStateDown()
flickerstreak@109 662 local before, after = self:GetNeighbors()
flickerstreak@109 663 if after then
flickerstreak@109 664 self:SwapOrder(self:GetName(), after)
flickerstreak@109 665 ApplyStates(self.bar)
flickerstreak@109 666 end
flickerstreak@109 667 end
flickerstreak@109 668
flickerstreak@109 669 function StateHandler:GetAnchorDisabled()
flickerstreak@109 670 return not GetProperty(self.bar, self:GetName(), "anchorEnable")
flickerstreak@109 671 end
flickerstreak@109 672
flickerstreak@109 673 function StateHandler:GetAnchorFrames(info)
flickerstreak@109 674 self._anchorframes = self._anchorframes or { }
flickerstreak@109 675 table.wipe(self._anchorframes)
flickerstreak@109 676
flickerstreak@109 677 table.insert(self._anchorframes, "UIParent")
flickerstreak@109 678 for name, bar in ReAction:IterateBars() do
flickerstreak@109 679 table.insert(self._anchorframes, bar:GetFrame():GetName())
flickerstreak@109 680 end
flickerstreak@109 681 return self._anchorframes
flickerstreak@109 682 end
flickerstreak@109 683
flickerstreak@109 684 function StateHandler:GetAnchorFrame(info)
flickerstreak@109 685 local value = self:GetProp(info)
flickerstreak@109 686 for k,v in pairs(self._anchorframes) do
flickerstreak@109 687 if v == value then
flickerstreak@109 688 return k
flickerstreak@109 689 end
flickerstreak@109 690 end
flickerstreak@109 691 end
flickerstreak@109 692
flickerstreak@109 693 function StateHandler:SetAnchorFrame(info, value)
flickerstreak@109 694 local f = _G[self._anchorframes[value]]
flickerstreak@109 695 if f then
flickerstreak@157 696 self.bar:SetFrameRef("anchor-"..self:GetName(), f)
flickerstreak@109 697 self:SetProp(info, f:GetName())
flickerstreak@109 698 end
flickerstreak@109 699 end
flickerstreak@109 700
flickerstreak@109 701 function StateHandler:SetAnchorPointProp(info, value)
flickerstreak@109 702 self:SetProp(info, value ~= "NONE" and value or nil)
flickerstreak@109 703 end
flickerstreak@109 704
flickerstreak@109 705 function StateHandler:GetAnchorPointProp(info)
flickerstreak@109 706 return self:GetProp(info) or "NONE"
flickerstreak@109 707 end
flickerstreak@109 708
flickerstreak@109 709 function StateHandler:GetScale(info)
flickerstreak@109 710 return self:GetProp(info) or 1.0
flickerstreak@109 711 end
flickerstreak@109 712
flickerstreak@109 713 function StateHandler:GetScaleDisabled()
flickerstreak@109 714 return not GetProperty(self.bar, self:GetName(), "enableScale")
flickerstreak@109 715 end
flickerstreak@109 716
flickerstreak@109 717 function StateHandler:GetAlpha(info)
flickerstreak@109 718 return self:GetProp(info) or 1.0
flickerstreak@109 719 end
flickerstreak@109 720
flickerstreak@109 721 function StateHandler:GetAlphaDisabled()
flickerstreak@109 722 return not GetProperty(self.bar, self:GetName(), "enableAlpha")
flickerstreak@109 723 end
flickerstreak@109 724
flickerstreak@109 725 function StateHandler:SetType(info, value)
flickerstreak@109 726 self:SetRuleField("type", value)
flickerstreak@109 727 self:FixAll()
flickerstreak@109 728 ApplyStates(self.bar)
flickerstreak@109 729 end
flickerstreak@109 730
flickerstreak@109 731 function StateHandler:GetType()
flickerstreak@109 732 return self:GetRuleField("type")
flickerstreak@109 733 end
flickerstreak@109 734
flickerstreak@109 735 function StateHandler:GetClearAllDisabled()
flickerstreak@109 736 local t = self:GetRuleField("type")
flickerstreak@109 737 return not( t == "any" or t == "all" or t == "custom")
flickerstreak@109 738 end
flickerstreak@109 739
flickerstreak@109 740 function StateHandler:ClearAllConditions()
flickerstreak@109 741 local t = self:GetRuleField("type")
flickerstreak@109 742 if t == "custom" then
flickerstreak@109 743 self:SetRuleField("custom","")
flickerstreak@109 744 elseif t == "any" or t == "all" then
flickerstreak@109 745 self:SetRuleField("values", {})
flickerstreak@109 746 end
flickerstreak@109 747 ApplyStates(self.bar)
flickerstreak@109 748 end
flickerstreak@109 749
flickerstreak@109 750 function StateHandler:GetConditionsDisabled()
flickerstreak@109 751 local t = self:GetRuleField("type")
flickerstreak@109 752 return not( t == "any" or t == "all")
flickerstreak@109 753 end
flickerstreak@109 754
flickerstreak@109 755 function StateHandler:SetCondition(info, key, value)
flickerstreak@109 756 self:SetRuleField(ruleMap[key], value or nil, "values")
flickerstreak@109 757 if value then
flickerstreak@109 758 self:FixAll(ruleMap[key])
flickerstreak@109 759 end
flickerstreak@109 760 ApplyStates(self.bar)
flickerstreak@109 761 end
flickerstreak@109 762
flickerstreak@109 763 function StateHandler:GetCondition(info, key)
flickerstreak@109 764 return self:GetRuleField("values", ruleMap[key]) or false
flickerstreak@109 765 end
flickerstreak@109 766
flickerstreak@109 767 function StateHandler:GetCustomDisabled()
flickerstreak@109 768 return self:GetRuleField("type") ~= "custom"
flickerstreak@109 769 end
flickerstreak@109 770
flickerstreak@109 771 function StateHandler:SetCustomRule(info, value)
flickerstreak@109 772 self:SetRuleField("custom",value)
flickerstreak@109 773 ApplyStates(self.bar)
flickerstreak@109 774 end
flickerstreak@109 775
flickerstreak@109 776 function StateHandler:GetCustomRule()
flickerstreak@109 777 return self:GetRuleField("custom") or ""
flickerstreak@109 778 end
flickerstreak@109 779
flickerstreak@109 780 function StateHandler:ValidateCustomRule(info, value)
flickerstreak@109 781 local s = value:gsub("%s","") -- remove all spaces
flickerstreak@109 782 -- unfortunately %b and captures don't support the '+' notation, or this would be considerably simpler
flickerstreak@109 783 repeat
flickerstreak@109 784 if s == "" then
flickerstreak@109 785 return true
flickerstreak@109 786 end
flickerstreak@109 787 local c, r = s:match("(%b[])(.*)")
flickerstreak@109 788 if c == nil and s and #s > 0 then
flickerstreak@109 789 return format(L["Invalid custom rule '%s': each clause must appear within [brackets]"],value or "")
flickerstreak@109 790 end
flickerstreak@109 791 s = r
flickerstreak@109 792 until c == nil
flickerstreak@109 793 return true
flickerstreak@109 794 end
flickerstreak@109 795
flickerstreak@109 796 function StateHandler:GetKeybindDisabled()
flickerstreak@109 797 return self:GetRuleField("type") ~= "keybind"
flickerstreak@109 798 end
flickerstreak@109 799
flickerstreak@109 800 function StateHandler:GetKeybind()
flickerstreak@109 801 return self:GetRuleField("keybind")
flickerstreak@109 802 end
flickerstreak@109 803
flickerstreak@109 804 function StateHandler:SetKeybind(info, value)
flickerstreak@109 805 if value and #value == 0 then
flickerstreak@109 806 value = nil
flickerstreak@109 807 end
flickerstreak@109 808 self:SetRuleField("keybind",value)
flickerstreak@109 809 ApplyStates(self.bar)
flickerstreak@109 810 end
flickerstreak@109 811
flickerstreak@109 812 local function CreateStateOptions(bar, name)
flickerstreak@109 813 local opts = {
flickerstreak@109 814 type = "group",
flickerstreak@109 815 name = name,
flickerstreak@109 816 childGroups = "tab",
flickerstreak@109 817 args = stateOptions
flickerstreak@109 818 }
flickerstreak@109 819
flickerstreak@109 820 opts.handler = StateHandler:New(bar,opts)
flickerstreak@109 821
flickerstreak@109 822 return opts
flickerstreak@109 823 end
flickerstreak@109 824
flickerstreak@109 825 function module:GetBarOptions(bar)
flickerstreak@109 826 local private = { }
flickerstreak@109 827 local states = tbuild(module.db.profile.bars, bar:GetName(), "states")
flickerstreak@109 828 local options = {
flickerstreak@109 829 name = L["Dynamic State"],
flickerstreak@109 830 type = "group",
flickerstreak@109 831 order = -1,
flickerstreak@109 832 childGroups = "tree",
flickerstreak@109 833 disabled = InCombatLockdown,
flickerstreak@109 834 args = {
flickerstreak@109 835 __desc__ = {
flickerstreak@109 836 name = L["States are evaluated in the order they are listed"],
flickerstreak@109 837 order = 1,
flickerstreak@109 838 type = "description",
flickerstreak@109 839 },
flickerstreak@109 840 __new__ = {
flickerstreak@109 841 name = L["New State..."],
flickerstreak@109 842 order = 2,
flickerstreak@109 843 type = "group",
flickerstreak@109 844 args = {
flickerstreak@109 845 name = {
flickerstreak@109 846 name = L["State Name"],
flickerstreak@109 847 desc = L["Set a name for the new state"],
flickerstreak@109 848 order = 1,
flickerstreak@109 849 type = "input",
flickerstreak@109 850 get = function() return private.newstatename or "" end,
flickerstreak@109 851 set = function(info,value) private.newstatename = value end,
flickerstreak@109 852 pattern = "^%w*$",
flickerstreak@109 853 usage = L["State names must be alphanumeric without spaces"],
flickerstreak@109 854 },
flickerstreak@109 855 create = {
flickerstreak@109 856 name = L["Create State"],
flickerstreak@109 857 order = 2,
flickerstreak@109 858 type = "execute",
flickerstreak@109 859 func = function ()
flickerstreak@109 860 local name = private.newstatename
flickerstreak@109 861 if states[name] then
flickerstreak@109 862 ReAction:UserError(format(L["State named '%s' already exists"],name))
flickerstreak@109 863 else
flickerstreak@109 864 -- TODO: select default state options and pass as final argument
flickerstreak@109 865 states[name] = { }
flickerstreak@109 866 optionMap[bar].args[name] = CreateStateOptions(bar,name)
flickerstreak@109 867 ReAction:ShowEditor(bar, moduleID, name)
flickerstreak@109 868 private.newstatename = ""
flickerstreak@109 869 end
flickerstreak@109 870 end,
flickerstreak@109 871 disabled = function()
flickerstreak@109 872 local name = private.newstatename or ""
flickerstreak@109 873 return #name == 0 or name:find("%W")
flickerstreak@109 874 end,
flickerstreak@109 875 }
flickerstreak@109 876 }
flickerstreak@109 877 }
flickerstreak@109 878 }
flickerstreak@109 879 }
flickerstreak@109 880 for name, config in pairs(states) do
flickerstreak@109 881 options.args[name] = CreateStateOptions(bar,name)
flickerstreak@109 882 end
flickerstreak@109 883 optionMap[bar] = options
flickerstreak@109 884 return options
flickerstreak@109 885 end
flickerstreak@109 886 end
flickerstreak@109 887
flickerstreak@109 888 -- Module API --
flickerstreak@109 889
flickerstreak@109 890 -- Pass in a property field-name, an implementation secure snippet, a static options table, and an
flickerstreak@109 891 -- optional options handler method-table
flickerstreak@109 892 --
flickerstreak@109 893 -- The options table is static, i.e. not bar-specific and should only reference handler method
flickerstreak@109 894 -- strings (either existing ones or those added via optHandler). The existing options are ordered
flickerstreak@109 895 -- 90-99. Order #1 is reserved for the heading.
flickerstreak@109 896 --
flickerstreak@109 897 -- The contents of optHandler, if provided, will be added to the existing StateHandler options metatable.
flickerstreak@109 898 -- See above, for existing API. In particular see the properties set up in the New method: self.bar,
flickerstreak@109 899 -- self.states, and self:GetName(), and the generic property handlers self:GetProp() and self:SetProp().
flickerstreak@109 900 --
flickerstreak@109 901 function module:RegisterStateProperty( field, snippetHandler, options, optHandler )
flickerstreak@109 902 RegisterProperty(field, snippetHandler)
flickerstreak@109 903 RegisterPropertyOptions(field, options, optHandler)
flickerstreak@109 904 end
flickerstreak@109 905
flickerstreak@109 906 function module:UnregisterStateProperty( field )
flickerstreak@109 907 UnregisterProperty(field)
flickerstreak@109 908 UnregisterPropertyOptions(field)
flickerstreak@109 909 end
flickerstreak@109 910
flickerstreak@109 911
flickerstreak@109 912 -- Export methods to Bar class --
flickerstreak@109 913
flickerstreak@109 914 ReAction.Bar.GetStateProperty = GetProperty
flickerstreak@109 915 ReAction.Bar.SetStateProperty = SetProperty