input.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 TWINE_KEYBOARD_H
#define TWINE_KEYBOARD_H

#include "common/events.h"
#include "common/keyboard.h"
#include "common/scummsys.h"
#include "common/util.h"
#include "common/rect.h"

namespace TwinE {

class TwinEEngine;

extern const char *mainKeyMapId;
extern const char *uiKeyMapId;
extern const char *cutsceneKeyMapId;
extern const char *holomapKeyMapId;

enum TwinEActionType {
    Pause,
    DebugGridCameraPressUp,
    DebugGridCameraPressDown,
    DebugGridCameraPressLeft,
    DebugGridCameraPressRight,
    QuickBehaviourNormal,
    QuickBehaviourAthletic,
    QuickBehaviourAggressive,
    QuickBehaviourDiscreet,
    ChangeBehaviourNormal,
    ChangeBehaviourAthletic,
    ChangeBehaviourAggressive,
    ChangeBehaviourDiscreet,
    ExecuteBehaviourAction,
    BehaviourMenu,
    OptionsMenu,
    RecenterScreenOnTwinsen,
    UseSelectedObject,
    ThrowMagicBall,
    MoveForward,
    MoveBackward,
    TurnRight,
    TurnLeft,
    UseProtoPack,
    OpenHolomap,
    InventoryMenu,
    SpecialAction,
    SceneryZoom,
    Escape,

    UIEnter,
    UIAbort,
    UILeft,
    UIRight,
    UIUp,
    UIDown,
    UINextPage,

    CutsceneAbort,

    HolomapAbort,
    HolomapLeft,
    HolomapRight,
    HolomapUp,
    HolomapDown,
    HolomapNext,
    HolomapPrev,

    Max
};

class ScopedKeyMap {
private:
    TwinEEngine* _engine;
    bool _changed;
    Common::String _keymap;
public:
    ScopedKeyMap(TwinEEngine* engine, const char *id);
    ~ScopedKeyMap();
};

class Input {
private:
    TwinEEngine *_engine;
    Common::String _currentKeyMap;

    uint8 _actionStates[TwinEActionType::Max]{false};
    Common::Point _lastMousePos;
public:
    Input(TwinEEngine *engine);

    void enableKeyMap(const char *id);
    bool enableAdditionalKeyMap(const char *id, bool enable);

    const Common::String currentKeyMap() const;

    bool isActionActive(TwinEActionType actionType, bool onlyFirstTime = true) const;

    void resetLastHoveredMousePosition();
    bool isMouseHovering(const Common::Rect &rect, bool onlyIfMoved = true);

    bool toggleActionIfActive(TwinEActionType actionType);
    void resetActionStates();

    bool toggleAbortAction();

    bool isQuickBehaviourActionActive() const;
    bool isMoveOrTurnActionActive() const;
    bool isHeroActionActive() const;
    bool resetHeroActions();

    Common::Point getMousePositions() const;

    void readKeys();
    void processCustomEngineEventStart(const Common::Event& event);
    void processCustomEngineEventEnd(const Common::Event& event);
};

inline const Common::String Input::currentKeyMap() const {
    return _currentKeyMap;
}

} // namespace TwinE

#endif