m4.h

/* 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 M4_H
#define M4_H

#include "common/scummsys.h"
#include "common/system.h"
#include "common/error.h"
#include "common/fs.h"
#include "common/hash-str.h"
#include "common/random.h"
#include "common/serializer.h"
#include "common/util.h"
#include "engines/engine.h"
#include "engines/savestate.h"
#include "graphics/screen.h"

#include "m4/detection.h"
#include "m4/vars.h"
#include "m4/core/rooms.h"
#include "m4/subtitles.h"

namespace M4 {

struct M4GameDescription;

class M4Engine : public Engine, public Sections {
private:
    const M4GameDescription *_gameDescription;
    Common::RandomSource _randomSource;
    M4Subtitles _subtitles;

    void m4_inflight();

    Common::InSaveFile *getOriginalSave(int slot) const;

protected:
    bool _useOriginalSaveLoad = false;

    // Engine APIs
    Common::Error run() override;

    virtual Vars *createVars() = 0;

    virtual void setupConsole() = 0;

    void pauseEngineIntern(bool pause) override;

public:
    M4Engine(OSystem *syst, const M4GameDescription *gameDesc);
    ~M4Engine() override = default;

    uint32 getFeatures() const;

    bool useOriginalSaveLoad() const {
        return _useOriginalSaveLoad;
    }

    Common::String getGameId() const;

    int getGameType() const;

    Common::Language getLanguage() const;

    int isDemo() const;

    uint32 getRandomNumber(uint maxNum) {
        return _randomSource.getRandomNumber(maxNum);
    }

    void initializePath(const Common::FSNode &gamePath) override;

    bool hasFeature(EngineFeature f) const override {
        return
            (f == kSupportsLoadingDuringRuntime) ||
            (f == kSupportsSavingDuringRuntime) ||
            (f == kSupportsReturnToLauncher);
    };

    bool canLoadGameStateCurrently(Common::U32String * msg = nullptr) override;
    bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;
    void syncSoundSettings() override;

    Common::Error loadGameState(int slot) override;
    Common::Error loadGameStateDoIt(int slot);

    Common::Error syncGame(Common::Serializer &s);

    virtual void syncFlags(Common::Serializer &s) = 0;

    Common::Error saveGameStream(Common::WriteStream* stream, bool isAutosave = false) override;

    Common::Error loadGameStream(Common::SeekableReadStream* stream) override;

    bool autosaveExists() const;

    bool savesExist() const;

    SaveStateList listSaves() const;

    bool loadSaveThumbnail(int slotNum, M4sprite *thumbnail) const;

    bool saveGameFromMenu(int slotNum, const Common::String &desc,
        Graphics::Surface &thumbnail);

    virtual void showSaveScreen();

    enum LoadDialogSource { kLoadFromMainMenu, kLoadFromGameDialog, kLoadFromHotkey };
    virtual void showLoadScreen(LoadDialogSource fromMainMenu);

    virtual void showEngineInfo() = 0;

    void drawSubtitle(const Common::String &soundId) const {
        _subtitles.drawSubtitle(soundId);
    }

    void clearSubtitle() const {
        _subtitles.clearSubtitle();
    }

    void updateSubtitleOverlay() const {
        _subtitles.updateSubtitleOverlay();
    }
};

extern M4Engine *g_engine;
#define SHOULD_QUIT ::M4::g_engine->shouldQuit()
#define IS_BURGER (g_engine->getGameType() == GType_Burger)
#define IS_RIDDLE (g_engine->getGameType() == GType_Riddle)

} // End of namespace M4

#endif // M4_H