Merge branch 'topic/dap.gs.285.call_stack_filter_opening_view' into 'master'

Prevent the DAP Call Stack to be automatically opened

Closes #285

See merge request eng/ide/gnatstudio!468

Author: AdrienBoulanger

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

@@ -957,7 +957,7 @@ package body DAP.Views.Assembly is
       pragma Unreferenced (New_Request);
 
       View : constant Assembly_MDI := Assembly_MDI_Views.Retrieve_View
-        (Self.Kernel);
+        (Self.Kernel, True);
       S    : Disassemble_Elements;
 
       -- Format_Opcodes --
@@ -1360,7 +1360,7 @@ package body DAP.Views.Assembly is
    is
       pragma Unreferenced (Self);
       View : constant Assembly_View :=
-        Assembly_View (Assembly_MDI_Views.Retrieve_View (Kernel));
+        Assembly_View (Assembly_MDI_Views.Retrieve_View (Kernel, True));
    begin
       if View /= null then
          View.Highlight (False);
@@ -1378,7 +1378,7 @@ package body DAP.Views.Assembly is
    is
       pragma Unreferenced (Self);
       View : constant Assembly_View := Assembly_View
-        (Assembly_MDI_Views.Retrieve_View (Kernel));
+        (Assembly_MDI_Views.Retrieve_View (Kernel, True));
    begin
       if View /= null then
          View.Highlight (False);

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

@@ -238,7 +238,8 @@ package body DAP.Views.Call_Stack is
       use type DAP.Clients.DAP_Client_Access;
 
       View : constant Call_Stack :=
-        CS_MDI_Views.Retrieve_View (Get_Kernel (Context));
+        CS_MDI_Views.Retrieve_View
+          (Get_Kernel (Context), Visible_Only => True);
    begin
       if View = null then
          return False;
@@ -294,9 +295,11 @@ package body DAP.Views.Call_Stack is
         or else Pref = Preference (Show_Location)
         or else Pref = Preference (Show_Address)
       then
-         View := CS_MDI_Views.Retrieve_View (Kernel);
-         Update_Columns_Visibility (View);
-         Update (View);
+         View := CS_MDI_Views.Retrieve_View (Kernel, Visible_Only => True);
+         if View /= null then
+            Update_Columns_Visibility (View);
+            Update (View);
+         end if;
       end if;
    end Execute;
 
@@ -314,7 +317,7 @@ package body DAP.Views.Call_Stack is
 
       Kernel : constant Kernel_Handle := Get_Kernel (Context.Context);
       View   : constant Call_Stack    :=
-        Call_Stack (CS_MDI_Views.Retrieve_View (Kernel));
+        Call_Stack (CS_MDI_Views.Retrieve_View (Kernel, Visible_Only => True));
       Client : DAP.Clients.DAP_Client_Access;
    begin
       if View /= null then
@@ -502,7 +505,7 @@ package body DAP.Views.Call_Stack is
       Client : not null access DAP.Clients.DAP_Client'Class)
    is
       View : constant Call_Stack    :=
-        Call_Stack (CS_MDI_Views.Retrieve_View (Kernel));
+        Call_Stack (CS_MDI_Views.Retrieve_View (Kernel, Visible_Only => True));
    begin
       if View /= null
         and then Get_Client (View) = Client

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

@@ -554,7 +554,7 @@ package body DAP.Views.Consoles is
    is
       pragma Unreferenced (Command);
       View : constant Console_MDI :=
-        Console_MDI_Views.Retrieve_View (Get_Kernel (Context.Context));
+        Console_MDI_Views.Retrieve_View (Get_Kernel (Context.Context), True);
    begin
       if View /= null then
          View.Console.Clear;

dap/src/modules/dap-views.adb

@@ -189,8 +189,8 @@ package body DAP.Views is
       is
          pragma Unreferenced (Self);
 
