Back to Home

ESO Lua File v101050

libraries/utility/zo_autocomplete.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
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
--[[
ZO_AutoComplete is a utility object that connects to an edit control to provide autocomplete functionality.
]]
local COMMIT_BEHAVIOR_KEEP_FOCUS = 1
local COMMIT_BEHAVIOR_LOSE_FOCUS = 2
AUTO_COMPLETION_AUTOMATIC_MODE = true
AUTO_COMPLETION_MANUAL_MODE = false
AUTO_COMPLETION_USE_ARROWS = true
AUTO_COMPLETION_DONT_USE_ARROWS = false
AUTO_COMPLETION_DONT_CALL_HOOKED_HANDLERS = true
AUTO_COMPLETION_CALL_HOOKED_HANDLERS = false
AUTO_COMPLETION_ONLINE_ONLY = true
AUTO_COMPLETION_ONLINE_OR_OFFLINE = false
AUTO_COMPLETION_ANCHOR_TOP = 0
AUTO_COMPLETION_ANCHOR_BOTTOM = 1
AUTO_COMPLETION_SELECTED_BY_SPACE = 0
AUTO_COMPLETION_SELECTED_BY_ENTER = 1
AUTO_COMPLETION_SELECTED_BY_CLICK = 2
AUTO_COMPLETION_SELECTED_BY_TAB = 3
ZO_AutoComplete = ZO_InitializingCallbackObject:Subclass()
ZO_AutoComplete.ON_ENTRY_SELECTED = "ZO_AutoComplete_On_Entry_Selected"
AUTO_COMPLETE_FLAG_ALL = -1
AUTO_COMPLETE_FLAG_NONE = 0
ZO_AutoComplete.FlagHandlers = { }
function ZO_AutoComplete.AddFlag(handler)
    table.insert(ZO_AutoComplete.FlagHandlers, handler)
    return #ZO_AutoComplete.FlagHandlers
end
function ZO_AutoComplete:Initialize(editControl, includeFlags, excludeFlags, onlineOnly, maxResults, mode, allowArrows, dontCallHookedHandlers)
    self:SetEnabled(true)
    self:SetIncludeFlags(includeFlags)
    self:SetExcludeFlags(excludeFlags)
    self:SetOnlineOnly(onlineOnly)
    self:SetMaxResults(maxResults)
    self.automaticMode = mode == nil or mode == AUTO_COMPLETION_AUTOMATIC_MODE
    self.anchorStyle = AUTO_COMPLETION_ANCHOR_TOP
    self.useArrows = allowArrows == nil or AUTO_COMPLETION_USE_ARROWS == allowArrows
    self.dontCallHookedHandlers = dontCallHookedHandlers
    if self.dontCallHookedHandlers == nil then
        self.dontCallHookedHandlers = true
    end
    self.keepFocusOnCommit = true
    self.widthOffsetLeft = 0
    self.widthOffsetRight = 0
    self:SetEditControl(editControl)
    self:SetOwner(editControl)
end
function ZO_AutoComplete:SetEnabled(enabled)
    self.enabled = enabled
    if not enabled then
        self:Hide()
    end
end
function ZO_AutoComplete:SetIncludeFlags(includeFlags)
    self.includeFlags = includeFlags
end
function ZO_AutoComplete:SetExcludeFlags(excludeFlags)
    self.excludeFlags = excludeFlags
end
function ZO_AutoComplete:SetOnlineOnly(onlineOnly)
    self.onlineOnly = onlineOnly
end
function ZO_AutoComplete:SetMaxResults(maxResults)
    self.maxResults = maxResults
