Merge branch '22-dap-integration-239-1' into 'master'

Scroll to the selected variable after the variable view updating

See merge request eng/ide/gnatstudio!437

Author: ogorodnik

dap/src/modules/dap-views-variables.adb

@@ -366,7 +366,7 @@ package body DAP.Views.Variables is
       use type Expansions.Expansion_Status;
    begin
       if Self.Expansion /= Expansions.No_Expansion then
-         Expansions.Set_Expansion_Status
+         Expansions.Set_Expansion_Status_Stop_On_Dummy
            (Self.Tree, Self.Expansion);
       end if;
    end Restore_Expansion;
@@ -1373,11 +1373,19 @@ package body DAP.Views.Variables is
      (Self : not null access DAP_Variables_View_Record)
    is
       use type DAP.Clients.DAP_Client_Access;
+      use type Expansions.Expansion_Status;
 
       Client : constant DAP.Clients.DAP_Client_Access := Get_Client (Self);
    begin
       Trace (Me, "Update view");
 
+      if not Self.Tree.Items.Is_Empty
+        and then Self.Expansion = Expansions.No_Expansion
+      then
+         --  Store expansion if not done yet
+         Expansions.Get_Expansion_Status (Self.Tree, Self.Expansion);
+      end if;
+
       if Client /= null
         and then Client.Get_Variables /= null
       then
@@ -1397,7 +1405,6 @@ package body DAP.Views.Variables is
 
       elsif not Self.Tree.Items.Is_Empty then
          Self.Tree.Types_Column.Set_Visible (Show_Types.Get_Pref);
-         Expansions.Get_Expansion_Status (Self.Tree, Self.Expansion);
          Self.Tree.Model.Clear;
 
          Self.Update (0);

testsuite/tests/dap.V711-016.arguments/main.adb

@@ -4,11 +4,20 @@ procedure Main is
    procedure Print (I : Integer; B : Boolean) is
    begin
       Ada.Text_IO.Put_Line ("Hello" & B'Img & I'Img);
+      Ada.Text_IO.Put_Line ("Hello" & B'Img & I'Img);
    end;
 
    I : constant Integer := 0;
    B : constant Boolean := False;
    Arguments : constant Integer := 5;
+
+   type Rec is record
+      A : Integer := 1;
+      B : Boolean := False;
+   end record;
+
+   R : Rec;
+
 begin
    Print (I, B);
 end Main;

testsuite/tests/dap.V711-016.arguments/test.py

@@ -51,3 +51,19 @@ def run_test():
     dump = dump_tree_model(tree.get_model(), 0)
     gps_assert(dump, expected_names_1)
 
+    # test that we restore the variable view selection
+    debug.send("graph display R")
+    yield wait_until_not_busy(debug)
+    tree = get_widget_by_name("Variables Tree")
+    tree.expand_row(Gtk.TreePath((0)), True)
+    tree.expand_row(Gtk.TreePath((2)), True)
+    tree.get_selection().select_path(Gtk.TreePath("1"))
+
+    debug.send("step")
+    yield wait_DAP_server("variables")
+    yield wait_until_not_busy(debug)
+
+    gps_assert(tree.get_selection().iter_is_selected(tree.get_model().get_iter("1")),
+               True,
+               "Wrong variable is selected")
+    gps_assert(tree.row_expanded(Gtk.TreePath((2))), True, "Expansion not restored")

widgets/src/gtkada-tree_view.adb

@@ -1280,6 +1280,90 @@ package body Gtkada.Tree_View is
          end if;
       end Set_Expansion_Status;
 
+      ----------------------------------------
+      -- Set_Expansion_Status_Stop_On_Dummy --
+      ----------------------------------------
+
+      procedure Set_Expansion_Status_Stop_On_Dummy
+        (Self   : not null access Tree_Record'Class;
+         Status : in out Expansion_Status)
+      is
+         Stopped : Boolean := False;
+         --  Flag to stop expanding when we found a dummy node that means that
+         --  not all data is loaded
+
+         function Expand_Node
+           (Model : Gtk_Tree_Model;
+            Path  : Gtk_Tree_Path;
+            Iter  : Gtk_Tree_Iter) return Boolean;
+
+         -----------------
+         -- Expand_Node --
+         -----------------
+
+         function Expand_Node
+           (Model : Gtk_Tree_Model;
+            Path  : Gtk_Tree_Path;
+            Iter  : Gtk_Tree_Iter) return Boolean
+         is
+            pragma Unreferenced (Path);
+
+            Dummy         : Boolean;
+            The_Id        : constant Id := Get_Id (Self, Iter);
+            Sortable_Path : Gtk_Tree_Path;
+
+         begin
+            if Status.Expanded.Contains (The_Id) then
+
+               --  check whether the node contains the dummy node
+               if Model.Has_Child (Iter) then
+                  Stopped := Get_Flag
+                    (Self, Model.Children (Iter), Flag_Is_Dummy);
+               end if;
+
+               Sortable_Path := Self.Get_Sortable_Path_For_Store_Iter (Iter);
+               Dummy := Self.Expand_Row (Sortable_Path, Open_All => False);
+               Path_Free (Sortable_Path);
+            end if;
+
+            if not Stopped then
+               if Status.Selection.Contains (The_Id) then
+                  Self.Get_Selection.Select_Iter
+                    (Self.Convert_To_Sortable_Model_Iter (Iter));
+               end if;
+            end if;
+
+            --  Return True to stop iterating or False to continue
+            return Stopped;
+         end Expand_Node;
+
+      begin
+         if Status = No_Expansion then
+            return;
+         end if;
+
+         Self.Collapse_All;
+         Self.Model.Foreach (Expand_Node'Unrestricted_Access);
+
+         if Stopped then
+            --  we found the dummy node, stop for now
+            return;
+         end if;
+
+         --  here we have all nodes created
+         if Status.Has_Scroll_Info then
+            Gtk_Tree_View_Record (Self.all).Scroll_To_Cell
+              (Path      => Status.Scroll_Y,
+               Column    => null,
+               Use_Align => False,
+               Row_Align => 0.0,
+               Col_Align => 0.0);
+            Path_Free (Status.Scroll_Y);
+         end if;
+
+         Status := No_Expansion;
+      end Set_Expansion_Status_Stop_On_Dummy;
+
       -----------------------
       -- On_Tree_Destroyed --
       -----------------------

widgets/src/gtkada-tree_view.ads

@@ -191,6 +191,14 @@ package Gtkada.Tree_View is
       --  across refresh of the model.
       --  This also preserves the current scrolling position
 
+      procedure Set_Expansion_Status_Stop_On_Dummy
+        (Self   : not null access Tree_Record'Class;
+         Status : in out Expansion_Status);
+      --  Same as above but stop on the first expanding node that contains
+      --  the "dummy" child. Clears Status when not stopped and expansion,
+      --  scrolling, and selection are restored. Is used when getting/filling
+      --  data asynchronous.
+
       type Detached_Model is new Ada.Finalization.Limited_Controlled
          with private;
       type Detached_Model_Access is access all Detached_Model'Class;