2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
15 * The Original Code is libguac-client-rdp.
17 * The Initial Developer of the Original Code is
19 * Portions created by the Initial Developer are Copyright (C) 2011
20 * the Initial Developer. All Rights Reserved.
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
36 * ***** END LICENSE BLOCK ***** */
38 #ifndef _GUAC_RDP_RDP_KEYMAP_H
39 #define _GUAC_RDP_RDP_KEYMAP_H
41 #include <freerdp/locale/keyboard.h>
45 * Represents a keysym-to-scancode mapping for RDP, with extra information
46 * about the state of prerequisite keysyms.
48 typedef struct guac_rdp_keysym_desc {
51 * The keysym being mapped.
56 * The scancode this keysym maps to.
61 * Required RDP-specific flags.
66 * Null-terminated list of keysyms which must be down for this keysym
67 * to be properly typed.
69 const int* set_keysyms;
72 * Null-terminated list of keysyms which must be up for this keysym
73 * to be properly typed.
75 const int* clear_keysyms;
77 } guac_rdp_keysym_desc;
80 * Hierarchical keysym mapping
82 typedef struct guac_rdp_keymap guac_rdp_keymap;
83 struct guac_rdp_keymap {
86 * The parent mapping this map will inherit its initial mapping from.
87 * Any other mapping information will add to or override the mapping
88 * inherited from the parent.
90 const guac_rdp_keymap* parent;
93 * Descriptive name of this keymap
98 * Null-terminated array of scancode mappings.
100 const guac_rdp_keysym_desc* mapping;
103 * FreeRDP keyboard layout associated with this
104 * keymap. If this keymap is selected, this layout
105 * will be requested from the server.
107 const uint32 freerdp_keyboard_layout;
112 * Static mapping from keysyms to scancodes.
114 typedef guac_rdp_keysym_desc guac_rdp_static_keymap[256][256];
117 * Mapping from keysym to current state
119 typedef int guac_rdp_keysym_state_map[256][256];
122 * Map of X11 keysyms to RDP scancodes (US English).
124 extern const guac_rdp_keymap guac_rdp_keymap_en_us;
127 * Map of X11 keysyms to RDP scancodes (common non-printable keys).
129 extern const guac_rdp_keymap guac_rdp_keymap_base;
132 * Simple macro for referencing the mapped value of an altcode or scancode for a given keysym.
134 #define GUAC_RDP_KEYSYM_LOOKUP(keysym_mapping, keysym) ((keysym_mapping)[((keysym) & 0xFF00) >> 8][(keysym) & 0xFF])
137 * Keysym string containing only the left "shift" key.
139 extern const int GUAC_KEYSYMS_SHIFT[];
142 * Keysym string containing both "shift" keys.
144 extern const int GUAC_KEYSYMS_ALL_SHIFT[];
147 * Keysym string containing only the left "ctrl" key.
149 extern const int GUAC_KEYSYMS_CTRL[];
152 * Keysym string containing both "ctrl" keys.
154 extern const int GUAC_KEYSYMS_ALL_CTRL[];
157 * Keysym string containing only the left "alt" key.
159 extern const int GUAC_KEYSYMS_ALT[];
162 * Keysym string containing both "alt" keys.
164 extern const int GUAC_KEYSYMS_ALL_ALT[];
167 * Keysym string containing all modifier keys.
169 extern const int GUAC_KEYSYMS_ALL_MODIFIERS[];