include/rdp_keymap.h

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   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/
   9  *
  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
  13  * License.
  14  *
  15  * The Original Code is libguac-client-rdp.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2011
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  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.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _GUAC_RDP_RDP_KEYMAP_H
  39 #define _GUAC_RDP_RDP_KEYMAP_H
  40
  41 #include <freerdp/locale/keyboard.h>
  42
  43 /**
  44  * Represents a keysym-to-scancode mapping for RDP, with extra information
  45  * about the state of prerequisite keysyms.
  46  */
  47 typedef struct guac_rdp_keysym_desc {
  48
  49     /**
  50      * The keysym being mapped.
  51      */
  52     int keysym;
  53
  54     /**
  55      * The scancode this keysym maps to.
  56      */
  57     int scancode;
  58
  59     /**
  60      * Required RDP-specific flags.
  61      */
  62     int flags;
  63
  64     /**
  65      * Null-terminated list of keysyms which must be down for this keysym
  66      * to be properly typed.
  67      */
  68     const int* set_keysyms;
  69
  70     /**
  71      * Null-terminated list of keysyms which must be up for this keysym
  72      * to be properly typed.
  73      */
  74     const int* clear_keysyms;
  75
  76 } guac_rdp_keysym_desc;
  77
  78 /**
  79  * Hierarchical keysym mapping
  80  */
  81 typedef struct guac_rdp_keymap guac_rdp_keymap;
  82 struct guac_rdp_keymap {
  83
  84     /**
  85      * The parent mapping this map will inherit its initial mapping from.
  86      * Any other mapping information will add to or override the mapping
  87      * inherited from the parent.
  88      */
  89     const guac_rdp_keymap* parent;
  90
  91     /**
  92      * Descriptive name of this keymap
  93      */
  94     const char* name;
  95
  96     /**
  97      * Null-terminated array of scancode mappings.
  98      */
  99     const guac_rdp_keysym_desc* mapping;
 100
 101     /**
 102      * FreeRDP keyboard layout associated with this
 103      * keymap. If this keymap is selected, this layout
 104      * will be requested from the server.
 105      */
 106     const uint32 freerdp_keyboard_layout;
 107
 108 };
 109
 110 /**
 111  * Static mapping from keysyms to scancodes.
 112  */
 113 typedef guac_rdp_keysym_desc guac_rdp_static_keymap[256][256];
 114
 115 /**
 116  * Mapping from keysym to current state
 117  */
 118 typedef int guac_rdp_keysym_state_map[256][256];
 119
 120 /**
 121  * Map of X11 keysyms to RDP scancodes (US English).
 122  */
 123 extern const guac_rdp_keymap guac_rdp_keymap_en_us;
 124
 125 /**
 126  * Map of X11 keysyms to RDP scancodes (common non-printable keys).
 127  */
 128 extern const guac_rdp_keymap guac_rdp_keymap_base;
 129
 130 /**
 131  * Simple macro for referencing the mapped value of an altcode or scancode for a given keysym.
 132  */
 133 #define GUAC_RDP_KEYSYM_LOOKUP(keysym_mapping, keysym) ((keysym_mapping)[((keysym) & 0xFF00) >> 8][(keysym) & 0xFF])
 134
 135 /**
 136  * Keysym string containing only the left "shift" key.
 137  */
 138 extern const int GUAC_KEYSYMS_SHIFT[];
 139
 140 /**
 141  * Keysym string containing both "shift" keys.
 142  */
 143 extern const int GUAC_KEYSYMS_ALL_SHIFT[];
 144
 145 /**
 146  * Keysym string containing only the left "ctrl" key.
 147  */
 148 extern const int GUAC_KEYSYMS_CTRL[];
 149
 150 /**
 151  * Keysym string containing both "ctrl" keys.
 152  */
 153 extern const int GUAC_KEYSYMS_ALL_CTRL[];
 154
 155 /**
 156  * Keysym string containing only the left "alt" key.
 157  */
 158 extern const int GUAC_KEYSYMS_ALT[];
 159
 160 /**
 161  * Keysym string containing both "alt" keys.
 162  */
 163 extern const int GUAC_KEYSYMS_ALL_ALT[];
 164
 165 /**
 166  * Keysym string containing all modifier keys.
 167  */
 168 extern const int GUAC_KEYSYMS_ALL_MODIFIERS[];
 169
 170 #endif
 171