Merge branch 'gs_303' into 'master'

Corrections for the DAP variables view

See merge request eng/ide/gnatstudio!854

Author: ogorodnik

dap/src/dap-clients-variables-variables.adb

@@ -92,7 +92,23 @@ package body DAP.Clients.Variables.Variables is
 
       --  Add childs to Id
       if Result.a_body.variables.Length = 0 then
-         Var.Scopes.Append_Child (C, Empty_Variable_Data);
+         --  GDB did not return nested elements, for example:
+         --  {"request_seq": 17, "type": "response", "command": "variables",
+         --   "success": true, "body": {"variables": []}, "seq": 146}
+         --  so display "[]" as a value
+         Var.Scopes.Append_Child
+           (C,
+            (Non_Specified,
+             (name               => "<>",
+              value              => "[]",
+              a_type             => "<>",
+              presentationHint   => (Is_Set => False),
+              evaluateName       => <>,
+              variablesReference => 0,
+              namedVariables     => (Is_Set => False),
+              indexedVariables   => (Is_Set => False),
+              memoryReference    => <>)));
+
       else
          for Index in 1 .. Result.a_body.variables.Length loop
             Var.Scopes.Append_Child
@@ -130,11 +146,46 @@ package body DAP.Clients.Variables.Variables is
    overriding procedure On_Error_Message
      (Self    : in out Variables_Request;
       Client  : not null access DAP.Clients.DAP_Client'Class;
-      Message : VSS.Strings.Virtual_String) is
+      Message : VSS.Strings.Virtual_String)
+   is
+      Var     : constant Variables_Holder_Access := Client.Get_Variables;
+      Id      : constant Integer :=
+        Self.Parameters.arguments.variablesReference;
+      C       : Variables_References_Trees.Cursor;
    begin
       DAP.Requests.Variables.Variables_DAP_Request
         (Self).On_Error_Message (Client, Message);
-      Client.Variables.On_Variable_Not_Found (Self.Params);
+
+      C := Var.Find_By_Id (Id);
+      if C = Variables_References_Trees.No_Element then
+         --  We did not find any entrance
+         return;
+      end if;
+
+      if Id = Var.Arguments_Scope_Id
+        or else Id = Var.Locals_Scope_Id
+        or else Id = Var.Globals_Scope_Id
+        or else Message.Is_Empty
+      then
+         Client.Variables.On_Variable_Not_Found (Self.Params);
+
+      else
+         --  Can't get nested elements for some reason, display
+         --  error message as a value to let user know about the problem.
+         Var.Scopes.Append_Child
+           (C,
+            (Non_Specified,
+             (name               => "<>",
+              value              => Message,
+              a_type             => "<>",
+              presentationHint   => (Is_Set => False),
+              evaluateName       => <>,
+              variablesReference => 0,
+              namedVariables     => (Is_Set => False),
+              indexedVariables   => (Is_Set => False),
+              memoryReference    => <>)));
+         Var.On_Variables_Response (Self.Params);
+      end if;
    end On_Error_Message;
 
    -----------------

testsuite/tests/dap.incorrect_variable/main.adb

@@ -0,0 +1,19 @@
+with Ada.Text_IO;
+with Ada.Unchecked_Conversion;
+with System;
+with System.Address_To_Access_Conversions;
+
+procedure Main is
+
+   type Integer_Access is access all Integer;
+   package To_Access is
+     new System.Address_To_Access_Conversions (Integer);
+   function To_Address is
+     new Ada.Unchecked_Conversion (Integer, System.Address);
+
+   I : Integer_Access;
+
+begin
+   I := Integer_Access (To_Access.To_Pointer (To_Address (16#8#)));
+   Ada.Text_IO.Put_Line (I.all'Img);
+end Main;

testsuite/tests/dap.incorrect_variable/prj.gpr

@@ -0,0 +1,11 @@
+project Prj is
+
+   for Object_Dir use "obj";
+   for Main use ("main.adb");
+
+   package Builder is
+      for Switches ("ada") use ("-g");
+   end Builder;
+
+end Prj;
+

testsuite/tests/dap.incorrect_variable/test.cmd

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

testsuite/tests/dap.incorrect_variable/test.py

@@ -0,0 +1,44 @@
+"""
+Verify that the Variables view shows error message as a value
+when GDB can't get the value.
+"""
+
+from gs_utils.internal.utils import *
+from workflows import promises
+
+
+@run_test_driver
+def driver():
+    yield wait_tasks()
+    GPS.execute_action("Build & Debug Number 1")
+    yield wait_for_mdi_child("Debugger Console")
+
+    b = GPS.EditorBuffer.get(GPS.File("main.adb"))
+
+    p = promises.DebuggerWrapper(GPS.File("main"))
+    debug = p.get()
+    yield wait_until_not_busy(debug)
+
+    yield p.send_promise("break main.adb:18")
+    yield wait_until_not_busy(debug)
+
+    yield p.send_promise("run")
+    yield wait_DAP_server('stackTrace')
+    yield wait_idle()
+
+    GPS.MDI.get_by_child(b.current_view()).raise_window()
+    b.current_view().goto(b.at(14, 4))
+
+    select_editor_contextual("Debug/Display I in Variables view")
+    yield wait_until_not_busy(debug)
+
+    view = Variables_View()
+    yield view.open_and_yield()
+
+    view.expand([0])
+    yield wait_until_not_busy(debug)
+    
+    gps_assert(
+        "Cannot access memory" in view.dump()[1][0],
+        True,
+        "Invalid contents of the Variables view")

testsuite/tests/dap.incorrect_variable/test.yaml

@@ -0,0 +1,3 @@
+title: 'dap.incorrect_variable'
+skip:
+    - [SKIP, 'env.valgrind_cmd != []']