src/supertux/savegame.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //                2014 Ingo Ruhnke <grumbel@gmx.de>
   4 //
   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.
   9 //
  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.
  14 //
  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/>.
  17
  18 #ifndef HEADER_SUPERTUX_SUPERTUX_SAVEGAME_HPP
  19 #define HEADER_SUPERTUX_SUPERTUX_SAVEGAME_HPP
  20
  21 #include <memory>
  22 #include <string>
  23 #include <vector>
  24
  25 class PlayerStatus;
  26
  27 struct LevelState
  28 {
  29 public:
  30   LevelState() :
  31     filename(),
  32     solved(false),
  33     perfect(false)
  34   {}
  35
  36   std::string filename;
  37   bool solved;
  38   bool perfect;
  39 };
  40
  41 struct LevelsetState
  42 {
  43 public:
  44   LevelsetState() :
  45     directory(),
  46     level_states()
  47   {}
  48   std::string directory;
  49   std::vector<LevelState> level_states;
  50
  51   LevelState get_level_state(const std::string& filename);
  52   void store_level_state(const LevelState& state);
  53 };
  54
  55 struct WorldmapState
  56 {
  57 public:
  58   WorldmapState() :
  59     filename(),
  60     level_states()
  61   {}
  62   std::string filename;
  63   std::vector<LevelState> level_states;
  64 };
  65
  66 /**
  67 (supertux-savegame
  68   (version 1)
  69   (title "Bonus Island II (0/28)")
  70   (tux
  71     (bonus "none")
  72     (fireflowers 0)
  73     (iceflowers 0)
  74     (coins 110)
  75   )
  76   (state
  77     ("levelsets"
  78       ("levels/test/"
  79         ("levels"
  80           ("level10.stl"
  81             (perfect #f)
  82             (solved #f)
  83           )
  84     ("worlds"
  85       ("levels/bonus2/worldmap.stwm"
  86         ("tux" ....)
  87         ("levels"
  88           ("level10.stl"
  89             (perfect #f)
  90             (solved #f)
  91           )
  92           ("level28.stl"
  93             (perfect #f)
  94             (solved #f)
  95           )
  96  */
  97 class Savegame
  98 {
  99 private:
 100   std::string m_filename;
 101   std::unique_ptr<PlayerStatus> m_player_status;
 102
 103 public:
 104   Savegame(const std::string& filename);
 105   ~Savegame();
 106
 107   /** Returns content of (tux ...) entry */
 108   PlayerStatus* get_player_status() const { return m_player_status.get(); }
 109
 110   std::string get_title() const;
 111
 112   std::vector<std::string> get_levelsets();
 113   LevelsetState get_levelset_state(const std::string& name);
 114   void set_levelset_state(const std::string& basedir,
 115                           const std::string& level_filename,
 116                           bool solved);
 117
 118   std::vector<std::string> get_worldmaps();
 119   WorldmapState get_worldmap_state(const std::string& name);
 120
 121   void save();
 122   void load();
 123
 124 private:
 125   void clear_state_table();
 126
 127 private:
 128   Savegame(const Savegame&) = delete;
 129   Savegame& operator=(const Savegame&) = delete;
 130 };
 131
 132 #endif
 133
 134 /* EOF */