nancy.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 NANCY_H
#define NANCY_H

#include "common/file.h"
#include "common/str.h"
#include "common/ptr.h"

#include "engines/engine.h"

#include "nancy/detection.h"
#include "nancy/time.h"
#include "nancy/commontypes.h"
#include "nancy/enginedata.h"

namespace Common {
class RandomSource;
class Serializer;
}

namespace Nancy {

static const int kSavegameVersion = 5;

struct NancyGameDescription;

class ResourceManager;
class IFF;
class InputManager;
class SoundManager;
class GraphicsManager;
class CursorManager;
class NancyConsole;
class DeferredLoader;

namespace State {
class State;
}

class NancyEngine : public Engine {
public:
    NancyEngine(OSystem *syst, const NancyGameDescription *gd);
    ~NancyEngine();

    static NancyEngine *create(GameType type, OSystem *syst, const NancyGameDescription *gd);

    void errorString(const char *buf_input, char *buf_output, int buf_output_size) override;
    bool hasFeature(EngineFeature f) const override;

    Common::Error loadGameState(int slot) override;
    Common::Error loadGameStream(Common::SeekableReadStream *stream) override;
    Common::Error saveGameStream(Common::WriteStream *stream, bool isAutosave = false) override;
    bool canLoadGameStateCurrently(Common::U32String *msg = nullptr) override;
    bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;

    void secondChance();

    const char *getCopyrightString() const;
    uint32 getGameFlags() const;
    const char *getGameId() const;
    GameType getGameType() const;
    Common::Language getGameLanguage() const;
    Common::Platform getPlatform() const;

    const StaticData &getStaticData() const;
    const EngineData *getEngineData(const Common::String &name) const;
    const Common::String getEventFlagName(uint flagID) const;

    void setState(NancyState::NancyState state, NancyState::NancyState overridePrevious = NancyState::kNone);
    NancyState::NancyState getState() { return _gameFlow.curState; }
    void setToPreviousState();

    void setMouseEnabled(bool enabled);

    void addDeferredLoader(Common::SharedPtr<DeferredLoader> &loaderPtr);

    // The first few games used 1/2 for false/true in
    // inventory, logic conditions, and event flags
    const byte _true;
    const byte _false;

    // Managers
    ResourceManager *_resource;
    GraphicsManager *_graphics;
    CursorManager *_cursor;
    InputManager *_input;
    SoundManager *_sound;

    Common::RandomSource *_randomSource;

    // Used to check whether we need to show the SaveDialog
    bool _hasJustSaved;

protected:
    Common::Error run() override;
    void pauseEngineIntern(bool pause) override;

private:
    struct GameFlow {
        NancyState::NancyState curState = NancyState::kNone;
        NancyState::NancyState prevState = NancyState::kNone;
        NancyState::NancyState nextState = NancyState::kNone;
        bool changingState = true;
    };

    void bootGameEngine();

    State::State *getStateObject(NancyState::NancyState state) const;
    void destroyState(NancyState::NancyState state) const;

    void preloadCals();
    void readDatFile();
    // Nancy12 onwards no longer ship their static data in nancy.dat; the values
    // the engine still needs are provided here instead (see also the EVNT chunk).
    void populateStaticData();

    Common::Error synchronize(Common::Serializer &serializer);

    bool isCompressed();

    StaticData _staticData;
    Common::HashMap<Common::String, EngineData *> _engineData;

    const byte _datFileMajorVersion;
    const byte _datFileMinorVersion;

    GameFlow _gameFlow;
    OSystem *_system;

    const NancyGameDescription *_gameDescription;

    Common::Array<Common::WeakPtr<DeferredLoader>> _deferredLoaderObjects;
};

extern NancyEngine *g_nancy;
#define GetEngineData(s) (const s*)g_nancy->getEngineData(#s);

} // End of namespace Nancy

#endif // NANCY_H