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 };
  53
  54 struct WorldmapState
  55 {
  56 public:
  57   WorldmapState() :
  58     filename(),
  59     level_states()
  60   {}
  61   std::string filename;
  62   std::vector<LevelState> level_states;
  63 };
  64
  65 /**
  66 (supertux-savegame
  67   (version 1)
  68   (title "Bonus Island II (0/28)")
  69   (tux
  70     (bonus "none")
  71     (fireflowers 0)
  72     (iceflowers 0)
  73     (coins 110)
  74   )
  75   (state
  76     ("levelsets"
  77       ("levels/test/"
  78         ("levels"
  79           ("level10.stl"
  80             (perfect #f)
  81             (solved #f)
  82           )
  83     ("worlds"
  84       ("levels/bonus2/worldmap.stwm"
  85         ("tux" ....)
  86         ("levels"
  87           ("level10.stl"
  88             (perfect #f)
  89             (solved #f)
  90           )
  91           ("level28.stl"
  92             (perfect #f)
  93             (solved #f)
  94           )
  95  */
  96 class Savegame
  97 {
  98 private:
  99   std::string m_filename;
 100   std::unique_ptr<PlayerStatus> m_player_status;
 101
 102 public:
 103   Savegame(const std::string& filename);
 104   ~Savegame();
 105
 106   /** Returns content of (tux ...) entry */
 107   PlayerStatus* get_player_status() const { return m_player_status.get(); }
 108
 109   std::string get_title() const;
 110
 111   std::vector<std::string> get_levelsets();
 112   LevelsetState get_levelset_state(const std::string& name);
 113
 114   std::vector<std::string> get_worldmaps();
 115   WorldmapState get_worldmap_state(const std::string& name);
 116
 117   void save();
 118   void load();
 119
 120 private:
 121   void clear_state_table();
 122
 123 private:
 124   Savegame(const Savegame&) = delete;
 125   Savegame& operator=(const Savegame&) = delete;
 126 };
 127
 128 #endif
 129
 130 /* EOF */