Back to Home

ESO Lua File v100035

ingame/utility/textsearchmanager.lua

[◄ back to folders ]
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
    local questItemList = {}
    for questIndex = 1, MAX_JOURNAL_QUESTS do
        if IsValidQuestIndex(questIndex) then
            for toolIndex = 1, GetQuestToolCount(questIndex) do
                local questItemId = select(5, GetQuestToolInfo(questIndex, toolIndex))
                if questItemId ~= 0 then
                    table.insert(questItemList, questItemId)
                end
            end
            for stepIndex = QUEST_MAIN_STEP_INDEX, GetJournalQuestNumSteps(questIndex) do
                for conditionIndex = 1, GetJournalQuestNumConditions(questIndex, stepIndex) do
                    local questItemId = select(4, GetQuestItemInfo(questIndex, stepIndex, conditionIndex))
                    if questItemId ~= 0 then
                        table.insert(questItemList, questItemId)
                    end
                end
            end
        end
    end
    return questItemList
end
--
--[[ Text Search Manager ]]--
--
ZO_TextSearchManager = ZO_InitializingCallbackObject:Subclass()
function ZO_TextSearchManager:Initialize()
    self.contextSearches = {}
    self.pendingContextSearches = {}
    local function OnTextSearchFilterComplete(eventId, ...)
        self:OnBackgroundListFilterComplete(...)
    end
    EVENT_MANAGER:RegisterForEvent("ZO_TextSearchManager", EVENT_BACKGROUND_LIST_FILTER_COMPLETE, OnTextSearchFilterComplete)
end
function ZO_TextSearchManager.CanFilterByText(text)
    -- Very broad searches have bad performance implications: The search itself is asynchronous (and snappy), but updating UI to reflect the search is not
    return text ~= nil and ZoUTF8StringLength(text) >= 2
end
--[[
Expected format for filterTargetDescriptors:
filterTargetDescriptors =
{
[<FilterTarget>] =
{
searchFilterList =
{
BACKGROUND_LIST_FILTER_TYPE_<FilterType>,
...
},
primaryKeys =
{
<List of keys> (ie. BAG_BACKPACK, BAG_BANK for FILTER_TARGET_BAG_SLOT or filterFunction() for filter like slottable in FILTER_TARGET_COLLECTIBLE)
},
},
}
This function will also override the filter target descriptors for a context that already exists.
]]
--
function ZO_TextSearchManager:SetupContextTextSearch(context, filterTargetDescriptors)
    local contextSearch = self.contextSearches[context]
    if not contextSearch then
        contextSearch = {}
        self.contextSearches[context] = contextSearch
    end
    contextSearch.filterTargetDescriptors = filterTargetDescriptors
    contextSearch.isDirty = true
    contextSearch.isActive = false
    contextSearch.searchText = ""
    contextSearch.inProgressSearchTasks = {}
    contextSearch.searchResults = {}
end
function ZO_TextSearchManager:ActivateTextSearch(context)
    if self.contextSearches[context] and not self.contextSearches[context].isActive then
        self.contextSearches[context].isActive = true
        self:CleanSearch(context)
        return true
    else
        return false
    end
end
function ZO_TextSearchManager:DeactivateTextSearch(context)
    if self:IsActiveTextSearch(context) then
        self.contextSearches[context].isActive = false
        return true
    else
        return false
    end
end
function ZO_TextSearchManager:IsActiveTextSearch(context)
    return self.contextSearches[context] and self.contextSearches[context].isActive
end
function ZO_TextSearchManager:IsFilterTargetInContext(context, filterTarget)
    local contextSearch = self.contextSearches[context]
    if contextSearch then
        return contextSearch.filterTargetDescriptors[filterTarget] ~= nil
    end
    return false
end
function ZO_TextSearchManager:GetSearchText(context)
    return self.contextSearches[context] and self.contextSearches[context].searchText or ""
end
function ZO_TextSearchManager:SetSearchText(context, searchText)
    local contextSearch = self.contextSearches[context]
    if contextSearch then
        searchText = searchText or ""
        if contextSearch.searchText ~= searchText then
            contextSearch.searchText = searchText
            contextSearch.isDirty = true
            if self:IsActiveTextSearch(context) then
                self:ExecuteSearch(context)
            end
        end
    end
end
function ZO_TextSearchManager:MarkDirtyByFilterTargetAndPrimaryKey(filterTarget, primaryKey, shouldSuppressSearchUpdate)
    for context, contextSearch in pairs(self.contextSearches) do
        local filterTargetData = contextSearch.filterTargetDescriptors[filterTarget]
        if filterTargetData then
            local primaryKeys = filterTargetData.primaryKeys
            if type(primaryKeys) == "function" then
                primaryKeys = primaryKeys()
            end
            for _, key in ipairs(primaryKeys) do
                if key == primaryKey then
                    contextSearch.isDirty = true
                    self:CleanSearch(context, shouldSuppressSearchUpdate)
                    break
                end
            end
        end
    end
end
function ZO_TextSearchManager:CleanSearch(context, shouldSuppressSearchUpdate)
    local contextSearch = self.contextSearches[context]
    if not contextSearch then
        return
    end
    if contextSearch.isDirty and self:IsActiveTextSearch(context) then
        if not shouldSuppressSearchUpdate then
            self:ExecuteSearch(context)
        else
            self.pendingContextSearches[context] = true
        end
    end
