globals.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 TSAGE_GLOBALS_H
#define TSAGE_GLOBALS_H

#include "common/random.h"
#include "tsage/core.h"
#include "tsage/scenes.h"
#include "tsage/events.h"
#include "tsage/sound.h"
#include "tsage/saveload.h"
#include "tsage/screen.h"
#include "tsage/user_interface.h"

namespace TsAGE {

class Globals : public SavedObject {
private:
    static void dispatchSound(ASound *obj);
public:
    Screen _screen;
    GfxManager _gfxManagerInstance;
    Common::List<GfxManager *> _gfxManagers;
    SceneHandler *_sceneHandler;
    Game *_game;
    EventsClass _events;
    SceneManager _sceneManager;
    ScenePalette _scenePalette;
    SceneRegions _sceneRegions;
    SceneItemList _sceneItems;
    SceneObjectList _sceneObjectsInstance;
    SceneObjectList *_sceneObjects;
    SynchronizedList<SceneObjectList *> _sceneObjects_queue;
    SceneText _sceneText;
    int _gfxFontNumber;
    GfxColors _gfxColors;
    GfxColors _fontColors;
    byte _color1, _color2, _color3;
    SoundManager _soundManager;
    Common::Point _dialogCenter;
    WalkRegions _walkRegions;
    SynchronizedList<ASound *> _sounds;
    bool _flags[256];
    Player _player;
    ASound _soundHandler;
    InvObjectList *_inventory;
    Region _paneRegions[2];
    int _paneRefreshFlag[2];
    Common::Point _sceneOffset;
    Common::Point _prevSceneOffset;
    SceneObject *_scrollFollower;
    SequenceManager _sequenceManager;
    Common::RandomSource _randomSource;
    int _stripNum;
    int _gfxEdgeAdjust;
public:
    Globals();
    ~Globals() override;

    void setFlag(int flagNum) {
        assert((flagNum >= 0) && (flagNum < MAX_FLAGS));
        _flags[flagNum] = true;
    }
    void clearFlag(int flagNum) {
        assert((flagNum >= 0) && (flagNum < MAX_FLAGS));
        _flags[flagNum] = false;
    }
    bool getFlag(int flagNum) const {
        assert((flagNum >= 0) && (flagNum < MAX_FLAGS));
        return _flags[flagNum];
    }

    GfxManager &gfxManager() { return **_gfxManagers.begin(); }
    Common::String getClassName() override { return "Globals"; }
    void synchronize(Serializer &s) override;
    virtual void reset();

    void dispatchSounds();
};

typedef bool (*SelectItemProc)(int objectNumber);

class TsAGE2Globals: public Globals {
public:
    UIElements _uiElements;
    SelectItemProc _onSelectItem;
    int _interfaceY;
    ASoundExt _inventorySound;

