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 #ifdef HAVE_FREERDP_LOCALE_KEYBOARD_H
  42 #include <freerdp/locale/keyboard.h>
  43 #else
  44 #include <freerdp/kbd/layouts.h>
  45 #endif
  46
  47 /**
  48  * Represents a keysym-to-scancode mapping for RDP, with extra information
  49  * about the state of prerequisite keysyms.
  50  */
  51 typedef struct guac_rdp_keysym_desc {
  52
  53     /**
  54      * The keysym being mapped.
  55      */
  56     int keysym;
  57
  58     /**
  59      * The scancode this keysym maps to.
  60      */
  61     int scancode;
  62
  63     /**
  64      * Required RDP-specific flags.
  65      */
  66     int flags;
  67
  68     /**
  69      * Null-terminated list of keysyms which must be down for this keysym
  70      * to be properly typed.
  71      */
  72     const int* set_keysyms;
  73
  74     /**
  75      * Null-terminated list of keysyms which must be up for this keysym
  76      * to be properly typed.
  77      */
  78     const int* clear_keysyms;
  79
  80 } guac_rdp_keysym_desc;
  81
  82 /**
  83  * Hierarchical keysym mapping
  84  */
  85 typedef struct guac_rdp_keymap guac_rdp_keymap;
  86 struct guac_rdp_keymap {
  87
  88     /**
  89      * The parent mapping this map will inherit its initial mapping from.
  90      * Any other mapping information will add to or override the mapping
  91      * inherited from the parent.
  92      */
  93     const guac_rdp_keymap* parent;
  94
  95     /**
  96      * Descriptive name of this keymap
  97      */
  98     const char* name;
  99
 100     /**
 101      * Null-terminated array of scancode mappings.
 102      */
 103     const guac_rdp_keysym_desc* mapping;
 104
 105     /**
 106      * FreeRDP keyboard layout associated with this
 107      * keymap. If this keymap is selected, this layout
 108      * will be requested from the server.
 109      */
 110     const uint32 freerdp_keyboard_layout;
 111
 112 };
 113
 114 /**
 115  * Static mapping from keysyms to scancodes.
 116  */
 117 typedef guac_rdp_keysym_desc guac_rdp_static_keymap[256][256];
 118
 119 /**
 120  * Mapping from keysym to current state
 121  */
 122 typedef int guac_rdp_keysym_state_map[256][256];
 123
 124 /**
 125  * Map of X11 keysyms to RDP scancodes (US English).
 126  */
 127 extern const guac_rdp_keymap guac_rdp_keymap_en_us;
 128
 129 /**
 130  * Map of X11 keysyms to RDP scancodes (common non-printable keys).
 131  */
 132 extern const guac_rdp_keymap guac_rdp_keymap_base;
 133
 134 /**
 135  * Simple macro for referencing the mapped value of a scancode for a given
 136  * keysym.
 137  */
 138 #define GUAC_RDP_KEYSYM_LOOKUP(keysym_mapping, keysym) ((keysym_mapping)[((keysym) & 0xFF00) >> 8][(keysym) & 0xFF])
 139
 140 /**
 141  * Keysym string containing only the left "shift" key.
 142  */
 143 extern const int GUAC_KEYSYMS_SHIFT[];
 144
 145 /**
 146  * Keysym string containing both "shift" keys.
 147  */
 148 extern const int GUAC_KEYSYMS_ALL_SHIFT[];
 149
 150 /**
 151  * Keysym string containing only the left "ctrl" key.
 152  */
 153 extern const int GUAC_KEYSYMS_CTRL[];
 154
 155 /**
 156  * Keysym string containing both "ctrl" keys.
 157  */
 158 extern const int GUAC_KEYSYMS_ALL_CTRL[];
 159
 160 /**
 161  * Keysym string containing only the left "alt" key.
 162  */
 163 extern const int GUAC_KEYSYMS_ALT[];
 164
 165 /**
 166  * Keysym string containing both "alt" keys.
 167  */
 168 extern const int GUAC_KEYSYMS_ALL_ALT[];
 169
 170 /**
 171  * Keysym string containing all modifier keys.
 172  */
 173 extern const int GUAC_KEYSYMS_ALL_MODIFIERS[];
 174
 175 #endif
 176