lab.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/>.
 *
 */

 /*
 * This code is based on Labyrinth of Time code with assistance of
 *
 * Copyright (c) 1993 Terra Nova Development
 * Copyright (c) 2004 The Wyrmkeep Entertainment Co.
 *
 */

#ifndef LAB_LAB_H
#define LAB_LAB_H

#include "common/system.h"
#include "common/random.h"
#include "common/rect.h"
#include "common/savefile.h"
#include "engines/engine.h"
#include "engines/savestate.h"

#include "lab/console.h"
#include "lab/image.h"
#include "lab/labsets.h"
#include "lab/detection.h"

struct ADGameDescription;

namespace Lab {

struct MapData;
struct Action;
struct CloseData;
struct Button;
struct IntuiMessage;
struct InventoryData;
struct RoomData;
struct Rule;
struct TextFont;
struct ViewData;

class Anim;
class DisplayMan;
class EventManager;
class Interface;
class Image;
class Music;
class Resource;
class SpecialLocks;
class Utils;

struct SaveGameHeader {
    byte _version;
    SaveStateDescriptor _descr;
    uint16 _roomNumber;
    uint16 _direction;
};

typedef Common::List<Button *> ButtonList;

struct CrumbData {
    uint16 _crumbRoomNum;
    uint16 _crumbDirection;
};

#define MAX_CRUMBS          128

typedef Common::List<Rule> RuleList;
typedef Common::List<Action> ActionList;
typedef Common::List<CloseData> CloseDataList;
typedef Common::List<ViewData> ViewDataList;

enum Direction {
    kDirectionNorth,
    kDirectionSouth,
    kDirectionEast,
    kDirectionWest
};

enum MainButton {
    kButtonNone = -1,
    kButtonPickup,
    kButtonUse,
    kButtonOpen,
    kButtonClose,
    kButtonLook,
    kButtonInventory,
    kButtonLeft,
    kButtonForward,
    kButtonRight,
    kButtonMap
};

enum MessageClass {
    kMessageLeftClick,
    kMessageRightClick,
    kMessageButtonUp,
    kMessageAction
};

enum LABActions {
    kActionNone,
    kActionQuit,
    kActionSkipIntro,
    kActionSoundRaise,
    kActionSoundLower,
    kActionInteract,
    kActionTake,
    kActionMove,
    kActionOpen,
    kActionClose,
    kActionLook,
    kActionInv,
    kActionForward,
    kActionLeft,
    kActionRight,
    kActionMap,
    kActionFocusOnNextInteractiveItem,
    kActionExit,
    kActionMainDisplay,
    kActionSaveLoad,
    kActionUse,
    kActionInvLook,
    kActionPrev,
    kActionNext,
    kActionDropBreadcrumb,
    kActionFollowBreadcrumbs,
    kActionRunWhileFollowingBreadcrumbs,
    kActionMapExit,
    kActionUpperFloor,
    kActionLowerFloor,
    kActionQuitDialogYes,
    kActionQuitDialogNo,
    kActionJournalBack,
    kActionJournalExit,
    kActionJournalForward,
    kActionDummy,
};

class LabEngine : public Engine {
    friend class Console;

private:
    bool _isCrumbWaiting;
    bool _lastTooLong;
    bool _lastPage;
    bool _mainDisplay;
    bool _noUpdateDiff;
    bool _quitLab;

    byte *_blankJournal;

    int _lastWaitTOFTicks;

    uint16 _direction;
    uint16 _highPalette[20];
    uint16 _journalPage;
    uint16 _maxRooms;
    uint16 _monitorPage;
    uint16 _monitorButtonHeight;

    uint32 _extraGameFeatures;

    Common::String _journalText;
    Common::String _journalTextTitle;
    Common::String _nextFileName;
    Common::String _newFileName;
    Common::String _monitorTextFilename;

    const CloseData *_closeDataPtr;
    ButtonList _journalButtonList;
    ButtonList _mapButtonList;
    Image *_imgMap, *_imgRoom, *_imgUpArrowRoom, *_imgDownArrowRoom, *_imgBridge;
    Image *_imgHRoom, *_imgVRoom, *_imgMaze, *_imgHugeMaze, *_imgPath;
    Image *_imgMapX[4];
    InventoryData *_inventory;
    MapData *_maps;
    Image *_monitorButton;
    Image *_journalBackImage;
    TextFont *_journalFont;
    bool _introPlaying;

public:
    bool _alternate;
    bool _droppingCrumbs;
    bool _followingCrumbs;
    bool _followCrumbsFast;
    bool _isCrumbTurning;
    bool _isHiRes;

    int _roomNum;

    uint16 _highestCondition;
    uint16 _manyRooms;
    uint16 _numCrumbs;
    uint16 _numInv;

    uint32 _crumbTimestamp;

    Common::String _curFileName;

