1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/* ResidualVM - A 3D game interpreter
*
* ResidualVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the AUTHORS
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef STARK_SAVE_METADATA_H
#define STARK_SAVE_METADATA_H
#include "common/error.h"
#include "common/system.h"
namespace Stark {
class ResourceSerializer;
/**
* Utility class for reading and writing the save file header
*
* The save file header contains metadata related to the save
* as well as a thumbnail of the game screen.
*/
class SaveMetadata {
public:
Common::String description;
uint levelIndex;
uint locationIndex;
uint version;
uint32 totalPlayTime;
uint8 saveDay;
uint8 saveMonth;
uint16 saveYear;
uint8 saveHour;
uint8 saveMinute;
const Graphics::Surface *gameWindowThumbnail;
SaveMetadata();
/** Set the time the save was created on */
void setSaveTime(const TimeDate &timeDate);
/**
* Read the metadata from a stream
*
* @param filename Save filename, used for the error messages only
*/
Common::ErrorCode read(Common::SeekableReadStream *stream, const Common::String &filename);
/** Write the metadata to a stream */
void write(Common::WriteStream *stream);
/** Read the game screen thumbnail from a stream */
Graphics::Surface *readGameScreenThumbnail(Common::SeekableReadStream *stream);
/** Skip the game screen thumbnail in a stream */
void skipGameScreenThumbnail(Common::SeekableReadStream *stream);
/** Write the game screen thumbnail to a stream */
void writeGameScreenThumbnail(Common::WriteStream *stream);
private:
void saveLoad(ResourceSerializer *s);
static void syncResourceIndexAsString(ResourceSerializer *s, uint &index);
Common::ErrorCode syncVersion(ResourceSerializer *s);
Common::String _readFilename;
Common::ErrorCode _readErrorCode;
};
} // End of namespace Stark
#endif // STARK_SAVE_METADATA_H
|
