KeymapManager.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef MACHINE_KEYMAP_MANAGER_H
#define MACHINE_KEYMAP_MANAGER_H

#include "pedigree/kernel/Spinlock.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/Tree.h"

class EXPORTED_PUBLIC KeymapManager
{
  public:
    KeymapManager();

    virtual ~KeymapManager();

    static KeymapManager &instance()
    {
        return m_Instance;
    }

    void useKeymap(uint8_t *pSparseTable, uint8_t *pDataTable);

    bool useCompiledKeymap(uint32_t *pCompiledKeymap, size_t keymapLength);

    bool handleHidModifier(uint8_t keyCode, bool bDown);

    uint64_t resolveHidKeycode(uint8_t keyCode);

    enum EscapeState
    {
        EscapeNone = 0,
        EscapeE0,
        EscapeE1,
    };

    uint8_t
    convertPc102ScancodeToHidKeycode(uint8_t scancode, EscapeState &escape);

    struct KeymapEntry
    {
        enum Flags
        {
            Special = 0x80000000
        };
        uint32_t flags;
        uint32_t value;
    };

    KeymapEntry *getKeymapEntry(
        bool bCtrl, bool bShift, bool bAlt, bool bAltGr, uint8_t nCombinator,
        uint8_t keyCode);

  private:
    enum IndexModifiers
    {
        IndexCtrl = 1,
        IndexShift = 2,
        IndexAlt = 4,
        IndexAltGr = 8
    };

    enum HidModifiers
    {
        HidCapsLock = 0x39,
        HidLeftCtrl = 0xE0,
        HidLeftShift = 0xE1,
        HidLeftAlt = 0xE2,
        HidLeftGui = 0xE3,
        HidRightCtrl = 0xE4,
        HidRightShift = 0xE5,
        HidRightAlt = 0xE6,
        HidRightGui = 0xE7,
    };

    struct SparseEntry
    {
        enum Flags
        {
            DataFlag = 0x8000
        };
        uint16_t left;
        uint16_t right;
    };

    static KeymapManager m_Instance;

    SparseEntry *m_pSparseTable;
    KeymapEntry *m_pDataTable;

    bool m_bLeftCtrl;
    bool m_bLeftShift;
    bool m_bLeftAlt;
    bool m_bRightCtrl;
    bool m_bRightShift;
    bool m_bRightAlt;

    bool m_bCapsLock;

    uint8_t m_nCombinator;

    struct KeyState
    {
        uint64_t key;

        uint64_t nLeftTicks;
    };

    Tree<uint8_t, KeyState *> m_KeyStates;

    Spinlock m_KeyLock;

    bool m_bHaveLoadedKeymap;
};

#endif