Mercurial > wow > reaction

annotate modules/State.lua @ 175:df68b5a40490

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