end
function ZO_AutoComplete:SetEditControl(editControl)
    if editControl then
        if self.automaticMode then
            ZO_PreHookHandler(editControl, "OnTextChanged", function() self:OnTextChanged() end)
        end
        ZO_PreHookHandler(editControl, "OnEnter", function()
            if self:IsOpen() then
                if not self.keepFocusOnCommit and self.automaticMode then
                    return self:OnCommit(COMMIT_BEHAVIOR_LOSE_FOCUS, AUTO_COMPLETION_SELECTED_BY_ENTER)
                else
                    return self:OnCommit(COMMIT_BEHAVIOR_KEEP_FOCUS, AUTO_COMPLETION_SELECTED_BY_ENTER)
                end
            end
        end)
        ZO_PreHookHandler(editControl, "OnTab", function()
            if self:IsOpen() then
                if not ZO_Menu_GetSelectedIndex() then
                    self:ChangeAutoCompleteIndex(1)
                end
                return self:OnCommit(COMMIT_BEHAVIOR_KEEP_FOCUS, AUTO_COMPLETION_SELECTED_BY_TAB)
            end
        end)
        if self.useArrows then
            ZO_PreHookHandler(editControl, "OnDownArrow", function() self:ChangeAutoCompleteIndex(1) end)
            ZO_PreHookHandler(editControl, "OnUpArrow", function() self:ChangeAutoCompleteIndex(-1) end)
        end
        ZO_PreHookHandler(editControl, "OnFocusLost", function() self:Hide() end)
        ZO_PreHookHandler(editControl, "OnHide", function() self:Hide() end)
    end
    self.editControl = editControl
end
function ZO_AutoComplete:SetOwner(owner)
    self.owner = owner
end
function ZO_AutoComplete:SetKeepFocusOnCommit(keepFocus)
    self.keepFocusOnCommit = keepFocus
end
function ZO_AutoComplete:Show(text)
        self:Hide()
    end
end
function ZO_AutoComplete:Hide()
    if self:IsOpen() then
        ClearMenu()
    end
end
function ZO_AutoComplete:IsOpen()
    return IsMenuVisible() and GetMenuOwner() == self.owner
end
function ZO_AutoComplete:SetUseCallbacks(useCallbacks)
    self.useCallbacks = useCallbacks
end
function ZO_AutoComplete:SetAnchorStyle(style)
    self.anchorStyle = style
end
function ZO_AutoComplete:SetWidthOffsets(left, right)
    self.widthOffsetLeft = left or 0
    self.widthOffsetRight = right or 0
