keymapper.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 COMMON_KEYMAPPER_H
#define COMMON_KEYMAPPER_H

#include "common/scummsys.h"

#include "backends/keymapper/keymap.h"

#include "common/array.h"
#include "common/config-manager.h"
#include "common/events.h"

namespace Common {

const char *const kGuiKeymapName = "gui";
const char *const kGlobalKeymapName = "global";

struct Action;
class DelayedEventSource;
struct HardwareInput;
class HardwareInputSet;
class KeymapperDefaultBindings;

class Keymapper : public Common::EventMapper {
public:

    Keymapper(EventManager *eventMan);
    ~Keymapper();

    // EventMapper interface
    virtual bool mapEvent(const Event &ev, List<Event> &mappedEvents);

    void registerHardwareInputSet(HardwareInputSet *inputs, KeymapperDefaultBindings *backendDefaultBindings);

    void addGlobalKeymap(Keymap *keymap);

    void addGameKeymap(Keymap *keymap);

    void cleanupGameKeymaps();

    void setGameKeymapState(const String &id, bool enable);

    void disableAllGameKeymaps();

    Keymap *getKeymap(const String &id) const;

    const KeymapArray &getKeymaps() const { return _keymaps; }

    void reloadAllMappings();

    void setEnabledKeymapType(Keymap::KeymapType type);
    Keymap::KeymapType enabledKeymapType() const { return _enabledKeymapType; }

    void setEnabled(bool enabled) { _enabled = enabled; }

    bool isEnabled() const { return _enabled; }

    void clear();

    HardwareInput findHardwareInput(const Event &event);

    void initKeymap(Keymap *keymap, ConfigManager::Domain *domain);
    void reloadKeymapMappings(Keymap *keymap);

private:
    EventManager *_eventMan;
    HardwareInputSet *_hardwareInputs;
    KeymapperDefaultBindings *_backendDefaultBindings;
    DelayedEventSource *_delayedEventSource;

    enum IncomingEventType {
        kIncomingEventIgnored,
        kIncomingEventStart,
        kIncomingEventEnd,
        kIncomingEventInstant
    };

    enum {
        kJoyAxisPressedTreshold   = Common::JOYAXIS_MAX / 2,
        kJoyAxisUnpressedTreshold = Common::JOYAXIS_MAX / 4
    };

    bool _enabled;
    Keymap::KeymapType _enabledKeymapType;

    KeymapArray _keymaps;

    bool _joystickAxisPreviouslyPressed[8]; // size should match the number of valid axis entries of defaultJoystickAxes (in hardware-input.cpp)

    Keymap::KeymapMatch getMappedActions(const Event &event, Keymap::ActionArray &actions, Keymap::KeymapType keymapType) const;
    Event executeAction(const Action *act, const Event &incomingEvent);
    EventType convertStartToEnd(EventType eventType);
    IncomingEventType convertToIncomingEventType(const Event &ev) const;

    void hardcodedEventMapping(Event ev);
    void resetInputState();
};

class KeymapTypeEnabler {
public:
    KeymapTypeEnabler(Keymapper *keymapper, Keymap::KeymapType keymapType) :
            _keymapper(keymapper) {
        assert(keymapper);
        _previousKeymapType = keymapper->enabledKeymapType();
        keymapper->setEnabledKeymapType(keymapType);
    }

    ~KeymapTypeEnabler() {
        _keymapper->setEnabledKeymapType(_previousKeymapType);
    }

private:
    Keymapper *_keymapper;
    Keymap::KeymapType _previousKeymapType;
};

class DelayedEventSource : public EventSource {
public:
    // EventSource API
    bool pollEvent(Event &event) override;
    bool allowMapping() const override;

    void scheduleEvent(const Event &ev, uint32 delayMillis);

private:
    struct DelayedEventsEntry {
        const uint32 timerOffset;
        const Event event;
        DelayedEventsEntry(const uint32 offset, const Event ev) : timerOffset(offset), event(ev) { }
    };

    Queue<DelayedEventsEntry> _delayedEvents;
    uint32 _delayedEffectiveTime;
};

} // End of namespace Common

#endif // #ifndef COMMON_KEYMAPPER_H