Merge lp:~3v1n0/nux/text-entry-meta-filters into lp:nux

[Marco Trevisan (Treviño)]

TextEntry: don't allow invalid character to be written and ignore keypress when holding Alt or Super

Filter out keys when pressing Alt or Super modifiers, also avoid that invalid test is written into the text-entry.

Both xtests and gtests added.

UNBLOCK

[lp:~3v1n0/nux/text-entry-meta-filters]

638. By Marco Trevisan (Treviño) on 2012-07-03

gtest-nux-textentry: don't be linux dependent on test

639. By Marco Trevisan (Treviño) on 2012-07-03

InputMethodIBus: both consider keydown and keyup events

Ibus needs both when using the +Release flag

640. By Marco Trevisan (Treviño) on 2012-07-03

gtest-nux-textentry: fix tests when ibus-daemon is active

[Brandon Schaefer (brandontschaefer)]

All tests pass and looks good. +1

review: Approve

=== modified file 'Nux/InputMethodIBus.cpp'
--- Nux/InputMethodIBus.cpp	2012-06-26 22:35:16 +0000
+++ Nux/InputMethodIBus.cpp	2012-07-03 14:59:18 +0000
@@ -504,7 +504,7 @@
   {
     for (Event const& ev : hotkeys_)
     {
-      if (ev.type == type && ev.x11_keysym == keysym)
+      if (ev.x11_keysym == keysym && (ev.type == type || type == EVENT_KEY_DOWN))
       {
         if (type == EVENT_KEY_UP)
           return (modifiers & ev.key_modifiers);
 
=== modified file 'Nux/TextEntry.cpp'
--- Nux/TextEntry.cpp	2012-07-03 11:04:59 +0000
+++ Nux/TextEntry.cpp	2012-07-03 14:59:18 +0000
@@ -316,7 +316,7 @@
 
     // FIXME Have to get the current event fot he x11_keycode for ibus-hangul/korean input
     nux::Event const& cur_event = GetGraphicsDisplay()->GetCurrentEvent();
-    KeyEvent event(static_cast<EventType>(event_type), keysym,cur_event.x11_keycode, state, character);
+    KeyEvent event(static_cast<EventType>(event_type), keysym, cur_event.x11_keycode, state, character);
     im_filtered = ime_->FilterKeyEvent(event);
 #endif
 
@@ -464,13 +464,16 @@
 //       }
     }
 
-    if (character && strlen(character) && !im_filtered)
-    {
-      EnterText(character);
-    }
-
     if (!im_filtered)
     {
+      if (character)
+      {
+        unsigned int utf_char = g_utf8_get_char(character);
+
+        if (g_unichar_isprint(utf_char))
+          EnterText(character);
+      }
+
       QueueRefresh(false, true);
     }
   }
@@ -2317,16 +2320,29 @@
 
   bool TextEntry::InspectKeyEvent(unsigned int eventType, unsigned int key_sym, const char* character)
   {
+    nux::Event const& cur_event = GetGraphicsDisplay()->GetCurrentEvent();
+
+    return InspectKeyEvent(cur_event);
+  }
+
+  bool TextEntry::InspectKeyEvent(nux::Event const& event)
+  {
+    unsigned int eventType = event.type;
+    unsigned int key_sym = event.GetKeySym();
+
 #if defined(NUX_OS_LINUX)
     if (im_running())
     {
       // Always allow IBus hotkey events
-      nux::Event const& cur_event = GetGraphicsDisplay()->GetCurrentEvent();
-      if (ime_->IsHotkeyEvent(static_cast<EventType>(eventType), key_sym, cur_event.key_modifiers))
+      if (ime_->IsHotkeyEvent(static_cast<EventType>(eventType), key_sym, event.key_modifiers))
         return true;
     }
 #endif
 
+    // Ignore events when Alt or Super are pressed
+    if (event.GetKeyModifierState(KEY_MODIFIER_SUPER) || event.GetKeyModifierState(KEY_MODIFIER_ALT))
+      return false;
+
     if ((eventType == NUX_KEYDOWN) && (key_nav_mode_ == true) && (text_input_mode_ == false) && (ime_active_ == false))
     {
       if (key_sym == NUX_VK_ENTER ||
@@ -2388,14 +2404,14 @@
       {
         if ((!multiline_) && (!lose_key_focus_on_key_nav_direction_up_) && NUX_VK_UP)
         {
-          // By returning true, the text entry signals that it want to receinve the signal for this event.
+          // By returning true, the text entry signals that it want to receive the signal for this event.
           // Otherwise, the parent view of the text entry would be looking for another view to receive keynav focus to.
           return true;
         }
 
         if ((!multiline_) && (!lose_key_focus_on_key_nav_direction_down_) && NUX_VK_DOWN)
         {
-          // By returning true, the text entry signals that it want to receinve the signal for this event.
+          // By returning true, the text entry signals that it want to receive the signal for this event.
           // Otherwise, the parent view of the text entry would be looking for another view to receive keynav focus to.
           return true;
         }
 
=== modified file 'Nux/TextEntry.h'
--- Nux/TextEntry.h	2012-07-03 11:04:59 +0000
+++ Nux/TextEntry.h	2012-07-03 14:59:18 +0000
@@ -491,9 +491,8 @@
     bool composition_mode_;
     std::string composition_string_;
 
-    virtual bool InspectKeyEvent(unsigned int eventType,
-      unsigned int keysym,
-      const char* character);
+    virtual bool InspectKeyEvent(Event const& event);
+    virtual bool InspectKeyEvent(unsigned int eventType, unsigned int keysym, const char* character);
 };
 }
 
 
=== modified file 'tests/gtest-nux-textentry.cpp'
--- tests/gtest-nux-textentry.cpp	2012-03-05 19:32:20 +0000
+++ tests/gtest-nux-textentry.cpp	2012-07-03 14:59:18 +0000
@@ -1,50 +1,67 @@
-#include <string>
-#include <fstream>
-
-#include <iostream>
 #include <gmock/gmock.h>
-#include <boost/filesystem.hpp>
-#include <glib.h>
 
 #include "Nux/Nux.h"
 #include "Nux/TextEntry.h"
+#if defined(NUX_OS_LINUX)
+#include "Nux/InputMethodIBus.h"
+#endif
 
 
 using namespace testing;
+using namespace nux;
 
 namespace {
 
-TEST(TestTextEntry, TestSetText)
-{
-  nux::NuxInitialize(0);
-  nux::WindowThread* wnd_thread = nux::CreateNuxWindow("Nux Window", 300, 200,
-    nux::WINDOWSTYLE_NORMAL, NULL, false, NULL, NULL);
-
-  nux::TextEntry* text_entry = new nux::TextEntry("");
-  
-  nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(text_entry);
-
+class MockTextEntry : public nux::TextEntry
+{
+public:
+  MockTextEntry(const char* text) : nux::TextEntry(text)
+  {}
+
+  bool InspectKeyEvent(nux::Event const& event)
+  {
+    return nux::TextEntry::InspectKeyEvent(event);
+  }
+
+  nux::IBusIMEContext* ime() const
+  {
+#if defined(NUX_OS_LINUX)
+    return ime_;
+#else
+    return nullptr;
+#endif
+  }
+};
+
+class TestTextEntry : public Test
+{
+public:
+  virtual void SetUp()
+  {
+    nux::NuxInitialize(0);
+    wnd_thread.reset(nux::CreateNuxWindow("Nux Window", 300, 200,
+                     nux::WINDOWSTYLE_NORMAL, NULL, false, NULL, NULL));
+
+    text_entry = new MockTextEntry("");
+    nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(text_entry.GetPointer());
+  }
+
+  std::unique_ptr<nux::WindowThread> wnd_thread;
+  nux::ObjectPtr<MockTextEntry> text_entry;
+};
+
+TEST_F(TestTextEntry, TestSetText)
+{
   EXPECT_EQ(text_entry->IsInTextInputMode(), false);
 
   text_entry->SetText("Nux");
   EXPECT_EQ(text_entry->GetText() == std::string("Nux"), true);
 
   EXPECT_EQ(text_entry->IsInTextInputMode(), true);
-
-  text_entry->UnReference();
-  delete wnd_thread;
 }
 
-TEST(TestTextEntry, TestEnterText)
+TEST_F(TestTextEntry, TestEnterText)
 {
-  nux::NuxInitialize(0);
-  nux::WindowThread* wnd_thread = nux::CreateNuxWindow("Nux Window", 300, 200,
-    nux::WINDOWSTYLE_NORMAL, NULL, false, NULL, NULL);
-
-  nux::TextEntry* text_entry = new nux::TextEntry("");
-  
-  nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(text_entry);
-
   EXPECT_EQ(text_entry->IsInTextInputMode(), false);
 
   text_entry->EnterText("Nux");
@@ -52,21 +69,10 @@
   EXPECT_EQ(text_entry->GetText() == std::string("Nux"), true);
 
   EXPECT_EQ(text_entry->IsInTextInputMode(), true);
-
-  text_entry->UnReference();
-  delete wnd_thread;
 }
 
-TEST(TestTextEntry, TestDeleteText)
+TEST_F(TestTextEntry, TestDeleteText)
 {
-  nux::NuxInitialize(0);
-  nux::WindowThread* wnd_thread = nux::CreateNuxWindow("Nux Window", 300, 200,
-    nux::WINDOWSTYLE_NORMAL, NULL, false, NULL, NULL);
-
-  nux::TextEntry* text_entry = new nux::TextEntry("");
-  
-  nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(text_entry);
-
   EXPECT_EQ(text_entry->IsInTextInputMode(), false);
 
   text_entry->EnterText("Nux");
@@ -77,7 +83,7 @@
 
   nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(NULL);
 
-  nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(text_entry);
+  nux::GetWindowThread()->GetWindowCompositor().SetKeyFocusArea(text_entry.GetPointer());
 
   EXPECT_EQ(text_entry->IsInTextInputMode(), false);
 
@@ -86,10 +92,65 @@
   EXPECT_EQ(text_entry->GetText() == std::string(""), true);
 
   EXPECT_EQ(text_entry->IsInTextInputMode(), true);
-
-
-  text_entry->UnReference();
-  delete wnd_thread;
+}
+
+#if defined(NUX_OS_LINUX)
+class TestEvent : public nux::Event
+{
+public:
+  TestEvent(nux::KeyModifier keymod, unsigned long keysym)
+  {
+    type = nux::NUX_KEYDOWN;
+    key_modifiers = keymod;
+    x11_keysym = keysym;
+  }
+
+  TestEvent(unsigned long keysym)
+  {
+    type = nux::NUX_KEYDOWN;
+    x11_keysym = keysym;
+  }
+};
+
+TEST_F(TestTextEntry, AltLinuxKeybindings)
+{
+  for (unsigned long keysym = 0; keysym < XK_VoidSymbol; ++keysym)
+  {
+    TestEvent event(KEY_MODIFIER_ALT, keysym);
+
+    if (text_entry->ime()->IsHotkeyEvent(event.type, event.GetKeySym(), event.key_modifiers))
+      EXPECT_TRUE(text_entry->InspectKeyEvent(event));
+    else
+      EXPECT_FALSE(text_entry->InspectKeyEvent(event));
+  }
+}
+
+TEST_F(TestTextEntry, SuperLinuxKeybindings)
+{
+  for (unsigned long keysym = 0; keysym < XK_VoidSymbol; ++keysym)
+  {
+    TestEvent event(KEY_MODIFIER_SUPER, keysym);
+
+    if (text_entry->ime()->IsHotkeyEvent(event.type, event.GetKeySym(), event.key_modifiers))
+      EXPECT_TRUE(text_entry->InspectKeyEvent(event));
+    else
+      EXPECT_FALSE(text_entry->InspectKeyEvent(event));
+  }
+}
+#endif
+
+TEST_F(TestTextEntry, InvalidKeys)
+{
+  std::vector<std::string> invalid_chars = {"", "", "", "", "",
+                                            "", "", "", "", "",
+                                            "", "", "
 "};
+  for (auto c : invalid_chars)
+  {
+    unsigned int keysym = g_utf8_get_char(c.c_str());
+    text_entry->DeleteText(0, std::numeric_limits<int>::max());
+    text_entry->key_down.emit(NUX_KEYDOWN, keysym, 0, c.c_str(), 1);
+    EXPECT_EQ(text_entry->GetText(), "");
+  }
 }
 
 }
 
=== modified file 'tests/xtest-text-entry.cpp'
--- tests/xtest-text-entry.cpp	2012-04-25 15:37:23 +0000
+++ tests/xtest-text-entry.cpp	2012-07-03 14:59:18 +0000
@@ -313,6 +313,29 @@
     test.TestReportMsg(test_textentry->text_entry_->GetText() == "", "TextEntry is empty");
   }
 
+  // Send invalid keys
+  {
+    test.ViewSendKeyCombo(XK_Control_L, 0, 0, 'r');
+    test.TestReportMsg(test_textentry->text_entry_->GetText() == "", "Invalid key: TextEntry is empty");
+    nux::SleepForMilliseconds(500);
+
+    test.ViewSendKeyCombo(XK_Control_L, 0, 0, 'w');
+    test.TestReportMsg(test_textentry->text_entry_->GetText() == "", "Invalid key: TextEntry is empty");
+    nux::SleepForMilliseconds(500);
+
+    test.ViewSendKeyCombo(XK_Control_L, 0, 0, 'g');
+    test.TestReportMsg(test_textentry->text_entry_->GetText() == "", "Invalid key: TextEntry is empty");
+    nux::SleepForMilliseconds(500);
+
+    test.ViewSendKeyCombo(XK_Control_L, 0, 0, 'h');
+    test.TestReportMsg(test_textentry->text_entry_->GetText() == "", "Invalid key: TextEntry is empty");
+    nux::SleepForMilliseconds(500);
+
+    nux::SleepForMilliseconds(500);
+    test.ViewSendCtrlA();
+    test.ViewSendDelete();
+  }
+
   // Toggle IBus
   // Type "qwerty"
   // Simulate key '1' to select the first IM option