scummvm/engines/neverhood/saveload.cpp

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#include "common/savefile.h"

#include "graphics/thumbnail.h"

#include "neverhood/neverhood.h"
#include "neverhood/gamemodule.h"
#include "neverhood/gamevars.h"

namespace Neverhood {

#define NEVERHOOD_SAVEGAME_VERSION 0

WARN_UNUSED_RESULT NeverhoodEngine::kReadSaveHeaderError NeverhoodEngine::readSaveHeader(Common::SeekableReadStream *in, SaveHeader &header, bool skipThumbnail) {

	header.version = in->readUint32LE();
	if (header.version > NEVERHOOD_SAVEGAME_VERSION)
		return kRSHEInvalidVersion;

	byte descriptionLen = in->readByte();
	header.description = "";
	while (descriptionLen--)
		header.description += (char)in->readByte();

	if (!Graphics::loadThumbnail(*in, header.thumbnail, skipThumbnail)) {
		return kRSHEIoError;
	}

	// Not used yet, reserved for future usage
	header.gameID = in->readByte();
	header.flags = in->readUint32LE();

	header.saveDate = in->readUint32LE();
	header.saveTime = in->readUint32LE();
	header.playTime = in->readUint32LE();

	return ((in->eos() || in->err()) ? kRSHEIoError : kRSHENoError);
}

bool NeverhoodEngine::savegame(const char *filename, const char *description) {

	Common::OutSaveFile *out;
	if (!(out = g_system->getSavefileManager()->openForSaving(filename))) {
		warning("Can't create file '%s', game not saved", filename);
		return false;
	}

	TimeDate curTime;
	g_system->getTimeAndDate(curTime);

	// Header start
	out->writeUint32LE(NEVERHOOD_SAVEGAME_VERSION);

	byte descriptionLen = strlen(description);
	out->writeByte(descriptionLen);
	out->write(description, descriptionLen);

	Graphics::saveThumbnail(*out);

	// Not used yet, reserved for future usage
	out->writeByte(0);
	out->writeUint32LE(0);
	uint32 saveDate = ((curTime.tm_mday & 0xFF) << 24) | (((curTime.tm_mon + 1) & 0xFF) << 16) | ((curTime.tm_year + 1900) & 0xFFFF);
	uint32 saveTime = ((curTime.tm_hour & 0xFF) << 16) | (((curTime.tm_min) & 0xFF) << 8) | ((curTime.tm_sec) & 0xFF);
	uint32 playTime = g_engine->getTotalPlayTime() / 1000;
	out->writeUint32LE(saveDate);
	out->writeUint32LE(saveTime);
	out->writeUint32LE(playTime);
	// Header end

	_gameVars->setGlobalVar(V_CURRENT_SCENE, _gameState.sceneNum);
	_gameVars->setGlobalVar(V_CURRENT_SCENE_WHICH, _gameState.which);

	_gameVars->saveState(out);

	out->finalize();
	delete out;
	return true;
}

bool NeverhoodEngine::loadgame(const char *filename) {
	Common::InSaveFile *in;
	if (!(in = g_system->getSavefileManager()->openForLoading(filename))) {
		warning("Can't open file '%s', game not loaded", filename);
		return false;
	}

	SaveHeader header;

	kReadSaveHeaderError errorCode = readSaveHeader(in, header);

	if (errorCode != kRSHENoError) {
		warning("Error loading savegame '%s'", filename);
		delete in;
		return false;
	}

	g_engine->setTotalPlayTime(header.playTime * 1000);

	_gameVars->loadState(in);

	// If user has changed NHC it may have changed the correct solution for
	// crystal puzzle. If it did and it was already solved, changed solors to the new solution
	// if it wasn't solved, just let the code do full reinit.
	if (_gameVars->getGlobalVar(V_CRYSTAL_COLORS_INIT)) {
		TextResource textResource(this);
		const char *textStart, *textEnd;
		bool colorsChanged = false, colorsAreCorrect = true;
		textResource.load(0x46691611);
		textStart = textResource.getString(0, textEnd);
		byte newCorrectColorNum[5];
		for (uint index = 0; index < 5; index++) {
			newCorrectColorNum[index] = GameModule::parseCrystalColor(textStart[index]);
		}
		for (uint index = 0; index < 5; index++) {
			if (_gameVars->getSubVar(VA_GOOD_CRYSTAL_COLORS, index) != newCorrectColorNum[index]) {
				colorsChanged = true;
			}
			if (_gameVars->getSubVar(VA_GOOD_CRYSTAL_COLORS, index) != _gameVars->getSubVar(VA_CURR_CRYSTAL_COLORS, index)) {
				colorsAreCorrect = false;
			}
		}
		if (colorsChanged && colorsAreCorrect) {
			for (uint index = 0; index < 5; index++) {
				_gameVars->setSubVar(VA_GOOD_CRYSTAL_COLORS, index, newCorrectColorNum[index]);
				_gameVars->setSubVar(VA_CURR_CRYSTAL_COLORS, index, newCorrectColorNum[index]);
			}
		}
		if (colorsChanged && !colorsAreCorrect) {
			_gameVars->setGlobalVar(V_CRYSTAL_COLORS_INIT, 0);
		}
	}

	_gameState.sceneNum = _gameVars->getGlobalVar(V_CURRENT_SCENE);
	_gameState.which = _gameVars->getGlobalVar(V_CURRENT_SCENE_WHICH);

	_gameModule->requestRestoreGame();

	delete in;
	return true;
}

Common::Error NeverhoodEngine::loadGameState(int slot) {
	Common::String fileName = getSaveStateName(slot);
	if (!loadgame(fileName.c_str()))
		return Common::kReadingFailed;
	return Common::kNoError;
}

Common::Error NeverhoodEngine::saveGameState(int slot, const Common::String &description, bool isAutosave) {
	Common::String fileName = getSaveStateName(slot);
	if (!savegame(fileName.c_str(), description.c_str()))
		return Common::kWritingFailed;
	return Common::kNoError;
}

Common::Error NeverhoodEngine::removeGameState(int slot) {
	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
	Common::String filename = Neverhood::NeverhoodEngine::getSavegameFilename(_targetName, slot);
	saveFileMan->removeSavefile(filename.c_str());
	return Common::kNoError;
}

Common::String NeverhoodEngine::getSaveStateName(int slot) const {
	return getSavegameFilename(_targetName, slot);
}

Common::String NeverhoodEngine::getSavegameFilename(const Common::String &target, int num) {
	assert(num >= 0 && num <= 999);
	return Common::String::format("%s.%03d", target.c_str(), num);
}

} // End of namespace Neverhood