ESOUI - SavedVariables Problem...Any Ideas?

ESOUI (https://www.esoui.com/forums/index.php)

- Lua/XML Help (https://www.esoui.com/forums/forumdisplay.php?f=175)

- - SavedVariables Problem...Any Ideas? (https://www.esoui.com/forums/showthread.php?t=4470)

SavedVariables Problem...Any Ideas?

Anyone have any ideas on this.

Whenever the function (below) runs and adds the scriptName & script to the scripts table...and then I try to reload the UI (or just wait long enough) the game crashes & the saved variable file is over 1 gig.
That is the only line of code that adds anything to the saved variables file.

Code Paste here, Line 392 is the problem: http://pastebin.com/sjnG4v9d

Or if you want/need to see the whole addon you can find it here: Drop Box Zip File

CLICK4INFO.sv -- Is my saved variables
CLICK4INFO.sv.scripts -- Is just an empty table to start out.

Lua Code:

function Click4Info_AddScript(self)
    local scriptName = CLICK4INFO.nameEditBox:GetText()
    local script = CLICK4INFO.scriptEditBox:GetText()
    
    if not scriptName or scriptName == "" then return end
    if not script or script == "" then return end
    
    -- This Msg only prints once
    -- so its not infinitely looping this function
    debugMsg("Adding Script")
 
    -- check to see if it already exists
    if not DoesScriptNameExist(scriptName) then
    
        -- This line is the problem:
        table.insert(CLICK4INFO.sv.scripts, {["scriptName"] = scriptName, ["script"] = script})
    end
end

I think the problem is the DoesScriptNameExist function.
CLICK4INFO.sv.scripts is a indexed table (using table.insert)

The function should be like this:

Lua Code:

local function DoesScriptNameExist(scriptName)
    local scripts = CLICK4INFO.sv.scripts
    for _, script in ipairs(scripts) do
        if script.scriptName == scriptName then
            return true
        end
    end
    return false
end

Quote:

Originally Posted by votan (Post 19831)

I think the problem is the DoesScriptNameExist function.
CLICK4INFO.sv.scripts is a indexed table (using table.insert)

The function should be like this:

Lua Code:

local function DoesScriptNameExist(scriptName)
    local scripts = CLICK4INFO.sv.scripts
    for _, script in ipairs(scripts) do
        if script.scriptName == scriptName then
            return true
        end
    end
    return false
end

Or you can replace table.insert and remove whole DoesScriptNameExist function:

Lua Code:

function Click4Info_AddScript(self)
    local scriptName = CLICK4INFO.nameEditBox:GetText()
    local script = CLICK4INFO.scriptEditBox:GetText()
 
    if not script or script == "" then return end
    if not scriptName or scriptName == "" then
        scriptName = "New Script"
    end
 
    debugMsg("Adding Script")
 
    local scripts = CLICK4INFO.sv.scripts
    local uniqueScriptName = scriptName
    local counter = 1
 
    while scripts[uniqueScriptName] ~= nil do
        uniqueScriptName = ("%s (%d)"):format(scriptName, counter)
        counter = counter + 1
    end
 
    scripts[uniqueScriptName] = script
end

Quote:

Originally Posted by votan (Post 19831)

I think the problem is the DoesScriptNameExist function.
CLICK4INFO.sv.scripts is a indexed table (using table.insert)

The function should be like this:

Lua Code:

local function DoesScriptNameExist(scriptName)
    local scripts = CLICK4INFO.sv.scripts
    for _, script in ipairs(scripts) do
        if script.scriptName == scriptName then
            return true
        end
    end
    return false
end

Oh yeah I forgot I changed how I was saving the information. I was doing it like Garkin suggested below and forgot to fix that function.

But, that does not solve the problem.

Quote:

Originally Posted by Garkin (Post 19832)

Or you can replace table.insert and remove whole DoesScriptNameExist function:

I was originally doing something similar to what you suggested adding the information to the table and checking to see if it already existed like this:

Lua Code:

if not CLICK4INFO.sv.scripts[scriptName] then
    CLICK4INFO.sv.scripts[scriptName] = script
end

By the way doing it like this does NOT cause the error.

But if I do it like that then every time I try to populate the scroll list with that information I would have to copy it into another table & reorganize it like this any way:

Lua Code:

{["scriptName"] = scriptName, ["script"] = script}

Because in When you call:

Lua Code:

local entry = ZO_ScrollList_CreateDataEntry(ROW_TYPE_ID, rowData, 1)
table.insert(dataList, entry)

To add a row to the scrollList you have to pass in rowData which is a table (well it doesn't have to be a table, but since I need to pass in two pieces of information it needs to be a table to hold all of the information). If I did it the old way:

Lua Code:

CLICK4INFO.sv.scripts[scriptName] = script

I would loose the scriptName & only script would get passed to my setupDataRow function. Unless I copy the script information into the correct format first so I can pass in rowData as a table like:

Lua Code:

{["scriptName"] = scriptName, ["script"] = script}

Although I could do that..it just seemed like a waste and slower. My choices are do a little extra function call with special code to see if a scriptName already exists, which only runs when you add a new script. Or Repack all of the information into a new table every time the data is displayed.

The only thing that stops the error (without changing it to the old way that Garkin suggested) is commenting out this line:

Lua Code:

--table.insert(CLICK4INFO.sv.scripts, {["scriptName"] = scriptName, ["script"] = script})

So the problem has to have something to do with that?

EDIT: I had tried to open the saved variable file before to see what was in it, why it was getting so large but notepad++ always crashed. I got lucky this time & was able to open it & see what was getting saved in the scripts table.
Which now knowing what was in there I was able to find the problem.

This function calls ZO_ScrollList_CreateDataEntry

Lua Code:

function Click4Info:UpdateScrollList(sourceTable) 
   ...
   -- which calls:
   local entry = ZO_ScrollList_CreateDataEntry(ROW_TYPE_ID, rowData, 1)  
  ...
end

Which causes some recursion here copying data into itself, data.dataEntry.data = data
Which I guess is ok for items in the game ? not sure why or what the purpose of that is ? but since the data object I was passing in was a table inside the saved variable file it was doing that recursion in the saved variable file saving data inside its self infinitely.

Lua Code:

function ZO_ScrollList_CreateDataEntry(typeId, data, categoryId)
    local entry =
    {
        typeId = typeId,
        categoryId = categoryId,
        data = data,
    }
    data.dataEntry = entry
    return entry
end

Saved Variable file scripts table:

I guess I also sometimes see this inside ZGOO when I inspect controls.
They seem to have an data entry which got another data entry with a third data entry and so on.

I was always wondering why was shown this way and thought it's only a "visual" problem with ZGOO, where parents and childs (where parent and child are the same somehow) are shown in the same control again.

Lua tables are essentially references, so it's not that uncommon/difficult to have some nested loops.

For example, this is really all you need for setting it up:

Lua Code:

local foo = {}
foo.bar = foo

I'm not sure that you can throw a recursive table structure into SavedVars normally, so probably create it elsewhere and do a deep copy that removes those references.

Here's a gist someone put up on different deep copy methods:
https://gist.github.com/tylerneylon/...21109155b2d244

Quote:

Originally Posted by Sasky (Post 19863)

Lua tables are essentially references, so it's not that uncommon/difficult to have some nested loops.

For example, this is really all you need for setting it up:

Lua Code:

local foo = {}
foo.bar = foo

Yeah, I didn't want the recursion in the saved variables, I just didn't realize that was happening until now.
Thats what I did to solve it, I just did a deep copy and used that to add the data rows to the scroll list.

BTW, theres already a built in function for it:

Lua Code:

ZO_DeepTableCopy(table source, table dest)

Thanks everyone for the ideas !

You could also get around that by giving CreateDataEntry a wrapper table instead of copying the data:

Lua Code:

local entry = ZO_ScrollList_CreateDataEntry(typeId, {mydata = realdata})
-- it will then look like this
entry = {
  typeId = typeId,
  categoryId = categoryId,
  data = {mydata = realdata, dataEntry = entry},
}
-- the data.dataEntry.data.dataEntry... cycle doesn't infect realdata

Or use a metatable:

Lua Code:

local mtdata = {__index = realdata}
local entry = ZO_ScrollList_CreateDataEntry(typeId, setmetatable({}, mtdata))
mtdata.__newindex = realdata
-- it will then look like this
entry = {
  typeId = typeId,
  categoryId = categoryId,
  data = {dataEntry = entry},
}
-- but entry.data.thing will return realdata.thing