mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-20 08:48:13 +00:00
00e59a3122
This commit introduces the following changes: 1. Graphics::loadThumbnail() Now returns a boolean and takes a new argument skipThumbnail which defaults to false. In case of true, loadThumbnail() reads past the thumbnail data in the input stream instead of actually loading the thumbnail. This simplifies savegame handling where, up until now, many engines always read the whole savegame metadata (including the thumbnail) and then threw away the thumbnail when not needed (which is in almost all cases, the most common exception being MetaEngine::querySaveMetaInfos() which is responsible for loading savegame metadata for displaying it in the GUI launcher. 2. readSavegameHeader() Engines which already implement such a method (name varies) now take a new argument skipThumbnail (default: true) which is passed through to loadThumbnail(). This means that the default case for readSavegameHeader() is now _not_ loading the thumbnail from a savegame and just reading past it. In those cases, e.g. querySaveMetaInfos(), where we actually are interested in loading the thumbnail readSavegameHeader() needs to explicitely be called with skipThumbnail == false. Engines whose readSavegameHeader() (name varies) already takes an argument loadThumbnail have been adapted to have a similar prototype and semantics. I.e. readSaveHeader(in, loadThumbnail, header) now is readSaveHeader(in, header, skipThumbnail). 3. Error handling Engines which previously did not check the return value of readSavegameHeader() (name varies) now do so ensuring that possibly broken savegames (be it a broken thumbnail or something else) don't make it into the GUI launcher list in the first place.
106 lines
2.5 KiB
C++
106 lines
2.5 KiB
C++
/* 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 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 XEEN_SAVES_H
|
|
#define XEEN_SAVES_H
|
|
|
|
#include "common/scummsys.h"
|
|
#include "common/savefile.h"
|
|
#include "common/serializer.h"
|
|
#include "common/str.h"
|
|
#include "graphics/surface.h"
|
|
#include "xeen/party.h"
|
|
|
|
namespace Xeen {
|
|
|
|
struct XeenSavegameHeader {
|
|
uint8 _version;
|
|
Common::String _saveName;
|
|
Graphics::Surface *_thumbnail;
|
|
int _year, _month, _day;
|
|
int _hour, _minute;
|
|
int _totalFrames;
|
|
};
|
|
|
|
class SavesManager {
|
|
private:
|
|
Common::String _targetName;
|
|
private:
|
|
/**
|
|
* Support method that generates a savegame name
|
|
* @param slot Slot number
|
|
*/
|
|
Common::String generateSaveName(int slot);
|
|
|
|
/**
|
|
* Initializes a new savegame
|
|
*/
|
|
void reset();
|
|
public:
|
|
bool _wonWorld;
|
|
bool _wonDarkSide;
|
|
public:
|
|
SavesManager(const Common::String &targetName);
|
|
~SavesManager();
|
|
|
|
/**
|
|
* Read in a savegame header
|
|
*/
|
|
WARN_UNUSED_RESULT static bool readSavegameHeader(Common::InSaveFile *in, XeenSavegameHeader &header, bool skipThumbnail = true);
|
|
|
|
/**
|
|
* Write out a savegame header
|
|
*/
|
|
void writeSavegameHeader(Common::OutSaveFile *out, XeenSavegameHeader &header);
|
|
|
|
/**
|
|
* Load a savegame
|
|
*/
|
|
Common::Error loadGameState(int slot);
|
|
|
|
/**
|
|
* Save the game
|
|
*/
|
|
Common::Error saveGameState(int slot, const Common::String &desc);
|
|
|
|
/**
|
|
* Sets up a new game
|
|
*/
|
|
void newGame();
|
|
|
|
/**
|
|
* Shows the load game dialog, and lets the user load a game
|
|
* @returns True if a savegame was loaded
|
|
*/
|
|
bool loadGame();
|
|
|
|
/**
|
|
* Shows the save game dialog, and lets the user save their game
|
|
* @returns True if a savegame was saved
|
|
*/
|
|
bool saveGame();
|
|
};
|
|
|
|
} // End of namespace Xeen
|
|
|
|
#endif /* XEEN_SAVES_H */
|