Merge lp:~brandontschaefer/unity/unity.fix-middle-paste-reg into lp:unity

[Brandon Schaefer]

= Problem description =

Fixes middle mouse button pasting, which was removed by me.

= The fix =

Restored the IMTextEntry::OnMouseButtonUp function but now it only handles paste with the middle mouse

= Test coverage =

There is a manual test for this

[Tim Penhey (thumper)]

I've edited the description to use our new template.

Can you update the fix and test coverage section please?

review: Needs Information

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

First, the standard for clipboard is here: http://www.freedesktop.org/wiki/Specifications/ClipboardsWiki?action=show&redirect=Standards%2FClipboardsWiki

The PRIMARY clipboard should be set when the MOUSE selects some text, and should be pasted on MOUSE middle-click ONLY.
The CLIPBOARD clipboard is used for menu entries, and Ctrl+[cxv] shortcuts.

Regarding your first test:

50 + def test_paste_crash(self):
51 + """ This test is for this bug:926793 """
52 + self.dash.ensure_hidden()
53 + self.dash.toggle_reveal()
54 +
55 + kb = Keyboard();
56 + kb.type("SegFault")
57 + sleep(1)
58 +
59 + kb.press_and_release("Ctrl+a")
60 + kb.press_and_release("Ctrl+c")
61 + kb.press_and_release("Ctrl+v")
62 +
63 + searchbar = self.dash.get_searchbar()
64 + self.assertEqual(searchbar.search_string, u'SegFault')

This needs to be fixed, for a couple of reasons. First, we don't have a test that verifies that Ctrl+a works. So your test should be something like this:

50 + def test_paste_crash(self):
51 + """ This test is for this bug:926793 """
52 + self.dash.ensure_hidden()
53 + self.dash.toggle_reveal()
54 +
55 + kb = Keyboard();
56 + kb.type("SegFault")
57 + sleep(1)
58 +
59 + kb.press_and_release("Ctrl+a")
   kb.press_and_release("Delete")
63 + searchbar = self.dash.get_searchbar()
64 + self.assertEqual(searchbar.search_string, u'')

Secondly, you need to verify that Ctrl+C actually does something. If both Ctrl+C and Ctrl+V stopped working, your test would still pass. So how about somethingt like this:

50 + def test_paste_crash(self):
51 + """ This test is for this bug:926793 """
52 + self.dash.ensure_hidden()
53 + self.dash.toggle_reveal()
54 +
55 + kb = Keyboard();
56 + kb.type("SegFault")
57 + sleep(1)
58 +
59 + kb.press_and_release("Ctrl+a")
60 + kb.press_and_release("Ctrl+c")
60 + kb.press_and_release("Ctrl+v")
60 + kb.press_and_release("Ctrl+v")
62 +
63 + searchbar = self.dash.get_searchbar()
64 + self.assertEqual(searchbar.search_string, u'SegFaultSegfault')

We also need to test Ctrl+x (I assume we're supposed to support that):

50 + def test_paste_crash(self):
51 + """ This test is for this bug:926793 """
52 + self.dash.ensure_hidden()
53 + self.dash.toggle_reveal()
54 +
55 + kb = Keyboard();
56 + kb.type("SegFault")
57 + sleep(1)
58 +
59 + kb.press_and_release("Ctrl+a")
60 + kb.press_and_release("Ctrl+x")
62 +
63 + searchbar = self.dash.get_searchbar()
64 + self.assertEqual(searchbar.search_string, u'')

...and also:

50 + def test_paste_crash(self):
51 + """ This test is for this bug:926793 """
52 + self.dash.ensure_hidden()
53 + self.dash.toggle_reveal()
54 +
55 + kb = Keyboard();
56 + kb.type("SegFault")
57 + sleep(1)
58 +
59 + kb.press_and_release("Ctrl+a")
60 + kb.press_and_release("Ctrl+x")
60 + kb.press_and_release("Ctrl+v")
60 + kb.press_and_release("Ctrl+v")
62 +
63 + searchbar = self.dash.get_searchbar()
64 + self.assertEqual(searchbar.search_string, u'SegFaultSegfault')

Finally, we need to do something similar with the PRIMARY clipboard.

You can put something onto the clipboard artificiall with this code:

from gtk import Clipboard
cb = Clipboard(selection="PRIMARY") # can also be "CLIPBOARD", but we can test that easily enough a...

review: Needs Fixing

[Thomi Richards (thomir-deactivatedaccount)]

Looks great.

review: Approve

=== modified file 'plugins/unityshell/src/IMTextEntry.cpp'
--- plugins/unityshell/src/IMTextEntry.cpp	2012-02-23 10:12:51 +0000
+++ plugins/unityshell/src/IMTextEntry.cpp	2012-02-24 03:10:23 +0000
@@ -37,6 +37,7 @@
 IMTextEntry::IMTextEntry()
   : TextEntry("", NUX_TRACKER_LOCATION)
 {
+  mouse_up.connect(sigc::mem_fun(this, &IMTextEntry::OnMouseButtonUp));
 }
 
 bool IMTextEntry::InspectKeyEvent(unsigned int event_type,
@@ -104,8 +105,7 @@
   int start=0, end=0;
   if (GetSelectionBounds(&start, &end))
   {
-    GtkClipboard* clip = gtk_clipboard_get_for_display(gdk_display_get_default(),
-                                                       GDK_SELECTION_CLIPBOARD);
+    GtkClipboard* clip = gtk_clipboard_get(GDK_SELECTION_CLIPBOARD);
     gtk_clipboard_set_text(clip, text_.c_str() + start, end - start);
   }
 }
@@ -113,8 +113,7 @@
 void IMTextEntry::Paste(bool primary)
 {
   GdkAtom origin = primary ? GDK_SELECTION_PRIMARY : GDK_SELECTION_CLIPBOARD;
-  glib::Object<GtkClipboard> clip(gtk_clipboard_get_for_display(gdk_display_get_default(),
-                                                                origin));
+  GtkClipboard* clip = gtk_clipboard_get(origin);
 
   auto callback = [](GtkClipboard* clip, const char* text, gpointer user_data)
    {
@@ -142,4 +141,15 @@
     text_changed.emit(this);
   }
 }
+
+void IMTextEntry::OnMouseButtonUp(int x, int y, unsigned long bflags, unsigned long kflags)
+{
+  int button = nux::GetEventButton(bflags);
+
+  if (button == 2)
+  { 
+    SetCursor(XYToTextIndex(x,y));
+    Paste(true);
+  } 
+}
 }

