forked from rockingdice/AutoCategory
-
Notifications
You must be signed in to change notification settings - Fork 6
/
AC_Classes.lua
837 lines (702 loc) · 23.2 KB
/
AC_Classes.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
--====AutoCategory Classes====--
local L = GetString
local SF = LibSFUtils
local AC = AutoCategory
--local aclogger = AutoCategory.logger
--local RuleApi = AutoCategory.RuleApi
--local BagRuleApi = AutoCategory.BagRuleApi
-- -------------------------------------------------------
-- The CVT class manages the choices, choicesValues, and
-- choicesTooltips list for a particular dropdown control.
--
-- Note that the choices, choicesValues, and choicesTooltips
-- are 1-based contiguous lists (or possibly nil for values
-- and tooltips as these are optional).
--
-- A CVT can also be associated with a particular LAM dropdown
-- control by providing the control name (reference= in LAM options).
-- This allows the updateControls() function to refresh the
-- control from (possibly changed) choices, values, and
-- tooltips lists.
--
-- The indexValue field can keep track of the desired "current value"
-- of the CVT and is a value from either the choicesValues list
-- (if it exists) or else a value from the choices list. If you
-- wish to use this, you must ensure that the control setfunc() sets
-- the indexValue appropriately.
-- -------------------------------------------------------
AutoCategory.CVT = ZO_Object:Subclass()
AutoCategory.CVT.USE_NONE = 0
AutoCategory.CVT.USE_VALUES = 1
AutoCategory.CVT.USE_TOOLTIPS = 3
AutoCategory.CVT.USE_ALL = 4
local USE_NONE = AutoCategory.CVT.USE_NONE
local USE_VALUES = AutoCategory.CVT.USE_VALUES
local USE_TOOLTIPS = AutoCategory.CVT.USE_TOOLTIPS
local USE_ALL = AutoCategory.CVT.USE_ALL
function AutoCategory.CVT:New(...)
local obj = ZO_Object.New(self)
obj:initialize(...)
return obj
end
function AutoCategory.CVT:initialize(ctlname, ndx, usesFlags)
if ctlname then
self.controlName = ctlname
end
self.choices = {} -- mandatory list
if usesFlags and (usesFlags == USE_VALUES or usesFlags == USE_ALL) then
self.choicesValues = {}
end
if usesFlags and (usesFlags == USE_TOOLTIPS or usesFlags == USE_ALL) then
self.choicesTooltips = {}
end
self.indexValue = ndx
end
-- clear all of the tables in the CVT while preserving the references to the tables themselves
function AutoCategory.CVT:clear()
self.dirty = 1
self.choices = SF.safeClearTable(self.choices)
if self.choicesValues then
self.choicesValues = SF.safeClearTable(self.choicesValues)
end
if self.choicesTooltips then
self.choicesTooltips = SF.safeClearTable(self.choicesTooltips)
end
self.indexValue = nil
end
function AutoCategory.CVT:getControlName()
return self.controlName
end
-- assign the choices, choicesValues, and choicesTooltips from tblB to self
function AutoCategory.CVT:assign(tblB)
if not tblB then return end
if self.choicesValues and not tblB.choicesValues then
--AutoCategory.logger:Debug("don't have choicesValues for src tables in assign "..tostring(self.controlName))
return
end
if self.choicesTooltips and not tblB.choicesTooltips then
--AutoCategory.logger:Debug("don't have choicesTooltips for dest tables in assign "..tostring(self.controlName))
return
end
local ndx = self.indexValue
self.dirty = 1
self:clear()
-- 1-based and contiguous, remember?
-- may return nil
local function shallowcpy(src, dest)
if not src then return dest end
if not dest then return dest end --dest = {} end
for k=1, #src do
dest[k] = src[k]
end
return dest
end
self.choices = shallowcpy(tblB.choices, self.choices)
self.choicesValues = shallowcpy(tblB.choicesValues, self.choicesValues)
self.choicesTooltips = shallowcpy(tblB.choicesTooltips, self.choicesTooltips)
-- select the first value as the "current" value
if tblB.indexValue then
self:select(tblB.indexValue)
elseif ndx then
self:select(ndx)
else --if #self.choicesValues > 0 then
self:select()
end
end
-- set the current indexValue of the CVT from available values of the dropdown
-- if "value" is a non-empty table, then select the first entry from that table.
-- returns the value selected (may be nil)
function AutoCategory.CVT:select(value)
local searchtbl = self.choices
if self.choicesValues then
searchtbl = self.choicesValues
end
if not searchtbl then return nil end
if type(value) == "table" then
if #value > 0 then
self.indexValue = value[1]
return self.indexValue
end
if #searchtbl > 0 then
self.indexValue = searchtbl[1]
return self.indexValue
end
self.indexValue = nil
return nil
end
-- not a table
if value == "" then value = nil end
if value and ZO_IsElementInNumericallyIndexedTable(searchtbl, value) then
-- we have a valid value, so use it
self.indexValue=value
return self.indexValue
elseif self.indexValue and ZO_IsElementInNumericallyIndexedTable(searchtbl, self.indexValue) then
-- already has a value that is still valid so leave it alone
return self.indexValue
elseif searchtbl and #searchtbl > 0 then
-- fall back to using the initial list value of the CVT
self.indexValue = searchtbl[1]
return self.indexValue
end
return self.indexValue
end
function AutoCategory.CVT:clearIndex()
self.indexValue = nil
end
-- append a row selection to the cvt tables
-- returns whether or not it succeeded
function AutoCategory.CVT:append(choice, value, tooltip)
if not value and self.choicesValues then return false end -- value required when have choicesValues
if not tooltip and self.choicesTooltips then return false end -- tooltip required when have choicesTooltips
if not choice then return false end -- choice is mandatory
self.dirty = 1
self.choices[#self.choices+1] = choice -- (required)
if value and self.choicesValues then
self.choicesValues[#self.choicesValues+1] = value -- (optional)
end
if tooltip and self.choicesTooltips then
self.choicesTooltips[#self.choicesTooltips+1] = tooltip -- (optional)
end
return true
end
-- set the name of the associated control for these lists (if there is one) -- not currently used
function AutoCategory.CVT:setControlName(fld)
self.controlName = fld
end
-- returns the size of the required list for the CVT
-- (when other lists are used they must also have the same size!)
function AutoCategory.CVT:size()
return #self.choices
end
-- update the dropdown control with the new/current list values
-- only works if a controlName was assigned to this CVT.
function AutoCategory.CVT:updateControl()
if not self.controlName then return end
if self.dirty == 1 then
self.dirty = nil
else
-- does not need updating
return
end
--AutoCategory.logger:Debug("CVT:updateControl: getting control for "..tostring(self.controlName))
local dropdownCtrl = WINDOW_MANAGER:GetControlByName(self.controlName)
if dropdownCtrl == nil then
return
end
--AutoCategory.logger:Debug("CVT:updateControl: lists changed - need to update "..tostring(self.controlName))
dropdownCtrl:UpdateChoices(self.choices, self.choicesValues,
self.choicesTooltips)
end
-- remove an item (by choice) from the dropdown lists (does not update the control)
-- returns the new (maybe new) index value
function AutoCategory.CVT:removeItemChoice(removeItem)
local removeIndex = -1
if not self.choices then -- corrupt cvt
self.dirty = 1
self.choices = {}
self.indexValue = nil
return nil
end
-- find the choice to remove
local ndx = ZO_IndexOfElementInNumericallyIndexedTable(self.choices, removeItem)
if not ndx then return self.indexValue end -- nothing to remove
removeIndex = ndx
self.dirty = 1
local num = #self.choices -- value BEFORE removal
-- remove it from lists
table.remove(self.choices, removeIndex)
if self.choicesValues and #self.choicesValues > 0 then
table.remove(self.choicesValues, removeIndex)
end
if self.choicesTooltips and #self.choicesTooltips > 0 then
table.remove(self.choicesTooltips, removeIndex)
end
-- choose what the new indexValue (selection) will be
if removeIndex <= 0 then return self.indexValue end
if num == 1 then
--select none
self.indexValue = nil
elseif removeIndex == num then
--no next one, select previous one
self.indexValue = self.choices[num-1]
else
--select next one
self.indexValue = self.choices[removeIndex]
end
return self.indexValue
end
-- remove an item by choiceValue from the dropdown lists (does not update the control)
-- returns new selected value/choice
function AutoCategory.CVT:removeItemChoiceValue(removeItem)
local removeIndex = -1
if not self.choicesValues then return nil end
-- find the choiceValue to remove
local ndx = ZO_IndexOfElementInNumericallyIndexedTable(self.choicesValues, removeItem)
if not ndx then return self.indexValue end -- nothing to remove
self.dirty = 1
removeIndex = ndx
local num = #self.choicesValues -- value BEFORE removal
-- remove it
table.remove(self.choicesValues, removeIndex)
table.remove(self.choices, removeIndex) -- not optional
if #self.choicesTooltips then
table.remove(self.choicesTooltips, removeIndex)
end
-- find the choice to remove
if num == 1 then
--select none
self:clearIndex()
elseif removeIndex == num then
--no next one, select previous one
self:select(self.choicesValues[num-1])
else
--select next one
self:select(self.choicesValues[removeIndex])
end
return self.indexValue
end
-- --------------------------------------------
AutoCategory.BaseUI = ZO_Object:Subclass()
function AutoCategory.BaseUI:New(...)
local obj = ZO_Object.New(self)
obj:initialize(...)
return obj
end
function AutoCategory.BaseUI:initialize(ctlname, ...)
self.controlName = ctlname
end
function AutoCategory.BaseUI:getControlName()
return self.controlName
end
function AutoCategory.BaseUI:updateValue()
if not self.controlName then return end
local val = self:getValue()
if not val then return end
--AutoCategory.logger:Debug("updateControl: getting control for "..tostring(self.cvt.controlName))
local uiCtrl = WINDOW_MANAGER:GetControlByName(self.controlName)
if uiCtrl == nil then
return
end
--AutoCategory.logger:Debug("updateValue: value changed - need to update "..tostring(self.controlName))
uiCtrl:UpdateValue(false, val)
end
-- --------------------------------------------
AutoCategory.BaseDD = ZO_Object:Subclass()
function AutoCategory.BaseDD:New(...)
local obj = ZO_Object.New(self)
obj:initialize(...)
return obj
end
function AutoCategory.BaseDD:initialize(ctlname, ndx, usesFlags)
self.cvt = AutoCategory.CVT:New(ctlname, ndx, usesFlags)
end
function AutoCategory.BaseDD:getControlName()
return self.cvt.controlName
end
function AutoCategory.BaseDD:select(val)
self.cvt:select(val)
end
function AutoCategory.BaseDD:clearIndex()
self.cvt:clearIndex()
end
function AutoCategory.BaseDD:clear()
self.cvt:clear()
end
function AutoCategory.BaseDD:assign(cvtTbl)
self.cvt:assign(cvtTbl)
end
function AutoCategory.BaseDD:updateControl()
if not self.cvt.controlName then return end
--AutoCategory.logger:Debug("updateControl: getting control for "..tostring(self.cvt.controlName))
local dropdownCtrl = WINDOW_MANAGER:GetControlByName(self.cvt.controlName)
if dropdownCtrl == nil then
return
end
if self.cvt.dirty == 1 then -- only do this if cvt lists have been modified
--AutoCategory.logger:Debug("updateControl: dropdown lists changed - updating "..tostring(self.cvt.controlName))
-- only update the choices if we know that the lists contents changed
self.cvt.dirty = nil
dropdownCtrl:UpdateChoices(self.cvt.choices, self.cvt.choicesValues,
self.cvt.choicesTooltips)
end
if self.cvt.indexValue then
--AutoCategory.logger:Debug("updateControl: value changed - need to update "..tostring(self.cvt.controlName))
dropdownCtrl:UpdateValue(false, self.cvt.indexValue)
end
end
function AutoCategory.BaseDD:size()
return #self.cvt.choices
end
function AutoCategory.BaseDD:getValue()
return self.cvt.indexValue
end
-- -------------------------------------------------------
-- Rule functions and helpers
-- based on the requested rule name, create a name that
-- is not already in use (since rule names must be unique)
function AutoCategory.GetUsableRuleName(name)
local testName = name
local index = 1
while AutoCategory.RulesW.ruleNames[testName] ~= nil do
testName = name .. index
index = index + 1
end
return testName
end
-- check that all required fields are set
-- returns err (t/f), errmsg (string)
function AutoCategory.isValidRule(ruledef)
--make sure rule is well-formed
-- validate rule name
if (not ruledef or not ruledef.name
or type(ruledef.name) ~= "string" or ruledef.name == "") then
return false, "name is required"
end
-- validate rule text
if (not ruledef.rule or type(ruledef.rule) ~= "string" or ruledef.rule == "") then
ruledef.error = true
return false, "rule text is required"
end
-- validate optional rule description
if ruledef.description then -- description is optional
if (type(ruledef.description) ~= "string") then
return false, "non-nil description must be a string"
end
end
-- validate optional rule tag
if ruledef.tag then -- tag is optional
if (type(ruledef.tag) ~= "string") then
return false, "non-nil tag must be a string"
end
end
return true
end
-- -------------------------------------------------
-- collected functions to be applied to a rule
--
-- factory for creating new rules
function AutoCategory.CreateNewRule(name, tag)
local rule = {
name = name,
description = "",
rule = "true",
tag = tag,
}
return rule
end
-- factory for making copies of rules
function AutoCategory.CopyFrom(copyFrom)
if not copyFrom then return end
local ruleName = copyFrom.name
-- get a unique name based on the old rule name
local newName = AutoCategory.GetUsableRuleName(ruleName)
local tag = copyFrom.tag
if tag == "" then
tag = AC_EMPTY_TAG_NAME
end
local newRule = AutoCategory.CreateNewRule(newName, tag)
newRule.description = copyFrom.description
newRule.rule = copyFrom.rule
newRule.damaged = copyFrom.damaged
newRule.err = copyFrom.err
newRule.pred = nil -- defaults to not pre-defined, because copies are user-defined rules
return newRule
end
-- The BagRule class assists in the definition, management, and formatting of
-- bag rules for the collection of them in the Bag Settings Categories dropdown.
-- The minimum that a bagrule has is { name, priority }.
-- -------------------------------------------------------
-- helper functions for BagRules (for bag settings)
-- --------------------------------------------
-- Create a new Bag Entry (factory)
-- Rule parameter is required, priority is optional.
-- If a priority is not provided, default to 1000
-- Returns a table {name=, priority=} or nil
--
function AutoCategory.CreateNewBagRule(rule, priority)
local rulename = nil
local ruleprior = nil
if not rule then
return nil
end
if type(rule) == "string" then
rulename = rule
rule = AutoCategory.GetRuleByName(rulename)
elseif not rule.name then
return nil
else
rulename = rule.name
end
if priority == nil then
ruleprior = 1000
else
ruleprior = priority
end
local bagrule = {
name = rulename,
priority = ruleprior,
}
return bagrule
end
-- -------------------------------------------------
-- collected (wrapper) functions to be applied to a rule list
--
AutoCategory.RuleList = ZO_Object:Subclass()
-- creates a rule list wrapper with a numeric-sequenced list of rules (not under a .rules!)
function AutoCategory.RuleList:New(...)
local obj = ZO_Object.New(self)
obj:initialize(...)
return obj
end
-- rule list wrapper adds a name lookup to accompany the base list of rules
function AutoCategory.RuleList:initialize(rules)
self.ruleList = rules
self.ruleNames = {} -- lookup by name for ruleList [name] ruleListIndex
local arrules = self.ruleList
for k = #arrules,1,-1 do
if not self.ruleNames[arrules[k].name ] then
self.ruleNames[arrules[k].name] = k
end
end
end
-- return number of entries in the base rule list
function AutoCategory.RuleList.size(self)
return #self.ruleList
end
function AutoCategory.RuleList.addRule(self, newRule, overwriteFlag)
if not newRule or not newRule.name then return end -- bad rule
local ndx = self.ruleNames[newRule.name]
if ndx then
-- rule by name already in list
if overwriteFlag then
self.ruleList[ndx] = newRule
end
return
end
self.ruleList[#self.ruleList+1] = newRule
self.ruleNames[newRule.name] = #self.ruleList
end
-- remove a rule from the ruleList
function AutoCategory.RuleList.removeRuleByName(self, ruleName)
if not ruleName then return end
local ndx = self.ruleNames[ruleName]
if ndx then
self.ruleNames[ruleName] = nil
table.remove(self.ruleList, ndx)
end
end
-- remove a rule from the ruleList by position (index) in the ruleList
function AutoCategory.RuleList.removeRule(self, ndx)
if not ndx then return end
local rl = self.ruleList[ndx]
if not rl then return end
local name = rl.name
if name then
self.ruleNames[name] = nil
end
table.remove(self.ruleList, ndx)
end
-- returns a rule from the ruleList as specified by name
function AutoCategory.RuleList.getRuleByName(self, ruleName)
if not ruleName then return nil end
local ndx = self.ruleNames[ruleName]
if not ndx then return nil end
return self.ruleList[ndx]
end
-- clear the contents of the ruleList
function AutoCategory.RuleList.clear(self)
SF.safeClearTable(self.ruleList)
end
-- returns the name lookup table used by the wrapper (temporary measure)
function AutoCategory.RuleList.getLookup(self)
return self.ruleNames
end
-- sort the contents of the ruleList using sortfn
function AutoCategory.RuleList.sort(self, sortfn)
if type(sortfn ~= "function") then return end
SF.safeClearTable(ruleNames)
table.sort(self.ruleList, sortfn)
-- rebuild name lookup
local arrules = self.ruleList
for k = #arrules,1,-1 do
if not self.lkRruleNamesules[arrules[k].name ] then
self.ruleNames[arrules[k].name] = k
end
end
end
--[[
-- not currently used (and not complete)
-- -------------------------------------------------
-- collected functions to be applied to a bagrule list
--
AutoCategory.BagRuleList = ZO_Object:Subclass()
function AutoCategory.BagRuleList:New(...)
local obj = ZO_Object.New(self)
obj:initialize(...)
return obj
end
function AutoCategory.BagRuleList:initialize(bagrules)
self.bagrule = bagrules
self.ruleList = bagrules.rules
self.lkRules = {}
local arrules = self.ruleList
for k = #arrules,1,-1 do
if not self.lkRules[arrules[k].name ] then
self.lkRules[arrules[k].name] = k
end
end
end
function AutoCategory.BagRuleList.size(self)
return #self.ruleList
end
function AutoCategory.BagRuleList.addBagRule(self, newRule, overwriteFlag)
if not newRule or not newRule.name then return end
local ndx = self.lkRules[newRule.name]
if ndx then
if overwriteFlag then
self.ruleList[ndx] = newRule
end
return
end
self.ruleList[#self.ruleList+1] = newRule
self.lkRules[newRule.name] = #self.ruleList
end
--]]
-- -------------------------------------------------
-- collected functions to be applied to a rule
--
-- This functions to be used with rule structures loaded in or created.
AutoCategory.RuleApi = {
-- check if rule def is valid (required keys all present)
isValid = function(r)
return AutoCategory.isValidRule(r)
end,
--determine if a rule is marked as pre-defined
isPredefined = function(r)
return r.pred and r.pred ==1
end,
-- return the description if the rule has one, otherwise return the name
getDesc = function(r)
local tt = r.description
if not tt or tt == "" then
tt = r.name
end
return tt
end,
-- handle error marking for a rule
setError = function(r,dmg,errm)
r.damaged = dmg
r.err = errm
end,
clearError = function(r)
r.damaged = nil
r.err = nil
end,
-- get assigned key for the rule (if nil, returns name)
key = function(r)
if r.rkey then
return r.rkey
end
return r.name
end,
-- compare a rule to another rule for certain basic equalities
-- used for converting from acct/char rules to acctwide-only
-- returns two bools - (name is ~=), (rule def ~=)
isequiv = function(r, a)
if not a then return false, false end
local notname = r.name ~= a.name
local notrule = r.rule ~= a.rule
return notname, notrule
end,
-- Compile the Rule
-- Return a string that is either empty (good compile)
-- or an error string returned from the compile
--
-- Stores the compiled rule into AutoCategory.compiledRules table
compile = function(rule)
if rule == nil or rule.name == nil or rule.name == "" then
return
end
AutoCategory.compiledRules = SF.safeTable(AutoCategory.compiledRules)
AutoCategory.RuleApi.clearError(rule)
AutoCategory.compiledRules[AutoCategory.RuleApi.key(rule)] = nil
if rule.rule == nil or rule.rule == "" then
AutoCategory.RuleApi.setError(rule, true,"Missing rule definition")
return rule.err
end
local rulestr = "return(" .. rule.rule .. ")"
local compiledfunc, err = zo_loadstring(rulestr)
if not compiledfunc then
AutoCategory.RuleApi.setError(rule, true, err)
AutoCategory.compiledRules[AutoCategory.RuleApi.key(rule)] = nil
return err
end
AutoCategory.compiledRules[AutoCategory.RuleApi.key(rule)] = compiledfunc
return ""
end,
}
-- -------------------------------------------------
-- collected functions to be applied to a BagRule
--
AutoCategory.BagRuleApi = {
isValid = function (bagrule)
if not bagrule.name or bagrule.name == "" then
return false
end
if not bagrule.priority then return false end
return true
end,
formatValue = function (bagrule)
return bagrule.name
end,
-- formatShow() creates a string to represent the bagrule in the UI dropdown.
-- It combines the name and priority and optionally marks or colorizes them
-- based on if the bag rule is marked "hidden" or if the backing Rule has
-- disappeared (i.e the bag rule is now invalid).
formatShow = function (bagrule)
local sn = nil
local rule = AutoCategory.BagRuleApi.getBackingRule(bagrule)
if not rule then
-- missing rule (nil was passed in)
sn = string.format("|cFF4444(!)|r %s (%d)", bagrule.name, bagrule.priority)
else
if bagrule.isHidden then
-- grey out the "hidden" category header
sn = string.format("|c626250%s (%d)|r", bagrule.name, bagrule.priority)
else
sn = string.format("%s (%d)", bagrule.name, bagrule.priority)
end
end
return sn
end,
-- Provides a tooltip string for the bag rule which may be displayed
-- when hovering over the bag rule in the dropdown menu.
-- Note: A bug in LAM has broken the display of tooltips from
-- the menu, but I hope that the fix recommended by Calamath may
-- soon be released for LAM.
formatTooltip = function (bagrule)
local tt = nil
local rule = AutoCategory.BagRuleApi.getBackingRule(bagrule)
if not rule then
-- missing rule (nil was passed in)
tt = L(SI_AC_WARNING_CATEGORY_MISSING)
else
tt = AutoCategory.RuleApi.getDesc(rule)
end
return tt
end,
-- Get the rule structure (if it exists) for the bag rule name
getBackingRule = function (bagrule)
if not bagrule.name then return nil end
local rule = AutoCategory.GetRuleByName(bagrule.name)
return rule
end,
-- Allows setting the isHidden value for the bag rule
-- (translates false into nil to reduce junk in saved variables).
setHidden = function (bagrule, isHidden)
if isHidden == false then isHidden = nil end
if bagrule.isHidden == isHidden then return bagrule.isHidden end
bagrule.isHidden = isHidden
return bagrule.isHidden
end,
}