gdb/testsuite/gdb.base/define.exp

   1 # Copyright 1998-2020 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 # This file was written by Elena Zannoni. (ezannoni@cygnus.com)
  17
  18
  19 #
  20 # test running programs
  21 #
  22
  23 standard_testfile break.c break1.c
  24
  25 if {[prepare_for_testing "failed to prepare" ${testfile} \
  26          [list $srcfile $srcfile2] {debug nowarnings}]} {
  27     return -1
  28 }
  29
  30 set bp_location1 [gdb_get_line_number "set breakpoint 1 here"]
  31 set bp_location11 [gdb_get_line_number "set breakpoint 11 here"]
  32
  33 if ![runto_main] then { fail "define tests suppressed" }
  34
  35 # Verify that GDB allows a user to define their very own commands.
  36 #
  37 gdb_test_multiple "define nextwhere" "define user command: nextwhere" {
  38     -re "Type commands for definition of \"nextwhere\".\r\nEnd with a line saying just \"end\".\r\n>$" {
  39         gdb_test "next\nbt\nend" "" \
  40             "define user command: nextwhere"
  41     }
  42 }
  43
  44 # Verify that those commands work as gdb_expected.
  45 #
  46 gdb_test "nextwhere" \
  47     "$bp_location1\[ \t\]*printf.*#0\[ \t\]*main.*:$bp_location1.*" \
  48     "use user command: nextwhere"
  49
  50 # Verify that a user can define a command whose spelling is a
  51 # proper substring of another user-defined command.
  52 #
  53 gdb_test_multiple "define nextwh" "define user command: nextwh" {
  54     -re "Type commands for definition of \"nextwh\".\r\nEnd with a line saying just \"end\".\r\n>$" {
  55         gdb_test "next 2\nbt\nend" "" \
  56             "define user command: nextwh"
  57     }
  58 }
  59
  60 # Verify that a user can redefine their commands.  (Test both the
  61 # confirmed and unconfirmed cases.)
  62 #
  63 gdb_test "define nextwhere" \
  64     "Command \"nextwhere\" not redefined.*" \
  65     "redefine user command aborted: nextwhere" \
  66     "Redefine command \"nextwhere\".*y or n. $" \
  67     "n"
  68
  69 send_gdb "define nextwhere\n"
  70 gdb_expect {
  71   -re "Redefine command \"nextwhere\".*y or n. $"\
  72           {send_gdb "y\n"
  73            gdb_expect {
  74              -re "Type commands for definition of \"nextwhere\".\r\nEnd with a line saying just \"end\".\r\n>$"\
  75                      {send_gdb "bt\nnext\nend\n"
  76                       gdb_expect {
  77                         -re "$gdb_prompt $"\
  78                                 {pass "redefine user command: nextwhere"}
  79                         timeout {fail "(timeout) redefine user command: nextwhere"}
  80                       }
  81                      }
  82              timeout {fail "(timeout) redefine user command: nextwhere"}
  83            }
  84           }
  85   -re "$gdb_prompt $"\
  86           {fail "redefine user command: nextwhere"}
  87   timeout {fail "(timeout) redefine user command: nextwhere"}
  88 }
  89
  90 # Verify that GDB gracefully handles an attempt to redefine the
  91 # help text for a builtin command.
  92 #
  93 gdb_test "document step" "Command \"step\" is built-in.*" \
  94     "redocumenting builtin command disallowed"
  95
  96 # Verify that a user can document their own commands.  (And redocument
  97 # them.)
  98 #
  99 gdb_test_multiple "document nextwhere" "document user command: nextwhere" {
 100     -re "Type documentation for \"nextwhere\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 101         gdb_test "A next command that first shows you where you're stepping from.\nend" \
 102             "" \
 103             "document user command: nextwhere"
 104     }
 105 }
 106
 107 gdb_test_multiple "document nextwhere" "re-document user command: nextwhere" {
 108     -re "Type documentation for \"nextwhere\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 109         gdb_test "A next command that first shows you where you're stepping from.\nend" \
 110             "" \
 111             "re-document user command: nextwhere"
 112     }
 113 }
 114
 115 gdb_test "help nextwhere" \
 116     "A next command that first shows you where you're stepping from.*" \
 117     "help user command: nextwhere"
 118
 119 # Verify that the document command preserves whitespace in the beginning of the line.
 120 #
 121 gdb_test_multiple "document nextwhere" "set up whitespace in help string" {
 122     -re "Type documentation for \"nextwhere\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 123         gdb_test "   A next command that first shows you where you're stepping from.\nend" \
 124             "" \
 125             "set up whitespace in help string"
 126     }
 127 }
 128
 129 gdb_test "help nextwhere" \
 130     "   A next command that first shows you where you're stepping from.*" \
 131     "preserve whitespace in help string"
 132
 133 # Verify that GDB allows a user to use . in a command name.
 134 #
 135 gdb_test_multiple "define dot.command" "define user command: dot.command" {
 136     -re "Type commands for definition of \"dot.command\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 137         gdb_test "echo dot command\\n\nend" "" \
 138             "define user command: dot.command"
 139     }
 140 }
 141
 142 # Verify that dot.command works.
 143 #
 144 gdb_test "dot.command" \
 145     "dot command" \
 146     "full name dot.command"
 147 gdb_test "dot" \
 148     "dot command" \
 149     "partial name dot"
 150 gdb_test "dot." \
 151     "dot command" \
 152     "partial name dot."
 153 gdb_test "dot.c" \
 154     "dot command" \
 155     "partial name dot.c"
 156
 157
 158 # Verify that the command parser doesn't require a space after an 'if'
 159 # command in a user defined function.
 160 #
 161 gdb_test_multiple "define ifnospace" "define user command: ifnospace" \
 162 {
 163   -re "Type commands for definition of \"ifnospace\".\r\nEnd with a line saying just \"end\".\r\n>$" \
 164     {
 165       gdb_test_multiple "if(3<4)\nprint \"hi there\\n\"\nend\nend" "send body of ifnospace"  \
 166         {
 167          -re "$gdb_prompt $"\
 168                  {pass "define user command: ifnospace"}
 169         }
 170     }
 171 }
 172
 173 gdb_test "ifnospace" ".*hi there.*" "test ifnospace is parsed correctly"
 174
 175 # Verify that the command parser properly handles command abbreviations.
 176 with_test_prefix "command abbreviations in define" {
 177   set test "define user command: breakmain"
 178   gdb_test_multiple "define breakmain" "$test" {
 179       -re "Type commands for definition of \"breakmain\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 180           pass "$test"
 181           set test "send body of breakmain"
 182           gdb_test_multiple "break main\ncommand\necho\nend\nend" "$test"  {
 183               -re "$gdb_prompt $"\
 184                   {pass "$test"}
 185           }
 186       }
 187   }
 188
 189   gdb_test "breakmain" ".*Breakpoint .*" "run user command"
 190
 191   # If GDB fails to interpret properly the abbrev "command", the last "end"
 192   # will be missing.  Issue it to avoid a desync that would break the other
 193   # tests in this file.
 194   gdb_test "end" \
 195     "This command cannot be used at the top level.*" \
 196     "additional end command"
 197
 198   gdb_test "info break \$bpnum" \
 199     [multi_line \
 200       "Num     Type\[ \]+Disp Enb Address\[ \]+What.*" \
 201       "\[0-9\]+\[\t \]+breakpoint     keep y.* in main at .*" \
 202       "\[\t \]+echo.*"] \
 203     "info break shows echo command"
 204 }
 205
 206
 207 # Verify that the command parser doesn't require a space after an 'while'
 208 # command in a user defined function.
 209 #
 210 gdb_test_multiple "define whilenospace" "define user command: whilenospace" \
 211 {
 212   -re "Type commands for definition of \"whilenospace\".\r\nEnd with a line saying just \"end\".\r\n>$" \
 213     {
 214       gdb_test_multiple "set \$i=1\nwhile(\$i<2)\nset \$i=2\nprint \"hi there\\n\"\nend\nend" "send body of whilenospace" \
 215          {
 216            -re "$gdb_prompt $" \
 217                    {pass "define user command: whilenospace"}
 218          }
 219     }
 220 }
 221
 222 gdb_test "whilenospace" ".*hi there.*" "test whilenospace is parsed correctly"
 223
 224 # Verify that the user can "hook" a builtin command.  We choose to
 225 # hook the "stop" pseudo command, and we'll define it to use a user-
 226 # define command.
 227 #
 228 gdb_test_multiple "define user-bt" "define user command: user-bt" {
 229     -re "Type commands for definition of \"user-bt\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 230         gdb_test "bt\nend" \
 231             "" \
 232             "define user command: user-bt"
 233     }
 234 }
 235
 236 gdb_test_multiple "define hook-stop" "define hook-stop command" {
 237     -re "Type commands for definition of \"hook-stop\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 238         gdb_test "user-b\nend" \
 239             "" \
 240             "define hook-stop command"
 241     }
 242 }
 243
 244 gdb_test "next" "#0\[ \t\]*main.*:$bp_location11.*" \
 245     "use hook-stop command"
 246
 247 # Verify that GDB responds gracefully to an attempt to define a "hook
 248 # command" which doesn't exist.  (Test both the confirmed and unconfirmed
 249 # cases.)
 250 #
 251 gdb_test "define hook-bar" \
 252     "Not confirmed.*" \
 253     "define hook undefined command aborted: bar" \
 254     "warning: Your new `hook-bar' command does not hook any existing command.\r\nProceed.*y or n. $" \
 255     "n"
 256
 257 send_gdb "define hook-bar\n"
 258 gdb_expect {
 259   -re "warning: Your new `hook-bar' command does not hook any existing command.\r\nProceed.*y or n. $"\
 260           {send_gdb "y\n"
 261            gdb_expect {
 262              -re "Type commands for definition of \"hook-bar\".\r\nEnd with a line saying just \"end\".\r\n>$"\
 263                      {send_gdb "nextwhere\nend\n"
 264                       gdb_expect {
 265                         -re "$gdb_prompt $"\
 266                                 {pass "define hook undefined command: bar"}
 267                         timeout {fail "(timeout) define hook undefined command: bar"}
 268                       }
 269                      }
 270              -re "$gdb_prompt $"\
 271                      {fail "define hook undefined command: bar"}
 272              timeout {fail "(timeout) define hook undefined command: bar"}
 273            }
 274           }
 275   -re "$gdb_prompt $"\
 276           {fail "define hook undefined command: bar"}
 277   timeout {fail "(timeout) define hook undefined command: bar"}
 278 }
 279
 280 # Test creation of an additional target subcommand.
 281 gdb_test_multiple "define target testsuite" "" {
 282     -re "Type commands for definition of \"target testsuite\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 283         gdb_test "printf \"hello\\n\"\nend" "" "define target testsuite"
 284     }
 285 }
 286 gdb_test_multiple "document target testsuite" "" {
 287     -re "Type documentation for \"target testsuite\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 288         gdb_test "A test target.\nend" "" "document target testsuite"
 289     }
 290 }
 291
 292 gdb_test "help target" ".*A test target.*"
 293 gdb_test "target testsuite" "hello"
 294 gdb_test "show user target testsuite" "User command \"target testsuite\":\r\n  printf \"hello\\\\n\"\r\n"
 295
 296 # We should even be able to hook subcommands.
 297 gdb_test_multiple "define target hook-testsuite" "" {
 298     -re "Type commands for definition of \"target hook-testsuite\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 299         gdb_test "printf \"one\\n\"\nend" "" "define target hook-testsuite"
 300     }
 301 }
 302
 303 gdb_test_multiple "define target hookpost-testsuite" "" {
 304     -re "Type commands for definition of \"target hookpost-testsuite\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 305         gdb_test "printf \"two\\n\"\nend" "" "define target hookpost-testsuite"
 306     }
 307 }
 308
 309 gdb_test "target testsuite" "one\r\nhello\r\ntwo" "target testsuite with hooks"
 310
 311 # Save the GDB prompt so it can be restored to the original value later.
 312 set prior_prompt ""
 313 gdb_test_multiple "show prompt" "save gdb_prompt" {
 314     -re "Gdb's prompt is \"($gdb_prompt) \"\.\[\r\n\]*$gdb_prompt $" {
 315         set prior_prompt $expect_out(1,string)
 316         pass "save gdb_prompt"
 317     }
 318 }
 319
 320 # This is a quasi-define command: Verify that the user can redefine
 321 # GDB's gdb_prompt.
 322 #
 323 gdb_test_multiple "set prompt \\(blah\\) " "set gdb_prompt" {
 324     -re "\\(blah\\) $" {
 325         pass "set gdb_prompt"
 326     }
 327 }
 328
 329 gdb_test_multiple "set prompt $prior_prompt " "reset gdb_prompt" {
 330     -re "\r\n$gdb_prompt $" {
 331         pass "reset gdb_prompt"
 332     }
 333 }
 334
 335 gdb_test_multiple "define do-define" "" {
 336     -re "Type commands for definition of \"do-define\".\r\nEnd with a line saying just \"end\".\r\n>$" {
 337         gdb_test "define do-printit\necho here\\n\nend\nend" "" "define do-define"
 338     }
 339 }
 340 gdb_test_no_output "do-define" "invoke do-define"
 341 gdb_test "do-printit" "here" "invoke do-printit"
 342
 343 gdb_exit
 344 return 0