ags.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 AGS_AGS_H
#define AGS_AGS_H

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

#include "ags/detection.h"
#include "ags/shared/gfx/bitmap.h"
#include "ags/lib/allegro/system.h"

namespace AGS3 {
class Globals;
}

namespace AGS {

/* Synced up to upstream: ---
 * ----
 */
#define SCREEN_WIDTH 320
#define SCREEN_HEIGHT 200

struct AGSGameDescription;
struct PluginVersion;
class EventsManager;
class Music;

struct PluginVersion {
    const char *_plugin;
    int _version;
};

enum AGSSteamVersion { kAGSteam = 0, kWadjetEye = 1 };
enum AGSSpriteFontVersion { kAGSSpriteFont = 0, kClifftopGames = 1 };

class AGSEngine : public Engine {
private:
    const AGSGameDescription *_gameDescription;
    Common::RandomSource _randomSource;
public:
    EventsManager *_events;
    Music *_music;
    ::AGS3::GFX_DRIVER *_gfxDriver;
    ::AGS3::Globals *_globals;
    bool _forceTextAA;
protected:
    // Engine APIs
    Common::Error run() override;
public:
    AGSEngine(OSystem *syst, const AGSGameDescription *gameDesc);
    ~AGSEngine() override;
    void GUIError(const Common::String &msg);

    void set_window_title(const char *str) {
        // No implementation
    }

    uint32 getFeatures() const;

    const PluginVersion *getNeededPlugins() const;

    Common::String getGameId() const;

    SaveStateList listSaves() const;

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

    void setRandomNumberSeed(uint32 seed) {
        _randomSource.setSeed(seed);
    }

    bool getPixelFormat(int depth, Graphics::PixelFormat &format) const;

    void setGraphicsMode(size_t w, size_t h, int depth);

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

    bool isUnsupportedPre25() const;

    /*
     * Returns true if the game has data files greater than 2Gb
     */
    bool is64BitGame() const;

    Common::FSNode getGameFolder();

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

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

    Common::Error loadGameState(int slot) override;

    Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false) override;

    int getAutosaveSlot() const override;

    void syncSoundSettings() override;
};

extern AGSEngine *g_vm;
#define gfx_driver ::AGS::g_vm->_gfxDriver
#define SHOULD_QUIT ::AGS::g_vm->shouldQuit()

} // namespace AGS

#endif