checkpoint. trying to add support for mode switch key to X11

screens.

lib/client/CXWindowsSecondaryScreen.cpp

@@ -812,10 +812,13 @@ CXWindowsSecondaryScreen::maskToX(KeyModifierMask inMask) const
 		outMask |= ControlMask;
 	}
 	if (inMask & KeyModifierAlt) {
-		outMask |= Mod1Mask;
+		outMask |= m_altMask;
 	}
 	if (inMask & KeyModifierMeta) {
-		outMask |= Mod4Mask;
+		outMask |= m_metaMask;
+	}
+	if (inMask & KeyModifierModeSwitch) {
+		outMask |= m_modeSwitchMask;
 	}
 	if (inMask & KeyModifierCapsLock) {
 		outMask |= m_capsLockMask;
@@ -876,8 +879,8 @@ CXWindowsSecondaryScreen::updateKeys()
 	}
 
 	// update mappings and current modifiers
-	updateKeycodeMap(display);
 	updateModifierMap(display);
+	updateKeycodeMap(display);
 	updateModifiers(display);
 }
 
@@ -913,6 +916,9 @@ CXWindowsSecondaryScreen::updateModifiers(Display* display)
 void
 CXWindowsSecondaryScreen::updateKeycodeMap(Display* display)
 {
+	// there are up to 4 keysyms per keycode
+	static const int numKeysyms = 4;
+
 	// get the number of keycodes
 	int minKeycode, maxKeycode;
 	XDisplayKeycodes(display, &minKeycode, &maxKeycode);
@@ -924,39 +930,31 @@ CXWindowsSecondaryScreen::updateKeycodeMap(Display* display)
 								minKeycode, numKeycodes,
 								&keysymsPerKeycode);
 
