keymap.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_KEYMAP_H
#define COMMON_KEYMAP_H

#include "common/scummsys.h"

#include "backends/keymapper/hardware-input.h"

#include "common/config-manager.h"
#include "common/func.h"
#include "common/hashmap.h"
#include "common/hash-ptr.h"
#include "common/list.h"
#include "common/str-array.h"

namespace Common {

const char *const kStandardActionsKeymapName = "standard-actions";

struct Action;
struct Event;
struct HardwareInput;
class HardwareInputSet;
class KeymapperDefaultBindings;

struct HardwareInput_EqualTo {
    bool operator()(const HardwareInput& x, const HardwareInput& y) const {
        return (x.type == y.type)
                && (x.key.keycode == y.key.keycode)
                && (x.key.flags == y.key.flags)
                && (x.inputCode == y.inputCode);
    }
};

struct HardwareInput_Hash {
    uint operator()(const HardwareInput& x) const {
        uint hash = 7;
        hash = 31 * hash + x.type;
        hash = 31 * hash + x.key.keycode;
        hash = 31 * hash + x.key.flags;
        hash = 31 * hash + x.inputCode;
        return hash;
    }
};

class Keymap {
public:
    enum KeymapType {
        kKeymapTypeGlobal,
        kKeymapTypeGui,
        kKeymapTypeGame
    };

    enum KeymapMatch {
        kKeymapMatchNone,
        kKeymapMatchPartial,
        kKeymapMatchExact
    };

    typedef Array<Action *> ActionArray;

    Keymap(KeymapType type, const String &id, const U32String &description);
    Keymap(KeymapType type, const String &id, const String &description);
    ~Keymap();
    void setConfigDomain(ConfigManager::Domain *configDomain);
    void setHardwareInputs(HardwareInputSet *hardwareInputSet);
    void setBackendDefaultBindings(const KeymapperDefaultBindings *backendDefaultBindings);

    void registerMapping(Action *action, const HardwareInput &input);

    void unregisterMapping(Action *action);

    void resetMapping(Action *action);

    Array<HardwareInput> getActionMapping(const Action *action) const;

    KeymapMatch getMappedActions(const Event &event, ActionArray &actions) const;

    void addAction(Action *action);

    const ActionArray &getActions() const { return _actions; }

    StringArray getActionDefaultMappings(Action *action);

    void loadMappings();

    void saveMappings();

    const String &getId() const { return _id; }
    const U32String &getDescription() const { return _description; }
    KeymapType getType() const { return _type; }

    bool isEnabled() const { return _enabled; }
    void setEnabled(bool enabled) { _enabled = enabled; }

    static Array<Keymap *> arrayOf(Keymap *keymap) {
        return Array<Keymap *>(1, keymap);
    }

private:

    const Action *findAction(const char *id) const;

    void registerMappings(Action *action, const StringArray &hwInputIds);
    bool areMappingsIdentical(const Array<HardwareInput> &inputs, const StringArray &mapping);

    typedef HashMap<HardwareInput, ActionArray, HardwareInput_Hash, HardwareInput_EqualTo> HardwareActionMap;

    KeymapType _type;
    String _id;
    U32String _description;

    bool _enabled;

    ActionArray _actions;
    HardwareActionMap _hwActionMap;

    ConfigManager::Domain *_configDomain;
    HardwareInputSet *_hardwareInputSet;
    const KeymapperDefaultBindings *_backendDefaultBindings;
};

typedef Array<Keymap *> KeymapArray;

} // End of namespace Common

#endif // #ifndef COMMON_KEYMAP_H