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/scripting.hpp"
25 #include "scripting/serialize.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 void get_or_create_table_entry(HSQUIRRELVM vm, const std::string& name)
49 sq_pushstring(vm, name.c_str(), -1);
50 if(SQ_FAILED(sq_get(vm, -2)))
52 sq_pushstring(vm, name.c_str(), -1);
54 if(SQ_FAILED(sq_newslot(vm, -3, SQFalse)))
56 throw std::runtime_error("failed to create '" + name + "' table entry");
60 get_table_entry(vm, name);
65 // successfully placed result on stack
69 std::vector<std::string> get_table_keys(HSQUIRRELVM vm)
71 std::vector<std::string> worlds;
74 while(SQ_SUCCEEDED(sq_next(vm, -2)))
76 //here -1 is the value and -2 is the key
78 if(SQ_FAILED(sq_getstring(vm, -2, &result)))
80 std::ostringstream msg;
81 msg << "Couldn't get string value for key";
82 throw scripting::SquirrelError(vm, msg.str());
86 worlds.push_back(result);
89 // pops key and val before the next iteration
96 std::vector<LevelState> get_level_states(HSQUIRRELVM vm)
98 std::vector<LevelState> results;
101 while(SQ_SUCCEEDED(sq_next(vm, -2)))
103 //here -1 is the value and -2 is the key
105 if(SQ_FAILED(sq_getstring(vm, -2, &result)))
107 std::ostringstream msg;
108 msg << "Couldn't get string value";
109 throw scripting::SquirrelError(vm, msg.str());
113 LevelState level_state;
114 level_state.filename = result;
115 scripting::get_bool(vm, "solved", level_state.solved);
116 scripting::get_bool(vm, "perfect", level_state.perfect);
118 results.push_back(level_state);
121 // pops key and val before the next iteration
131 LevelsetState::store_level_state(const LevelState& in_state)
133 auto it = std::find_if(level_states.begin(), level_states.end(),
134 [&in_state](const LevelState& state)
136 return state.filename == in_state.filename;
138 if (it != level_states.end())
144 level_states.push_back(in_state);
149 LevelsetState::get_level_state(const std::string& filename)
151 auto it = std::find_if(level_states.begin(), level_states.end(),
152 [filename](const LevelState& state)
154 return state.filename == filename;
156 if (it != level_states.end())
162 log_warning << "failed to retrieve level state for " << filename << std::endl;
164 state.filename = filename;
169 Savegame::Savegame(const std::string& filename) :
170 m_filename(filename),
171 m_player_status(new PlayerStatus)
175 Savegame::~Savegame()
182 if (m_filename.empty())
184 log_debug << "no filename set for savegame, skipping load" << std::endl;
190 if(!PHYSFS_exists(m_filename.c_str()))
192 log_info << m_filename << ": doesn't exist, not loading state" << std::endl;
196 log_debug << "loading savegame from " << m_filename << std::endl;
200 HSQUIRRELVM vm = scripting::global_vm;
203 const lisp::Lisp* root = parser.parse(m_filename);
205 const lisp::Lisp* lisp = root->get_lisp("supertux-savegame");
208 throw std::runtime_error("file is not a supertux-savegame file");
213 lisp->get("version", version);
216 throw std::runtime_error("incompatible savegame version");
220 const lisp::Lisp* tux = lisp->get_lisp("tux");
223 throw std::runtime_error("No tux section in savegame");
226 m_player_status->read(*tux);
229 const lisp::Lisp* state = lisp->get_lisp("state");
232 throw std::runtime_error("No state section in savegame");
236 sq_pushroottable(vm);
237 get_table_entry(vm, "state");
238 scripting::load_squirrel_table(vm, -1, *state);
244 catch(const std::exception& e)
246 log_fatal << "Couldn't load savegame: " << e.what() << std::endl;
252 Savegame::clear_state_table()
254 HSQUIRRELVM vm = scripting::global_vm;
256 // delete existing state table, if it exists
257 sq_pushroottable(vm);
259 // create a new empty state table
260 sq_pushstring(vm, "state", -1);
262 if(SQ_FAILED(sq_newslot(vm, -3, SQFalse)))
264 throw std::runtime_error("Couldn't create state table");
273 if (m_filename.empty())
275 log_debug << "no filename set for savegame, skipping save" << std::endl;
279 log_debug << "saving savegame to " << m_filename << std::endl;
281 { // make sure the savegame directory exists
282 std::string dirname = FileSystem::dirname(m_filename);
283 if(!PHYSFS_exists(dirname.c_str()))
285 if(!PHYSFS_mkdir(dirname.c_str()))
287 std::ostringstream msg;
288 msg << "Couldn't create directory for savegames '"
289 << dirname << "': " <<PHYSFS_getLastError();
290 throw std::runtime_error(msg.str());
294 if(!PHYSFS_isDirectory(dirname.c_str()))
296 std::ostringstream msg;
297 msg << "Savegame path '" << dirname << "' is not a directory";
298 throw std::runtime_error(msg.str());
302 HSQUIRRELVM vm = scripting::global_vm;
304 lisp::Writer writer(m_filename);
306 writer.start_list("supertux-savegame");
307 writer.write("version", 1);
309 using namespace worldmap;
310 if(WorldMap::current() != NULL)
312 std::ostringstream title;
313 title << WorldMap::current()->get_title();
314 title << " (" << WorldMap::current()->solved_level_count()
315 << "/" << WorldMap::current()->level_count() << ")";
316 writer.write("title", title.str());
319 writer.start_list("tux");
320 m_player_status->write(writer);
321 writer.end_list("tux");
323 writer.start_list("state");
325 sq_pushroottable(vm);
326 sq_pushstring(vm, "state", -1);
327 if(SQ_SUCCEEDED(sq_get(vm, -2)))
329 scripting::save_squirrel_table(vm, -1, writer);
333 writer.end_list("state");
335 writer.end_list("supertux-savegame");
338 std::vector<std::string>
339 Savegame::get_worldmaps()
341 std::vector<std::string> worlds;
343 HSQUIRRELVM vm = scripting::global_vm;
344 int oldtop = sq_gettop(vm);
348 sq_pushroottable(vm);
349 get_table_entry(vm, "state");
350 get_table_entry(vm, "worlds");
351 worlds = get_table_keys(vm);
353 catch(const std::exception& err)
355 log_warning << err.what() << std::endl;
358 sq_settop(vm, oldtop);
364 Savegame::get_worldmap_state(const std::string& name)
366 WorldmapState result;
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, "worlds");
376 get_table_entry(vm, name);
377 get_table_entry(vm, "levels");
379 result.level_states = get_level_states(vm);
381 catch(const std::exception& err)
383 log_warning << err.what() << std::endl;
386 sq_settop(vm, oldtop);
391 std::vector<std::string>
392 Savegame::get_levelsets()
394 std::vector<std::string> results;
396 HSQUIRRELVM vm = scripting::global_vm;
397 int oldtop = sq_gettop(vm);
401 sq_pushroottable(vm);
402 get_table_entry(vm, "state");
403 get_table_entry(vm, "levelsets");
404 results = get_table_keys(vm);
406 catch(const std::exception& err)
408 log_warning << err.what() << std::endl;
411 sq_settop(vm, oldtop);
417 Savegame::get_levelset_state(const std::string& basedir)
419 LevelsetState result;
421 HSQUIRRELVM vm = scripting::global_vm;
422 int oldtop = sq_gettop(vm);
426 sq_pushroottable(vm);
427 get_table_entry(vm, "state");
428 get_table_entry(vm, "levelsets");
429 get_table_entry(vm, basedir);
430 get_table_entry(vm, "levels");
432 result.level_states = get_level_states(vm);
434 catch(const std::exception& err)
436 log_warning << err.what() << std::endl;
439 sq_settop(vm, oldtop);
445 Savegame::set_levelset_state(const std::string& basedir,
446 const std::string& level_filename,
449 LevelsetState state = get_levelset_state(basedir);
451 HSQUIRRELVM vm = scripting::global_vm;
452 int oldtop = sq_gettop(vm);
456 sq_pushroottable(vm);
457 get_table_entry(vm, "state");
458 get_or_create_table_entry(vm, "levelsets");
459 get_or_create_table_entry(vm, basedir);
460 get_or_create_table_entry(vm, "levels");
461 get_or_create_table_entry(vm, level_filename);
463 bool old_solved = false;
464 scripting::get_bool(vm, "solved", old_solved);
465 scripting::store_bool(vm, "solved", solved || old_solved);
467 catch(const std::exception& err)
469 log_warning << err.what() << std::endl;
472 sq_settop(vm, oldtop);