    TsAGE2Globals();
    void reset() override;
    void synchronize(Serializer &s) override;
};

extern Globals *g_globals;

#define GLOBALS (*::TsAGE::g_globals)
#define T2_GLOBALS (*((::TsAGE::TsAGE2Globals *)g_globals))
#define BF_GLOBALS (*((::TsAGE::BlueForce::BlueForceGlobals *)g_globals))
#define R2_GLOBALS (*((::TsAGE::Ringworld2::Ringworld2Globals *)g_globals))

// Note: Currently this can't be part of the g_globals structure, since it needs to be constructed
// prior to many of the fields in Globals execute their constructors
extern ResourceManager *g_resourceManager;


namespace BlueForce {

using namespace TsAGE;

enum Bookmark {
    bNone,
    bStartOfGame, bCalledToDomesticViolence, bArrestedGreen, bLauraToParamedics,
    bBookedGreen, bStoppedFrankie, bBookedFrankie, bBookedFrankieEvidence,
    bEndOfWorkDayOne, bTalkedToGrannyAboutSkipsCard, bLyleStoppedBy, bEndDayOne,
    bInspectionDone, bCalledToDrunkStop, bArrestedDrunk, bEndDayTwo,
    bFlashBackOne, bFlashBackTwo, bFlashBackThree, bDroppedOffLyle, bEndDayThree,
    bDoneWithIsland, bDoneAtLyles, bEndDayFour, bInvestigateBoat, bFinishedWGreen,
    bAmbushed, bAmbushOver, bEndOfGame
};

enum Flag {
    JAKE_FILE_COPIED, gunClean, onBike, onDuty, fShowedIdToKate, fLateToMarina,
    fCalledBackup, fWithLyle, gunDrawn, fBackupArrived340, fBriefedBackup,
    fGotAllSkip340, fToldToLeave340, fBackupIn350, fNetInBoat, fForbesWaiting,
    fWithCarter, fTalkedToTony, fMugOnKate, takenWeasel, gotTrailer450,
    showEugeneNapkin, showRapEugene, fMgrCallsWeasel, fCarterMetLyle,
    fGunLoaded, fLoadedSpare, showEugeneID, fRandomShot350, examinedFile810,
    shownLyleCrate1, shownLyleRapsheet, shownLyleDisk, shownLylePO,
    fCanDrawGun, fGotAutoWeapon, fGotBulletsFromDash, fShotSuttersDesk,
    greenTaken, fLateToDrunkStop, didDrunk, fSearchedTruck, seenFolder,
    showMugAround, frankInJail, fTalkedCarterDay3, fDecryptedBluePrints,
    fTalkedToDrunkInCar, fToldLyleOfSchedule, fTalkedShooterNoBkup,
    fTalkedDriverNoBkup, fDriverOutOfTruck, readGreenRights, readFrankRights,
    talkedToHarrisAboutDrunk, unlockBoat, fShootGoon, fBlowUpGoon,
    fTalkedToBarry, fTalkedToLarry, fLeftTraceIn920, fLeftTraceIn900,
    fBackupAt340, fShotNicoIn910, fGotPointsForTktBook, fGotPointsForMCard,
    fShowedBluePrint, fGotPointsForPunch, fGotPointsForBox, fGotPointsForBank,
    fGotPointsForCombo, fGotPointsForCoin, fGotPointsForCPU, fGotPointsForBoots,
    fGotPointsForCrate, fGotPointsForBlackCord, fGotPointsForGeneratorPlug,
    fGotPointsForFuseBoxPlug, fGotPointsForStartGenerator, fGotPointsForLightsOn,
    fGotPointsForOpeningDoor, fGotPointsForClosingDoor, fGotPointsForLightsOff,
    fGotPointsForGeneratorOff, fGotPointsForCordOnForklift, fGotPointsForCuffingNico,
    fGotPointsForCuffingDA, fGotPointsForSearchingNico, fGotPointsForSearchingDA,
    fLeftTraceIn910, fBookedGreenEvidence, fGotPointsForCleaningGun,
    fGotPointsForMemo, fGotPointsForFBI, fTookTrailerAmmo, fAlertedGreen355,
    fGotGreen355fTalkedToGrannyDay3, shownFax, beenToJRDay2, shownLyleCrate1Day1,
    fLyleOnIsland, iWasAmbushed, fGangInCar, fArrivedAtGangStop, ticketVW,
    f1015Marina, fCan1015Marina, f1015Frankie, fCan1015Frankie, f1015Drunk,
    fCan1015Drunk, f1027Marina, fCan1027Marina, f1027Frankie, fCan1027Frankie,
    f1027Drunk, fCan1027Drunk, f1035Marina, fCan1035Marina, f1035Frankie,
    fCan1035Frankie, f1035Drunk, fCan1035Drunk, f1097Marina, fCan1097Marina,
    f1097Frankie, fCan1097Frankie, f1097Drunk, fCan1097Drunk, f1098Marina,
    fCan1098Marina, f1098Frankie, fCan1098Frankie, f1098Drunk, fCan1098Drunk,
    fCuffedFrankie, fGotPointsForTrapDog, fGotPointsForUnlockGate,
    fGotPointsForUnlockWarehouse, fGotPointsForLockWarehouse, fGotPointsForLockGate,
    fGotPointsForFreeDog, fGotPointsForWhistleDog, fGivenNapkin, fCan1004Marina,
    fCan1004Drunk, fHasLeftDrunk, fHasDrivenFromDrunk, fCrateOpen, fSawGuns,
    hookPoints
};

class BlueForceGlobals: public TsAGE2Globals {
public:
    ASoundExt _sound1, _sound3;
    StripProxy _stripProxy;
    int _dayNumber;
    int _tonyDialogCtr;
    int _marinaWomanCtr;
    int _kateDialogCtr;
    int _v4CEB6;
    int _safeCombination;
    int _gateStatus;
    int _greenDay5TalkCtr;
    int _v4CEC8;
    int _v4CECA;
    int _v4CECC;
    int8 _breakerBoxStatusArr[18];
    int _hiddenDoorStatus;
    int _nico910State;
    int _stuart910State;
    int _nico910Talk;
    int _stuart910Talk;
    int _deziTopic;
    int _deathReason;
    int _driveFromScene;
    int _driveToScene;
    uint8 _subFlagBitArr1;
    uint8 _subFlagBitArr2;
    bool _scene410HarrisonTalkFl;
    int _scene410Action1Count;
    int _scene410TalkCount;
    bool _scene410HarrisonMovedFl;
    Bookmark _bookmark;
    int _mapLocationId;
    int _clip1Bullets, _clip2Bullets;

