From 261c92277b500b2f6d7f8c049c54ac3535de8f63 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Fri, 17 Apr 2020 18:26:49 +0000
Subject: Fix [585584ad66]: Aqua: event generate not working for function keys

---
 macosx/tkMacOSXKeyEvent.c | 121 +++++++++-------------------------------------
 macosx/tkMacOSXKeyboard.c | 107 +++++++++++++++++-----------------------
 2 files changed, 67 insertions(+), 161 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index f69a531..8d7f258 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -33,8 +33,6 @@ static int caret_x = 0, caret_y = 0, caret_height = 0;
 static TkWindow *caret_win = NULL;
 
 static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
-static unsigned	isFunctionKey(unsigned int code);
-
 
 #pragma mark TKApplication(TKKeyEvent)
 
@@ -52,8 +50,7 @@ static unsigned	isFunctionKey(unsigned int code);
 			    NSDeviceIndependentModifierFlagsMask);
     NSString *characters = nil;
     NSString *charactersIgnoringModifiers = nil;
-    NSUInteger len = 0;
-    int code = 0;
+    UniChar unichar = 0;
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray;
 
@@ -96,6 +93,20 @@ static unsigned	isFunctionKey(unsigned int code);
     BOOL has_modifiers = NO;
     XEvent xEvent;
 
+    if (type == NSKeyUp || type == NSKeyDown) {
+	characters = [theEvent characters];
+	unichar = [characters characterAtIndex:0];
+	charactersIgnoringModifiers = [theEvent charactersIgnoringModifiers];
+
+#if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
+	TKLog(@"-[%@(%p) %s] r=%d mods=%u '%@' '%@' keyCode=%u c=%d %@ %d",
+	      [self class], self, _cmd, (type == NSKeyDown) && [theEvent isARepeat],
+	      modifiers, characters, charactersIgnoringModifiers, keyCode,
+	      ([charactersIgnoringModifiers length] == 0) ? 0 :
+	      [charactersIgnoringModifiers characterAtIndex: 0], w, type);
+#endif
+    }
+    
     /*
      * Check whether this key event belongs to the caret window.
      */
@@ -128,18 +139,13 @@ static unsigned	isFunctionKey(unsigned int code);
 	    xEvent.xkey.keycode = (modifiers ^ savedModifiers);
 	    break;
 	case NSKeyUp:
-	    characters = [theEvent characters];
 	    xEvent.xany.type = KeyRelease;
-	    xEvent.xkey.keycode = (keyCode << 16) | (UInt16) [characters characterAtIndex:0];
+	    xEvent.xkey.keycode = (keyCode << 16) | unichar;
 	    break;
 	case NSKeyDown:
-	    characters = [theEvent characters];
-	    charactersIgnoringModifiers = [theEvent charactersIgnoringModifiers];
 	    xEvent.xany.type = KeyPress;
-	    xEvent.xkey.keycode = (keyCode << 16) | (UInt16) [characters characterAtIndex:0];
-	    len = [charactersIgnoringModifiers length];
-	    if (len > 0) {
-		code = [charactersIgnoringModifiers characterAtIndex:0];
+	    xEvent.xkey.keycode = (keyCode << 16) | unichar;
+	    if ([charactersIgnoringModifiers length] > 0) {
 		has_modifiers = xEvent.xkey.state &
 		    (ControlMask | Mod1Mask | Mod3Mask | Mod4Mask);
 	    }
@@ -148,15 +154,10 @@ static unsigned	isFunctionKey(unsigned int code);
 	    return theEvent; /* Unrecognized key event. */
 	}
 
-#if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
-	TKLog(@"-[%@(%p) %s] r=%d mods=%u '%@' '%@' code=%u c=%d %@ %d",
-	      [self class], self, _cmd, (type == NSKeyDown) && [theEvent isARepeat],
-	      modifiers, characters, charactersIgnoringModifiers, keyCode,
-	      ([charactersIgnoringModifiers length] == 0) ? 0 :
-	      [charactersIgnoringModifiers characterAtIndex: 0], w, type);
-#endif
-
-        if (type != NSKeyDown || !has_caret || isFunctionKey(code) || has_modifiers) {
+        if (type != NSKeyDown ||
+	    !has_caret        ||
+	    has_modifiers     ||
+	    ((keyCode >= 0xF700) && (keyCode <= 0xF8FF))) {
 	    if (type == NSKeyDown && [theEvent isARepeat]) {
 
 		/*
@@ -723,84 +724,6 @@ Tk_SetCaretPos(
     caret_height = height;
 }
 
-
-static unsigned convert_ns_to_X_keysym[] =
-{
-    NSHomeFunctionKey,		0x50,
-    NSLeftArrowFunctionKey,	0x51,
-    NSUpArrowFunctionKey,	0x52,
-    NSRightArrowFunctionKey,	0x53,
-    NSDownArrowFunctionKey,	0x54,
-    NSPageUpFunctionKey,	0x55,
-    NSPageDownFunctionKey,	0x56,
-    NSEndFunctionKey,		0x57,
-    NSBeginFunctionKey,		0x58,
-    NSSelectFunctionKey,	0x60,
-    NSPrintFunctionKey,		0x61,
-    NSExecuteFunctionKey,	0x62,
-    NSInsertFunctionKey,	0x63,
-    NSUndoFunctionKey,		0x65,
-    NSRedoFunctionKey,		0x66,
-    NSMenuFunctionKey,		0x67,
-    NSFindFunctionKey,		0x68,
-    NSHelpFunctionKey,		0x6A,
-    NSBreakFunctionKey,		0x6B,
-
-    NSF1FunctionKey,		0xBE,
-    NSF2FunctionKey,		0xBF,
-    NSF3FunctionKey,		0xC0,
-    NSF4FunctionKey,		0xC1,
-    NSF5FunctionKey,		0xC2,
-    NSF6FunctionKey,		0xC3,
-    NSF7FunctionKey,		0xC4,
-    NSF8FunctionKey,		0xC5,
-    NSF9FunctionKey,		0xC6,
-    NSF10FunctionKey,		0xC7,
-    NSF11FunctionKey,		0xC8,
-    NSF12FunctionKey,		0xC9,
-    NSF13FunctionKey,		0xCA,
-    NSF14FunctionKey,		0xCB,
-    NSF15FunctionKey,		0xCC,
-    NSF16FunctionKey,		0xCD,
-    NSF17FunctionKey,		0xCE,
-    NSF18FunctionKey,		0xCF,
-    NSF19FunctionKey,		0xD0,
-    NSF20FunctionKey,		0xD1,
-    NSF21FunctionKey,		0xD2,
-    NSF22FunctionKey,		0xD3,
-    NSF23FunctionKey,		0xD4,
-    NSF24FunctionKey,		0xD5,
-
-    NSBackspaceCharacter,	0x08,  /* 8: Not on some KBs. */
-    NSDeleteCharacter,		0xFF,  /* 127: Big 'delete' key upper right. */
-    NSDeleteFunctionKey,	0x9F,  /* 63272: Del forw key off main array. */
-
-    NSTabCharacter,		0x09,
-    0x19,			0x09,  /* left tab->regular since pass shift */
-    NSCarriageReturnCharacter,	0x0D,
-    NSNewlineCharacter,		0x0D,
-    NSEnterCharacter,		0x8D,
-
-    0x1B,			0x1B   /* escape */
-};
-
-
-static unsigned
-isFunctionKey(
-    unsigned code)
-{
-    const unsigned last_keysym = (sizeof(convert_ns_to_X_keysym)
-                                / sizeof(convert_ns_to_X_keysym[0]));
-    unsigned keysym;
-
-    for (keysym = 0; keysym < last_keysym; keysym += 2) {
-	if (code == convert_ns_to_X_keysym[keysym]) {
-	    return 0xFF00 | convert_ns_to_X_keysym[keysym + 1];
-	}
-    }
-    return 0;
-}
-
 /*
  * Local Variables:
  * mode: objc
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 60e67c8..961808c 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -23,7 +23,7 @@
 
 #define LATIN1_MAX	 255
 #define MAC_KEYCODE_MAX	 0x7F
-#define MAC_KEYCODE_MASK 0x7F
+#define MAC_KEYCODE_MASK 0xFF
 #define COMMAND_MASK	 Mod1Mask
 #define OPTION_MASK	 Mod2Mask
 
@@ -35,65 +35,49 @@
  */
 
 typedef struct {
-    int keycode;		/* Macintosh keycode. */
+    int keycode;		/* Macintosh keycode in NSEvent */
     KeySym keysym;		/* X windows keysym. */
 } KeyInfo;
 
-/*
- * Notes on keyArray:
- *
- * 0x34, XK_Return - Powerbooks use this and some keymaps define it.
- *
- * 0x4C, XK_Return - XFree86 and Apple's X11 call this one XK_KP_Enter.
- *
- * 0x47, XK_Clear - This key is NumLock when used on PCs, but Mac
- * applications don't use it like that, nor does Apple's X11.
- *
- * All other keycodes are taken from the published ADB keyboard layouts.
- */
 
 static KeyInfo keyArray[] = {
-    {0x24,	XK_Return},
-    {0x30,	XK_Tab},
-    {0x33,	XK_BackSpace},
-    {0x34,	XK_Return},
-    {0x35,	XK_Escape},
-
-    {0x47,	XK_Clear},
-    {0x4C,	XK_KP_Enter},
-
-    {0x72,	XK_Help},
-    {0x73,	XK_Home},
-    {0x74,	XK_Page_Up},
-    {0x75,	XK_Delete},
-    {0x77,	XK_End},
-    {0x79,	XK_Page_Down},
-
-    {0x7B,	XK_Left},
-    {0x7C,	XK_Right},
-    {0x7D,	XK_Down},
-    {0x7E,	XK_Up},
-
-    {0,		0}
-};
-
-static KeyInfo virtualkeyArray[] = {
-    {122,	XK_F1},
-    {120,	XK_F2},
-    {99,	XK_F3},
-    {118,	XK_F4},
+    {36,	XK_Return},
+    {48,	XK_Tab},
+    {51,	XK_BackSpace},
+    {52,	XK_Return},  /* Used on some powerbooks. */
+    {53,	XK_Escape},
+    {64,	XK_F17},
+    {71,	XK_Clear},   /* Numlock on PC */
+    {76,	XK_KP_Enter},
+    {79,	XK_F18},
+    {80,	XK_F19},
     {96,	XK_F5},
     {97,	XK_F6},
     {98,	XK_F7},
+    {99,	XK_F3},
     {100,	XK_F8},
     {101,	XK_F9},
-    {109,	XK_F10},
     {103,	XK_F11},
-    {111,	XK_F12},
     {105,	XK_F13},
+    {106,	XK_F16},
     {107,	XK_F14},
+    {109,	XK_F10},
+    {111,	XK_F12},
     {113,	XK_F15},
-    {0,		0}
+    {114,	XK_Help},
+    {115,	XK_Home},
+    {116,	XK_Page_Up},
+    {117,	XK_Delete},
+    {118,	XK_F4},
+    {119,	XK_End},
+    {120,	XK_F2},
+    {121,	XK_Page_Down},
+    {122,	XK_F1},
+    {123,	XK_Left},
+    {124,	XK_Right},
+    {125,	XK_Down},
+    {126,	XK_Up},
+    {0,		0},
 };
 
 #define NUM_MOD_KEYCODES 14
@@ -116,9 +100,6 @@ static KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
 
 static int initialized = 0;
 static Tcl_HashTable keycodeTable;	/* keyArray hashed by keycode value. */
-static Tcl_HashTable vkeyTable;		/* virtualkeyArray hashed by virtual
-					 * keycode value. */
-
 static int latin1Table[LATIN1_MAX+1];	/* Reverse mapping table for
 					 * controls, ASCII and Latin-1. */
 
@@ -182,12 +163,6 @@ InitKeyMaps(void)
 		&dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keysym));
     }
-    Tcl_InitHashTable(&vkeyTable, TCL_ONE_WORD_KEYS);
-    for (kPtr = virtualkeyArray; kPtr->keycode != 0; kPtr++) {
-	hPtr = Tcl_CreateHashEntry(&vkeyTable, INT2PTR(kPtr->keycode),
-		&dummy);
-	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keysym));
-    }
     initialized = 1;
 }
 
@@ -381,7 +356,7 @@ XKeycodeToKeysym(
     newKeycode = keycode >> 16;
 
     if ((keycode & 0xFFFF) >= 0xF700) { /* NSEvent.h function key unicodes */
-	hPtr = Tcl_FindHashEntry(&vkeyTable, INT2PTR(newKeycode));
+	hPtr = Tcl_FindHashEntry(&keycodeTable, INT2PTR(newKeycode));
 	if (hPtr != NULL) {
 	    return (KeySym) Tcl_GetHashValue(hPtr);
 	}
@@ -592,7 +567,8 @@ XKeysymToMacKeycode(
 	    return kPtr->keycode;
 	}
     }
-    for (kPtr = virtualkeyArray; kPtr->keycode != 0; kPtr++) {
+    /* Should do hash lookup. */
+    for (kPtr = keyArray; kPtr->keycode != 0; kPtr++) {
 	if (kPtr->keysym == keysym) {
 	    return kPtr->keycode;
 	}
@@ -646,13 +622,12 @@ XKeysymToKeycode(
     KeyCode result;
 
     /*
-     * See also TkpSetKeycodeAndState. The 0x0010 magic is used in
-     * XKeycodeToKeysym. For special keys like XK_Return the lower 8 bits of
-     * the keysym are usually a related ASCII control code.
+     * See also TkpSetKeycodeAndState.  For special keys like XK_Return the
+     * lower 8 bits of the keysym are usually a related ASCII control code.
      */
 
     if ((keysym >= XK_F1) && (keysym <= XK_F35)) {
-	result = 0x0010;
+	    result = 0xf704 + keysym - XK_F1;
     } else {
 	result = 0x00FF & keysym;
     }
@@ -705,8 +680,16 @@ TkpSetKeycodeAndState(
 	/*
 	 * See also XKeysymToKeycode.
 	 */
+
 	if ((keysym >= XK_F1) && (keysym <= XK_F35)) {
-	    eventPtr->xkey.keycode = 0x0010;
+
+	    /*
+	     * NSEvent.h defines the unicode values in the "Private Use" range
+	     * 0xF700-0xF8FF to correspond to function keys.  The first four
+	     * are arrow keys, followed by the Fn function keys in order.
+	     */
+
+	    eventPtr->xkey.keycode = 0xf704 + keysym - XK_F1;
 	} else {
 	    eventPtr->xkey.keycode = 0x00FF & keysym;
 	}
-- 
cgit v0.12


From d0ac480acbd80c95c07b982ca19b175690c4c5ff Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Sun, 19 Apr 2020 23:43:24 +0000
Subject: Another major overhaul: more code cleanup; make event generate work
 for Home, End, ...; distinguish left and right mod keys.

---
 macosx/tkMacOSXKeyEvent.c |  68 +++++---
 macosx/tkMacOSXKeyboard.c | 401 ++++++++++++++++++----------------------------
 2 files changed, 203 insertions(+), 266 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 8d7f258..100ac02 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -43,14 +43,14 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 #ifdef TK_MAC_DEBUG_EVENTS
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, theEvent);
 #endif
-    unsigned short keyCode = [theEvent keyCode];
+    unsigned int keyCode = [theEvent keyCode];
     NSWindow *w = [theEvent window];
     TkWindow *winPtr = TkMacOSXGetTkWindow(w);
     NSUInteger modifiers = ([theEvent modifierFlags] &
 			    NSDeviceIndependentModifierFlagsMask);
     NSString *characters = nil;
     NSString *charactersIgnoringModifiers = nil;
-    UniChar unichar = 0;
+    UniChar keychar = 0;
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray;
 
@@ -95,9 +95,9 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 
     if (type == NSKeyUp || type == NSKeyDown) {
 	characters = [theEvent characters];
-	unichar = [characters characterAtIndex:0];
+	keychar = [characters length] > 0 ? [characters characterAtIndex:0] : 0;
 	charactersIgnoringModifiers = [theEvent charactersIgnoringModifiers];
-
+	
 #if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
 	TKLog(@"-[%@(%p) %s] r=%d mods=%u '%@' '%@' keyCode=%u c=%d %@ %d",
 	      [self class], self, _cmd, (type == NSKeyDown) && [theEvent isARepeat],
@@ -105,50 +105,63 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 	      ([charactersIgnoringModifiers length] == 0) ? 0 :
 	      [charactersIgnoringModifiers characterAtIndex: 0], w, type);
 #endif
+
+    }
+    if (type == NSKeyDown) {
+	has_modifiers = xEvent.xkey.state &
+	    (ControlMask | Mod1Mask | Mod3Mask | Mod4Mask);
     }
-    
+
     /*
-     * Check whether this key event belongs to the caret window.
+     * Build the XEvent.
      */
 
     setupXEvent(&xEvent, tkwin, modifiers);
+
+    /*
+     * Check whether this key event belongs to the caret window.
+     */
+
     Bool has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret_win);
 
     /*
      * A KeyDown event received for the caret window which is not a function key
-     * and has no modifiers other than Shift or Alt will be processed with the
+     * and has no modifiers other than Shift or Option will be processed with the
      * TextInputClient protocol below.  All other key events are handled here
      * by queueing the XEvent created above.
      */
 
     if (!processingCompose || !has_caret) {
+	xEvent.xkey.keycode = (keyCode << 16) | keychar;
 	switch (type) {
 	case NSFlagsChanged:
-	    if (savedModifiers > modifiers) {
-		xEvent.xany.type = KeyRelease;
-	    } else {
-		xEvent.xany.type = KeyPress;
-	    }
 
 	    /*
-	     * The value -1 indicates a special keycode to the platform
-	     * specific code in tkMacOSXKeyboard.c.
+	     * If the highest bit where they differ was set then this is a press.
+	     */
+
+	    xEvent.xany.type = modifiers > savedModifiers ? KeyPress : KeyRelease;
+
+	    /*
+	     * The value -1 signals a modifier keycode to the function TkpGetKeySym
+	     * defined in tkMacOSXKeyboard.c.
 	     */
 
 	    xEvent.xany.send_event = -1;
-	    xEvent.xkey.keycode = (modifiers ^ savedModifiers);
+
+	    /*
+	     * Update savedModifiers for NSFlagsChanged events and no others,
+	     * since some non-modifier keys (e.g. function keys) have modifier
+	     * flags set
+	     */
+
+            savedModifiers = modifiers;
 	    break;
 	case NSKeyUp:
 	    xEvent.xany.type = KeyRelease;
-	    xEvent.xkey.keycode = (keyCode << 16) | unichar;
 	    break;
 	case NSKeyDown:
 	    xEvent.xany.type = KeyPress;
-	    xEvent.xkey.keycode = (keyCode << 16) | unichar;
-	    if ([charactersIgnoringModifiers length] > 0) {
-		has_modifiers = xEvent.xkey.state &
-		    (ControlMask | Mod1Mask | Mod3Mask | Mod4Mask);
-	    }
 	    break;
 	default:
 	    return theEvent; /* Unrecognized key event. */
@@ -157,7 +170,7 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
         if (type != NSKeyDown ||
 	    !has_caret        ||
 	    has_modifiers     ||
-	    ((keyCode >= 0xF700) && (keyCode <= 0xF8FF))) {
+	    ((keychar >= 0xF700) && (keychar <= 0xF8FF))) {
 	    if (type == NSKeyDown && [theEvent isARepeat]) {
 
 		/*
@@ -174,7 +187,6 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 	     */
 
             Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
-            savedModifiers = modifiers;
             return theEvent;
 	}
     }
@@ -185,7 +197,8 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
      * interpretKeyEvents.  But we only need to send KeyDown events.
      */
 
-    if (type == NSKeyDown) {
+    switch (type) {
+    case NSKeyDown:
 	if (NS_KEYLOG) {
 	    TKLog(@"keyDown: %s compose sequence.\n",
 		  processingCompose == YES ? "Continue" : "Begin");
@@ -212,8 +225,13 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 		break;
 	    }
 	}
+	break;
+    case NSFlagsChanged:
+	savedModifiers = modifiers;
+	break;
+    default:
+	break;
     }
-    savedModifiers = modifiers;
     return theEvent;
 }
 @end
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 961808c..c007cc9 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -29,57 +29,78 @@
 
 
 /*
- * Tables enumerating the special keys defined on Mac keyboards. These are
+ * Table enumerating the special keys defined on Mac keyboards. These are
  * necessary for correct keysym mappings for all keys where the keysyms are
  * not identical with their ASCII or Latin-1 code points.
+ *
+ * This table includes every key listed in Apple's documentation of Function-Key
+ * Unicodes which is not marked as "Not on most Macintosh keyboards".  I
+ * know of no reliable way to find the Apple "Virtual Keycode" for any of the
+ * keys that are so marked.
  */
 
 typedef struct {
-    int keycode;		/* Macintosh keycode in NSEvent */
-    KeySym keysym;		/* X windows keysym. */
+    int virtual;	       /* value of [NSEvent keyCode] */
+    KeySym keysym;	       /* X11 keysym */
+    KeyCode keychar;           /* XEvent keycode & 0xFFFF */
 } KeyInfo;
 
-
-static KeyInfo keyArray[] = {
-    {36,	XK_Return},
-    {48,	XK_Tab},
-    {51,	XK_BackSpace},
-    {52,	XK_Return},  /* Used on some powerbooks. */
-    {53,	XK_Escape},
-    {64,	XK_F17},
-    {71,	XK_Clear},   /* Numlock on PC */
-    {76,	XK_KP_Enter},
-    {79,	XK_F18},
-    {80,	XK_F19},
-    {96,	XK_F5},
-    {97,	XK_F6},
-    {98,	XK_F7},
-    {99,	XK_F3},
-    {100,	XK_F8},
-    {101,	XK_F9},
-    {103,	XK_F11},
-    {105,	XK_F13},
-    {106,	XK_F16},
-    {107,	XK_F14},
-    {109,	XK_F10},
-    {111,	XK_F12},
-    {113,	XK_F15},
-    {114,	XK_Help},
-    {115,	XK_Home},
-    {116,	XK_Page_Up},
-    {117,	XK_Delete},
-    {118,	XK_F4},
-    {119,	XK_End},
-    {120,	XK_F2},
-    {121,	XK_Page_Down},
-    {122,	XK_F1},
-    {123,	XK_Left},
-    {124,	XK_Right},
-    {125,	XK_Down},
-    {126,	XK_Up},
-    {0,		0},
+static const KeyInfo keyArray[] = {
+    {36,	XK_Return,	NSNewlineCharacter},
+    {48,	XK_Tab,		NSTabCharacter},
+    {51,	XK_BackSpace,	NSBackspaceCharacter},
+    {52,	XK_Return,	NSNewlineCharacter},  /* Used on some Powerbooks */
+    {53,	XK_Escape,	0x1B},
+    {54,	XK_Meta_R,      0},
+    {55,	XK_Meta_L,	0},
+    {56,	XK_Shift_L,	0},
+    {57,	XK_Caps_Lock,   0},
+    {58,	XK_Alt_L,	0},
+    {59,	XK_Control_L,	0},
+    {60,	XK_Shift_R, 	0},
+    {61,	XK_Alt_R,	0},
+    {62,	XK_Control_R,	0},
+    {63,	XK_Super_L,	0},
+    {64,	XK_F17,		NSF17FunctionKey},
+    {71,	XK_Clear,       NSClearLineFunctionKey}, /* Numlock on PC */
+    {76,	XK_KP_Enter,	NSEnterCharacter},       /* Fn Return */
+    {79,	XK_F18,		NSF18FunctionKey},
+    {80,	XK_F19,		NSF19FunctionKey},
+    {90,	XK_F20,		NSF20FunctionKey}, /* For scripting only */
+    {96,	XK_F5,		NSF5FunctionKey},
+    {97,	XK_F6,		NSF6FunctionKey},
+    {98,	XK_F7,		NSF7FunctionKey},
+    {99,	XK_F3,		NSF3FunctionKey},
+    {100,	XK_F8,		NSF8FunctionKey},
+    {101,	XK_F9,		NSF9FunctionKey},
+    {103,	XK_F11,		NSF11FunctionKey},
+    {105,	XK_F13,		NSF13FunctionKey},
+    {107,	XK_F14,		NSF14FunctionKey},
+    {109,	XK_F10,		NSF10FunctionKey},
+    {105,	XK_F13,		NSF13FunctionKey},
+    {106,	XK_F16,		NSF16FunctionKey},
+    {111,	XK_F12,		NSF12FunctionKey},
+    {113,	XK_F15,		NSF15FunctionKey},
+    {114,	XK_Help,	NSHelpFunctionKey},
+    {115,	XK_Home,	NSHomeFunctionKey},     /* Fn Left */
+    {116,	XK_Page_Up,	NSPageUpFunctionKey},   /* Fn Up */
+    {117,	XK_Delete,	NSDeleteFunctionKey},   /* Fn Deleete */
+    {118,	XK_F4,		NSF4FunctionKey},
+    {119,	XK_End,		NSEndFunctionKey},      /* Fn Right */
+    {120,	XK_F2,		NSF2FunctionKey},
+    {121,	XK_Page_Down,	NSPageDownFunctionKey}, /* Fn Down */
+    {122,	XK_F1,		NSF1FunctionKey},
+    {123,	XK_Left,	NSLeftArrowFunctionKey},
+    {124,	XK_Right,	NSRightArrowFunctionKey},
+    {125,	XK_Down,	NSDownArrowFunctionKey},
+    {126,	XK_Up,		NSUpArrowFunctionKey},
+    {0,		0, 		0}
 };
 
+/*
+ * X11 keysyms for modifier keys, in order.
+ */
+
 #define NUM_MOD_KEYCODES 14
 static KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
     XK_Shift_L,
@@ -99,11 +120,10 @@ static KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
 };
 
 static int initialized = 0;
-static Tcl_HashTable keycodeTable;	/* keyArray hashed by keycode value. */
-static int latin1Table[LATIN1_MAX+1];	/* Reverse mapping table for
-					 * controls, ASCII and Latin-1. */
-
 static int keyboardChanged = 1;
+static Tcl_HashTable virtual2keysym;	/* Maps Mac keyCode to X11 keysym. */
+static Tcl_HashTable keysym2keycode;	/* Maps X11 keysym to Mac keycode. */
+static int latin1Table[LATIN1_MAX+1];	/* Reverse mapping table for Latin-1. */
 
 /*
  * Prototypes for static functions used in this file.
@@ -111,7 +131,6 @@ static int keyboardChanged = 1;
 
 static void	InitKeyMaps (void);
 static void	InitLatin1Table(Display *display);
-static int	XKeysymToMacKeycode(Display *display, KeySym keysym);
 static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
 			UInt16 keyaction, UInt32 keycode, UInt32 modifiers,
 			UInt32 * deadKeyStatePtr);
@@ -137,10 +156,6 @@ static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
  *
  *	Creates hash tables used by some of the functions in this file.
  *
- *	FIXME: As keycodes are defined to be in the limited range 0-127, it
- *	would be easier and more efficient to use directly initialized plain
- *	arrays and drop this function.
- *
  * Results:
  *	None.
  *
@@ -154,14 +169,18 @@ static void
 InitKeyMaps(void)
 {
     Tcl_HashEntry *hPtr;
-    KeyInfo *kPtr;
+    const KeyInfo *kPtr;
     int dummy;
 
-    Tcl_InitHashTable(&keycodeTable, TCL_ONE_WORD_KEYS);
-    for (kPtr = keyArray; kPtr->keycode != 0; kPtr++) {
-	hPtr = Tcl_CreateHashEntry(&keycodeTable, INT2PTR(kPtr->keycode),
-		&dummy);
+    Tcl_InitHashTable(&virtual2keysym, TCL_ONE_WORD_KEYS);
+    Tcl_InitHashTable(&keysym2keycode, TCL_ONE_WORD_KEYS);
+    for (kPtr = keyArray; kPtr->virtual != 0; kPtr++) {
+	hPtr = Tcl_CreateHashEntry(&virtual2keysym, INT2PTR(kPtr->virtual),
+				   &dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keysym));
+	hPtr = Tcl_CreateHashEntry(&keysym2keycode, INT2PTR(kPtr->keysym),
+				   &dummy);
+	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keychar | (kPtr->virtual << 16)));
     }
     initialized = 1;
 }
@@ -171,10 +190,12 @@ InitKeyMaps(void)
  *
  * InitLatin1Table --
  *
- *	Creates a simple table to be used for mapping from keysyms to keycodes.
- *	Always needs to be called before using latin1Table, because the
- *	keyboard layout may have changed, and than the table must be
- *	re-computed.
+ *	Creates a simple table to be used for mapping from Latin-1 keysyms to
+ *      keycodes as used in XEvents.  Always needs to be called before using
+ *      latin1Table, because the keyboard layout may have changed, and then the
+ *      table must be re-computed.  The high order byte of these keycodes is
+ *      overwritten with the modifier flags, which can be used to set the state
+ *      of an XEvent that uses the keycode.
  *
  * Results:
  *	None.
@@ -219,9 +240,9 @@ InitLatin1Table(
 	}
 
 	for (keycode = 0; keycode <= MAC_KEYCODE_MAX; keycode++) {
-	    keysym = XKeycodeToKeysym(display,keycode<<16,state);
-	    if (keysym <= LATIN1_MAX) {
-		latin1Table[keysym] = keycode | modifiers;
+	    keysym = XKeycodeToKeysym(display, keycode<<16, state);
+	    if (keysym != NoSymbol && keysym <= LATIN1_MAX) {
+		latin1Table[keysym] = modifiers << 16 | keycode << 16 | keysym;
 	    }
 	}
     }
@@ -287,20 +308,18 @@ KeycodeToUnicode(
 
 	keycode &= 0xFF;
 	modifiers = (modifiers >> 8) & 0xFF;
-
 	if (!deadKeyStatePtr) {
 	    options = kUCKeyTranslateNoDeadKeysMask;
 	    dummyState = 0;
 	    deadKeyStatePtr = &dummyState;
 	}
-
 	err = ChkErr(UCKeyTranslate, uchr, keycode, keyaction, modifiers,
 		keyboardType, options, deadKeyStatePtr, maxChars,
 		&actuallength, uniChars);
-
 	if (!actuallength && *deadKeyStatePtr) {
+
 	    /*
-	     * More data later
+	     * We are waiting for another key.
 	     */
 
 	    return 0;
@@ -318,8 +337,8 @@ KeycodeToUnicode(
  *
  * XKeycodeToKeysym --
  *
- *	Translate from a system-dependent keycode to a system-independent
- *	keysym.
+ *	Translate from the system-dependent keycode used in an XEvent
+ *      to a system-independent X11 keysym.
  *
  * Results:
  *	Returns the translated keysym, or NoSymbol on failure.
@@ -334,11 +353,11 @@ KeySym
 XKeycodeToKeysym(
     Display* display,
     KeyCode keycode,
-    int index)
+    int state)
 {
     Tcl_HashEntry *hPtr;
-    int newKeycode;
-    UniChar newChar;
+    int virtual, modifiers = 0;
+    UniChar keyChar = 0;
 
     (void) display; /*unused*/
 
@@ -347,49 +366,32 @@ XKeycodeToKeysym(
     }
 
     /*
-     * When determining what keysym to produce we first check to see if the key
-     * is a function key. We then check to see if the character is another
-     * non-printing key. Finally, we return the key syms for all ASCII and
-     * Latin-1 chars.
+     * First check if the virtual keycode corresponds to a special key such as
+     * an Fn function key or Tab, Backspace, Home, End, etc.
      */
 
-    newKeycode = keycode >> 16;
-
-    if ((keycode & 0xFFFF) >= 0xF700) { /* NSEvent.h function key unicodes */
-	hPtr = Tcl_FindHashEntry(&keycodeTable, INT2PTR(newKeycode));
+    virtual = (keycode >> 16) & 0xFF;
+    if (virtual) {
+	hPtr = Tcl_FindHashEntry(&virtual2keysym, INT2PTR(virtual));
 	if (hPtr != NULL) {
 	    return (KeySym) Tcl_GetHashValue(hPtr);
 	}
     }
-    hPtr = Tcl_FindHashEntry(&keycodeTable, INT2PTR(newKeycode));
-    if (hPtr != NULL) {
-	return (KeySym) Tcl_GetHashValue(hPtr);
-    }
 
     /*
-     * Add in the Mac modifier flags for shift and option.
+     * No? Check if the key represents a Latin-1 letter.
      */
 
-    if (index & 1) {
-	newKeycode |= shiftKey;
-    }
-    if (index & 2) {
-	newKeycode |= optionKey;
+    modifiers = (state & 1 ? shiftKey : 0) | (state & 2 ? optionKey : 0);
+    KeycodeToUnicode(&keyChar, 1, kUCKeyActionDown, virtual, modifiers, NULL);
+    if ((keyChar >= XK_space) && (keyChar <= LATIN1_MAX)) {
+	return keyChar;
     }
 
-    newChar = 0;
-    KeycodeToUnicode(&newChar, 1, kUCKeyActionDown, newKeycode & 0x00FF,
-	    newKeycode & 0xFF00, NULL);
-
     /*
-     * X11 keysyms are identical to Unicode for ASCII and Latin-1. Give up for
-     * other characters for now.
+     * This keycode does not belong to a key on any known Macintosh keyboard.
      */
 
-    if ((newChar >= XK_space) && (newChar <= LATIN1_MAX)) {
-	return newChar;
-    }
-
     return NoSymbol;
 }
 
@@ -522,14 +524,23 @@ XStringToKeysym(
 /*
  *----------------------------------------------------------------------
  *
- * XKeysymToMacKeycode --
+ * XKeysymToKeycode --
  *
- *	An internal function like XKeysymToKeycode but only generating the Mac
- *	specific keycode plus the modifiers Shift and Option.
+ *	Converts an XKeysym to the value which would be used as the keycode
+ *      field of a KeyPress or KeyRelease XEvent for the corresponding key.
+ *      This is an opaque stub function which knows how the keycode field is
+ *      generated on a Mac.
  *
  * Results:
- *	A Mac keycode with the actual keycode in the low byte and Mac-style
- *	modifier bits in the high byte.
+ *
+ *      An X11 KeyCode with a unicode character in the low 16 bits and the
+ *	8-bit "virtual keycode" in the third byte.  (The virtual keycode is the
+ *	8-bit value that appears as [NSEvent keycode] in an NSKeyUp or
+ *	NSKeyDown event.)  On the Mac pressing a modifier key generates an
+ *	NSFlagsChanged event but not an NSKeyDown event.  If a keysym
+ *	represents a modifier key, the unicode character is 0, but the modifier
+ *	flags are set in the high order byte.  For keysyms that represent other
+ *	keys, the resulting keycode has no modifiers.
  *
  * Side effects:
  *	None.
@@ -537,13 +548,15 @@ XStringToKeysym(
  *----------------------------------------------------------------------
  */
 
-static int
-XKeysymToMacKeycode(
+KeyCode
+XKeysymToKeycode(
     Display *display,
     KeySym keysym)
 {
-    KeyInfo *kPtr;
+    Tcl_HashEntry *hPtr;
+
     if (keysym <= LATIN1_MAX) {
+
 	/*
 	 * Handle keysyms in the Latin-1 range where keysym and Unicode
 	 * character code point are the same.
@@ -557,37 +570,22 @@ XKeysymToMacKeycode(
     }
 
     /*
-     * Handle special keys from our exception tables. Don't mind if this is
-     * slow, neither the test suite nor [event generate] need to be optimized
-     * (we hope).
+     * This is not a Latin-1 key.  Try doing a hash table lookup to find the
+     * keycode.
      */
 
-    for (kPtr = keyArray; kPtr->keycode != 0; kPtr++) {
-	if (kPtr->keysym == keysym) {
-	    return kPtr->keycode;
-	}
-    }
-    /* Should do hash lookup. */
-    for (kPtr = keyArray; kPtr->keycode != 0; kPtr++) {
-	if (kPtr->keysym == keysym) {
-	    return kPtr->keycode;
-	}
+    if (!initialized) {
+	InitKeyMaps();
     }
 
-    /*
-     * Modifier keycodes only come from generated events.  No translation
-     * is needed.
-     */
-
-    for (int i=0; i < NUM_MOD_KEYCODES; i++) {
-	if (keysym == modKeyArray[i]) {
-	    return keysym;
-	}
+    hPtr = Tcl_FindHashEntry(&keysym2keycode, INT2PTR(keysym));
+    if (hPtr != NULL) {
+	return (KeyCode) Tcl_GetHashValue(hPtr);
     }
 
     /*
-     * For other keysyms (not Latin-1 and not special keys), we'd need a
-     * generic keysym-to-unicode table. We don't have that, so we give up here.
+     * The keysym is not Latin-1 and not in our hash table, so it does not
+     * appear on any known Macintosh keyboard; just return 0.
      */
 
     return 0;
@@ -596,68 +594,23 @@ XKeysymToMacKeycode(
 /*
  *----------------------------------------------------------------------
  *
- * XKeysymToKeycode --
- *
- *	The function XKeysymToKeycode takes an X11 keysym and converts it into
- *	a Mac keycode. It is in the stubs table for compatibility but not used
- *	anywhere in the core.
- *
- * Results:
- *	A 32 bit keycode with the the mac keycode (without modifiers) in the
- *	higher 16 bits of the keycode and the ASCII or Latin-1 code in the
- *	lower 8 bits of the keycode.
- *
- * Side effects:
- *	None.
- *
- *----------------------------------------------------------------------
- */
-
-KeyCode
-XKeysymToKeycode(
-    Display* display,
-    KeySym keysym)
-{
-    int macKeycode = XKeysymToMacKeycode(display, keysym);
-    KeyCode result;
-
-    /*
-     * See also TkpSetKeycodeAndState.  For special keys like XK_Return the
-     * lower 8 bits of the keysym are usually a related ASCII control code.
-     */
-
-    if ((keysym >= XK_F1) && (keysym <= XK_F35)) {
-	    result = 0xf704 + keysym - XK_F1;
-    } else {
-	result = 0x00FF & keysym;
-    }
-    result |= (macKeycode & MAC_KEYCODE_MASK) << 16;
-
-    return result;
-}
-
-/*
- *----------------------------------------------------------------------
- *
  * TkpSetKeycodeAndState --
  *
- *	The function TkpSetKeycodeAndState takes a keysym and fills in the
- *	appropriate members of an XEvent. It is similar to XKeysymToKeycode,
- *	but it also sets the modifier mask in the XEvent. It is used by [event
- *	generate] and it is in the stubs table.
+ *	This function accepts a keysym and an XEvent and sets some fields of
+ *	the XEvent.  It is used by the event generate command.
  *
  * Results:
- *	Fills an XEvent, sets the member xkey.keycode with a keycode
- *	formatted the same as XKeysymToKeycode and the member xkey.state with
- *	the modifiers implied by the keysym. Also fills in xkey.trans_chars,
- *	so that the actual characters can be retrieved later.
+ *      None
  *
  * Side effects:
- *	None.
+ *
+ *	Modifies the XEvent. Sets the xkey.keycode to a keycode value formatted
+ *	by XKeysymToKeycode and sets the shift and option flags in xkey.state
+ *	to the values implied by the keysym. Also fills in xkey.trans_chars, so
+ *	that the actual characters can be retrieved later.
  *
  *----------------------------------------------------------------------
  */
-
 void
 TkpSetKeycodeAndState(
     Tk_Window tkwin,
@@ -666,46 +619,19 @@ TkpSetKeycodeAndState(
 {
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
-    } else if ( modKeyArray[0] <= keysym &&
-		keysym <= modKeyArray[NUM_MOD_KEYCODES - 1]) {
-	/*
-	 * Keysyms for pure modifiers only arise in generated events.
-	 * We should just copy them to the keycode.
-	 */
-	eventPtr->xkey.keycode = keysym;
     } else {
 	Display *display = Tk_Display(tkwin);
-	int macKeycode = XKeysymToMacKeycode(display, keysym);
-
-	/*
-	 * See also XKeysymToKeycode.
-	 */
-
-	if ((keysym >= XK_F1) && (keysym <= XK_F35)) {
-
-	    /*
-	     * NSEvent.h defines the unicode values in the "Private Use" range
-	     * 0xF700-0xF8FF to correspond to function keys.  The first four
-	     * are arrow keys, followed by the Fn function keys in order.
-	     */
-
-	    eventPtr->xkey.keycode = 0xf704 + keysym - XK_F1;
-	} else {
-	    eventPtr->xkey.keycode = 0x00FF & keysym;
-	}
-	eventPtr->xkey.keycode |= (macKeycode & MAC_KEYCODE_MASK) << 16;
-
-	if (shiftKey & macKeycode) {
+	eventPtr->xkey.keycode = XKeysymToKeycode(display, keysym);
+	if ((shiftKey << 16) & eventPtr->xkey.keycode) {
 	    eventPtr->xkey.state |= ShiftMask;
 	}
-	if (optionKey & macKeycode) {
+	if ((optionKey << 16) & eventPtr->xkey.keycode) {
 	    eventPtr->xkey.state |= OPTION_MASK;
 	}
-
+	eventPtr->xkey.keycode &= 0xFFFFFF;
 	if (keysym <= LATIN1_MAX) {
-	    int done = TkUniCharToUtf(keysym, eventPtr->xkey.trans_chars);
-
-	    eventPtr->xkey.trans_chars[done] = 0;
+	    int length = TkUniCharToUtf(keysym, eventPtr->xkey.trans_chars);
+	    eventPtr->xkey.trans_chars[length] = 0;
 	} else {
 	    eventPtr->xkey.trans_chars[0] = 0;
 	}
@@ -718,7 +644,7 @@ TkpSetKeycodeAndState(
  * TkpGetKeySym --
  *
  *	Given an X KeyPress or KeyRelease event, map the keycode in the event
- *	into a keysym.
+ *	to a keysym.
  *
  * Results:
  *	The return value is the keysym corresponding to eventPtr, or NoSymbol
@@ -753,35 +679,28 @@ TkpGetKeySym(
      */
 
     if (eventPtr->xany.send_event == -1) {
-	int modifier = eventPtr->xkey.keycode & NSDeviceIndependentModifierFlagsMask;
-
-	if (modifier == NSCommandKeyMask) {
+	switch (eventPtr->xkey.keycode >> 16) {
+	case 54:
+	    return XK_Meta_R;
+	case 55:
 	    return XK_Meta_L;
-	} else if (modifier == NSShiftKeyMask) {
+	case 56:
 	    return XK_Shift_L;
-	} else if (modifier == NSAlphaShiftKeyMask) {
+	case 57:
 	    return XK_Caps_Lock;
-	} else if (modifier == NSAlternateKeyMask) {
+	case 58:
 	    return XK_Alt_L;
-	} else if (modifier == NSControlKeyMask) {
+	case 59:
 	    return XK_Control_L;
-	} else if (modifier == NSNumericPadKeyMask) {
-	    return XK_Num_Lock;
-	} else if (modifier == NSFunctionKeyMask) {
-	    return XK_Super_L;
-/*
-	} else if (modifier == rightShiftKey) {
+	case 60:
 	    return XK_Shift_R;
-	} else if (modifier == rightOptionKey) {
+	case 61:
 	    return XK_Alt_R;
-	} else if (modifier == rightControlKey) {
+	case 62:
 	    return XK_Control_R;
-*/
-	} else {
-	    /*
-	     * If we get here, we probably need to implement something new.
-	     */
-
+	case 63:
+	    return XK_Super_L;
+	default:
 	    return NoSymbol;
 	}
     }
@@ -921,7 +840,7 @@ TkpInitKeymapInfo(
     dispPtr->numModKeyCodes = NUM_MOD_KEYCODES;
     dispPtr->modKeyCodes = (KeyCode *)ckalloc(NUM_MOD_KEYCODES * sizeof(KeyCode));
     for (int i = 0; i < NUM_MOD_KEYCODES; i++) {
-	dispPtr->modKeyCodes[i] = modKeyArray[i];
+	dispPtr->modKeyCodes[i] = XKeysymToKeycode(NULL, modKeyArray[i]);
     }
 }
 
-- 
cgit v0.12


From 3fcc0bae6630b843931fdcf8636a4306a581739c Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Mon, 20 Apr 2020 17:14:40 +0000
Subject: Another rewrite of tkProcessKeyEvent to repair and clarify the logic
 of when to use the TextInputClient and when to send an XEvent.

---
 macosx/tkMacOSXKeyEvent.c | 214 +++++++++++++++++++++-------------------------
 macosx/tkMacOSXKeyboard.c |  13 ++-
 2 files changed, 102 insertions(+), 125 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 100ac02..ca6fe32 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -23,7 +23,7 @@
 #endif
 */
 #define NS_KEYLOG 0
-
+#define XEVENT_MOD_MASK (ControlMask | Mod1Mask | Mod3Mask | Mod4Mask)
 static Tk_Window keyboardGrabWinPtr = NULL; /* Current keyboard grab window. */
 static NSWindow *keyboardGrabNSWindow = nil; /* Its underlying NSWindow.*/
 static NSModalSession modalSession = nil;
@@ -43,21 +43,29 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 #ifdef TK_MAC_DEBUG_EVENTS
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, theEvent);
 #endif
-    unsigned int keyCode = [theEvent keyCode];
     NSWindow *w = [theEvent window];
     TkWindow *winPtr = TkMacOSXGetTkWindow(w);
+    Tk_Window tkwin = (Tk_Window) winPtr;
+    TkWindow *grabWinPtr = winPtr->dispPtr->grabWinPtr;
+    NSEventType type = [theEvent type];
+    NSUInteger keyCode = [theEvent keyCode];
     NSUInteger modifiers = ([theEvent modifierFlags] &
 			    NSDeviceIndependentModifierFlagsMask);
-    NSString *characters = nil;
-    NSString *charactersIgnoringModifiers = nil;
+    XEvent xEvent;
+    Bool has_modifiers = NO;
+    Bool has_caret = NO;
+    Bool use_text_input = NO;
     UniChar keychar = 0;
     static NSUInteger savedModifiers = 0;
-    static NSMutableArray *nsEvArray;
+    static NSMutableArray *nsEvArray = nil;
 
     if (nsEvArray == nil) {
         nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
         processingCompose = NO;
     }
+    if (!winPtr) {
+	return theEvent;
+    }
 
     /*
      * Control-Tab and Control-Shift-Tab are used to switch tabs in a tabbed
@@ -69,19 +77,13 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 	return theEvent;
     }
 
-    if (!winPtr) {
-	return theEvent;
-    }
-
     /*
      * If a local grab is in effect, key events for windows in the
      * grabber's application are redirected to the grabber.  Key events
-     * for other applications are delivered normally.  If a global
+     * for <other applications are delivered normally.  If a global
      * grab is in effect all key events are redirected to the grabber.
      */
 
-    Tk_Window tkwin = (Tk_Window) winPtr;
-    TkWindow *grabWinPtr = winPtr->dispPtr->grabWinPtr;
     if (grabWinPtr) {
 	if (winPtr->dispPtr->grabFlags ||  /* global grab */
 	    grabWinPtr->mainPtr == winPtr->mainPtr){ /* same application */
@@ -89,131 +91,65 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 	}
     }
 
-    NSEventType type = [theEvent type];
-    BOOL has_modifiers = NO;
-    XEvent xEvent;
+    /*
+     * Extract the unicode character from KeyUp and KeyDown events.
+     */
 
     if (type == NSKeyUp || type == NSKeyDown) {
-	characters = [theEvent characters];
-	keychar = [characters length] > 0 ? [characters characterAtIndex:0] : 0;
-	charactersIgnoringModifiers = [theEvent charactersIgnoringModifiers];
-	
+	if ([[theEvent characters] length] > 0) {
+	    keychar = [[theEvent characters] characterAtIndex:0];
+	} else {
+
+	    /*
+	     * This is a dead key, so it should go to the TextInputClient.
+	     */
+
+	    use_text_input = YES;
+	}
 #if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
-	TKLog(@"-[%@(%p) %s] r=%d mods=%u '%@' '%@' keyCode=%u c=%d %@ %d",
-	      [self class], self, _cmd, (type == NSKeyDown) && [theEvent isARepeat],
-	      modifiers, characters, charactersIgnoringModifiers, keyCode,
-	      ([charactersIgnoringModifiers length] == 0) ? 0 :
-	      [charactersIgnoringModifiers characterAtIndex: 0], w, type);
+	TKLog(@"-[%@(%p) %s] repeat=%d mods=%x char=%x code=%lu c=%d type=%d",
+	      [self class], self, _cmd,
+	      (type == NSKeyDown) && [theEvent isARepeat], modifiers, keychar,
+	      keyCode, w, type);
 #endif
-
-    }
-    if (type == NSKeyDown) {
-	has_modifiers = xEvent.xkey.state &
-	    (ControlMask | Mod1Mask | Mod3Mask | Mod4Mask);
     }
 
     /*
-     * Build the XEvent.
+     * Build a skeleton XEvent.  We need to build it here, even if we will not
+     * send it, so we can pass it to TkFocusKeyEvent to determine whether the
+     * target windows has the caret.
      */
 
     setupXEvent(&xEvent, tkwin, modifiers);
+    has_modifiers = xEvent.xkey.state & XEVENT_MOD_MASK;
+    has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret_win);
 
     /*
-     * Check whether this key event belongs to the caret window.
+     * A KeyDown event targetting the caret window and having alphanumeric
+     * keychar should be processed by our TextInputClient.  The XEvent will not
+     * be sent in this case.
      */
 
-    Bool has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret_win);
-
-    /*
-     * A KeyDown event received for the caret window which is not a function key
-     * and has no modifiers other than Shift or Option will be processed with the
-     * TextInputClient protocol below.  All other key events are handled here
-     * by queueing the XEvent created above.
-     */
-
-    if (!processingCompose || !has_caret) {
-	xEvent.xkey.keycode = (keyCode << 16) | keychar;
-	switch (type) {
-	case NSFlagsChanged:
-
-	    /*
-	     * If the highest bit where they differ was set then this is a press.
-	     */
-
-	    xEvent.xany.type = modifiers > savedModifiers ? KeyPress : KeyRelease;
-
-	    /*
-	     * The value -1 signals a modifier keycode to the function TkpGetKeySym
-	     * defined in tkMacOSXKeyboard.c.
-	     */
-
-	    xEvent.xany.send_event = -1;
-
-	    /*
-	     * Update savedModifiers for NSFlagsChanged events and no others,
-	     * since some non-modifier keys (e.g. function keys) have modifier
-	     * flags set
-	     */
-
-            savedModifiers = modifiers;
-	    break;
-	case NSKeyUp:
-	    xEvent.xany.type = KeyRelease;
-	    break;
-	case NSKeyDown:
-	    xEvent.xany.type = KeyPress;
-	    break;
-	default:
-	    return theEvent; /* Unrecognized key event. */
-	}
-
-        if (type != NSKeyDown ||
-	    !has_caret        ||
-	    has_modifiers     ||
-	    ((keychar >= 0xF700) && (keychar <= 0xF8FF))) {
-	    if (type == NSKeyDown && [theEvent isARepeat]) {
-
-		/*
-		 * Insert a KeyRelease XEvent before a repeated KeyPress.
-		 */
-
-		xEvent.xany.type = KeyRelease;
-		Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
-		xEvent.xany.type = KeyPress;
-            }
-
-	    /*
-	     * Queue the XEvent and return.
-	     */
-
-            Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
-            return theEvent;
-	}
+    if (type == NSKeyDown && has_caret && !has_modifiers &&
+	(keychar >= 0x0020) && (keychar <= 0x00FF)) {
+	use_text_input = YES;
     }
-
-    /*
-     * Either we are processing a composition or this is a normal KeyDown event
-     * for the caret window. Either way the event should be passed to
-     * interpretKeyEvents.  But we only need to send KeyDown events.
-     */
-
-    switch (type) {
-    case NSKeyDown:
-	if (NS_KEYLOG) {
-	    TKLog(@"keyDown: %s compose sequence.\n",
-		  processingCompose == YES ? "Continue" : "Begin");
-	}
+    if (use_text_input) {
+#if (NS_KEYLOG)
+	TKLog(@"keyDown: %s compose sequence.\n",
+	      processingCompose == YES ? "Continue" : "Begin");
+#endif
 
 	/*
-	 * Call the interpretKeyEvents method to handle the event as a
+	 * Call our interpretKeyEvents method to handle the event as a
 	 * TextInputClient.  When the composition sequence is complete, our
-	 * implementation of insertText: replacementRange will be called.  that
-	 * method generates a key down XEvent with the selected character.  In
+	 * implementation of insertText: replacementRange will be called.  That
+	 * method generates a keyPress XEvent with the selected character.  In
 	 * IME when multiple characters have the same composition sequence and
 	 * the selected character is not the default it may be necessary to hit
 	 * the Enter key multiple times before the character is accepted and
-	 * rendered. So we repeatedly send Enter key events until inputText has
-	 * cleared the processingCompose flag.
+	 * rendered. So we repeatedly send Enter key events until the inputText
+	 * method has cleared the processingCompose flag.
 	 */
 
 	processingCompose = YES;
@@ -225,13 +161,55 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 		break;
 	    }
 	}
-	break;
+	return theEvent;
+    }
+
+    /*
+     * We need to send an XEvent.  Finish constructing it.
+     */
+
+    xEvent.xkey.keycode = (keyCode << 16) | keychar;
+    switch (type) {
     case NSFlagsChanged:
+
+	/*
+	 * We simulate KeyPress and KeyRelease events whenever a modifier flag
+	 * change is reported.  To determine the type, note that the highest
+	 * bit where the flags differ is 1 if and only if it is a KeyPress.
+	 * Remember the modifiers for the next flag change.
+	 */
+
+	xEvent.xany.type = modifiers > savedModifiers ? KeyPress : KeyRelease;
 	savedModifiers = modifiers;
+
+	/*
+	 * The value -1 signals a modifier keycode to the function TkpGetKeySym
+	 * (see tkMacOSXKeyboard.c).
+	 */
+
+	xEvent.xany.send_event = -1;
 	break;
-    default:
+    case NSKeyUp:
+	xEvent.xany.type = KeyRelease;
 	break;
+    case NSKeyDown:
+	xEvent.xany.type = KeyPress;
+	break;
+    default:
+	return theEvent; /* Unrecognized key event. */
+    }
+
+    /*
+     * Finally we can queue an XEvent, inserting a KeyRelease before a
+     * repeated KeyPress.
+     */
+
+    if (type == NSKeyDown && [theEvent isARepeat]) {
+	xEvent.xany.type = KeyRelease;
+	Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
+	xEvent.xany.type = KeyPress;
     }
+    Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
     return theEvent;
 }
 @end
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index c007cc9..c4299cf 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -75,10 +75,9 @@ static const KeyInfo keyArray[] = {
     {101,	XK_F9,		NSF9FunctionKey},
     {103,	XK_F11,		NSF11FunctionKey},
     {105,	XK_F13,		NSF13FunctionKey},
+    {106,	XK_F16,		NSF16FunctionKey},
     {107,	XK_F14,		NSF14FunctionKey},
     {109,	XK_F10,		NSF10FunctionKey},
-    {105,	XK_F13,		NSF13FunctionKey},
-    {106,	XK_F16,		NSF16FunctionKey},
     {111,	XK_F12,		NSF12FunctionKey},
     {113,	XK_F15,		NSF15FunctionKey},
     {114,	XK_Help,	NSHelpFunctionKey},
@@ -102,7 +101,7 @@ static const KeyInfo keyArray[] = {
  */
 
 #define NUM_MOD_KEYCODES 14
-static KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
+static const KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
     XK_Shift_L,
     XK_Shift_R,
     XK_Control_L,
@@ -119,8 +118,8 @@ static KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
     XK_Hyper_R,
 };
 
-static int initialized = 0;
-static int keyboardChanged = 1;
+static BOOL initialized = NO;
+static BOOL keyboardChanged = YES;
 static Tcl_HashTable virtual2keysym;	/* Maps Mac keyCode to X11 keysym. */
 static Tcl_HashTable keysym2keycode;	/* Maps X11 keysym to Mac keycode. */
 static int latin1Table[LATIN1_MAX+1];	/* Reverse mapping table for Latin-1. */
@@ -143,7 +142,7 @@ static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
 #ifdef TK_MAC_DEBUG_NOTIFICATIONS
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, notification);
 #endif
-    keyboardChanged = 1;
+    keyboardChanged = YES;
 }
 @end
 
@@ -182,7 +181,7 @@ InitKeyMaps(void)
 				   &dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keychar | (kPtr->virtual << 16)));
     }
-    initialized = 1;
+    initialized = YES;
 }
 
 /*
-- 
cgit v0.12


From 3964e6aefdbae03b25d536bac0ae2ea275b6adbb Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Mon, 20 Apr 2020 19:18:01 +0000
Subject: Fix two typos and a bug -- thanks to Christopher Chavez.

---
 macosx/tkMacOSXKeyEvent.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index ca6fe32..6d468f7 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -44,9 +44,8 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, theEvent);
 #endif
     NSWindow *w = [theEvent window];
-    TkWindow *winPtr = TkMacOSXGetTkWindow(w);
+    TkWindow *winPtr = TkMacOSXGetTkWindow(w), *grabWinPtr;
     Tk_Window tkwin = (Tk_Window) winPtr;
-    TkWindow *grabWinPtr = winPtr->dispPtr->grabWinPtr;
     NSEventType type = [theEvent type];
     NSUInteger keyCode = [theEvent keyCode];
     NSUInteger modifiers = ([theEvent modifierFlags] &
@@ -80,10 +79,11 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     /*
      * If a local grab is in effect, key events for windows in the
      * grabber's application are redirected to the grabber.  Key events
-     * for <other applications are delivered normally.  If a global
+     * for other applications are delivered normally.  If a global
      * grab is in effect all key events are redirected to the grabber.
      */
 
+    grabWinPtr = winPtr->dispPtr->grabWinPtr;
     if (grabWinPtr) {
 	if (winPtr->dispPtr->grabFlags ||  /* global grab */
 	    grabWinPtr->mainPtr == winPtr->mainPtr){ /* same application */
@@ -125,7 +125,7 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret_win);
 
     /*
-     * A KeyDown event targetting the caret window and having alphanumeric
+     * A KeyDown event targeting the caret window and having alphanumeric
      * keychar should be processed by our TextInputClient.  The XEvent will not
      * be sent in this case.
      */
-- 
cgit v0.12


From e925338c5bc25742dbe0a932d8d3d9dcdc0f56a2 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Mon, 20 Apr 2020 21:06:00 +0000
Subject: Process Control-Tab normally; stop using an illegal value for
 send_event as a flag.

---
 macosx/tkMacOSXKeyEvent.c | 38 +++++++++++++++-----------------------
 macosx/tkMacOSXKeyboard.c | 10 ++++------
 2 files changed, 19 insertions(+), 29 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 6d468f7..2237f34 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -67,16 +67,6 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     }
 
     /*
-     * Control-Tab and Control-Shift-Tab are used to switch tabs in a tabbed
-     * window.  We do not want to generate an Xevent for these since that might
-     * cause the deselected tab to be reactivated.
-     */
-
-    if (keyCode == 48 && (modifiers & NSControlKeyMask) == NSControlKeyMask) {
-	return theEvent;
-    }
-
-    /*
      * If a local grab is in effect, key events for windows in the
      * grabber's application are redirected to the grabber.  Key events
      * for other applications are delivered normally.  If a global
@@ -101,7 +91,8 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 	} else {
 
 	    /*
-	     * This is a dead key, so it should go to the TextInputClient.
+	     * This is a dead key, such as Option-e, so it should go to the
+	     * TextInputClient.
 	     */
 
 	    use_text_input = YES;
@@ -117,7 +108,7 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     /*
      * Build a skeleton XEvent.  We need to build it here, even if we will not
      * send it, so we can pass it to TkFocusKeyEvent to determine whether the
-     * target windows has the caret.
+     * target window has the caret.
      */
 
     setupXEvent(&xEvent, tkwin, modifiers);
@@ -125,7 +116,7 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret_win);
 
     /*
-     * A KeyDown event targeting the caret window and having alphanumeric
+     * A KeyDown event targeting the caret window and having an alphanumeric
      * keychar should be processed by our TextInputClient.  The XEvent will not
      * be sent in this case.
      */
@@ -148,8 +139,9 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 	 * IME when multiple characters have the same composition sequence and
 	 * the selected character is not the default it may be necessary to hit
 	 * the Enter key multiple times before the character is accepted and
-	 * rendered. So we repeatedly send Enter key events until the inputText
-	 * method has cleared the processingCompose flag.
+	 * rendered (See ticket 39de9677aa]). So we repeatedly send Enter key
+	 * events until the inputText method has cleared the processingCompose
+	 * flag.
 	 */
 
 	processingCompose = YES;
@@ -173,21 +165,21 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     case NSFlagsChanged:
 
 	/*
-	 * We simulate KeyPress and KeyRelease events whenever a modifier flag
-	 * change is reported.  To determine the type, note that the highest
-	 * bit where the flags differ is 1 if and only if it is a KeyPress.
-	 * Remember the modifiers for the next flag change.
+	 * This XEvent is a simulated KeyPress or KeyRelease event for a
+	 * modifier key.  To determine the type, note that the highest bit
+	 * where the flags differ is 1 if and only if it is a KeyPress. The
+	 * modifiers are saved so we can detect the next flag change.
 	 */
 
 	xEvent.xany.type = modifiers > savedModifiers ? KeyPress : KeyRelease;
 	savedModifiers = modifiers;
 
 	/*
-	 * The value -1 signals a modifier keycode to the function TkpGetKeySym
-	 * (see tkMacOSXKeyboard.c).
+	 * Set the keychar to 0xF8FF, the largest value reserved for a function
+	 * key, as a signal to TkpGetKeySym (see tkMacOSXKeyboard.c) that this
+	 * is a modifier key event.
 	 */
-
-	xEvent.xany.send_event = -1;
+	xEvent.xkey.keycode |= 0xF8FF;
 	break;
     case NSKeyUp:
 	xEvent.xany.type = KeyRelease;
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index c4299cf..76dceb7 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -673,12 +673,10 @@ TkpGetKeySym(
     }
 
     /*
-     * Handle pure modifier keys specially. We use -1 as a signal for
-     * this.
+     * Modifier key events have a special mac keycode (see tkProcessKeyEvent).
      */
-
-    if (eventPtr->xany.send_event == -1) {
-	switch (eventPtr->xkey.keycode >> 16) {
+    if ((eventPtr->xkey.keycode & MAC_KEYCODE_MASK) == 0xF8FF) {
+	switch (eventPtr->xkey.keycode >> 16) { /* the virtual keyCode */
 	case 54:
 	    return XK_Meta_R;
 	case 55:
@@ -802,7 +800,7 @@ TkpInitKeymapInfo(
     dispPtr->bindInfoStale = 0;
 
     /*
-     * Behaviours that are variable on X11 are defined constant on MacOSX.
+     * Behaviors that are variable on X11 are defined constant on MacOSX.
      * lockUsage is only used above in TkpGetKeySym(), nowhere else currently.
      * There is no offical "Mode_switch" key.
      */
-- 
cgit v0.12


From bf2a61422685c1304d7ac9373cfe5ffeea1a4e64 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Tue, 21 Apr 2020 17:29:25 +0000
Subject: Send all chars up to 0x7F to the TextInputClient so non-Latin1
 keyboards work again.

---
 macosx/tkMacOSXKeyEvent.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 2237f34..3b213c5 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -122,7 +122,7 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
      */
 
     if (type == NSKeyDown && has_caret && !has_modifiers &&
-	(keychar >= 0x0020) && (keychar <= 0x00FF)) {
+	(keychar >= 0x0020) && (keychar <= 0xF700)) {
 	use_text_input = YES;
     }
     if (use_text_input) {
-- 
cgit v0.12


From 6435fba8f65521e30dc051e5eaaa59c84462db4a Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Tue, 21 Apr 2020 19:33:53 +0000
Subject: Make the structure of the latin1Table explicit

---
 macosx/tkMacOSXKeyboard.c | 83 ++++++++++++++++++++++++-----------------------
 1 file changed, 42 insertions(+), 41 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 76dceb7..c495d49 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -22,21 +22,22 @@
  */
 
 #define LATIN1_MAX	 255
-#define MAC_KEYCODE_MAX	 0x7F
+#define VIRTUAL_MAX	 0x7F
 #define MAC_KEYCODE_MASK 0xFF
 #define COMMAND_MASK	 Mod1Mask
 #define OPTION_MASK	 Mod2Mask
 
-
 /*
- * Table enumerating the special keys defined on Mac keyboards. These are
- * necessary for correct keysym mappings for all keys where the keysyms are
- * not identical with their ASCII or Latin-1 code points.
- *
- * This table includes every key listed in Apple's documentation of Function-Key
- * Unicodes which is not marked as "Not on most Macintosh keyboards".  I
- * know of no reliable way to find the Apple "Virtual Keycode" for any of the
- * keys that are so marked.
+ * This table enumerates the keys on Mac keyboards which do not represent
+ * letters.  This is static data -- these keys do not change when the keyboard
+ * layout changes.  The unicode representation of a special key which is not a
+ * modifier and does not have an ASCII code point lies in the reserved range
+ * 0xF700 - 0xF8FF.
+ *
+ * The table includes every key listed in Apple's documentation of Function-Key
+ * Unicodes which is not marked as "Not on most Macintosh keyboards", as well
+ * as F20, which is reported to be usable in scripts even though it does not
+ * appear on any Macintosh keyboard.
  */
 
 typedef struct {
@@ -118,18 +119,23 @@ static const KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
     XK_Hyper_R,
 };
 
-static BOOL initialized = NO;
-static BOOL keyboardChanged = YES;
+typedef struct {
+    KeyCode keycode;
+    int state;
+} Latin1KeyInfo;
+
+static Latin1KeyInfo latin1Table[LATIN1_MAX+1];	/* keysym to Latin1KeyInfo. */
 static Tcl_HashTable virtual2keysym;	/* Maps Mac keyCode to X11 keysym. */
 static Tcl_HashTable keysym2keycode;	/* Maps X11 keysym to Mac keycode. */
-static int latin1Table[LATIN1_MAX+1];	/* Reverse mapping table for Latin-1. */
+static BOOL initialized = NO;
+static BOOL keyboardChanged = YES;
 
 /*
  * Prototypes for static functions used in this file.
  */
 
 static void	InitKeyMaps (void);
-static void	InitLatin1Table(Display *display);
+static void	InitLatin1Table(void);
 static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
 			UInt16 keyaction, UInt32 keycode, UInt32 modifiers,
 			UInt32 * deadKeyStatePtr);
@@ -206,13 +212,11 @@ InitKeyMaps(void)
  */
 
 static void
-InitLatin1Table(
-    Display *display)
+InitLatin1Table(void)
 {
-    int keycode;
+    int virtual;
     KeySym keysym;
     int state;
-    int modifiers;
 
     memset(latin1Table, 0, sizeof(latin1Table));
 
@@ -230,18 +234,11 @@ InitLatin1Table(
      */
 
     for (state = 3; state >= 0; state--) {
-	modifiers = 0;
-	if (state & 1) {
-	    modifiers |= shiftKey;
-	}
-	if (state & 2) {
-	    modifiers |= optionKey;
-	}
-
-	for (keycode = 0; keycode <= MAC_KEYCODE_MAX; keycode++) {
-	    keysym = XKeycodeToKeysym(display, keycode<<16, state);
+	for (virtual = 0; virtual <= VIRTUAL_MAX; virtual++) {
+	    keysym = XKeycodeToKeysym(NULL, virtual<<16, state);
 	    if (keysym != NoSymbol && keysym <= LATIN1_MAX) {
-		latin1Table[keysym] = modifiers << 16 | keycode << 16 | keysym;
+		latin1Table[keysym].state = state;
+		latin1Table[keysym].keycode = virtual << 16 | keysym;
 	    }
 	}
     }
@@ -388,7 +385,11 @@ XKeycodeToKeysym(
     }
 
     /*
-     * This keycode does not belong to a key on any known Macintosh keyboard.
+     * Unfortunately we currently cannot generate keysyms for alphabetical keys
+     * whose unicode value is outside of Latin-1. This means that when such a
+     * letter key is pressed or released on, say, a Greek keyboard the XEvent
+     * that is sent will have its keysym field set to NoSymbol.  Also, it is not
+     * possible to generate events for these keys.
      */
 
     return NoSymbol;
@@ -562,10 +563,10 @@ XKeysymToKeycode(
 	 */
 
 	if (keyboardChanged) {
-	    InitLatin1Table(display);
+	    InitLatin1Table();
 	    keyboardChanged = 0;
 	}
-	return latin1Table[keysym];
+	return latin1Table[keysym].keycode;
     }
 
     /*
@@ -619,19 +620,19 @@ TkpSetKeycodeAndState(
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
     } else {
-	Display *display = Tk_Display(tkwin);
-	eventPtr->xkey.keycode = XKeysymToKeycode(display, keysym);
-	if ((shiftKey << 16) & eventPtr->xkey.keycode) {
-	    eventPtr->xkey.state |= ShiftMask;
-	}
-	if ((optionKey << 16) & eventPtr->xkey.keycode) {
-	    eventPtr->xkey.state |= OPTION_MASK;
-	}
-	eventPtr->xkey.keycode &= 0xFFFFFF;
 	if (keysym <= LATIN1_MAX) {
+	    if (keyboardChanged) {
+		InitLatin1Table();
+		keyboardChanged = 0;
+	    }
+	    Latin1KeyInfo info = latin1Table[keysym];
 	    int length = TkUniCharToUtf(keysym, eventPtr->xkey.trans_chars);
 	    eventPtr->xkey.trans_chars[length] = 0;
+	    eventPtr->xkey.keycode = info.keycode;
+	    eventPtr->xkey.state |= info.state;
 	} else {
+	    Display *display = Tk_Display(tkwin);
+	    eventPtr->xkey.keycode = XKeysymToKeycode(display, keysym);
 	    eventPtr->xkey.trans_chars[0] = 0;
 	}
     }
-- 
cgit v0.12


From f9ca46b9cf499b4a960aad013afc784d19a46ebf Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Thu, 23 Apr 2020 15:39:07 +0000
Subject: Rework the keysym handling so we can generate keysyms for non-Latin-1
 keys.  Also, edit comments and try to make names more accurate.

---
 macosx/tkMacOSXKeyboard.c |  383 ++++++--------
 macosx/tkMacOSXKeysyms.h  | 1286 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 1434 insertions(+), 235 deletions(-)
 create mode 100644 macosx/tkMacOSXKeysyms.h

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index c495d49..a2fdfd6 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -14,119 +14,53 @@
 #include "tkMacOSXPrivate.h"
 #include "tkMacOSXEvent.h"
 #include "tkMacOSXConstants.h"
+#include "tkMacOSXKeysyms.h"
+
 /*
- * A couple of simple definitions to make code a bit more self-explaining.
- *
- * For the assignments of Mod1==meta==command and Mod2==alt==option, see also
- * tkMacOSXMouseEvent.c.
+ * When converting native key events to X11 key events, each platform is
+ * allowed to choose what information to encode in the XEvent.xkey.keycode
+ * field.  On the Macintosh, every non-modifier key has a unicode character
+ * associated to it.  For non-text keys this unicode character is in the
+ * private use range 0xF700 - 0xF8FF.  Modifier keys, however, do not produce
+ * KeyDown or KeyUp events, rather FlagsChanged events, so they do not have an
+ * associated unicode character.
+ *
+ * When constructing an XEvent from a KeyDown or KeyUo NSEvent, the
+ * XEvent.xkey.keycode field is constructed by using bits 0-15 to hold the
+ * first unicode character of the [NSEvent characters] attribute of the
+ * NSEvent, and bits 16-23 to hold the value of the [NSEvent keyCode]
+ * attribute.  The keyCode attribute identifies a location on the keyboard,
+ * and Apple calls it a "virtual keycode". It is allowed for the characters
+ * attribute to have length greater than 1, but that does not appear to happen
+ * for any known keyboards.
+ *
+ * When generating an XEvent with the event generate command, the unicode
+ * character is determined from the X11 keysym and, if that unicode character
+ * belongs to a key on the current keyboard layout bits 16-23 are set to the
+ * virtual keycode of that key.  Otherwise they are cleared.
+ *
+ * KeyPress or KeyRelease XEvents are also constructed when a FlagsChanged
+ * NSEvent is processed.  For these, the unicode character is set to 0xF8FF,
+ * the last value of the private use range.
  */
 
-#define LATIN1_MAX	 255
 #define VIRTUAL_MAX	 0x7F
 #define MAC_KEYCODE_MASK 0xFF
-#define COMMAND_MASK	 Mod1Mask
-#define OPTION_MASK	 Mod2Mask
 
 /*
- * This table enumerates the keys on Mac keyboards which do not represent
- * letters.  This is static data -- these keys do not change when the keyboard
- * layout changes.  The unicode representation of a special key which is not a
- * modifier and does not have an ASCII code point lies in the reserved range
- * 0xF700 - 0xF8FF.
- *
- * The table includes every key listed in Apple's documentation of Function-Key
- * Unicodes which is not marked as "Not on most Macintosh keyboards", as well
- * as F20, which is reported to be usable in scripts even though it does not
- * appear on any Macintosh keyboard.
+ * Hash tables used to translate between various key attributes.
  */
 
-typedef struct {
-    int virtual;	       /* value of [NSEvent keyCode] */
-    KeySym keysym;	       /* X11 keysym */
-    KeyCode keychar;           /* XEvent keycode & 0xFFFF */
-} KeyInfo;
-
-static const KeyInfo keyArray[] = {
-    {36,	XK_Return,	NSNewlineCharacter},
-    {48,	XK_Tab,		NSTabCharacter},
-    {51,	XK_BackSpace,	NSBackspaceCharacter},
-    {52,	XK_Return,	NSNewlineCharacter},  /* Used on some Powerbooks */
-    {53,	XK_Escape,	0x1B},
-    {54,	XK_Meta_R,      0},
-    {55,	XK_Meta_L,	0},
-    {56,	XK_Shift_L,	0},
-    {57,	XK_Caps_Lock,   0},
-    {58,	XK_Alt_L,	0},
-    {59,	XK_Control_L,	0},
-    {60,	XK_Shift_R, 	0},
-    {61,	XK_Alt_R,	0},
-    {62,	XK_Control_R,	0},
-    {63,	XK_Super_L,	0},
-    {64,	XK_F17,		NSF17FunctionKey},
-    {71,	XK_Clear,       NSClearLineFunctionKey}, /* Numlock on PC */
-    {76,	XK_KP_Enter,	NSEnterCharacter},       /* Fn Return */
-    {79,	XK_F18,		NSF18FunctionKey},
-    {80,	XK_F19,		NSF19FunctionKey},
-    {90,	XK_F20,		NSF20FunctionKey}, /* For scripting only */
-    {96,	XK_F5,		NSF5FunctionKey},
-    {97,	XK_F6,		NSF6FunctionKey},
-    {98,	XK_F7,		NSF7FunctionKey},
-    {99,	XK_F3,		NSF3FunctionKey},
-    {100,	XK_F8,		NSF8FunctionKey},
-    {101,	XK_F9,		NSF9FunctionKey},
-    {103,	XK_F11,		NSF11FunctionKey},
-    {105,	XK_F13,		NSF13FunctionKey},
-    {106,	XK_F16,		NSF16FunctionKey},
-    {107,	XK_F14,		NSF14FunctionKey},
-    {109,	XK_F10,		NSF10FunctionKey},
-    {111,	XK_F12,		NSF12FunctionKey},
-    {113,	XK_F15,		NSF15FunctionKey},
-    {114,	XK_Help,	NSHelpFunctionKey},
-    {115,	XK_Home,	NSHomeFunctionKey},     /* Fn Left */
-    {116,	XK_Page_Up,	NSPageUpFunctionKey},   /* Fn Up */
-    {117,	XK_Delete,	NSDeleteFunctionKey},   /* Fn Deleete */
-    {118,	XK_F4,		NSF4FunctionKey},
-    {119,	XK_End,		NSEndFunctionKey},      /* Fn Right */
-    {120,	XK_F2,		NSF2FunctionKey},
-    {121,	XK_Page_Down,	NSPageDownFunctionKey}, /* Fn Down */
-    {122,	XK_F1,		NSF1FunctionKey},
-    {123,	XK_Left,	NSLeftArrowFunctionKey},
-    {124,	XK_Right,	NSRightArrowFunctionKey},
-    {125,	XK_Down,	NSDownArrowFunctionKey},
-    {126,	XK_Up,		NSUpArrowFunctionKey},
-    {0,		0, 		0}
-};
+static Tcl_HashTable virtual2keysym;	/* Special virtual keycode to keysym */
+static Tcl_HashTable keysym2keycode;	/* keysym to XEvent keycode */
+static Tcl_HashTable keysym2unichar;	/* keysym to unichar */
+static Tcl_HashTable unichar2keysym;	/* unichar to X11 keysym */
+static Tcl_HashTable unichar2virtual;	/* unichar to virtual keycode */
 
 /*
- * X11 keysyms for modifier keys, in order.
+ * Flags.
  */
 
-#define NUM_MOD_KEYCODES 14
-static const KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
-    XK_Shift_L,
-    XK_Shift_R,
-    XK_Control_L,
-    XK_Control_R,
-    XK_Caps_Lock,
-    XK_Shift_Lock,
-    XK_Meta_L,
-    XK_Meta_R,
-    XK_Alt_L,
-    XK_Alt_R,
-    XK_Super_L,
-    XK_Super_R,
-    XK_Hyper_L,
-    XK_Hyper_R,
-};
-
-typedef struct {
-    KeyCode keycode;
-    int state;
-} Latin1KeyInfo;
-
-static Latin1KeyInfo latin1Table[LATIN1_MAX+1];	/* keysym to Latin1KeyInfo. */
-static Tcl_HashTable virtual2keysym;	/* Maps Mac keyCode to X11 keysym. */
-static Tcl_HashTable keysym2keycode;	/* Maps X11 keysym to Mac keycode. */
 static BOOL initialized = NO;
 static BOOL keyboardChanged = YES;
 
@@ -134,9 +68,9 @@ static BOOL keyboardChanged = YES;
  * Prototypes for static functions used in this file.
  */
 
-static void	InitKeyMaps (void);
-static void	InitLatin1Table(void);
-static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
+static void	InitHashTables(void);
+static void     UpdateKeymap(void);
+static int	KeyDataToUnicode(UniChar * uniChars, int maxChars,
 			UInt16 keyaction, UInt32 keycode, UInt32 modifiers,
 			UInt32 * deadKeyStatePtr);
 
@@ -149,6 +83,7 @@ static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, notification);
 #endif
     keyboardChanged = YES;
+    UpdateKeymap();
 }
 @end
 
@@ -157,7 +92,7 @@ static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
 /*
  *----------------------------------------------------------------------
  *
- * InitKeyMaps --
+ * InitHashTables --
  *
  *	Creates hash tables used by some of the functions in this file.
  *
@@ -171,10 +106,11 @@ static int	KeycodeToUnicode(UniChar * uniChars, int maxChars,
  */
 
 static void
-InitKeyMaps(void)
+InitHashTables(void)
 {
     Tcl_HashEntry *hPtr;
     const KeyInfo *kPtr;
+    const KeysymInfo *ksPtr;
     int dummy;
 
     Tcl_InitHashTable(&virtual2keysym, TCL_ONE_WORD_KEYS);
@@ -187,70 +123,70 @@ InitKeyMaps(void)
 				   &dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keychar | (kPtr->virtual << 16)));
     }
+    Tcl_InitHashTable(&keysym2unichar, TCL_ONE_WORD_KEYS);
+    Tcl_InitHashTable(&unichar2keysym, TCL_ONE_WORD_KEYS);
+    for (ksPtr = keysymTable; ksPtr->keysym != 0; ksPtr++) {
+	hPtr = Tcl_CreateHashEntry(&keysym2unichar, INT2PTR(ksPtr->keysym),
+				   &dummy);
+	Tcl_SetHashValue(hPtr, INT2PTR(ksPtr->keycode));
+	hPtr = Tcl_CreateHashEntry(&unichar2keysym, INT2PTR(ksPtr->keycode),
+				   &dummy);
+	Tcl_SetHashValue(hPtr, INT2PTR(ksPtr->keysym));
+    }
+    UpdateKeymap();
     initialized = YES;
 }
 
 /*
  *----------------------------------------------------------------------
  *
- * InitLatin1Table --
+ * UpdateKeymap --
  *
- *	Creates a simple table to be used for mapping from Latin-1 keysyms to
- *      keycodes as used in XEvents.  Always needs to be called before using
- *      latin1Table, because the keyboard layout may have changed, and then the
- *      table must be re-computed.  The high order byte of these keycodes is
- *      overwritten with the modifier flags, which can be used to set the state
- *      of an XEvent that uses the keycode.
+ *	Called when the keyboard changes to update the hash table that
+ *      maps unicode characters to virtual keycodes.
  *
  * Results:
  *	None.
  *
  * Side effects:
- *	Sets the global latin1Table.
+ *	Initializes, if necessary, and updates the unichar2virtual table.
  *
  *----------------------------------------------------------------------
  */
 
 static void
-InitLatin1Table(void)
+UpdateKeymap()
 {
-    int virtual;
-    KeySym keysym;
-    int state;
-
-    memset(latin1Table, 0, sizeof(latin1Table));
-
-    /*
-     * In the common X11 implementations, a keymap has four columns
-     * "plain", "Shift", "Mode_switch" and "Mode_switch + Shift". We don't
-     * use "Mode_switch", but we use "Option" instead. (This is similar to
-     * Apple's X11 implementation, where "Mode_switch" is used as an alias
-     * for "Option".)
-     *
-     * So here we go through all 4 columns of the keymap and find all
-     * Latin-1 compatible keycodes. We go through the columns back-to-front
-     * from the more exotic columns to the more simple, so that simple
-     * keycode-modifier combinations are preferred in the resulting table.
-     */
+    static int keymapInitialized = 0;
+    UniChar keyChar = 0;
+    Tcl_HashEntry *hPtr;
+    int virtual, state, modifiers, dummy;
 
+    if (!keymapInitialized) {
+	Tcl_InitHashTable(&unichar2virtual, TCL_ONE_WORD_KEYS);
+    } else {
+	Tcl_DeleteHashTable(&unichar2virtual);
+    }
     for (state = 3; state >= 0; state--) {
 	for (virtual = 0; virtual <= VIRTUAL_MAX; virtual++) {
-	    keysym = XKeycodeToKeysym(NULL, virtual<<16, state);
-	    if (keysym != NoSymbol && keysym <= LATIN1_MAX) {
-		latin1Table[keysym].state = state;
-		latin1Table[keysym].keycode = virtual << 16 | keysym;
-	    }
+	    modifiers = (state & 1 ? shiftKey : 0) | (state & 2 ? optionKey : 0);
+	    KeyDataToUnicode(&keyChar, 1, kUCKeyActionDown, virtual, modifiers, NULL);
+	    hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keyChar),
+				       &dummy);
+	    Tcl_SetHashValue(hPtr, INT2PTR(state << 8 | virtual));
 	}
     }
 }
+
 
 /*
  *----------------------------------------------------------------------
  *
- * KeycodeToUnicode --
+ * KeyDataToUnicode --
  *
- *	Given MacOS key event data this function generates the Unicode
- *	characters. It does this using OS resources and APIs.
+ *	Given MacOS key event data this function generates the unicode
+ *	characters. It does this using OS resources from the Carbon
+ *      framework.
  *
  *	The parameter deadKeyStatePtr can be NULL, if no deadkey handling is
  *	needed.
@@ -269,7 +205,7 @@ InitLatin1Table(void)
  */
 
 static int
-KeycodeToUnicode(
+KeyDataToUnicode(
     UniChar *uniChars,
     int maxChars,
     UInt16 keyaction,
@@ -302,7 +238,7 @@ KeycodeToUnicode(
 	UInt32 dummyState;
 	OSStatus err;
 
-	keycode &= 0xFF;
+	keycode &= 0xFFFF;
 	modifiers = (modifiers >> 8) & 0xFF;
 	if (!deadKeyStatePtr) {
 	    options = kUCKeyTranslateNoDeadKeysMask;
@@ -333,11 +269,13 @@ KeycodeToUnicode(
  *
  * XKeycodeToKeysym --
  *
- *	Translate from the system-dependent keycode used in an XEvent
- *      to a system-independent X11 keysym.
+ *	Stub function which translate from the platform-specific keycode used
+ *      in an XEvent to an X11 keysym.  On the Macintosh, the display input
+ *      is ignored and only the virtual keycode in bits 16-23 is used.
  *
  * Results:
- *	Returns the translated keysym, or NoSymbol on failure.
+ *      Returns the corresponding keysym, or NoSymbol if the keysym cannot
+ *	be found.
  *
  * Side effects:
  *	None.
@@ -358,11 +296,11 @@ XKeycodeToKeysym(
     (void) display; /*unused*/
 
     if (!initialized) {
-	InitKeyMaps();
+	InitHashTables();
     }
 
     /*
-     * First check if the virtual keycode corresponds to a special key such as
+     * First check if the virtual keycode corresponds to a special key, such as
      * an Fn function key or Tab, Backspace, Home, End, etc.
      */
 
@@ -375,23 +313,16 @@ XKeycodeToKeysym(
     }
 
     /*
-     * No? Check if the key represents a Latin-1 letter.
+     * If not, use Carbon to find the unicode character and translate it
+     * to a keysym using a hash table.
      */
 
     modifiers = (state & 1 ? shiftKey : 0) | (state & 2 ? optionKey : 0);
-    KeycodeToUnicode(&keyChar, 1, kUCKeyActionDown, virtual, modifiers, NULL);
-    if ((keyChar >= XK_space) && (keyChar <= LATIN1_MAX)) {
-	return keyChar;
+    KeyDataToUnicode(&keyChar, 1, kUCKeyActionDown, virtual, modifiers, NULL);
+    hPtr = Tcl_FindHashEntry(&unichar2keysym, INT2PTR(keyChar));
+    if (hPtr != NULL) {
+	return (KeySym) Tcl_GetHashValue(hPtr);
     }
-
-    /*
-     * Unfortunately we currently cannot generate keysyms for alphabetical keys
-     * whose unicode value is outside of Latin-1. This means that when such a
-     * letter key is pressed or released on, say, a Greek keyboard the XEvent
-     * that is sent will have its keysym field set to NoSymbol.  Also, it is not
-     * possible to generate events for these keys.
-     */
-
     return NoSymbol;
 }
 
@@ -400,10 +331,11 @@ XKeycodeToKeysym(
  *
  * TkpGetString --
  *
- *	Retrieve the string equivalent for the given keyboard event.
+ *	Retrieve the string stored in the transchars field of an XEvent
+ *      and convert it to a DString.
  *
  * Results:
- *	Returns the UTF string.
+ *	Returns the DString.
  *
  * Side effects:
  *	None.
@@ -452,9 +384,10 @@ XGetModifierMapping(
     (void) display; /*unused*/
 
     /*
-     * MacOSX doesn't use the key codes for the modifiers for anything, and we
+     * MacOS doesn't use the key codes for the modifiers for anything, and we
      * don't generate them either. So there is no modifier map.
      */
+
     modmap = ckalloc(sizeof(XModifierKeymap));
     modmap->max_keypermod = 0;
     modmap->modifiermap = NULL;
@@ -494,9 +427,8 @@ XFreeModifiermap(
  * XKeysymToString, XStringToKeysym --
  *
  *	These X window functions map keysyms to strings & strings to keysyms.
- *	However, Tk already does this for the most common keysyms. Therefore,
- *	these functions only need to support keysyms that will be specific to
- *	the Macintosh. Currently, there are none.
+ *      These are never called because we define REDO_KEYSYM_LOOKUP, which
+ *      instructs tkBind to do the conversion for us.
  *
  * Results:
  *	None.
@@ -534,62 +466,64 @@ XStringToKeysym(
  * Results:
  *
  *      An X11 KeyCode with a unicode character in the low 16 bits and the
- *	8-bit "virtual keycode" in the third byte.  (The virtual keycode is the
- *	8-bit value that appears as [NSEvent keycode] in an NSKeyUp or
- *	NSKeyDown event.)  On the Mac pressing a modifier key generates an
- *	NSFlagsChanged event but not an NSKeyDown event.  If a keysym
- *	represents a modifier key, the unicode character is 0, but the modifier
- *	flags are set in the high order byte.  For keysyms that represent other
- *	keys, the resulting keycode has no modifiers.
+ *	8-bit "virtual keycode" in the third byte.  See the description of
+ *      keycodes on the Macintosh at the top of this file.
  *
  * Side effects:
  *	None.
  *
  *----------------------------------------------------------------------
  */
-
 KeyCode
-XKeysymToKeycode(
+XKeysymToKeycodeWithState(
     Display *display,
-    KeySym keysym)
+    KeySym keysym,
+    int *state)
 {
     Tcl_HashEntry *hPtr;
 
-    if (keysym <= LATIN1_MAX) {
-
-	/*
-	 * Handle keysyms in the Latin-1 range where keysym and Unicode
-	 * character code point are the same.
-	 */
-
-	if (keyboardChanged) {
-	    InitLatin1Table();
-	    keyboardChanged = 0;
+    if (!initialized) {
+	InitHashTables();
+    }
+    hPtr = Tcl_FindHashEntry(&keysym2unichar, INT2PTR(keysym));
+    if (hPtr != NULL) {
+	KeyCode character = (KeyCode) Tcl_GetHashValue(hPtr);
+	hPtr = Tcl_FindHashEntry(&unichar2virtual, INT2PTR(character));
+	if (hPtr != NULL) {
+	    KeyCode lookup = ((KeyCode) Tcl_GetHashValue(hPtr));
+	    KeyCode virtual = lookup & 0xFF;
+	    *state = lookup >> 8;
+	    return virtual << 16 | character;
+	} else {
+	    return character;
 	}
-	return latin1Table[keysym].keycode;
     }
 
     /*
-     * This is not a Latin-1 key.  Try doing a hash table lookup to find the
-     * keycode.
+     * This is not a text key.  Try doing a hash table lookup to find the
+     * keycode for a special key.
      */
 
-    if (!initialized) {
-	InitKeyMaps();
-    }
-
     hPtr = Tcl_FindHashEntry(&keysym2keycode, INT2PTR(keysym));
     if (hPtr != NULL) {
 	return (KeyCode) Tcl_GetHashValue(hPtr);
     }
 
     /*
-     * The keysym is not Latin-1 and not in our hash table, so it does not
-     * appear on any known Macintosh keyboard; just return 0.
+     * Could not construct a keycode.
      */
 
     return 0;
 }
+
+KeyCode
+XKeysymToKeycode(
+    Display *display,
+    KeySym keysym)
+{
+    int state;
+    return XKeysymToKeycodeWithState(display, keysym, &state);
+}
 
 /*
  *----------------------------------------------------------------------
@@ -620,21 +554,12 @@ TkpSetKeycodeAndState(
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
     } else {
-	if (keysym <= LATIN1_MAX) {
-	    if (keyboardChanged) {
-		InitLatin1Table();
-		keyboardChanged = 0;
-	    }
-	    Latin1KeyInfo info = latin1Table[keysym];
-	    int length = TkUniCharToUtf(keysym, eventPtr->xkey.trans_chars);
-	    eventPtr->xkey.trans_chars[length] = 0;
-	    eventPtr->xkey.keycode = info.keycode;
-	    eventPtr->xkey.state |= info.state;
-	} else {
-	    Display *display = Tk_Display(tkwin);
-	    eventPtr->xkey.keycode = XKeysymToKeycode(display, keysym);
-	    eventPtr->xkey.trans_chars[0] = 0;
-	}
+	int state;
+	Display *display = Tk_Display(tkwin);
+	eventPtr->xkey.keycode = XKeysymToKeycodeWithState(display, keysym, &state);
+	eventPtr->xkey.state |= state;
+	int length = TkUniCharToUtf(keysym, eventPtr->xkey.trans_chars);
+	eventPtr->xkey.trans_chars[length] = 0;
     }
 }
 
@@ -676,6 +601,7 @@ TkpGetKeySym(
     /*
      * Modifier key events have a special mac keycode (see tkProcessKeyEvent).
      */
+
     if ((eventPtr->xkey.keycode & MAC_KEYCODE_MASK) == 0xF8FF) {
 	switch (eventPtr->xkey.keycode >> 16) { /* the virtual keyCode */
 	case 54:
@@ -703,10 +629,13 @@ TkpGetKeySym(
 	}
     }
 
-    /* If nbytes has been set, it's not a function key, but a regular key that
-       has been translated in tkMacOSXKeyEvent.c; just use that. */
+    /*
+     * If nbytes has been set, it's not a function key, but a regular key that
+     * has been translated in tkMacOSXKeyEvent.c; just use that.
+     */
+
     if (eventPtr->xkey.nbytes) {
-      return eventPtr->xkey.keycode;
+	return eventPtr->xkey.keycode;
     }
 
     /*
@@ -717,18 +646,9 @@ TkpGetKeySym(
      */
 
     index = 0;
-
-    /*
-     * We want Option key combinations to use their base chars as keysyms, so
-     * we ignore the option modifier here.
-     */
-
-#if 0
-    if (eventPtr->xkey.state & OPTION_MASK) {
+    if (eventPtr->xkey.state & Mod2Mask) { /* Option */
 	index |= 2;
     }
-#endif
-
     if ((eventPtr->xkey.state & ShiftMask)
 	    || (/* (dispPtr->lockUsage != LU_IGNORE)
 	    && */ (eventPtr->xkey.state & LockMask))) {
@@ -736,7 +656,7 @@ TkpGetKeySym(
     }
 
     /*
-     * First try of the actual translation.
+     * First do the straightforward lookup.
      */
 
     sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode, index);
@@ -749,14 +669,8 @@ TkpGetKeySym(
 
     if ((index & 1) && !(eventPtr->xkey.state & ShiftMask)
 	    /*&& (dispPtr->lockUsage == LU_CAPS)*/ ) {
-	/*
-	 * FIXME: Keysyms are only identical to Unicode for ASCII and Latin-1,
-	 * so we can't use Tcl_UniCharIsUpper() for keysyms outside that range.
-	 * This may be a serious problem here.
-	 */
-
-	if ((sym == NoSymbol) || (sym > LATIN1_MAX)
-		|| !Tcl_UniCharIsUpper(sym)) {
+
+	if ((sym == NoSymbol) || !Tcl_UniCharIsUpper(sym)) {
 	    index &= ~1;
 	    sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode,
 		    index);
@@ -808,7 +722,6 @@ TkpInitKeymapInfo(
 
     dispPtr->lockUsage = LU_CAPS;
     dispPtr->modeModMask = 0;
-
 #if 0
     /*
      * With this, <Alt> and <Meta> become synonyms for <Command> and <Option>
@@ -818,8 +731,8 @@ TkpInitKeymapInfo(
      * some changes in those scripts. See also bug #700311.
      */
 
-    dispPtr->altModMask = OPTION_MASK;
-    dispPtr->metaModMask = COMMAND_MASK;
+    dispPtr->altModMask = Mod2Mask;  /* Option key */
+    dispPtr->metaModMask = Mod1Mask; /* Command key */
 #else
     dispPtr->altModMask = 0;
     dispPtr->metaModMask = 0;
diff --git a/macosx/tkMacOSXKeysyms.h b/macosx/tkMacOSXKeysyms.h
new file mode 100644
index 0000000..6f54406
--- /dev/null
+++ b/macosx/tkMacOSXKeysyms.h
@@ -0,0 +1,1286 @@
+/*
+ * tkMacOSXKeysyms.h --
+ *
+ *      Contains data used for processing key events, some of which was
+ *      moved from tkMacOSXKeyboard.c.
+ *
+ * Copyright (c) 1990-1994 The Regents of the University of California.
+ * Copyright (c) 1994-1997 Sun Microsystems, Inc.
+ * Copyright 2001-2009, Apple Inc.
+ * Copyright (c) 2006-2009 Daniel A. Steffen <das@users.sourceforge.net>
+ * Copyright (c) 2020 Marc Culler
+ *
+ * See the file "license.terms" for information on usage and redistribution
+ * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+ */
+
+#ifndef TKMACOSXKEYSYMS_H
+#define TKMACOSXKEYSYMS_H 1
+
+/*
+ * This table enumerates the keys on Mac keyboards which do not represent
+ * letters.  This is static data -- these keys do not change when the keyboard
+ * layout changes.  The unicode representation of a special key which is not a
+ * modifier and does not have an ASCII code point lies in the reserved range
+ * 0xF700 - 0xF8FF.
+ *
+ * The table includes every key listed in Apple's documentation of Function-Key
+ * Unicodes which is not marked as "Not on most Macintosh keyboards", as well
+ * as F20, which is reported to be usable in scripts even though it does not
+ * appear on any Macintosh keyboard.
+ */
+
+typedef struct {
+    int virtual;	       /* value of [NSEvent keyCode] */
+    KeySym keysym;	       /* X11 keysym */
+    KeyCode keychar;           /* XEvent keycode & 0xFFFF */
+} KeyInfo;
+
+static const KeyInfo keyArray[] = {
+    {36,	XK_Return,	NSNewlineCharacter},
+    {48,	XK_Tab,		NSTabCharacter},
+    {51,	XK_BackSpace,	NSBackspaceCharacter},
+    {52,	XK_Return,	NSNewlineCharacter},  /* Used on some Powerbooks */
+    {53,	XK_Escape,	0x1B},
+    {54,	XK_Meta_R,      XK_Meta_R},
+    {55,	XK_Meta_L,	XK_Meta_L},
+    {56,	XK_Shift_L,	XK_Shift_L},
+    {57,	XK_Caps_Lock,   XK_Caps_Lock},
+    {58,	XK_Alt_L,	XK_Alt_L},
+    {59,	XK_Control_L,	XK_Control_L},
+    {60,	XK_Shift_R, 	XK_Shift_R},
+    {61,	XK_Alt_R,	XK_Alt_R},
+    {62,	XK_Control_R,	XK_Control_R},
+    {63,	XK_Super_L,	XK_Super_L},
+    {71,	XK_Clear,       NSClearLineFunctionKey}, /* Numlock on PC */
+    {76,	XK_KP_Enter,	NSEnterCharacter},       /* Fn Return */
+    {79,	XK_F18,		NSF18FunctionKey},
+    {80,	XK_F19,		NSF19FunctionKey},
+    {90,	XK_F20,		NSF20FunctionKey}, /* For scripting only */
+    {96,	XK_F5,		NSF5FunctionKey},
+    {97,	XK_F6,		NSF6FunctionKey},
+    {98,	XK_F7,		NSF7FunctionKey},
+    {99,	XK_F3,		NSF3FunctionKey},
+    {100,	XK_F8,		NSF8FunctionKey},
+    {101,	XK_F9,		NSF9FunctionKey},
+    {103,	XK_F11,		NSF11FunctionKey},
+    {105,	XK_F13,		NSF13FunctionKey},
+    {106,	XK_F16,		NSF16FunctionKey},
+    {107,	XK_F14,		NSF14FunctionKey},
+    {109,	XK_F10,		NSF10FunctionKey},
+    {111,	XK_F12,		NSF12FunctionKey},
+    {113,	XK_F15,		NSF15FunctionKey},
+    {114,	XK_Help,	NSHelpFunctionKey},
+    {115,	XK_Home,	NSHomeFunctionKey},     /* Fn Left */
+    {116,	XK_Page_Up,	NSPageUpFunctionKey},   /* Fn Up */
+    {117,	XK_Delete,	NSDeleteFunctionKey},   /* Fn Deleete */
+    {118,	XK_F4,		NSF4FunctionKey},
+    {119,	XK_End,		NSEndFunctionKey},      /* Fn Right */
+    {120,	XK_F2,		NSF2FunctionKey},
+    {121,	XK_Page_Down,	NSPageDownFunctionKey}, /* Fn Down */
+    {122,	XK_F1,		NSF1FunctionKey},
+    {123,	XK_Left,	NSLeftArrowFunctionKey},
+    {124,	XK_Right,	NSRightArrowFunctionKey},
+    {125,	XK_Down,	NSDownArrowFunctionKey},
+    {126,	XK_Up,		NSUpArrowFunctionKey},
+    {0, 0, 0}
+};
+
+/*
+ * X11 keysyms for modifier keys, in order.
+ */
+
+#define NUM_MOD_KEYCODES 14
+static const KeyCode modKeyArray[NUM_MOD_KEYCODES] = {
+    XK_Shift_L,
+    XK_Shift_R,
+    XK_Control_L,
+    XK_Control_R,
+    XK_Caps_Lock,
+    XK_Shift_Lock,
+    XK_Meta_L,
+    XK_Meta_R,
+    XK_Alt_L,
+    XK_Alt_R,
+    XK_Super_L,
+    XK_Super_R,
+    XK_Hyper_L,
+    XK_Hyper_R,
+};
+
+/*
+ * This table pairs X11 Keysyms for alphanumeric characters with the
+ * unicode code point for that letter.
+ * The data comes from http://www.cl.cam.ac.uk/~mgk25/ucs/keysyms.txt
+ */
+
+typedef struct KeysymInfo {
+    KeySym keysym;
+    KeyCode keycode;
+} KeysymInfo;
+
+const KeysymInfo keysymTable[] = {
+    {0x0020, 0x0020}, /* space */
+    {0x0021, 0x0021}, /* exclam */
+    {0x0022, 0x0022}, /* quotedbl */
+    {0x0023, 0x0023}, /* numbersign */
+    {0x0024, 0x0024}, /* dollar */
+    {0x0025, 0x0025}, /* percent */
+    {0x0026, 0x0026}, /* ampersand */
+    {0x0027, 0x0027}, /* apostrophe */
+    {0x0028, 0x0028}, /* parenleft */
+    {0x0029, 0x0029}, /* parenright */
+    {0x002a, 0x002a}, /* asterisk */
+    {0x002b, 0x002b}, /* plus */
+    {0x002c, 0x002c}, /* comma */
+    {0x002d, 0x002d}, /* minus */
+    {0x002e, 0x002e}, /* period */
+    {0x002f, 0x002f}, /* slash */
+    {0x0030, 0x0030}, /* 0 */
+    {0x0031, 0x0031}, /* 1 */
+    {0x0032, 0x0032}, /* 2 */
+    {0x0033, 0x0033}, /* 3 */
+    {0x0034, 0x0034}, /* 4 */
+    {0x0035, 0x0035}, /* 5 */
+    {0x0036, 0x0036}, /* 6 */
+    {0x0037, 0x0037}, /* 7 */
+    {0x0038, 0x0038}, /* 8 */
+    {0x0039, 0x0039}, /* 9 */
+    {0x003a, 0x003a}, /* colon */
+    {0x003b, 0x003b}, /* semicolon */
+    {0x003c, 0x003c}, /* less */
+    {0x003d, 0x003d}, /* equal */
+    {0x003e, 0x003e}, /* greater */
+    {0x003f, 0x003f}, /* question */
+    {0x0040, 0x0040}, /* at */
+    {0x0041, 0x0041}, /* A */
+    {0x0042, 0x0042}, /* B */
+    {0x0043, 0x0043}, /* C */
+    {0x0044, 0x0044}, /* D */
+    {0x0045, 0x0045}, /* E */
+    {0x0046, 0x0046}, /* F */
+    {0x0047, 0x0047}, /* G */
+    {0x0048, 0x0048}, /* H */
+    {0x0049, 0x0049}, /* I */
+    {0x004a, 0x004a}, /* J */
+    {0x004b, 0x004b}, /* K */
+    {0x004c, 0x004c}, /* L */
+    {0x004d, 0x004d}, /* M */
+    {0x004e, 0x004e}, /* N */
+    {0x004f, 0x004f}, /* O */
+    {0x0050, 0x0050}, /* P */
+    {0x0051, 0x0051}, /* Q */
+    {0x0052, 0x0052}, /* R */
+    {0x0053, 0x0053}, /* S */
+    {0x0054, 0x0054}, /* T */
+    {0x0055, 0x0055}, /* U */
+    {0x0056, 0x0056}, /* V */
+    {0x0057, 0x0057}, /* W */
+    {0x0058, 0x0058}, /* X */
+    {0x0059, 0x0059}, /* Y */
+    {0x005a, 0x005a}, /* Z */
+    {0x005b, 0x005b}, /* bracketleft */
+    {0x005c, 0x005c}, /* backslash */
+    {0x005d, 0x005d}, /* bracketright */
+    {0x005e, 0x005e}, /* asciicircum */
+    {0x005f, 0x005f}, /* underscore */
+    {0x0060, 0x0060}, /* grave */
+    {0x0061, 0x0061}, /* a */
+    {0x0062, 0x0062}, /* b */
+    {0x0063, 0x0063}, /* c */
+    {0x0064, 0x0064}, /* d */
+    {0x0065, 0x0065}, /* e */
+    {0x0066, 0x0066}, /* f */
+    {0x0067, 0x0067}, /* g */
+    {0x0068, 0x0068}, /* h */
+    {0x0069, 0x0069}, /* i */
+    {0x006a, 0x006a}, /* j */
+    {0x006b, 0x006b}, /* k */
+    {0x006c, 0x006c}, /* l */
+    {0x006d, 0x006d}, /* m */
+    {0x006e, 0x006e}, /* n */
+    {0x006f, 0x006f}, /* o */
+    {0x0070, 0x0070}, /* p */
+    {0x0071, 0x0071}, /* q */
+    {0x0072, 0x0072}, /* r */
+    {0x0073, 0x0073}, /* s */
+    {0x0074, 0x0074}, /* t */
+    {0x0075, 0x0075}, /* u */
+    {0x0076, 0x0076}, /* v */
+    {0x0077, 0x0077}, /* w */
+    {0x0078, 0x0078}, /* x */
+    {0x0079, 0x0079}, /* y */
+    {0x007a, 0x007a}, /* z */
+    {0x007b, 0x007b}, /* braceleft */
+    {0x007c, 0x007c}, /* bar */
+    {0x007d, 0x007d}, /* braceright */
+    {0x007e, 0x007e}, /* asciitilde */
+    {0x00a0, 0x00a0}, /* nobreakspace */
+    {0x00a1, 0x00a1}, /* exclamdown */
+    {0x00a2, 0x00a2}, /* cent */
+    {0x00a3, 0x00a3}, /* sterling */
+    {0x00a4, 0x00a4}, /* currency */
+    {0x00a5, 0x00a5}, /* yen */
+    {0x00a6, 0x00a6}, /* brokenbar */
+    {0x00a7, 0x00a7}, /* section */
+    {0x00a8, 0x00a8}, /* diaeresis */
+    {0x00a9, 0x00a9}, /* copyright */
+    {0x00aa, 0x00aa}, /* ordfeminine */
+    {0x00ab, 0x00ab}, /* guillemotleft */
+    {0x00ac, 0x00ac}, /* notsign */
+    {0x00ad, 0x00ad}, /* hyphen */
+    {0x00ae, 0x00ae}, /* registered */
+    {0x00af, 0x00af}, /* macron */
+    {0x00b0, 0x00b0}, /* degree */
+    {0x00b1, 0x00b1}, /* plusminus */
+    {0x00b2, 0x00b2}, /* twosuperior */
+    {0x00b3, 0x00b3}, /* threesuperior */
+    {0x00b4, 0x00b4}, /* acute */
+    {0x00b5, 0x00b5}, /* mu */
+    {0x00b6, 0x00b6}, /* paragraph */
+    {0x00b7, 0x00b7}, /* periodcentered */
+    {0x00b8, 0x00b8}, /* cedilla */
+    {0x00b9, 0x00b9}, /* onesuperior */
+    {0x00ba, 0x00ba}, /* masculine */
+    {0x00bb, 0x00bb}, /* guillemotright */
+    {0x00bc, 0x00bc}, /* onequarter */
+    {0x00bd, 0x00bd}, /* onehalf */
+    {0x00be, 0x00be}, /* threequarters */
+    {0x00bf, 0x00bf}, /* questiondown */
+    {0x00c0, 0x00c0}, /* Agrave */
+    {0x00c1, 0x00c1}, /* Aacute */
+    {0x00c2, 0x00c2}, /* Acircumflex */
+    {0x00c3, 0x00c3}, /* Atilde */
+    {0x00c4, 0x00c4}, /* Adiaeresis */
+    {0x00c5, 0x00c5}, /* Aring */
+    {0x00c6, 0x00c6}, /* AE */
+    {0x00c7, 0x00c7}, /* Ccedilla */
+    {0x00c8, 0x00c8}, /* Egrave */
+    {0x00c9, 0x00c9}, /* Eacute */
+    {0x00ca, 0x00ca}, /* Ecircumflex */
+    {0x00cb, 0x00cb}, /* Ediaeresis */
+    {0x00cc, 0x00cc}, /* Igrave */
+    {0x00cd, 0x00cd}, /* Iacute */
+    {0x00ce, 0x00ce}, /* Icircumflex */
+    {0x00cf, 0x00cf}, /* Idiaeresis */
+    {0x00d0, 0x00d0}, /* ETH */
+    {0x00d1, 0x00d1}, /* Ntilde */
+    {0x00d2, 0x00d2}, /* Ograve */
+    {0x00d3, 0x00d3}, /* Oacute */
+    {0x00d4, 0x00d4}, /* Ocircumflex */
+    {0x00d5, 0x00d5}, /* Otilde */
+    {0x00d6, 0x00d6}, /* Odiaeresis */
+    {0x00d7, 0x00d7}, /* multiply */
+    {0x00d8, 0x00d8}, /* Ooblique */
+    {0x00d9, 0x00d9}, /* Ugrave */
+    {0x00da, 0x00da}, /* Uacute */
+    {0x00db, 0x00db}, /* Ucircumflex */
+    {0x00dc, 0x00dc}, /* Udiaeresis */
+    {0x00dd, 0x00dd}, /* Yacute */
+    {0x00de, 0x00de}, /* THORN */
+    {0x00df, 0x00df}, /* ssharp */
+    {0x00e0, 0x00e0}, /* agrave */
+    {0x00e1, 0x00e1}, /* aacute */
+    {0x00e2, 0x00e2}, /* acircumflex */
+    {0x00e3, 0x00e3}, /* atilde */
+    {0x00e4, 0x00e4}, /* adiaeresis */
+    {0x00e5, 0x00e5}, /* aring */
+    {0x00e6, 0x00e6}, /* ae */
+    {0x00e7, 0x00e7}, /* ccedilla */
+    {0x00e8, 0x00e8}, /* egrave */
+    {0x00e9, 0x00e9}, /* eacute */
+    {0x00ea, 0x00ea}, /* ecircumflex */
+    {0x00eb, 0x00eb}, /* ediaeresis */
+    {0x00ec, 0x00ec}, /* igrave */
+    {0x00ed, 0x00ed}, /* iacute */
+    {0x00ee, 0x00ee}, /* icircumflex */
+    {0x00ef, 0x00ef}, /* idiaeresis */
+    {0x00f0, 0x00f0}, /* eth */
+    {0x00f1, 0x00f1}, /* ntilde */
+    {0x00f2, 0x00f2}, /* ograve */
+    {0x00f3, 0x00f3}, /* oacute */
+    {0x00f4, 0x00f4}, /* ocircumflex */
+    {0x00f5, 0x00f5}, /* otilde */
+    {0x00f6, 0x00f6}, /* odiaeresis */
+    {0x00f7, 0x00f7}, /* division */
+    {0x00f8, 0x00f8}, /* oslash */
+    {0x00f9, 0x00f9}, /* ugrave */
+    {0x00fa, 0x00fa}, /* uacute */
+    {0x00fb, 0x00fb}, /* ucircumflex */
+    {0x00fc, 0x00fc}, /* udiaeresis */
+    {0x00fd, 0x00fd}, /* yacute */
+    {0x00fe, 0x00fe}, /* thorn */
+    {0x00ff, 0x00ff}, /* ydiaeresis */
+    {0x01a1, 0x0104}, /* Aogonek */
+    {0x01a2, 0x02d8}, /* breve */
+    {0x01a3, 0x0141}, /* Lstroke */
+    {0x01a5, 0x013d}, /* Lcaron */
+    {0x01a6, 0x015a}, /* Sacute */
+    {0x01a9, 0x0160}, /* Scaron */
+    {0x01aa, 0x015e}, /* Scedilla */
+    {0x01ab, 0x0164}, /* Tcaron */
+    {0x01ac, 0x0179}, /* Zacute */
+    {0x01ae, 0x017d}, /* Zcaron */
+    {0x01af, 0x017b}, /* Zabovedot */
+    {0x01b1, 0x0105}, /* aogonek */
+    {0x01b2, 0x02db}, /* ogonek */
+    {0x01b3, 0x0142}, /* lstroke */
+    {0x01b5, 0x013e}, /* lcaron */
+    {0x01b6, 0x015b}, /* sacute */
+    {0x01b7, 0x02c7}, /* caron */
+    {0x01b9, 0x0161}, /* scaron */
+    {0x01ba, 0x015f}, /* scedilla */
+    {0x01bb, 0x0165}, /* tcaron */
+    {0x01bc, 0x017a}, /* zacute */
+    {0x01bd, 0x02dd}, /* doubleacute */
+    {0x01be, 0x017e}, /* zcaron */
+    {0x01bf, 0x017c}, /* zabovedot */
+    {0x01c0, 0x0154}, /* Racute */
+    {0x01c3, 0x0102}, /* Abreve */
+    {0x01c5, 0x0139}, /* Lacute */
+    {0x01c6, 0x0106}, /* Cacute */
+    {0x01c8, 0x010c}, /* Ccaron */
+    {0x01ca, 0x0118}, /* Eogonek */
+    {0x01cc, 0x011a}, /* Ecaron */
+    {0x01cf, 0x010e}, /* Dcaron */
+    {0x01d0, 0x0110}, /* Dstroke */
+    {0x01d1, 0x0143}, /* Nacute */
+    {0x01d2, 0x0147}, /* Ncaron */
+    {0x01d5, 0x0150}, /* Odoubleacute */
+    {0x01d8, 0x0158}, /* Rcaron */
+    {0x01d9, 0x016e}, /* Uring */
+    {0x01db, 0x0170}, /* Udoubleacute */
+    {0x01de, 0x0162}, /* Tcedilla */
+    {0x01e0, 0x0155}, /* racute */
+    {0x01e3, 0x0103}, /* abreve */
+    {0x01e5, 0x013a}, /* lacute */
+    {0x01e6, 0x0107}, /* cacute */
+    {0x01e8, 0x010d}, /* ccaron */
+    {0x01ea, 0x0119}, /* eogonek */
+    {0x01ec, 0x011b}, /* ecaron */
+    {0x01ef, 0x010f}, /* dcaron */
+    {0x01f0, 0x0111}, /* dstroke */
+    {0x01f1, 0x0144}, /* nacute */
+    {0x01f2, 0x0148}, /* ncaron */
+    {0x01f5, 0x0151}, /* odoubleacute */
+    {0x01f8, 0x0159}, /* rcaron */
+    {0x01f9, 0x016f}, /* uring */
+    {0x01fb, 0x0171}, /* udoubleacute */
+    {0x01fe, 0x0163}, /* tcedilla */
+    {0x01ff, 0x02d9}, /* abovedot */
+    {0x02a1, 0x0126}, /* Hstroke */
+    {0x02a6, 0x0124}, /* Hcircumflex */
+    {0x02a9, 0x0130}, /* Iabovedot */
+    {0x02ab, 0x011e}, /* Gbreve */
+    {0x02ac, 0x0134}, /* Jcircumflex */
+    {0x02b1, 0x0127}, /* hstroke */
+    {0x02b6, 0x0125}, /* hcircumflex */
+    {0x02b9, 0x0131}, /* idotless */
+    {0x02bb, 0x011f}, /* gbreve */
+    {0x02bc, 0x0135}, /* jcircumflex */
+    {0x02c5, 0x010a}, /* Cabovedot */
+    {0x02c6, 0x0108}, /* Ccircumflex */
+    {0x02d5, 0x0120}, /* Gabovedot */
+    {0x02d8, 0x011c}, /* Gcircumflex */
+    {0x02dd, 0x016c}, /* Ubreve */
+    {0x02de, 0x015c}, /* Scircumflex */
+    {0x02e5, 0x010b}, /* cabovedot */
+    {0x02e6, 0x0109}, /* ccircumflex */
+    {0x02f5, 0x0121}, /* gabovedot */
+    {0x02f8, 0x011d}, /* gcircumflex */
+    {0x02fd, 0x016d}, /* ubreve */
+    {0x02fe, 0x015d}, /* scircumflex */
+    {0x03a2, 0x0138}, /* kra */
+    {0x03a3, 0x0156}, /* Rcedilla */
+    {0x03a5, 0x0128}, /* Itilde */
+    {0x03a6, 0x013b}, /* Lcedilla */
+    {0x03aa, 0x0112}, /* Emacron */
+    {0x03ab, 0x0122}, /* Gcedilla */
+    {0x03ac, 0x0166}, /* Tslash */
+    {0x03b3, 0x0157}, /* rcedilla */
+    {0x03b5, 0x0129}, /* itilde */
+    {0x03b6, 0x013c}, /* lcedilla */
+    {0x03ba, 0x0113}, /* emacron */
+    {0x03bb, 0x0123}, /* gcedilla */
+    {0x03bc, 0x0167}, /* tslash */
+    {0x03bd, 0x014a}, /* ENG */
+    {0x03bf, 0x014b}, /* eng */
+    {0x03c0, 0x0100}, /* Amacron */
+    {0x03c7, 0x012e}, /* Iogonek */
+    {0x03cc, 0x0116}, /* Eabovedot */
+    {0x03cf, 0x012a}, /* Imacron */
+    {0x03d1, 0x0145}, /* Ncedilla */
+    {0x03d2, 0x014c}, /* Omacron */
+    {0x03d3, 0x0136}, /* Kcedilla */
+    {0x03d9, 0x0172}, /* Uogonek */
+    {0x03dd, 0x0168}, /* Utilde */
+    {0x03de, 0x016a}, /* Umacron */
+    {0x03e0, 0x0101}, /* amacron */
+    {0x03e7, 0x012f}, /* iogonek */
+    {0x03ec, 0x0117}, /* eabovedot */
+    {0x03ef, 0x012b}, /* imacron */
+    {0x03f1, 0x0146}, /* ncedilla */
+    {0x03f2, 0x014d}, /* omacron */
+    {0x03f3, 0x0137}, /* kcedilla */
+    {0x03f9, 0x0173}, /* uogonek */
+    {0x03fd, 0x0169}, /* utilde */
+    {0x03fe, 0x016b}, /* umacron */
+    {0x047e, 0x203e}, /* overline */
+    {0x04a1, 0x3002}, /* kana_fullstop */
+    {0x04a2, 0x300c}, /* kana_openingbracket */
+    {0x04a3, 0x300d}, /* kana_closingbracket */
+    {0x04a4, 0x3001}, /* kana_comma */
+    {0x04a5, 0x30fb}, /* kana_conjunctive */
+    {0x04a6, 0x30f2}, /* kana_WO */
+    {0x04a7, 0x30a1}, /* kana_a */
+    {0x04a8, 0x30a3}, /* kana_i */
+    {0x04a9, 0x30a5}, /* kana_u */
+    {0x04aa, 0x30a7}, /* kana_e */
+    {0x04ab, 0x30a9}, /* kana_o */
+    {0x04ac, 0x30e3}, /* kana_ya */
+    {0x04ad, 0x30e5}, /* kana_yu */
+    {0x04ae, 0x30e7}, /* kana_yo */
+    {0x04af, 0x30c3}, /* kana_tsu */
+    {0x04b0, 0x30fc}, /* prolongedsound */
+    {0x04b1, 0x30a2}, /* kana_A */
+    {0x04b2, 0x30a4}, /* kana_I */
+    {0x04b3, 0x30a6}, /* kana_U */
+    {0x04b4, 0x30a8}, /* kana_E */
+    {0x04b5, 0x30aa}, /* kana_O */
+    {0x04b6, 0x30ab}, /* kana_KA */
+    {0x04b7, 0x30ad}, /* kana_KI */
+    {0x04b8, 0x30af}, /* kana_KU */
+    {0x04b9, 0x30b1}, /* kana_KE */
+    {0x04ba, 0x30b3}, /* kana_KO */
+    {0x04bb, 0x30b5}, /* kana_SA */
+    {0x04bc, 0x30b7}, /* kana_SHI */
+    {0x04bd, 0x30b9}, /* kana_SU */
+    {0x04be, 0x30bb}, /* kana_SE */
+    {0x04bf, 0x30bd}, /* kana_SO */
+    {0x04c0, 0x30bf}, /* kana_TA */
+    {0x04c1, 0x30c1}, /* kana_CHI */
+    {0x04c2, 0x30c4}, /* kana_TSU */
+    {0x04c3, 0x30c6}, /* kana_TE */
+    {0x04c4, 0x30c8}, /* kana_TO */
+    {0x04c5, 0x30ca}, /* kana_NA */
+    {0x04c6, 0x30cb}, /* kana_NI */
+    {0x04c7, 0x30cc}, /* kana_NU */
+    {0x04c8, 0x30cd}, /* kana_NE */
+    {0x04c9, 0x30ce}, /* kana_NO */
+    {0x04ca, 0x30cf}, /* kana_HA */
+    {0x04cb, 0x30d2}, /* kana_HI */
+    {0x04cc, 0x30d5}, /* kana_FU */
+    {0x04cd, 0x30d8}, /* kana_HE */
+    {0x04ce, 0x30db}, /* kana_HO */
+    {0x04cf, 0x30de}, /* kana_MA */
+    {0x04d0, 0x30df}, /* kana_MI */
+    {0x04d1, 0x30e0}, /* kana_MU */
+    {0x04d2, 0x30e1}, /* kana_ME */
+    {0x04d3, 0x30e2}, /* kana_MO */
+    {0x04d4, 0x30e4}, /* kana_YA */
+    {0x04d5, 0x30e6}, /* kana_YU */
+    {0x04d6, 0x30e8}, /* kana_YO */
+    {0x04d7, 0x30e9}, /* kana_RA */
+    {0x04d8, 0x30ea}, /* kana_RI */
+    {0x04d9, 0x30eb}, /* kana_RU */
+    {0x04da, 0x30ec}, /* kana_RE */
+    {0x04db, 0x30ed}, /* kana_RO */
+    {0x04dc, 0x30ef}, /* kana_WA */
+    {0x04dd, 0x30f3}, /* kana_N */
+    {0x04de, 0x309b}, /* voicedsound */
+    {0x04df, 0x309c}, /* semivoicedsound */
+    {0x05ac, 0x060c}, /* Arabic_comma */
+    {0x05bb, 0x061b}, /* Arabic_semicolon */
+    {0x05bf, 0x061f}, /* Arabic_question_mark */
+    {0x05c1, 0x0621}, /* Arabic_hamza */
+    {0x05c2, 0x0622}, /* Arabic_maddaonalef */
+    {0x05c3, 0x0623}, /* Arabic_hamzaonalef */
+    {0x05c4, 0x0624}, /* Arabic_hamzaonwaw */
+    {0x05c5, 0x0625}, /* Arabic_hamzaunderalef */
+    {0x05c6, 0x0626}, /* Arabic_hamzaonyeh */
+    {0x05c7, 0x0627}, /* Arabic_alef */
+    {0x05c8, 0x0628}, /* Arabic_beh */
+    {0x05c9, 0x0629}, /* Arabic_tehmarbuta */
+    {0x05ca, 0x062a}, /* Arabic_teh */
+    {0x05cb, 0x062b}, /* Arabic_theh */
+    {0x05cc, 0x062c}, /* Arabic_jeem */
+    {0x05cd, 0x062d}, /* Arabic_hah */
+    {0x05ce, 0x062e}, /* Arabic_khah */
+    {0x05cf, 0x062f}, /* Arabic_dal */
+    {0x05d0, 0x0630}, /* Arabic_thal */
+    {0x05d1, 0x0631}, /* Arabic_ra */
+    {0x05d2, 0x0632}, /* Arabic_zain */
+    {0x05d3, 0x0633}, /* Arabic_seen */
+    {0x05d4, 0x0634}, /* Arabic_sheen */
+    {0x05d5, 0x0635}, /* Arabic_sad */
+    {0x05d6, 0x0636}, /* Arabic_dad */
+    {0x05d7, 0x0637}, /* Arabic_tah */
+    {0x05d8, 0x0638}, /* Arabic_zah */
+    {0x05d9, 0x0639}, /* Arabic_ain */
+    {0x05da, 0x063a}, /* Arabic_ghain */
+    {0x05e0, 0x0640}, /* Arabic_tatweel */
+    {0x05e1, 0x0641}, /* Arabic_feh */
+    {0x05e2, 0x0642}, /* Arabic_qaf */
+    {0x05e3, 0x0643}, /* Arabic_kaf */
+    {0x05e4, 0x0644}, /* Arabic_lam */
+    {0x05e5, 0x0645}, /* Arabic_meem */
+    {0x05e6, 0x0646}, /* Arabic_noon */
+    {0x05e7, 0x0647}, /* Arabic_ha */
+    {0x05e8, 0x0648}, /* Arabic_waw */
+    {0x05e9, 0x0649}, /* Arabic_alefmaksura */
+    {0x05ea, 0x064a}, /* Arabic_yeh */
+    {0x05eb, 0x064b}, /* Arabic_fathatan */
+    {0x05ec, 0x064c}, /* Arabic_dammatan */
+    {0x05ed, 0x064d}, /* Arabic_kasratan */
+    {0x05ee, 0x064e}, /* Arabic_fatha */
+    {0x05ef, 0x064f}, /* Arabic_damma */
+    {0x05f0, 0x0650}, /* Arabic_kasra */
+    {0x05f1, 0x0651}, /* Arabic_shadda */
+    {0x05f2, 0x0652}, /* Arabic_sukun */
+    {0x06a1, 0x0452}, /* Serbian_dje */
+    {0x06a2, 0x0453}, /* Macedonia_gje */
+    {0x06a3, 0x0451}, /* Cyrillic_io */
+    {0x06a4, 0x0454}, /* Ukrainian_ie */
+    {0x06a5, 0x0455}, /* Macedonia_dse */
+    {0x06a6, 0x0456}, /* Ukrainian_i */
+    {0x06a7, 0x0457}, /* Ukrainian_yi */
+    {0x06a8, 0x0458}, /* Cyrillic_je */
+    {0x06a9, 0x0459}, /* Cyrillic_lje */
+    {0x06aa, 0x045a}, /* Cyrillic_nje */
+    {0x06ab, 0x045b}, /* Serbian_tshe */
+    {0x06ac, 0x045c}, /* Macedonia_kje */
+    {0x06ae, 0x045e}, /* Byelorussian_shortu */
+    {0x06af, 0x045f}, /* Cyrillic_dzhe */
+    {0x06b0, 0x2116}, /* numerosign */
+    {0x06b1, 0x0402}, /* Serbian_DJE */
+    {0x06b2, 0x0403}, /* Macedonia_GJE */
+    {0x06b3, 0x0401}, /* Cyrillic_IO */
+    {0x06b4, 0x0404}, /* Ukrainian_IE */
+    {0x06b5, 0x0405}, /* Macedonia_DSE */
+    {0x06b6, 0x0406}, /* Ukrainian_I */
+    {0x06b7, 0x0407}, /* Ukrainian_YI */
+    {0x06b8, 0x0408}, /* Cyrillic_JE */
+    {0x06b9, 0x0409}, /* Cyrillic_LJE */
+    {0x06ba, 0x040a}, /* Cyrillic_NJE */
+    {0x06bb, 0x040b}, /* Serbian_TSHE */
+    {0x06bc, 0x040c}, /* Macedonia_KJE */
+    {0x06be, 0x040e}, /* Byelorussian_SHORTU */
+    {0x06bf, 0x040f}, /* Cyrillic_DZHE */
+    {0x06c0, 0x044e}, /* Cyrillic_yu */
+    {0x06c1, 0x0430}, /* Cyrillic_a */
+    {0x06c2, 0x0431}, /* Cyrillic_be */
+    {0x06c3, 0x0446}, /* Cyrillic_tse */
+    {0x06c4, 0x0434}, /* Cyrillic_de */
+    {0x06c5, 0x0435}, /* Cyrillic_ie */
+    {0x06c6, 0x0444}, /* Cyrillic_ef */
+    {0x06c7, 0x0433}, /* Cyrillic_ghe */
+    {0x06c8, 0x0445}, /* Cyrillic_ha */
+    {0x06c9, 0x0438}, /* Cyrillic_i */
+    {0x06ca, 0x0439}, /* Cyrillic_shorti */
+    {0x06cb, 0x043a}, /* Cyrillic_ka */
+    {0x06cc, 0x043b}, /* Cyrillic_el */
+    {0x06cd, 0x043c}, /* Cyrillic_em */
+    {0x06ce, 0x043d}, /* Cyrillic_en */
+    {0x06cf, 0x043e}, /* Cyrillic_o */
+    {0x06d0, 0x043f}, /* Cyrillic_pe */
+    {0x06d1, 0x044f}, /* Cyrillic_ya */
+    {0x06d2, 0x0440}, /* Cyrillic_er */
+    {0x06d3, 0x0441}, /* Cyrillic_es */
+    {0x06d4, 0x0442}, /* Cyrillic_te */
+    {0x06d5, 0x0443}, /* Cyrillic_u */
+    {0x06d6, 0x0436}, /* Cyrillic_zhe */
+    {0x06d7, 0x0432}, /* Cyrillic_ve */
+    {0x06d8, 0x044c}, /* Cyrillic_softsign */
+    {0x06d9, 0x044b}, /* Cyrillic_yeru */
+    {0x06da, 0x0437}, /* Cyrillic_ze */
+    {0x06db, 0x0448}, /* Cyrillic_sha */
+    {0x06dc, 0x044d}, /* Cyrillic_e */
+    {0x06dd, 0x0449}, /* Cyrillic_shcha */
+    {0x06de, 0x0447}, /* Cyrillic_che */
+    {0x06df, 0x044a}, /* Cyrillic_hardsign */
+    {0x06e0, 0x042e}, /* Cyrillic_YU */
+    {0x06e1, 0x0410}, /* Cyrillic_A */
+    {0x06e2, 0x0411}, /* Cyrillic_BE */
+    {0x06e3, 0x0426}, /* Cyrillic_TSE */
+    {0x06e4, 0x0414}, /* Cyrillic_DE */
+    {0x06e5, 0x0415}, /* Cyrillic_IE */
+    {0x06e6, 0x0424}, /* Cyrillic_EF */
+    {0x06e7, 0x0413}, /* Cyrillic_GHE */
+    {0x06e8, 0x0425}, /* Cyrillic_HA */
+    {0x06e9, 0x0418}, /* Cyrillic_I */
+    {0x06ea, 0x0419}, /* Cyrillic_SHORTI */
+    {0x06eb, 0x041a}, /* Cyrillic_KA */
+    {0x06ec, 0x041b}, /* Cyrillic_EL */
+    {0x06ed, 0x041c}, /* Cyrillic_EM */
+    {0x06ee, 0x041d}, /* Cyrillic_EN */
+    {0x06ef, 0x041e}, /* Cyrillic_O */
+    {0x06f0, 0x041f}, /* Cyrillic_PE */
+    {0x06f1, 0x042f}, /* Cyrillic_YA */
+    {0x06f2, 0x0420}, /* Cyrillic_ER */
+    {0x06f3, 0x0421}, /* Cyrillic_ES */
+    {0x06f4, 0x0422}, /* Cyrillic_TE */
+    {0x06f5, 0x0423}, /* Cyrillic_U */
+    {0x06f6, 0x0416}, /* Cyrillic_ZHE */
+    {0x06f7, 0x0412}, /* Cyrillic_VE */
+    {0x06f8, 0x042c}, /* Cyrillic_SOFTSIGN */
+    {0x06f9, 0x042b}, /* Cyrillic_YERU */
+    {0x06fa, 0x0417}, /* Cyrillic_ZE */
+    {0x06fb, 0x0428}, /* Cyrillic_SHA */
+    {0x06fc, 0x042d}, /* Cyrillic_E */
+    {0x06fd, 0x0429}, /* Cyrillic_SHCHA */
+    {0x06fe, 0x0427}, /* Cyrillic_CHE */
+    {0x06ff, 0x042a}, /* Cyrillic_HARDSIGN */
+    {0x07a1, 0x0386}, /* Greek_ALPHAaccent */
+    {0x07a2, 0x0388}, /* Greek_EPSILONaccent */
+    {0x07a3, 0x0389}, /* Greek_ETAaccent */
+    {0x07a4, 0x038a}, /* Greek_IOTAaccent */
+    {0x07a5, 0x03aa}, /* Greek_IOTAdiaeresis */
+    {0x07a7, 0x038c}, /* Greek_OMICRONaccent */
+    {0x07a8, 0x038e}, /* Greek_UPSILONaccent */
+    {0x07a9, 0x03ab}, /* Greek_UPSILONdieresis */
+    {0x07ab, 0x038f}, /* Greek_OMEGAaccent */
+    {0x07ae, 0x0385}, /* Greek_accentdieresis */
+    {0x07af, 0x2015}, /* Greek_horizbar */
+    {0x07b1, 0x03ac}, /* Greek_alphaaccent */
+    {0x07b2, 0x03ad}, /* Greek_epsilonaccent */
+    {0x07b3, 0x03ae}, /* Greek_etaaccent */
+    {0x07b4, 0x03af}, /* Greek_iotaaccent */
+    {0x07b5, 0x03ca}, /* Greek_iotadieresis */
+    {0x07b6, 0x0390}, /* Greek_iotaaccentdieresis */
+    {0x07b7, 0x03cc}, /* Greek_omicronaccent */
+    {0x07b8, 0x03cd}, /* Greek_upsilonaccent */
+    {0x07b9, 0x03cb}, /* Greek_upsilondieresis */
+    {0x07ba, 0x03b0}, /* Greek_upsilonaccentdieresis */
+    {0x07bb, 0x03ce}, /* Greek_omegaaccent */
+    {0x07c1, 0x0391}, /* Greek_ALPHA */
+    {0x07c2, 0x0392}, /* Greek_BETA */
+    {0x07c3, 0x0393}, /* Greek_GAMMA */
+    {0x07c4, 0x0394}, /* Greek_DELTA */
+    {0x07c5, 0x0395}, /* Greek_EPSILON */
+    {0x07c6, 0x0396}, /* Greek_ZETA */
+    {0x07c7, 0x0397}, /* Greek_ETA */
+    {0x07c8, 0x0398}, /* Greek_THETA */
+    {0x07c9, 0x0399}, /* Greek_IOTA */
+    {0x07ca, 0x039a}, /* Greek_KAPPA */
+    {0x07cb, 0x039b}, /* Greek_LAMDA */
+    {0x07cc, 0x039c}, /* Greek_MU */
+    {0x07cd, 0x039d}, /* Greek_NU */
+    {0x07ce, 0x039e}, /* Greek_XI */
+    {0x07cf, 0x039f}, /* Greek_OMICRON */
+    {0x07d0, 0x03a0}, /* Greek_PI */
+    {0x07d1, 0x03a1}, /* Greek_RHO */
+    {0x07d2, 0x03a3}, /* Greek_SIGMA */
+    {0x07d4, 0x03a4}, /* Greek_TAU */
+    {0x07d5, 0x03a5}, /* Greek_UPSILON */
+    {0x07d6, 0x03a6}, /* Greek_PHI */
+    {0x07d7, 0x03a7}, /* Greek_CHI */
+    {0x07d8, 0x03a8}, /* Greek_PSI */
+    {0x07d9, 0x03a9}, /* Greek_OMEGA */
+    {0x07e1, 0x03b1}, /* Greek_alpha */
+    {0x07e2, 0x03b2}, /* Greek_beta */
+    {0x07e3, 0x03b3}, /* Greek_gamma */
+    {0x07e4, 0x03b4}, /* Greek_delta */
+    {0x07e5, 0x03b5}, /* Greek_epsilon */
+    {0x07e6, 0x03b6}, /* Greek_zeta */
+    {0x07e7, 0x03b7}, /* Greek_eta */
+    {0x07e8, 0x03b8}, /* Greek_theta */
+    {0x07e9, 0x03b9}, /* Greek_iota */
+    {0x07ea, 0x03ba}, /* Greek_kappa */
+    {0x07eb, 0x03bb}, /* Greek_lambda */
+    {0x07ec, 0x03bc}, /* Greek_mu */
+    {0x07ed, 0x03bd}, /* Greek_nu */
+    {0x07ee, 0x03be}, /* Greek_xi */
+    {0x07ef, 0x03bf}, /* Greek_omicron */
+    {0x07f0, 0x03c0}, /* Greek_pi */
+    {0x07f1, 0x03c1}, /* Greek_rho */
+    {0x07f2, 0x03c3}, /* Greek_sigma */
+    {0x07f3, 0x03c2}, /* Greek_finalsmallsigma */
+    {0x07f4, 0x03c4}, /* Greek_tau */
+    {0x07f5, 0x03c5}, /* Greek_upsilon */
+    {0x07f6, 0x03c6}, /* Greek_phi */
+    {0x07f7, 0x03c7}, /* Greek_chi */
+    {0x07f8, 0x03c8}, /* Greek_psi */
+    {0x07f9, 0x03c9}, /* Greek_omega */
+    {0x08a1, 0x23b7}, /* leftradical */
+    {0x08a4, 0x2320}, /* topintegral */
+    {0x08a5, 0x2321}, /* botintegral */
+    {0x08a7, 0x23a1}, /* topleftsqbracket */
+    {0x08a8, 0x23a3}, /* botleftsqbracket */
+    {0x08a9, 0x23a4}, /* toprightsqbracket */
+    {0x08aa, 0x23a6}, /* botrightsqbracket */
+    {0x08ab, 0x239b}, /* topleftparens */
+    {0x08ac, 0x239d}, /* botleftparens */
+    {0x08ad, 0x239e}, /* toprightparens */
+    {0x08ae, 0x23a0}, /* botrightparens */
+    {0x08af, 0x23a8}, /* leftmiddlecurlybrace */
+    {0x08b0, 0x23ac}, /* rightmiddlecurlybrace */
+    {0x08bc, 0x2264}, /* lessthanequal */
+    {0x08bd, 0x2260}, /* notequal */
+    {0x08be, 0x2265}, /* greaterthanequal */
+    {0x08bf, 0x222b}, /* integral */
+    {0x08c0, 0x2234}, /* therefore */
+    {0x08c1, 0x221d}, /* variation */
+    {0x08c2, 0x221e}, /* infinity */
+    {0x08c5, 0x2207}, /* nabla */
+    {0x08c8, 0x223c}, /* approximate */
+    {0x08c9, 0x2243}, /* similarequal */
+    {0x08cd, 0x21d4}, /* ifonlyif */
+    {0x08ce, 0x21d2}, /* implies */
+    {0x08cf, 0x2261}, /* identical */
+    {0x08d6, 0x221a}, /* radical */
+    {0x08da, 0x2282}, /* includedin */
+    {0x08db, 0x2283}, /* includes */
+    {0x08dc, 0x2229}, /* intersection */
+    {0x08dd, 0x222a}, /* union */
+    {0x08de, 0x2227}, /* logicaland */
+    {0x08df, 0x2228}, /* logicalor */
+    {0x08ef, 0x2202}, /* partialderivative */
+    {0x08f6, 0x0192}, /* function */
+    {0x08fb, 0x2190}, /* leftarrow */
+    {0x08fc, 0x2191}, /* uparrow */
+    {0x08fd, 0x2192}, /* rightarrow */
+    {0x08fe, 0x2193}, /* downarrow */
+    {0x09e0, 0x25c6}, /* soliddiamond */
+    {0x09e1, 0x2592}, /* checkerboard */
+    {0x09e2, 0x2409}, /* ht */
+    {0x09e3, 0x240c}, /* ff */
+    {0x09e4, 0x240d}, /* cr */
+    {0x09e5, 0x240a}, /* lf */
+    {0x09e8, 0x2424}, /* nl */
+    {0x09e9, 0x240b}, /* vt */
+    {0x09ea, 0x2518}, /* lowrightcorner */
+    {0x09eb, 0x2510}, /* uprightcorner */
+    {0x09ec, 0x250c}, /* upleftcorner */
+    {0x09ed, 0x2514}, /* lowleftcorner */
+    {0x09ee, 0x253c}, /* crossinglines */
+    {0x09ef, 0x23ba}, /* horizlinescan1 */
+    {0x09f0, 0x23bb}, /* horizlinescan3 */
+    {0x09f1, 0x2500}, /* horizlinescan5 */
+    {0x09f2, 0x23bc}, /* horizlinescan7 */
+    {0x09f3, 0x23bd}, /* horizlinescan9 */
+    {0x09f4, 0x251c}, /* leftt */
+    {0x09f5, 0x2524}, /* rightt */
+    {0x09f6, 0x2534}, /* bott */
+    {0x09f7, 0x252c}, /* topt */
+    {0x09f8, 0x2502}, /* vertbar */
+    {0x0aa1, 0x2003}, /* emspace */
+    {0x0aa2, 0x2002}, /* enspace */
+    {0x0aa3, 0x2004}, /* em3space */
+    {0x0aa4, 0x2005}, /* em4space */
+    {0x0aa5, 0x2007}, /* digitspace */
+    {0x0aa6, 0x2008}, /* punctspace */
+    {0x0aa7, 0x2009}, /* thinspace */
+    {0x0aa8, 0x200a}, /* hairspace */
+    {0x0aa9, 0x2014}, /* emdash */
+    {0x0aaa, 0x2013}, /* endash */
+    {0x0aae, 0x2026}, /* ellipsis */
+    {0x0aaf, 0x2025}, /* doubbaselinedot */
+    {0x0ab0, 0x2153}, /* onethird */
+    {0x0ab1, 0x2154}, /* twothirds */
+    {0x0ab2, 0x2155}, /* onefifth */
+    {0x0ab3, 0x2156}, /* twofifths */
+    {0x0ab4, 0x2157}, /* threefifths */
+    {0x0ab5, 0x2158}, /* fourfifths */
+    {0x0ab6, 0x2159}, /* onesixth */
+    {0x0ab7, 0x215a}, /* fivesixths */
+    {0x0ab8, 0x2105}, /* careof */
+    {0x0abb, 0x2012}, /* figdash */
+    {0x0ac3, 0x215b}, /* oneeighth */
+    {0x0ac4, 0x215c}, /* threeeighths */
+    {0x0ac5, 0x215d}, /* fiveeighths */
+    {0x0ac6, 0x215e}, /* seveneighths */
+    {0x0ac9, 0x2122}, /* trademark */
+    {0x0ad0, 0x2018}, /* leftsinglequotemark */
+    {0x0ad1, 0x2019}, /* rightsinglequotemark */
+    {0x0ad2, 0x201c}, /* leftdoublequotemark */
+    {0x0ad3, 0x201d}, /* rightdoublequotemark */
+    {0x0ad4, 0x211e}, /* prescription */
+    {0x0ad6, 0x2032}, /* minutes */
+    {0x0ad7, 0x2033}, /* seconds */
+    {0x0ad9, 0x271d}, /* latincross */
+    {0x0aec, 0x2663}, /* club */
+    {0x0aed, 0x2666}, /* diamond */
+    {0x0aee, 0x2665}, /* heart */
+    {0x0af0, 0x2720}, /* maltesecross */
+    {0x0af1, 0x2020}, /* dagger */
+    {0x0af2, 0x2021}, /* doubledagger */
+    {0x0af3, 0x2713}, /* checkmark */
+    {0x0af4, 0x2717}, /* ballotcross */
+    {0x0af5, 0x266f}, /* musicalsharp */
+    {0x0af6, 0x266d}, /* musicalflat */
+    {0x0af7, 0x2642}, /* malesymbol */
+    {0x0af8, 0x2640}, /* femalesymbol */
+    {0x0af9, 0x260e}, /* telephone */
+    {0x0afa, 0x2315}, /* telephonerecorder */
+    {0x0afb, 0x2117}, /* phonographcopyright */
+    {0x0afc, 0x2038}, /* caret */
+    {0x0afd, 0x201a}, /* singlelowquotemark */
+    {0x0afe, 0x201e}, /* doublelowquotemark */
+    {0x0bc2, 0x22a5}, /* downtack */
+    {0x0bc4, 0x230a}, /* downstile */
+    {0x0bca, 0x2218}, /* jot */
+    {0x0bcc, 0x2395}, /* quad */
+    {0x0bce, 0x22a4}, /* uptack */
+    {0x0bcf, 0x25cb}, /* circle */
+    {0x0bd3, 0x2308}, /* upstile */
+    {0x0bdc, 0x22a2}, /* lefttack */
+    {0x0bfc, 0x22a3}, /* righttack */
+    {0x0cdf, 0x2017}, /* hebrew_doublelowline */
+    {0x0ce0, 0x05d0}, /* hebrew_aleph */
+    {0x0ce1, 0x05d1}, /* hebrew_bet */
+    {0x0ce2, 0x05d2}, /* hebrew_gimel */
+    {0x0ce3, 0x05d3}, /* hebrew_dalet */
+    {0x0ce4, 0x05d4}, /* hebrew_he */
+    {0x0ce5, 0x05d5}, /* hebrew_waw */
+    {0x0ce6, 0x05d6}, /* hebrew_zain */
+    {0x0ce7, 0x05d7}, /* hebrew_chet */
+    {0x0ce8, 0x05d8}, /* hebrew_tet */
+    {0x0ce9, 0x05d9}, /* hebrew_yod */
+    {0x0cea, 0x05da}, /* hebrew_finalkaph */
+    {0x0ceb, 0x05db}, /* hebrew_kaph */
+    {0x0cec, 0x05dc}, /* hebrew_lamed */
+    {0x0ced, 0x05dd}, /* hebrew_finalmem */
+    {0x0cee, 0x05de}, /* hebrew_mem */
+    {0x0cef, 0x05df}, /* hebrew_finalnun */
+    {0x0cf0, 0x05e0}, /* hebrew_nun */
+    {0x0cf1, 0x05e1}, /* hebrew_samech */
+    {0x0cf2, 0x05e2}, /* hebrew_ayin */
+    {0x0cf3, 0x05e3}, /* hebrew_finalpe */
+    {0x0cf4, 0x05e4}, /* hebrew_pe */
+    {0x0cf5, 0x05e5}, /* hebrew_finalzade */
+    {0x0cf6, 0x05e6}, /* hebrew_zade */
+    {0x0cf7, 0x05e7}, /* hebrew_qoph */
+    {0x0cf8, 0x05e8}, /* hebrew_resh */
+    {0x0cf9, 0x05e9}, /* hebrew_shin */
+    {0x0cfa, 0x05ea}, /* hebrew_taw */
+    {0x0da1, 0x0e01}, /* Thai_kokai */
+    {0x0da2, 0x0e02}, /* Thai_khokhai */
+    {0x0da3, 0x0e03}, /* Thai_khokhuat */
+    {0x0da4, 0x0e04}, /* Thai_khokhwai */
+    {0x0da5, 0x0e05}, /* Thai_khokhon */
+    {0x0da6, 0x0e06}, /* Thai_khorakhang */
+    {0x0da7, 0x0e07}, /* Thai_ngongu */
+    {0x0da8, 0x0e08}, /* Thai_chochan */
+    {0x0da9, 0x0e09}, /* Thai_choching */
+    {0x0daa, 0x0e0a}, /* Thai_chochang */
+    {0x0dab, 0x0e0b}, /* Thai_soso */
+    {0x0dac, 0x0e0c}, /* Thai_chochoe */
+    {0x0dad, 0x0e0d}, /* Thai_yoying */
+    {0x0dae, 0x0e0e}, /* Thai_dochada */
+    {0x0daf, 0x0e0f}, /* Thai_topatak */
+    {0x0db0, 0x0e10}, /* Thai_thothan */
+    {0x0db1, 0x0e11}, /* Thai_thonangmontho */
+    {0x0db2, 0x0e12}, /* Thai_thophuthao */
+    {0x0db3, 0x0e13}, /* Thai_nonen */
+    {0x0db4, 0x0e14}, /* Thai_dodek */
+    {0x0db5, 0x0e15}, /* Thai_totao */
+    {0x0db6, 0x0e16}, /* Thai_thothung */
+    {0x0db7, 0x0e17}, /* Thai_thothahan */
+    {0x0db8, 0x0e18}, /* Thai_thothong */
+    {0x0db9, 0x0e19}, /* Thai_nonu */
+    {0x0dba, 0x0e1a}, /* Thai_bobaimai */
+    {0x0dbb, 0x0e1b}, /* Thai_popla */
+    {0x0dbc, 0x0e1c}, /* Thai_phophung */
+    {0x0dbd, 0x0e1d}, /* Thai_fofa */
+    {0x0dbe, 0x0e1e}, /* Thai_phophan */
+    {0x0dbf, 0x0e1f}, /* Thai_fofan */
+    {0x0dc0, 0x0e20}, /* Thai_phosamphao */
+    {0x0dc1, 0x0e21}, /* Thai_moma */
+    {0x0dc2, 0x0e22}, /* Thai_yoyak */
+    {0x0dc3, 0x0e23}, /* Thai_rorua */
+    {0x0dc4, 0x0e24}, /* Thai_ru */
+    {0x0dc5, 0x0e25}, /* Thai_loling */
+    {0x0dc6, 0x0e26}, /* Thai_lu */
+    {0x0dc7, 0x0e27}, /* Thai_wowaen */
+    {0x0dc8, 0x0e28}, /* Thai_sosala */
+    {0x0dc9, 0x0e29}, /* Thai_sorusi */
+    {0x0dca, 0x0e2a}, /* Thai_sosua */
+    {0x0dcb, 0x0e2b}, /* Thai_hohip */
+    {0x0dcc, 0x0e2c}, /* Thai_lochula */
+    {0x0dcd, 0x0e2d}, /* Thai_oang */
+    {0x0dce, 0x0e2e}, /* Thai_honokhuk */
+    {0x0dcf, 0x0e2f}, /* Thai_paiyannoi */
+    {0x0dd0, 0x0e30}, /* Thai_saraa */
+    {0x0dd1, 0x0e31}, /* Thai_maihanakat */
+    {0x0dd2, 0x0e32}, /* Thai_saraaa */
+    {0x0dd3, 0x0e33}, /* Thai_saraam */
+    {0x0dd4, 0x0e34}, /* Thai_sarai */
+    {0x0dd5, 0x0e35}, /* Thai_saraii */
+    {0x0dd6, 0x0e36}, /* Thai_saraue */
+    {0x0dd7, 0x0e37}, /* Thai_sarauee */
+    {0x0dd8, 0x0e38}, /* Thai_sarau */
+    {0x0dd9, 0x0e39}, /* Thai_sarauu */
+    {0x0dda, 0x0e3a}, /* Thai_phinthu */
+    {0x0ddf, 0x0e3f}, /* Thai_baht */
+    {0x0de0, 0x0e40}, /* Thai_sarae */
+    {0x0de1, 0x0e41}, /* Thai_saraae */
+    {0x0de2, 0x0e42}, /* Thai_sarao */
+    {0x0de3, 0x0e43}, /* Thai_saraaimaimuan */
+    {0x0de4, 0x0e44}, /* Thai_saraaimaimalai */
+    {0x0de5, 0x0e45}, /* Thai_lakkhangyao */
+    {0x0de6, 0x0e46}, /* Thai_maiyamok */
+    {0x0de7, 0x0e47}, /* Thai_maitaikhu */
+    {0x0de8, 0x0e48}, /* Thai_maiek */
+    {0x0de9, 0x0e49}, /* Thai_maitho */
+    {0x0dea, 0x0e4a}, /* Thai_maitri */
+    {0x0deb, 0x0e4b}, /* Thai_maichattawa */
+    {0x0dec, 0x0e4c}, /* Thai_thanthakhat */
+    {0x0ded, 0x0e4d}, /* Thai_nikhahit */
+    {0x0df0, 0x0e50}, /* Thai_leksun */
+    {0x0df1, 0x0e51}, /* Thai_leknung */
+    {0x0df2, 0x0e52}, /* Thai_leksong */
+    {0x0df3, 0x0e53}, /* Thai_leksam */
+    {0x0df4, 0x0e54}, /* Thai_leksi */
+    {0x0df5, 0x0e55}, /* Thai_lekha */
+    {0x0df6, 0x0e56}, /* Thai_lekhok */
+    {0x0df7, 0x0e57}, /* Thai_lekchet */
+    {0x0df8, 0x0e58}, /* Thai_lekpaet */
+    {0x0df9, 0x0e59}, /* Thai_lekkao */
+    {0x13bc, 0x0152}, /* OE */
+    {0x13bd, 0x0153}, /* oe */
+    {0x13be, 0x0178}, /* Ydiaeresis */
+    {0x20a0, 0x20a0}, /* EcuSign */
+    {0x20a1, 0x20a1}, /* ColonSign */
+    {0x20a2, 0x20a2}, /* CruzeiroSign */
+    {0x20a3, 0x20a3}, /* FFrancSign */
+    {0x20a4, 0x20a4}, /* LiraSign */
+    {0x20a5, 0x20a5}, /* MillSign */
+    {0x20a6, 0x20a6}, /* NairaSign */
+    {0x20a7, 0x20a7}, /* PesetaSign */
+    {0x20a8, 0x20a8}, /* RupeeSign */
+    {0x20a9, 0x20a9}, /* WonSign */
+    {0x20aa, 0x20aa}, /* NewSheqelSign */
+    {0x20ab, 0x20ab}, /* DongSign */
+    {0x20ac, 0x20ac}, /* EuroSign */
+    {0x06ad, 0x0491}, /* Ukrainian_ghe_with_upturn */
+    {0x06bd, 0x0490}, /* Ukrainian_GHE_WITH_UPTURN */
+    {0x14a2, 0x0587}, /* Armenian_ligature_ew */
+    {0x14a3, 0x0589}, /* Armenian_verjaket */
+    {0x14aa, 0x055d}, /* Armenian_but */
+    {0x14ad, 0x058a}, /* Armenian_yentamna */
+    {0x14af, 0x055c}, /* Armenian_amanak */
+    {0x14b0, 0x055b}, /* Armenian_shesht */
+    {0x14b1, 0x055e}, /* Armenian_paruyk */
+    {0x14b2, 0x0531}, /* Armenian_AYB */
+    {0x14b3, 0x0561}, /* Armenian_ayb */
+    {0x14b4, 0x0532}, /* Armenian_BEN */
+    {0x14b5, 0x0562}, /* Armenian_ben */
+    {0x14b6, 0x0533}, /* Armenian_GIM */
+    {0x14b7, 0x0563}, /* Armenian_gim */
+    {0x14b8, 0x0534}, /* Armenian_DA */
+    {0x14b9, 0x0564}, /* Armenian_da */
+    {0x14ba, 0x0535}, /* Armenian_YECH */
+    {0x14bb, 0x0565}, /* Armenian_yech */
+    {0x14bc, 0x0536}, /* Armenian_ZA */
+    {0x14bd, 0x0566}, /* Armenian_za */
+    {0x14be, 0x0537}, /* Armenian_E */
+    {0x14bf, 0x0567}, /* Armenian_e */
+    {0x14c0, 0x0538}, /* Armenian_AT */
+    {0x14c1, 0x0568}, /* Armenian_at */
+    {0x14c2, 0x0539}, /* Armenian_TO */
+    {0x14c3, 0x0569}, /* Armenian_to */
+    {0x14c4, 0x053a}, /* Armenian_ZHE */
+    {0x14c5, 0x056a}, /* Armenian_zhe */
+    {0x14c6, 0x053b}, /* Armenian_INI */
+    {0x14c7, 0x056b}, /* Armenian_ini */
+    {0x14c8, 0x053c}, /* Armenian_LYUN */
+    {0x14c9, 0x056c}, /* Armenian_lyun */
+    {0x14ca, 0x053d}, /* Armenian_KHE */
+    {0x14cb, 0x056d}, /* Armenian_khe */
+    {0x14cc, 0x053e}, /* Armenian_TSA */
+    {0x14cd, 0x056e}, /* Armenian_tsa */
+    {0x14ce, 0x053f}, /* Armenian_KEN */
+    {0x14cf, 0x056f}, /* Armenian_ken */
+    {0x14d0, 0x0540}, /* Armenian_HO */
+    {0x14d1, 0x0570}, /* Armenian_ho */
+    {0x14d2, 0x0541}, /* Armenian_DZA */
+    {0x14d3, 0x0571}, /* Armenian_dza */
+    {0x14d4, 0x0542}, /* Armenian_GHAT */
+    {0x14d5, 0x0572}, /* Armenian_ghat */
+    {0x14d6, 0x0543}, /* Armenian_TCHE */
+    {0x14d7, 0x0573}, /* Armenian_tche */
+    {0x14d8, 0x0544}, /* Armenian_MEN */
+    {0x14d9, 0x0574}, /* Armenian_men */
+    {0x14da, 0x0545}, /* Armenian_HI */
+    {0x14db, 0x0575}, /* Armenian_hi */
+    {0x14dc, 0x0546}, /* Armenian_NU */
+    {0x14dd, 0x0576}, /* Armenian_nu */
+    {0x14de, 0x0547}, /* Armenian_SHA */
+    {0x14df, 0x0577}, /* Armenian_sha */
+    {0x14e0, 0x0548}, /* Armenian_VO */
+    {0x14e1, 0x0578}, /* Armenian_vo */
+    {0x14e2, 0x0549}, /* Armenian_CHA */
+    {0x14e3, 0x0579}, /* Armenian_cha */
+    {0x14e4, 0x054a}, /* Armenian_PE */
+    {0x14e5, 0x057a}, /* Armenian_pe */
+    {0x14e6, 0x054b}, /* Armenian_JE */
+    {0x14e7, 0x057b}, /* Armenian_je */
+    {0x14e8, 0x054c}, /* Armenian_RA */
+    {0x14e9, 0x057c}, /* Armenian_ra */
+    {0x14ea, 0x054d}, /* Armenian_SE */
+    {0x14eb, 0x057d}, /* Armenian_se */
+    {0x14ec, 0x054e}, /* Armenian_VEV */
+    {0x14ed, 0x057e}, /* Armenian_vev */
+    {0x14ee, 0x054f}, /* Armenian_TYUN */
+    {0x14ef, 0x057f}, /* Armenian_tyun */
+    {0x14f0, 0x0550}, /* Armenian_RE */
+    {0x14f1, 0x0580}, /* Armenian_re */
+    {0x14f2, 0x0551}, /* Armenian_TSO */
+    {0x14f3, 0x0581}, /* Armenian_tso */
+    {0x14f4, 0x0552}, /* Armenian_VYUN */
+    {0x14f5, 0x0582}, /* Armenian_vyun */
+    {0x14f6, 0x0553}, /* Armenian_PYUR */
+    {0x14f7, 0x0583}, /* Armenian_pyur */
+    {0x14f8, 0x0554}, /* Armenian_KE */
+    {0x14f9, 0x0584}, /* Armenian_ke */
+    {0x14fa, 0x0555}, /* Armenian_O */
+    {0x14fb, 0x0585}, /* Armenian_o */
+    {0x14fc, 0x0556}, /* Armenian_FE */
+    {0x14fd, 0x0586}, /* Armenian_fe */
+    {0x14fe, 0x055a}, /* Armenian_apostrophe */
+    {0x15d0, 0x10d0}, /* Georgian_an */
+    {0x15d1, 0x10d1}, /* Georgian_ban */
+    {0x15d2, 0x10d2}, /* Georgian_gan */
+    {0x15d3, 0x10d3}, /* Georgian_don */
+    {0x15d4, 0x10d4}, /* Georgian_en */
+    {0x15d5, 0x10d5}, /* Georgian_vin */
+    {0x15d6, 0x10d6}, /* Georgian_zen */
+    {0x15d7, 0x10d7}, /* Georgian_tan */
+    {0x15d8, 0x10d8}, /* Georgian_in */
+    {0x15d9, 0x10d9}, /* Georgian_kan */
+    {0x15da, 0x10da}, /* Georgian_las */
+    {0x15db, 0x10db}, /* Georgian_man */
+    {0x15dc, 0x10dc}, /* Georgian_nar */
+    {0x15dd, 0x10dd}, /* Georgian_on */
+    {0x15de, 0x10de}, /* Georgian_par */
+    {0x15df, 0x10df}, /* Georgian_zhar */
+    {0x15e0, 0x10e0}, /* Georgian_rae */
+    {0x15e1, 0x10e1}, /* Georgian_san */
+    {0x15e2, 0x10e2}, /* Georgian_tar */
+    {0x15e3, 0x10e3}, /* Georgian_un */
+    {0x15e4, 0x10e4}, /* Georgian_phar */
+    {0x15e5, 0x10e5}, /* Georgian_khar */
+    {0x15e6, 0x10e6}, /* Georgian_ghan */
+    {0x15e7, 0x10e7}, /* Georgian_qar */
+    {0x15e8, 0x10e8}, /* Georgian_shin */
+    {0x15e9, 0x10e9}, /* Georgian_chin */
+    {0x15ea, 0x10ea}, /* Georgian_can */
+    {0x15eb, 0x10eb}, /* Georgian_jil */
+    {0x15ec, 0x10ec}, /* Georgian_cil */
+    {0x15ed, 0x10ed}, /* Georgian_char */
+    {0x15ee, 0x10ee}, /* Georgian_xan */
+    {0x15ef, 0x10ef}, /* Georgian_jhan */
+    {0x15f0, 0x10f0}, /* Georgian_hae */
+    {0x15f1, 0x10f1}, /* Georgian_he */
+    {0x15f2, 0x10f2}, /* Georgian_hie */
+    {0x15f3, 0x10f3}, /* Georgian_we */
+    {0x15f4, 0x10f4}, /* Georgian_har */
+    {0x15f5, 0x10f5}, /* Georgian_hoe */
+    {0x15f6, 0x10f6}, /* Georgian_fi */
+    {0x12a1, 0x1e02}, /* Babovedot */
+    {0x12a2, 0x1e03}, /* babovedot */
+    {0x12a6, 0x1e0a}, /* Dabovedot */
+    {0x12a8, 0x1e80}, /* Wgrave */
+    {0x12aa, 0x1e82}, /* Wacute */
+    {0x12ab, 0x1e0b}, /* dabovedot */
+    {0x12ac, 0x1ef2}, /* Ygrave */
+    {0x12b0, 0x1e1e}, /* Fabovedot */
+    {0x12b1, 0x1e1f}, /* fabovedot */
+    {0x12b4, 0x1e40}, /* Mabovedot */
+    {0x12b5, 0x1e41}, /* mabovedot */
+    {0x12b7, 0x1e56}, /* Pabovedot */
+    {0x12b8, 0x1e81}, /* wgrave */
+    {0x12b9, 0x1e57}, /* pabovedot */
+    {0x12ba, 0x1e83}, /* wacute */
+    {0x12bb, 0x1e60}, /* Sabovedot */
+    {0x12bc, 0x1ef3}, /* ygrave */
+    {0x12bd, 0x1e84}, /* Wdiaeresis */
+    {0x12be, 0x1e85}, /* wdiaeresis */
+    {0x12bf, 0x1e61}, /* sabovedot */
+    {0x12d0, 0x0174}, /* Wcircumflex */
+    {0x12d7, 0x1e6a}, /* Tabovedot */
+    {0x12de, 0x0176}, /* Ycircumflex */
+    {0x12f0, 0x0175}, /* wcircumflex */
+    {0x12f7, 0x1e6b}, /* tabovedot */
+    {0x12fe, 0x0177}, /* ycircumflex */
+    {0x0590, 0x06f0}, /* Farsi_0 */
+    {0x0591, 0x06f1}, /* Farsi_1 */
+    {0x0592, 0x06f2}, /* Farsi_2 */
+    {0x0593, 0x06f3}, /* Farsi_3 */
+    {0x0594, 0x06f4}, /* Farsi_4 */
+    {0x0595, 0x06f5}, /* Farsi_5 */
+    {0x0596, 0x06f6}, /* Farsi_6 */
+    {0x0597, 0x06f7}, /* Farsi_7 */
+    {0x0598, 0x06f8}, /* Farsi_8 */
+    {0x0599, 0x06f9}, /* Farsi_9 */
+    {0x05a5, 0x066a}, /* Arabic_percent */
+    {0x05a6, 0x0670}, /* Arabic_superscript_alef */
+    {0x05a7, 0x0679}, /* Arabic_tteh */
+    {0x05a8, 0x067e}, /* Arabic_peh */
+    {0x05a9, 0x0686}, /* Arabic_tcheh */
+    {0x05aa, 0x0688}, /* Arabic_ddal */
+    {0x05ab, 0x0691}, /* Arabic_rreh */
+    {0x05ae, 0x06d4}, /* Arabic_fullstop */
+    {0x05b0, 0x0660}, /* Arabic_0 */
+    {0x05b1, 0x0661}, /* Arabic_1 */
+    {0x05b2, 0x0662}, /* Arabic_2 */
+    {0x05b3, 0x0663}, /* Arabic_3 */
+    {0x05b4, 0x0664}, /* Arabic_4 */
+    {0x05b5, 0x0665}, /* Arabic_5 */
+    {0x05b6, 0x0666}, /* Arabic_6 */
+    {0x05b7, 0x0667}, /* Arabic_7 */
+    {0x05b8, 0x0668}, /* Arabic_8 */
+    {0x05b9, 0x0669}, /* Arabic_9 */
+    {0x05f3, 0x0653}, /* Arabic_madda_above */
+    {0x05f4, 0x0654}, /* Arabic_hamza_above */
+    {0x05f5, 0x0655}, /* Arabic_hamza_below */
+    {0x05f6, 0x0698}, /* Arabic_jeh */
+    {0x05f7, 0x06a4}, /* Arabic_veh */
+    {0x05f8, 0x06a9}, /* Arabic_keheh */
+    {0x05f9, 0x06af}, /* Arabic_gaf */
+    {0x05fa, 0x06ba}, /* Arabic_noon_ghunna */
+    {0x05fb, 0x06be}, /* Arabic_heh_doachashmee */
+    {0x05fc, 0x06cc}, /* Farsi_yeh */
+    {0x05fd, 0x06d2}, /* Arabic_yeh_baree */
+    {0x05fe, 0x06c1}, /* Arabic_heh_goal */
+    {0x0680, 0x0492}, /* Cyrillic_GHE_bar */
+    {0x0681, 0x0496}, /* Cyrillic_ZHE_descender */
+    {0x0682, 0x049a}, /* Cyrillic_KA_descender */
+    {0x0683, 0x049c}, /* Cyrillic_KA_vertstroke */
+    {0x0684, 0x04a2}, /* Cyrillic_EN_descender */
+    {0x0685, 0x04ae}, /* Cyrillic_U_straight */
+    {0x0686, 0x04b0}, /* Cyrillic_U_straight_bar */
+    {0x0687, 0x04b2}, /* Cyrillic_HA_descender */
+    {0x0688, 0x04b6}, /* Cyrillic_CHE_descender */
+    {0x0689, 0x04b8}, /* Cyrillic_CHE_vertstroke */
+    {0x068a, 0x04ba}, /* Cyrillic_SHHA */
+    {0x068c, 0x04d8}, /* Cyrillic_SCHWA */
+    {0x068d, 0x04e2}, /* Cyrillic_I_macron */
+    {0x068e, 0x04e8}, /* Cyrillic_O_bar */
+    {0x068f, 0x04ee}, /* Cyrillic_U_macron */
+    {0x0690, 0x0493}, /* Cyrillic_ghe_bar */
+    {0x0691, 0x0497}, /* Cyrillic_zhe_descender */
+    {0x0692, 0x049b}, /* Cyrillic_ka_descender */
+    {0x0693, 0x049d}, /* Cyrillic_ka_vertstroke */
+    {0x0694, 0x04a3}, /* Cyrillic_en_descender */
+    {0x0695, 0x04af}, /* Cyrillic_u_straight */
+    {0x0696, 0x04b1}, /* Cyrillic_u_straight_bar */
+    {0x0697, 0x04b3}, /* Cyrillic_ha_descender */
+    {0x0698, 0x04b7}, /* Cyrillic_che_descender */
+    {0x0699, 0x04b9}, /* Cyrillic_che_vertstroke */
+    {0x069a, 0x04bb}, /* Cyrillic_shha */
+    {0x069c, 0x04d9}, /* Cyrillic_schwa */
+    {0x069d, 0x04e3}, /* Cyrillic_i_macron */
+    {0x069e, 0x04e9}, /* Cyrillic_o_bar */
+    {0x069f, 0x04ef}, /* Cyrillic_u_macron */
+    {0x16a3, 0x1e8a}, /* Xabovedot */
+    {0x16a6, 0x012c}, /* Ibreve */
+    {0x16a9, 0x01b5}, /* Zstroke */
+    {0x16aa, 0x01e6}, /* Gcaron */
+    {0x16af, 0x019f}, /* Obarred */
+    {0x16b3, 0x1e8b}, /* xabovedot */
+    {0x16b6, 0x012d}, /* ibreve */
+    {0x16b9, 0x01b6}, /* zstroke */
+    {0x16ba, 0x01e7}, /* gcaron */
+    {0x16bd, 0x01d2}, /* ocaron */
+    {0x16bf, 0x0275}, /* obarred */
+    {0x16c6, 0x018f}, /* SCHWA */
+    {0x16f6, 0x0259}, /* schwa */
+    {0x16d1, 0x1e36}, /* Lbelowdot */
+    {0x16e1, 0x1e37}, /* lbelowdot */
+    {0x1ea0, 0x1ea0}, /* Abelowdot */
+    {0x1ea1, 0x1ea1}, /* abelowdot */
+    {0x1ea2, 0x1ea2}, /* Ahook */
+    {0x1ea3, 0x1ea3}, /* ahook */
+    {0x1ea4, 0x1ea4}, /* Acircumflexacute */
+    {0x1ea5, 0x1ea5}, /* acircumflexacute */
+    {0x1ea6, 0x1ea6}, /* Acircumflexgrave */
+    {0x1ea7, 0x1ea7}, /* acircumflexgrave */
+    {0x1ea8, 0x1ea8}, /* Acircumflexhook */
+    {0x1ea9, 0x1ea9}, /* acircumflexhook */
+    {0x1eaa, 0x1eaa}, /* Acircumflextilde */
+    {0x1eab, 0x1eab}, /* acircumflextilde */
+    {0x1eac, 0x1eac}, /* Acircumflexbelowdot */
+    {0x1ead, 0x1ead}, /* acircumflexbelowdot */
+    {0x1eae, 0x1eae}, /* Abreveacute */
+    {0x1eaf, 0x1eaf}, /* abreveacute */
+    {0x1eb0, 0x1eb0}, /* Abrevegrave */
+    {0x1eb1, 0x1eb1}, /* abrevegrave */
+    {0x1eb2, 0x1eb2}, /* Abrevehook */
+    {0x1eb3, 0x1eb3}, /* abrevehook */
+    {0x1eb4, 0x1eb4}, /* Abrevetilde */
+    {0x1eb5, 0x1eb5}, /* abrevetilde */
+    {0x1eb6, 0x1eb6}, /* Abrevebelowdot */
+    {0x1eb7, 0x1eb7}, /* abrevebelowdot */
+    {0x1eb8, 0x1eb8}, /* Ebelowdot */
+    {0x1eb9, 0x1eb9}, /* ebelowdot */
+    {0x1eba, 0x1eba}, /* Ehook */
+    {0x1ebb, 0x1ebb}, /* ehook */
+    {0x1ebc, 0x1ebc}, /* Etilde */
+    {0x1ebd, 0x1ebd}, /* etilde */
+    {0x1ebe, 0x1ebe}, /* Ecircumflexacute */
+    {0x1ebf, 0x1ebf}, /* ecircumflexacute */
+    {0x1ec0, 0x1ec0}, /* Ecircumflexgrave */
+    {0x1ec1, 0x1ec1}, /* ecircumflexgrave */
+    {0x1ec2, 0x1ec2}, /* Ecircumflexhook */
+    {0x1ec3, 0x1ec3}, /* ecircumflexhook */
+    {0x1ec4, 0x1ec4}, /* Ecircumflextilde */
+    {0x1ec5, 0x1ec5}, /* ecircumflextilde */
+    {0x1ec6, 0x1ec6}, /* Ecircumflexbelowdot */
+    {0x1ec7, 0x1ec7}, /* ecircumflexbelowdot */
+    {0x1ec8, 0x1ec8}, /* Ihook */
+    {0x1ec9, 0x1ec9}, /* ihook */
+    {0x1eca, 0x1eca}, /* Ibelowdot */
+    {0x1ecb, 0x1ecb}, /* ibelowdot */
+    {0x1ecc, 0x1ecc}, /* Obelowdot */
+    {0x1ecd, 0x1ecd}, /* obelowdot */
+    {0x1ece, 0x1ece}, /* Ohook */
+    {0x1ecf, 0x1ecf}, /* ohook */
+    {0x1ed0, 0x1ed0}, /* Ocircumflexacute */
+    {0x1ed1, 0x1ed1}, /* ocircumflexacute */
+    {0x1ed2, 0x1ed2}, /* Ocircumflexgrave */
+    {0x1ed3, 0x1ed3}, /* ocircumflexgrave */
+    {0x1ed4, 0x1ed4}, /* Ocircumflexhook */
+    {0x1ed5, 0x1ed5}, /* ocircumflexhook */
+    {0x1ed6, 0x1ed6}, /* Ocircumflextilde */
+    {0x1ed7, 0x1ed7}, /* ocircumflextilde */
+    {0x1ed8, 0x1ed8}, /* Ocircumflexbelowdot */
+    {0x1ed9, 0x1ed9}, /* ocircumflexbelowdot */
+    {0x1eda, 0x1eda}, /* Ohornacute */
+    {0x1edb, 0x1edb}, /* ohornacute */
+    {0x1edc, 0x1edc}, /* Ohorngrave */
+    {0x1edd, 0x1edd}, /* ohorngrave */
+    {0x1ede, 0x1ede}, /* Ohornhook */
+    {0x1edf, 0x1edf}, /* ohornhook */
+    {0x1ee0, 0x1ee0}, /* Ohorntilde */
+    {0x1ee1, 0x1ee1}, /* ohorntilde */
+    {0x1ee2, 0x1ee2}, /* Ohornbelowdot */
+    {0x1ee3, 0x1ee3}, /* ohornbelowdot */
+    {0x1ee4, 0x1ee4}, /* Ubelowdot */
+    {0x1ee5, 0x1ee5}, /* ubelowdot */
+    {0x1ee6, 0x1ee6}, /* Uhook */
+    {0x1ee7, 0x1ee7}, /* uhook */
+    {0x1ee8, 0x1ee8}, /* Uhornacute */
+    {0x1ee9, 0x1ee9}, /* uhornacute */
+    {0x1eea, 0x1eea}, /* Uhorngrave */
+    {0x1eeb, 0x1eeb}, /* uhorngrave */
+    {0x1eec, 0x1eec}, /* Uhornhook */
+    {0x1eed, 0x1eed}, /* uhornhook */
+    {0x1eee, 0x1eee}, /* Uhorntilde */
+    {0x1eef, 0x1eef}, /* uhorntilde */
+    {0x1ef0, 0x1ef0}, /* Uhornbelowdot */
+    {0x1ef1, 0x1ef1}, /* uhornbelowdot */
+    {0x1ef4, 0x1ef4}, /* Ybelowdot */
+    {0x1ef5, 0x1ef5}, /* ybelowdot */
+    {0x1ef6, 0x1ef6}, /* Yhook */
+    {0x1ef7, 0x1ef7}, /* yhook */
+    {0x1ef8, 0x1ef8}, /* Ytilde */
+    {0x1ef9, 0x1ef9}, /* ytilde */
+    {0x1efa, 0x01a0}, /* Ohorn */
+    {0x1efb, 0x01a1}, /* ohorn */
+    {0x1efc, 0x01af}, /* Uhorn */
+    {0x1efd, 0x01b0}, /* uhorn */
+    {0, 0}
+};
+
+#endif
-- 
cgit v0.12


From 7cd41e727ae5601c5ef0782145198200c680b31d Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Fri, 24 Apr 2020 17:43:39 +0000
Subject: Fix [4fa083dd3f]: Should not set the caret position for a window
 which is not receiving key events.

---
 macosx/tkMacOSXKeyEvent.c | 49 ++++++++++++++++++++++-------------------------
 1 file changed, 23 insertions(+), 26 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 3b213c5..ec09306 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -650,15 +650,17 @@ TkMacOSXGetModalSession(void)
  *
  * Tk_SetCaretPos --
  *
- *	This enables correct placement of the XIM caret. This is called by
- *	widgets to indicate their cursor placement, and the caret location is
- *	used by TkpGetString to place the XIM caret.
+ *	This enables correct placement of the popups used for character
+ *      selection by the NSTextInputClient.  It gets called by text entry
+ *      widgets whenever the cursor is drawn.  It does nothing if the widget's
+ *      NSWindow is not the current KeyWindow.
  *
  * Results:
  *	None
  *
  * Side effects:
- *	None
+ *	May update the display's caret window as well as the static
+ *      variables caret_win, caret_x, caret_y and caret_height.
  *
  *----------------------------------------------------------------------
  */
@@ -670,28 +672,32 @@ Tk_SetCaretPos(
     int y,
     int height)
  {
-    TkCaret *caretPtr = &(((TkWindow *) tkwin)->dispPtr->caret);
-
-    /*
-     * Prevent processing anything if the values haven't changed. Windows only
-     * has one display, so we can do this with statics.
-     */
+    TkWindow *winPtr = (TkWindow *) tkwin;
+    TkCaret *caretPtr = &(winPtr->dispPtr->caret);
+    NSWindow *w = TkMacOSXDrawableWindow(Tk_WindowId(tkwin));
 
-    if ((caretPtr->winPtr == ((TkWindow *) tkwin))
-	    && (caretPtr->x == x) && (caretPtr->y == y)) {
+    if (w && ![w isKeyWindow]) {
 	return;
     }
-
-    caret_win = (TkWindow*) tkwin;
-    caretPtr->winPtr = ((TkWindow *) tkwin);
+    if ((caretPtr->winPtr == winPtr
+	 && caretPtr->x == x) && (caretPtr->y == y)) {
+	return;
+    }
+    caretPtr->winPtr = winPtr;
     caretPtr->x = x;
     caretPtr->y = y;
     caretPtr->height = height;
 
     /*
-     * As in Windows, adjust to the toplevel to get the coords right.
+     * Record the window and and the caret geometry in static variables for use
+     * when processing key events.  (Only caret windows use the NSTextClient
+     * protocol.)  We use the coordinate system of the containing toplevel's
+     * TKContextView for this.
      */
 
+    caret_win = winPtr;
+    caret_x = x;
+    caret_height = height;
     while (!Tk_IsTopLevel(tkwin)) {
 	x += Tk_X(tkwin);
 	y += Tk_Y(tkwin);
@@ -700,16 +706,7 @@ Tk_SetCaretPos(
 	    return;
 	}
     }
-
-    /*
-     * But adjust for fact that NS uses flipped view.
-     */
-
-    y = Tk_Height(tkwin) - y;
-
-    caret_x = x;
-    caret_y = y;
-    caret_height = height;
+    caret_y = Tk_Height(tkwin) - y;
 }
 
 /*
-- 
cgit v0.12


From e2124e344267e83ec932ceaf23e7ad39bef98b1a Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Fri, 24 Apr 2020 20:13:52 +0000
Subject: Add x, y, X and Y to key events.

---
 macosx/tkMacOSXKeyEvent.c   | 41 ++++++++++++++++++++++++++++++++++++++++-
 macosx/tkMacOSXMouseEvent.c |  3 +--
 2 files changed, 41 insertions(+), 3 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index ec09306..c5fb93b 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -16,6 +16,7 @@
 #include "tkMacOSXPrivate.h"
 #include "tkMacOSXInt.h"
 #include "tkMacOSXConstants.h"
+#include "tkMacOSXWm.h"
 
 /*
 #ifdef TK_MAC_DEBUG
@@ -33,6 +34,7 @@ static int caret_x = 0, caret_y = 0, caret_height = 0;
 static TkWindow *caret_win = NULL;
 
 static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
+static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
 #pragma mark TKApplication(TKKeyEvent)
 
@@ -190,9 +192,10 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
     default:
 	return theEvent; /* Unrecognized key event. */
     }
+    setXeventPoint(&xEvent, tkwin, w);
 
     /*
-     * Finally we can queue an XEvent, inserting a KeyRelease before a
+     * Finally we can queue the XEvent, inserting a KeyRelease before a
      * repeated KeyPress.
      */
 
@@ -258,6 +261,7 @@ static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
      */
 
     setupXEvent(&xEvent, tkwin, 0);
+    setXeventPoint(&xEvent, tkwin, [self window]);
     xEvent.xany.type = KeyPress;
 
     /*
@@ -546,6 +550,41 @@ setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers)
      * because of the memset() above. */
 }
 
+static void
+setXeventPoint(
+    XEvent *xEvent,
+    Tk_Window tkwin,
+    NSWindow *w)
+{
+    TkWindow *winPtr = (TkWindow *) tkwin;
+    NSPoint local = [w  mouseLocationOutsideOfEventStream];
+    NSPoint global = [w tkConvertPointToScreen: local];
+    int win_x, win_y;
+
+    if (Tk_IsEmbedded(winPtr)) {
+	TkWindow *contPtr = TkpGetOtherWindow(winPtr);
+	if (Tk_IsTopLevel(contPtr)) {
+	    local.x -= contPtr->wmInfoPtr->xInParent;
+	    local.y -= contPtr->wmInfoPtr->yInParent;
+	} else {
+	    TkWindow *topPtr = TkMacOSXGetHostToplevel(winPtr)->winPtr;
+	    local.x -= (topPtr->wmInfoPtr->xInParent + contPtr->changes.x);
+	    local.y -= (topPtr->wmInfoPtr->yInParent + contPtr->changes.y);
+	}
+    } else {
+	local.x -= winPtr->wmInfoPtr->xInParent;
+	local.y -= winPtr->wmInfoPtr->yInParent;
+    }
+    tkwin = Tk_TopCoordsToWindow(tkwin, local.x, local.y, &win_x, &win_y);
+    local.x = win_x;
+    local.y = win_y;
+    global.y = TkMacOSXZeroScreenHeight() - global.y;
+    xEvent->xbutton.x = local.x;
+    xEvent->xbutton.y = local.y;
+    xEvent->xbutton.x_root = global.x;
+    xEvent->xbutton.y_root = global.y;
+}
+
 #pragma mark -
 
 /*
diff --git a/macosx/tkMacOSXMouseEvent.c b/macosx/tkMacOSXMouseEvent.c
index dd50d0a..d475dbc 100644
--- a/macosx/tkMacOSXMouseEvent.c
+++ b/macosx/tkMacOSXMouseEvent.c
@@ -123,7 +123,6 @@ enum {
 	    }
 	}
 	local.y = [eventWindow frame].size.height - local.y;
-	global.y = TkMacOSXZeroScreenHeight() - global.y;
     } else {
 
 	/*
@@ -143,7 +142,6 @@ enum {
 	}
 	local = [eventWindow tkConvertPointFromScreen: global];
 	local.y = [eventWindow frame].size.height - local.y;
-	global.y = TkMacOSXZeroScreenHeight() - global.y;
     }
 
     /*
@@ -222,6 +220,7 @@ enum {
     tkwin = Tk_TopCoordsToWindow(tkwin, local.x, local.y, &win_x, &win_y);
     local.x = win_x;
     local.y = win_y;
+    global.y = TkMacOSXZeroScreenHeight() - global.y;
 
     /*
      *  Generate an XEvent for this mouse event.
-- 
cgit v0.12


From de18de90226a68036c113f30c249135bc0afe72b Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Fri, 24 Apr 2020 22:28:09 +0000
Subject: Add keysym data for Menu and keypad.

---
 macosx/tkMacOSXKeysyms.h | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/macosx/tkMacOSXKeysyms.h b/macosx/tkMacOSXKeysyms.h
index 6f54406..870c662 100644
--- a/macosx/tkMacOSXKeysyms.h
+++ b/macosx/tkMacOSXKeysyms.h
@@ -31,9 +31,9 @@
  */
 
 typedef struct {
-    int virtual;	       /* value of [NSEvent keyCode] */
-    KeySym keysym;	       /* X11 keysym */
-    KeyCode keychar;           /* XEvent keycode & 0xFFFF */
+    int virtual;	/* value of [NSEvent keyCode] */
+    KeySym keysym;	/* X11 keysym */
+    KeyCode keychar;	/* XEvent keycode & 0xFFFF */
 } KeyInfo;
 
 static const KeyInfo keyArray[] = {
@@ -52,11 +52,27 @@ static const KeyInfo keyArray[] = {
     {61,	XK_Alt_R,	XK_Alt_R},
     {62,	XK_Control_R,	XK_Control_R},
     {63,	XK_Super_L,	XK_Super_L},
+    {65,	XK_KP_Decimal,	'.'},
+    {67,	XK_KP_Multiply, '*'},
+    {69,	XK_KP_Add,	'+'},
     {71,	XK_Clear,       NSClearLineFunctionKey}, /* Numlock on PC */
+    {75,	XK_KP_Divide,   '/'},
     {76,	XK_KP_Enter,	NSEnterCharacter},       /* Fn Return */
+    {78,	XK_KP_Subtract, '-'},
     {79,	XK_F18,		NSF18FunctionKey},
     {80,	XK_F19,		NSF19FunctionKey},
+    {81,	XK_KP_Equal,	'='},
+    {82,	XK_KP_0,	'0'},
+    {83,	XK_KP_1,	'1'},
+    {84,	XK_KP_2,	'2'},
+    {85,	XK_KP_3,	'3'},
+    {86,	XK_KP_4,	'4'},
+    {87,	XK_KP_5,	'5'},
+    {88,	XK_KP_6,	'6'},
+    {89,	XK_KP_7,	'7'},
     {90,	XK_F20,		NSF20FunctionKey}, /* For scripting only */
+    {91,	XK_KP_8,	'8'},
+    {92,	XK_KP_9,	'9'},
     {96,	XK_F5,		NSF5FunctionKey},
     {97,	XK_F6,		NSF6FunctionKey},
     {98,	XK_F7,		NSF7FunctionKey},
@@ -68,6 +84,7 @@ static const KeyInfo keyArray[] = {
     {106,	XK_F16,		NSF16FunctionKey},
     {107,	XK_F14,		NSF14FunctionKey},
     {109,	XK_F10,		NSF10FunctionKey},
+    {110,       XK_Menu,	XK_Menu},
     {111,	XK_F12,		NSF12FunctionKey},
     {113,	XK_F15,		NSF15FunctionKey},
     {114,	XK_Help,	NSHelpFunctionKey},
-- 
cgit v0.12


From 9ece90e358fbcd016729d578752b90b9f0179d18 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Sat, 25 Apr 2020 01:38:30 +0000
Subject: Restore F17 which was accidentally deleted when moving the KeyArray
 to a header file.

---
 macosx/tkMacOSXKeysyms.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/macosx/tkMacOSXKeysyms.h b/macosx/tkMacOSXKeysyms.h
index 870c662..91dd760 100644
--- a/macosx/tkMacOSXKeysyms.h
+++ b/macosx/tkMacOSXKeysyms.h
@@ -52,6 +52,7 @@ static const KeyInfo keyArray[] = {
     {61,	XK_Alt_R,	XK_Alt_R},
     {62,	XK_Control_R,	XK_Control_R},
     {63,	XK_Super_L,	XK_Super_L},
+    {64,	XK_F17,		NSF17FunctionKey},
     {65,	XK_KP_Decimal,	'.'},
     {67,	XK_KP_Multiply, '*'},
     {69,	XK_KP_Add,	'+'},
-- 
cgit v0.12


From ae80e8949fa3f011cd23c2dabffa04b3837b9e70 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Sat, 25 Apr 2020 13:35:14 +0000
Subject: Fix a logic error that broke IME and remove the static caret_win
 variable.

---
 macosx/tkMacOSXKeyEvent.c | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index c5fb93b..46db914 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -31,7 +31,6 @@ static NSModalSession modalSession = nil;
 static BOOL processingCompose = NO;
 static Tk_Window composeWin = NULL;
 static int caret_x = 0, caret_y = 0, caret_height = 0;
-static TkWindow *caret_win = NULL;
 
 static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
@@ -47,6 +46,7 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 #endif
     NSWindow *w = [theEvent window];
     TkWindow *winPtr = TkMacOSXGetTkWindow(w), *grabWinPtr;
+    TkCaret caret = winPtr->dispPtr->caret;
     Tk_Window tkwin = (Tk_Window) winPtr;
     NSEventType type = [theEvent type];
     NSUInteger keyCode = [theEvent keyCode];
@@ -115,7 +115,8 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
     setupXEvent(&xEvent, tkwin, modifiers);
     has_modifiers = xEvent.xkey.state & XEVENT_MOD_MASK;
-    has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret_win);
+    has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret.winPtr);
+
 
     /*
      * A KeyDown event targeting the caret window and having an alphanumeric
@@ -123,10 +124,13 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * be sent in this case.
      */
 
-    if (type == NSKeyDown && has_caret && !has_modifiers &&
-	(keychar >= 0x0020) && (keychar <= 0xF700)) {
+    if (processingCompose ||
+	(type == NSKeyDown && has_caret && !has_modifiers &&
+	     (keychar >= 0x0020) && (keychar < 0xF700))
+	) {
 	use_text_input = YES;
     }
+    
     if (use_text_input) {
 #if (NS_KEYLOG)
 	TKLog(@"keyDown: %s compose sequence.\n",
@@ -692,14 +696,16 @@ TkMacOSXGetModalSession(void)
  *	This enables correct placement of the popups used for character
  *      selection by the NSTextInputClient.  It gets called by text entry
  *      widgets whenever the cursor is drawn.  It does nothing if the widget's
- *      NSWindow is not the current KeyWindow.
+ *      NSWindow is not the current KeyWindow.  Otherwise it udpates the
+ *      display's caret structure and records the caret geometry in static
+ *      variables for use by the NSTextInputClient implementation.
  *
  * Results:
  *	None
  *
  * Side effects:
- *	May update the display's caret window as well as the static
- *      variables caret_win, caret_x, caret_y and caret_height.
+ *	May update the display's caret structure as well as the static
+ *      variables caret_x, caret_y and caret_height.
  *
  *----------------------------------------------------------------------
  */
@@ -728,13 +734,11 @@ Tk_SetCaretPos(
     caretPtr->height = height;
 
     /*
-     * Record the window and and the caret geometry in static variables for use
-     * when processing key events.  (Only caret windows use the NSTextClient
-     * protocol.)  We use the coordinate system of the containing toplevel's
+     * Record the caret geometry in static variables for use when processing
+     * key events.  We use the coordinate system of the containing toplevel's
      * TKContextView for this.
      */
 
-    caret_win = winPtr;
     caret_x = x;
     caret_height = height;
     while (!Tk_IsTopLevel(tkwin)) {
-- 
cgit v0.12


From ba16fcc0988a8dbdd54e7ed66b2622b1fb1fcc73 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Sat, 25 Apr 2020 19:16:36 +0000
Subject: Fixing IME broke Latin1; make both work. Use a flag so deciding
 whether to use the TextInputClient will be more robust.

---
 generic/tk.h              |  6 +++
 macosx/tkMacOSXKeyEvent.c | 98 +++++++++++++++++++++++++++++------------------
 2 files changed, 66 insertions(+), 38 deletions(-)

diff --git a/generic/tk.h b/generic/tk.h
index ce5902d..01f3657 100644
--- a/generic/tk.h
+++ b/generic/tk.h
@@ -884,6 +884,10 @@ typedef struct Tk_FakeWin {
  *				window.
  * TK_WM_MANAGEABLE		1 marks a window as capable of being converted
  *				into a toplevel using [wm manage].
+ * TK_CAN_INPUT_TEXT            1 means that this window accepts text input.
+ *                              Used on macOS to indicate that key events can be
+ *                              processed with the NSTextInputClient protocol.
+ *                              Not currently accessible through the public API.
  */
 
 #define TK_MAPPED		1
@@ -897,6 +901,7 @@ typedef struct Tk_FakeWin {
 #define TK_EMBEDDED		0x100
 #define TK_CONTAINER		0x200
 #define TK_BOTH_HALVES		0x400
+
 #define TK_WRAPPER		0x1000
 #define TK_REPARENTED		0x2000
 #define TK_ANONYMOUS_WINDOW	0x4000
@@ -905,6 +910,7 @@ typedef struct Tk_FakeWin {
 #define TK_TOP_HIERARCHY	0x20000
 #define TK_PROP_PROPCHANGE	0x40000
 #define TK_WM_MANAGEABLE	0x80000
+#define TK_CAN_INPUT_TEXT       0x100000
 
 /*
  *----------------------------------------------------------------------
diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 46db914..5f10e87 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -45,18 +45,15 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, theEvent);
 #endif
     NSWindow *w = [theEvent window];
-    TkWindow *winPtr = TkMacOSXGetTkWindow(w), *grabWinPtr;
-    TkCaret caret = winPtr->dispPtr->caret;
+    TkWindow *winPtr = TkMacOSXGetTkWindow(w), *grabWinPtr, *focusWinPtr;
     Tk_Window tkwin = (Tk_Window) winPtr;
     NSEventType type = [theEvent type];
-    NSUInteger keyCode = [theEvent keyCode];
+    NSUInteger virtual = [theEvent keyCode];
     NSUInteger modifiers = ([theEvent modifierFlags] &
 			    NSDeviceIndependentModifierFlagsMask);
     XEvent xEvent;
-    Bool has_modifiers = NO;
-    Bool has_caret = NO;
-    Bool use_text_input = NO;
     UniChar keychar = 0;
+    Bool can_input_text, has_modifiers = NO, use_text_input = NO;
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray = nil;
 
@@ -79,7 +76,8 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     if (grabWinPtr) {
 	if (winPtr->dispPtr->grabFlags ||  /* global grab */
 	    grabWinPtr->mainPtr == winPtr->mainPtr){ /* same application */
-	    tkwin = (Tk_Window) winPtr->dispPtr->focusPtr;
+	    winPtr =winPtr->dispPtr->focusPtr;
+	    tkwin = (Tk_Window) winPtr;
 	}
     }
 
@@ -103,20 +101,20 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	TKLog(@"-[%@(%p) %s] repeat=%d mods=%x char=%x code=%lu c=%d type=%d",
 	      [self class], self, _cmd,
 	      (type == NSKeyDown) && [theEvent isARepeat], modifiers, keychar,
-	      keyCode, w, type);
+	      virtual, w, type);
 #endif
     }
 
     /*
      * Build a skeleton XEvent.  We need to build it here, even if we will not
      * send it, so we can pass it to TkFocusKeyEvent to determine whether the
-     * target window has the caret.
+     * target widget can input text.
      */
 
     setupXEvent(&xEvent, tkwin, modifiers);
+    focusWinPtr = TkFocusKeyEvent(winPtr, &xEvent);
     has_modifiers = xEvent.xkey.state & XEVENT_MOD_MASK;
-    has_caret = (TkFocusKeyEvent(winPtr, &xEvent) == caret.winPtr);
-
+    can_input_text = ((focusWinPtr->flags & TK_CAN_INPUT_TEXT) != 0);
 
     /*
      * A KeyDown event targeting the caret window and having an alphanumeric
@@ -124,39 +122,48 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * be sent in this case.
      */
 
+#if (NS_KEYLOG)
+    TKLog(@"keyDown: %s compose sequence.\n",
+	  processingCompose == YES ? "Continue" : "Begin");
+#endif
+
     if (processingCompose ||
-	(type == NSKeyDown && has_caret && !has_modifiers &&
-	     (keychar >= 0x0020) && (keychar < 0xF700))
+	(type == NSKeyDown && can_input_text && !has_modifiers &&
+	 (keychar >= 0x0020) && (keychar < 0xF700))
 	) {
 	use_text_input = YES;
     }
-    
     if (use_text_input) {
-#if (NS_KEYLOG)
-	TKLog(@"keyDown: %s compose sequence.\n",
-	      processingCompose == YES ? "Continue" : "Begin");
-#endif
 
 	/*
-	 * Call our interpretKeyEvents method to handle the event as a
-	 * TextInputClient.  When the composition sequence is complete, our
+	 * Call our interpretKeyEvents method to handle the event as an
+	 * NSTextInputClient.  When the composition sequence is complete, our
 	 * implementation of insertText: replacementRange will be called.  That
-	 * method generates a keyPress XEvent with the selected character.  In
-	 * IME when multiple characters have the same composition sequence and
-	 * the selected character is not the default it may be necessary to hit
-	 * the Enter key multiple times before the character is accepted and
-	 * rendered (See ticket 39de9677aa]). So we repeatedly send Enter key
-	 * events until the inputText method has cleared the processingCompose
-	 * flag.
+	 * method generates a keyPress XEvent with the selected character.
 	 */
 
-	processingCompose = YES;
-	while(processingCompose) {
+	if (!processingCompose) {
 	    [nsEvArray addObject: theEvent];
 	    [[w contentView] interpretKeyEvents: nsEvArray];
 	    [nsEvArray removeObject: theEvent];
-	    if ([theEvent keyCode] != 36) {
-		break;
+	} else {
+
+	    /*
+	     * In IME when there are multiple choices with the same composition
+	     * sequence and the selected choice is not the default it may be
+	     * necessary to hit the Enter key twice before the character is
+	     * accepted and rendered (See ticket 39de9677aa]). So when sending
+	     * an Enter key, we continue sending Enter keys until the inputText
+	     * method has cleared the processingCompose flag.
+	     */
+
+	    while(processingCompose) {
+		[nsEvArray addObject: theEvent];
+		[[w contentView] interpretKeyEvents: nsEvArray];
+		[nsEvArray removeObject: theEvent];
+		if ([theEvent keyCode] != 36) {
+		    break;
+		}
 	    }
 	}
 	return theEvent;
@@ -166,7 +173,7 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * We need to send an XEvent.  Finish constructing it.
      */
 
-    xEvent.xkey.keycode = (keyCode << 16) | keychar;
+    xEvent.xkey.keycode = (virtual << 16) | keychar;
     switch (type) {
     case NSFlagsChanged:
 
@@ -208,6 +215,8 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
 	xEvent.xany.type = KeyPress;
     }
+    if (xEvent.xany.type == KeyPress) {
+    }
     Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
     return theEvent;
 }
@@ -334,7 +343,6 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
     str = ([aString isKindOfClass: [NSAttributedString class]]) ?
         [aString string] : aString;
-
     if (focusWin) {
 
 	/*
@@ -698,14 +706,17 @@ TkMacOSXGetModalSession(void)
  *      widgets whenever the cursor is drawn.  It does nothing if the widget's
  *      NSWindow is not the current KeyWindow.  Otherwise it udpates the
  *      display's caret structure and records the caret geometry in static
- *      variables for use by the NSTextInputClient implementation.
+ *      variables for use by the NSTextInputClient implementation.  Any
+ *      widget passed to this function will be marked as being able to input
+ *      text by setting the TK_CAN_INPUT_TEXT flag.
  *
  * Results:
  *	None
  *
  * Side effects:
- *	May update the display's caret structure as well as the static
- *      variables caret_x, caret_y and caret_height.
+ *      Sets the CAN_INPUT_TEXT flag on the widget passed as tkwin.  May update
+ *      the display's caret structure as well as the static variables caret_x,
+ *      caret_y and caret_height.
  *
  *----------------------------------------------------------------------
  */
@@ -721,6 +732,13 @@ Tk_SetCaretPos(
     TkCaret *caretPtr = &(winPtr->dispPtr->caret);
     NSWindow *w = TkMacOSXDrawableWindow(Tk_WindowId(tkwin));
 
+    /*
+     * Register this widget as being capable of text input, so we know we
+     * should process (appropriate) key events for this window with the
+     * NSTextInputClient protocol.
+     */
+
+    winPtr->flags |= TK_CAN_INPUT_TEXT;
     if (w && ![w isKeyWindow]) {
 	return;
     }
@@ -728,6 +746,11 @@ Tk_SetCaretPos(
 	 && caretPtr->x == x) && (caretPtr->y == y)) {
 	return;
     }
+
+    /*
+     * Update the display's caret information.
+     */
+
     caretPtr->winPtr = winPtr;
     caretPtr->x = x;
     caretPtr->y = y;
@@ -735,8 +758,7 @@ Tk_SetCaretPos(
 
     /*
      * Record the caret geometry in static variables for use when processing
-     * key events.  We use the coordinate system of the containing toplevel's
-     * TKContextView for this.
+     * key events.  We use the TKContextView coordinate system for this.
      */
 
     caret_x = x;
-- 
cgit v0.12


From 775dc1fe237adc2f793bf9b1e6af1061db3719f9 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Sat, 25 Apr 2020 22:05:32 +0000
Subject: Remove no-op bindings for function keys and set trans_chars
 appropriately.

---
 library/tk.tcl            |  2 --
 macosx/tkMacOSXKeyEvent.c | 13 ++++++++++++-
 macosx/tkMacOSXKeyboard.c | 16 +++++++++++++---
 3 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/library/tk.tcl b/library/tk.tcl
index 87e0586..421bac8 100644
--- a/library/tk.tcl
+++ b/library/tk.tcl
@@ -462,8 +462,6 @@ switch -exact -- [tk windowingsystem] {
 	# Official bindings
 	# See http://support.apple.com/kb/HT1343
 	event add <<SelectAll>>		<Command-Key-a>
-	#Attach function keys not otherwise assigned to this event so they no-op - workaround for bug 0e6930dfe7
-	event add <<SelectNone>>	<Option-Command-Key-a> <Key-F5> <Key-F1> <Key-F5> <Key-F6> <Key-F7> <Key-F8> <Key-F9> <Key-F10> <Key-F11> <Key-F12>
 	event add <<Undo>>		<Command-Key-z> <Command-Lock-Key-Z>
 	event add <<Redo>>		<Shift-Command-Key-z> <Shift-Command-Lock-Key-z>
 	event add <<NextChar>>		<Right> <Control-Key-f> <Control-Lock-Key-F>
diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 5f10e87..5f21853 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -54,6 +54,7 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     XEvent xEvent;
     UniChar keychar = 0;
     Bool can_input_text, has_modifiers = NO, use_text_input = NO;
+    int length = 0;
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray = nil;
 
@@ -192,6 +193,7 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	 * key, as a signal to TkpGetKeySym (see tkMacOSXKeyboard.c) that this
 	 * is a modifier key event.
 	 */
+
 	xEvent.xkey.keycode |= 0xF8FF;
 	break;
     case NSKeyUp:
@@ -203,9 +205,18 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     default:
 	return theEvent; /* Unrecognized key event. */
     }
-    setXeventPoint(&xEvent, tkwin, w);
 
     /*
+     * Set the trans_chars for keychars outside of the private-use range.
+     */
+    
+    setXeventPoint(&xEvent, tkwin, w);
+    if (keychar < 0xF700) {
+	length = TkUniCharToUtf(keychar, xEvent.xkey.trans_chars);
+    }
+    xEvent.xkey.trans_chars[length] = 0;
+    
+    /*
      * Finally we can queue the XEvent, inserting a KeyRelease before a
      * repeated KeyPress.
      */
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index a2fdfd6..a628953 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -554,11 +554,21 @@ TkpSetKeycodeAndState(
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
     } else {
-	int state;
+	int state, length = 0;
+	UniChar keychar;
 	Display *display = Tk_Display(tkwin);
-	eventPtr->xkey.keycode = XKeysymToKeycodeWithState(display, keysym, &state);
+	eventPtr->xkey.keycode = XKeysymToKeycodeWithState(display, keysym,
+							   &state);
 	eventPtr->xkey.state |= state;
-	int length = TkUniCharToUtf(keysym, eventPtr->xkey.trans_chars);
+	keychar = eventPtr->xkey.keycode & 0xFFFF;
+	
+	/*
+	 * Set trans_chars for keychars outside of the private-use range.
+	 */
+
+	if (keychar < 0xF700) {
+	    length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
+	}
 	eventPtr->xkey.trans_chars[length] = 0;
     }
 }
-- 
cgit v0.12


From 1b713f4b0328104285771bb1ddd781feacebea38 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Sat, 25 Apr 2020 22:51:10 +0000
Subject: Prevent a crash in setXEventPoint by checking for NULL wmInfoPtr

---
 macosx/tkMacOSXKeyEvent.c | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 5f21853..1b3d8a9 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -33,7 +33,7 @@ static Tk_Window composeWin = NULL;
 static int caret_x = 0, caret_y = 0, caret_height = 0;
 
 static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
-static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
+static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
 #pragma mark TKApplication(TKKeyEvent)
 
@@ -210,7 +210,7 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * Set the trans_chars for keychars outside of the private-use range.
      */
     
-    setXeventPoint(&xEvent, tkwin, w);
+    setXEventPoint(&xEvent, tkwin, w);
     if (keychar < 0xF700) {
 	length = TkUniCharToUtf(keychar, xEvent.xkey.trans_chars);
     }
@@ -285,7 +285,7 @@ static void setXeventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     setupXEvent(&xEvent, tkwin, 0);
-    setXeventPoint(&xEvent, tkwin, [self window]);
+    setXEventPoint(&xEvent, tkwin, [self window]);
     xEvent.xany.type = KeyPress;
 
     /*
@@ -551,6 +551,8 @@ static void
 setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers)
 {
     unsigned int state = 0;
+    Display *display = Tk_Display(tkwin);
+
     if (modifiers) {
 	state = (modifiers & NSAlphaShiftKeyMask ? LockMask    : 0) |
 	        (modifiers & NSShiftKeyMask      ? ShiftMask   : 0) |
@@ -561,11 +563,11 @@ setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers)
 	        (modifiers & NSFunctionKeyMask   ? Mod4Mask    : 0) ;
     }
     memset(xEvent, 0, sizeof(XEvent));
-    xEvent->xany.serial = LastKnownRequestProcessed(Tk_Display(tkwin));
+    xEvent->xany.serial = LastKnownRequestProcessed(display);
     xEvent->xany.display = Tk_Display(tkwin);
     xEvent->xany.window = Tk_WindowId(tkwin);
 
-    xEvent->xkey.root = XRootWindow(Tk_Display(tkwin), 0);
+    xEvent->xkey.root = XRootWindow(display, 0);
     xEvent->xkey.time = TkpGetMS();
     xEvent->xkey.state = state;
     xEvent->xkey.same_screen = true;
@@ -574,7 +576,7 @@ setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers)
 }
 
 static void
-setXeventPoint(
+setXEventPoint(
     XEvent *xEvent,
     Tk_Window tkwin,
     NSWindow *w)
@@ -594,7 +596,7 @@ setXeventPoint(
 	    local.x -= (topPtr->wmInfoPtr->xInParent + contPtr->changes.x);
 	    local.y -= (topPtr->wmInfoPtr->yInParent + contPtr->changes.y);
 	}
-    } else {
+    } else if (winPtr->wmInfoPtr != NULL) {
 	local.x -= winPtr->wmInfoPtr->xInParent;
 	local.y -= winPtr->wmInfoPtr->yInParent;
     }
-- 
cgit v0.12


From 551859ab46ad0d92f0097687308150befab95217 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Sun, 26 Apr 2020 03:07:31 +0000
Subject: Figured out how to make empty trans_chars, and dealt with menu and
 control characters.

---
 macosx/tkMacOSXKeyEvent.c | 6 ++++--
 macosx/tkMacOSXKeyboard.c | 6 ++++--
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 1b3d8a9..109c774 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -211,10 +211,12 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
     
     setXEventPoint(&xEvent, tkwin, w);
-    if (keychar < 0xF700) {
+    if ((keychar >= 0x20) && (keychar < 0xF700)) {
 	length = TkUniCharToUtf(keychar, xEvent.xkey.trans_chars);
+	xEvent.xkey.trans_chars[length] = 0;
+    } else {
+	    xEvent.xkey.nbytes = 0;
     }
-    xEvent.xkey.trans_chars[length] = 0;
     
     /*
      * Finally we can queue the XEvent, inserting a KeyRelease before a
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index a628953..00b8715 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -566,10 +566,12 @@ TkpSetKeycodeAndState(
 	 * Set trans_chars for keychars outside of the private-use range.
 	 */
 
-	if (keychar < 0xF700) {
+	if ((keychar >= 0x20) && (keychar < 0xF700)) {
 	    length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
+	    eventPtr->xkey.trans_chars[length] = 0;
+	} else {
+	    eventPtr->xkey.nbytes = 0;
 	}
-	eventPtr->xkey.trans_chars[length] = 0;
     }
 }
 
-- 
cgit v0.12


From 022c2fd5dc1cc83cc6606d7e83495af76e8bdbd8 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Sun, 26 Apr 2020 22:12:52 +0000
Subject: Tidy up; expand comments; clarify NSTextInputClient logic; deal with
 keyPad buttons.

---
 macosx/tkMacOSXKeyEvent.c |  76 ++++++++--------
 macosx/tkMacOSXKeyboard.c | 221 ++++++++++++++++++++++++++++++----------------
 2 files changed, 182 insertions(+), 115 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 109c774..fe71ea9 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -17,6 +17,7 @@
 #include "tkMacOSXInt.h"
 #include "tkMacOSXConstants.h"
 #include "tkMacOSXWm.h"
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar < 0xF700))
 
 /*
 #ifdef TK_MAC_DEBUG
@@ -54,7 +55,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     XEvent xEvent;
     UniChar keychar = 0;
     Bool can_input_text, has_modifiers = NO, use_text_input = NO;
-    int length = 0;
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray = nil;
 
@@ -117,64 +117,63 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     has_modifiers = xEvent.xkey.state & XEVENT_MOD_MASK;
     can_input_text = ((focusWinPtr->flags & TK_CAN_INPUT_TEXT) != 0);
 
-    /*
-     * A KeyDown event targeting the caret window and having an alphanumeric
-     * keychar should be processed by our TextInputClient.  The XEvent will not
-     * be sent in this case.
-     */
-
 #if (NS_KEYLOG)
     TKLog(@"keyDown: %s compose sequence.\n",
 	  processingCompose == YES ? "Continue" : "Begin");
 #endif
 
+    /*
+     * Decide whether this event should be processed with the NSTextInputClient
+     * protocol.
+     */
+
     if (processingCompose ||
 	(type == NSKeyDown && can_input_text && !has_modifiers &&
-	 (keychar >= 0x0020) && (keychar < 0xF700))
+	 IS_PRINTABLE(keychar))
 	) {
 	use_text_input = YES;
     }
+
+    /*
+     * If we are processing this KeyDown event as an NSTextInputClient we do
+     * not queue an XEvent.  We pass the NSEvent to our interpretKeyEvents
+     * method.  When the composition sequence is complete, the callback method
+     * insertText: replacementRange will be called.  That method generates a
+     * keyPress XEvent with the selected character.
+     */
+
     if (use_text_input) {
 
 	/*
-	 * Call our interpretKeyEvents method to handle the event as an
-	 * NSTextInputClient.  When the composition sequence is complete, our
-	 * implementation of insertText: replacementRange will be called.  That
-	 * method generates a keyPress XEvent with the selected character.
+	 * In IME the Enter key is used to terminate a composition sequence.
+	 * when there are multiple choices of input text available, and the
+	 * user's selected choice is not the default it may be necessary to hit
+	 * the Enter key multiple times before the text is accepted and
+	 * rendered (See ticket 39de9677aa]). So when sending an Enter key
+	 * during composition, we continue sending Enter keys until the
+	 * inputText method has cleared the processingCompose flag.
 	 */
 
-	if (!processingCompose) {
+	if (processingCompose && [theEvent keyCode] == 36) {
 	    [nsEvArray addObject: theEvent];
-	    [[w contentView] interpretKeyEvents: nsEvArray];
-	    [nsEvArray removeObject: theEvent];
-	} else {
-
-	    /*
-	     * In IME when there are multiple choices with the same composition
-	     * sequence and the selected choice is not the default it may be
-	     * necessary to hit the Enter key twice before the character is
-	     * accepted and rendered (See ticket 39de9677aa]). So when sending
-	     * an Enter key, we continue sending Enter keys until the inputText
-	     * method has cleared the processingCompose flag.
-	     */
-
 	    while(processingCompose) {
-		[nsEvArray addObject: theEvent];
 		[[w contentView] interpretKeyEvents: nsEvArray];
-		[nsEvArray removeObject: theEvent];
-		if ([theEvent keyCode] != 36) {
-		    break;
-		}
 	    }
+	    [nsEvArray removeObject: theEvent];
+	} else {
+	    [nsEvArray addObject: theEvent];
+	    [[w contentView] interpretKeyEvents: nsEvArray];
+	    [nsEvArray removeObject: theEvent];
 	}
 	return theEvent;
     }
 
     /*
-     * We need to send an XEvent.  Finish constructing it.
+     * We are not handling this event as an NSTextInputClient, so we need to
+     * finish constructing the XEvent and queue it.
      */
 
-    xEvent.xkey.keycode = (virtual << 16) | keychar;
+    xEvent.xkey.keycode = (virtual << 24) | keychar;
     switch (type) {
     case NSFlagsChanged:
 
@@ -209,15 +208,14 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     /*
      * Set the trans_chars for keychars outside of the private-use range.
      */
-    
+
     setXEventPoint(&xEvent, tkwin, w);
-    if ((keychar >= 0x20) && (keychar < 0xF700)) {
-	length = TkUniCharToUtf(keychar, xEvent.xkey.trans_chars);
+    if (IS_PRINTABLE(keychar)) {
+	xEvent.xkey.nbytes = 0;  /* This string is null-terminated. */
+	int length = TkUniCharToUtf(keychar, xEvent.xkey.trans_chars);
 	xEvent.xkey.trans_chars[length] = 0;
-    } else {
-	    xEvent.xkey.nbytes = 0;
     }
-    
+
     /*
      * Finally we can queue the XEvent, inserting a KeyRelease before a
      * repeated KeyPress.
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 00b8715..0d023ff 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -16,37 +16,107 @@
 #include "tkMacOSXConstants.h"
 #include "tkMacOSXKeysyms.h"
 
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar < 0xF700))
+#define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
+#define VIRTUAL_MAX	 0x7F
+#define MAC_KEYCHAR_MASK 0xFFFF
+
 /*
- * When converting native key events to X11 key events, each platform is
- * allowed to choose what information to encode in the XEvent.xkey.keycode
- * field.  On the Macintosh, every non-modifier key has a unicode character
- * associated to it.  For non-text keys this unicode character is in the
- * private use range 0xF700 - 0xF8FF.  Modifier keys, however, do not produce
- * KeyDown or KeyUp events, rather FlagsChanged events, so they do not have an
- * associated unicode character.
- *
- * When constructing an XEvent from a KeyDown or KeyUo NSEvent, the
- * XEvent.xkey.keycode field is constructed by using bits 0-15 to hold the
- * first unicode character of the [NSEvent characters] attribute of the
- * NSEvent, and bits 16-23 to hold the value of the [NSEvent keyCode]
- * attribute.  The keyCode attribute identifies a location on the keyboard,
- * and Apple calls it a "virtual keycode". It is allowed for the characters
- * attribute to have length greater than 1, but that does not appear to happen
- * for any known keyboards.
- *
- * When generating an XEvent with the event generate command, the unicode
- * character is determined from the X11 keysym and, if that unicode character
- * belongs to a key on the current keyboard layout bits 16-23 are set to the
- * virtual keycode of that key.  Otherwise they are cleared.
- *
- * KeyPress or KeyRelease XEvents are also constructed when a FlagsChanged
- * NSEvent is processed.  For these, the unicode character is set to 0xF8FF,
- * the last value of the private use range.
+ * About keyboards
+
+ * Keyboards are complicated.  This long comment is an attempt to provide
+ * enough information about them to make it possible to read and understand
+ * the code in this file.
+ *
+ * Every key on a keyboard is identified by a number between 0 and 127.  In
+ * macOS, pressing or releasing a key on the keyboard generates an NSEvent of
+ * type KeyDown, KeyUp or FlagsChanged.  The 8-bit identifier of the key that
+ * was involved in this event is provided in the attribute [NSEvent keyCode].
+ * Apple also refers to this number as a "Virtual KeyCode".  In this file, to
+ * avoid confusion with other uses of the word keycode, we will refer to this
+ * key identifier as a "virtual keycode", usually the value of a variable named
+ * "virtual".
+ *
+ * Some of the keys on a keyboard are "modifier" keys.  The effect of
+ * pressing or releasing a key depends on three quantities:
+ *     - which key is being pressed or released
+ *     - which modifier keys are being held down at the moment
+ *     - the current keyboard layout
+ * If the key is a modifier key then the effect of pressing or releasing it is
+ * only to change the list of which modifier keys are being held down.  Apple
+ * reports this by sending an NSEvent of type FlagsChanged.  X11 reports this
+ * as a KeyPress or KeyRelease event for the modifier key.  Note that there may
+ * be combinations of modifier key states and key presses which have no effect.
+ *
+ * In X11 every meaningful effect from a key action is identified by a 16 bit
+ * value known as a keysym.  Every keysym has an associated string name, also
+ * known as a keysym.  The Tk bind command uses the X11 keysym string to
+ * specify a key event which should invoke a certain action and it provides the
+ * numeric and symbolic keysyms to the bound proc as %K and %N respectively.
+ * An X11 XEvent which reports a KeyPress or KeyRelease does not include the
+ * keysym.  Instead it includes a platform-specific numerical value called a
+ * keycode which is available to the bound procedure as %k.  A platform port of
+ * Tk must provide functions which convert between keycodes and numerical
+ * keysyms.  Conversion between numerical and symbolic keysyms is provided by
+ * the generic Tk code, although platforms are allowed to provide their own by
+ * defining the XKeysymToString and XStringToKeysym functions and undefining
+ * the macro REDO_KEYSYM_LOOKUP.  This macOS port uses the conversion provided
+ * by the generic code.
+ *
+ * When the keyboard focus is on a Tk widget which provides text input, there
+ * are some X11 KeyPress events which cause text to be inserted.  We will call
+ * these "printable" events.  The text which should be inserted is contained in
+ * the xkeys.trans_chars field of a key XEvent as a unicode string encoded with
+ * a special Tcl encoding.  The string is assumed to be null-terminated if the
+ * nbytes field of the XEvent is non-zero.  Otherwise the length is given by
+ * the value of nbytes.  The value of the trans_chars string in an Xevent
+ * depends on more than the three items above.  It may also depend on the
+ * sequence of keypresses that preceded the one being reported by the XEvent.
+ * For example, on macOS an <Alt-e> event does not cause text to be inserted
+ * but a following <a> event causes an accented a to be inserted.  The events
+ * in such a composition sequence, other than the final one, are known as
+ * "dead-key" events.
+ *
+ * MacOS packages the information described above in a different way.  Every
+ * meaningful effect from a key action *other than changing the state of
+ * modifier keys* is identified by a unicode string which is provided as the
+ * [NSEvent characters] attribute of a KeyDown or KeyUp event.  FlagsChanged
+ * events do not have characters.  In principle, the characters attribute could
+ * be an arbitrary unicode string but in practice it is always a single UTF-16
+ * character which we usually store in a variable named keychar.  While the
+ * keychar is a legal unicode code point, it does not necessarily represent a
+ * glyph. MacOS uses unicode code points in the private-use range 0xF700-0xF8FF
+ * for non-printable events which have no associated ASCII code point.  For
+ * example, pressing the F2 key generates an NSEvent with the character 0xF705,
+ * the Backspace key produces 0x7F (ASCII del) and the Delete key produces
+ * 0xF728.
+ *
+ * With the exception of modifier keys, it is possible to translate between
+ * numerical X11 keysyms and macOS keychars; this file constructs Tcl hash
+ * tables to do this job, using data defined in the file tkMacOSXKeysyms.h.
+ * The code here adopts the convention that the keychar of any modifier key
+ * is 0xF8FF, the last value in the private-use range.
+ *
+ * The macosx platform-specific scheme for generating a keycode when mapping an
+ * NSEvent of type KeyUp, KeyDown or FlagsChanged to an XEvent of type KeyPress
+ * or KeyRelease is as follows:
+ *     keycode = (virtual << 24) | keychar
+ * A few remarks are in order.  First, we are using 32 bits for the keycode and
+ * we are allowing room for up to 24 bits for the keychar.  This means that
+ * there is enough room in the keycode to hold a UTF-32 character, which only
+ * requires 21 bits.  So, in the future, when macs have emoji keyboards, no
+ * change will be needed in how keycodes are generated.  Second, the KeyCode
+ * type for the keycode field in an XEvent is currently defined as unsigned
+ * long, which means that it is 64 bits on modern macOS systems. Finally, there
+ * is no obstruction to generating KeyPress events for keys that represent
+ * letters which do not exist on the current keyboard layout.  And different
+ * keyboard layouts can assign a given letter to different keys.  So we need a
+ * convention for what value to assign to "virtual" when computing the keycode
+ * for a generated event.  The convention used here is as follows:
+ *   If there is a key on the current keyboard which produces the keychar,
+ *   use the virtual keycode of that key.  Otherwise set virtual = 0.
  */
 
-#define VIRTUAL_MAX	 0x7F
-#define MAC_KEYCODE_MASK 0xFF
-
 /*
  * Hash tables used to translate between various key attributes.
  */
@@ -70,8 +140,8 @@ static BOOL keyboardChanged = YES;
 
 static void	InitHashTables(void);
 static void     UpdateKeymap(void);
-static int	KeyDataToUnicode(UniChar * uniChars, int maxChars,
-			UInt16 keyaction, UInt32 keycode, UInt32 modifiers,
+static int	KeyDataToUnicode(UniChar *uniChars, int maxChars,
+			UInt16 keyaction, UInt32 virtual, UInt32 modifiers,
 			UInt32 * deadKeyStatePtr);
 
 #pragma mark TKApplication(TKKeyboard)
@@ -121,7 +191,7 @@ InitHashTables(void)
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keysym));
 	hPtr = Tcl_CreateHashEntry(&keysym2keycode, INT2PTR(kPtr->keysym),
 				   &dummy);
-	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keychar | (kPtr->virtual << 16)));
+	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keychar | (kPtr->virtual << 24)));
     }
     Tcl_InitHashTable(&keysym2unichar, TCL_ONE_WORD_KEYS);
     Tcl_InitHashTable(&unichar2keysym, TCL_ONE_WORD_KEYS);
@@ -143,7 +213,9 @@ InitHashTables(void)
  * UpdateKeymap --
  *
  *	Called when the keyboard changes to update the hash table that
- *      maps unicode characters to virtual keycodes.
+ *      maps unicode characters to virtual keycodes with states.  In order
+ *      for this to be well-defined we have to ignore virtual keycodes for
+ *      keypad keys.
  *
  * Results:
  *	None.
@@ -158,7 +230,7 @@ static void
 UpdateKeymap()
 {
     static int keymapInitialized = 0;
-    UniChar keyChar = 0;
+    UniChar keychar;
     Tcl_HashEntry *hPtr;
     int virtual, state, modifiers, dummy;
 
@@ -167,31 +239,34 @@ UpdateKeymap()
     } else {
 	Tcl_DeleteHashTable(&unichar2virtual);
     }
-    for (state = 3; state >= 0; state--) {
+    for (state = 4; state >= 0; state--) {
 	for (virtual = 0; virtual <= VIRTUAL_MAX; virtual++) {
-	    modifiers = (state & 1 ? shiftKey : 0) | (state & 2 ? optionKey : 0);
-	    KeyDataToUnicode(&keyChar, 1, kUCKeyActionDown, virtual, modifiers, NULL);
-	    hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keyChar),
+	    if (ON_KEYPAD(virtual)) {
+		continue;
+	    }
+	    modifiers =  (state & 1 ? shiftKey : 0) |
+		(state & 2 ? optionKey : 0);
+	    KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual, modifiers,
+			     NULL);
+	    hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keychar),
 				       &dummy);
 	    Tcl_SetHashValue(hPtr, INT2PTR(state << 8 | virtual));
 	}
     }
 }
-
 
 /*
  *----------------------------------------------------------------------
  *
  * KeyDataToUnicode --
  *
- *	Given MacOS key event data this function generates the unicode
- *	characters. It does this using OS resources from the Carbon
- *      framework.
+ *	Given MacOS key event data this function generates the keychar.  It
+ *	does this by using OS resources from the Carbon framework.
  *
  *	The parameter deadKeyStatePtr can be NULL, if no deadkey handling is
- *	needed.
+ *	needed (which is always the case here).
  *
- *	This function is called from XKeycodeToKeysym() in tkMacOSKeyboard.c.
+ *	This function is called from XKeycodeToKeysym().
  *
  * Results:
  *	The number of characters generated if any, 0 if we are waiting for
@@ -209,11 +284,11 @@ KeyDataToUnicode(
     UniChar *uniChars,
     int maxChars,
     UInt16 keyaction,
-    UInt32 keycode,
+    UInt32 virtual,
     UInt32 modifiers,
     UInt32 *deadKeyStatePtr)
 {
-    static const void *uchr = NULL;
+    static const void *layoutData = NULL;
     static UInt32 keyboardType = 0;
     UniCharCount actuallength = 0;
 
@@ -226,26 +301,26 @@ KeyDataToUnicode(
 		    currentKeyboardLayout, kTISPropertyUnicodeKeyLayoutData);
 
 	    if (keyLayoutData) {
-		uchr = CFDataGetBytePtr(keyLayoutData);
+		layoutData = CFDataGetBytePtr(keyLayoutData);
 		keyboardType = LMGetKbdType();
 	    }
 	    CFRelease(currentKeyboardLayout);
 	}
 	keyboardChanged = 0;
     }
-    if (uchr) {
+    if (layoutData) {
 	OptionBits options = 0;
 	UInt32 dummyState;
 	OSStatus err;
 
-	keycode &= 0xFFFF;
+	virtual &= MAC_KEYCHAR_MASK;
 	modifiers = (modifiers >> 8) & 0xFF;
 	if (!deadKeyStatePtr) {
 	    options = kUCKeyTranslateNoDeadKeysMask;
 	    dummyState = 0;
 	    deadKeyStatePtr = &dummyState;
 	}
-	err = ChkErr(UCKeyTranslate, uchr, keycode, keyaction, modifiers,
+	err = ChkErr(UCKeyTranslate, layoutData, virtual, keyaction, modifiers,
 		keyboardType, options, deadKeyStatePtr, maxChars,
 		&actuallength, uniChars);
 	if (!actuallength && *deadKeyStatePtr) {
@@ -269,9 +344,9 @@ KeyDataToUnicode(
  *
  * XKeycodeToKeysym --
  *
- *	Stub function which translate from the platform-specific keycode used
+ *	This is a stub function which translates from the keycode used
  *      in an XEvent to an X11 keysym.  On the Macintosh, the display input
- *      is ignored and only the virtual keycode in bits 16-23 is used.
+ *      is ignored and only the virtual keycode in bits 24-31 is used.
  *
  * Results:
  *      Returns the corresponding keysym, or NoSymbol if the keysym cannot
@@ -304,7 +379,7 @@ XKeycodeToKeysym(
      * an Fn function key or Tab, Backspace, Home, End, etc.
      */
 
-    virtual = (keycode >> 16) & 0xFF;
+    virtual = (keycode >> 24) & MAC_KEYCHAR_MASK;
     if (virtual) {
 	hPtr = Tcl_FindHashEntry(&virtual2keysym, INT2PTR(virtual));
 	if (hPtr != NULL) {
@@ -313,8 +388,8 @@ XKeycodeToKeysym(
     }
 
     /*
-     * If not, use Carbon to find the unicode character and translate it
-     * to a keysym using a hash table.
+     * If not, use the Carbon Framework to find the unicode character and
+     * translate it to a keysym using the unicode2keysym hash table.
      */
 
     modifiers = (state & 1 ? shiftKey : 0) | (state & 2 ? optionKey : 0);
@@ -427,7 +502,7 @@ XFreeModifiermap(
  * XKeysymToString, XStringToKeysym --
  *
  *	These X window functions map keysyms to strings & strings to keysyms.
- *      These are never called because we define REDO_KEYSYM_LOOKUP, which
+ *      They are never called because we define REDO_KEYSYM_LOOKUP, which
  *      instructs tkBind to do the conversion for us.
  *
  * Results:
@@ -458,15 +533,14 @@ XStringToKeysym(
  *
  * XKeysymToKeycode --
  *
- *	Converts an XKeysym to the value which would be used as the keycode
- *      field of a KeyPress or KeyRelease XEvent for the corresponding key.
- *      This is an opaque stub function which knows how the keycode field is
- *      generated on a Mac.
+ *	This is a stub function which onverts a numerical keysym to the keycode
+ *      which should be used as the in a KeyPress or KeyRelease XEvent for the
+ *      corresponding key.
  *
  * Results:
  *
  *      An X11 KeyCode with a unicode character in the low 16 bits and the
- *	8-bit "virtual keycode" in the third byte.  See the description of
+ *	8-bit "virtual keycode" in the highest byte.  See the description of
  *      keycodes on the Macintosh at the top of this file.
  *
  * Side effects:
@@ -474,7 +548,7 @@ XStringToKeysym(
  *
  *----------------------------------------------------------------------
  */
-KeyCode
+static KeyCode
 XKeysymToKeycodeWithState(
     Display *display,
     KeySym keysym,
@@ -485,6 +559,7 @@ XKeysymToKeycodeWithState(
     if (!initialized) {
 	InitHashTables();
     }
+
     hPtr = Tcl_FindHashEntry(&keysym2unichar, INT2PTR(keysym));
     if (hPtr != NULL) {
 	KeyCode character = (KeyCode) Tcl_GetHashValue(hPtr);
@@ -493,17 +568,12 @@ XKeysymToKeycodeWithState(
 	    KeyCode lookup = ((KeyCode) Tcl_GetHashValue(hPtr));
 	    KeyCode virtual = lookup & 0xFF;
 	    *state = lookup >> 8;
-	    return virtual << 16 | character;
+	    return virtual << 24 | character;
 	} else {
 	    return character;
 	}
     }
 
-    /*
-     * This is not a text key.  Try doing a hash table lookup to find the
-     * keycode for a special key.
-     */
-
     hPtr = Tcl_FindHashEntry(&keysym2keycode, INT2PTR(keysym));
     if (hPtr != NULL) {
 	return (KeyCode) Tcl_GetHashValue(hPtr);
@@ -554,23 +624,22 @@ TkpSetKeycodeAndState(
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
     } else {
-	int state, length = 0;
+	int state;
 	UniChar keychar;
 	Display *display = Tk_Display(tkwin);
 	eventPtr->xkey.keycode = XKeysymToKeycodeWithState(display, keysym,
 							   &state);
 	eventPtr->xkey.state |= state;
-	keychar = eventPtr->xkey.keycode & 0xFFFF;
-	
+	keychar = eventPtr->xkey.keycode & MAC_KEYCHAR_MASK;
+
 	/*
 	 * Set trans_chars for keychars outside of the private-use range.
 	 */
 
-	if ((keychar >= 0x20) && (keychar < 0xF700)) {
-	    length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
+	if (IS_PRINTABLE(keychar)) {
+	    eventPtr->xkey.nbytes = 0; /* This string is null-terminated. */
+	    int length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
 	    eventPtr->xkey.trans_chars[length] = 0;
-	} else {
-	    eventPtr->xkey.nbytes = 0;
 	}
     }
 }
@@ -614,8 +683,8 @@ TkpGetKeySym(
      * Modifier key events have a special mac keycode (see tkProcessKeyEvent).
      */
 
-    if ((eventPtr->xkey.keycode & MAC_KEYCODE_MASK) == 0xF8FF) {
-	switch (eventPtr->xkey.keycode >> 16) { /* the virtual keyCode */
+    if ((eventPtr->xkey.keycode & MAC_KEYCHAR_MASK) == 0xF8FF) {
+	switch (eventPtr->xkey.keycode >> 24) { /* the virtual keyCode */
 	case 54:
 	    return XK_Meta_R;
 	case 55:
-- 
cgit v0.12


From 3d5553c792d681627037b1c7fb47a5884e9fa55d Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Sun, 26 Apr 2020 22:35:01 +0000
Subject: Revert change to tkMacOSXMouseEvent.c which broke local grabs and add
 a NULL pointer guard in setupXEvent.

---
 macosx/tkMacOSXKeyEvent.c   | 3 +++
 macosx/tkMacOSXMouseEvent.c | 3 ++-
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index fe71ea9..fb75fb6 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -553,6 +553,9 @@ setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers)
     unsigned int state = 0;
     Display *display = Tk_Display(tkwin);
 
+    if (tkwin == NULL) {
+	return;
+    }
     if (modifiers) {
 	state = (modifiers & NSAlphaShiftKeyMask ? LockMask    : 0) |
 	        (modifiers & NSShiftKeyMask      ? ShiftMask   : 0) |
diff --git a/macosx/tkMacOSXMouseEvent.c b/macosx/tkMacOSXMouseEvent.c
index d475dbc..dd50d0a 100644
--- a/macosx/tkMacOSXMouseEvent.c
+++ b/macosx/tkMacOSXMouseEvent.c
@@ -123,6 +123,7 @@ enum {
 	    }
 	}
 	local.y = [eventWindow frame].size.height - local.y;
+	global.y = TkMacOSXZeroScreenHeight() - global.y;
     } else {
 
 	/*
@@ -142,6 +143,7 @@ enum {
 	}
 	local = [eventWindow tkConvertPointFromScreen: global];
 	local.y = [eventWindow frame].size.height - local.y;
+	global.y = TkMacOSXZeroScreenHeight() - global.y;
     }
 
     /*
@@ -220,7 +222,6 @@ enum {
     tkwin = Tk_TopCoordsToWindow(tkwin, local.x, local.y, &win_x, &win_y);
     local.x = win_x;
     local.y = win_y;
-    global.y = TkMacOSXZeroScreenHeight() - global.y;
 
     /*
      *  Generate an XEvent for this mouse event.
-- 
cgit v0.12


From 9baf680ce5583741fa38bb80544776a38b263cee Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Mon, 27 Apr 2020 01:28:18 +0000
Subject: Deal with Apple's Backspace key.

---
 macosx/tkMacOSXKeyEvent.c | 4 +++-
 macosx/tkMacOSXKeyboard.c | 4 +++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index fb75fb6..688d7dd 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -17,7 +17,9 @@
 #include "tkMacOSXInt.h"
 #include "tkMacOSXConstants.h"
 #include "tkMacOSXWm.h"
-#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar < 0xF700))
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && \
+			       (keychar != 0x7f) && \
+			       (keychar < 0xF700))
 
 /*
 #ifdef TK_MAC_DEBUG
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 0d023ff..9c0eb84 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -16,7 +16,9 @@
 #include "tkMacOSXConstants.h"
 #include "tkMacOSXKeysyms.h"
 
-#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar < 0xF700))
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && \
+			       (keychar != 0x7f) && \
+			       (keychar < 0xF700))
 #define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
 #define VIRTUAL_MAX	 0x7F
 #define MAC_KEYCHAR_MASK 0xFFFF
-- 
cgit v0.12


From 71ba027f8de56bf6837fd722d37dbb2bda01f5a1 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Mon, 27 Apr 2020 13:45:16 +0000
Subject: Fix crash when Tk is deactivated while the character selection popup
 is open.  Nice catch by Christopher Chavez!

---
 macosx/tkMacOSXKeyEvent.c | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 688d7dd..fbc688d 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -115,8 +115,21 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     setupXEvent(&xEvent, tkwin, modifiers);
-    focusWinPtr = TkFocusKeyEvent(winPtr, &xEvent);
     has_modifiers = xEvent.xkey.state & XEVENT_MOD_MASK;
+    focusWinPtr = TkFocusKeyEvent(winPtr, &xEvent);
+    if (focusWinPtr == NULL) {
+
+	/*
+	 * This NSEvent is being sent to a window which no longer has focus.
+	 * This has been observed to happen when the user deactivates the Tk
+	 * app while the NSTextInputClient's popup character selection window
+	 * is still open.  We attempt to abandon any ongoing composition
+	 * operation and discard the event.
+	 */
+
+	[[w contentView] cancelComposingText];
+	return theEvent;
+    }
     can_input_text = ((focusWinPtr->flags & TK_CAN_INPUT_TEXT) != 0);
 
 #if (NS_KEYLOG)
@@ -398,7 +411,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     return privateWorkingText != nil;
 }
 
-
 - (NSRange)markedRange
 {
     NSRange rng = privateWorkingText != nil
@@ -429,7 +441,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     processingCompose = NO;
 }
 
-
 /*
  * Called by the system to get a position for popup character selection windows
  * such as a Character Palette, or a selection menu for IME.
-- 
cgit v0.12


From 1f578eda91cddbe705333692cdb369a6c502aa70 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Mon, 27 Apr 2020 17:21:04 +0000
Subject: Eliminate use of nbytes, which seems to be superfluous on macOS; edit
 some comments

---
 macosx/tkMacOSXKeyEvent.c |  4 +---
 macosx/tkMacOSXKeyboard.c | 49 ++++++++++++++++++-----------------------------
 2 files changed, 20 insertions(+), 33 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index fbc688d..b25f2a5 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -226,7 +226,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
     setXEventPoint(&xEvent, tkwin, w);
     if (IS_PRINTABLE(keychar)) {
-	xEvent.xkey.nbytes = 0;  /* This string is null-terminated. */
 	int length = TkUniCharToUtf(keychar, xEvent.xkey.trans_chars);
 	xEvent.xkey.trans_chars[length] = 0;
     }
@@ -332,8 +331,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     for (i = 0; i < len; i++) {
-	xEvent.xkey.nbytes = TkUtfAtIndex(str, i, xEvent.xkey.trans_chars,
-					   &xEvent.xkey.keycode);
+	TkUtfAtIndex(str, i, xEvent.xkey.trans_chars, &xEvent.xkey.keycode);
 	if (xEvent.xkey.keycode > 0xffff){
 	    i++;
 	}
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 9c0eb84..90f7c25 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -25,7 +25,7 @@
 
 /*
  * About keyboards
-
+ * ---------------
  * Keyboards are complicated.  This long comment is an attempt to provide
  * enough information about them to make it possible to read and understand
  * the code in this file.
@@ -67,17 +67,15 @@
  *
  * When the keyboard focus is on a Tk widget which provides text input, there
  * are some X11 KeyPress events which cause text to be inserted.  We will call
- * these "printable" events.  The text which should be inserted is contained in
- * the xkeys.trans_chars field of a key XEvent as a unicode string encoded with
- * a special Tcl encoding.  The string is assumed to be null-terminated if the
- * nbytes field of the XEvent is non-zero.  Otherwise the length is given by
- * the value of nbytes.  The value of the trans_chars string in an Xevent
- * depends on more than the three items above.  It may also depend on the
- * sequence of keypresses that preceded the one being reported by the XEvent.
- * For example, on macOS an <Alt-e> event does not cause text to be inserted
- * but a following <a> event causes an accented a to be inserted.  The events
- * in such a composition sequence, other than the final one, are known as
- * "dead-key" events.
+ * these "printable" events.  On macOS the text which should be inserted is
+ * contained in the xkeys.trans_chars field of a key XEvent as a
+ * null-terminated unicode string encoded with a special Tcl encoding.  The
+ * value of the trans_chars string in an Xevent depends on more than the three
+ * items above.  It may also depend on the sequence of keypresses that preceded
+ * the one being reported by the XEvent.  For example, on macOS an <Alt-e>
+ * event does not cause text to be inserted but a following <a> event causes an
+ * accented 'a' to be inserted.  The events in such a composition sequence,
+ * other than the final one, are known as "dead-key" events.
  *
  * MacOS packages the information described above in a different way.  Every
  * meaningful effect from a key action *other than changing the state of
@@ -217,7 +215,8 @@ InitHashTables(void)
  *	Called when the keyboard changes to update the hash table that
  *      maps unicode characters to virtual keycodes with states.  In order
  *      for this to be well-defined we have to ignore virtual keycodes for
- *      keypad keys.
+ *      keypad keys, since each keypad key has the same character as the
+ *      corresponding key on the main keyboard.
  *
  * Results:
  *	None.
@@ -346,13 +345,13 @@ KeyDataToUnicode(
  *
  * XKeycodeToKeysym --
  *
- *	This is a stub function which translates from the keycode used
- *      in an XEvent to an X11 keysym.  On the Macintosh, the display input
- *      is ignored and only the virtual keycode in bits 24-31 is used.
+ *	This is a stub function which translates from the keycode used in an
+ *      XEvent to a numerical keysym.  On macOS, the display input variable is
+ *      ignored and only the virtual keycode in bits 24-31 is used.
  *
  * Results:
- *      Returns the corresponding keysym, or NoSymbol if the keysym cannot
- *	be found.
+ *      Returns the corresponding numerical keysym, or NoSymbol if the keysym
+ *      cannot be found.
  *
  * Side effects:
  *	None.
@@ -639,7 +638,6 @@ TkpSetKeycodeAndState(
 	 */
 
 	if (IS_PRINTABLE(keychar)) {
-	    eventPtr->xkey.nbytes = 0; /* This string is null-terminated. */
 	    int length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
 	    eventPtr->xkey.trans_chars[length] = 0;
 	}
@@ -651,8 +649,8 @@ TkpSetKeycodeAndState(
  *
  * TkpGetKeySym --
  *
- *	Given an X KeyPress or KeyRelease event, map the keycode in the event
- *	to a keysym.
+ *	This is a stub function called in tkBind.c.  Given an X KeyPress or
+ *	KeyRelease event, map the keycode in the event to a keysym.
  *
  * Results:
  *	The return value is the keysym corresponding to eventPtr, or NoSymbol
@@ -713,15 +711,6 @@ TkpGetKeySym(
     }
 
     /*
-     * If nbytes has been set, it's not a function key, but a regular key that
-     * has been translated in tkMacOSXKeyEvent.c; just use that.
-     */
-
-    if (eventPtr->xkey.nbytes) {
-	return eventPtr->xkey.keycode;
-    }
-
-    /*
      * Figure out which of the four slots in the keymap vector to use for this
      * key. Refer to Xlib documentation for more info on how this computation
      * works. (Note: We use "Option" in keymap columns 2 and 3 where other
-- 
cgit v0.12


From d085039112bdde005d6f6b3e43145b428c53ca70 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Mon, 27 Apr 2020 18:54:22 +0000
Subject: Edit a comment

---
 macosx/tkMacOSXKeyboard.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 90f7c25..110f9dd 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -39,8 +39,9 @@
  * key identifier as a "virtual keycode", usually the value of a variable named
  * "virtual".
  *
- * Some of the keys on a keyboard are "modifier" keys.  The effect of
- * pressing or releasing a key depends on three quantities:
+ * Some of the keys on a keyboard, such as the Shift, Option, Command or
+ * Control keys, are "modifier" keys.  The effect of pressing or releasing a
+ * key depends on three quantities:
  *     - which key is being pressed or released
  *     - which modifier keys are being held down at the moment
  *     - the current keyboard layout
@@ -54,7 +55,7 @@
  * value known as a keysym.  Every keysym has an associated string name, also
  * known as a keysym.  The Tk bind command uses the X11 keysym string to
  * specify a key event which should invoke a certain action and it provides the
- * numeric and symbolic keysyms to the bound proc as %K and %N respectively.
+ * numeric and symbolic keysyms to the bound proc as %N and %K respectively.
  * An X11 XEvent which reports a KeyPress or KeyRelease does not include the
  * keysym.  Instead it includes a platform-specific numerical value called a
  * keycode which is available to the bound procedure as %k.  A platform port of
-- 
cgit v0.12


From 861d22a255f85e8bb3759abd4d646578548d6b7e Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Mon, 27 Apr 2020 19:08:30 +0000
Subject: Correct a couple of masking operations.

---
 macosx/tkMacOSXKeyboard.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 110f9dd..4dbf692 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -21,7 +21,7 @@
 			       (keychar < 0xF700))
 #define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
 #define VIRTUAL_MAX	 0x7F
-#define MAC_KEYCHAR_MASK 0xFFFF
+#define MAC_KEYCHAR_MASK 0xFFFFFF
 
 /*
  * About keyboards
@@ -315,7 +315,7 @@ KeyDataToUnicode(
 	UInt32 dummyState;
 	OSStatus err;
 
-	virtual &= MAC_KEYCHAR_MASK;
+	virtual &= 0xFF;
 	modifiers = (modifiers >> 8) & 0xFF;
 	if (!deadKeyStatePtr) {
 	    options = kUCKeyTranslateNoDeadKeysMask;
@@ -381,7 +381,7 @@ XKeycodeToKeysym(
      * an Fn function key or Tab, Backspace, Home, End, etc.
      */
 
-    virtual = (keycode >> 24) & MAC_KEYCHAR_MASK;
+    virtual = (keycode >> 24) & 0xFF;
     if (virtual) {
 	hPtr = Tcl_FindHashEntry(&virtual2keysym, INT2PTR(virtual));
 	if (hPtr != NULL) {
-- 
cgit v0.12


From 373c3b707cea33b1eabb9e1d417d9003a2e8a051 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Tue, 28 Apr 2020 14:41:46 +0000
Subject: More comment edits.  Add a new test command which can by used to
 inject key NSEvents directly into the macOS event queue.

---
 macosx/tkMacOSXKeyboard.c | 107 ++++++++++++++++++++++------------------------
 macosx/tkMacOSXTest.c     |  99 +++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 149 insertions(+), 57 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 4dbf692..6430484 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -6,6 +6,7 @@
  * Copyright (c) 1995-1997 Sun Microsystems, Inc.
  * Copyright 2001-2009, Apple Inc.
  * Copyright (c) 2005-2009 Daniel A. Steffen <das@users.sourceforge.net>
+ * Copyright (c) 2020 Marc Culler
  *
  * See the file "license.terms" for information on usage and redistribution
  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
@@ -347,8 +348,9 @@ KeyDataToUnicode(
  * XKeycodeToKeysym --
  *
  *	This is a stub function which translates from the keycode used in an
- *      XEvent to a numerical keysym.  On macOS, the display input variable is
- *      ignored and only the virtual keycode in bits 24-31 is used.
+ *      XEvent to a numerical keysym.  On macOS, the display parameter is
+ *      ignored and only the the virtual keycode stored in bits 24-31 is
+ *      used.
  *
  * Results:
  *      Returns the corresponding numerical keysym, or NoSymbol if the keysym
@@ -408,11 +410,11 @@ XKeycodeToKeysym(
  *
  * TkpGetString --
  *
- *	Retrieve the string stored in the transchars field of an XEvent
- *      and convert it to a DString.
+ *	This is a stub function which retrieves the string stored in the
+ *      transchars field of an XEvent and converts it to a Tcl_DString.
  *
  * Results:
- *	Returns the DString.
+ *	Returns a pointer to the string value of the DString.
  *
  * Side effects:
  *	None.
@@ -441,10 +443,11 @@ TkpGetString(
  *
  * XGetModifierMapping --
  *
- *	Fetch the current keycodes used as modifiers.
+ *	X11 stub function to get the keycodes used as modifiers.  This
+ *      is never called by the macOS port.
  *
  * Results:
- *	Returns a new modifier map.
+ *	Returns a newly allocated modifier map.
  *
  * Side effects:
  *	Allocates a new modifier map data structure.
@@ -458,13 +461,6 @@ XGetModifierMapping(
 {
     XModifierKeymap *modmap;
 
-    (void) display; /*unused*/
-
-    /*
-     * MacOS doesn't use the key codes for the modifiers for anything, and we
-     * don't generate them either. So there is no modifier map.
-     */
-
     modmap = ckalloc(sizeof(XModifierKeymap));
     modmap->max_keypermod = 0;
     modmap->modifiermap = NULL;
@@ -476,7 +472,8 @@ XGetModifierMapping(
  *
  * XFreeModifiermap --
  *
- *	Deallocate a modifier map that was created by XGetModifierMapping.
+ *	Deallocates a modifier map that was created by XGetModifierMapping.
+ *      This is also never called by the macOS port.
  *
  * Results:
  *	None.
@@ -503,9 +500,10 @@ XFreeModifiermap(
  *
  * XKeysymToString, XStringToKeysym --
  *
- *	These X window functions map keysyms to strings & strings to keysyms.
- *      They are never called because we define REDO_KEYSYM_LOOKUP, which
- *      instructs tkBind to do the conversion for us.
+ *	These X11 stub functions map keysyms to strings & strings to keysyms.
+ *      A platform can do its own conversion by defining these and undefining
+ *      REDO_KEYSYM_LOOKUP.  The macOS port defines REDO_KEYSYM_LOOKUP so these
+ *      are never called and Tk does the conversion for us.
  *
  * Results:
  *	None.
@@ -535,15 +533,16 @@ XStringToKeysym(
  *
  * XKeysymToKeycode --
  *
- *	This is a stub function which onverts a numerical keysym to the keycode
- *      which should be used as the in a KeyPress or KeyRelease XEvent for the
- *      corresponding key.
+ *	This is a stub function which converts a numerical keysym to the
+ *      platform-specific keycode used in a KeyPress or KeyRelease XEvent.  The
+ *      implementation calls a static function which also provides information
+ *      about the modifier state, needed by TkpSetKeycodeAndState.
  *
  * Results:
  *
- *      An X11 KeyCode with a unicode character in the low 16 bits and the
- *	8-bit "virtual keycode" in the highest byte.  See the description of
- *      keycodes on the Macintosh at the top of this file.
+ *      On macOS, a KeyCode with a unicode character in the lowest 16 bits and
+ *	the 8-bit "virtual keycode" in the highest byte.  See the description
+ *	of keycodes on the Macintosh at the top of this file.
  *
  * Side effects:
  *	None.
@@ -612,8 +611,8 @@ XKeysymToKeycode(
  *
  *	Modifies the XEvent. Sets the xkey.keycode to a keycode value formatted
  *	by XKeysymToKeycode and sets the shift and option flags in xkey.state
- *	to the values implied by the keysym. Also fills in xkey.trans_chars, so
- *	that the actual characters can be retrieved later.
+ *	to the values implied by the keysym. Also fills in xkey.trans_chars for
+ *	printable events.
  *
  *----------------------------------------------------------------------
  */
@@ -650,16 +649,17 @@ TkpSetKeycodeAndState(
  *
  * TkpGetKeySym --
  *
- *	This is a stub function called in tkBind.c.  Given an X KeyPress or
- *	KeyRelease event, map the keycode in the event to a keysym.
+ *	This is a stub function called in tkBind.c.  Given a KeyPress or
+ *	KeyRelease XEvent, it maps the keycode in the event to a numerical
+ *      keysym.
  *
  * Results:
  *	The return value is the keysym corresponding to eventPtr, or NoSymbol
  *	if no matching keysym could be found.
  *
  * Side effects:
- *	In the first call for a given display, keycode-to-keysym maps get
- *	loaded.
+ *	In the first call for a given display, calls TkpInitKeymapInfo.
+ *
  *
  *----------------------------------------------------------------------
  */
@@ -714,17 +714,15 @@ TkpGetKeySym(
     /*
      * Figure out which of the four slots in the keymap vector to use for this
      * key. Refer to Xlib documentation for more info on how this computation
-     * works. (Note: We use "Option" in keymap columns 2 and 3 where other
-     * implementations have "Mode_switch".)
+     * works.
      */
 
     index = 0;
     if (eventPtr->xkey.state & Mod2Mask) { /* Option */
 	index |= 2;
     }
-    if ((eventPtr->xkey.state & ShiftMask)
-	    || (/* (dispPtr->lockUsage != LU_IGNORE)
-	    && */ (eventPtr->xkey.state & LockMask))) {
+    if ((eventPtr->xkey.state & ShiftMask) || /* Shift or caps lock. */
+	(eventPtr->xkey.state & LockMask)) {
 	index |= 1;
     }
 
@@ -767,15 +765,14 @@ TkpGetKeySym(
  *
  * TkpInitKeymapInfo --
  *
- *	This procedure is invoked to scan keymap information to recompute stuff
- *	that's important for binding, such as the modifier key (if any) that
- *	corresponds to the "Mode_switch" keysym.
+ *	This procedure initializes fields in the display that pertain
+ *      to modifier keys.
  *
  * Results:
  *	None.
  *
  * Side effects:
- *	Keymap-related information in dispPtr is updated.
+ *	Modifier key information in dispPtr is initialized.
  *
  *--------------------------------------------------------------
  */
@@ -788,34 +785,32 @@ TkpInitKeymapInfo(
     dispPtr->bindInfoStale = 0;
 
     /*
-     * Behaviors that are variable on X11 are defined constant on MacOSX.
-     * lockUsage is only used above in TkpGetKeySym(), nowhere else currently.
+     * On macOS the caps lock key is always interpreted to mean that alphabetic
+     * keys become uppercase but other keys do not get shifted.  (X11 allows
+     * a configuration option which makes the caps lock equivalent to holding
+     * down the shift key.)
      * There is no offical "Mode_switch" key.
      */
 
     dispPtr->lockUsage = LU_CAPS;
+
+    /* This field is no longer used by tkBind.c */
+
     dispPtr->modeModMask = 0;
-#if 0
-    /*
-     * With this, <Alt> and <Meta> become synonyms for <Command> and <Option>
-     * in bindings like they are (and always have been) in the keysyms that
-     * are reported by KeyPress events. But the init scripts like text.tcl
-     * have some disabling bindings for <Meta>, so we don't want this without
-     * some changes in those scripts. See also bug #700311.
+
+    /* The Alt and Meta keys are interchanged on Macintosh keyboards compared
+     * to PC keyboards.  These fields could be set to make the Alt key on a PC
+     * keyboard behave likd an Alt key. That would also require interchanging
+     * Mod1Mask and Mod2Mask in tkMacOSXKeyEvent.c.
      */
 
-    dispPtr->altModMask = Mod2Mask;  /* Option key */
-    dispPtr->metaModMask = Mod1Mask; /* Command key */
-#else
     dispPtr->altModMask = 0;
     dispPtr->metaModMask = 0;
-#endif
 
     /*
-     * MacOSX doesn't create a key event when a modifier key is pressed or
-     * released.  However, it is possible to generate key events for
-     * modifier keys, and this is done in the tests.  So we construct an array
-     * containing the keycodes of the standard modifier keys from static data.
+     * The modKeyCodes table lists the keycodes that appear in KeyPress or
+     * KeyRelease XEvents for modifier keys.  In tkBind.c this table is
+     * searched to determine whether an XEvent corresponds to a modifier key.
      */
 
     if (dispPtr->modKeyCodes != NULL) {
diff --git a/macosx/tkMacOSXTest.c b/macosx/tkMacOSXTest.c
index c353efe..72a5996 100644
--- a/macosx/tkMacOSXTest.c
+++ b/macosx/tkMacOSXTest.c
@@ -25,6 +25,8 @@ static int		DebuggerObjCmd (ClientData dummy, Tcl_Interp *interp,
 #endif
 static int		PressButtonObjCmd (ClientData dummy, Tcl_Interp *interp,
 					int objc, Tcl_Obj *const objv[]);
+static int		InjectKeyEventObjCmd (ClientData dummy, Tcl_Interp *interp,
+					int objc, Tcl_Obj *const objv[]);
 
 
 /*
@@ -56,6 +58,7 @@ TkplatformtestInit(
     Tcl_CreateObjCommand(interp, "debugger", DebuggerObjCmd, NULL, NULL);
 #endif
     Tcl_CreateObjCommand(interp, "pressbutton", PressButtonObjCmd, NULL, NULL);
+    Tcl_CreateObjCommand(interp, "injectkeyevent", InjectKeyEventObjCmd, NULL, NULL);
 
     return TCL_OK;
 }
@@ -219,7 +222,101 @@ PressButtonObjCmd(
     return TCL_OK;
 }
 
-
+static int
+InjectKeyEventObjCmd(
+    ClientData clientData,
+    Tcl_Interp *interp,
+    int objc,
+    Tcl_Obj *const objv[])
+{
+    int i, index, key, mods = 0, x = 0, y = 0;
+    const char *character, *unmod=nil;
+    NSEvent *keyEvent;
+    NSString *unmodChar = nil;
+    NSUInteger type;
+    
+    static const char *const optionStrings[] = {
+	"press", "release", "flagschanged"};
+    NSUInteger types[3] = {NSKeyDown, NSKeyUp, NSFlagsChanged};
+    static const char *const argStrings[] = {
+	"-unmod", "-modifiers", "-x", "-y"};
+    enum args {KEYEVENT_UNMOD, KEYEVENT_MODIFIERS, KEYEVENT_X, KEYEVENT_Y};
+    if (objc < 4) {
+    wrongArgs:
+        Tcl_WrongNumArgs(interp, 1, objv, "option key char ?arg?");
+        return TCL_ERROR;
+    }
+    if (Tcl_GetIndexFromObj(interp, objv[1], optionStrings, "option", 0,
+            &index) != TCL_OK) {
+        return TCL_ERROR;
+    }
+    type = types[index];
+    if (Tcl_GetIntFromObj(interp, objv[2], &key) != TCL_OK) {
+	Tcl_SetObjResult(interp, Tcl_ObjPrintf(
+			 "virtual key code must be an integer"));
+	Tcl_SetErrorCode(interp, "TK", "TEST", "INJECT", "KEY", NULL);
+	return TCL_ERROR;
+    }
+    if (key < 0 || key > 127) {
+	Tcl_SetObjResult(interp, Tcl_ObjPrintf(
+			 "virtual key code must be between 0 and 127"));
+	Tcl_SetErrorCode(interp, "TK", "TEST", "INJECT", "KEY", NULL);
+        return TCL_ERROR;
+    }
+    character = Tcl_GetString(objv[3]);
+    for (i = 4; i < objc; i++) {
+        if (Tcl_GetIndexFromObjStruct(interp, objv[i], &argStrings,
+	        sizeof(char *), "option", 0, &index) != TCL_OK) {
+            return TCL_ERROR;
+        }
+        switch ((enum args) index) {
+	case KEYEVENT_UNMOD:
+	    if (++i >= objc) {
+                goto wrongArgs;
+            }
+            unmod = Tcl_GetString(objv[i]),
+	    unmodChar = [[[NSString alloc] initWithUTF8String:unmod]
+			    autorelease];
+            break;
+	case KEYEVENT_MODIFIERS:
+	    if (++i >= objc) {
+                goto wrongArgs;
+            }
+	    if (Tcl_GetIntFromObj(interp,objv[i],&mods) != TCL_OK) {
+		return TCL_ERROR;
+	    }
+	    break;
+	case KEYEVENT_X:
+	    if (++i >= objc) {
+                goto wrongArgs;
+            }
+	    if (Tcl_GetIntFromObj(interp,objv[i],&x) != TCL_OK) {
+		return TCL_ERROR;
+	    }
+	    break;
+	case KEYEVENT_Y:
+	    if (++i >= objc) {
+                goto wrongArgs;
+            }
+	    if (Tcl_GetIntFromObj(interp,objv[i],&y) != TCL_OK) {
+		return TCL_ERROR;
+	    }
+	}
+    }
+    keyEvent = [NSEvent keyEventWithType:type
+	location:NSMakePoint(x, y)
+        modifierFlags:mods
+	timestamp:GetCurrentEventTime()
+	windowNumber:0
+	context:nil
+	characters:[[[NSString alloc] initWithUTF8String:character]
+		       autorelease]
+	charactersIgnoringModifiers:unmodChar
+	isARepeat:NO
+	keyCode:key];
+    [NSApp postEvent:keyEvent atStart:NO];
+    return TCL_OK;
+}
 /*
  * Local Variables:
  * mode: objc
-- 
cgit v0.12


From fb718bb804556da3691f5945793c4a0da75a85dd Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Wed, 29 Apr 2020 18:40:54 +0000
Subject: Deal with <Oslash> ~ <Shift-oslash> ~ <Shift-Option-o> ~
 <Shift-Option-O> ~ <Option-O> ... and fix <BackSpace> and improve injection
 of key NSEvents.

---
 macosx/tkMacOSXKeyEvent.c |  36 +++++----
 macosx/tkMacOSXKeyboard.c | 195 +++++++++++++++++++++++++++++++---------------
 macosx/tkMacOSXKeysyms.h  |   5 +-
 macosx/tkMacOSXPrivate.h  |  10 +++
 macosx/tkMacOSXTest.c     |  61 +++++++--------
 xlib/X11/X.h              |   2 +-
 xlib/X11/Xlib.h           |   2 +-
 7 files changed, 197 insertions(+), 114 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index b25f2a5..c2445b9 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -17,9 +17,10 @@
 #include "tkMacOSXInt.h"
 #include "tkMacOSXConstants.h"
 #include "tkMacOSXWm.h"
-#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && \
-			       (keychar != 0x7f) && \
-			       (keychar < 0xF700))
+
+/*
+ * See tkMacOSXPrivate.h for the definition of IS_PRINTABLE.
+ */
 
 /*
 #ifdef TK_MAC_DEBUG
@@ -118,7 +119,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     has_modifiers = xEvent.xkey.state & XEVENT_MOD_MASK;
     focusWinPtr = TkFocusKeyEvent(winPtr, &xEvent);
     if (focusWinPtr == NULL) {
-
+	TKContentView *contentView = [w contentView];
 	/*
 	 * This NSEvent is being sent to a window which no longer has focus.
 	 * This has been observed to happen when the user deactivates the Tk
@@ -127,7 +128,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	 * operation and discard the event.
 	 */
 
-	[[w contentView] cancelComposingText];
+	[contentView cancelComposingText];
 	return theEvent;
     }
     can_input_text = ((focusWinPtr->flags & TK_CAN_INPUT_TEXT) != 0);
@@ -331,10 +332,12 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     for (i = 0; i < len; i++) {
-	TkUtfAtIndex(str, i, xEvent.xkey.trans_chars, &xEvent.xkey.keycode);
-	if (xEvent.xkey.keycode > 0xffff){
+	unsigned int code;
+	TkUtfAtIndex(str, i, xEvent.xkey.trans_chars, &code);
+	if (code > 0xFFFF){
 	    i++;
 	}
+	xEvent.xkey.keycode = code;
     	xEvent.xany.type = KeyPress;
     	Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
     }
@@ -421,15 +424,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     return rng;
 }
 
-- (void)cancelComposingText
-{
-    if (NS_KEYLOG) {
-	TKLog(@"cancelComposingText");
-    }
-    [self deleteWorkingText];
-    processingCompose = NO;
-}
-
 - (void)unmarkText
 {
     if (NS_KEYLOG) {
@@ -552,6 +546,16 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	}
     }
 }
+
+- (void)cancelComposingText
+{
+    if (NS_KEYLOG) {
+	TKLog(@"cancelComposingText");
+    }
+    [self deleteWorkingText];
+    processingCompose = NO;
+}
+
 @end
 
 /*
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 6430484..4e04bae 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -17,13 +17,6 @@
 #include "tkMacOSXConstants.h"
 #include "tkMacOSXKeysyms.h"
 
-#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && \
-			       (keychar != 0x7f) && \
-			       (keychar < 0xF700))
-#define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
-#define VIRTUAL_MAX	 0x7F
-#define MAC_KEYCHAR_MASK 0xFFFFFF
-
 /*
  * About keyboards
  * ---------------
@@ -97,7 +90,7 @@
  * numerical X11 keysyms and macOS keychars; this file constructs Tcl hash
  * tables to do this job, using data defined in the file tkMacOSXKeysyms.h.
  * The code here adopts the convention that the keychar of any modifier key
- * is 0xF8FF, the last value in the private-use range.
+ * is MOD_KEYCHAR.
  *
  * The macosx platform-specific scheme for generating a keycode when mapping an
  * NSEvent of type KeyUp, KeyDown or FlagsChanged to an XEvent of type KeyPress
@@ -109,16 +102,43 @@
  * requires 21 bits.  So, in the future, when macs have emoji keyboards, no
  * change will be needed in how keycodes are generated.  Second, the KeyCode
  * type for the keycode field in an XEvent is currently defined as unsigned
- * long, which means that it is 64 bits on modern macOS systems. Finally, there
- * is no obstruction to generating KeyPress events for keys that represent
- * letters which do not exist on the current keyboard layout.  And different
- * keyboard layouts can assign a given letter to different keys.  So we need a
- * convention for what value to assign to "virtual" when computing the keycode
- * for a generated event.  The convention used here is as follows:
- *   If there is a key on the current keyboard which produces the keychar,
- *   use the virtual keycode of that key.  Otherwise set virtual = 0.
+ * int, which was modified from the unsigned short used in X11 in order to
+ * accomodate macOS. Finally, there is no obstruction to generating KeyPress
+ * events for keys that represent letters which do not exist on the current
+ * keyboard layout.  And different keyboard layouts can assign a given letter
+ * to different keys.  So we need a convention for what value to assign to
+ * "virtual" when computing the keycode for a generated event.  The convention
+ * used here is as follows: If there is a key on the current keyboard which
+ * produces the keychar, use the virtual keycode of that key.  Otherwise set
+ * virtual = NO_VIRTUAL.
+ */
+
+
+/*
+ * See tkMacOSXPrivate.h for the definition of IS_PRINTABLE.
  */
 
+#define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
+#define VIRTUAL_MAX	 0x7F
+#define NO_VIRTUAL 0xFF
+#define MAC_KEYCHAR_MASK 0xFFFFFF
+#define MOD_KEYCHAR 0xF8FE
+
+/*
+ * An "index" is an int containing two modifier flags for Option and Shift
+ * in bits 0-1.  It is used as an index when building the keymap hash
+ * tables.
+ */
+
+#define INDEX_SHIFT 1
+#define INDEX_OPTION 2
+#define INDEX2STATE(index) ((index & INDEX_SHIFT ? ShiftMask : 0) |	\
+			    (index & INDEX_OPTION ? Mod2Mask : 0))
+#define INDEX2CARBON(index) ((index & INDEX_SHIFT ? shiftKey : 0) |	\
+			     (index & INDEX_OPTION ? optionKey : 0))
+#define STATE2INDEX(state) ((state & ShiftMask ? INDEX_SHIFT : 0) |	\
+			    (state & Mod2Mask ? INDEX_OPTION : 0))
+
 /*
  * Hash tables used to translate between various key attributes.
  */
@@ -127,7 +147,8 @@ static Tcl_HashTable virtual2keysym;	/* Special virtual keycode to keysym */
 static Tcl_HashTable keysym2keycode;	/* keysym to XEvent keycode */
 static Tcl_HashTable keysym2unichar;	/* keysym to unichar */
 static Tcl_HashTable unichar2keysym;	/* unichar to X11 keysym */
-static Tcl_HashTable unichar2virtual;	/* unichar to virtual keycode */
+static Tcl_HashTable unichar2virtual;	/* unichar to virtual with index */
+static Tcl_HashTable virtual2unichar;	/* virtual with index to unichar */
 
 /*
  * Flags.
@@ -141,7 +162,7 @@ static BOOL keyboardChanged = YES;
  */
 
 static void	InitHashTables(void);
-static void     UpdateKeymap(void);
+static void     UpdateKeymaps(void);
 static int	KeyDataToUnicode(UniChar *uniChars, int maxChars,
 			UInt16 keyaction, UInt32 virtual, UInt32 modifiers,
 			UInt32 * deadKeyStatePtr);
@@ -155,7 +176,7 @@ static int	KeyDataToUnicode(UniChar *uniChars, int maxChars,
     TKLog(@"-[%@(%p) %s] %@", [self class], self, _cmd, notification);
 #endif
     keyboardChanged = YES;
-    UpdateKeymap();
+    UpdateKeymaps();
 }
 @end
 
@@ -205,14 +226,14 @@ InitHashTables(void)
 				   &dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(ksPtr->keysym));
     }
-    UpdateKeymap();
+    UpdateKeymaps();
     initialized = YES;
 }
 
 /*
  *----------------------------------------------------------------------
  *
- * UpdateKeymap --
+ * UpdateKeymaps --
  *
  *	Called when the keyboard changes to update the hash table that
  *      maps unicode characters to virtual keycodes with states.  In order
@@ -230,30 +251,41 @@ InitHashTables(void)
  */
 
 static void
-UpdateKeymap()
+UpdateKeymaps()
 {
     static int keymapInitialized = 0;
     UniChar keychar;
     Tcl_HashEntry *hPtr;
-    int virtual, state, modifiers, dummy;
+    int virtual, index, modifiers, dummy;
 
     if (!keymapInitialized) {
 	Tcl_InitHashTable(&unichar2virtual, TCL_ONE_WORD_KEYS);
+	Tcl_InitHashTable(&virtual2unichar, TCL_ONE_WORD_KEYS);
     } else {
 	Tcl_DeleteHashTable(&unichar2virtual);
+	Tcl_DeleteHashTable(&virtual2unichar);
     }
-    for (state = 4; state >= 0; state--) {
+
+    /*
+     * This for loop goes backwards so that a unichar lookup will
+     * provide the minimal modifier mask.  Simpler combinations
+     * will overwrite more complex ones.
+     */
+
+    for (index = 4; index >= 0; index--) {
 	for (virtual = 0; virtual <= VIRTUAL_MAX; virtual++) {
 	    if (ON_KEYPAD(virtual)) {
 		continue;
 	    }
-	    modifiers =  (state & 1 ? shiftKey : 0) |
-		(state & 2 ? optionKey : 0);
+	    modifiers = INDEX2CARBON(index);
 	    KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual, modifiers,
 			     NULL);
 	    hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keychar),
 				       &dummy);
-	    Tcl_SetHashValue(hPtr, INT2PTR(state << 8 | virtual));
+	    Tcl_SetHashValue(hPtr, INT2PTR(index << 8 | virtual));
+	    hPtr = Tcl_CreateHashEntry(&virtual2unichar,
+				       INT2PTR(index << 8 | virtual), &dummy);
+	    Tcl_SetHashValue(hPtr, INT2PTR(keychar));
 	}
     }
 }
@@ -392,6 +424,18 @@ XKeycodeToKeysym(
     }
 
     /*
+     * If there is no key with this keysym, try using the keychar to look up a
+     * keysym.
+     */
+
+    if (virtual == NO_VIRTUAL)
+	hPtr = Tcl_FindHashEntry(&unichar2keysym,
+				 INT2PTR(keycode & MAC_KEYCHAR_MASK));
+	if (hPtr != NULL) {
+	    return (KeySym) Tcl_GetHashValue(hPtr);
+	}
+
+    /*
      * If not, use the Carbon Framework to find the unicode character and
      * translate it to a keysym using the unicode2keysym hash table.
      */
@@ -550,10 +594,10 @@ XStringToKeysym(
  *----------------------------------------------------------------------
  */
 static KeyCode
-XKeysymToKeycodeWithState(
+XKeysymToKeycodeWithIndex(
     Display *display,
     KeySym keysym,
-    int *state)
+    int *index)
 {
     Tcl_HashEntry *hPtr;
 
@@ -561,6 +605,19 @@ XKeysymToKeycodeWithState(
 	InitHashTables();
     }
 
+    /*
+     * First check for a special key.
+     */
+
+    hPtr = Tcl_FindHashEntry(&keysym2keycode, INT2PTR(keysym));
+    if (hPtr != NULL) {
+	return (KeyCode) Tcl_GetHashValue(hPtr);
+    }
+
+    /*
+     * Next check for printable keys.
+     */
+
     hPtr = Tcl_FindHashEntry(&keysym2unichar, INT2PTR(keysym));
     if (hPtr != NULL) {
 	KeyCode character = (KeyCode) Tcl_GetHashValue(hPtr);
@@ -568,23 +625,23 @@ XKeysymToKeycodeWithState(
 	if (hPtr != NULL) {
 	    KeyCode lookup = ((KeyCode) Tcl_GetHashValue(hPtr));
 	    KeyCode virtual = lookup & 0xFF;
-	    *state = lookup >> 8;
+	    *index = lookup >> 8;
 	    return virtual << 24 | character;
 	} else {
-	    return character;
-	}
-    }
 
-    hPtr = Tcl_FindHashEntry(&keysym2keycode, INT2PTR(keysym));
-    if (hPtr != NULL) {
-	return (KeyCode) Tcl_GetHashValue(hPtr);
+	    /*
+	     * The keysym does not exist on the current keyboard.
+	     */
+
+	    return (NO_VIRTUAL << 24) | character;
+	}
     }
 
     /*
-     * Could not construct a keycode.
+     * Would not construct a keycode.  Set the keychar to 0.
      */
 
-    return 0;
+    return (NO_VIRTUAL << 24) ;
 }
 
 KeyCode
@@ -592,8 +649,8 @@ XKeysymToKeycode(
     Display *display,
     KeySym keysym)
 {
-    int state;
-    return XKeysymToKeycodeWithState(display, keysym, &state);
+    int index;
+    return XKeysymToKeycodeWithIndex(display, keysym, &index);
 }
 
 /*
@@ -625,18 +682,36 @@ TkpSetKeycodeAndState(
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
     } else {
-	int state;
-	UniChar keychar;
+	int index = 0, eventIndex = STATE2INDEX(eventPtr->xkey.state);
 	Display *display = Tk_Display(tkwin);
-	eventPtr->xkey.keycode = XKeysymToKeycodeWithState(display, keysym,
-							   &state);
-	eventPtr->xkey.state |= state;
-	keychar = eventPtr->xkey.keycode & MAC_KEYCHAR_MASK;
+	KeyCode keycode = XKeysymToKeycodeWithIndex(display, keysym, &index);
+	UniChar keychar = keycode & MAC_KEYCHAR_MASK;
+	int virtual = (keycode >> 24) & 0xFF;
 
 	/*
-	 * Set trans_chars for keychars outside of the private-use range.
+	 * We now have a virtual keycode and a minimal choice of Shift and
+	 * Option modifiers which which generates the keychar that corresponds
+	 * to the specified keysym.  But we might not have the correct keychar
+	 * yet, because the xEvent may have specified modifiers beyond our
+	 * minimal set.  For example, the events described by <Oslash>,
+	 * <Shift-oslash>, <Shift-Option-O> and <Shift-Option-o> should all
+	 * produce the same uppercase Danish O.  So we may need to add some
+	 * extra modifiers and do another lookup for the keychar.
 	 */
 
+	if (index != eventIndex) {
+	    Tcl_HashEntry *hPtr;
+	    eventIndex |= index;
+	    hPtr = Tcl_FindHashEntry(&virtual2unichar,
+				     INT2PTR(eventIndex << 8 | virtual));
+	    if (hPtr != NULL) {
+		keychar = ((UniChar) Tcl_GetHashValue(hPtr));
+	    }
+	    keycode = virtual << 24 | keychar;
+	}
+	eventPtr->xkey.keycode = keycode;
+	eventPtr->xkey.state |= INDEX2STATE(eventIndex);
+	keychar = eventPtr->xkey.keycode & MAC_KEYCHAR_MASK;
 	if (IS_PRINTABLE(keychar)) {
 	    int length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
 	    eventPtr->xkey.trans_chars[length] = 0;
@@ -684,7 +759,7 @@ TkpGetKeySym(
      * Modifier key events have a special mac keycode (see tkProcessKeyEvent).
      */
 
-    if ((eventPtr->xkey.keycode & MAC_KEYCHAR_MASK) == 0xF8FF) {
+    if ((eventPtr->xkey.keycode & MAC_KEYCHAR_MASK) == MOD_KEYCHAR) {
 	switch (eventPtr->xkey.keycode >> 24) { /* the virtual keyCode */
 	case 54:
 	    return XK_Meta_R;
@@ -717,12 +792,8 @@ TkpGetKeySym(
      * works.
      */
 
-    index = 0;
-    if (eventPtr->xkey.state & Mod2Mask) { /* Option */
-	index |= 2;
-    }
-    if ((eventPtr->xkey.state & ShiftMask) || /* Shift or caps lock. */
-	(eventPtr->xkey.state & LockMask)) {
+    index = STATE2INDEX(eventPtr->xkey.state);
+    if (eventPtr->xkey.state & LockMask) {
 	index |= 1;
     }
 
@@ -733,16 +804,14 @@ TkpGetKeySym(
     sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode, index);
 
     /*
-     * Special handling: If the key was shifted because of Lock, but lock is
-     * only caps lock, not shift lock, and the shifted keysym isn't upper-case
-     * alphabetic, then switch back to the unshifted keysym.
+     * Special handling: If the key was shifted because of Lock, which is only
+     * caps lock on macOS, not shift lock, and if the shifted keysym isn't
+     * upper-case alphabetic, then switch back to the unshifted keysym.
      */
 
-    if ((index & 1) && !(eventPtr->xkey.state & ShiftMask)
-	    /*&& (dispPtr->lockUsage == LU_CAPS)*/ ) {
-
+    if ((index & INDEX_SHIFT) && !(eventPtr->xkey.state & ShiftMask)) {
 	if ((sym == NoSymbol) || !Tcl_UniCharIsUpper(sym)) {
-	    index &= ~1;
+	    index &= ~INDEX_SHIFT;
 	    sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode,
 		    index);
 	}
@@ -753,9 +822,9 @@ TkpGetKeySym(
      * no keysym defined, then use the keysym for the unshifted key.
      */
 
-    if ((index & 1) && (sym == NoSymbol)) {
+    if ((index & INDEX_SHIFT) && (sym == NoSymbol)) {
 	sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode,
-		index & ~1);
+		index & ~INDEX_SHIFT);
     }
     return sym;
 }
diff --git a/macosx/tkMacOSXKeysyms.h b/macosx/tkMacOSXKeysyms.h
index 91dd760..8e8dba6 100644
--- a/macosx/tkMacOSXKeysyms.h
+++ b/macosx/tkMacOSXKeysyms.h
@@ -39,7 +39,7 @@ typedef struct {
 static const KeyInfo keyArray[] = {
     {36,	XK_Return,	NSNewlineCharacter},
     {48,	XK_Tab,		NSTabCharacter},
-    {51,	XK_BackSpace,	NSBackspaceCharacter},
+    {51,	XK_BackSpace,	NSDeleteCharacter},
     {52,	XK_Return,	NSNewlineCharacter},  /* Used on some Powerbooks */
     {53,	XK_Escape,	0x1B},
     {54,	XK_Meta_R,      XK_Meta_R},
@@ -105,7 +105,8 @@ static const KeyInfo keyArray[] = {
 };
 
 /*
- * X11 keysyms for modifier keys, in order.
+ * X11 keysyms for modifier keys, in order.  This list includes keys which
+ * do not appear on Apple keyboards, such as Shift_Lock and Super_R.
  */
 
 #define NUM_MOD_KEYCODES 14
diff --git a/macosx/tkMacOSXPrivate.h b/macosx/tkMacOSXPrivate.h
index 64a0cd3..77b6272 100644
--- a/macosx/tkMacOSXPrivate.h
+++ b/macosx/tkMacOSXPrivate.h
@@ -123,6 +123,15 @@
     }
 
 /*
+ * Macro used in tkMacOSXKeyboard.c and tkMacOSXKeyEvent.c to check if an
+ * XEvent should have a non-empty trans_chars field.
+ */
+
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && \
+			       (keychar != 0x7f) && \
+			       (keychar < 0xF700))
+
+/*
  * Structure encapsulating current drawing environment.
  */
 
@@ -356,6 +365,7 @@ VISIBILITY_HIDDEN
 
 @interface TKContentView(TKKeyEvent)
 - (void) deleteWorkingText;
+- (void) cancelComposingText;
 @end
 
 @interface TKContentView(TKWindowEvent)
diff --git a/macosx/tkMacOSXTest.c b/macosx/tkMacOSXTest.c
index 72a5996..a4809a4 100644
--- a/macosx/tkMacOSXTest.c
+++ b/macosx/tkMacOSXTest.c
@@ -229,18 +229,18 @@ InjectKeyEventObjCmd(
     int objc,
     Tcl_Obj *const objv[])
 {
+    static const char *const optionStrings[] = {
+	"press", "release", "flagschanged", NULL};
+    NSUInteger types[3] = {NSKeyDown, NSKeyUp, NSFlagsChanged};
+    static const char *const argStrings[] = {
+	"-shift", "-control", "-option", "-command", "-x", "-y", NULL};
+    enum args {KEYEVENT_SHIFT, KEYEVENT_CONTROL, KEYEVENT_OPTION,
+	       KEYEVENT_COMMAND, KEYEVENT_X, KEYEVENT_Y};
     int i, index, key, mods = 0, x = 0, y = 0;
-    const char *character, *unmod=nil;
+    NSString *keyChar, *unmod;
     NSEvent *keyEvent;
-    NSString *unmodChar = nil;
     NSUInteger type;
     
-    static const char *const optionStrings[] = {
-	"press", "release", "flagschanged"};
-    NSUInteger types[3] = {NSKeyDown, NSKeyUp, NSFlagsChanged};
-    static const char *const argStrings[] = {
-	"-unmod", "-modifiers", "-x", "-y"};
-    enum args {KEYEVENT_UNMOD, KEYEVENT_MODIFIERS, KEYEVENT_X, KEYEVENT_Y};
     if (objc < 4) {
     wrongArgs:
         Tcl_WrongNumArgs(interp, 1, objv, "option key char ?arg?");
@@ -263,34 +263,33 @@ InjectKeyEventObjCmd(
 	Tcl_SetErrorCode(interp, "TK", "TEST", "INJECT", "KEY", NULL);
         return TCL_ERROR;
     }
-    character = Tcl_GetString(objv[3]);
+    keyChar = [[[NSString alloc] initWithUTF8String:Tcl_GetString(objv[3])]
+		  autorelease];
+    unmod = keyChar;
     for (i = 4; i < objc; i++) {
-        if (Tcl_GetIndexFromObjStruct(interp, objv[i], &argStrings,
-	        sizeof(char *), "option", 0, &index) != TCL_OK) {
+	if (Tcl_GetIndexFromObjStruct(interp, objv[i], argStrings,
+                sizeof(char *), "option", TCL_EXACT, &index) != TCL_OK) {
             return TCL_ERROR;
         }
         switch ((enum args) index) {
-	case KEYEVENT_UNMOD:
-	    if (++i >= objc) {
-                goto wrongArgs;
-            }
-            unmod = Tcl_GetString(objv[i]),
-	    unmodChar = [[[NSString alloc] initWithUTF8String:unmod]
-			    autorelease];
+	case KEYEVENT_SHIFT:
+	    mods |= NSShiftKeyMask;
+	    unmod = [keyChar lowercaseString];
+            break;
+	case KEYEVENT_CONTROL:
+	    mods |= NSShiftKeyMask;
+            break;
+	case KEYEVENT_OPTION:
+	    mods |= NSShiftKeyMask;
+            break;
+	case KEYEVENT_COMMAND:
+	    mods |= NSShiftKeyMask;
             break;
-	case KEYEVENT_MODIFIERS:
-	    if (++i >= objc) {
-                goto wrongArgs;
-            }
-	    if (Tcl_GetIntFromObj(interp,objv[i],&mods) != TCL_OK) {
-		return TCL_ERROR;
-	    }
-	    break;
 	case KEYEVENT_X:
 	    if (++i >= objc) {
                 goto wrongArgs;
             }
-	    if (Tcl_GetIntFromObj(interp,objv[i],&x) != TCL_OK) {
+	    if (Tcl_GetIntFromObj(interp,objv[i], &x) != TCL_OK) {
 		return TCL_ERROR;
 	    }
 	    break;
@@ -298,9 +297,10 @@ InjectKeyEventObjCmd(
 	    if (++i >= objc) {
                 goto wrongArgs;
             }
-	    if (Tcl_GetIntFromObj(interp,objv[i],&y) != TCL_OK) {
+	    if (Tcl_GetIntFromObj(interp,objv[i], &y) != TCL_OK) {
 		return TCL_ERROR;
 	    }
+	    break;
 	}
     }
     keyEvent = [NSEvent keyEventWithType:type
@@ -309,9 +309,8 @@ InjectKeyEventObjCmd(
 	timestamp:GetCurrentEventTime()
 	windowNumber:0
 	context:nil
-	characters:[[[NSString alloc] initWithUTF8String:character]
-		       autorelease]
-	charactersIgnoringModifiers:unmodChar
+	characters:keyChar
+	charactersIgnoringModifiers:unmod
 	isARepeat:NO
 	keyCode:key];
     [NSApp postEvent:keyEvent atStart:NO];
diff --git a/xlib/X11/X.h b/xlib/X11/X.h
index c2c57af..22f99c0 100644
--- a/xlib/X11/X.h
+++ b/xlib/X11/X.h
@@ -63,7 +63,7 @@ typedef unsigned long VisualID;
 
 typedef unsigned long Time;
 
-typedef unsigned long KeyCode;	/* In order to use IME, the Macintosh needs
+typedef unsigned int KeyCode;	/* In order to use IME, the Macintosh needs
 				 * to pack 3 bytes into the keyCode field in
 				 * the XEvent.  In the real X.h, a KeyCode is
 				 * defined as a short, which wouldn't be big
diff --git a/xlib/X11/Xlib.h b/xlib/X11/Xlib.h
index af8f706..e737e88 100644
--- a/xlib/X11/Xlib.h
+++ b/xlib/X11/Xlib.h
@@ -547,7 +547,7 @@ typedef struct {
 	int x, y;		/* pointer x, y coordinates in event window */
 	int x_root, y_root;	/* coordinates relative to root */
 	unsigned int state;	/* key or button mask */
-	unsigned int keycode;	/* detail */
+	KeyCode keycode;	/* detail */
 	Bool same_screen;	/* same screen flag */
 	char trans_chars[XMaxTransChars];
 				/* translated characters */
-- 
cgit v0.12


From bde460e4e8f7c8699df2529320cda972331aeb15 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Wed, 29 Apr 2020 21:56:02 +0000
Subject: Follow Jan's sage advice and revert the xlib files.

---
 xlib/X11/X.h    | 2 +-
 xlib/X11/Xlib.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/xlib/X11/X.h b/xlib/X11/X.h
index 22f99c0..c2c57af 100644
--- a/xlib/X11/X.h
+++ b/xlib/X11/X.h
@@ -63,7 +63,7 @@ typedef unsigned long VisualID;
 
 typedef unsigned long Time;
 
-typedef unsigned int KeyCode;	/* In order to use IME, the Macintosh needs
+typedef unsigned long KeyCode;	/* In order to use IME, the Macintosh needs
 				 * to pack 3 bytes into the keyCode field in
 				 * the XEvent.  In the real X.h, a KeyCode is
 				 * defined as a short, which wouldn't be big
diff --git a/xlib/X11/Xlib.h b/xlib/X11/Xlib.h
index e737e88..af8f706 100644
--- a/xlib/X11/Xlib.h
+++ b/xlib/X11/Xlib.h
@@ -547,7 +547,7 @@ typedef struct {
 	int x, y;		/* pointer x, y coordinates in event window */
 	int x_root, y_root;	/* coordinates relative to root */
 	unsigned int state;	/* key or button mask */
-	KeyCode keycode;	/* detail */
+	unsigned int keycode;	/* detail */
 	Bool same_screen;	/* same screen flag */
 	char trans_chars[XMaxTransChars];
 				/* translated characters */
-- 
cgit v0.12


From 110d19785b7a3b12c915e9d3e3d6bacf2120ce62 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Thu, 30 Apr 2020 01:37:50 +0000
Subject: Add missing braces.  Thanks to Christopher Chavez.

---
 macosx/tkMacOSXKeyboard.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 4e04bae..e838a78 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -428,12 +428,13 @@ XKeycodeToKeysym(
      * keysym.
      */
 
-    if (virtual == NO_VIRTUAL)
+    if (virtual == NO_VIRTUAL) {
 	hPtr = Tcl_FindHashEntry(&unichar2keysym,
 				 INT2PTR(keycode & MAC_KEYCHAR_MASK));
 	if (hPtr != NULL) {
 	    return (KeySym) Tcl_GetHashValue(hPtr);
 	}
+    }
 
     /*
      * If not, use the Carbon Framework to find the unicode character and
-- 
cgit v0.12


From c2d1aabbc5e01887c47d018f0d0197eaca54c1de Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Thu, 30 Apr 2020 01:56:57 +0000
Subject: Edit some comments.

---
 macosx/tkMacOSXKeyboard.c | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index e838a78..21a9890 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -639,7 +639,8 @@ XKeysymToKeycodeWithIndex(
     }
 
     /*
-     * Would not construct a keycode.  Set the keychar to 0.
+     * Could not construct a keycode.  Set the keychar to 0 and the
+     * virtual keycode to NO_VIRTUAL.
      */
 
     return (NO_VIRTUAL << 24) ;
@@ -668,9 +669,9 @@ XKeysymToKeycode(
  * Side effects:
  *
  *	Modifies the XEvent. Sets the xkey.keycode to a keycode value formatted
- *	by XKeysymToKeycode and sets the shift and option flags in xkey.state
- *	to the values implied by the keysym. Also fills in xkey.trans_chars for
- *	printable events.
+ *	by XKeysymToKeycode and updates the shift and option flags in
+ *	xkey.state if either of those modifiers is required to generate the
+ *	keysym. Also fills in xkey.trans_chars for printable events.
  *
  *----------------------------------------------------------------------
  */
@@ -691,13 +692,13 @@ TkpSetKeycodeAndState(
 
 	/*
 	 * We now have a virtual keycode and a minimal choice of Shift and
-	 * Option modifiers which which generates the keychar that corresponds
-	 * to the specified keysym.  But we might not have the correct keychar
-	 * yet, because the xEvent may have specified modifiers beyond our
-	 * minimal set.  For example, the events described by <Oslash>,
-	 * <Shift-oslash>, <Shift-Option-O> and <Shift-Option-o> should all
-	 * produce the same uppercase Danish O.  So we may need to add some
-	 * extra modifiers and do another lookup for the keychar.
+	 * Option modifiers which generates the keychar that corresponds to the
+	 * specified keysym.  But we might not have the correct keychar yet,
+	 * because the xEvent may have specified modifiers beyond our minimal
+	 * set.  For example, the events described by <Oslash>, <Shift-oslash>,
+	 * <Shift-Option-O> and <Shift-Option-o> should all produce the same
+	 * uppercase Danish O.  So we may need to add some extra modifiers and
+	 * do another lookup for the keychar.
 	 */
 
 	if (index != eventIndex) {
-- 
cgit v0.12


From b1025441afc7caaf80c4748b32fcb7086854da14 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Thu, 30 Apr 2020 03:05:43 +0000
Subject: Do a little better with keypad keys and shifting keysyms that are not
 on the keyboard.

---
 macosx/tkMacOSXKeyboard.c | 43 +++++++++++++++++++++++++++----------------
 1 file changed, 27 insertions(+), 16 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 21a9890..72d4a46 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -235,11 +235,12 @@ InitHashTables(void)
  *
  * UpdateKeymaps --
  *
- *	Called when the keyboard changes to update the hash table that
- *      maps unicode characters to virtual keycodes with states.  In order
- *      for this to be well-defined we have to ignore virtual keycodes for
- *      keypad keys, since each keypad key has the same character as the
- *      corresponding key on the main keyboard.
+ *	Called when the keyboard changes to update the hash tables that provide
+ *      maps between unicode characters and virtual keycodes with indexes.  In
+ *      order for the map from characters to virtual keycodes to be
+ *      well-defined we have to ignore virtual keycodes for keypad keys, since
+ *      each keypad key has the same character as the corresponding key on the
+ *      main keyboard.
  *
  * Results:
  *	None.
@@ -267,22 +268,21 @@ UpdateKeymaps()
     }
 
     /*
-     * This for loop goes backwards so that a unichar lookup will
-     * provide the minimal modifier mask.  Simpler combinations
-     * will overwrite more complex ones.
+     * This loop goes backwards so that a unichar lookup will provide the
+     * minimal modifier mask.  Simpler combinations will overwrite more complex
+     * ones when constructing the table.
      */
 
     for (index = 4; index >= 0; index--) {
 	for (virtual = 0; virtual <= VIRTUAL_MAX; virtual++) {
-	    if (ON_KEYPAD(virtual)) {
-		continue;
+	    if (! ON_KEYPAD(virtual)) {
+		modifiers = INDEX2CARBON(index);
+		KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual,
+				 modifiers, NULL);
+		hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keychar),
+					   &dummy);
+		Tcl_SetHashValue(hPtr, INT2PTR(index << 8 | virtual));
 	    }
-	    modifiers = INDEX2CARBON(index);
-	    KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual, modifiers,
-			     NULL);
-	    hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keychar),
-				       &dummy);
-	    Tcl_SetHashValue(hPtr, INT2PTR(index << 8 | virtual));
 	    hPtr = Tcl_CreateHashEntry(&virtual2unichar,
 				       INT2PTR(index << 8 | virtual), &dummy);
 	    Tcl_SetHashValue(hPtr, INT2PTR(keychar));
@@ -708,6 +708,17 @@ TkpSetKeycodeAndState(
 				     INT2PTR(eventIndex << 8 | virtual));
 	    if (hPtr != NULL) {
 		keychar = ((UniChar) Tcl_GetHashValue(hPtr));
+	    } else if (eventIndex & INDEX_SHIFT) {
+
+		/*
+		 * Even though the keychar is not on the keyboard, we can still
+		 * apply the Shift modifier. However, we can't guess the effect
+		 * of the Option modifier and so must ignore it.
+		 */
+
+		NSString *upper = [[[NSString alloc] initWithCharacters:&keychar
+				      length:1] uppercaseString];
+		keychar = [upper characterAtIndex:0];
 	    }
 	    keycode = virtual << 24 | keychar;
 	}
-- 
cgit v0.12


From 937dc6352aa45ed6fde47e54080a3eee3fd2dedf Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Sun, 3 May 2020 03:03:11 +0000
Subject: Replace one hash table with an array; make keycodes work in text and
 entry; use bitfields; stop bind from sign extending keycodes.

---
 generic/tkBind.c          |   6 +-
 macosx/tkMacOSXKeyEvent.c |  89 +++++++++----
 macosx/tkMacOSXKeyboard.c | 323 ++++++++++++++++++++++------------------------
 macosx/tkMacOSXPrivate.h  |  64 ++++++++-
 4 files changed, 280 insertions(+), 202 deletions(-)

diff --git a/generic/tkBind.c b/generic/tkBind.c
index 1443270..76b0f00 100644
--- a/generic/tkBind.c
+++ b/generic/tkBind.c
@@ -3203,7 +3203,11 @@ ExpandPercents(
 	}
 
 	if (number != NO_NUMBER) {
-	    snprintf(numStorage, sizeof(numStorage), "%d", (int) number);
+	    if (evPtr->type != MouseWheelEvent) {
+		snprintf(numStorage, sizeof(numStorage), "%ld", number);
+	    } else {
+		snprintf(numStorage, sizeof(numStorage), "%d", (int) number);
+	    }		
 	    string = numStorage;
 	}
 	{   /* local scope */
diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index c2445b9..f710040 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -19,7 +19,7 @@
 #include "tkMacOSXWm.h"
 
 /*
- * See tkMacOSXPrivate.h for the definition of IS_PRINTABLE.
+ * See tkMacOSXPrivate.h for macros related to key event processing.
  */
 
 /*
@@ -27,6 +27,7 @@
 #define TK_MAC_DEBUG_KEYBOARD
 #endif
 */
+
 #define NS_KEYLOG 0
 #define XEVENT_MOD_MASK (ControlMask | Mod1Mask | Mod3Mask | Mod4Mask)
 static Tk_Window keyboardGrabWinPtr = NULL; /* Current keyboard grab window. */
@@ -56,11 +57,13 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     NSUInteger modifiers = ([theEvent modifierFlags] &
 			    NSDeviceIndependentModifierFlagsMask);
     XEvent xEvent;
+    MacKeycode macKC;
     UniChar keychar = 0;
     Bool can_input_text, has_modifiers = NO, use_text_input = NO;
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray = nil;
 
+
     if (nsEvArray == nil) {
         nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
         processingCompose = NO;
@@ -92,6 +95,13 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     if (type == NSKeyUp || type == NSKeyDown) {
 	if ([[theEvent characters] length] > 0) {
 	    keychar = [[theEvent characters] characterAtIndex:0];
+#if 0   /* Currently, real keys always send BMP characters. */
+	    if (CFStringIsSurrogateHighCharacter(keychar)) {
+		UniChar lowChar = [str characterAtIndex:1];
+		keychar = CFStringGetLongCharacterForSurrogatePair(
+		    (UniChar)keychar, lowChar);
+	    }
+#endif
 	} else {
 
 	    /*
@@ -101,12 +111,14 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
 	    use_text_input = YES;
 	}
+
 #if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
 	TKLog(@"-[%@(%p) %s] repeat=%d mods=%x char=%x code=%lu c=%d type=%d",
 	      [self class], self, _cmd,
 	      (type == NSKeyDown) && [theEvent isARepeat], modifiers, keychar,
 	      virtual, w, type);
 #endif
+
     }
 
     /*
@@ -120,12 +132,13 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     focusWinPtr = TkFocusKeyEvent(winPtr, &xEvent);
     if (focusWinPtr == NULL) {
 	TKContentView *contentView = [w contentView];
+
 	/*
-	 * This NSEvent is being sent to a window which no longer has focus.
-	 * This has been observed to happen when the user deactivates the Tk
-	 * app while the NSTextInputClient's popup character selection window
-	 * is still open.  We attempt to abandon any ongoing composition
-	 * operation and discard the event.
+	 * This NSEvent is being sent to a window which does not have focus.
+	 * This could mean, for example, that the user deactivated the Tk app
+	 * while the NSTextInputClient's popup character selection window was
+	 * still open.  We attempt to abandon any ongoing composition operation
+	 * and discard the event.
 	 */
 
 	[contentView cancelComposingText];
@@ -162,9 +175,9 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
 	/*
 	 * In IME the Enter key is used to terminate a composition sequence.
-	 * when there are multiple choices of input text available, and the
-	 * user's selected choice is not the default it may be necessary to hit
-	 * the Enter key multiple times before the text is accepted and
+	 * When there are multiple choices of input text available, and the
+	 * user's selected choice is not the default, it may be necessary to
+	 * hit the Enter key multiple times before the text is accepted and
 	 * rendered (See ticket 39de9677aa]). So when sending an Enter key
 	 * during composition, we continue sending Enter keys until the
 	 * inputText method has cleared the processingCompose flag.
@@ -189,7 +202,9 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * finish constructing the XEvent and queue it.
      */
 
-    xEvent.xkey.keycode = (virtual << 24) | keychar;
+    macKC.v.o_s =  ((modifiers & NSShiftKeyMask ? INDEX_SHIFT : 0) |
+		    (modifiers & NSAlternateKeyMask ? INDEX_OPTION : 0));
+    macKC.v.virtual = virtual;
     switch (type) {
     case NSFlagsChanged:
 
@@ -204,12 +219,11 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	savedModifiers = modifiers;
 
 	/*
-	 * Set the keychar to 0xF8FF, the largest value reserved for a function
-	 * key, as a signal to TkpGetKeySym (see tkMacOSXKeyboard.c) that this
-	 * is a modifier key event.
+	 * Set the keychar to MOD_KEYCHAR as a signal to TkpGetKeySym (see
+	 * tkMacOSXKeyboard.c) that this is a modifier key event.
 	 */
 
-	xEvent.xkey.keycode |= 0xF8FF;
+	keychar = MOD_KEYCHAR;
 	break;
     case NSKeyUp:
 	xEvent.xany.type = KeyRelease;
@@ -220,6 +234,8 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     default:
 	return theEvent; /* Unrecognized key event. */
     }
+    macKC.v.keychar = keychar;
+    xEvent.xkey.keycode = macKC.uint;
 
     /*
      * Set the trans_chars for keychars outside of the private-use range.
@@ -285,8 +301,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	TKLog(@"insertText '%@'\tlen = %d", aString, len);
     }
 
-    processingCompose = NO;
-
     /*
      * Clear any working text.
      */
@@ -317,27 +331,46 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
     /*
      * Next we generate an XEvent for each unicode character in our string.
+     * This string could contain non-BMP characters, for example if the
+     * emoji palette was used.
      *
      * NSString uses UTF-16 internally, which means that a non-BMP character is
-     * represented by a sequence of two 16-bit "surrogates".  In principle we
-     * could record this in the XEvent by setting the keycode to the 32-bit
-     * unicode code point and setting the trans_chars string to the 4-byte
-     * UTF-8 string for the non-BMP character.  However, that will not work
-     * when TCL_UTF_MAX is set to 3, as is the case for Tcl 8.6.  A workaround
-     * used internally by Tcl 8.6 is to encode each surrogate as a 3-byte
-     * sequence using the UTF-8 algorithm (ignoring the fact that the UTF-8
-     * encoding specification does not allow encoding UTF-16 surrogates).
-     * This gives a 6-byte encoding of the non-BMP character which we write into
-     * the trans_chars field of the XEvent.
+     * represented by a sequence of two 16-bit "surrogates".  We record this in
+     * the XEvent by setting the low order 21-bits of the keycode to the UCS-32
+     * value value of the character and the virtual keycode in the high order
+     * byte to the special value NON_BMP. In principle we could set the
+     * trans_chars string to the UTF-8 string for the non-BMP character.
+     * However, that will not work when TCL_UTF_MAX is set to 3, as is the case
+     * for Tcl 8.6.  A workaround used internally by Tcl 8.6 is to encode each
+     * surrogate as a 3-byte sequence using the UTF-8 algorithm (ignoring the
+     * fact that the UTF-8 encoding specification does not allow encoding
+     * UTF-16 surrogates).  This gives a 6-byte encoding of the non-BMP
+     * character which we write into the trans_chars field of the XEvent.
      */
 
     for (i = 0; i < len; i++) {
 	unsigned int code;
+	UniChar keychar;
+	MacKeycode macKC = {0};
+
+	keychar = [str characterAtIndex:i];
+	macKC.v.keychar = keychar;
+	if (CFStringIsSurrogateHighCharacter(keychar)) {
+	    UniChar lowChar = [str characterAtIndex:i+1];
+	    macKC.v.keychar = CFStringGetLongCharacterForSurrogatePair(
+				  (UniChar)keychar, lowChar);
+	    macKC.v.virtual = NON_BMP_VIRTUAL;
+	} else if (repRange.location == 0) {
+	    macKC.v.virtual = REPLACEMENT_VIRTUAL;
+	} else {
+	    macKC.v.virtual = TkMacOSXGetVirtual(macKC.uint);
+	    xEvent.xkey.state |= INDEX2STATE(macKC.x.xvirtual);
+	}
 	TkUtfAtIndex(str, i, xEvent.xkey.trans_chars, &code);
 	if (code > 0xFFFF){
 	    i++;
 	}
-	xEvent.xkey.keycode = code;
+	xEvent.xkey.keycode = macKC.uint;
     	xEvent.xany.type = KeyPress;
     	Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
     }
@@ -400,10 +433,10 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     TkSendVirtualEvent(focusWin, "TkStartIMEMarkedText", NULL);
+    processingCompose = YES;
     temp = [str copy];
     [self insertText: temp replacementRange:repRange];
     privateWorkingText = temp;
-    processingCompose = YES;
     TkSendVirtualEvent(focusWin, "TkEndIMEMarkedText", NULL);
 }
 
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 72d4a46..cef729e 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -95,60 +95,40 @@
  * The macosx platform-specific scheme for generating a keycode when mapping an
  * NSEvent of type KeyUp, KeyDown or FlagsChanged to an XEvent of type KeyPress
  * or KeyRelease is as follows:
- *     keycode = (virtual << 24) | keychar
+ *     keycode = (virtual << 24) | index << 22 | keychar
+ * where index is a 2-bit quantity whose bits indicate the state of the Option
+ * and Shift keys.
+ *
  * A few remarks are in order.  First, we are using 32 bits for the keycode and
- * we are allowing room for up to 24 bits for the keychar.  This means that
+ * we are allowing room for up to 22 bits for the keychar.  This means that
  * there is enough room in the keycode to hold a UTF-32 character, which only
- * requires 21 bits.  So, in the future, when macs have emoji keyboards, no
- * change will be needed in how keycodes are generated.  Second, the KeyCode
- * type for the keycode field in an XEvent is currently defined as unsigned
- * int, which was modified from the unsigned short used in X11 in order to
- * accomodate macOS. Finally, there is no obstruction to generating KeyPress
- * events for keys that represent letters which do not exist on the current
- * keyboard layout.  And different keyboard layouts can assign a given letter
- * to different keys.  So we need a convention for what value to assign to
- * "virtual" when computing the keycode for a generated event.  The convention
- * used here is as follows: If there is a key on the current keyboard which
- * produces the keychar, use the virtual keycode of that key.  Otherwise set
- * virtual = NO_VIRTUAL.
- */
-
-
-/*
- * See tkMacOSXPrivate.h for the definition of IS_PRINTABLE.
+ * requires 21 bits.  Second, the KeyCode type for the keycode field in an
+ * XEvent is currently defined as unsigned int, which was modified from the
+ * unsigned short used in X11 in order to accomodate macOS. Finally, there is
+ * no obstruction to generating KeyPress events for keys that represent letters
+ * which do not exist on the current keyboard layout.  And different keyboard
+ * layouts can assign a given letter to different keys.  So we need a
+ * convention for what value to assign to "virtual" when computing the keycode
+ * for a generated event.  The convention used here is as follows: If there is
+ * a key on the current keyboard which produces the keychar, use the virtual
+ * keycode of that key.  Otherwise set virtual = NO_VIRTUAL.
  */
 
-#define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
-#define VIRTUAL_MAX	 0x7F
-#define NO_VIRTUAL 0xFF
-#define MAC_KEYCHAR_MASK 0xFFFFFF
-#define MOD_KEYCHAR 0xF8FE
 
 /*
- * An "index" is an int containing two modifier flags for Option and Shift
- * in bits 0-1.  It is used as an index when building the keymap hash
- * tables.
+ * See tkMacOSXPrivate.h for macros related to key event processing.
  */
 
-#define INDEX_SHIFT 1
-#define INDEX_OPTION 2
-#define INDEX2STATE(index) ((index & INDEX_SHIFT ? ShiftMask : 0) |	\
-			    (index & INDEX_OPTION ? Mod2Mask : 0))
-#define INDEX2CARBON(index) ((index & INDEX_SHIFT ? shiftKey : 0) |	\
-			     (index & INDEX_OPTION ? optionKey : 0))
-#define STATE2INDEX(state) ((state & ShiftMask ? INDEX_SHIFT : 0) |	\
-			    (state & Mod2Mask ? INDEX_OPTION : 0))
-
 /*
- * Hash tables used to translate between various key attributes.
+ * Hash tables and array used to translate between various key attributes.
  */
 
-static Tcl_HashTable virtual2keysym;	/* Special virtual keycode to keysym */
+static Tcl_HashTable special2keysym;	/* Special virtual keycode to keysym */
 static Tcl_HashTable keysym2keycode;	/* keysym to XEvent keycode */
 static Tcl_HashTable keysym2unichar;	/* keysym to unichar */
 static Tcl_HashTable unichar2keysym;	/* unichar to X11 keysym */
-static Tcl_HashTable unichar2virtual;	/* unichar to virtual with index */
-static Tcl_HashTable virtual2unichar;	/* virtual with index to unichar */
+static Tcl_HashTable unichar2xvirtual;	/* unichar to virtual with index */
+static UniChar xvirtual2unichar[512];	/* virtual with index to unichar */
 
 /*
  * Flags.
@@ -206,15 +186,19 @@ InitHashTables(void)
     const KeysymInfo *ksPtr;
     int dummy;
 
-    Tcl_InitHashTable(&virtual2keysym, TCL_ONE_WORD_KEYS);
+    Tcl_InitHashTable(&special2keysym, TCL_ONE_WORD_KEYS);
     Tcl_InitHashTable(&keysym2keycode, TCL_ONE_WORD_KEYS);
     for (kPtr = keyArray; kPtr->virtual != 0; kPtr++) {
-	hPtr = Tcl_CreateHashEntry(&virtual2keysym, INT2PTR(kPtr->virtual),
+	MacKeycode keycode;
+	keycode.v.o_s = 0;
+	hPtr = Tcl_CreateHashEntry(&special2keysym, INT2PTR(kPtr->virtual),
 				   &dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keysym));
 	hPtr = Tcl_CreateHashEntry(&keysym2keycode, INT2PTR(kPtr->keysym),
 				   &dummy);
-	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keychar | (kPtr->virtual << 24)));
+	keycode.v.virtual = kPtr->virtual;
+	keycode.v.keychar = kPtr->keychar;
+	Tcl_SetHashValue(hPtr, INT2PTR(keycode.uint));
     }
     Tcl_InitHashTable(&keysym2unichar, TCL_ONE_WORD_KEYS);
     Tcl_InitHashTable(&unichar2keysym, TCL_ONE_WORD_KEYS);
@@ -246,7 +230,8 @@ InitHashTables(void)
  *	None.
  *
  * Side effects:
- *	Initializes, if necessary, and updates the unichar2virtual table.
+ *	Initializes, if necessary, and updates the unichar2xvirtual hash table
+ *      and the xvirtual2unichar array.
  *
  *----------------------------------------------------------------------
  */
@@ -254,38 +239,38 @@ InitHashTables(void)
 static void
 UpdateKeymaps()
 {
-    static int keymapInitialized = 0;
-    UniChar keychar;
+    static Bool keymapInitialized = false;
     Tcl_HashEntry *hPtr;
-    int virtual, index, modifiers, dummy;
+    int virtual, index, dummy;
 
     if (!keymapInitialized) {
-	Tcl_InitHashTable(&unichar2virtual, TCL_ONE_WORD_KEYS);
-	Tcl_InitHashTable(&virtual2unichar, TCL_ONE_WORD_KEYS);
+	Tcl_InitHashTable(&unichar2xvirtual, TCL_ONE_WORD_KEYS);
+	keymapInitialized = true;
     } else {
-	Tcl_DeleteHashTable(&unichar2virtual);
-	Tcl_DeleteHashTable(&virtual2unichar);
+	Tcl_DeleteHashTable(&unichar2xvirtual);
+	Tcl_InitHashTable(&unichar2xvirtual, TCL_ONE_WORD_KEYS);
     }
-
     /*
-     * This loop goes backwards so that a unichar lookup will provide the
+     * This loop goes backwards so that a lookup by keychar will provide the
      * minimal modifier mask.  Simpler combinations will overwrite more complex
      * ones when constructing the table.
      */
 
-    for (index = 4; index >= 0; index--) {
-	for (virtual = 0; virtual <= VIRTUAL_MAX; virtual++) {
+    for (index = 3; index >= 0; index--) {
+        for (virtual = 0; virtual < 128; virtual++) {
+	    MacKeycode macKC;
+	    macKC.v = (keycode_v) {.virtual = virtual, .o_s = index, .keychar = 0};
+	    int modifiers = INDEX2CARBON(index), result;
+	    UniChar keychar = 0;
+	    result = KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual,
+				      modifiers, NULL);
+	    macKC.v.keychar = keychar;
 	    if (! ON_KEYPAD(virtual)) {
-		modifiers = INDEX2CARBON(index);
-		KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual,
-				 modifiers, NULL);
-		hPtr = Tcl_CreateHashEntry(&unichar2virtual, INT2PTR(keychar),
-					   &dummy);
-		Tcl_SetHashValue(hPtr, INT2PTR(index << 8 | virtual));
-	    }
-	    hPtr = Tcl_CreateHashEntry(&virtual2unichar,
-				       INT2PTR(index << 8 | virtual), &dummy);
-	    Tcl_SetHashValue(hPtr, INT2PTR(keychar));
+		hPtr = Tcl_CreateHashEntry(&unichar2xvirtual,
+					   INT2PTR(macKC.x.keychar), &dummy);
+		Tcl_SetHashValue(hPtr, INT2PTR(macKC.x.xvirtual));
+            }
+           xvirtual2unichar[macKC.x.xvirtual] = macKC.x.keychar;
 	}
     }
 }
@@ -305,15 +290,15 @@ UpdateKeymaps()
  *
  * Results:
  *	The number of characters generated if any, 0 if we are waiting for
- *	another byte of a dead-key sequence. Fills in the uniChars array with a
- *	Unicode string.
+ *	another byte of a dead-key sequence.
  *
  * Side Effects:
- *	None
+ *	 Fills in the uniChars array with a Unicode string.
  *
  *----------------------------------------------------------------------
  */
 
+
 static int
 KeyDataToUnicode(
     UniChar *uniChars,
@@ -398,54 +383,57 @@ KeySym
 XKeycodeToKeysym(
     Display* display,
     KeyCode keycode,
-    int state)
+    int index)
 {
     Tcl_HashEntry *hPtr;
-    int virtual, modifiers = 0;
-    UniChar keyChar = 0;
-
+    MacKeycode macKC;
     (void) display; /*unused*/
+    int modifiers, result;
+    UniChar keychar = 0;
 
     if (!initialized) {
 	InitHashTables();
     }
+    macKC.uint = keycode;
+    macKC.v.o_s = index;
 
     /*
      * First check if the virtual keycode corresponds to a special key, such as
      * an Fn function key or Tab, Backspace, Home, End, etc.
      */
 
-    virtual = (keycode >> 24) & 0xFF;
-    if (virtual) {
-	hPtr = Tcl_FindHashEntry(&virtual2keysym, INT2PTR(virtual));
-	if (hPtr != NULL) {
-	    return (KeySym) Tcl_GetHashValue(hPtr);
-	}
+    hPtr = Tcl_FindHashEntry(&special2keysym, INT2PTR(macKC.v.virtual));
+    if (hPtr != NULL) {
+	return (KeySym) Tcl_GetHashValue(hPtr);
     }
 
     /*
-     * If there is no key with this keysym, try using the keychar to look up a
-     * keysym.
+     * If the virtual value does not correspond to an actual key, try using its
+     * keychar to look up a keysym.
      */
 
-    if (virtual == NO_VIRTUAL) {
-	hPtr = Tcl_FindHashEntry(&unichar2keysym,
-				 INT2PTR(keycode & MAC_KEYCHAR_MASK));
+    if (macKC.v.virtual > 127) {
+	hPtr = Tcl_FindHashEntry(&unichar2keysym, INT2PTR(macKC.v.keychar));
 	if (hPtr != NULL) {
 	    return (KeySym) Tcl_GetHashValue(hPtr);
 	}
     }
 
     /*
-     * If not, use the Carbon Framework to find the unicode character and
-     * translate it to a keysym using the unicode2keysym hash table.
+     * If the virtual keycode does belong to a key, use the virtual and the
+     * Option-Shift from index to look up a keychar; then use the Carbon
+     * Framework to find a unicode character; then translate that to a keysym
+     * using the unicode2keysym hash table.
      */
 
-    modifiers = (state & 1 ? shiftKey : 0) | (state & 2 ? optionKey : 0);
-    KeyDataToUnicode(&keyChar, 1, kUCKeyActionDown, virtual, modifiers, NULL);
-    hPtr = Tcl_FindHashEntry(&unichar2keysym, INT2PTR(keyChar));
-    if (hPtr != NULL) {
-	return (KeySym) Tcl_GetHashValue(hPtr);
+    modifiers = INDEX2CARBON(macKC.v.o_s);
+    result = KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, macKC.v.virtual,
+			      modifiers, NULL);
+    if (result) {
+	hPtr = Tcl_FindHashEntry(&unichar2keysym, INT2PTR(keychar));
+	if (hPtr != NULL) {
+	    return (KeySym) Tcl_GetHashValue(hPtr);
+	}
     }
     return NoSymbol;
 }
@@ -579,29 +567,26 @@ XStringToKeysym(
  * XKeysymToKeycode --
  *
  *	This is a stub function which converts a numerical keysym to the
- *      platform-specific keycode used in a KeyPress or KeyRelease XEvent.  The
- *      implementation calls a static function which also provides information
- *      about the modifier state, needed by TkpSetKeycodeAndState.
+ *      platform-specific keycode used in a KeyPress or KeyRelease XEvent.
  *
  * Results:
  *
- *      On macOS, a KeyCode with a unicode character in the lowest 16 bits and
- *	the 8-bit "virtual keycode" in the highest byte.  See the description
- *	of keycodes on the Macintosh at the top of this file.
+ *      A macOS KeyCode. See the description of keycodes at the top of this
+ *	file.
  *
  * Side effects:
  *	None.
  *
  *----------------------------------------------------------------------
  */
-static KeyCode
-XKeysymToKeycodeWithIndex(
+
+KeyCode
+XKeysymToKeycode(
     Display *display,
-    KeySym keysym,
-    int *index)
+    KeySym keysym)
 {
     Tcl_HashEntry *hPtr;
-
+    MacKeycode macKC;
     if (!initialized) {
 	InitHashTables();
     }
@@ -612,47 +597,32 @@ XKeysymToKeycodeWithIndex(
 
     hPtr = Tcl_FindHashEntry(&keysym2keycode, INT2PTR(keysym));
     if (hPtr != NULL) {
-	return (KeyCode) Tcl_GetHashValue(hPtr);
+	return (unsigned int) Tcl_GetHashValue(hPtr);
     }
 
     /*
-     * Next check for printable keys.
+     * Initialize the keycode as if the keysym cannot be converted to anything
+     * else.
+     */
+
+    macKC.v.virtual = NO_VIRTUAL;
+    macKC.v.o_s = 0;
+    macKC.v.keychar = 0;
+
+    /*
+     * If the keysym is recognized fill in the keychar.  Also fill in the
+     * xvirtual field if the key exists on the current keyboard.
      */
 
     hPtr = Tcl_FindHashEntry(&keysym2unichar, INT2PTR(keysym));
     if (hPtr != NULL) {
-	KeyCode character = (KeyCode) Tcl_GetHashValue(hPtr);
-	hPtr = Tcl_FindHashEntry(&unichar2virtual, INT2PTR(character));
+	macKC.x.keychar = (unsigned int) Tcl_GetHashValue(hPtr);
+	hPtr = Tcl_FindHashEntry(&unichar2xvirtual, INT2PTR(macKC.x.keychar));
 	if (hPtr != NULL) {
-	    KeyCode lookup = ((KeyCode) Tcl_GetHashValue(hPtr));
-	    KeyCode virtual = lookup & 0xFF;
-	    *index = lookup >> 8;
-	    return virtual << 24 | character;
-	} else {
-
-	    /*
-	     * The keysym does not exist on the current keyboard.
-	     */
-
-	    return (NO_VIRTUAL << 24) | character;
+	    macKC.x.xvirtual = (unsigned int) Tcl_GetHashValue(hPtr);
 	}
     }
-
-    /*
-     * Could not construct a keycode.  Set the keychar to 0 and the
-     * virtual keycode to NO_VIRTUAL.
-     */
-
-    return (NO_VIRTUAL << 24) ;
-}
-
-KeyCode
-XKeysymToKeycode(
-    Display *display,
-    KeySym keysym)
-{
-    int index;
-    return XKeysymToKeycodeWithIndex(display, keysym, &index);
+    return macKC.uint;
 }
 
 /*
@@ -684,49 +654,44 @@ TkpSetKeycodeAndState(
     if (keysym == NoSymbol) {
 	eventPtr->xkey.keycode = 0;
     } else {
-	int index = 0, eventIndex = STATE2INDEX(eventPtr->xkey.state);
-	Display *display = Tk_Display(tkwin);
-	KeyCode keycode = XKeysymToKeycodeWithIndex(display, keysym, &index);
-	UniChar keychar = keycode & MAC_KEYCHAR_MASK;
-	int virtual = (keycode >> 24) & 0xFF;
+	int eventIndex = STATE2INDEX(eventPtr->xkey.state);
+	MacKeycode macKC;
+	macKC.uint = XKeysymToKeycode(NULL, keysym);
 
 	/*
-	 * We now have a virtual keycode and a minimal choice of Shift and
-	 * Option modifiers which generates the keychar that corresponds to the
+	 * We have a virtual keycode and a minimal choice for Shift and Option
+	 * modifiers which generates the keychar that corresponds to the
 	 * specified keysym.  But we might not have the correct keychar yet,
 	 * because the xEvent may have specified modifiers beyond our minimal
 	 * set.  For example, the events described by <Oslash>, <Shift-oslash>,
 	 * <Shift-Option-O> and <Shift-Option-o> should all produce the same
-	 * uppercase Danish O.  So we may need to add some extra modifiers and
+	 * uppercase Danish O.  So we may need to add the extra modifiers and
 	 * do another lookup for the keychar.
 	 */
 
-	if (index != eventIndex) {
-	    Tcl_HashEntry *hPtr;
-	    eventIndex |= index;
-	    hPtr = Tcl_FindHashEntry(&virtual2unichar,
-				     INT2PTR(eventIndex << 8 | virtual));
-	    if (hPtr != NULL) {
-		keychar = ((UniChar) Tcl_GetHashValue(hPtr));
-	    } else if (eventIndex & INDEX_SHIFT) {
-
-		/*
-		 * Even though the keychar is not on the keyboard, we can still
-		 * apply the Shift modifier. However, we can't guess the effect
-		 * of the Option modifier and so must ignore it.
+	if (macKC.v.o_s != eventIndex) {
+	    macKC.v.o_s |= eventIndex;
+	    if (macKC.v.virtual != NO_VIRTUAL) {
+		macKC.x.keychar = xvirtual2unichar[macKC.x.xvirtual];
+	    } else if (macKC.v.o_s & INDEX_SHIFT) { //(eventIndex & INDEX_SHIFT) {
+
+	        /*
+		 * Even though this keychar is not on the keyboard, we can
+		 * still apply the Shift modifier. However, we can't guess the
+		 * effect of the Option modifier and so we ignore it.
 		 */
 
+		UniChar keychar = macKC.v.keychar;
 		NSString *upper = [[[NSString alloc] initWithCharacters:&keychar
 				      length:1] uppercaseString];
-		keychar = [upper characterAtIndex:0];
+		macKC.v.keychar = [upper characterAtIndex:0];
 	    }
-	    keycode = virtual << 24 | keychar;
 	}
-	eventPtr->xkey.keycode = keycode;
-	eventPtr->xkey.state |= INDEX2STATE(eventIndex);
-	keychar = eventPtr->xkey.keycode & MAC_KEYCHAR_MASK;
-	if (IS_PRINTABLE(keychar)) {
-	    int length = TkUniCharToUtf(keychar, eventPtr->xkey.trans_chars);
+	eventPtr->xkey.keycode = macKC.uint;
+	eventPtr->xkey.state |= INDEX2STATE(macKC.v.o_s);
+	if (IS_PRINTABLE(macKC.v.keychar)) {
+	    int length = TkUniCharToUtf(macKC.v.keychar,
+					eventPtr->xkey.trans_chars);
 	    eventPtr->xkey.trans_chars[length] = 0;
 	}
     }
@@ -759,6 +724,8 @@ TkpGetKeySym(
 {
     KeySym sym;
     int index;
+    MacKeycode macKC;
+    macKC.uint = eventPtr->xkey.keycode;
 
     /*
      * Refresh the mapping information if it's stale.
@@ -772,8 +739,8 @@ TkpGetKeySym(
      * Modifier key events have a special mac keycode (see tkProcessKeyEvent).
      */
 
-    if ((eventPtr->xkey.keycode & MAC_KEYCHAR_MASK) == MOD_KEYCHAR) {
-	switch (eventPtr->xkey.keycode >> 24) { /* the virtual keyCode */
+    if (macKC.v.keychar == MOD_KEYCHAR) {
+	switch (macKC.v.virtual) {
 	case 54:
 	    return XK_Meta_R;
 	case 55:
@@ -814,7 +781,7 @@ TkpGetKeySym(
      * First do the straightforward lookup.
      */
 
-    sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode, index);
+    sym = XKeycodeToKeysym(dispPtr->display, macKC.uint, index);
 
     /*
      * Special handling: If the key was shifted because of Lock, which is only
@@ -824,9 +791,8 @@ TkpGetKeySym(
 
     if ((index & INDEX_SHIFT) && !(eventPtr->xkey.state & ShiftMask)) {
 	if ((sym == NoSymbol) || !Tcl_UniCharIsUpper(sym)) {
-	    index &= ~INDEX_SHIFT;
-	    sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode,
-		    index);
+	    sym = XKeycodeToKeysym(dispPtr->display, macKC.uint,
+				   index & ~INDEX_SHIFT);
 	}
     }
 
@@ -836,8 +802,8 @@ TkpGetKeySym(
      */
 
     if ((index & INDEX_SHIFT) && (sym == NoSymbol)) {
-	sym = XKeycodeToKeysym(dispPtr->display, eventPtr->xkey.keycode,
-		index & ~INDEX_SHIFT);
+	sym = XKeycodeToKeysym(dispPtr->display, macKC.uint,
+			       index & ~INDEX_SHIFT);
     }
     return sym;
 }
@@ -905,6 +871,27 @@ TkpInitKeymapInfo(
     }
 }
 
+unsigned int
+TkMacOSXGetVirtual(
+    unsigned int keycode)
+{
+    MacKeycode macKC;
+    Tcl_HashEntry *hPtr;
+    macKC.uint = keycode;
+
+    if (!initialized) {
+	InitHashTables();
+    }
+
+    hPtr = Tcl_FindHashEntry(&unichar2xvirtual, INT2PTR(macKC.v.keychar));
+    if (hPtr != NULL) {
+	macKC.x.xvirtual = (unsigned int) Tcl_GetHashValue(hPtr);
+    } else {
+	macKC.v.virtual = NO_VIRTUAL;
+    }
+    return macKC.x.xvirtual;
+}
+
 /*
  * Local Variables:
  * mode: objc
diff --git a/macosx/tkMacOSXPrivate.h b/macosx/tkMacOSXPrivate.h
index 77b6272..aee2aa4 100644
--- a/macosx/tkMacOSXPrivate.h
+++ b/macosx/tkMacOSXPrivate.h
@@ -123,13 +123,66 @@
     }
 
 /*
- * Macro used in tkMacOSXKeyboard.c and tkMacOSXKeyEvent.c to check if an
- * XEvent should have a non-empty trans_chars field.
+ *  The structure of a 32-bit XEvent keycode on macOS. It may be viewed as
+ *  an unsigned int or as having either two or three bitfields.
  */
 
-#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && \
-			       (keychar != 0x7f) && \
-			       (keychar < 0xF700))
+typedef struct keycode_v_t {
+    unsigned keychar: 22;    /* UCS-32 character */
+    unsigned o_s: 2;         /* state of Option and Shift keys */
+    unsigned virtual: 8;     /* virtual keycode */
+} keycode_v;
+
+typedef struct keycode_x_t {
+    unsigned keychar: 22;     /* UCS-32 character */
+    unsigned xvirtual: 10;    /* lookup key for key maps */
+} keycode_x;
+
+typedef union MacKeycode_t {
+  unsigned int uint;
+  keycode_v v;
+  keycode_x x;
+} MacKeycode;
+
+/*
+ * Macros used in tkMacOSXKeyboard.c and tkMacOSXKeyEvent.c.
+ * Note that 0x7f is del and 0xF8FF is the Apple Logo character.
+ */
+
+#define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar != 0x7f) &&\
+                               ((keychar < 0xF700) || keychar >= 0xF8FF))
+
+/*
+ * An "index" is 2-bit bitfield showing the state of the Option and Shift
+ * keys.  It is used as an index when building the keymaps and it
+ * is the value of the o_s bitfield of a keycode_v.
+ */
+
+#define INDEX_SHIFT 1
+#define INDEX_OPTION 2
+#define INDEX2STATE(index) ((index & INDEX_SHIFT ? ShiftMask : 0) |	\
+			    (index & INDEX_OPTION ? Mod2Mask : 0))
+#define INDEX2CARBON(index) ((index & INDEX_SHIFT ? shiftKey : 0) |	\
+			     (index & INDEX_OPTION ? optionKey : 0))
+#define STATE2INDEX(state) ((state & ShiftMask ? INDEX_SHIFT : 0) |	\
+			    (state & Mod2Mask ? INDEX_OPTION : 0))
+
+/*
+ * Special values for the virtual bitfield.
+ */
+
+#define NO_VIRTUAL 0xFF /* No virtual keycode could be deduced. */
+#define REPLACEMENT_VIRTUAL 0x80 /* A BMP char sent by the NSTextInputClient. */
+#define NON_BMP_VIRTUAL 0x81 /* A non-BMP char sent by the NSTextInputClient. */
+
+/*
+ * A special character used in the keycode for modifier KeyPress or KeyRelease
+ * XEvents.  It is near the end of the private-use range but different from the
+ * UniChar 0xF8FF which Apple uses for their logo character.
+ */
+
+#define MOD_KEYCHAR 0xF8FE
 
 /*
  * Structure encapsulating current drawing environment.
@@ -248,6 +301,7 @@ MODULE_SCOPE NSString*  TkUtfToNSString(const char *source, size_t numBytes);
 MODULE_SCOPE int        TkUtfAtIndex(NSString *string, int index, char *uni,
 				      unsigned int *code);
 MODULE_SCOPE char*      TkNSStringToUtf(NSString *string, int *numBytes);
+MODULE_SCOPE unsigned int  TkMacOSXGetVirtual(unsigned int keycode);
 
 #pragma mark Private Objective-C Classes
 
-- 
cgit v0.12


From e165910b617afdb44cd2c7d08a1c289b60976d15 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Sun, 3 May 2020 16:14:18 +0000
Subject: Add comments, set virtual to REPLACEMENT_VIRTUAL when inserting IME
 text too.

---
 macosx/tkMacOSXKeyEvent.c |  7 ++++---
 macosx/tkMacOSXKeyboard.c | 29 ++++++++++++++++++++++++++---
 macosx/tkMacOSXPrivate.h  |  2 +-
 3 files changed, 31 insertions(+), 7 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index f710040..5913957 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -36,7 +36,6 @@ static NSModalSession modalSession = nil;
 static BOOL processingCompose = NO;
 static Tk_Window composeWin = NULL;
 static int caret_x = 0, caret_y = 0, caret_height = 0;
-
 static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 
@@ -292,6 +291,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     NSString *str;
     TkWindow *winPtr = TkMacOSXGetTkWindow([self window]);
     Tk_Window tkwin = (Tk_Window) winPtr;
+    Bool sendingIMEText = NO;
 
     str = ([aString isKindOfClass: [NSAttributedString class]]) ?
         [aString string] : aString;
@@ -306,6 +306,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     if (privateWorkingText != nil) {
+	sendingIMEText = YES;
     	[self deleteWorkingText];
     }
 
@@ -360,10 +361,10 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	    macKC.v.keychar = CFStringGetLongCharacterForSurrogatePair(
 				  (UniChar)keychar, lowChar);
 	    macKC.v.virtual = NON_BMP_VIRTUAL;
-	} else if (repRange.location == 0) {
+	} else if (repRange.location == 0 || sendingIMEText) {
 	    macKC.v.virtual = REPLACEMENT_VIRTUAL;
 	} else {
-	    macKC.v.virtual = TkMacOSXGetVirtual(macKC.uint);
+	    macKC.uint = TkMacOSXAddVirtual(macKC.uint);
 	    xEvent.xkey.state |= INDEX2STATE(macKC.x.xvirtual);
 	}
 	TkUtfAtIndex(str, i, xEvent.xkey.trans_chars, &code);
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index cef729e..f9708c1 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -673,7 +673,7 @@ TkpSetKeycodeAndState(
 	    macKC.v.o_s |= eventIndex;
 	    if (macKC.v.virtual != NO_VIRTUAL) {
 		macKC.x.keychar = xvirtual2unichar[macKC.x.xvirtual];
-	    } else if (macKC.v.o_s & INDEX_SHIFT) { //(eventIndex & INDEX_SHIFT) {
+	    } else if (macKC.v.o_s & INDEX_SHIFT) {
 
 	        /*
 		 * Even though this keychar is not on the keyboard, we can
@@ -871,8 +871,31 @@ TkpInitKeymapInfo(
     }
 }
 
+/*
+ *--------------------------------------------------------------
+ *
+ * TkMacOSXAddVirtual --
+ *
+ *	This procedure is an internal utility which accepts an unsigned int
+ *      that has been partially filled as a MacKeycode, having the Option and
+ *      Shift state set in the o_s field and the keychar field set but with the
+ *      virtual keycode blank.  It looks up the virtual keycode for the keychar
+ *      (possibly NO_VIRTUAL) and returns an unsigned int which is a complete
+ *      MacKeycode with the looked up virtual keycode added.  This is used when
+ *      creating XEvents for the unicode characters which are generated by the
+ *      NSTextInputClient.
+ *
+ * Results:
+ *      An unsigned int which is a complete MacKeycode, including a virtual
+ *	keycode which matches the Option-Shift state and keychar.
+ *
+ * Side effects:
+ *	None
+ *
+ *--------------------------------------------------------------
+ */
 unsigned int
-TkMacOSXGetVirtual(
+TkMacOSXAddVirtual(
     unsigned int keycode)
 {
     MacKeycode macKC;
@@ -889,7 +912,7 @@ TkMacOSXGetVirtual(
     } else {
 	macKC.v.virtual = NO_VIRTUAL;
     }
-    return macKC.x.xvirtual;
+    return macKC.uint;
 }
 
 /*
diff --git a/macosx/tkMacOSXPrivate.h b/macosx/tkMacOSXPrivate.h
index aee2aa4..292902c 100644
--- a/macosx/tkMacOSXPrivate.h
+++ b/macosx/tkMacOSXPrivate.h
@@ -301,7 +301,7 @@ MODULE_SCOPE NSString*  TkUtfToNSString(const char *source, size_t numBytes);
 MODULE_SCOPE int        TkUtfAtIndex(NSString *string, int index, char *uni,
 				      unsigned int *code);
 MODULE_SCOPE char*      TkNSStringToUtf(NSString *string, int *numBytes);
-MODULE_SCOPE unsigned int  TkMacOSXGetVirtual(unsigned int keycode);
+MODULE_SCOPE unsigned int  TkMacOSXAddVirtual(unsigned int keycode);
 
 #pragma mark Private Objective-C Classes
 
-- 
cgit v0.12


From aa7fd4173bbd1149b15dfe1d97a38fa23d4f4cee Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Sun, 3 May 2020 19:49:45 +0000
Subject: make injectkeyevent accept a numerical keysym instead of a virtual
 key code.

---
 macosx/tkMacOSXKeyboard.c |  3 +--
 macosx/tkMacOSXPrivate.h  |  2 +-
 macosx/tkMacOSXTest.c     | 38 +++++++++++++++++---------------------
 3 files changed, 19 insertions(+), 24 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index f9708c1..004a1eb 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -894,7 +894,7 @@ TkpInitKeymapInfo(
  *
  *--------------------------------------------------------------
  */
-unsigned int
+unsigned
 TkMacOSXAddVirtual(
     unsigned int keycode)
 {
@@ -914,7 +914,6 @@ TkMacOSXAddVirtual(
     }
     return macKC.uint;
 }
-
 /*
  * Local Variables:
  * mode: objc
diff --git a/macosx/tkMacOSXPrivate.h b/macosx/tkMacOSXPrivate.h
index 292902c..7903c6a 100644
--- a/macosx/tkMacOSXPrivate.h
+++ b/macosx/tkMacOSXPrivate.h
@@ -301,7 +301,7 @@ MODULE_SCOPE NSString*  TkUtfToNSString(const char *source, size_t numBytes);
 MODULE_SCOPE int        TkUtfAtIndex(NSString *string, int index, char *uni,
 				      unsigned int *code);
 MODULE_SCOPE char*      TkNSStringToUtf(NSString *string, int *numBytes);
-MODULE_SCOPE unsigned int  TkMacOSXAddVirtual(unsigned int keycode);
+MODULE_SCOPE unsigned   TkMacOSXAddVirtual(unsigned int keycode);
 
 #pragma mark Private Objective-C Classes
 
diff --git a/macosx/tkMacOSXTest.c b/macosx/tkMacOSXTest.c
index a4809a4..d465492 100644
--- a/macosx/tkMacOSXTest.c
+++ b/macosx/tkMacOSXTest.c
@@ -236,14 +236,15 @@ InjectKeyEventObjCmd(
 	"-shift", "-control", "-option", "-command", "-x", "-y", NULL};
     enum args {KEYEVENT_SHIFT, KEYEVENT_CONTROL, KEYEVENT_OPTION,
 	       KEYEVENT_COMMAND, KEYEVENT_X, KEYEVENT_Y};
-    int i, index, key, mods = 0, x = 0, y = 0;
-    NSString *keyChar, *unmod;
+    int i, index, keysym, mods = 0, x = 0, y = 0;
+    NSString *chars = nil;
     NSEvent *keyEvent;
     NSUInteger type;
+    MacKeycode macKC;
     
-    if (objc < 4) {
+    if (objc < 3) {
     wrongArgs:
-        Tcl_WrongNumArgs(interp, 1, objv, "option key char ?arg?");
+        Tcl_WrongNumArgs(interp, 1, objv, "option keysym ?arg?");
         return TCL_ERROR;
     }
     if (Tcl_GetIndexFromObj(interp, objv[1], optionStrings, "option", 0,
@@ -251,22 +252,14 @@ InjectKeyEventObjCmd(
         return TCL_ERROR;
     }
     type = types[index];
-    if (Tcl_GetIntFromObj(interp, objv[2], &key) != TCL_OK) {
+    if (Tcl_GetIntFromObj(interp, objv[2], &keysym) != TCL_OK) {
 	Tcl_SetObjResult(interp, Tcl_ObjPrintf(
-			 "virtual key code must be an integer"));
-	Tcl_SetErrorCode(interp, "TK", "TEST", "INJECT", "KEY", NULL);
+			 "keysym must be an integer"));
+	Tcl_SetErrorCode(interp, "TK", "TEST", "INJECT", "KEYSYM", NULL);
 	return TCL_ERROR;
     }
-    if (key < 0 || key > 127) {
-	Tcl_SetObjResult(interp, Tcl_ObjPrintf(
-			 "virtual key code must be between 0 and 127"));
-	Tcl_SetErrorCode(interp, "TK", "TEST", "INJECT", "KEY", NULL);
-        return TCL_ERROR;
-    }
-    keyChar = [[[NSString alloc] initWithUTF8String:Tcl_GetString(objv[3])]
-		  autorelease];
-    unmod = keyChar;
-    for (i = 4; i < objc; i++) {
+    macKC.uint = XKeysymToKeycode(NULL, keysym);
+    for (i = 3; i < objc; i++) {
 	if (Tcl_GetIndexFromObjStruct(interp, objv[i], argStrings,
                 sizeof(char *), "option", TCL_EXACT, &index) != TCL_OK) {
             return TCL_ERROR;
@@ -274,7 +267,6 @@ InjectKeyEventObjCmd(
         switch ((enum args) index) {
 	case KEYEVENT_SHIFT:
 	    mods |= NSShiftKeyMask;
-	    unmod = [keyChar lowercaseString];
             break;
 	case KEYEVENT_CONTROL:
 	    mods |= NSShiftKeyMask;
@@ -303,16 +295,20 @@ InjectKeyEventObjCmd(
 	    break;
 	}
     }
+    if (type != NSFlagsChanged) {
+	UniChar keychar = macKC.v.keychar;
+	chars = [[NSString alloc] initWithCharacters: &keychar length:1];	
+    }
     keyEvent = [NSEvent keyEventWithType:type
 	location:NSMakePoint(x, y)
         modifierFlags:mods
 	timestamp:GetCurrentEventTime()
 	windowNumber:0
 	context:nil
-	characters:keyChar
-	charactersIgnoringModifiers:unmod
+	characters:chars
+	charactersIgnoringModifiers:chars ? [chars lowercaseString] : nil
 	isARepeat:NO
-	keyCode:key];
+	keyCode:macKC.v.virtual];
     [NSApp postEvent:keyEvent atStart:NO];
     return TCL_OK;
 }
-- 
cgit v0.12


From dd4adf36936e5abb0eecfb4a37e7b9a6cf82e16e Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Mon, 4 May 2020 22:16:09 +0000
Subject: Add non-regression tests.

---
 macosx/tkMacOSXKeyEvent.c |  31 ++++++++---
 macosx/tkMacOSXKeyboard.c |  62 ++++++++++++++-------
 macosx/tkMacOSXKeysyms.h  |  20 +++----
 macosx/tkMacOSXTest.c     |  38 +++++++++----
 tests/bind.test           | 137 ++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 240 insertions(+), 48 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 5913957..8d8ccc3 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -38,6 +38,7 @@ static Tk_Window composeWin = NULL;
 static int caret_x = 0, caret_y = 0, caret_height = 0;
 static void setupXEvent(XEvent *xEvent, Tk_Window tkwin, NSUInteger modifiers);
 static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
+static NSUInteger textInputModifiers;
 
 #pragma mark TKApplication(TKKeyEvent)
 
@@ -62,7 +63,6 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     static NSUInteger savedModifiers = 0;
     static NSMutableArray *nsEvArray = nil;
 
-
     if (nsEvArray == nil) {
         nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
         processingCompose = NO;
@@ -94,13 +94,16 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
     if (type == NSKeyUp || type == NSKeyDown) {
 	if ([[theEvent characters] length] > 0) {
 	    keychar = [[theEvent characters] characterAtIndex:0];
-#if 0   /* Currently, real keys always send BMP characters. */
+
+	    /*
+	     * Currently, real keys always send BMP characters, but who knows?
+	     */
+
 	    if (CFStringIsSurrogateHighCharacter(keychar)) {
-		UniChar lowChar = [str characterAtIndex:1];
+		UniChar lowChar = [[theEvent characters] characterAtIndex:1];
 		keychar = CFStringGetLongCharacterForSurrogatePair(
-		    (UniChar)keychar, lowChar);
+		    keychar, lowChar);
 	    }
-#endif
 	} else {
 
 	    /*
@@ -171,6 +174,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      */
 
     if (use_text_input) {
+	textInputModifiers = modifiers;
 
 	/*
 	 * In IME the Enter key is used to terminate a composition sequence.
@@ -286,9 +290,9 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 - (void)insertText: (id)aString
   replacementRange: (NSRange)repRange
 {
-    int i, len;
+    int i, len, state;
     XEvent xEvent;
-    NSString *str;
+    NSString *str, *keystr, *lower;
     TkWindow *winPtr = TkMacOSXGetTkWindow([self window]);
     Tk_Window tkwin = (Tk_Window) winPtr;
     Bool sendingIMEText = NO;
@@ -314,7 +318,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * Insert the string as a sequence of keystrokes.
      */
 
-    setupXEvent(&xEvent, tkwin, 0);
+    setupXEvent(&xEvent, tkwin, textInputModifiers);
     setXEventPoint(&xEvent, tkwin, [self window]);
     xEvent.xany.type = KeyPress;
 
@@ -349,6 +353,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
      * character which we write into the trans_chars field of the XEvent.
      */
 
+    state = xEvent.xkey.state;
     for (i = 0; i < len; i++) {
 	unsigned int code;
 	UniChar keychar;
@@ -367,6 +372,15 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	    macKC.uint = TkMacOSXAddVirtual(macKC.uint);
 	    xEvent.xkey.state |= INDEX2STATE(macKC.x.xvirtual);
 	}
+	keystr = [[NSString alloc] initWithCharacters:&keychar length:1];
+	lower = [keystr lowercaseString];
+	if (![keystr isEqual: lower]) {
+	    macKC.v.o_s |= INDEX_SHIFT;
+	    xEvent.xkey.state |= ShiftMask;
+	}
+	if (xEvent.xkey.state & Mod2Mask) {
+	    macKC.v.o_s |= INDEX_OPTION;
+	}
 	TkUtfAtIndex(str, i, xEvent.xkey.trans_chars, &code);
 	if (code > 0xFFFF){
 	    i++;
@@ -374,6 +388,7 @@ static void setXEventPoint(XEvent *xEvent, Tk_Window tkwin, NSWindow *w);
 	xEvent.xkey.keycode = macKC.uint;
     	xEvent.xany.type = KeyPress;
     	Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
+	xEvent.xkey.state = state;
     }
 }
 
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 004a1eb..920abfe 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -184,21 +184,32 @@ InitHashTables(void)
     Tcl_HashEntry *hPtr;
     const KeyInfo *kPtr;
     const KeysymInfo *ksPtr;
-    int dummy;
+    int dummy, index;
 
     Tcl_InitHashTable(&special2keysym, TCL_ONE_WORD_KEYS);
     Tcl_InitHashTable(&keysym2keycode, TCL_ONE_WORD_KEYS);
     for (kPtr = keyArray; kPtr->virtual != 0; kPtr++) {
-	MacKeycode keycode;
-	keycode.v.o_s = 0;
+	MacKeycode macKC;
+	macKC.v.o_s = 0;
 	hPtr = Tcl_CreateHashEntry(&special2keysym, INT2PTR(kPtr->virtual),
 				   &dummy);
 	Tcl_SetHashValue(hPtr, INT2PTR(kPtr->keysym));
 	hPtr = Tcl_CreateHashEntry(&keysym2keycode, INT2PTR(kPtr->keysym),
 				   &dummy);
-	keycode.v.virtual = kPtr->virtual;
-	keycode.v.keychar = kPtr->keychar;
-	Tcl_SetHashValue(hPtr, INT2PTR(keycode.uint));
+	macKC.v.virtual = kPtr->virtual;
+	macKC.v.keychar = kPtr->keychar;
+	Tcl_SetHashValue(hPtr, INT2PTR(macKC.uint));
+
+	/*
+	 * The Carbon framework does not work for finding the unicode character
+	 * of a special key.  But that does not depend on the keyboard layout,
+	 * so we can record the information here.
+	 */
+
+	for (index = 3; index >= 0; index--) {
+	    macKC.v.o_s = index;
+	    xvirtual2unichar[macKC.x.xvirtual] = macKC.x.keychar;
+	}
     }
     Tcl_InitHashTable(&keysym2unichar, TCL_ONE_WORD_KEYS);
     Tcl_InitHashTable(&unichar2keysym, TCL_ONE_WORD_KEYS);
@@ -264,13 +275,21 @@ UpdateKeymaps()
 	    UniChar keychar = 0;
 	    result = KeyDataToUnicode(&keychar, 1, kUCKeyActionDown, virtual,
 				      modifiers, NULL);
+	    if (keychar == 0x10) {
+
+		/*
+		 * This is a special key, handled in InitHashTables.
+		 */
+
+		continue;
+	    }
 	    macKC.v.keychar = keychar;
 	    if (! ON_KEYPAD(virtual)) {
 		hPtr = Tcl_CreateHashEntry(&unichar2xvirtual,
 					   INT2PTR(macKC.x.keychar), &dummy);
 		Tcl_SetHashValue(hPtr, INT2PTR(macKC.x.xvirtual));
             }
-           xvirtual2unichar[macKC.x.xvirtual] = macKC.x.keychar;
+	    xvirtual2unichar[macKC.x.xvirtual] = macKC.x.keychar;
 	}
     }
 }
@@ -666,25 +685,28 @@ TkpSetKeycodeAndState(
 	 * set.  For example, the events described by <Oslash>, <Shift-oslash>,
 	 * <Shift-Option-O> and <Shift-Option-o> should all produce the same
 	 * uppercase Danish O.  So we may need to add the extra modifiers and
-	 * do another lookup for the keychar.
+	 * do another lookup for the keychar.  We don't want to do this for
+	 * special keys, however.
 	 */
 
 	if (macKC.v.o_s != eventIndex) {
 	    macKC.v.o_s |= eventIndex;
+	}
+	if (macKC.v.keychar < 0xF700) {
+	    UniChar keychar = macKC.v.keychar;
+	    NSString *str, *lower, *upper;
 	    if (macKC.v.virtual != NO_VIRTUAL) {
 		macKC.x.keychar = xvirtual2unichar[macKC.x.xvirtual];
-	    } else if (macKC.v.o_s & INDEX_SHIFT) {
-
-	        /*
-		 * Even though this keychar is not on the keyboard, we can
-		 * still apply the Shift modifier. However, we can't guess the
-		 * effect of the Option modifier and so we ignore it.
-		 */
-
-		UniChar keychar = macKC.v.keychar;
-		NSString *upper = [[[NSString alloc] initWithCharacters:&keychar
-				      length:1] uppercaseString];
-		macKC.v.keychar = [upper characterAtIndex:0];
+	    } else {
+		str = [[NSString alloc] initWithCharacters:&keychar length:1];
+		lower = [str lowercaseString];
+		upper = [str uppercaseString];
+		if (![str isEqual: lower]) {
+		    macKC.v.o_s |= INDEX_SHIFT;
+		}
+		if (macKC.v.o_s & INDEX_SHIFT) {
+		    macKC.v.keychar = [upper characterAtIndex:0];
+		}
 	    }
 	}
 	eventPtr->xkey.keycode = macKC.uint;
diff --git a/macosx/tkMacOSXKeysyms.h b/macosx/tkMacOSXKeysyms.h
index 8e8dba6..281b5e7 100644
--- a/macosx/tkMacOSXKeysyms.h
+++ b/macosx/tkMacOSXKeysyms.h
@@ -42,16 +42,16 @@ static const KeyInfo keyArray[] = {
     {51,	XK_BackSpace,	NSDeleteCharacter},
     {52,	XK_Return,	NSNewlineCharacter},  /* Used on some Powerbooks */
     {53,	XK_Escape,	0x1B},
-    {54,	XK_Meta_R,      XK_Meta_R},
-    {55,	XK_Meta_L,	XK_Meta_L},
-    {56,	XK_Shift_L,	XK_Shift_L},
-    {57,	XK_Caps_Lock,   XK_Caps_Lock},
-    {58,	XK_Alt_L,	XK_Alt_L},
-    {59,	XK_Control_L,	XK_Control_L},
-    {60,	XK_Shift_R, 	XK_Shift_R},
-    {61,	XK_Alt_R,	XK_Alt_R},
-    {62,	XK_Control_R,	XK_Control_R},
-    {63,	XK_Super_L,	XK_Super_L},
+    {54,	XK_Meta_R,      MOD_KEYCHAR},
+    {55,	XK_Meta_L,	MOD_KEYCHAR},
+    {56,	XK_Shift_L,	MOD_KEYCHAR},
+    {57,	XK_Caps_Lock,   MOD_KEYCHAR},
+    {58,	XK_Alt_L,	MOD_KEYCHAR},
+    {59,	XK_Control_L,	MOD_KEYCHAR},
+    {60,	XK_Shift_R, 	MOD_KEYCHAR},
+    {61,	XK_Alt_R,	MOD_KEYCHAR},
+    {62,	XK_Control_R,	MOD_KEYCHAR},
+    {63,	XK_Super_L,	MOD_KEYCHAR},
     {64,	XK_F17,		NSF17FunctionKey},
     {65,	XK_KP_Decimal,	'.'},
     {67,	XK_KP_Multiply, '*'},
diff --git a/macosx/tkMacOSXTest.c b/macosx/tkMacOSXTest.c
index d465492..902bf9e 100644
--- a/macosx/tkMacOSXTest.c
+++ b/macosx/tkMacOSXTest.c
@@ -233,15 +233,15 @@ InjectKeyEventObjCmd(
 	"press", "release", "flagschanged", NULL};
     NSUInteger types[3] = {NSKeyDown, NSKeyUp, NSFlagsChanged};
     static const char *const argStrings[] = {
-	"-shift", "-control", "-option", "-command", "-x", "-y", NULL};
-    enum args {KEYEVENT_SHIFT, KEYEVENT_CONTROL, KEYEVENT_OPTION,
-	       KEYEVENT_COMMAND, KEYEVENT_X, KEYEVENT_Y};
+	"-shift", "-control", "-option", "-command", "-function", "-x", "-y", NULL};
+    enum args {KEYEVENT_SHIFT, KEYEVENT_CONTROL, KEYEVENT_OPTION, KEYEVENT_COMMAND,
+	       KEYEVENT_FUNCTION, KEYEVENT_X, KEYEVENT_Y};
     int i, index, keysym, mods = 0, x = 0, y = 0;
-    NSString *chars = nil;
+    NSString *chars = nil, *unmod = nil, *upper, *lower;
     NSEvent *keyEvent;
     NSUInteger type;
     MacKeycode macKC;
-    
+
     if (objc < 3) {
     wrongArgs:
         Tcl_WrongNumArgs(interp, 1, objv, "option keysym ?arg?");
@@ -269,13 +269,16 @@ InjectKeyEventObjCmd(
 	    mods |= NSShiftKeyMask;
             break;
 	case KEYEVENT_CONTROL:
-	    mods |= NSShiftKeyMask;
+	    mods |= NSControlKeyMask;
             break;
 	case KEYEVENT_OPTION:
-	    mods |= NSShiftKeyMask;
+	    mods |= NSAlternateKeyMask;
             break;
 	case KEYEVENT_COMMAND:
-	    mods |= NSShiftKeyMask;
+	    mods |= NSCommandKeyMask;
+            break;
+	case KEYEVENT_FUNCTION:
+	    mods |= NSFunctionKeyMask;
             break;
 	case KEYEVENT_X:
 	    if (++i >= objc) {
@@ -297,7 +300,22 @@ InjectKeyEventObjCmd(
     }
     if (type != NSFlagsChanged) {
 	UniChar keychar = macKC.v.keychar;
-	chars = [[NSString alloc] initWithCharacters: &keychar length:1];	
+	chars = [[NSString alloc] initWithCharacters: &keychar length:1];
+	upper = [chars uppercaseString];
+	lower = [chars lowercaseString];
+	if (![upper isEqual: lower] && [chars isEqual: upper]) {
+	    mods |= NSShiftKeyMask;
+	}
+	if (mods & NSShiftKeyMask) {
+	    chars = upper;
+	    unmod = lower;
+	    macKC.v.o_s |= INDEX_SHIFT;
+	} else {
+	    unmod = chars;
+	}
+	if (macKC.v.o_s & INDEX_OPTION) {
+	    mods |= NSAlternateKeyMask;
+	}
     }
     keyEvent = [NSEvent keyEventWithType:type
 	location:NSMakePoint(x, y)
@@ -306,7 +324,7 @@ InjectKeyEventObjCmd(
 	windowNumber:0
 	context:nil
 	characters:chars
-	charactersIgnoringModifiers:chars ? [chars lowercaseString] : nil
+	charactersIgnoringModifiers:unmod
 	isARepeat:NO
 	keyCode:macKC.v.virtual];
     [NSApp postEvent:keyEvent atStart:NO];
diff --git a/tests/bind.test b/tests/bind.test
index 7cb515d..05bca6f 100644
--- a/tests/bind.test
+++ b/tests/bind.test
@@ -6707,6 +6707,143 @@ test bind-34.3 {-warp works with null or negative coordinates} -setup {
 } -cleanup {
 } -result {ok ok ok ok}
 
+set keyInfo {}
+set numericKeysym {}
+proc testKey {window event type mods} {
+    global keyInfo numericKeysym
+    set keyInfo {}
+    set numericKeysym {}
+    bind $window <KeyPress> {
+	set keyInfo [format "%K,0x%%X,0x%%X,%A" %N %k]
+	set numericKeysym %N
+    }
+    focus -force $window
+    update
+    event generate $window $event
+    if {$keyInfo == {}} {
+        vwait keyInfo
+    }
+    set save $keyInfo
+    set keyInfo {}
+    set injectcmd [list injectkeyevent $type $numericKeysym]
+    foreach {option} $mods {
+	lappend injectcmd $option
+    }
+    eval $injectcmd
+    if {$keyInfo == {}} {
+        vwait keyInfo
+    }
+    if {$save != $keyInfo} {
+	return "[format "0x%x" $numericKeysym] ($mods): $save != $keyInfo"
+    }
+    return pass
+}    
+proc testKeyWithMods {window keysym type} {
+    set result [testKey $window "<$keysym>" $type {}]
+    if {$result != {pass}} {
+	return $result
+    }
+    set result [testKey $window "<Shift-$keysym>" $type {-shift}]
+    if {$result != {pass}} {
+	return $result
+    }
+    set result [testKey $window "<Option-$keysym>" $type {-option}]
+    if {$result != {pass}} {
+	return $result
+    }
+    set result [testKey $window "<Shift-Option-$keysym>" $type {-shift -option}]
+    if {$result != {pass}} {
+	return $result
+    }
+    return pass
+}
+proc testModifierKey {window event option} {
+    global KeyInfo numericKeysym
+    bind . <KeyPress> {
+	set keyInfo [format "%K,0x%%X,0x%%X,%A" %N %k]
+	set numericKeysym %N
+    }
+    wm iconify $window
+    wm deiconify $window
+    update
+    focus -force $window
+    set keyInfo {}
+    event generate $window $event
+    if {$keyInfo == {}} {
+	vwait keyInfo
+    }
+    set save $keyInfo
+    set keyInfo {}
+    injectkeyevent flagschanged $numericKeysym -shift
+    if {$keyInfo == {}} {
+	vwait keyInfo
+    }
+    if {$save != $keyInfo} {
+	return "[format "0x%x" $numericKeysym]: $save != $keyInfo"
+    } else {
+	return pass
+    }
+}
+
+test bind-35.0 {Generated and real key events agree} -constraints {aqua} -body {
+    foreach k {o O F2 Home Right Greek_sigma Greek_ALPHA} {
+	set result [testKeyWithMods . $k press]
+	if {$result != "pass"} {
+	    return $result
+	}
+    }
+    return pass
+} -cleanup {
+} -result pass
+
+test bind-35.1 {Key events agree for entry widgets} -constraints {aqua} -setup {
+    toplevel .new
+    entry .new.e
+    pack .new.e
+} -body {
+    foreach k {o O F2 Home Right Greek_sigma Greek_ALPHA} {
+	set result [testKeyWithMods .new.e $k press]
+	if {$result != "pass"} {
+	    return $result
+	}
+    }
+    return pass
+} -cleanup {
+    destroy .new.e
+    destroy .new
+} -result pass
+
+test bind-35.2 {Can bind to function keys} -constraints {aqua} -body {
+    global keyInfo numericKeysym
+    bind . <KeyPress> {}
+    bind . <KeyPress> {
+	lappend keyInfo %K
+	set numericKeysym %N
+    }
+    set keyInfo {}
+    set numericKeysym {}
+    focus -force .
+    event generate . <F2>
+    injectkeyevent press $numericKeysym -function
+    vwait keyInfo
+    return $keyInfo
+} -cleanup {
+} -result {F2 F2}
+
+## For some reason this hangs after the call to event generate:
+# test bind-35.3 {Events agree for modifier keys} -constraints {aqua} -body {
+#     return [testModifierKey . <Control_L> -control]
+# } -cleanup {
+# } -result pass
+## but this works fine:
+# $ tktest
+# % bind . <KeyPress> {puts [format "%K 0x%%X 0x%%X %A" %N %k]}
+# % event generate . <Control_L>
+# % focus -force . ; event generate . <Control_L>
+# Control_L 0xFFE3 0x3B00F8FE {}
+# focus -force . ; injectkeyevent flagschanged 0xFFE3 -control
+# % Control_L 0xFFE3 0x3B00F8FE {}
+
 # cleanup
 cleanupTests
 return
-- 
cgit v0.12


From 0ae195d498c982b984a2bc75c900d8e939a64c52 Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Tue, 5 May 2020 00:47:08 +0000
Subject: Add regression tests for modifier key events.

---
 tests/bind.test | 80 ++++++++++++++++++++++++++-------------------------------
 1 file changed, 37 insertions(+), 43 deletions(-)

diff --git a/tests/bind.test b/tests/bind.test
index 05bca6f..fb74ab8 100644
--- a/tests/bind.test
+++ b/tests/bind.test
@@ -6629,7 +6629,7 @@ test bind-34.1 {-warp works relatively to a window} -setup {
     toplevel .top
 } -body {
     # In order to avoid platform-dependent coordinate results due to
-    # decorations and borders, this test warps the pointer twice 
+    # decorations and borders, this test warps the pointer twice
     # relatively to a window that moved in the meantime, and checks
     # how much the pointer moved
     wm geometry .top +200+200
@@ -6737,7 +6737,7 @@ proc testKey {window event type mods} {
 	return "[format "0x%x" $numericKeysym] ($mods): $save != $keyInfo"
     }
     return pass
-}    
+}
 proc testKeyWithMods {window keysym type} {
     set result [testKey $window "<$keysym>" $type {}]
     if {$result != {pass}} {
@@ -6757,34 +6757,6 @@ proc testKeyWithMods {window keysym type} {
     }
     return pass
 }
-proc testModifierKey {window event option} {
-    global KeyInfo numericKeysym
-    bind . <KeyPress> {
-	set keyInfo [format "%K,0x%%X,0x%%X,%A" %N %k]
-	set numericKeysym %N
-    }
-    wm iconify $window
-    wm deiconify $window
-    update
-    focus -force $window
-    set keyInfo {}
-    event generate $window $event
-    if {$keyInfo == {}} {
-	vwait keyInfo
-    }
-    set save $keyInfo
-    set keyInfo {}
-    injectkeyevent flagschanged $numericKeysym -shift
-    if {$keyInfo == {}} {
-	vwait keyInfo
-    }
-    if {$save != $keyInfo} {
-	return "[format "0x%x" $numericKeysym]: $save != $keyInfo"
-    } else {
-	return pass
-    }
-}
-
 test bind-35.0 {Generated and real key events agree} -constraints {aqua} -body {
     foreach k {o O F2 Home Right Greek_sigma Greek_ALPHA} {
 	set result [testKeyWithMods . $k press]
@@ -6830,19 +6802,41 @@ test bind-35.2 {Can bind to function keys} -constraints {aqua} -body {
 } -cleanup {
 } -result {F2 F2}
 
-## For some reason this hangs after the call to event generate:
-# test bind-35.3 {Events agree for modifier keys} -constraints {aqua} -body {
-#     return [testModifierKey . <Control_L> -control]
-# } -cleanup {
-# } -result pass
-## but this works fine:
-# $ tktest
-# % bind . <KeyPress> {puts [format "%K 0x%%X 0x%%X %A" %N %k]}
-# % event generate . <Control_L>
-# % focus -force . ; event generate . <Control_L>
-# Control_L 0xFFE3 0x3B00F8FE {}
-# focus -force . ; injectkeyevent flagschanged 0xFFE3 -control
-# % Control_L 0xFFE3 0x3B00F8FE {}
+test bind-35.3 {Events agree for modifier keys} -constraints {aqua} -setup {
+} -body {
+    global keyInfo numericalKeysym
+    set result {}
+    bind . <KeyPress> {
+    	set keyInfo [format "%K,0x%%X,0x%%X,%A" %N %k]
+    	set numericalKeysym [format "0x%x" %N]
+    }
+    foreach event {
+	{<Control_L> -control}
+	{<Control_R> -control}
+	{<Alt_L> -option}
+	{<Alt_R> -option}
+	{<Meta_L> -command}
+	{<Meta_R> -command}
+	{<Shift_L> -shift}
+	{<Shift_R> -shift}
+    } {
+	set keyInfo {}
+	event generate . [lindex $event 0]
+	if {$keyInfo == {}} {
+	    vwait keyInfo
+	}
+	set save $keyInfo
+	injectkeyevent flagschanged $numericKeysym [lindex $event 1]
+	if {$keyInfo == {}} {
+	    vwait keyInfo
+	}
+	if {$save != $keyInfo} {
+	    return "$save != $keyInfo"
+	}
+    }
+    return pass
+} -cleanup {
+} -result pass
 
 # cleanup
 cleanupTests
-- 
cgit v0.12


From 02b68dc72bc616f661ceb403dad035461439cb29 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Tue, 5 May 2020 02:11:28 +0000
Subject: Edit comments.

---
 macosx/tkMacOSXKeyboard.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 920abfe..199d76e 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -116,7 +116,7 @@
 
 
 /*
- * See tkMacOSXPrivate.h for macros related to key event processing.
+ * See tkMacOSXPrivate.h for macros and structures related to key event processing.
  */
 
 /*
@@ -427,8 +427,9 @@ XKeycodeToKeysym(
     }
 
     /*
-     * If the virtual value does not correspond to an actual key, try using its
-     * keychar to look up a keysym.
+     * If the virtual value in this keycode does not correspond to an actual
+     * key in the current keyboard layout, try using its keychar to look up a
+     * keysym.
      */
 
     if (macKC.v.virtual > 127) {
@@ -440,9 +441,9 @@ XKeycodeToKeysym(
 
     /*
      * If the virtual keycode does belong to a key, use the virtual and the
-     * Option-Shift from index to look up a keychar; then use the Carbon
-     * Framework to find a unicode character; then translate that to a keysym
-     * using the unicode2keysym hash table.
+     * Option-Shift from index to look up a keychar by using the Carbon
+     * Framework; then translate the keychar to a keysym using the
+     * unicode2keysym hash table.
      */
 
     modifiers = INDEX2CARBON(macKC.v.o_s);
@@ -591,7 +592,7 @@ XStringToKeysym(
  * Results:
  *
  *      A macOS KeyCode. See the description of keycodes at the top of this
- *	file.
+ *	file and in tkMacOSXPrivate.h.
  *
  * Side effects:
  *	None.
@@ -796,7 +797,7 @@ TkpGetKeySym(
 
     index = STATE2INDEX(eventPtr->xkey.state);
     if (eventPtr->xkey.state & LockMask) {
-	index |= 1;
+	index |= INDEX_SHIFT;
     }
 
     /*
-- 
cgit v0.12


From c63f235278a78cc9b3f29c872814be8d1553fabf Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Tue, 5 May 2020 13:41:34 +0000
Subject: Edit another comment.

---
 macosx/tkMacOSXKeyboard.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 199d76e..d7c0064 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -300,12 +300,15 @@ UpdateKeymaps()
  * KeyDataToUnicode --
  *
  *	Given MacOS key event data this function generates the keychar.  It
- *	does this by using OS resources from the Carbon framework.
+ *	does this by using OS resources from the Carbon framework.  Note that
+ *      the Carbon functions used here are not aware of the keychars in the
+ *      private-use range which macOS now uses for special keys.  For those
+ *      keys this function returns 0x10 (ASCII dle).
  *
  *	The parameter deadKeyStatePtr can be NULL, if no deadkey handling is
  *	needed (which is always the case here).
  *
- *	This function is called from XKeycodeToKeysym().
+ *	This function is called in XKeycodeToKeysym and UpdateKeymaps.
  *
  * Results:
  *	The number of characters generated if any, 0 if we are waiting for
-- 
cgit v0.12


From 2ba6bd562b5ebdda1b68d6ea1e00defe7486801f Mon Sep 17 00:00:00 2001
From: marc_culler <marc.culler@gmail.com>
Date: Tue, 5 May 2020 16:03:41 +0000
Subject: More comment edits

---
 macosx/tkMacOSXKeyboard.c |  8 +++++---
 macosx/tkMacOSXPrivate.h  | 21 ++++++++++++---------
 2 files changed, 17 insertions(+), 12 deletions(-)

diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index d7c0064..1b8668e 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -388,8 +388,8 @@ KeyDataToUnicode(
  *
  *	This is a stub function which translates from the keycode used in an
  *      XEvent to a numerical keysym.  On macOS, the display parameter is
- *      ignored and only the the virtual keycode stored in bits 24-31 is
- *      used.
+ *      ignored and only the the virtual keycode stored in the .virtual bitfield
+ *      of a MacKeycode.v.
  *
  * Results:
  *      Returns the corresponding numerical keysym, or NoSymbol if the keysym
@@ -591,11 +591,13 @@ XStringToKeysym(
  *
  *	This is a stub function which converts a numerical keysym to the
  *      platform-specific keycode used in a KeyPress or KeyRelease XEvent.
+ *      For macOS the keycode is an unsigned int with bitfields described
+ *      in the definition of the MacKeycode type.
  *
  * Results:
  *
  *      A macOS KeyCode. See the description of keycodes at the top of this
- *	file and in tkMacOSXPrivate.h.
+ *	file and the definition of the MacKeycode type in tkMacOSXPrivate.h.
  *
  * Side effects:
  *	None.
diff --git a/macosx/tkMacOSXPrivate.h b/macosx/tkMacOSXPrivate.h
index 7903c6a..384a0df 100644
--- a/macosx/tkMacOSXPrivate.h
+++ b/macosx/tkMacOSXPrivate.h
@@ -129,13 +129,16 @@
 
 typedef struct keycode_v_t {
     unsigned keychar: 22;    /* UCS-32 character */
-    unsigned o_s: 2;         /* state of Option and Shift keys */
-    unsigned virtual: 8;     /* virtual keycode */
+    unsigned o_s: 2;         /* State of Option and Shift keys. */
+    unsigned virtual: 8;     /* 8-bit virtual keycode - identifies a key. */
 } keycode_v;
 
 typedef struct keycode_x_t {
     unsigned keychar: 22;     /* UCS-32 character */
-    unsigned xvirtual: 10;    /* lookup key for key maps */
+    unsigned xvirtual: 10;    /* Combines o_s and virtual. This 10-bit integer
+			       * is used as a key for looking up the character
+			       * produced when pressing a key with a particular
+			       * Shift and Option modifier state. */
 } keycode_x;
 
 typedef union MacKeycode_t {
@@ -150,7 +153,7 @@ typedef union MacKeycode_t {
  */
 
 #define ON_KEYPAD(virtual) ((virtual >= 0x41) && (virtual <= 0x5C))
-#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar != 0x7f) &&\
+#define IS_PRINTABLE(keychar) ((keychar >= 0x20) && (keychar != 0x7f) && \
                                ((keychar < 0xF700) || keychar >= 0xF8FF))
 
 /*
@@ -169,17 +172,17 @@ typedef union MacKeycode_t {
 			    (state & Mod2Mask ? INDEX_OPTION : 0))
 
 /*
- * Special values for the virtual bitfield.
+ * Special values for the virtual bitfield.  Actual virtual keycodes are < 128.
  */
 
-#define NO_VIRTUAL 0xFF /* No virtual keycode could be deduced. */
+#define NO_VIRTUAL 0xFF /* Not generated by a key or the NSText"InputClient. */
 #define REPLACEMENT_VIRTUAL 0x80 /* A BMP char sent by the NSTextInputClient. */
 #define NON_BMP_VIRTUAL 0x81 /* A non-BMP char sent by the NSTextInputClient. */
 
 /*
- * A special character used in the keycode for modifier KeyPress or KeyRelease
- * XEvents.  It is near the end of the private-use range but different from the
- * UniChar 0xF8FF which Apple uses for their logo character.
+ * A special character is used in the keycode for simulated modifier KeyPress
+ * or KeyRelease XEvents.  It is near the end of the private-use range but
+ * different from the UniChar 0xF8FF which Apple uses for their logo character.
  */
 
 #define MOD_KEYCHAR 0xF8FE
-- 
cgit v0.12


From c735d5a4eccde22cdc2eded757bed8b728607427 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Wed, 6 May 2020 21:45:15 +0000
Subject: Work around an Apple bug which causes *Warning: Window move completed
 without beginning.* to be sent to stderr.

---
 macosx/tkMacOSXNotify.c | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/macosx/tkMacOSXNotify.c b/macosx/tkMacOSXNotify.c
index afee942..77e9e74 100644
--- a/macosx/tkMacOSXNotify.c
+++ b/macosx/tkMacOSXNotify.c
@@ -141,12 +141,47 @@ void DebugPrintQueue(void)
  */
 - (void) sendEvent: (NSEvent *) theEvent
 {
+
+    /*
+     * Workaround for an Apple bug.  When an accented character is selected
+     * from an NSTextInputClient popup character viewer with the mouse, Apple
+     * sends an event of type NSEventTypeAppKitDefined and subtype 21. If that
+     * event is sent up the responder chain it causes Apple to print a warning
+     * to the console log and, extremely obnoxiously, also to stderr, which
+     * says "Window move completed without beginning."  Apparently they are
+     * sending the "move completed" event without having sent the "move began"
+     * event of subtype 20, and then announcing their error on our stderr.
+     * Also, of course, no movement is occurring.  The popup is not movable and
+     * is just being closed.  The bug has been reported to Apple.  If they ever
+     * fix it, this block should be removed.
+     */
+
+    if ([theEvent type] == NSEventTypeAppKitDefined) {
+	static Bool aWindowIsMoving = NO;
+	switch([theEvent subtype]) {
+	case 20:
+	    aWindowIsMoving = YES;
+	    break;
+	case 21:
+	    if (aWindowIsMoving) {
+		aWindowIsMoving = NO;
+		break;
+	    } else {
+		// printf("Bug!!!!\n");
+		return;
+	    }
+	default:
+	    break;
+	}
+    }
     [super sendEvent:theEvent];
     [NSApp tkCheckPasteboard];
+
 #ifdef TK_MAC_DEBUG_EVENTS
     fprintf(stderr, "Sending event of type %d\n", (int)[theEvent type]);
     DebugPrintQueue();
 #endif
+
 }
 @end
 
-- 
cgit v0.12


From dd7e4b7700686259339f93257093efd65cc8b2c5 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Mon, 11 May 2020 22:03:49 +0000
Subject: Revert changes to tkBind.c which will be handled by bug-d2a10a14a8/

---
 generic/tkBind.c | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

diff --git a/generic/tkBind.c b/generic/tkBind.c
index 76b0f00..1443270 100644
--- a/generic/tkBind.c
+++ b/generic/tkBind.c
@@ -3203,11 +3203,7 @@ ExpandPercents(
 	}
 
 	if (number != NO_NUMBER) {
-	    if (evPtr->type != MouseWheelEvent) {
-		snprintf(numStorage, sizeof(numStorage), "%ld", number);
-	    } else {
-		snprintf(numStorage, sizeof(numStorage), "%d", (int) number);
-	    }		
+	    snprintf(numStorage, sizeof(numStorage), "%d", (int) number);
 	    string = numStorage;
 	}
 	{   /* local scope */
-- 
cgit v0.12


From 4f9c5061a9037f3b854ae6046f5454578abc5707 Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Tue, 12 May 2020 13:21:44 +0000
Subject: Deal with the Menu key and possibly other keys that Apple does not
 use.

---
 macosx/tkMacOSXKeyEvent.c | 8 ++++++++
 macosx/tkMacOSXKeyboard.c | 3 ++-
 macosx/tkMacOSXKeysyms.h  | 9 ++++++---
 macosx/tkMacOSXPrivate.h  | 3 +++
 4 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index 8d8ccc3..9b866f6 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -114,6 +114,14 @@ static NSUInteger textInputModifiers;
 	    use_text_input = YES;
 	}
 
+	/*
+	 * Apple uses 0x10 for unrecognized keys.
+	 */
+
+	if (keychar == 0x10) {
+	    keychar = UNKNOWN_KEYCHAR;
+	}
+
 #if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
 	TKLog(@"-[%@(%p) %s] repeat=%d mods=%x char=%x code=%lu c=%d type=%d",
 	      [self class], self, _cmd,
diff --git a/macosx/tkMacOSXKeyboard.c b/macosx/tkMacOSXKeyboard.c
index 1b8668e..db693ea 100644
--- a/macosx/tkMacOSXKeyboard.c
+++ b/macosx/tkMacOSXKeyboard.c
@@ -90,7 +90,8 @@
  * numerical X11 keysyms and macOS keychars; this file constructs Tcl hash
  * tables to do this job, using data defined in the file tkMacOSXKeysyms.h.
  * The code here adopts the convention that the keychar of any modifier key
- * is MOD_KEYCHAR.
+ * is MOD_KEYCHAR.  Keys which do not appear on any Macintosh keyboard, such
+ * as the Menu key on PC keyboards, are assigned UNKNOWN_KEYCHAR.
  *
  * The macosx platform-specific scheme for generating a keycode when mapping an
  * NSEvent of type KeyUp, KeyDown or FlagsChanged to an XEvent of type KeyPress
diff --git a/macosx/tkMacOSXKeysyms.h b/macosx/tkMacOSXKeysyms.h
index 281b5e7..726f318 100644
--- a/macosx/tkMacOSXKeysyms.h
+++ b/macosx/tkMacOSXKeysyms.h
@@ -85,7 +85,7 @@ static const KeyInfo keyArray[] = {
     {106,	XK_F16,		NSF16FunctionKey},
     {107,	XK_F14,		NSF14FunctionKey},
     {109,	XK_F10,		NSF10FunctionKey},
-    {110,       XK_Menu,	XK_Menu},
+    {110,       XK_Menu,	UNKNOWN_KEYCHAR},
     {111,	XK_F12,		NSF12FunctionKey},
     {113,	XK_F15,		NSF15FunctionKey},
     {114,	XK_Help,	NSHelpFunctionKey},
@@ -105,8 +105,11 @@ static const KeyInfo keyArray[] = {
 };
 
 /*
- * X11 keysyms for modifier keys, in order.  This list includes keys which
- * do not appear on Apple keyboards, such as Shift_Lock and Super_R.
+ * X11 keysyms for modifier keys, in order.  This list includes keys
+ * which do not appear on Apple keyboards, such as Shift_Lock and
+ * Super_R.  While most systems don't provide events for the "fn"
+ * function key, Apple does.  We map it to Super_L when processing a
+ * FlagsChanged NSEvent.
  */
 
 #define NUM_MOD_KEYCODES 14
diff --git a/macosx/tkMacOSXPrivate.h b/macosx/tkMacOSXPrivate.h
index 384a0df..711569f 100644
--- a/macosx/tkMacOSXPrivate.h
+++ b/macosx/tkMacOSXPrivate.h
@@ -183,9 +183,12 @@ typedef union MacKeycode_t {
  * A special character is used in the keycode for simulated modifier KeyPress
  * or KeyRelease XEvents.  It is near the end of the private-use range but
  * different from the UniChar 0xF8FF which Apple uses for their logo character.
+ * A different special character is used for keys, like the Menu key, which do
+ * not appear on Macintosh keyboards.
  */
 
 #define MOD_KEYCHAR 0xF8FE
+#define UNKNOWN_KEYCHAR 0xF8FD
 
 /*
  * Structure encapsulating current drawing environment.
-- 
cgit v0.12


From 066e33ce244f83d24b210e469017004734af384d Mon Sep 17 00:00:00 2001
From: culler <culler>
Date: Tue, 12 May 2020 13:25:22 +0000
Subject: Add the Menu key to bind-35.1

---
 tests/bind.test | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/bind.test b/tests/bind.test
index fb74ab8..c6e0a2f 100644
--- a/tests/bind.test
+++ b/tests/bind.test
@@ -6773,7 +6773,7 @@ test bind-35.1 {Key events agree for entry widgets} -constraints {aqua} -setup {
     entry .new.e
     pack .new.e
 } -body {
-    foreach k {o O F2 Home Right Greek_sigma Greek_ALPHA} {
+    foreach k {o O F2 Home Right Greek_sigma Greek_ALPHA Menu} {
 	set result [testKeyWithMods .new.e $k press]
 	if {$result != "pass"} {
 	    return $result
-- 
cgit v0.12