223 lines
5.6 KiB
C
223 lines
5.6 KiB
C
/*
|
|
* Copyright (C) 2013 Glyptodon LLC
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
|
|
#ifndef _GUAC_RDP_RDP_KEYMAP_H
|
|
#define _GUAC_RDP_RDP_KEYMAP_H
|
|
|
|
#include "config.h"
|
|
|
|
#ifdef ENABLE_WINPR
|
|
#include <winpr/wtypes.h>
|
|
#else
|
|
#include "compat/winpr-wtypes.h"
|
|
#endif
|
|
|
|
/**
|
|
* Represents a keysym-to-scancode mapping for RDP, with extra information
|
|
* about the state of prerequisite keysyms.
|
|
*/
|
|
typedef struct guac_rdp_keysym_desc {
|
|
|
|
/**
|
|
* The keysym being mapped.
|
|
*/
|
|
int keysym;
|
|
|
|
/**
|
|
* The scancode this keysym maps to.
|
|
*/
|
|
int scancode;
|
|
|
|
/**
|
|
* Required RDP-specific flags.
|
|
*/
|
|
int flags;
|
|
|
|
/**
|
|
* Null-terminated list of keysyms which must be down for this keysym
|
|
* to be properly typed.
|
|
*/
|
|
const int* set_keysyms;
|
|
|
|
/**
|
|
* Null-terminated list of keysyms which must be up for this keysym
|
|
* to be properly typed.
|
|
*/
|
|
const int* clear_keysyms;
|
|
|
|
} guac_rdp_keysym_desc;
|
|
|
|
/**
|
|
* Hierarchical keysym mapping
|
|
*/
|
|
typedef struct guac_rdp_keymap guac_rdp_keymap;
|
|
struct guac_rdp_keymap {
|
|
|
|
/**
|
|
* The parent mapping this map will inherit its initial mapping from.
|
|
* Any other mapping information will add to or override the mapping
|
|
* inherited from the parent.
|
|
*/
|
|
const guac_rdp_keymap* parent;
|
|
|
|
/**
|
|
* Descriptive name of this keymap
|
|
*/
|
|
const char* name;
|
|
|
|
/**
|
|
* Null-terminated array of scancode mappings.
|
|
*/
|
|
const guac_rdp_keysym_desc* mapping;
|
|
|
|
/**
|
|
* FreeRDP keyboard layout associated with this
|
|
* keymap. If this keymap is selected, this layout
|
|
* will be requested from the server.
|
|
*/
|
|
const UINT32 freerdp_keyboard_layout;
|
|
|
|
};
|
|
|
|
/**
|
|
* Static mapping from keysyms to scancodes.
|
|
*/
|
|
typedef guac_rdp_keysym_desc guac_rdp_static_keymap[0x200][0x100];
|
|
|
|
/**
|
|
* Mapping from keysym to current state
|
|
*/
|
|
typedef int guac_rdp_keysym_state_map[0x200][0x100];
|
|
|
|
/**
|
|
* Simple macro for determing whether a keysym can be stored (or retrieved)
|
|
* from any keymap.
|
|
*
|
|
* @param keysym
|
|
* The keysym to check.
|
|
*
|
|
* @return
|
|
* Non-zero if the keysym can be stored or retrieved, zero otherwise.
|
|
*/
|
|
#define GUAC_RDP_KEYSYM_STORABLE(keysym) ((keysym) <= 0xFFFF || ((keysym) & 0xFFFF0000) == 0x01000000)
|
|
|
|
/**
|
|
* Simple macro for referencing the mapped value of a scancode for a given
|
|
* keysym. The idea here is that a keysym of the form 0xABCD will map to
|
|
* mapping[0xAB][0xCD] while a keysym of the form 0x100ABCD will map to
|
|
* mapping[0x1AB][0xCD].
|
|
*
|
|
* @param keysym_mapping
|
|
* A 512-entry array of 256-entry arrays of arbitrary values, where the
|
|
* location of each array and value is determined by the given keysym.
|
|
*
|
|
* @param keysym
|
|
* The keysym of the entry to look up.
|
|
*/
|
|
#define GUAC_RDP_KEYSYM_LOOKUP(keysym_mapping, keysym) ( \
|
|
(keysym_mapping) \
|
|
[(((keysym) & 0xFF00) >> 8) | ((keysym) >> 16)] \
|
|
[(keysym) & 0xFF] \
|
|
)
|
|
|
|
/**
|
|
* The name of the default keymap, which MUST exist.
|
|
*/
|
|
#define GUAC_DEFAULT_KEYMAP "en-us-qwerty"
|
|
|
|
/**
|
|
* Keysym string containing only the left "shift" key.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_SHIFT[];
|
|
|
|
/**
|
|
* Keysym string containing both "shift" keys.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALL_SHIFT[];
|
|
|
|
/**
|
|
* Keysym string containing only the right "alt" key (AltGr).
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALTGR[];
|
|
|
|
/**
|
|
* Keysym string containing the right "alt" key (AltGr) and
|
|
* left shift.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_SHIFT_ALTGR[];
|
|
|
|
/**
|
|
* Keysym string containing the right "alt" key (AltGr) and
|
|
* both shift keys.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALL_SHIFT_ALTGR[];
|
|
|
|
/**
|
|
* Keysym string containing only the left "ctrl" key.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_CTRL[];
|
|
|
|
/**
|
|
* Keysym string containing both "ctrl" keys.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALL_CTRL[];
|
|
|
|
/**
|
|
* Keysym string containing only the left "alt" key.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALT[];
|
|
|
|
/**
|
|
* Keysym string containing both "alt" keys.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALL_ALT[];
|
|
|
|
/**
|
|
* Keysym string containing the left "alt" and left "ctrl" keys
|
|
*/
|
|
extern const int GUAC_KEYSYMS_CTRL_ALT[];
|
|
|
|
/**
|
|
* Keysym string containing all modifier keys.
|
|
*/
|
|
extern const int GUAC_KEYSYMS_ALL_MODIFIERS[];
|
|
|
|
/**
|
|
* NULL-terminated array of all keymaps.
|
|
*/
|
|
extern const guac_rdp_keymap* GUAC_KEYMAPS[];
|
|
|
|
/**
|
|
* Return the keymap having the given name, if any, or NULL otherwise.
|
|
*
|
|
* @param name
|
|
* The name of the keymap to find.
|
|
*
|
|
* @return
|
|
* The keymap having the given name, or NULL if no such keymap exists.
|
|
*/
|
|
const guac_rdp_keymap* guac_rdp_keymap_find(const char* name);
|
|
|
|
#endif
|
|
|