Home | History | Annotate | Line # | Download | only in gdb.dap 
      1 # Copyright 2024 Free Software Foundation, Inc.
      2 
      3 # This program is free software; you can redistribute it and/or modify
      4 # it under the terms of the GNU General Public License as published by
      5 # the Free Software Foundation; either version 3 of the License, or
      6 # (at your option) any later version.
      7 #
      8 # This program is distributed in the hope that it will be useful,
      9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
     10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     11 # GNU General Public License for more details.
     12 #
     13 # You should have received a copy of the GNU General Public License
     14 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
     15 
     16 # Test that stepOut puts the return value in scope.
     17 
     18 require allow_dap_tests
     19 
     20 load_lib dap-support.exp
     21 
     22 standard_testfile
     23 
     24 if {[build_executable ${testfile}.exp $testfile] == -1} {
     25     return
     26 }
     27 
     28 if {[dap_initialize] == ""} {
     29     return
     30 }
     31 
     32 set launch_id [dap_launch $testfile]
     33 
     34 set obj [dap_check_request_and_response "set breakpoint on function" \
     35 	     setFunctionBreakpoints \
     36 	     {o breakpoints [a [o name [s function_breakpoint_here]]]}]
     37 set fn_bpno [dap_get_breakpoint_number $obj]
     38 
     39 dap_check_request_and_response "configurationDone" configurationDone
     40 
     41 dap_check_response "launch response" launch $launch_id
     42 
     43 dap_wait_for_event_and_check "inferior started" thread "body reason" started
     44 
     45 dap_wait_for_event_and_check "stopped at function breakpoint" stopped \
     46     "body reason" breakpoint \
     47     "body hitBreakpointIds" $fn_bpno
     48 
     49 dap_check_request_and_response "return from function" stepOut \
     50     {o threadId [i 1]}
     51 dap_wait_for_event_and_check "stopped after return" stopped \
     52     "body reason" step
     53 
     54 set bt [lindex [dap_check_request_and_response "backtrace" stackTrace \
     55 		    {o threadId [i 1]}] \
     56 	    0]
     57 set frame_id [dict get [lindex [dict get $bt body stackFrames] 0] id]
     58 
     59 set scopes [dap_check_request_and_response "get scopes" scopes \
     60 		[format {o frameId [i %d]} $frame_id]]
     61 set scopes [dict get [lindex $scopes 0] body scopes]
     62 
     63 gdb_assert {[llength $scopes] == 2 || [llength $scopes] == 3} "two or three scopes"
     64 
     65 lassign $scopes scope reg_scope return_scope
     66 
     67 set test "scope is locals"
     68 if { $return_scope == "" } {
     69     unsupported $test
     70 } else {
     71     gdb_assert {[dict get $scope name] == "Locals"} $test
     72     gdb_assert {[dict get $scope presentationHint] == "locals"} \
     73 	"locals presentation hint"
     74     gdb_assert {[dict get $scope namedVariables] == 1} "one var in scope"
     75 
     76     gdb_assert {[dict get $return_scope name] == "Return"} "scope is return"
     77     gdb_assert {[dict get $return_scope presentationHint] == "returnValue"} \
     78 	"returnValue presentation hint"
     79     gdb_assert {[dict get $return_scope namedVariables] == 1} \
     80 	"one var in return scope"
     81 
     82     set num [dict get $return_scope variablesReference]
     83     set refs [lindex [dap_check_request_and_response "fetch arguments" \
     84 			  "variables" \
     85 			  [format {o variablesReference [i %d]} $num]] \
     86 		  0]
     87     set varlist [lindex [dict get $refs body variables] 0]
     88 
     89     gdb_assert {[dict get $varlist variablesReference] > 0} \
     90 	"variable has children"
     91     gdb_assert {[dict get $varlist name] == "(return)"} \
     92 	"variable is return value"
     93 }
     94 
     95 set response_and_events [dap_request_and_response stepOut {o threadId [i 1]}]
     96 set response [lindex $response_and_events 0]
     97 if {[dict get $response success] == "true"} {
     98     fail "stepOut from outermost frame should not succeed"
     99 } else {
    100     pass "stepOut from outermost frame failed like it should"
    101 }
    102 
    103 dap_check_request_and_response "still stopped and may request backtrace" \
    104     stackTrace {o threadId [i 1]}
    105 
    106 dap_shutdown
    107