Back to Home

ESO Lua File v101041

libraries/globals/debugutils.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
local function EmitMessage(text)
    if text == "" then
        text = "[Empty String]"
    end
    if CHAT_ROUTER then
        CHAT_ROUTER:AddDebugMessage(text)
    elseif RequestDebugPrintText then
        RequestDebugPrintText(text)
    end
end
local function EmitTable(t, indent, tableHistory)
    indent          = indent or "."
    tableHistory    = tableHistory or {}
    
    for k, v in pairs(t)
    do
        local vType = type(v)
        EmitMessage(indent.."("..vType.."): "..tostring(k).." = "..tostring(v))
        
        if(vType == "table")
        then
            if(tableHistory[v])
            then
                EmitMessage(indent.."Avoiding cycle on table...")
            else
                tableHistory[v] = true
                EmitTable(v, indent.." ", tableHistory)
            end
        end
    end    
end
function d(...)    
    for i = 1, select("#", ...) do
        local value = select(i, ...)
        if(type(value) == "table")
        then
            EmitTable(value)
        else
            EmitMessage(tostring (value))
        end
    end
end
function df(formatter, ...)
    return d(formatter:format(...))
end
function countGlobals(desiredType)
    if(desiredType == nil)
    then
        countGlobals("number")
        countGlobals("string")
        countGlobals("boolean")
        countGlobals("table")
        countGlobals("function")
        countGlobals("thread")
        countGlobals("userdata")
        return
    end
    local count = 0
    desiredType = tostring(desiredType)
    
    for k, v in pairs(_G)
    do 
        if(type(v) == desiredType)
        then 
            count = count + 1 
        end 
    end 
    
    d("There are "..count.." variables of type "..desiredType)
end
function eventArgumentDebugger(...)
    local arg = { ... }    
    local numArgs = #arg
    
    if(numArgs == 0)
    then
        return "[Unamed event, without arguments]"
    end
    
    local eventName = arg[1]
    
    if(EVENT_NAME_LOOKUP) -- nice, we can get a string look up for this event code! (TODO: just expose these as strings?)
    then
        eventName = EVENT_NAME_LOOKUP[eventName] or eventName
    end
    
    local argString = "["..eventName.."]"
    local currentArg
    
    for i = 2, numArgs
    do
        currentArg = arg[i]
        if(type(currentArg) ~= "userdata")
        then
            argString = argString.."|c00ff00["..i.."]:|r "..tostring(currentArg)
        else
            -- Assume it's a control...which may not always be correct
            argString = argString.."|c00ff00["..i.."]:|r "..currentArg:GetName()
        end
        
        if(i < numArgs) then argString = argString..", " end
    end
    
    return argString
end
local eventRegistry = {}
function ZO_Debug_EventNotification(eventCode, register, allEvents)
    local eventManager = GetEventManager()
    local eventName = "ZO_Debug_EventNotification"..eventCode
    
    if(register and not eventRegistry[eventName])
    then
        eventRegistry[eventName] = true
        
        if(allEvents)
        then
            eventManager:RegisterForAllEvents(eventName, function(...) d(eventArgumentDebugger(...)) end)
        else
            eventManager:RegisterForEvent(eventName, eventCode, function(...) d(eventArgumentDebugger(...)) end)
        end
    else
        eventRegistry[eventName] = nil
        eventManager:UnregisterForEvent(eventName)
    end
end
-- Because typing is painful.
function all() e(0, true, true) end
-- Convenience for multiple event registration only using event variables.
-- Pass in multiple comma delimited events as the arguments:
-- ZO_Debug_MultiEventRegister(EVENT_QUEST_LIST_UPDATED, EVENT_QUEST_CONDITION_COUNTER_CHANGED, EVENT_QUEST_TOOL_UPDATED, etc...)
    for i = 1, select("#", ...)
    do
        -- NOTE: should be able to use arg[i] here, but it's not reliable...
        local eventCode = select(i, ...)
        e(eventCode, true, false)
    end
end
--
-- Execute a command with a well-known pattern over a range of numbers.
-- You give a base command (like: "]createitem")
-- and a range (start id, end id)
-- This function executes it using ExecuteChatCommand(finalCommand) n times where n = end - start
-- and where the id fed to ExecuteChatCommand is start + i.
function ExecutePatternedChatCommand(commandBase, startId, endId)
    if(type(startId) == "number" and type(endId) == "number" and endId > startId)
    then
        for i = startId, endId
        do
            ExecuteChatCommand(string.format("%s %s", commandBase, tostring(i)))
        end
    end
end
--
-- Utility to grab the current mouse over window and display its details.
-- stands for MouseOverName
--
function mon()
    local control = moc()
    
    if(control and type(control) == "userdata") then
        d(control)
    else
        d("Mouse isn't over a control, or isn't over a mouseEnabled control.")
    end
    
    return control
end
function moc()
    return WINDOW_MANAGER:GetMouseOverControl()
end
local tierToString =
{
    [DT_LOW] = "LOW",
    [DT_MEDIUM] = "MEDIUM",
    [DT_HIGH] = "HIGH",
    [DT_PARENT] = "PARENT",
}
local layerToString =
{
    [DL_BACKGROUND] = "BACKGROUND",
    [DL_CONTROLS] = "CONTROLS",
    [DL_TEXT] = "TEXT",
    [DL_OVERLAY] = "OVERLAY",
}
local function drawInfo(control)
    local drawTier = tierToString[control:GetDrawTier()] or tostring(control:GetDrawTier())
    local drawLayer = layerToString[control:GetDrawLayer()] or tostring(control:GetDrawLayer())
    d(string.format("|c00ff00DrawInfo of: %s\n Tier[%s] Layer[%s] Level[%d]", control:GetName(), drawTier, drawLayer, control:GetDrawLevel()))
end
do
    local memoryUsedBeforeKB = {}
    local memoryUsedAfterKB = {}
    local memoryDeltaKB = {}
    function ZO_StartMemProfile(tag)
        -- Don't want adding elements to the table to count the test
        if not memoryUsedBeforeKB[tag] then
            memoryUsedBeforeKB[tag] = 0
            memoryUsedAfterKB[tag] = 0
            memoryDeltaKB[tag] = 0
        end
        -- Manually run the garbage collector, to avoid measuring the garbage alongside the used memory
        -- Supposedly garbage can take two full cycles to clear if you're using the __gc hook or weak tables or something such,
        -- and that might be superstition but can't hurt
        for i=1, 2 do collectgarbage('collect') end
        memoryUsedBeforeKB[tag] = collectgarbage('count')
    end
    function ZO_StopMemProfile(tag)
        for i=1, 2 do collectgarbage('collect') end
        local afterKB = collectgarbage('count')
        memoryUsedAfterKB[tag] = afterKB
        local deltaKB = afterKB - memoryUsedBeforeKB[tag]
        memoryDeltaKB[tag] = deltaKB
        WriteToInterfaceLog(string.format("Lua mem profile '%s' result: %.3f kb", tag, deltaKB))
        return deltaKB
    end
    function ZO_GetLastMemProfileDelta(tag)
        return memoryDeltaKB[tag]
    end
end