hardware-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 COMMON_HARDWARE_KEY_H
#define COMMON_HARDWARE_KEY_H
 
#include "common/scummsys.h"
 
#include "common/array.h"
#include "common/events.h"
#include "common/keyboard.h"
#include "common/str.h"
 
namespace Common {
 
typedef uint32 HardwareInputCode;
 
enum HardwareInputType {
    kHardwareInputTypeInvalid,
    kHardwareInputTypeKeyboard,
    kHardwareInputTypeMouse,
    kHardwareInputTypeJoystickButton,
    kHardwareInputTypeJoystickHalfAxis,
    kHardwareInputTypeCustom
};
 
struct HardwareInput {
    String id;
 
    U32String description;
 
    HardwareInputType type;
 
    HardwareInputCode inputCode;
 
    KeyState key;
 
    HardwareInput()
        : inputCode(0), type(kHardwareInputTypeInvalid) { }
 
    static HardwareInput createCustom(const String &i, HardwareInputCode ic, const U32String &desc) {
        return createSimple(kHardwareInputTypeCustom, i, ic, desc);
    }
 
    static HardwareInput createKeyboard(const String &i, KeyState ky, const U32String &desc) {
        HardwareInput hardwareInput;
        hardwareInput.id = i;
        hardwareInput.description = desc;
        hardwareInput.type = kHardwareInputTypeKeyboard;
        hardwareInput.inputCode = 0;
        hardwareInput.key = ky;
        return hardwareInput;
    }
 
    static HardwareInput createJoystickButton(const String &i, uint8 button, const U32String &desc) {
        return createSimple(kHardwareInputTypeJoystickButton, i, button, desc);
    }
 
    static HardwareInput createJoystickHalfAxis(const String &i, uint8 axis, bool positiveHalf, const U32String &desc) {
        return createSimple(kHardwareInputTypeJoystickHalfAxis, i, axis * 2 + (positiveHalf ? 1 : 0), desc);
    }
 
    static HardwareInput createMouse(const String &i, uint8 button, const U32String &desc) {
        return createSimple(kHardwareInputTypeMouse, i, button, desc);
    }
 
private:
    static HardwareInput createSimple(HardwareInputType type, const String &i, HardwareInputCode ic, const U32String &desc) {
        HardwareInput hardwareInput;
        hardwareInput.id = i;
        hardwareInput.description = desc;
        hardwareInput.type = type;
        hardwareInput.inputCode = ic;
        return hardwareInput;
    }
};
 
struct HardwareInputTableEntry {
    const char *hwId;
    HardwareInputCode code;
    const char *desc;
 
    static const HardwareInputTableEntry *findWithCode(const HardwareInputTableEntry *_entries, HardwareInputCode code) {
        for (const HardwareInputTableEntry *hw = _entries;  hw->hwId; hw++) {
            if (hw->code == code) {
                return hw;
            }
        }
        return nullptr;
    }
 
    static const HardwareInputTableEntry *findWithId(const HardwareInputTableEntry *_entries, const String &id) {
        for (const HardwareInputTableEntry *hw = _entries;  hw->hwId; hw++) {
            if (id.equals(hw->hwId)) {
                return hw;
            }
        }
        return nullptr;
    }
};
 
struct KeyTableEntry {
    const char *hwId;
    KeyCode keycode;
    const char *desc;
};
 
struct ModifierTableEntry {
    byte flag;
    const char *id;
    const char *desc;
};
 
enum AxisType {
    kAxisTypeFull,
    kAxisTypeHalf
};
 
struct AxisTableEntry {
    const char *hwId;
    HardwareInputCode code;
    AxisType type;
    const char *desc;
 
    static const AxisTableEntry *findWithCode(const AxisTableEntry *_entries, HardwareInputCode code) {
        for (const AxisTableEntry *hw = _entries;  hw->hwId; hw++) {
            if (hw->code == code) {
                return hw;
            }
        }
        return nullptr;
    }
 
    static const AxisTableEntry *findWithId(const AxisTableEntry *_entries, const String &id) {
        for (const AxisTableEntry *hw = _entries;  hw->hwId; hw++) {
            if (id.equals(hw->hwId)) {
                return hw;
            }
        }
        return nullptr;
    }
};
 
 
class HardwareInputSet {
public:
    virtual ~HardwareInputSet();
 
    virtual HardwareInput findHardwareInput(const String &id) const = 0;
 
    virtual HardwareInput findHardwareInput(const Event &event) const = 0;
};
 
class KeyboardHardwareInputSet : public HardwareInputSet {
public:
    KeyboardHardwareInputSet(const KeyTableEntry *keys, const ModifierTableEntry *modifiers);
 
    // HardwareInputSet API
    HardwareInput findHardwareInput(const String &id) const override;
    HardwareInput findHardwareInput(const Event &event) const override;
 
    static KeyState normalizeKeyState(const KeyState &keystate);
 
private:
    const KeyTableEntry *_keys;
    const ModifierTableEntry *_modifiers;
};
 
class MouseHardwareInputSet : public HardwareInputSet {
public:
    MouseHardwareInputSet(const HardwareInputTableEntry *buttonEntries);
 
    // HardwareInputSet API
    HardwareInput findHardwareInput(const String &id) const override;
    HardwareInput findHardwareInput(const Event &event) const override;
 
private:
    const HardwareInputTableEntry *_buttonEntries;
};
 
class JoystickHardwareInputSet : public HardwareInputSet {
public:
    JoystickHardwareInputSet(const HardwareInputTableEntry *buttonEntries, const AxisTableEntry *axisEntries);
 
    // HardwareInputSet API
    HardwareInput findHardwareInput(const String &id) const override;
    HardwareInput findHardwareInput(const Event &event) const override;
 
private:
    const HardwareInputTableEntry *_buttonEntries;
    const AxisTableEntry *_axisEntries;
};
 
class CustomHardwareInputSet : public HardwareInputSet {
public:
    CustomHardwareInputSet(const HardwareInputTableEntry *hardwareEntries);
 
    // HardwareInputSet API
    HardwareInput findHardwareInput(const String &id) const override;
    HardwareInput findHardwareInput(const Event &event) const override;
 
private:
    const HardwareInputTableEntry *_hardwareEntries;
};
 
class CompositeHardwareInputSet : public HardwareInputSet {
public:
    ~CompositeHardwareInputSet() override;
 
    // HardwareInputSet API
    HardwareInput findHardwareInput(const String &id) const override;
    HardwareInput findHardwareInput(const Event &event) const override;
 
    void addHardwareInputSet(HardwareInputSet *hardwareInputSet);
 
private:
    Array<HardwareInputSet *> _inputSets;
};
 
extern const KeyTableEntry defaultKeys[];
 
extern const ModifierTableEntry defaultModifiers[];
 
extern const HardwareInputTableEntry defaultMouseButtons[];
 
extern const HardwareInputTableEntry defaultJoystickButtons[];
 
extern const AxisTableEntry defaultJoystickAxes[];
 
} // End of namespace Common
 
#endif // #ifndef COMMON_HARDWARE_KEY_H