end
function ZO_TextSearchManager:ClearPendingContextSearches()
    self.pendingContextSearches = {}
end
function ZO_TextSearchManager:ExecutePendingContextSearches()
    for context, _ in pairs(self.pendingContextSearches) do
         self:ExecuteSearch(context)
    end
end
function ZO_TextSearchManager:ExecuteSearch(context)
    local contextSearch = self.contextSearches[context]
    if not contextSearch then
        return
    end
    --Cancel any in progress filtering so we can do a new one
    for _, searchTaskId in pairs(contextSearch.inProgressSearchTasks) do
        DestroyBackgroundListFilter(searchTaskId)
    end
    ZO_ClearTable(contextSearch.inProgressSearchTasks)
    ZO_ClearTable(contextSearch.searchResults)
    --If we have filter text then create the tasks
    if ZO_TextSearchManager.CanFilterByText(contextSearch.searchText) then
        for filterTarget, filterData in pairs(contextSearch.filterTargetDescriptors) do
            local searchTaskId = CreateBackgroundListFilter(filterTarget, contextSearch.searchText)
            for _, searchFilter in ipairs(filterData.searchFilterList) do
                AddBackgroundListFilterType(searchTaskId, searchFilter)
            end
            contextSearch.inProgressSearchTasks[filterTarget] = searchTaskId
            local primaryKeys = filterData.primaryKeys
            if type(filterData.primaryKeys) == "function" then
                primaryKeys = filterData.primaryKeys()
            end
            for _, primaryKey in ipairs(primaryKeys) do
                if filterTarget == BACKGROUND_LIST_FILTER_TARGET_BAG_SLOT then
                    -- Filter Target is a Bag Slot Filter, primary key is a bagId
                    for slotIndex in ZO_IterateBagSlots(primaryKey) do
                        AddBackgroundListFilterEntry(searchTaskId, primaryKey, slotIndex)
                    end
                elseif filterTarget == BACKGROUND_LIST_FILTER_TARGET_QUEST_ITEM_ID then
                    -- Filter Target is a Quest Item Filter, primary key is a questItemId
                    AddBackgroundListFilterEntry(searchTaskId, primaryKey)
                elseif filterTarget == BACKGROUND_LIST_FILTER_TARGET_COLLECTIBLE_ID then
                    -- Filter Target is a Collections Filter, primary key is a collectibleId
                    AddBackgroundListFilterEntry(searchTaskId, primaryKey)
                end
            end
        end
        for _, searchTaskId in pairs(contextSearch.inProgressSearchTasks) do
            StartBackgroundListFilter(searchTaskId)
        end
    else
        contextSearch.isDirty = false
        self:FireCallbacks("UpdateSearchResults", context)
    end
end
function ZO_TextSearchManager:GetInProgressTaskInfoById(taskId)
    for context, searchData in pairs(self.contextSearches) do
        for filterTarget, searchTaskId in pairs(searchData.inProgressSearchTasks) do
            if searchTaskId == taskId then
                return context, filterTarget
            end
        end
    end
    return nil
end
function ZO_TextSearchManager:OnBackgroundListFilterComplete(taskId)
    local context, filterTarget = self:GetInProgressTaskInfoById(taskId)
    local contextSearch = self.contextSearches[context]
    if contextSearch then
        --Mark that it was completed.
        contextSearch.inProgressSearchTasks[filterTarget] = nil
        local searchResults = contextSearch.searchResults[filterTarget]
        if not searchResults then
            searchResults = {}
            contextSearch.searchResults[filterTarget] = searchResults
        end
        for filterResultIndex = 1, GetNumBackgroundListFilterResults(taskId) do
            local primaryKey, secondaryKey = GetBackgroundListFilterResult(taskId, filterResultIndex)
            if filterTarget == BACKGROUND_LIST_FILTER_TARGET_BAG_SLOT then
                if not searchResults[primaryKey] then
                    searchResults[primaryKey] = {}
                end
                searchResults[primaryKey][secondaryKey] = true
            elseif filterTarget == BACKGROUND_LIST_FILTER_TARGET_QUEST_ITEM_ID then
                searchResults[primaryKey] = true
            elseif filterTarget == BACKGROUND_LIST_FILTER_TARGET_COLLECTIBLE_ID then
                searchResults[primaryKey] = true
            end
        end
        if ZO_IsTableEmpty(contextSearch.inProgressSearchTasks) then
            contextSearch.isDirty = false
            self:FireCallbacks("UpdateSearchResults", context)
        end
        DestroyBackgroundListFilter(taskId)
    end
end
function ZO_TextSearchManager:IsItemInSearchTextResults(context, filterTarget, primaryKey, secondaryKey)
    local contextSearch = self.contextSearches[context]
    if not contextSearch or not ZO_TextSearchManager.CanFilterByText(contextSearch.searchText) then
        return true
    end
    local searchResults = contextSearch.searchResults[filterTarget]
    if searchResults then
        if primaryKey and secondaryKey then
            return searchResults[primaryKey] and searchResults[primaryKey][secondaryKey]
        elseif primaryKey then
            return searchResults[primaryKey]
        end
    end
    return false
end
TEXT_SEARCH_MANAGER = ZO_TextSearchManager:New()