Do not use addressof in lookup macro. Update keysym state in event handler.

[libguac-client-rdp.git] / include / rdp_keymap.h

diff --git a/include/rdp_keymap.h b/include/rdp_keymap.h
index 73ddc32..85eb8f4 100644 (file)
--- a/include/rdp_keymap.h
+++ b/include/rdp_keymap.h
@@ -35,10 +35,88 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
-#ifndef _GUAC_CLIENT_RDP_KEYMAP
-#define _GUAC_CLIENT_RDP_KEYMAP
+#ifndef _GUAC_RDP_RDP_KEYMAP_H
+#define _GUAC_RDP_RDP_KEYMAP_H
 
-extern const int guac_rdp_keysym_scancode[256][256];
+/**
+ * Represents a keysym-to-scancode mapping for RDP, with extra information
+ * about the state of prerequisite keysyms.
+ */
+typedef struct guac_rdp_scancode_map {
+
+    /**
+     * 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_scancode_map;
+
+/**
+ * Represents the Alt-code which types a given keysym. This is used as a
+ * fallback mapping, should a particular keymap not support a certain keysym.
+ *
+ * See: http://en.wikipedia.org/wiki/Alt_code
+ */
+typedef struct guac_rdp_altcode_map {
+
+    /**
+     * The 4-digit Alt-code which types this keysym.
+     */
+    const char* altcode;
+
+} guac_rdp_altcode_map;
+
+/**
+ * Mapping from keysym to current state
+ */
+typedef int guac_rdp_keysym_state_map[256][256];
+
+/**
+ * Static mapping from keysyms to scancodes.
+ */
+typedef guac_rdp_scancode_map guac_rdp_keysym_scancode_map[256][256];
+
+/**
+ * Static mapping from keysyms to Alt-codes.
+ */
+typedef guac_rdp_altcode_map guac_rdp_keysym_altcode_map[256][256];
+
+/**
+ * Map of X11 keysyms to RDP scancodes (US English).
+ */
+extern const guac_rdp_keysym_scancode_map guac_rdp_keysym_scancode_en_us;
+
+/**
+ * Map of X11 keysyms to Windows Alt-codes.
+ */
+extern const guac_rdp_keysym_altcode_map guac_rdp_keysym_altcode;
+
+/**
+ * Simple macro for referencing the mapped value of an altcode or scancode for a given keysym.
+ */
+#define GUAC_RDP_KEYSYM_LOOKUP(keysym_mapping, keysym) ((keysym_mapping)[((keysym) & 0xFF00) >> 8][(keysym) & 0xFF])
+
+/**
+ * Keysym string containing only the left "shift" key.
+ */
+extern const int GUAC_KEYSYMS_SHIFT[];
 
 #endif