Mercurial > wow > reaction

annotate modules/State.lua @ 228:ad40cd3fc7e9

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