    Anim *_anim;
    CrumbData _breadCrumbs[MAX_CRUMBS];
    DisplayMan *_graphics;
    EventManager *_event;
    Interface *_interface;
    ButtonList _invButtonList;
    ButtonList _moveButtonList;
    Image *_invImages[10];
    Image *_moveImages[20];
    LargeSet *_conditions, *_roomsFound;
    Music *_music;
    Resource *_resource;
    RoomData *_rooms;
    TextFont *_msgFont;
    SpecialLocks *_specialLocks;
    Utils *_utils;

public:
    LabEngine(OSystem *syst, const ADGameDescription *gameDesc);
    ~LabEngine() override;

    Common::Error run() override;
    void go();

    const ADGameDescription *_gameDescription;
    Common::Platform getPlatform() const;
    uint32 getFeatures() const;

    bool hasFeature(EngineFeature f) const override;

    void changeVolume(int delta);
    uint16 getDirection() { return _direction; }

    Common::String getPictName(bool useClose);
    uint16 getQuarters();
    void setQuarters(uint16 quarters);
    void updateEvents();
    void waitTOF();

    Common::Error loadGameState(int slot) override;
    Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false) override;
    bool canLoadGameStateCurrently(Common::U32String *msg = nullptr) override;
    bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;

    bool isMainDisplay() const { return _mainDisplay; }

private:
    bool checkConditions(const Common::Array<int16> &cond);

    void decIncInv(uint16 *CurInv, bool dec);

    void doActions(const ActionList &actionList);

    bool doActionRule(Common::Point pos, int16 action, int16 roomNum);

    bool doActionRuleSub(int16 action, int16 roomNum, const CloseData *closePtr, bool allowDefaults);

    void handleMonitorCloseup();

    bool doGoForward();

    void doJournal();

    bool doMainView();

    void doMap();

    void doMonitor(const Common::String &background, const Common::String &textfile, bool isinteractive, Common::Rect textRect);

    void doNotes();

    bool doOperateRuleSub(int16 itemNum, int16 roomNum, const CloseData *closePtr, bool allowDefaults);

    bool doOperateRule(Common::Point pos, int16 ItemNum);

    bool doTurn(uint16 from, uint16 to);

    bool doUse(uint16 curInv);

    void doWestPaper();

    void drawDirection(const CloseData *closePtr);

    void drawJournal(uint16 wipenum, bool needFade);

    void drawJournalText();

    void drawMap(uint16 curRoom, uint16 curMsg, uint16 floorNum, bool fadeIn);

    void drawMonText(const char *text, TextFont *monitorFont, Common::Rect textRect, bool isinteractive);

    void drawRoomMap(uint16 curRoom, bool drawMarkFl);

    void drawRoomMessage(uint16 curInv, const CloseData *closePtr);
    void drawStaticMessage(byte index);

    void eatMessages();

    const CloseData *findClosePtrMatch(const CloseData *closePtr, const CloseDataList &list);

    bool floorVisited(uint16 floorNum);

    MainButton followCrumbs();
    void freeMapData();
    void freeScreens();
    bool processEvent(MessageClass tmpClass, uint16 code, uint16 qualifier, Common::Point tmpPos,
        uint16 &curInv, IntuiMessage *curMsg, bool &forceDraw, uint16 buttonId, uint16 &actionMode);

    Common::String getInvName(uint16 curInv);

    uint16 getLowerFloor(uint16 floorNum);

    const CloseData *getObject(Common::Point pos, const CloseData *closePtr);

    uint16 getUpperFloor(uint16 floorNum);

    ViewData *getViewData(uint16 roomNum, uint16 direction);

    void interfaceOff();

    void interfaceOn();

    void loadJournalData();

    void loadMapData();

    void mainGameLoop();
    void showLab2Teaser();

    void perFlipButton(uint16 buttonId);

    uint16 processArrow(uint16 curDirection, uint16 arrow);

    void processJournal();

    void processMap(uint16 curRoom);

    void processMonitor(const Common::String &ntext, TextFont *monitorFont, bool isInteractive, Common::Rect textRect);

    Common::Rect roomCoords(uint16 curRoom);
    bool saveRestoreGame();

    void setCurrentClose(Common::Point pos, const CloseData **closePtrList, bool useAbsoluteCoords, bool next=false);

    bool takeItem(Common::Point pos);

    void turnPage(bool fromLeft);
    bool processKey(IntuiMessage *curMsg, uint32 msgClass, uint16 &qualifier, Common::Point &curPos, uint16 &curInv, bool &forceDraw, uint16 code);
    void processMainButton(uint16 &curInv, uint16 &lastInv, uint16 &oldDirection, bool &forceDraw, uint16 buttonId, uint16 &actionMode);
    void processAltButton(uint16 &curInv, uint16 &lastInv, uint16 buttonId, uint16 &actionMode);
    void performAction(uint16 actionMode, Common::Point curPos, uint16 &curInv);

    bool saveGame(int slot, const Common::String &desc);

    bool loadGame(int slot);
    void writeSaveGameHeader(Common::OutSaveFile *out, const Common::String &saveName);

    void handleTrialWarning();
};

WARN_UNUSED_RESULT bool readSaveGameHeader(Common::InSaveFile *in, SaveGameHeader &header, bool skipThumbnail = true);

} // End of namespace Lab

#endif // LAB_LAB_H