--[[ Copyright (c) 2010 Peter "Corsix" Cawley Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --]] local persist = require("persist") local saved_permanents = {} strict_declare_global "permanent" strict_declare_global "unpermanent" local th_getfenv local th_getupvalue -- luacheck: ignore 231 if _G._VERSION == "Lua 5.1" then th_getfenv = debug.getfenv th_getupvalue = debug.getupvalue else th_getfenv = function(f) local _, val = nil, nil if type(f) == "function" then _, val = debug.getupvalue(f, 1) elseif type(f) == "userdata" then val = debug.getuservalue(f) else print('Unhandled argument to th_getfenv') end return val end th_getupvalue = function(f, n) return debug.getupvalue(f, n + 1) end end function permanent(name, ...) if select('#', ...) == 0 then return function (...) return permanent(name, ...) end end local value = ... assert(value ~= nil) assert(saved_permanents[name] == nil) saved_permanents[name] = value return value end function unpermanent(name) assert(saved_permanents[name] ~= nil) saved_permanents[name] = nil end local --[[persistable:persistance_global_fetch]] function global_fetch(...) local val = _G for _, k in ipairs({...}) do val = val[k] end return val end local function MakePermanentObjectsTable(inverted) local return_val = setmetatable({}, {}) local permanent = return_val if inverted then getmetatable(permanent).__newindex = function(t, k, v) rawset(t, v, k) end end -- Global functions for k, v in pairs(_G) do if type(v) == "function" then permanent[v] = k end end -- Lua class methods for name, class in pairs(_G) do repeat if type(class) ~= "table" then break -- continue end local class_mt = getmetatable(class) if not class_mt or class_mt.__class_name ~= name then break -- continue end permanent[class] = name .. ".1" permanent[class_mt] = name .. ".2" for k, v in pairs(class) do if type(v) == "function" then permanent[v] = name .. "." .. k end end for k, v in pairs(class._metatable) do if type(v) == "function" then permanent[v] = name .. "._metatable." .. k end end until true end -- C/class/library methods for name, lib in pairs(package.loaded) do if not name:find(".", 1, true) then permanent[lib] = name end if type(lib) == "table" then for k, v in pairs(lib) do local type_of_lib = type(v) if type_of_lib == "function" or type_of_lib == "table" or type_of_lib == "userdata" then permanent[v] = name .. "." .. k if name == "TH" and type_of_lib == "table" then -- C class metatables local callenv = th_getfenv(getmetatable(v).__call) permanent[callenv] = name .. "." .. k .. "." end end end else print("Warning: Expected table but got " .. type(lib) .. ". A library probably failed to load.") end end -- Bits of the app permanent[TheApp] = "TheApp" for _, key in ipairs({"config", "modes", "video", "strings", "audio", "gfx", "fs", "moviePlayer"}) do permanent[TheApp[key]] = inverted and "TheApp." .. key or {global_fetch, "TheApp", key} end for _, collection in ipairs({"walls", "objects", "rooms", "humanoid_actions", "diseases"}) do for k, v in pairs(TheApp[collection]) do if type(k) == "string" then permanent[v] = inverted and "TheApp." .. collection .. "." .. k or {global_fetch, "TheApp", collection, k} end end end -- If loading a game from the main menu, there will be no menu bar, so make one local menu_bar = TheApp.ui and TheApp.ui.menu_bar if not menu_bar then -- The menu bar wants a UI, but it is happy with just something naming an App menu_bar = UIMenuBar({app = TheApp}) end permanent[menu_bar] = "TheApp.ui.menu_bar" -- Graphics bits are persisted as instructions to reload them or reuse if already loaded if inverted then -- as the object was persisted as a table, we need to add some magic to -- the __index metamethod to interpret this table as a function call getmetatable(return_val).__index = function(_, k) if type(k) == "table" then return k[1](unpack(k, 2)) end end else -- load_info is a table containing a method and parameters to load obj pause_gc_and_use_weak_keys(function(p) for obj, load_info in pairs(TheApp.gfx.load_info) do p[obj] = load_info end end, permanent) end -- Things requested to be permanent by other bits of code for name, value in pairs(saved_permanents) do permanent[value] = name end return return_val end local function NameOf(obj) -- Debug aid local explored = {[_G] = true} local to_explore = {[_G] = "_G"} while true do local exploring, name = next(to_explore) if exploring == nil then break end to_explore[exploring] = nil if exploring == obj then return name end if type(exploring) == "table" then for key, val in pairs(exploring) do if not explored[val] then to_explore[val] = name .. "." ..tostring(key) explored[val] = true end end elseif type(exploring) == "function" then local i = 0 while true do i = i + 1 local dbg_name, val = debug.getupvalue(exploring, i) if not dbg_name then break end if val ~= nil and not explored[val] then to_explore[val] = name .. "." explored[val] = true end end end local mt = debug.getmetatable(exploring) if mt and not explored[mt] then to_explore[mt] = name .. "." explored[mt] = true end mt = th_getfenv(exploring) if mt and not explored[mt] then to_explore[mt] = name .. "." explored[mt] = true end end return "" end strict_declare_global "SaveGame" strict_declare_global "SaveGameFile" strict_declare_global "LoadGame" strict_declare_global "LoadGameFile" function SaveGame() local state = { ui = TheApp.ui, world = TheApp.world, map = TheApp.map, random = math.randomdump(), } state.map:prepareForSave() --local status, res = xpcall(function() local result, err, obj = persist.dump(state, MakePermanentObjectsTable(false)) state.map:afterSave() if not result then print(obj, NameOf(obj)) -- for debugging error(err) else return result end --end, persist.errcatch) end --! Save a game to disk. --!param filename (string) Path of the file to write. function SaveGameFile(filename) local data = SaveGame() local f = TheApp:writeToFileOrTmp(filename, "wb") f:write(data) f:close() end --! Compatibility function to work out the game's graphics set --!param map The savegame map data --!param world The savegame world data local function gfxSetHeuristic(map, world) -- First eliminate all but the first campaign level (same in demo and full) local toxicity = tostring(_S.level_names[1]:upper()) local level_name = tostring(map.level_name) if level_name ~= toxicity then return "full" end -- Now check a disease only in the demo (baldness) for _, disease in ipairs(world.available_diseases) do if disease.id == "baldness" then return "demo" end end return "full" end --! Puts loaded file into the game --!param data The file function LoadGame(data) --local status, res = xpcall(function() local objtable = MakePermanentObjectsTable(true) local state = assert(persist.load(data, objtable)) -- Graphics set types were defined in savegame version 166+. if not state.world.gfx_set then state.world.gfx_set = gfxSetHeuristic(state.map, state.world) end -- Check the game we're loading is compatible with program if not TheApp:checkCompatibility(state.world.savegame_version, state.world.gfx_set) then return end state.ui:resync(TheApp.ui) TheApp.ui = state.ui TheApp.world = state.world TheApp.map = state.map math.randomseed(state.random) local cursor = TheApp.ui.cursor TheApp.ui.cursor = nil TheApp.ui:setCursor(cursor) -- The menu bar is a permanent object, so its ui field needs updating to -- the depersisted ui value. TheApp.ui.menu_bar.ui = TheApp.ui TheApp.ui.menu_bar:onChangeLanguage() --end, persist.errcatch) TheApp.world.map:registerTemperatureDisplayMethod() -- TODO: sound effects on/off are saved too, but should be a global value? TheApp.audio:playSoundEffects(TheApp.config.play_sounds) TheApp:afterLoad() TheApp.world:resetAnimations() TheApp.ui:onChangeResolution() -- Check if the blueish tone should be applied. -- Note: Blue filter control should be handled from world or ui, however when -- loading a game we should let persistence do it. TheApp.world:updateUserActionsAllowed() TheApp.world:updateScreenBlueFilter() end function LoadGameFile(filename) local f = assert(io.open(filename, "rb")) local data = f:read("*a") f:close() LoadGame(data) end