end
do
    local function ComputeSubStringMatchScore(source, startIndex, trimmedTextToScore)
        local startIndex, endIndex = source:find(trimmedTextToScore, startIndex, true)
        if startIndex then
            return ((endIndex - startIndex) / (#source * .1)) * 10
        end
        return 0
    end
    local function ComputeScore(source, scoringText, startIndex, trimmedTextToScore)
        return ComputeStringDistance(source, scoringText) - ComputeSubStringMatchScore(source, startIndex, trimmedTextToScore)
    end
    local POOR_MATCH_RATIO = 0.75
    local POOR_MATCH_MIN = 1
    local scores = {}
    local function BinaryInsertComparer(leftScore, _, rightIndex)
        return leftScore - scores[rightIndex]
    end
    local zo_binarysearch = zo_binarysearch
    function GetTopMatchesByLevenshteinSubStringScore(stringsToScore, scoringText, startingIndex, maxResults, noMinScore)
        maxResults = maxResults or 10
        if maxResults == 0 then return end
        startingIndex = startingIndex or 1
        scoringText = zo_strlower(scoringText)
        local trimmedTextToScore = scoringText:sub(startingIndex, 20)
        local results = {}
        ZO_ClearNumericallyIndexedTable(scores)
        local minScore = POOR_MATCH_RATIO * (zo_min(#scoringText, 10 + startingIndex) - startingIndex - POOR_MATCH_MIN)
        for lowerSource, source in pairs(stringsToScore) do
            local score = ComputeScore(lowerSource, scoringText, startingIndex, trimmedTextToScore)
            if noMinScore or (score <= minScore) then
                local _, insertPosition = zo_binarysearch(score, results, BinaryInsertComparer)
                table.insert(results, insertPosition, source)
                table.insert(scores, insertPosition, score)
                results[maxResults + 1] = nil
                scores[maxResults + 1] = nil
            end
        end
        return results
    end
end
do
    local function TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, include)
        local handler = ZO_AutoComplete.FlagHandlers[flag]
        if handler then
            handler(possibleMatches, input, onlineOnly, include)
        end
    end
    local INCLUDE = true
    local EXCLUDE = false
    local function GenerateAutoCompletionResults(input, maxResults, onlineOnly, includeFlags, excludeFlags, noMinScore)
        local possibleMatches = {}
        if not includeFlags or includeFlags[1] == AUTO_COMPLETE_FLAG_ALL then
            for flag in ipairs(ZO_AutoComplete.FlagHandlers) do
                TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, INCLUDE)
            end
        else
            for i, flag in ipairs(includeFlags) do
                TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, INCLUDE)
            end
        end
        if excludeFlags then
            if excludeFlags[1] == AUTO_COMPLETE_FLAG_ALL then
                return
            end
            for i, flag in ipairs(excludeFlags) do
                TryCallFlagHandler(flag, possibleMatches, input, onlineOnly, EXCLUDE)
            end
        end 
        local results = GetTopMatchesByLevenshteinSubStringScore(possibleMatches, input, 1, maxResults, noMinScore)
        if results then
            return unpack(results)
        end
    end
    function ZO_AutoComplete:GetAutoCompletionResults(text)
        local maxResults = self.maxResults or 10
        local lowerText = text:lower()
        return GenerateAutoCompletionResults(lowerText, maxResults, self.onlineOnly, self.includeFlags, self.excludeFlags)
    end
end
function ZO_AutoComplete:ApplyAutoCompletionResults(...)
    if ... and ... ~= "" then
        ClearMenu()
        SetMenuMinimumWidth(self.editControl:GetWidth() - GetMenuPadding() * 2)
        local numResults = select("#", ...)
        for i = 1, numResults do
            local name = select(i, ...)
            AddMenuItem(name, function()
                if self.useCallbacks then
                    self:FireCallbacks(self.ON_ENTRY_SELECTED, name, AUTO_COMPLETION_SELECTED_BY_CLICK)
                else
                    self.editControl:SetText(name) 
                end
            end)
        end
        ShowMenu(self.owner, nil, MENU_TYPE_TEXT_ENTRY_DROP_DOWN)
        if self.anchorStyle == AUTO_COMPLETION_ANCHOR_BOTTOM then
            ZO_Menu:ClearAnchors()
            ZO_Menu:SetAnchor(BOTTOMLEFT, self.editControl, TOPLEFT, -8 + self.widthOffsetLeft, -2)
            ZO_Menu:SetAnchor(BOTTOMRIGHT, self.editControl, TOPRIGHT, 8 + self.widthOffsetRight, -2)
        else
            ZO_Menu:ClearAnchors()
            ZO_Menu:SetAnchor(TOPLEFT, self.editControl, BOTTOMLEFT, -8 + self.widthOffsetLeft, 2)
            ZO_Menu:SetAnchor(TOPRIGHT, self.editControl, BOTTOMRIGHT, 8 + self.widthOffsetRight, 2)
        end
        return true
    end
    return false
end
function ZO_AutoComplete:OnTextChanged()
    if self.enabled and self.editControl:HasFocus() and self.editControl:GetText() ~= "" then
        self:Show(self.editControl:GetText())
    else
        self:Hide()
    end
end
function ZO_AutoComplete:ChangeAutoCompleteIndex(offset)
    if self:IsOpen() then
        local numItems = ZO_Menu_GetNumMenuItems()
        if numItems > 0 then
            local index = (ZO_Menu_GetSelectedIndex() or 0) + offset
        
            ZO_Menu_SetSelectedIndex(index)
        end
    end
end
function ZO_AutoComplete:GetNumAutoCompleteEntries()
    if self:IsOpen() then
        return ZO_Menu_GetNumMenuItems()
    end
end
function ZO_AutoComplete:GetAutoCompleteIndex()
    if self:IsOpen() then
        return ZO_Menu_GetSelectedIndex()
    end
end 
function ZO_AutoComplete:OnCommit(commitBehavior, commitMethod)
    if self:IsOpen() then
        local selectedIndex = ZO_Menu_GetSelectedIndex()
        if selectedIndex then
            local name = ZO_Menu_GetSelectedText()
            if self.useCallbacks then
                self:FireCallbacks(self.ON_ENTRY_SELECTED, name, commitMethod)
            else
                self.editControl:SetText(name) 
            end
        end
        if not commitBehavior or commitBehavior == COMMIT_BEHAVIOR_LOSE_FOCUS then
            self.editControl:LoseFocus()
        end
        self:Hide()
        if selectedIndex then
            return self.dontCallHookedHandlers
        else
            return false
        end
    end
end