    BlueForceGlobals();
    bool getHasBullets();

    Common::String getClassName() override { return "BFGlobals"; }
    void reset() override;
    void synchronize(Serializer &s) override;
    void set2Flags(int flagNum);
    bool removeFlag(int flagNum);
};

} // End of namespace BlueForce

namespace Ringworld2 {

#define SPEECH_TEXT 1
#define SPEECH_VOICE 2

class ScannerDialog;

struct VampireData {
    bool _isAlive;
    int _shotsRequired;
    Common::Point _position;
};

class Ringworld2Globals: public TsAGE2Globals {
public:
    ASoundExt _sound1, _sound2, _sound3, _sound4;
    PlayStream _playStream;
    StripProxy _stripProxy;
    bool _fadePaletteFlag;
    byte _fadePaletteMap[10][256];
    byte _paletteMap[4096];
    int _insetUp;
    int _frameEdgeColor;
    int _animationCtr;
    int _electromagnetChangeAmount;
    int _electromagnetZoom;
    bool _tractorField;
    bool _cableAttached;
    int _foodCount;
    int _rimLocation;
    int _rimTransportLocation;
    byte _stripModifier;
    byte _spillLocation[14];
    VampireData _vampireData[18];
    byte _flubMazeArea;
    byte _flubMazeEntryDirection;
    int _maze3800SceneNumb;
    byte _landerSuitNumber;
    byte _desertStepsRemaining;
    byte _desertCorrectDirection;
    byte _desertPreviousDirection;
    byte _desertMovements[1000];
    int _desertWrongDirCtr;
    byte _balloonAltitude;
    int _scene1925CurrLevel; //_v56A9C
    int _walkwaySceneNumber;
    byte _mirandaJailState;
    byte _scientistConvIndex;
    Common::Point _ventCellPos;
    byte _ductMazePanel1State;
    byte _ductMazePanel2State;
    byte _ductMazePanel3State;
    int _scene180Mode;  // _v575f7
    int _v57709;
    int _v5780C;
    int _mouseCursorId;
    int _v57810;
    int _speechSubtitles;
    Common::Point _s1550PlayerArea[3]; // only used for Quinn and Seeker
    byte _scannerFrequencies[4];
    byte _stripManager_lookupList[12];
    byte _scene1550JunkLocations[508];
    Common::Point _balloonPosition;
    bool _debugCardGame;               // moved from scene 1337 so it can be easily set in the debugger

    ScannerDialog *_scannerDialog;

    Ringworld2Globals();
    ~Ringworld2Globals() override;
    void reset() override;
    void synchronize(Serializer &s) override;
};

} // End of namespace Ringworld2

} // End of namespace TsAGE

#endif