hotspots.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 file is dual-licensed.
 * In addition to the GPLv3 license mentioned above, this code is also
 * licensed under LGPL 2.1. See LICENSES/COPYING.LGPL file for the
 * full text of the license.
 *
 */

#ifndef GOB_HOTSPOTS_H
#define GOB_HOTSPOTS_H

#include "common/stack.h"

#include "gob/util.h"

namespace Gob {

class Font;
class Script;

class Hotspots {
public:
    static const int kHotspotCount = 250;

    enum Type {
        kTypeNone              =  0,
        kTypeMove              =  1,
        kTypeClick             =  2,
        kTypeInput1NoLeave     =  3,
        kTypeInput1Leave       =  4,
        kTypeInput2NoLeave     =  5,
        kTypeInput2Leave       =  6,
        kTypeInput3NoLeave     =  7,
        kTypeInput3Leave       =  8,
        kTypeInputFloatNoLeave =  9,
        kTypeInputFloatLeave   = 10,
        kTypeEnable2           = 11,
        kTypeEnable1           = 12,
        kTypeClickEnter        = 21
    };

    enum State {
        kStateFilledDisabled = 0xC,
        kStateFilled         = 0x8,
        kStateDisabled       = 0x4,
        kStateType2          = 0x2,
        kStateType1          = 0x1
    };

    Hotspots(GobEngine *vm);
    ~Hotspots();

    void clear();

    uint16 add(uint16 id,
            uint16 left,  uint16 top, uint16 right, uint16 bottom,
            uint16 flags, uint16 key,
            uint16 funcEnter, uint16 funcLeave, uint16 funcPos);

    void remove(uint16 id);
    void removeState(uint8 state);

    void push(uint8 all, bool force = false);
    void pop();

    uint16 check(uint8 handleMouse, int16 delay, uint16 &id, uint16 &index);
    uint16 check(uint8 handleMouse, int16 delay);

    void evaluate();

    int16 findCursor(uint16 x, uint16 y) const;

    void oPlaytoons_F_1B();

#ifdef USE_TTS
    bool hoveringOverHotspot() const;
    void addHotspotText(const Common::String &text, uint16 x1, uint16 y1, uint16 x2, uint16 y2, int16 surf);
    void voiceUnassignedHotspots();
    void voiceHotspotText(int16 x, int16 y);
    void clearHotspotText();
    void clearUnassignedHotspotText();
    void clearPreviousSaid();
    void adjustHotspotTextRect(int16 oldLeft, int16 oldTop, int16 oldRight, int16 oldBottom, int16 newX, int16 newY, int16 surf);
#endif

private:
    struct Hotspot {
        uint16  id;
        uint16  left;
        uint16  top;
        uint16  right;
        uint16  bottom;
        uint16  flags;
        uint16  key;
        uint16  funcEnter;
        uint16  funcLeave;
        uint16  funcPos;
        Script *scriptFuncLeave;
        Script *scriptFuncPos;

        Hotspot();
        Hotspot(uint16 i,
                uint16 l, uint16 t, uint16 r, uint16 b, uint16 f, uint16 k,
                uint16 enter, uint16 leave, uint16 pos);

        void clear();

        Type         getType  () const;
        MouseButtons getButton() const;
        uint16       getWindow() const;
        uint8        getCursor() const;
        uint8        getState () const;

        bool isEnd() const;

        bool isInput      () const;
        bool isActiveInput() const;
        bool isInputLeave () const;

        bool isFilled       () const;
        bool isFilledEnabled() const;
        bool isFilledNew    () const;
        bool isDisabled     () const;

        bool isIn(uint16 x, uint16 y) const;
        bool buttonMatch(MouseButtons button) const;

        static uint8 getState(uint16 id);

        void disable();
        void enable ();
    };

#ifdef USE_TTS
    struct HotspotTTSText {
        Common::String str;
        Common::Rect rect;
        int16 hotspot;
        bool voiced;
        int16 surf;
    };
#endif

