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