V413-013: Event handling issue for floating toplevel

Don't use Gtk.Main.Grab_Get_Current in Keymanager, in
case of a modal dialog it will still return a widget
from the Main_Window which is in the wrong toplevel.

Modify Get_Current_Focus_Widget to first check if a
toplevel is active before relying on Grab_Get_Current.

Add a test.

Change-Id: I494ce5a59d710f5043a669c425fb958141a421e3

Author: AdrienBoulanger

kernel/src/gps-kernel-mdi.adb

@@ -1894,7 +1894,7 @@ package body GPS.Kernel.MDI is
      (Kernel : access Kernel_Handle_Record'Class) return Gtk.Widget.Gtk_Widget
    is
       use Widget_List;
-      W, W2       : Gtk_Widget;
+      W, W2       : Gtk_Widget := null;
       Toplevel    : Gtk_Window;
       List, List2 : Widget_List.Glist;
       Tooltip_Focus_Widget : constant Gtk_Widget :=
@@ -1906,14 +1906,6 @@ package body GPS.Kernel.MDI is
          return Tooltip_Focus_Widget;
       end if;
 
-      --  Then check if a window currently has a grab
-
-      W := Gtk.Main.Grab_Get_Current;
-      if W /= null then
-         Toplevel := Gtk_Window (Get_Toplevel (W));
-         W := Get_Focus (Toplevel);
-      end if;
-
       --  Then check all toplevel windows and stop at the one that has
       --  the focus.
 
@@ -1938,6 +1930,16 @@ package body GPS.Kernel.MDI is
          Free (List);
       end if;
 
+      --  Then check if a window currently has a grab
+
+      if W = null then
+         W := Gtk.Main.Grab_Get_Current;
+         if W /= null then
+            Toplevel := Gtk_Window (Get_Toplevel (W));
+            W := Get_Focus (Toplevel);
+         end if;
+      end if;
+
       --  If still no one has the focus, then no window in GNAT Studio
       --  currently has it. In this case, we assume that would be the main
       --  GNAT Studio window unless a floating child last had the focus.

keymanager/src/keymanager_module.adb

@@ -31,7 +31,7 @@ with Gdk.Window;                     use Gdk.Window;
 with Glib.Convert;                   use Glib.Convert;
 with Glib;                           use Glib;
 with Gtk.Accel_Group;                use Gtk.Accel_Group;
-with Gtk.Main;                       use Gtk.Main;
+with Gtk.Main;
 with Gtk.Widget;                     use Gtk.Widget;
 with Gtk.Window;                     use Gtk.Window;
 with Gtkada.MDI;                     use Gtkada.MDI;
@@ -522,7 +522,7 @@ package body KeyManager_Module is
          --  another "Continue Search?" dialog to appear.
 
          declare
-            Current : constant Gtk_Widget := Grab_Get_Current;
+            Current : constant Gtk_Widget := Get_Current_Focus_Widget (Kernel);
          begin
             if Current = null
               or else (Current.Get_Realized and then

testsuite/tests/V413-013.dialog.focus/default.gpr

@@ -0,0 +1,3 @@
+project Default is
+    for Main use ("main.adb");
+end Default;

testsuite/tests/V413-013.dialog.focus/main.adb

@@ -0,0 +1,4 @@
+procedure Main is
+begin
+   null;
+end Main;

testsuite/tests/V413-013.dialog.focus/test.py

@@ -0,0 +1,37 @@
+"""
+When a dialog modal is opened no actions should be executed in the editor.
+"""
+import GPS
+from gs_utils.internal.utils import *
+from gs_utils.internal.dialogs import *
+
+
+@run_test_driver
+def test_driver():
+    GPS.Preference("General-Use-Native-Dialogs").set(False)
+    b = GPS.EditorBuffer.get(GPS.File("main.adb"))
+    expected = b.get_chars()
+    b.current_view().goto(b.at(1, 18))
+    d = Gtk_File_Chooser_Dialog()
+    yield d.open_and_yield("save as")
+    # The first BACKSPACE will be sent to the "new name entry" which will
+    # trigger the completion
+    entry = get_widgets_by_type(Gtk.Entry, d.dialogs[0])[0]
+    gps_assert(entry.get_text(), "main.adb", "Wrong text in entry")
+    entry.get_toplevel().grab_focus()
+    entry.grab_focus()
+    send_key_event(GDK_BACKSPACE)
+    yield timeout(200)
+    # During the completion the focus is whacky => the second and third
+    # BACKSPACE should do nothing
+    send_key_event(GDK_BACKSPACE)
+    yield timeout(200)
+    send_key_event(GDK_BACKSPACE)
+    yield timeout(200)
+    gps_assert(entry.get_text(),
+               ".adb",
+               "Backspace should have affected the entry")
+    yield d.cancel()
+    gps_assert(len(b.get_chars()),
+               len(expected),
+               "The buffer has been modified while a modal dialog was shown")

testsuite/tests/V413-013.dialog.focus/test.yaml

@@ -0,0 +1,4 @@
+title: 'V413-013.dialog.focus'
+skip:
+    # not compatible with xvfb
+    - ['SKIP', 'env.build.os.name == "linux"']