io.lua

-- MODULE IO.LUA
-- by Garran Plum
--
-- Foundation-specific I/O functions for all GP mods.
-- 
-- FUNCTION ASSIGNMENTS
-- IMPORT GP OBJECT
local myMod, GP = ...

-- GP FOUNDATION FUNCTION Write
-- Writes a string to a file. Default = "GP.log".
-- I/O EFFECT
function GP:write(fileContent, fileName)

    -- Set a default fileName if one isn't provided.
    fileName = fileName or "GP.log"

    -- Setup for return status.
    local isWriteSuccessful = false

    -- Setup file path.
    local filePath = GP:magicWords().log.folder .. '/' .. fileName

    -- Clear a path to writing by ensuring folders exist.
    GP:clearPath(filePath)

    -- Call the Foundation function to write the file and grab the return boolean.
    isWriteSuccessful = myMod:writeFileAsString(filePath, fileContent)

end

-- GP FOUNDATION FUNCTION Write Table
-- Writes a table to a file. Default = [modName].log
-- I/O EFFECT
function GP:writeTable(incomingTable, fileName)

    -- Set a default fileName if one isn't provided.
    -- Uses GP.load instead of GP:config() to preclude looping if config() calls writeTable().
    fileName = (fileName or GP:load(configPath).modName) .. ".log"

    -- Registration w/ DataType? Add a folder for it.
    if incomingTable.DataType then
        fileName = incomingTable.DataType .. "/" .. fileName
    end

    -- Add a local var declaration to make the log valid Lua.
    local logVar = incomingTable.Id or "gpsLog"
    local varDeclaration = "local" .. " " .. logVar .. " = " .. "\n"

    -- Write the table serialized as a string with the log variable declaration.
    GP:write(varDeclaration .. GP:serializeTable(incomingTable), fileName)
end

-- GP FOUNDATION FUNCTION Clear Path
-- Clears a path to file writing by creating all nested folders.
-- I/O EFFECT
function GP:clearPath(incomingString)

    -- Separate the file path and file name.
    local filePath, fileName = GP:filePath(incomingString)

    -- If path doesn't exist, create it.
    if not myMod:directoryExists(filePath) then
        myMod:createDirectory(filePath)
    end
end