Newt: better keyboard input support on Windows (warning: may have broken the mobile windows build because of unicode API usage, I have no way to check)

git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/branches/JOGL_2_SANDBOX@1918 232f8b59-042b-4e1e-8c03-345bb8c30851

1 files changed, 429 insertions, 6 deletions

diff --git a/src/newt/native/WindowsWindow.c b/src/newt/native/WindowsWindow.c
index 3f8ba5c87..f76fdf46f 100755
--- a/src/newt/native/WindowsWindow.c
+++ b/src/newt/native/WindowsWindow.c
@@ -84,6 +84,345 @@ static jmethodID sendKeyEventID = NULL;
 // This is set by DispatchMessages, below, and cleared when it exits
 static JNIEnv* env = NULL;
 
+typedef struct {
+    UINT javaKey;
+    UINT windowsKey;
+} KeyMapEntry;
+
+// Static table, arranged more or less spatially.
+static KeyMapEntry keyMapTable[] = {
+    // Modifier keys
+    {J_VK_CAPS_LOCK,        VK_CAPITAL},
+    {J_VK_SHIFT,            VK_SHIFT},
+    {J_VK_CONTROL,          VK_CONTROL},
+    {J_VK_ALT,              VK_MENU},
+    {J_VK_NUM_LOCK,         VK_NUMLOCK},
+
+    // Miscellaneous Windows keys
+    {J_VK_WINDOWS,          VK_LWIN},
+    {J_VK_WINDOWS,          VK_RWIN},
+    {J_VK_CONTEXT_MENU,     VK_APPS},
+
+    // Alphabet
+    {J_VK_A,                'A'},
+    {J_VK_B,                'B'},
+    {J_VK_C,                'C'},
+    {J_VK_D,                'D'},
+    {J_VK_E,                'E'},
+    {J_VK_F,                'F'},
+    {J_VK_G,                'G'},
+    {J_VK_H,                'H'},
+    {J_VK_I,                'I'},
+    {J_VK_J,                'J'},
+    {J_VK_K,                'K'},
+    {J_VK_L,                'L'},
+    {J_VK_M,                'M'},
+    {J_VK_N,                'N'},
+    {J_VK_O,                'O'},
+    {J_VK_P,                'P'},
+    {J_VK_Q,                'Q'},
+    {J_VK_R,                'R'},
+    {J_VK_S,                'S'},
+    {J_VK_T,                'T'},
+    {J_VK_U,                'U'},
+    {J_VK_V,                'V'},
+    {J_VK_W,                'W'},
+    {J_VK_X,                'X'},
+    {J_VK_Y,                'Y'},
+    {J_VK_Z,                'Z'},
+    {J_VK_0,                '0'},
+    {J_VK_1,                '1'},
+    {J_VK_2,                '2'},
+    {J_VK_3,                '3'},
+    {J_VK_4,                '4'},
+    {J_VK_5,                '5'},
+    {J_VK_6,                '6'},
+    {J_VK_7,                '7'},
+    {J_VK_8,                '8'},
+    {J_VK_9,                '9'},
+    {J_VK_ENTER,            VK_RETURN},
+    {J_VK_SPACE,            VK_SPACE},
+    {J_VK_BACK_SPACE,       VK_BACK},
+    {J_VK_TAB,              VK_TAB},
+    {J_VK_ESCAPE,           VK_ESCAPE},
+    {J_VK_INSERT,           VK_INSERT},
+    {J_VK_DELETE,           VK_DELETE},
+    {J_VK_HOME,             VK_HOME},
+    {J_VK_END,              VK_END},
+    {J_VK_PAGE_UP,          VK_PRIOR},
+    {J_VK_PAGE_DOWN,        VK_NEXT},
+    {J_VK_CLEAR,            VK_CLEAR}, // NumPad 5
+
+    // NumPad with NumLock off & extended arrows block (triangular)
+    {J_VK_LEFT,             VK_LEFT},
+    {J_VK_RIGHT,            VK_RIGHT},
+    {J_VK_UP,               VK_UP},
+    {J_VK_DOWN,             VK_DOWN},
+
+    // NumPad with NumLock on: numbers
+    {J_VK_NUMPAD0,          VK_NUMPAD0},
+    {J_VK_NUMPAD1,          VK_NUMPAD1},
+    {J_VK_NUMPAD2,          VK_NUMPAD2},
+    {J_VK_NUMPAD3,          VK_NUMPAD3},
+    {J_VK_NUMPAD4,          VK_NUMPAD4},
+    {J_VK_NUMPAD5,          VK_NUMPAD5},
+    {J_VK_NUMPAD6,          VK_NUMPAD6},
+    {J_VK_NUMPAD7,          VK_NUMPAD7},
+    {J_VK_NUMPAD8,          VK_NUMPAD8},
+    {J_VK_NUMPAD9,          VK_NUMPAD9},
+
+    // NumPad with NumLock on
+    {J_VK_MULTIPLY,         VK_MULTIPLY},
+    {J_VK_ADD,              VK_ADD},
+    {J_VK_SEPARATOR,        VK_SEPARATOR},
+    {J_VK_SUBTRACT,         VK_SUBTRACT},
+    {J_VK_DECIMAL,          VK_DECIMAL},
+    {J_VK_DIVIDE,           VK_DIVIDE},
+
+    // Functional keys
+    {J_VK_F1,               VK_F1},
+    {J_VK_F2,               VK_F2},
+    {J_VK_F3,               VK_F3},
+    {J_VK_F4,               VK_F4},
+    {J_VK_F5,               VK_F5},
+    {J_VK_F6,               VK_F6},
+    {J_VK_F7,               VK_F7},
+    {J_VK_F8,               VK_F8},
+    {J_VK_F9,               VK_F9},
+    {J_VK_F10,              VK_F10},
+    {J_VK_F11,              VK_F11},
+    {J_VK_F12,              VK_F12},
+    {J_VK_F13,              VK_F13},
+    {J_VK_F14,              VK_F14},
+    {J_VK_F15,              VK_F15},
+    {J_VK_F16,              VK_F16},
+    {J_VK_F17,              VK_F17},
+    {J_VK_F18,              VK_F18},
+    {J_VK_F19,              VK_F19},
+    {J_VK_F20,              VK_F20},
+    {J_VK_F21,              VK_F21},
+    {J_VK_F22,              VK_F22},
+    {J_VK_F23,              VK_F23},
+    {J_VK_F24,              VK_F24},
+
+    {J_VK_PRINTSCREEN,      VK_SNAPSHOT},
+    {J_VK_SCROLL_LOCK,      VK_SCROLL},
+    {J_VK_PAUSE,            VK_PAUSE},
+    {J_VK_CANCEL,           VK_CANCEL},
+    {J_VK_HELP,             VK_HELP},
+
+    // Japanese
+/*
+    {J_VK_CONVERT,          VK_CONVERT},
+    {J_VK_NONCONVERT,       VK_NONCONVERT},
+    {J_VK_INPUT_METHOD_ON_OFF, VK_KANJI},
+    {J_VK_ALPHANUMERIC,     VK_DBE_ALPHANUMERIC},
+    {J_VK_KATAKANA,         VK_DBE_KATAKANA},
+    {J_VK_HIRAGANA,         VK_DBE_HIRAGANA},
+    {J_VK_FULL_WIDTH,       VK_DBE_DBCSCHAR},
+    {J_VK_HALF_WIDTH,       VK_DBE_SBCSCHAR},
+    {J_VK_ROMAN_CHARACTERS, VK_DBE_ROMAN},
+*/
+
+    {J_VK_UNDEFINED,        0}
+};
+
+/*
+Dynamic mapping table for OEM VK codes.  This table is refilled
+by BuildDynamicKeyMapTable when keyboard layout is switched.
+(see NT4 DDK src/input/inc/vkoem.h for OEM VK_ values).
+*/
+typedef struct {
+    // OEM VK codes known in advance
+    UINT windowsKey;
+    // depends on input langauge (kbd layout)
+    UINT javaKey;
+} DynamicKeyMapEntry;
+
+static DynamicKeyMapEntry dynamicKeyMapTable[] = {
+    {0x00BA,  J_VK_UNDEFINED}, // VK_OEM_1
+    {0x00BB,  J_VK_UNDEFINED}, // VK_OEM_PLUS
+    {0x00BC,  J_VK_UNDEFINED}, // VK_OEM_COMMA
+    {0x00BD,  J_VK_UNDEFINED}, // VK_OEM_MINUS
+    {0x00BE,  J_VK_UNDEFINED}, // VK_OEM_PERIOD
+    {0x00BF,  J_VK_UNDEFINED}, // VK_OEM_2
+    {0x00C0,  J_VK_UNDEFINED}, // VK_OEM_3
+    {0x00DB,  J_VK_UNDEFINED}, // VK_OEM_4
+    {0x00DC,  J_VK_UNDEFINED}, // VK_OEM_5
+    {0x00DD,  J_VK_UNDEFINED}, // VK_OEM_6
+    {0x00DE,  J_VK_UNDEFINED}, // VK_OEM_7
+    {0x00DF,  J_VK_UNDEFINED}, // VK_OEM_8
+    {0x00E2,  J_VK_UNDEFINED}, // VK_OEM_102
+    {0, 0}
+};
+
+// Auxiliary tables used to fill the above dynamic table.  We first
+// find the character for the OEM VK code using ::MapVirtualKey and
+// then go through these auxiliary tables to map it to Java VK code.
+
+typedef struct {
+    WCHAR c;
+    UINT  javaKey;
+} CharToVKEntry;
+
+static const CharToVKEntry charToVKTable[] = {
+    {L'!',   J_VK_EXCLAMATION_MARK},
+    {L'"',   J_VK_QUOTEDBL},
+    {L'#',   J_VK_NUMBER_SIGN},
+    {L'$',   J_VK_DOLLAR},
+    {L'&',   J_VK_AMPERSAND},
+    {L'\'',  J_VK_QUOTE},
+    {L'(',   J_VK_LEFT_PARENTHESIS},
+    {L')',   J_VK_RIGHT_PARENTHESIS},
+    {L'*',   J_VK_ASTERISK},
+    {L'+',   J_VK_PLUS},
+    {L',',   J_VK_COMMA},
+    {L'-',   J_VK_MINUS},
+    {L'.',   J_VK_PERIOD},
+    {L'/',   J_VK_SLASH},
+    {L':',   J_VK_COLON},
+    {L';',   J_VK_SEMICOLON},
+    {L'<',   J_VK_LESS},
+    {L'=',   J_VK_EQUALS},
+    {L'>',   J_VK_GREATER},
+    {L'@',   J_VK_AT},
+    {L'[',   J_VK_OPEN_BRACKET},
+    {L'\\',  J_VK_BACK_SLASH},
+    {L']',   J_VK_CLOSE_BRACKET},
+    {L'^',   J_VK_CIRCUMFLEX},
+    {L'_',   J_VK_UNDERSCORE},
+    {L'`',   J_VK_BACK_QUOTE},
+    {L'{',   J_VK_BRACELEFT},
+    {L'}',   J_VK_BRACERIGHT},
+    {0x00A1, J_VK_INVERTED_EXCLAMATION_MARK},
+    {0x20A0, J_VK_EURO_SIGN}, // ????
+    {0,0}
+};
+
+// For dead accents some layouts return ASCII punctuation, while some
+// return spacing accent chars, so both should be listed.  NB: MS docs
+// say that conversion routings return spacing accent character, not
+// combining.
+static const CharToVKEntry charToDeadVKTable[] = {
+    {L'`',   J_VK_DEAD_GRAVE},
+    {L'\'',  J_VK_DEAD_ACUTE},
+    {0x00B4, J_VK_DEAD_ACUTE},
+    {L'^',   J_VK_DEAD_CIRCUMFLEX},
+    {L'~',   J_VK_DEAD_TILDE},
+    {0x02DC, J_VK_DEAD_TILDE},
+    {0x00AF, J_VK_DEAD_MACRON},
+    {0x02D8, J_VK_DEAD_BREVE},
+    {0x02D9, J_VK_DEAD_ABOVEDOT},
+    {L'"',   J_VK_DEAD_DIAERESIS},
+    {0x00A8, J_VK_DEAD_DIAERESIS},
+    {0x02DA, J_VK_DEAD_ABOVERING},
+    {0x02DD, J_VK_DEAD_DOUBLEACUTE},
+    {0x02C7, J_VK_DEAD_CARON},            // aka hacek
+    {L',',   J_VK_DEAD_CEDILLA},
+    {0x00B8, J_VK_DEAD_CEDILLA},
+    {0x02DB, J_VK_DEAD_OGONEK},
+    {0x037A, J_VK_DEAD_IOTA},             // ASCII ???
+    {0x309B, J_VK_DEAD_VOICED_SOUND},
+    {0x309C, J_VK_DEAD_SEMIVOICED_SOUND},
+    {0,0}
+};
+
+// ANSI CP identifiers are no longer than this
+#define MAX_ACP_STR_LEN 7
+
+static void BuildDynamicKeyMapTable()
+{
+    HKL hkl = GetKeyboardLayout(0);
+    // Will need this to reset layout after dead keys.
+    UINT spaceScanCode = MapVirtualKeyEx(VK_SPACE, 0, hkl);
+    DynamicKeyMapEntry *dynamic;
+
+    LANGID idLang = LOWORD(GetKeyboardLayout(0));
+    UINT codePage;
+    TCHAR strCodePage[MAX_ACP_STR_LEN];
+    // use the LANGID to create a LCID
+    LCID idLocale = MAKELCID(idLang, SORT_DEFAULT);
+    // get the ANSI code page associated with this locale
+    if (GetLocaleInfo(idLocale, LOCALE_IDEFAULTANSICODEPAGE,
+	strCodePage, sizeof(strCodePage)/sizeof(TCHAR)) > 0 )
+    {
+        codePage = _ttoi(strCodePage);
+    } else {
+        codePage = GetACP();
+    }
+
+    // Entries in dynamic table that maps between Java VK and Windows
+    // VK are built in three steps:
+    //   1. Map windows VK to ANSI character (cannot map to unicode
+    //      directly, since ::ToUnicode is not implemented on win9x)
+    //   2. Convert ANSI char to Unicode char
+    //   3. Map Unicode char to Java VK via two auxilary tables.
+
+    for (dynamic = dynamicKeyMapTable; dynamic->windowsKey != 0; ++dynamic)
+    {
+        char cbuf[2] = { '\0', '\0'};
+        WCHAR ucbuf[2] = { L'\0', L'\0' };
+        int nchars;
+        UINT scancode;
+        const CharToVKEntry *charMap;
+        int nconverted;
+        WCHAR uc;
+        BYTE kbdState[256];
+
+        // Defaults to J_VK_UNDEFINED
+        dynamic->javaKey = J_VK_UNDEFINED;
+
+        GetKeyboardState(kbdState);
+
+        kbdState[dynamic->windowsKey] |=  0x80; // Press the key.
+
+        // Unpress modifiers, since they are most likely pressed as
+        // part of the keyboard switching shortcut.
+        kbdState[VK_CONTROL] &= ~0x80;
+        kbdState[VK_SHIFT]   &= ~0x80;
+        kbdState[VK_MENU]    &= ~0x80;
+
+        scancode = MapVirtualKeyEx(dynamic->windowsKey, 0, hkl);
+        nchars = ToAsciiEx(dynamic->windowsKey, scancode, kbdState,
+                                 (WORD*)cbuf, 0, hkl);
+
+        // Auxiliary table used to map Unicode character to Java VK.
+        // Will assign a different table for dead keys (below).
+        charMap = charToVKTable;
+
+        if (nchars < 0) { // Dead key
+            char junkbuf[2] = { '\0', '\0'};
+            // Use a different table for dead chars since different layouts
+            // return different characters for the same dead key.
+            charMap = charToDeadVKTable;
+
+            // We also need to reset layout so that next translation
+            // is unaffected by the dead status.  We do this by
+            // translating <SPACE> key.
+            kbdState[dynamic->windowsKey] &= ~0x80;
+            kbdState[VK_SPACE] |= 0x80;
+
+            ToAsciiEx(VK_SPACE, spaceScanCode, kbdState,
+                      (WORD*)junkbuf, 0, hkl);
+        }
+
+        nconverted = MultiByteToWideChar(codePage, 0,
+                                         cbuf, 1, ucbuf, 2);
+
+        uc = ucbuf[0];
+        {
+            const CharToVKEntry *map;
+            for (map = charMap;  map->c != 0;  ++map) {
+                if (uc == map->c) {
+                    dynamic->javaKey = map->javaKey;
+                    break;
+                }
+            }
+        }
+
+    } // for each VK_OEM_*
+}
+
 // Really need to factor this out in to a separate run-time file
 static jchar* GetNullTerminatedStringChars(JNIEnv* env, jstring str)
 {
@@ -130,6 +469,10 @@ static int WmChar(JNIEnv *env, jobject window, UINT character, UINT repCnt,
             return 1;
         }
     }