=== modified file 'plugins/unityshell/src/IMTextEntry.h'
--- plugins/unityshell/src/IMTextEntry.h	2012-02-23 05:16:50 +0000
+++ plugins/unityshell/src/IMTextEntry.h	2012-02-24 03:10:23 +0000
@@ -47,6 +47,8 @@
   void Cut();
   void Copy();
   void Paste(bool primary = false);
+
+  void OnMouseButtonUp(int x, int y, unsigned long bflags, unsigned long kflags);
 };
 
 }

=== modified file 'tests/autopilot/autopilot/tests/test_dash.py'
--- tests/autopilot/autopilot/tests/test_dash.py	2012-02-23 02:20:09 +0000
+++ tests/autopilot/autopilot/tests/test_dash.py	2012-02-24 03:10:23 +0000
@@ -13,6 +13,8 @@
 from autopilot.tests import AutopilotTestCase
 from autopilot.glibrunner import GlibRunner
 
+from gtk import Clipboard
+
 
 class DashRevealTests(AutopilotTestCase):
     """Test the unity Dash Reveal."""
@@ -265,3 +267,100 @@
         kb.press_and_release('Tab')
         category = app_lens.get_focused_category()
         self.assertIsNot(category, None)
+
+class DashClipboardTests(AutopilotTestCase):
+    """Test the Unity clipboard""" 
+    run_test_with = GlibRunner
+
+    def setUp(self):
+        super(DashClipboardTests, self).setUp()
+        self.dash = Dash()
+
+    def tearDown(self):
+        super(DashClipboardTests, self).tearDown()
+        self.dash.ensure_hidden()
+         
+    def test_ctrl_a(self):
+        """ This test if ctrl+a selects all text """
+        self.dash.ensure_hidden()
+        self.dash.toggle_reveal()
+
+        kb = Keyboard();
+        kb.type("SelectAll")
+        sleep(1)
+
+        kb.press_and_release("Ctrl+a")
+        kb.press_and_release("Delete")
+        
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual(searchbar.search_string, u'')
+
+    def test_ctrl_c(self):
+        """ This test if ctrl+c copies text into the clipboard """
+        self.dash.ensure_hidden()
+        self.dash.toggle_reveal()
+
+        kb = Keyboard();
+        kb.type("Copy")
+        sleep(1)
+
+        kb.press_and_release("Ctrl+a")
+        kb.press_and_release("Ctrl+c")
+
+        cb = Clipboard(selection="CLIPBOARD")
+
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual(searchbar.search_string, cb.wait_for_text())
+
+    def test_ctrl_x(self):
+        """ This test if ctrl+x deletes all text and copys it """
+        self.dash.ensure_hidden()
+        self.dash.toggle_reveal()
+
+        kb = Keyboard();
+        kb.type("Cut")
+        sleep(1)
+
+        kb.press_and_release("Ctrl+a")
+        kb.press_and_release("Ctrl+x")
+        sleep(1)
+
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual(searchbar.search_string, u'')
+
+        cb = Clipboard(selection="CLIPBOARD")
+        self.assertEqual(cb.wait_for_text(), u'Cut')
+
+    def test_ctrl_c_v(self):
+        """ This test if ctrl+c and ctrl+v copies and pastes text"""
+        self.dash.ensure_hidden()
+        self.dash.toggle_reveal()
+
+        kb = Keyboard();
+        kb.type("CopyPaste")
+        sleep(1)
+
+        kb.press_and_release("Ctrl+a")
+        kb.press_and_release("Ctrl+c")
+        kb.press_and_release("Ctrl+v")
+        kb.press_and_release("Ctrl+v")
+        
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual(searchbar.search_string, u'CopyPasteCopyPaste')
+
+    def test_ctrl_x_v(self):
+        """ This test if ctrl+x and ctrl+v cuts and pastes text"""
+        self.dash.ensure_hidden()
+        self.dash.toggle_reveal()
+
+        kb = Keyboard();
+        kb.type("CutPaste")
+        sleep(1)
+
+        kb.press_and_release("Ctrl+a")
+        kb.press_and_release("Ctrl+x")
+        kb.press_and_release("Ctrl+v")
+        kb.press_and_release("Ctrl+v")
+        
+        searchbar = self.dash.get_searchbar()
+        self.assertEqual(searchbar.search_string, u'CutPasteCutPaste')