2 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
3 // 2014 Ingo Ruhnke <grumbel@gmx.de>
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include "supertux/savegame.hpp"
20 #include "lisp/lisp.hpp"
21 #include "lisp/parser.hpp"
22 #include "lisp/writer.hpp"
23 #include "physfs/ifile_streambuf.hpp"
24 #include "scripting/serialize.hpp"
25 #include "scripting/squirrel_util.hpp"
26 #include "scripting/squirrel_util.hpp"
27 #include "supertux/player_status.hpp"
28 #include "util/file_system.hpp"
29 #include "util/log.hpp"
30 #include "worldmap/worldmap.hpp"
34 void get_table_entry(HSQUIRRELVM vm, const std::string& name)
36 sq_pushstring(vm, name.c_str(), -1);
37 if(SQ_FAILED(sq_get(vm, -2)))
39 throw std::runtime_error("failed to get '" + name + "' table entry");
43 // successfully placed result on stack
47 std::vector<std::string> get_table_keys(HSQUIRRELVM vm)
49 std::vector<std::string> worlds;
52 while(SQ_SUCCEEDED(sq_next(vm, -2)))
54 //here -1 is the value and -2 is the key
56 if(SQ_FAILED(sq_getstring(vm, -2, &result)))
58 std::ostringstream msg;
59 msg << "Couldn't get string value for key";
60 throw scripting::SquirrelError(vm, msg.str());
64 worlds.push_back(result);
67 // pops key and val before the next iteration
74 std::vector<LevelState> get_level_states(HSQUIRRELVM vm)
76 std::vector<LevelState> results;
79 while(SQ_SUCCEEDED(sq_next(vm, -2)))
81 //here -1 is the value and -2 is the key
83 if(SQ_FAILED(sq_getstring(vm, -2, &result)))
85 std::ostringstream msg;
86 msg << "Couldn't get string value";
87 throw scripting::SquirrelError(vm, msg.str());
91 LevelState level_state;
92 level_state.filename = result;
93 scripting::get_bool(vm, "solved", level_state.solved);
94 scripting::get_bool(vm, "perfect", level_state.perfect);
96 results.push_back(level_state);
99 // pops key and val before the next iteration
109 LevelsetState::get_level_state(const std::string& filename)
111 auto it = std::find_if(level_states.begin(), level_states.end(),
112 [filename](const LevelState& state)
114 return state.filename == filename;
116 if (it != level_states.end())
122 log_warning << "failed to retrieve level state for " << filename << std::endl;
124 state.filename = filename;
129 Savegame::Savegame(const std::string& filename) :
130 m_filename(filename),
131 m_player_status(new PlayerStatus)
135 Savegame::~Savegame()
142 if (m_filename.empty())
144 log_debug << "no filename set for savegame, skipping load" << std::endl;
150 if(!PHYSFS_exists(m_filename.c_str()))
152 log_info << m_filename << ": doesn't exist, not loading state" << std::endl;
156 log_debug << "loading savegame from " << m_filename << std::endl;
160 HSQUIRRELVM vm = scripting::global_vm;
163 const lisp::Lisp* root = parser.parse(m_filename);
165 const lisp::Lisp* lisp = root->get_lisp("supertux-savegame");
168 throw std::runtime_error("file is not a supertux-savegame file");
173 lisp->get("version", version);
176 throw std::runtime_error("incompatible savegame version");
180 const lisp::Lisp* tux = lisp->get_lisp("tux");
183 throw std::runtime_error("No tux section in savegame");
186 m_player_status->read(*tux);
189 const lisp::Lisp* state = lisp->get_lisp("state");
192 throw std::runtime_error("No state section in savegame");
196 sq_pushroottable(vm);
197 get_table_entry(vm, "state");
199 scripting::load_squirrel_table(vm, -1, *state);
200 if(SQ_FAILED(sq_createslot(vm, -3)))
203 throw std::runtime_error("Couldn't create state table");
210 catch(const std::exception& e)
212 log_fatal << "Couldn't load savegame: " << e.what() << std::endl;
218 Savegame::clear_state_table()
220 HSQUIRRELVM vm = scripting::global_vm;
222 // delete existing state table, if it exists
223 sq_pushroottable(vm);
225 /*sq_pushstring(vm, "state", -1);
226 if(SQ_FAILED(sq_deleteslot(vm, -2, SQFalse)))
231 // create a new empty state table
232 sq_pushstring(vm, "state", -1);
234 if(SQ_FAILED(sq_newslot(vm, -3, SQFalse)))
236 throw std::runtime_error("Couldn't create state table");
245 if (m_filename.empty())
247 log_debug << "no filename set for savegame, skipping save" << std::endl;
251 log_debug << "saving savegame to " << m_filename << std::endl;
253 { // make sure the savegame directory exists
254 std::string dirname = FileSystem::dirname(m_filename);
255 if(!PHYSFS_exists(dirname.c_str()))
257 if(!PHYSFS_mkdir(dirname.c_str()))
259 std::ostringstream msg;
260 msg << "Couldn't create directory for savegames '"
261 << dirname << "': " <<PHYSFS_getLastError();
262 throw std::runtime_error(msg.str());
266 if(!PHYSFS_isDirectory(dirname.c_str()))
268 std::ostringstream msg;
269 msg << "Savegame path '" << dirname << "' is not a directory";
270 throw std::runtime_error(msg.str());
274 HSQUIRRELVM vm = scripting::global_vm;
276 lisp::Writer writer(m_filename);
278 writer.start_list("supertux-savegame");
279 writer.write("version", 1);
281 using namespace worldmap;
282 if(WorldMap::current() != NULL)
284 std::ostringstream title;
285 title << WorldMap::current()->get_title();
286 title << " (" << WorldMap::current()->solved_level_count()
287 << "/" << WorldMap::current()->level_count() << ")";
288 writer.write("title", title.str());
291 writer.start_list("tux");
292 m_player_status->write(writer);
293 writer.end_list("tux");
295 writer.start_list("state");
297 sq_pushroottable(vm);
298 sq_pushstring(vm, "state", -1);
299 if(SQ_SUCCEEDED(sq_get(vm, -2)))
301 scripting::save_squirrel_table(vm, -1, writer);
305 writer.end_list("state");
307 writer.end_list("supertux-savegame");
310 std::vector<std::string>
311 Savegame::get_worldmaps()
313 std::vector<std::string> worlds;
315 HSQUIRRELVM vm = scripting::global_vm;
316 int oldtop = sq_gettop(vm);
320 sq_pushroottable(vm);
321 get_table_entry(vm, "state");
322 get_table_entry(vm, "worlds");
323 worlds = get_table_keys(vm);
325 catch(const std::exception& err)
327 log_warning << err.what() << std::endl;
330 sq_settop(vm, oldtop);
336 Savegame::get_worldmap_state(const std::string& name)
338 WorldmapState result;
340 HSQUIRRELVM vm = scripting::global_vm;
341 int oldtop = sq_gettop(vm);
345 sq_pushroottable(vm);
346 get_table_entry(vm, "state");
347 get_table_entry(vm, "worlds");
348 get_table_entry(vm, name);
349 get_table_entry(vm, "levels");
351 result.level_states = get_level_states(vm);
353 catch(const std::exception& err)
355 log_warning << err.what() << std::endl;
358 sq_settop(vm, oldtop);
363 std::vector<std::string>
364 Savegame::get_levelsets()
366 std::vector<std::string> results;
368 HSQUIRRELVM vm = scripting::global_vm;
369 int oldtop = sq_gettop(vm);
373 sq_pushroottable(vm);
374 get_table_entry(vm, "state");
375 get_table_entry(vm, "levelsets");
376 results = get_table_keys(vm);
378 catch(const std::exception& err)
380 log_warning << err.what() << std::endl;
383 sq_settop(vm, oldtop);
389 Savegame::get_levelset_state(const std::string& name)
391 LevelsetState result;
393 HSQUIRRELVM vm = scripting::global_vm;
394 int oldtop = sq_gettop(vm);
398 sq_pushroottable(vm);
399 get_table_entry(vm, "state");
400 get_table_entry(vm, "levelsets");
401 get_table_entry(vm, name);
402 get_table_entry(vm, "levels");
404 result.level_states = get_level_states(vm);
406 catch(const std::exception& err)
408 log_warning << err.what() << std::endl;
411 sq_settop(vm, oldtop);