+
+    if (character == VK_RETURN) {
+        character = J_VK_ENTER;
+    }
     (*env)->CallVoidMethod(env, window, sendKeyEventID,
                            (jint) EVENT_KEY_TYPED,
                            GetModifiers(),
@@ -138,6 +481,87 @@ static int WmChar(JNIEnv *env, jobject window, UINT character, UINT repCnt,
     return 1;
 }
 
+UINT WindowsKeyToJavaKey(UINT windowsKey, UINT modifiers)
+{
+    int i, j;
+    // for the general case, use a bi-directional table
+    for (i = 0; keyMapTable[i].windowsKey != 0; i++) {
+        if (keyMapTable[i].windowsKey == windowsKey) {
+            return keyMapTable[i].javaKey;
+        }
+    }
+    for (j = 0; dynamicKeyMapTable[j].windowsKey != 0; j++) {
+        if (dynamicKeyMapTable[j].windowsKey == windowsKey) {
+            if (dynamicKeyMapTable[j].javaKey != J_VK_UNDEFINED) {
+                return dynamicKeyMapTable[j].javaKey;
+            } else {
+                break;
+            }
+        }
+    }
+
+    return J_VK_UNDEFINED;
+}
+
+static int WmKeyDown(JNIEnv *env, jobject window, UINT wkey, UINT repCnt,
+                     UINT flags, BOOL system)
+{
+    UINT modifiers = 0, jkey = 0, character = -1;
+    if (wkey == VK_PROCESSKEY) {
+        return 1;
+    }
+
+    modifiers = GetModifiers();
+    jkey = WindowsKeyToJavaKey(wkey, modifiers);
+
+/*
+    character = WindowsKeyToJavaChar(wkey, modifiers, SAVE);
+*/
+
+    (*env)->CallVoidMethod(env, window, sendKeyEventID,
+                           (jint) EVENT_KEY_PRESSED,
+                           modifiers,
+                           (jint) jkey,
+                           (jchar) character);
+
+    /* windows does not create a WM_CHAR for the Del key
+       for some reason, so we need to create the KEY_TYPED event on the
+       WM_KEYDOWN.
+     */
+    if (jkey == J_VK_DELETE) {
+        (*env)->CallVoidMethod(env, window, sendKeyEventID,
+                               (jint) EVENT_KEY_TYPED,
+                               GetModifiers(),
+                               (jint) -1,
+                               (jchar) '\177');
+    }
+
+    return 0;
+}
+
+static int WmKeyUp(JNIEnv *env, jobject window, UINT wkey, UINT repCnt,
+                   UINT flags, BOOL system)
+{
+    UINT modifiers = 0, jkey = 0, character = -1;
+    if (wkey == VK_PROCESSKEY) {
+        return 1;
+    }
+
+    modifiers = GetModifiers();
+    jkey = WindowsKeyToJavaKey(wkey, modifiers);
+/*
+    character = WindowsKeyToJavaChar(wkey, modifiers, SAVE);
+*/
+
+    (*env)->CallVoidMethod(env, window, sendKeyEventID,
+                           (jint) EVENT_KEY_RELEASED,
+                           modifiers,
+                           (jint) jkey,
+                           (jchar) character);
+
+    return 0;
+}
+
 static LRESULT CALLBACK wndProc(HWND wnd, UINT message,
                                 WPARAM wParam, LPARAM lParam)
 {
@@ -177,15 +601,13 @@ static LRESULT CALLBACK wndProc(HWND wnd, UINT message,
         break;
         
     case WM_KEYDOWN:
-        (*env)->CallVoidMethod(env, window, sendKeyEventID, (jint) EVENT_KEY_PRESSED,
-                               GetModifiers(), (jint) wParam, (jchar) -1);
-        useDefWindowProc = 1;
+        useDefWindowProc = WmKeyDown(env, window, wParam,
+                                     LOWORD(lParam), HIWORD(lParam), FALSE);
         break;
 
     case WM_KEYUP:
-        (*env)->CallVoidMethod(env, window, sendKeyEventID, (jint) EVENT_KEY_RELEASED,
-                               GetModifiers(), (jint) wParam, (jchar) -1);
-        useDefWindowProc = 1;
+        useDefWindowProc = WmKeyUp(env, window, wParam,
+                                   LOWORD(lParam), HIWORD(lParam), FALSE);
         break;
 
     case WM_SIZE:
@@ -331,6 +753,7 @@ JNIEXPORT jboolean JNICALL Java_com_sun_javafx_newt_windows_WindowsWindow_initID
         sendKeyEventID == NULL) {
         return JNI_FALSE;
     }
+    BuildDynamicKeyMapTable();
     return JNI_TRUE;
 }