riven_stack.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 RIVEN_STACK_H
#define RIVEN_STACK_H

#include "common/keyboard.h"
#include "common/hash-str.h"
#include "common/ptr.h"
#include "common/rect.h"
#include "common/str-array.h"

#include "mohawk/riven_actions.h"
#include "mohawk/riven_graphics.h"

namespace Mohawk {

class MohawkEngine_Riven;

// NAME Resource ID's
enum RivenNameResource {
    kCardNames = 1,
    kHotspotNames = 2,
    kExternalCommandNames = 3,
    kVariableNames = 4,
    kStackNames = 5
};

class RivenNameList {
public:
    RivenNameList();
    RivenNameList(MohawkEngine_Riven *vm, uint16 id);
    ~RivenNameList();

    Common::String getName(uint16 nameID) const;

    int16 getNameId(const Common::String &name) const;

    void registerName(uint16 nameId, const Common::String &name);

private:
    void loadResource(MohawkEngine_Riven *vm, uint16 id);

    Common::StringArray _names;
    Common::Array<uint16> _index;
};

class RivenStack {
public:
    RivenStack(MohawkEngine_Riven *vm, uint16 id);
    virtual ~RivenStack();

    typedef Common::Array<uint16> ArgumentArray;
    typedef Common::Functor0<void> TimerProc;

    uint16 getId() const;

    Common::String getName(RivenNameResource nameResource, uint16 nameId) const;

    int16 getIdFromName(RivenNameResource nameResource, const Common::String &name) const;

    void registerName(RivenNameResource nameResource, uint16 nameId, const Common::String &name);

    uint16 getCardStackId(uint32 globalId) const;

    uint32 getCurrentCardGlobalId() const;

    uint32 getCardGlobalId(uint16 cardId) const;

    void runCommand(uint16 commandNameId, const Common::Array<uint16> &args);

    void dump() const;

    virtual void installCardTimer();

    void removeTimer();

    void onMouseDown(const Common::Point &mouse);

    void onMouseUp(const Common::Point &mouse);

    void onMouseMove(const Common::Point &mouse);

    void queueMouseCursorRefresh();

    void onFrame();

    bool mouseIsDown() const;

    Common::Point getMousePosition() const;

    Common::Point getMouseDragStartPosition() const;

    void mouseForceUp();

    void onAction(RivenAction keyAction);

    RivenAction getAction() const;

    void resetAction();

    // Common external commands
    void xflies(const ArgumentArray &args); // Start the "flies" effect

    // Miscellaneous
    uint16 getComboDigit(uint32 correctCombo, uint32 digit);
    void runDemoBoundaryDialog();
    void runEndGame(uint16 videoCode, uint32 delay, uint32 videoFrameCountOverride);
    void runCredits(uint16 video, uint32 delay, uint32 videoFrameCountOverride);

    void pageTurn(RivenTransition transition);
    bool keepTurningPages();
    void waitForPageTurnSound();

protected:
    typedef Common::Functor1<const ArgumentArray &, void> ExternalCommand;

    MohawkEngine_Riven *_vm;

    void registerCommand(const Common::String &name, ExternalCommand *command);

    void installTimer(TimerProc *proc, uint32 time);

private:
    typedef Common::HashMap<Common::String, Common::SharedPtr<ExternalCommand>, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> CommandsMap;

#define REGISTER_COMMAND(cls, method) \
        registerCommand( \
            #method, new Common::Functor1Mem<const Common::Array<uint16> &, void, cls>(this, &cls::method) \
        )

#define TIMER(cls, method) \
        new Common::Functor0Mem<void, cls>(this, &cls::method)

    void loadResourceNames();
    void loadCardIdMap();
    void setCurrentStackVariable();
    void checkTimer();

    uint16 _id;

    // Stack resource names
    RivenNameList _varNames;
    RivenNameList _externalCommandNames;
    RivenNameList _hotspotNames;
    RivenNameList _cardNames;
    RivenNameList _stackNames;

    Common::Array<uint32> _cardIdMap;

    CommandsMap _commands;

    RivenAction _action;

    bool _mouseIsDown;
    Common::Point _mousePosition;
    Common::Point _mouseDragStartPosition;
    bool _shouldRefreshMouseCursor;

    // Timer
    Common::SharedPtr<TimerProc> _timerProc;
    uint32 _timerTime;
};

namespace RivenStacks {
    const char *getName(uint16 stackId);

    uint16 getId(const char *stackName);
}

} // End of namespace Mohawk

#endif