-	// restrict keysyms per keycode to 2 because, frankly, i have no
-	// idea how/what modifiers are used to access keysyms beyond the
-	// first 2.
-	int numKeysyms = 2;	// keysymsPerKeycode
-
 	// initialize
 	KeyCodeMask entry;
 	m_keycodeMap.clear();
 
 	// insert keys
 	for (int i = 0; i < numKeycodes; ++i) {
-		// how many keysyms for this keycode?
+		// compute mask over all mapped keysyms.  if a keycode has, say,
-		int n;
+		// no shifted keysym then we can ignore the shift state when
-		for (n = 0; n < numKeysyms; ++n) {
+		// synthesizing an event to generate it.
-			if (keysyms[i * keysymsPerKeycode + n] == NoSymbol) {
+		entry.m_keyMaskMask = 0;
-				break;
+		for (int j = 0; j < numKeysyms; ++j) {
+			const KeySym keySym = keysyms[i * keysymsPerKeycode + j];
+			if (keySym != NoSymbol) {
+				entry.m_keyMaskMask |= indexToModifierMask(j);
 			}
 		}
 
-		// move to next keycode if there are no keysyms
-		if (n == 0) {
-			continue;
-		}
-
-		// set the mask of modifiers that this keycode uses
-		entry.m_keyMaskMask = (n == 1) ? 0 : (ShiftMask | LockMask);
-
 		// add entries for this keycode
 		entry.m_keycode = static_cast<KeyCode>(minKeycode + i);
 		for (int j = 0; j < numKeysyms; ++j) {
-			entry.m_keyMask = (j == 0) ? 0 : ShiftMask;
+			const KeySym keySym = keysyms[i * keysymsPerKeycode + j];
-			m_keycodeMap.insert(std::make_pair(keysyms[i *
+			if (keySym != NoSymbol) {
-									keysymsPerKeycode + j], entry));
+				entry.m_keyMask = indexToModifierMask(j) & ~LockMask;
+				m_keycodeMap.insert(std::make_pair(keySym, entry));
+			}
 		}
 	}
 
@@ -964,6 +962,26 @@ CXWindowsSecondaryScreen::updateKeycodeMap(Display* display)
 	XFree(keysyms);
 }
 
+unsigned int
+CXWindowsSecondaryScreen::indexToModifierMask(int index) const
+{
+	assert(index >= 0 && index <= 3);
+
+	switch (index) {
+	case 0:
+		return 0;
+
+	case 1:
+		return ShiftMask | LockMask;
+
+	case 2:
+		return m_modeSwitchMask;
+
+	case 3:
+		return ShiftMask | LockMask | m_modeSwitchMask;
+	}
+}
+
 void
 CXWindowsSecondaryScreen::updateModifierMap(Display* display)
 {
@@ -973,6 +991,9 @@ CXWindowsSecondaryScreen::updateModifierMap(Display* display)
 	// initialize
 	m_modifierMask       = 0;
 	m_toggleModifierMask = 0;
+	m_altMask            = 0;
+	m_metaMask           = 0;
+	m_modeSwitchMask     = 0;
 	m_numLockMask        = 0;
 	m_capsLockMask       = 0;
 	m_scrollLockMask     = 0;
@@ -989,29 +1010,49 @@ CXWindowsSecondaryScreen::updateModifierMap(Display* display)
 			// save in modifier to keycode
 			m_modifierToKeycode[i * m_keysPerModifier + j] = keycode;
 
+			// no further interest in unmapped modifier
+			if (keycode == 0) {
+				continue;
+			}
+
 			// save in keycode to modifier
 			m_keycodeToModifier.insert(std::make_pair(keycode, i));
 
-			// modifier is enabled if keycode isn't 0
+			// save bit in all-modifiers mask
-			if (keycode != 0) {
+			m_modifierMask |= bit;
-				m_modifierMask |= bit;
-			}
 
 			// modifier is a toggle if the keysym is a toggle modifier
 			const KeySym keysym = XKeycodeToKeysym(display, keycode, 0);
 			if (isToggleKeysym(keysym)) {
 				m_toggleModifierMask |= bit;
+			}
 
-				// note num/caps-lock
+			// note mask for particular modifiers
-				if (keysym == XK_Num_Lock) {
+			switch (keysym) {
-					m_numLockMask |= bit;
+			case XK_Alt_L:
-				}
+			case XK_Alt_R:
-				else if (keysym == XK_Caps_Lock) {
+				m_altMask        |= bit;
-					m_capsLockMask |= bit;
+				break;
-				}
+
-				else if (keysym == XK_Scroll_Lock) {
+			case XK_Meta_L:
-					m_scrollLockMask |= bit;
+			case XK_Meta_R:
-				}
+				m_metaMask       |= bit;
+				break;
+
+			case XK_Mode_switch:
+				m_modeSwitchMask |= bit;
+				break;
+
+			case XK_Num_Lock:
+				m_numLockMask    |= bit;
+				break;
+
+			case XK_Caps_Lock:
+				m_capsLockMask   |= bit;
+				break;
+
+			case XK_Scroll_Lock:
+				m_scrollLockMask |= bit;
 			}
 		}
 	}

lib/client/CXWindowsSecondaryScreen.h

@@ -98,6 +98,7 @@ private:
 	void				updateKeycodeMap(Display* display);
 	void				updateModifiers(Display* display);
 	void				updateModifierMap(Display* display);
+	unsigned int		indexToModifierMask(int index) const;
 	void				toggleKey(Display*, KeySym, unsigned int mask);
 	static bool			isToggleKeysym(KeySym);
 
@@ -130,7 +131,10 @@ private:
 	// set bits indicate modifiers that toggle (e.g. caps-lock)
 	unsigned int		m_toggleModifierMask;
 
-	// masks that indicate which modifier bits are for toggle keys
+	// modifier masks
+	unsigned int		m_altMask;
+	unsigned int		m_metaMask;
+	unsigned int		m_modeSwitchMask;
 	unsigned int		m_numLockMask;
 	unsigned int		m_capsLockMask;
 	unsigned int		m_scrollLockMask;

lib/server/CXWindowsPrimaryScreen.cpp