    struct StackEntry {
        bool     shouldPush;
        Hotspot *hotspots;
        uint32   size;
        uint32   key;
        uint32   id;
        uint32   index;
        uint16   x;
        uint16   y;
    };

    struct InputDesc {
        uint16 fontIndex;
        uint16 backColor;
        uint16 frontColor;
        uint16 length;
        const char *str;
    };

    GobEngine *_vm;

    Hotspot *_hotspots;
    Common::Stack<StackEntry> _stack;

    bool _shouldPush;

    uint16 _currentKey;
    uint16 _currentIndex;
    uint16 _currentId;
    uint16 _currentX;
    uint16 _currentY;

#ifdef USE_TTS
    Common::String _previousSaid;
    int16 _currentHotspotTextIndex;
    bool _hotspotSpokenLast;
    Common::Array<HotspotTTSText> _hotspotText;
#endif

    uint16 add(const Hotspot &hotspot);

    void recalculate(bool force);

    bool isValid(uint16 key, uint16 id, uint16 index) const;

    void call(uint16 offset);
    void enter(uint16 index);
    void leave(uint16 index);

    int16 windowCursor(int16 &dx, int16 &dy) const;

    uint16 checkMouse(Type type, uint16 &id, uint16 &index) const;

    bool checkHotspotChanged();

    uint16 updateInput(uint16 xPos, uint16 yPos, uint16 width, uint16 height,
            uint16 backColor, uint16 frontColor, char *str, uint16 fontIndex,
            Type type, int16 &duration, uint16 &id, uint16 &index);

    uint16 handleInputs(int16 time, uint16 inputCount, uint16 &curInput,
            InputDesc *inputs, uint16 &id, uint16 &index);

    void evaluateNew(uint16 i, uint16 *ids, InputDesc *inputs,
            uint16 &inputId, bool &hasInput, uint16 &inputCount);
    bool evaluateFind(uint16 key, int16 timeVal, const uint16 *ids,
            uint16 leaveWindowIndex, uint16 hotspotIndex1, uint16 hotspotIndex2,
            uint16 endIndex, int16 &duration, uint16 &id, uint16 &index, bool &finished);

    // Finding specific hotspots
    uint16 inputToHotspot(uint16 input) const;
    uint16 hotspotToInput(uint16 hotspot) const;
    uint16 findClickedInput(uint16 index) const;
    bool findFirstInputLeave(uint16 &id, uint16 &inputId, uint16 &index) const;
    bool findKey(uint16 key, uint16 &id, uint16 &index) const;
    bool findKeyCaseInsensitive(uint16 key, uint16 &id, uint16 &index) const;
    bool findNthPlain(uint16 n, uint16 startIndex, uint16 &id, uint16 &index) const;

    bool leaveNthPlain(uint16 n, uint16 startIndex, int16 timeVal, const uint16 *ids,
            uint16 &id, uint16 &index, int16 &duration);

    // Hotspot ID variable access
    void setCurrentHotspot(const uint16 *ids, uint16 id) const;
    uint32 getCurrentHotspot() const;

    // String input functions
    void cleanFloatString(const Hotspot &spot) const;
    void checkStringMatch(const Hotspot &spot, const InputDesc &input,
            uint16 inputPos) const;
    void matchInputStrings(const InputDesc *inputs) const;

    uint16 convertSpecialKey(uint16 key) const;

    void getTextCursorPos(const Font &font, const char *str,
            uint32 pos, uint16 x, uint16 y, uint16 width, uint16 height,
            uint16 &cursorX, uint16 &cursorY, uint16 &cursorWidth, uint16 &cursorHeight) const;

    void fillRect(uint16 x, uint16 y, uint16 width, uint16 height, uint16 color) const;
    void printText(uint16 x, uint16 y, const char *str, uint16 fontIndex, uint16 color) const;

    void updateAllTexts(const InputDesc *inputs) const;

#ifdef USE_TTS
    void expandHotspotText(uint16 spotID);
    void removeHotspotText(uint16 spotID);
#endif
};

} // End of namespace Gob

#endif // GOB_HOTSPOTS_H