scummvm/engines/hpl1/hpl1.h

121 lines
3.1 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 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/>.
*
*/
#ifndef HPL1_HPL1_H
#define HPL1_HPL1_H
#include "common/bitarray.h"
#include "common/error.h"
#include "common/fs.h"
#include "common/hash-str.h"
#include "common/random.h"
#include "common/scummsys.h"
#include "common/serializer.h"
#include "common/system.h"
#include "common/util.h"
#include "engines/engine.h"
#include "engines/savestate.h"
#include "graphics/screen.h"
#include "hpl1/detection.h"
class cInit;
namespace Hpl1 {
struct Hpl1GameDescription;
class Hpl1Engine : public Engine {
private:
const ADGameDescription *_gameDescription;
Common::RandomSource _randomSource;
cInit *_gameInit;
protected:
// Engine APIs
Common::Error run() override;
void pauseEngineIntern(bool pause) override;
public:
Graphics::Screen *_screen = nullptr;
public:
Hpl1Engine(OSystem *syst, const ADGameDescription *gameDesc);
~Hpl1Engine() override;
uint32 getFeatures() const;
/**
* Returns the game Id
*/
Common::String getGameId() const;
/**
* Gets a random number
*/
uint32 getRandomNumber(uint maxNum) {
return _randomSource.getRandomNumber(maxNum);
}
bool hasFeature(EngineFeature f) const override {
return (f == kSupportsLoadingDuringRuntime) ||
(f == kSupportsReturnToLauncher) ||
(f == kSupportsArbitraryResolutions);
};
bool canLoadGameStateCurrently(Common::U32String *msg = nullptr) override {
return true;
}
Common::String createSaveFile(const Common::String &internalName);
Common::String mapInternalSaveToFile(const Common::String &internalName);
void removeSaveFile(const Common::String &internalName);
Common::StringArray listInternalSaves(const Common::String &pattern);
Common::Error loadGameState(int slot) override;
/**
* Uses a serializer to allow implementing savegame
* loading and saving using a single method
*/
Common::Error syncGame(Common::Serializer &s);
Common::Error saveGameStream(Common::WriteStream *stream, bool isAutosave = false) override {
Common::Serializer s(nullptr, stream);
return syncGame(s);
}
Common::Error loadGameStream(Common::SeekableReadStream *stream) override {
Common::Serializer s(stream, nullptr);
return syncGame(s);
}
};
extern Hpl1Engine *g_engine;
#define SHOULD_QUIT ::Hpl1::g_engine->shouldQuit()
} // namespace Hpl1
#endif