1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #include "common/savefile.h"
24 
25 #include "graphics/thumbnail.h"
26 
27 #include "neverhood/neverhood.h"
28 #include "neverhood/gamemodule.h"
29 #include "neverhood/gamevars.h"
30 
31 namespace Neverhood {
32 
33 #define NEVERHOOD_SAVEGAME_VERSION 0
34 
readSaveHeader(Common::SeekableReadStream * in,SaveHeader & header,bool skipThumbnail)35 WARN_UNUSED_RESULT NeverhoodEngine::kReadSaveHeaderError NeverhoodEngine::readSaveHeader(Common::SeekableReadStream *in, SaveHeader &header, bool skipThumbnail) {
36 
37 	header.version = in->readUint32LE();
38 	if (header.version > NEVERHOOD_SAVEGAME_VERSION)
39 		return kRSHEInvalidVersion;
40 
41 	byte descriptionLen = in->readByte();
42 	header.description = "";
43 	while (descriptionLen--)
44 		header.description += (char)in->readByte();
45 
46 	if (!Graphics::loadThumbnail(*in, header.thumbnail, skipThumbnail)) {
47 		return kRSHEIoError;
48 	}
49 
50 	// Not used yet, reserved for future usage
51 	header.gameID = in->readByte();
52 	header.flags = in->readUint32LE();
53 
54 	header.saveDate = in->readUint32LE();
55 	header.saveTime = in->readUint32LE();
56 	header.playTime = in->readUint32LE();
57 
58 	return ((in->eos() || in->err()) ? kRSHEIoError : kRSHENoError);
59 }
60 
savegame(const char * filename,const char * description)61 bool NeverhoodEngine::savegame(const char *filename, const char *description) {
62 
63 	Common::OutSaveFile *out;
64 	if (!(out = g_system->getSavefileManager()->openForSaving(filename))) {
65 		warning("Can't create file '%s', game not saved", filename);
66 		return false;
67 	}
68 
69 	TimeDate curTime;
70 	g_system->getTimeAndDate(curTime);
71 
72 	// Header start
73 	out->writeUint32LE(NEVERHOOD_SAVEGAME_VERSION);
74 
75 	byte descriptionLen = strlen(description);
76 	out->writeByte(descriptionLen);
77 	out->write(description, descriptionLen);
78 
79 	Graphics::saveThumbnail(*out);
80 
81 	// Not used yet, reserved for future usage
82 	out->writeByte(0);
83 	out->writeUint32LE(0);
84 	uint32 saveDate = ((curTime.tm_mday & 0xFF) << 24) | (((curTime.tm_mon + 1) & 0xFF) << 16) | ((curTime.tm_year + 1900) & 0xFFFF);
85 	uint32 saveTime = ((curTime.tm_hour & 0xFF) << 16) | (((curTime.tm_min) & 0xFF) << 8) | ((curTime.tm_sec) & 0xFF);
86 	uint32 playTime = g_engine->getTotalPlayTime() / 1000;
87 	out->writeUint32LE(saveDate);
88 	out->writeUint32LE(saveTime);
89 	out->writeUint32LE(playTime);
90 	// Header end
91 
92 	_gameVars->setGlobalVar(V_CURRENT_SCENE, _gameState.sceneNum);
93 	_gameVars->setGlobalVar(V_CURRENT_SCENE_WHICH, _gameState.which);
94 
95 	_gameVars->saveState(out);
96 
97 	out->finalize();
98 	delete out;
99 	return true;
100 }
101 
loadgame(const char * filename)102 bool NeverhoodEngine::loadgame(const char *filename) {
103 	Common::InSaveFile *in;
104 	if (!(in = g_system->getSavefileManager()->openForLoading(filename))) {
105 		warning("Can't open file '%s', game not loaded", filename);
106 		return false;
107 	}
108 
109 	SaveHeader header;
110 
111 	kReadSaveHeaderError errorCode = readSaveHeader(in, header);
112 
113 	if (errorCode != kRSHENoError) {
114 		warning("Error loading savegame '%s'", filename);
115 		delete in;
116 		return false;
117 	}
118 
119 	g_engine->setTotalPlayTime(header.playTime * 1000);
120 
121 	_gameVars->loadState(in);
122 
123 	_gameState.sceneNum = _gameVars->getGlobalVar(V_CURRENT_SCENE);
124 	_gameState.which = _gameVars->getGlobalVar(V_CURRENT_SCENE_WHICH);
125 
126 	_gameModule->requestRestoreGame();
127 
128 	delete in;
129 	return true;
130 }
131 
loadGameState(int slot)132 Common::Error NeverhoodEngine::loadGameState(int slot) {
133 	Common::String fileName = getSaveStateName(slot);
134 	if (!loadgame(fileName.c_str()))
135 		return Common::kReadingFailed;
136 	return Common::kNoError;
137 }
138 
saveGameState(int slot,const Common::String & description,bool isAutosave)139 Common::Error NeverhoodEngine::saveGameState(int slot, const Common::String &description, bool isAutosave) {
140 	Common::String fileName = getSaveStateName(slot);
141 	if (!savegame(fileName.c_str(), description.c_str()))
142 		return Common::kWritingFailed;
143 	return Common::kNoError;
144 }
145 
removeGameState(int slot)146 Common::Error NeverhoodEngine::removeGameState(int slot) {
147 	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
148 	Common::String filename = Neverhood::NeverhoodEngine::getSavegameFilename(_targetName, slot);
149 	saveFileMan->removeSavefile(filename.c_str());
150 	return Common::kNoError;
151 }
152 
getSaveStateName(int slot) const153 Common::String NeverhoodEngine::getSaveStateName(int slot) const {
154 	return getSavegameFilename(_targetName, slot);
155 }
156 
getSavegameFilename(const Common::String & target,int num)157 Common::String NeverhoodEngine::getSavegameFilename(const Common::String &target, int num) {
158 	assert(num >= 0 && num <= 999);
159 	return Common::String::format("%s.%03d", target.c_str(), num);
160 }
161 
162 } // End of namespace Neverhood
163