Fix for coverity #29409 - Use char 0 instead of NULL
[supertux.git] / 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 class Savegame
67 {
68 private:
69   std::string m_filename;
70   std::unique_ptr<PlayerStatus> m_player_status;
71
72 public:
73   Savegame(const std::string& filename);
74   ~Savegame();
75
76   /** Returns content of (tux ...) entry */
77   PlayerStatus* get_player_status() const { return m_player_status.get(); }
78
79   std::string get_title() const;
80
81   std::vector<std::string> get_levelsets();
82   LevelsetState get_levelset_state(const std::string& name);
83   void set_levelset_state(const std::string& basedir,
84                           const std::string& level_filename,
85                           bool solved);
86
87   std::vector<std::string> get_worldmaps();
88   WorldmapState get_worldmap_state(const std::string& name);
89
90   void save();
91   void load();
92
93 private:
94   void clear_state_table();
95
96 private:
97   Savegame(const Savegame&) = delete;
98   Savegame& operator=(const Savegame&) = delete;
99 };
100
101 #endif
102
103 /* EOF */