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 GOT_EVENTS_H
#define GOT_EVENTS_H

#include "common/array.h"
#include "common/stack.h"
#include "got/gfx/gfx_surface.h"
#include "got/messages.h"
#include "graphics/screen.h"

namespace Got {

#define FRAME_RATE 60
#define FRAME_DELAY (1000 / FRAME_RATE)

using Gfx::GfxSurface;
class Events;

struct Bounds {
private:
    Common::Rect _bounds;
    Common::Rect &_innerBounds;
    int _borderSize = 0;

public:
    const int16 &left;
    const int16 &top;
    const int16 &right;
    const int16 &bottom;

public:
    Bounds(Common::Rect &innerBounds);
    operator const Common::Rect &() const {
        return _bounds;
    }
    Bounds &operator=(const Common::Rect &r);
    void setBorderSize(size_t borderSize);
    size_t borderSize() const {
        return _borderSize;
    }
    int16 width() const {
        return _bounds.width();
    }
    int16 height() const {
        return _bounds.height();
    }
};

class UIElement {
    friend class Events;

private:
    int _timeoutCtr = 0;

protected:
    UIElement *_parent;
    Common::Array<UIElement *> _children;
    Common::Rect _innerBounds;
    Bounds _bounds;
    bool _needsRedraw = true;
    Common::String _name;
#ifdef USE_TTS
    Common::String _previousSaid;
#endif

protected:
    bool isDelayActive() const {
        return _timeoutCtr != 0;
    }

    void cancelDelay() {
        _timeoutCtr = 0;
    }

    virtual void timeout();

private:
    virtual void drawElements();

    static UIElement *findViewGlobally(const Common::String &name);

public:
    UIElement(const Common::String &name, UIElement *uiParent);
    UIElement(const Common::String &name);
    virtual ~UIElement() {}

    bool needsRedraw() const {
        return _needsRedraw;
    }

    void redraw();

    virtual void close();

    virtual void replaceView(UIElement *ui, bool replaceAllViews = false, bool fadeOutIn = false);
    virtual void replaceView(const Common::String &name, bool replaceAllViews = false, bool fadeOutIn = false);

    virtual void addView(UIElement *ui);
    virtual void addView(const Common::String &name);
    void addView();
    void open() {
        addView();
    }

    int getRandomNumber(int minNumber, int maxNumber);
    int getRandomNumber(int maxNumber);

    virtual void setBounds(const Common::Rect &r) {
        _bounds = r;
    }

    Common::Rect getBounds() const {
        return _bounds;
    }

    const Common::String &getName() const {
        return _name;
    }

    Gfx::GfxSurface getSurface(bool innerBounds = false) const;

    virtual void draw();

    virtual bool tick();

    virtual UIElement *findView(const Common::String &name);

    // Mouse move only has a minimal implementation for performance reasons
protected:
    virtual bool msgMouseMove(const MouseMoveMessage &msg) {
        return false;
    }

#ifdef USE_TTS

    void stopTextToSpeech();
#endif

public:
    bool send(const MouseMoveMessage &msg) {
        return msgMouseMove(msg);
    }

#define MESSAGE(NAME)                                                     \
protected:                                                                \
    virtual bool msg##NAME(const NAME##Message &e) {                      \
        for (Common::Array<UIElement *>::iterator it = _children.begin(); \
             it != _children.end(); ++it) {                               \
            if ((*it)->msg##NAME(e))                                      \
                return true;                                              \
        }                                                                 \
        return false;                                                     \
    }                                                                     \
                                                                          \
public:                                                                   \
    bool send(const Common::String &viewName, const NAME##Message &msg) { \
        UIElement *view = UIElement::findViewGlobally(viewName);          \
        assert(view);                                                     \
        return view->msg##NAME(msg);                                      \
    }                                                                     \
    bool send(const NAME##Message &msg) {                                 \
        return msg##NAME(msg);                                            \
    }

    MESSAGE(Focus);
    MESSAGE(Unfocus);
    MESSAGE(MouseEnter);
    MESSAGE(MouseLeave);
    MESSAGE(Keypress);
    MESSAGE(MouseDown);
    MESSAGE(MouseUp);
    MESSAGE(Action);
    MESSAGE(Game);
    MESSAGE(Value);
#undef MESSAGE
};

class Events : public UIElement {
private:
    Graphics::Screen *_screen = nullptr;
    Common::Stack<UIElement *> _views;
    int _palLoop = 0;
    int _palCnt1 = 0;
    int _palCnt2 = 0;

    void nextFrame();
    int actionToKeyFlag(int action) const;
    void rotatePalette();

    void processEvent(Common::Event &ev);

    void processDemoEvent(byte ev);

protected:
    virtual bool shouldQuit() const = 0;

#define MESSAGE(NAME)                                                 \
    bool msg##NAME(const NAME##Message &e) override {                 \
        return !_views.empty() ? focusedView()->msg##NAME(e) : false; \
    }
    MESSAGE(Action);
    MESSAGE(Focus);
    MESSAGE(Unfocus);
    MESSAGE(MouseEnter);
    MESSAGE(MouseLeave);
    MESSAGE(Keypress);
    MESSAGE(MouseDown);
    MESSAGE(MouseUp);
    MESSAGE(MouseMove);
#undef MESSAGE
public:
    Events();
    virtual ~Events();

    virtual bool isDemo() const = 0;

    void runGame();

    void replaceView(UIElement *ui, bool replaceAllViews = false, bool fadeOutIn = false) override;
    void replaceView(const Common::String &name, bool replaceAllViews = false, bool fadeOutIn = false) override;

    void addView(UIElement *ui) override;
    void addView(const Common::String &name) override;

    void clearViews();

    void popView();

    UIElement *focusedView() const {
        return _views.empty() ? nullptr : _views.top();
    }

    UIElement *priorView() const {
        return _views.size() < 2 ? nullptr : _views[_views.size() - 2];
    }

    UIElement *firstView() const {
        return _views.empty() ? nullptr : _views[0];
    }

    bool isPresent(const Common::String &name) const;

    bool isInCombat() const {
        return isPresent("Combat");
    }

    Graphics::Screen *getScreen() const {
        return _screen;
    }

    void drawElements() override;

    void draw() override {}

    bool tick() override {
        return !_views.empty() ? focusedView()->tick() : false;
    }

    void close() override {
        focusedView()->close();
    }
};

extern Events *g_events;

} // namespace Got

#endif