@@ -614,7 +614,6 @@ CXWindowsPrimaryScreen::doSelectEvents(Display* display, Window w) const
 KeyModifierMask
 CXWindowsPrimaryScreen::mapModifier(unsigned int state) const
 {
-	// FIXME -- should be configurable
 	KeyModifierMask mask = 0;
 	if (state & ShiftMask)
 		mask |= KeyModifierShift;
@@ -622,13 +621,15 @@ CXWindowsPrimaryScreen::mapModifier(unsigned int state) const
 		mask |= KeyModifierCapsLock;
 	if (state & ControlMask)
 		mask |= KeyModifierControl;
-	if (state & Mod1Mask)
+	if (state & m_altMask)
 		mask |= KeyModifierAlt;
-	if (state & Mod2Mask)
+	if (state & m_metaMask)
-		mask |= KeyModifierNumLock;
-	if (state & Mod4Mask)
 		mask |= KeyModifierMeta;
-	if (state & Mod5Mask)
+	if (state & m_modeSwitchMask)
+		mask |= KeyModifierModeSwitch;
+	if (state & m_numLockMask)
+		mask |= KeyModifierNumLock;
+	if (state & m_scrollLockMask)
 		mask |= KeyModifierScrollLock;
 	return mask;
 }
@@ -688,6 +689,9 @@ CXWindowsPrimaryScreen::updateKeys()
 	XModifierKeymap* keymap = XGetModifierMapping(display);
 
 	// initialize
+	m_altMask        = 0;
+	m_metaMask       = 0;
+	m_modeSwitchMask = 0;
 	m_numLockMask    = 0;
 	m_capsLockMask   = 0;
 	m_scrollLockMask = 0;
@@ -699,16 +703,34 @@ CXWindowsPrimaryScreen::updateKeys()
 			KeyCode keycode = keymap->modifiermap[i *
 								keymap->max_keypermod + j];
 
-			// note toggle modifier bits
+			// note mask for particular modifiers
 			const KeySym keysym = XKeycodeToKeysym(display, keycode, 0);
-			if (keysym == XK_Num_Lock) {
+			switch (keysym) {
-				m_numLockMask |= bit;
+			case XK_Alt_L:
-			}
+			case XK_Alt_R:
-			else if (keysym == XK_Caps_Lock) {
+				m_altMask        |= bit;
-				m_capsLockMask |= bit;
+				break;
-			}
+
-			else if (keysym == XK_Scroll_Lock) {
+			case XK_Meta_L:
+			case XK_Meta_R:
+				m_metaMask       |= bit;
+				break;
+
+			case XK_Mode_switch:
+				m_modeSwitchMask |= bit;
+				break;
+
+			case XK_Num_Lock:
+				m_numLockMask    |= bit;
+				break;
+
+			case XK_Caps_Lock:
+				m_capsLockMask   |= bit;
+				break;
+
+			case XK_Scroll_Lock:
 				m_scrollLockMask |= bit;
+				break;
 			}
 		}
 	}

lib/server/CXWindowsPrimaryScreen.h

@@ -97,7 +97,10 @@ private:
 	bool				m_numLockHalfDuplex;
 	bool				m_capsLockHalfDuplex;
 
-	// masks that indicate which modifier bits are for toggle keys
+	// modifier masks
+	unsigned int		m_altMask;
+	unsigned int		m_metaMask;
+	unsigned int		m_modeSwitchMask;
 	unsigned int		m_numLockMask;
 	unsigned int		m_capsLockMask;
 	unsigned int		m_scrollLockMask;

lib/synergy/KeyTypes.h

@@ -37,6 +37,7 @@ static const KeyModifierMask	KeyModifierShift      = 0x0001;
 static const KeyModifierMask	KeyModifierControl    = 0x0002;
 static const KeyModifierMask	KeyModifierAlt        = 0x0004;
 static const KeyModifierMask	KeyModifierMeta       = 0x0008;
+static const KeyModifierMask	KeyModifierModeSwitch = 0x0010;
 static const KeyModifierMask	KeyModifierCapsLock   = 0x1000;
 static const KeyModifierMask	KeyModifierNumLock    = 0x2000;
 static const KeyModifierMask	KeyModifierScrollLock = 0x4000;