-         V      : constant access Formal_View_Record'Class :=
-           Formal_Views.Retrieve_View (Kernel);
+         V : constant access Formal_View_Record'Class :=
+           Formal_Views.Retrieve_View (Kernel, True);
       begin
 
          if V /= null then
@@ -210,7 +210,7 @@ package body DAP.Views is
          pragma Unreferenced (Self);
 
          V : constant access Formal_View_Record'Class :=
-           Formal_Views.Retrieve_View (Kernel);
+           Formal_Views.Retrieve_View (Kernel, True);
       begin
          if V /= null then
             V.On_Process_Terminated;
@@ -227,7 +227,7 @@ package body DAP.Views is
           Debugger : access GPS.Debuggers.Base_Visual_Debugger'Class)
       is
          V : constant access Formal_View_Record'Class :=
-           Formal_Views.Retrieve_View (Kernel);
+           Formal_Views.Retrieve_View (Kernel, True);
       begin
 
          if V /= null and then V.Get_Client /= null then
@@ -247,8 +247,8 @@ package body DAP.Views is
       is
          pragma Unreferenced (Self);
 
-         V      : constant access Formal_View_Record'Class :=
-           Formal_Views.Retrieve_View (Kernel);
+         V : constant access Formal_View_Record'Class :=
+           Formal_Views.Retrieve_View (Kernel, True);
       begin
          if V /= null then
             V.On_Location_Changed;

testsuite/tests/dap.gs.285.debug_views_in_default_perspective/default.gpr

@@ -0,0 +1,10 @@
+project Default is
+
+   package Compiler is
+      for Switches ("Ada") use ("-g");
+   end Compiler;
+
+   for Main use ("main.adb");
+
+end Default;
+

testsuite/tests/dap.gs.285.debug_views_in_default_perspective/main.adb

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

testsuite/tests/dap.gs.285.debug_views_in_default_perspective/test.cmd

@@ -0,0 +1,5 @@
+v="$(gdb -v | head -n 1 | cut -c 14-16)"
+if [ $v -ge 15 ]
+then
+  $GPS -Pdefault --load=test.py --traceon=GPS.DEBUGGING.DAP_MODULE --traceon=MODULE.Debugger_DAP --traceoff=GPS.DAP.VARIABLES
+fi

testsuite/tests/dap.gs.285.debug_views_in_default_perspective/test.py

@@ -0,0 +1,47 @@
+"""
+Test that Debug views are closed when exiting the debugger session.
+"""
+import GPS
+from gs_utils.internal.utils import *
+
+
+DEBUG_VIEWS = ["Call Stack", "Assembly", "Threads", "Variables"]
+
+
+def check_debug_view_visibility(visible, msg):
+    cpt = 0
+    for child in GPS.MDI.children():
+        if child.name() in DEBUG_VIEWS:
+            gps_assert(
+                child.pywidget().get_parent().props.visible
+                and child.pywidget().get_parent().get_parent().props.visible,
+                visible,
+                child.name() + " " + msg)
+            cpt += 1
+    if visible:
+        gps_assert(cpt, len(DEBUG_VIEWS), "Missing views %s" % msg)
+
+
+@run_test_driver
+def test_driver():
+    GPS.execute_action("Build & Debug Number 1")
+    yield hook("debugger_started")
+
+    # Open the views
+    for view in DEBUG_VIEWS:
+        GPS.execute_action("/Debug/Data/%s" % view)
+
+    # Start the debugger with the dialog without setting any text
+    debug = GPS.Debugger.get()
+    debug.send("run")
+    yield wait_until_not_busy(debug)
+    check_debug_view_visibility(
+        True,
+        "should be opened")
+
+    debug.send("quit")
+    # Wait for context and filter to be recomputed
+    yield timeout(3000)
+    check_debug_view_visibility(
+        False,
+        "should be hidden after quitting the debugger")

testsuite/tests/dap.gs.285.debug_views_in_default_perspective/test.yaml

@@ -0,0 +1 @@
+title: 'dap.gs.285.debug_views_in_default_perspective'