events.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 TITANIC_EVENTS_H
#define TITANIC_EVENTS_H

#include "common/scummsys.h"
#include "common/events.h"
#include "common/stack.h"
#include "support/rect.h"

namespace Titanic {

#define GAME_FRAME_RATE 30
#define GAME_FRAME_TIME (1000 / GAME_FRAME_RATE)
#define DOUBLE_CLICK_TIME 100

enum SpecialButtons {
    MK_LBUTTON = 1, MK_RBUTTON = 2, MK_SHIFT = 4, MK_CONTROL = 8,
    MK_MBUTTON = 0x10
};

class TitanicEngine;

class CEventTarget {
public:
    virtual ~CEventTarget() {}

    virtual void onIdle() {}

    virtual void mouseMove(const Point &mousePos) {}
    virtual void leftButtonDown(const Point &mousePos) {}
    virtual void leftButtonUp(const Point &mousePos) {}
    virtual void leftButtonDoubleClick(const Point &mousePos) {}
    virtual void middleButtonDown(const Point &mousePos) {}
    virtual void middleButtonUp(const Point &mousePos) {}
    virtual void middleButtonDoubleClick(const Point &mousePos) {}
    virtual void mouseWheel(const Point &mousePos, bool wheelUp) {}
    virtual void keyDown(Common::KeyState keyState) {}
    virtual void keyUp(Common::KeyState keyState) {}
    virtual void actionStart(Common::CustomEventType action) {}
};

class CPressTarget : public CEventTarget {
public:
    bool _pressed;
public:
    CPressTarget() : _pressed(false) {}
    ~CPressTarget() override {}
    void leftButtonDown(const Point &mousePos) override { _pressed = true; }
    void middleButtonDown(const Point &mousePos) override { _pressed = true; }
    void keyDown(Common::KeyState keyState) override {
        if (keyState.ascii)
            _pressed = true;
    }
};

class Events {
private:
    TitanicEngine *_vm;
    Common::Stack<CEventTarget *> _eventTargets;
    uint32 _frameCounter;
    uint32 _priorFrameTime;
    uint _totalFrames;
    Common::Point _mousePos;
    uint _specialButtons;

    bool checkForNextFrameCounter();

    CEventTarget *eventTarget() const {
        return _eventTargets.top();
    }

    void handleKbdSpecial(Common::CustomEventType action);
public:
    Events(TitanicEngine *vm);
    ~Events() {}

    void addTarget(CEventTarget *target) {
        _eventTargets.push(target);
    }

    void removeTarget() {
        _eventTargets.pop();
    }

    void pollEvents();

    void pollEventsAndWait();

    uint32 getFrameCounter() const { return _frameCounter; }

    uint32 getTicksCount() const;

    uint32 getTotalPlayTicks() const;

    void setTotalPlayTicks(uint frames);

    void sleep(uint time);

    bool waitForPress(uint expiry);

    Common::Point getMousePos() const { return _mousePos; }

    void setMousePos(const Common::Point &pt);

    /*
     * Return whether a given special key is currently pressed
     */
    bool isSpecialPressed(SpecialButtons btn) const {
        return (_specialButtons & btn) != 0;
    }

    uint getSpecialButtons() const { return _specialButtons; }
};

} // End of namespace Titanic

#endif /* TITANIC_EVENTS_H */