-- create global instance
ViragDevTool = {
METATABLE_NAME = "$metatable",
tArgs = {}
}
-- just remove global reference so it is easy to read with my ide
local ViragDevTool = ViragDevTool
local pairs, tostring, type, print, string, getmetatable, table, pcall = pairs, tostring, type, print, string, getmetatable, table, pcall
local HybridScrollFrame_CreateButtons, HybridScrollFrame_GetOffset, HybridScrollFrame_Update = HybridScrollFrame_CreateButtons, HybridScrollFrame_GetOffset, HybridScrollFrame_Update
--- Linked List
-- @field size
-- @field first
-- @field last
--
-- Each node has:
-- @field name - string name
-- @field value - any object
-- @field next - nil/next node
-- @field padding - int expanded level( when you click on table it expands so padding = padding + 1)
-- @field parent - parent node after it expanded
-- @field expanded - true/false/nil
local ViragDevToolLinkedList = {
size = 0;
first = nil,
last = nil
}
ViragDevTool.list = ViragDevToolLinkedList
function ViragDevToolLinkedList:GetInfoAtPosition(position)
if self.size < position or self.first == nil then
return nil
end
local node = self.first
while position > 0 do
node = node.next
position = position - 1
end
return node
end
function ViragDevToolLinkedList:AddNodesAfter(nodeList, parentNode)
local tempNext = parentNode.next
local currNode = parentNode;
for _, node in pairs(nodeList) do
currNode.next = node
currNode = node
self.size = self.size + 1;
end
currNode.next = tempNext
if tempNext == nil then
self.last = currNode
end
end
function ViragDevToolLinkedList:AddNode(data, dataName)
local node = self:NewNode(data, dataName)
if self.first == nil then
self.first = node
self.last = node
else
if self.last ~= nil then
self.last.next = node
end
self.last = node
end
self.size = self.size + 1;
end
function ViragDevToolLinkedList:NewNode(data, dataName, padding, parent)
return {
name = dataName,
value = data,
next = nil,
padding = padding == nil and 0 or padding,
parent = parent
}
end
function ViragDevToolLinkedList:RemoveChildNodes(node)
local currNode = node
while true do
currNode = currNode.next
if currNode == nil then
node.next = nil
self.last = node
break
end
if currNode.padding <= node.padding then
node.next = currNode
break
end
self.size = self.size - 1
end
end
function ViragDevToolLinkedList:Clear()
self.size = 0
self.first = nil
self.last = nil
end
---
-- Main (and the only) function you can use in ViragDevTool API
-- Will add data to the list so you can explore its values in UI list
-- @usage
-- Lets suppose you have MyModFN function in yours addon
-- function MyModFN()
-- local var = {}
-- ViragDevTool_AddData(var, "My local var in MyModFN")
-- end
-- This will add var as new var in our list
-- @param data (any type)- is object you would like to track.
-- Default behavior is shallow copy
-- @param dataName (string or nil) - name tag to show in UI for you variable.
-- Main purpose is to give readable names to objects you want to track.
function ViragDevTool_AddData(data, dataName)
if dataName == nil then
dataName = tostring(data)
end
ViragDevTool.list:AddNode(data, tostring(dataName))
ViragDevTool:UpdateUI()
end
function ViragDevTool:ClearData()
self.list:Clear()
self:UpdateUI()
end
function ViragDevTool:ExpandCell(info)
local nodeList = {}
local padding = info.padding + 1
local couner = 1
for k, v in pairs(info.value) do
if type(v) ~= "userdata" then
nodeList[couner] = self.list:NewNode(v, tostring(k), padding, info)
else
local mt = getmetatable(info.value)
if mt then
nodeList[couner] = self.list:NewNode(mt.__index, self.METATABLE_NAME, padding, info)
end
end
couner = couner + 1
end
table.sort(nodeList, function(a, b)
if a.name == "__index" then return true
elseif b.name == "__index" then return false
else return a.name < b.name
end
end)
self.list:AddNodesAfter(nodeList, info)
info.expanded = true
ViragDevTool:UpdateUI()
end
function ViragDevTool:ColapseCell(info)
self.list:RemoveChildNodes(info)
info.expanded = nil
self:UpdateUI()
end
function ViragDevTool:UpdateUI()
local scrollFrame = self.wndRef.scrollFrame
self:ScrollBar_AddChildren(scrollFrame)
local buttons = scrollFrame.buttons;
local offset = HybridScrollFrame_GetOffset(scrollFrame)
local totalRowsCount = self.list.size
local lineplusoffset;
local nodeInfo = self.list:GetInfoAtPosition(offset)
for k, view in pairs(buttons) do
lineplusoffset = k + offset;
if lineplusoffset <= totalRowsCount then
self:UIUpdateListItem(view, nodeInfo, lineplusoffset)
nodeInfo = nodeInfo.next
view:Show();
else
view:Hide();
end
end
HybridScrollFrame_Update(scrollFrame, totalRowsCount * buttons[1]:GetHeight(), scrollFrame:GetHeight());
end
function ViragDevTool:ScrollBar_AddChildren(self)
if self.ScrollBarHeight == nil or self:GetHeight() > self.ScrollBarHeight then
self.ScrollBarHeight = self:GetHeight()
local scrollBarValue = self.scrollBar:GetValue()
HybridScrollFrame_CreateButtons(self, "ViragDevToolEntryTemplate", 0, -2)
self.scrollBar:SetValue(scrollBarValue);
end
end
function ViragDevTool:UIUpdateListItem(node, info, id)
local nameButton = node.nameButton;
local typeButton = node.typeButton
local valueButton = node.valueButton
local rowNumberButton = node.rowNumberButton
local value = info.value
local name = info.name
local padding = info.padding
nameButton:SetPoint("LEFT", node.typeButton, "RIGHT", 20 * padding, 0)
local valueType = type(value)
valueButton:SetText(tostring(value))
nameButton:SetText(tostring(name))
typeButton:SetText(valueType)
rowNumberButton:SetText(tostring(id))
local color = "ViragDevToolBaseFont"
if valueType == "table" then
if name ~= self.METATABLE_NAME then
if value.GetObjectType and value.IsForbidden then
local ok, forbidden = pcall(value.IsForbidden, value)
if ok and not forbidden then
local ok, result = pcall(value.GetObjectType, value)
if ok then
valueButton:SetText(result .. " " .. tostring(value))
end
end
end
color = "ViragDevToolTableFont";
else
color = "ViragDevToolMetatableFont";
end
local resultStringName = tostring(name)
local MAX_STRING_SIZE = 60
if #resultStringName >= MAX_STRING_SIZE then
resultStringName = string.sub(resultStringName, 0, MAX_STRING_SIZE) .. "..."
end
local function tablelength(T)
local count = 0
for _ in pairs(T) do count = count + 1 end
return count
end
nameButton:SetText(resultStringName .. " (" .. tablelength(value) .. ") ");
elseif valueType == "userdata" then
color = "ViragDevToolTableFont";
elseif valueType == "string" then
valueButton:SetText(string.gsub(string.gsub(tostring(value), "|n", ""), "\n", ""))
color = "ViragDevToolStringFont";
elseif valueType == "number" then
color = "ViragDevToolNumberFont";
elseif valueType == "function" then
color = "ViragDevToolFunctionFont";
--todo add function args info and description from error msges or from some mapping file
end
node.nameButton:SetNormalFontObject(color)
node.typeButton:SetNormalFontObject(color)
node.valueButton:SetNormalFontObject(color)
node.rowNumberButton:SetNormalFontObject(color)
if valueType == "table" then
nameButton:SetScript("OnMouseUp", function(this, button, down)
if info.expanded then
self:ColapseCell(info)
else
self:ExpandCell(info)
end
end)
elseif valueType == "function" then
nameButton:SetScript("OnMouseUp", function(this, button, down)
self:TryCallFunction(info)
end)
else
nameButton:SetScript("OnMouseUp", nil)
end
end
function ViragDevTool:TryCallFunction(info)
-- info.value is just our function to call
local parent, ok
local fn = info.value
local args = self:shallowcopyargs(self.tArgs)
local results = {}
-- lets try safe call first
ok, results[1], results[2], results[3], results[4], results[5] = pcall(fn, unpack(args, 1, 10))
if not ok then
-- if safe call failed we probably could try to find self and call self:fn()
parent = info.parent
if parent and parent.value == _G then
-- this fn is in global namespace so no parent
parent = nil
end
if parent then
if parent.name == self.METATABLE_NAME then
-- metatable has real object 1 level higher
parent = parent.parent
end
fn = parent.value[info.name]
table.insert(args, 1, parent.value)
ok, results[1], results[2], results[3], results[4], results[5] = pcall(fn, unpack(args, 1, 10))
end
end
self:ProcessCallFunctionData(ok, info, parent, args, results)
end
--todo refactore this
local ViragDevTool_Colors = {
white = "|cFFFFFFFF",
gray = "|cFFBEB9B5",
lightblue = "|cFF96C0CE",
red = "|cFFFF0000",
green = "|cFF00FF00",
darkred = "|cFFC25B56",
parent = "|cFFBEB9B5",
error = "|cFFC25B56",
ok = "|cFF00FF00",
}
function ViragDevTool_Colors:forState(state)
if state then return self.ok end
return self.darkred
end
function ViragDevTool_Colors:stateStr(state)
if state then return self.ok .. "OK" end
return self.red .. "ERROR"
end
function ViragDevTool_Colors:errorText()
return self:stateStr(false) .. self.error .. " function call failed"
end
function ViragDevTool_Colors:FNNameToString(name, args)
-- Create function call string like myFunction(arg1, arg2, arg3)
local fnNameWitArgs = ""
local delimiter = ""
local found = false
for i = 10, 1, -1 do
if args[i] ~= nil then found = true end
if found then
fnNameWitArgs = tostring(args[i]) .. delimiter .. fnNameWitArgs
delimiter = ", "
end
end
return name .. "(" .. fnNameWitArgs .. ")"
end
function ViragDevTool_Colors:functionStr(parent, name, args)
local resultStr = self:FNNameToString(name, args)
if parent then
return self.parent .. parent.name .. ":" .. self.white .. resultStr
else
return self.white .. resultStr
end
end
ViragDevTool.colors = ViragDevTool_Colors
-- this function is kinda hard to read but it just adds new items to list and prints log in chat.
-- will add 1 row for call result(ok or error) and 1 row for each return value
function ViragDevTool:ProcessCallFunctionData(ok, info, parent, args, results)
local nodes = {}
local C = self.colors
local list = self.list
--constract full function call name
local fnNameWitArgs = C:functionStr(parent, info.name, args)
local returnFormatedStr = ""
if not ok then
-- if function call was unsuccessful
nodes[1] = list:NewNode(tostring(results[1]), C:errorText(), info.padding + 1)
returnFormatedStr = string.format(" %s%s", C.white, tostring(results[1]))
else
-- itterate backwords because we want to include every meaningfull nil result
-- for example 1, 2, nil, 4 should return only this 4 values nothing more nothing less.
local found = false
for i = 10, 1, -1 do
if results[i] ~= nil then found = true end
if found or i == 1 then
nodes[i] = list:NewNode(results[i], string.format(" ret: %d", i), info.padding + 1)
returnFormatedStr = string.format(" %s%s %s(%s)%s", C.white, tostring(results[i]),
C.lightblue, type(results[i]), returnFormatedStr)
end
end
end
-- create fist node of result info no need for now. will use debug
local titleNode = list:NewNode(
string.format("%s - %s", C:stateStr(ok), fnNameWitArgs), -- node value
C:forState(ok) .. date("%X") .. " function call results:", -- node name
info.padding + 1) -- node padding
table.insert(nodes, 1, titleNode)
-- adds call result to our UI list
list:AddNodesAfter(nodes, info)
self:UpdateUI()
--print info to chat
local resultInfoStr = C:stateStr(ok) .. " " .. fnNameWitArgs .. C.gray .. " returns:" .. returnFormatedStr
print(C.darkred .. "[Virag's DT]: " .. C.white .. resultInfoStr)
-- if everything faild, just show default Blizzard error
-- if not ok then
-- fn(args)
-- end
end
---
-- LIFECICLE
--
function ViragDevTool:OnLoad(this)
self.wndRef = this
this:RegisterEvent("ADDON_LOADED")
--register update scrollFrame
self.wndRef.scrollFrame.update = function()
self:UpdateUI()
end
self:UpdateUI()
-- register slash cmd
SLASH_VIRAGDEVTOOLS1 = '/vdt';
function SlashCmdList.VIRAGDEVTOOLS(msg, editbox) -- 4.
ViragDevTool_AddData(_G[strGlobalName], strGlobalName)
end
end
function ViragDevTool:OnEvent(this, event, arg1, arg2, arg3)
if event == "VARIABLES_LOADED" then
if not ViragDevTool_Settings then ViragDevTool_Settings = {} end
self.settings = ViragDevTool_Settings
end
end
---
-- UTILS
--
function ViragDevTool:print(table)
print(tostring(table))
for k, v in pairs(table or {}) do
print(k .. ": " .. v.name)
end
end
function ViragDevTool:shallowcopyargs(orig)
local copy = {}
for k, v in pairs(orig) do copy[k] = orig[v] end
return copy
end