Mercurial > wow > reaction

annotate classes/State.lua @ 241:09c8e9baa35a

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