From f87c73da697c6075907a07490950a3ff51b52fd2 Mon Sep 17 00:00:00 2001
From: Kazuyoshi Kato <kato.kazuyoshi@gmail.com>
Date: Fri, 13 Sep 2024 00:39:19 -0700
Subject: [PATCH] Ignore Super and other modifier keys except for Alt

Mozc doesn't know Super and other extra modifier keys except for Alt.
For example, "Super + Space" (IBus' default for switching input methods)
is recognized as "Space".

This change ignores key events that have these extra modifiers to let
others handle the events.

Fixes #853.
---
 src/unix/ibus/key_event_handler.cc      | 12 ++++++++++++
 src/unix/ibus/key_event_handler_test.cc |  7 +++++++
 2 files changed, 19 insertions(+)

diff --git a/src/unix/ibus/key_event_handler.cc b/src/unix/ibus/key_event_handler.cc
index e7e3f0afd..0fbf04c67 100644
--- a/src/unix/ibus/key_event_handler.cc
+++ b/src/unix/ibus/key_event_handler.cc
@@ -62,6 +62,18 @@ bool KeyEventHandler::GetKeyEvent(uint keyval, uint keycode, uint modifiers,
   DCHECK(key);
   key->Clear();
 
+  // Ignore key events with modifiers, except for the below;
+  // - Alt (Mod1) - Mozc uses Alt for shortcuts
+  // - NumLock (Mod2) - NumLock shouldn't impact shortcuts
+  // This is needed for handling shortcuts such as Super (Mod4) + Space,
+  // IBus's default for switching input methods.
+  // https://github.com/google/mozc/issues/853
+  constexpr uint kExtraModMask =
+      IBUS_MOD3_MASK | IBUS_MOD4_MASK | IBUS_MOD5_MASK;
+  if (modifiers & kExtraModMask) {
+    return false;
+  }
+
   if (!key_translator_->Translate(keyval, keycode, modifiers, preedit_method,
                                   layout_is_jp, key)) {
     LOG(ERROR) << "Translate failed";
diff --git a/src/unix/ibus/key_event_handler_test.cc b/src/unix/ibus/key_event_handler_test.cc
index 8db8d6ea4..8e6bbda6e 100644
--- a/src/unix/ibus/key_event_handler_test.cc
+++ b/src/unix/ibus/key_event_handler_test.cc
@@ -180,6 +180,13 @@ TEST_F(KeyEventHandlerTest, GetKeyEvent) {
     EXPECT_NO_MODIFIERS_PRESSED();
   }
 
+  { // Ignore Super (Mod4)
+    key.Clear();
+    EXPECT_FALSE(handler_->GetKeyEvent(IBUS_space, kDummyKeycode,
+                                       IBUS_MOD4_MASK, config::Config::ROMAN,
+                                       true, &key));
+  }
+
   // This test fails in current implementation.
   // TODO(hsumita): Enables it.
   /*