1# Copyright (C) 2009-2016 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 is part of the GDB testsuite. It tests the mechanism 17# for defining new GDB commands in Python. 18 19load_lib gdb-python.exp 20 21standard_testfile 22 23if { [prepare_for_testing ${testfile}.exp ${testfile} ${srcfile}] } { 24 return -1 25} 26 27# Skip all tests if Python scripting is not enabled. 28if { [skip_python_tests] } { continue } 29 30if ![runto_main] then { 31 fail "Cannot run to main." 32 return 0 33} 34 35# Test a simple command. 36 37gdb_py_test_multiple "input simple command" \ 38 "python" "" \ 39 "class test_cmd (gdb.Command):" "" \ 40 " def __init__ (self):" "" \ 41 " super (test_cmd, self).__init__ (\"test_cmd\", gdb.COMMAND_OBSCURE)" "" \ 42 " def invoke (self, arg, from_tty):" "" \ 43 " print (\"test_cmd output, arg = %s\" % arg)" "" \ 44 "test_cmd ()" "" \ 45 "end" "" 46 47gdb_test "test_cmd ugh" "test_cmd output, arg = ugh" "call simple command" 48 49# Test a prefix command, and a subcommand within it. 50 51gdb_py_test_multiple "input prefix command" \ 52 "python" "" \ 53 "class prefix_cmd (gdb.Command):" "" \ 54 " def __init__ (self):" "" \ 55 " super (prefix_cmd, self).__init__ (\"prefix_cmd\", gdb.COMMAND_OBSCURE, gdb.COMPLETE_NONE, True)" "" \ 56 " def invoke (self, arg, from_tty):" "" \ 57 " print (\"prefix_cmd output, arg = %s\" % arg)" "" \ 58 "prefix_cmd ()" "" \ 59 "end" "" 60 61gdb_test "prefix_cmd ugh" "prefix_cmd output, arg = ugh" "call prefix command" 62 63gdb_py_test_multiple "input subcommand" \ 64 "python" "" \ 65 "class subcmd (gdb.Command):" "" \ 66 " def __init__ (self):" "" \ 67 " super (subcmd, self).__init__ (\"prefix_cmd subcmd\", gdb.COMMAND_OBSCURE)" "" \ 68 " def invoke (self, arg, from_tty):" "" \ 69 " print (\"subcmd output, arg = %s\" % arg)" "" \ 70 "subcmd ()" "" \ 71 "end" "" 72 73gdb_test "prefix_cmd subcmd ugh" "subcmd output, arg = ugh" "call subcmd" 74 75# Test prefix command using keyword arguments. 76 77gdb_py_test_multiple "input prefix command, keyword arguments" \ 78 "python" "" \ 79 "class prefix_cmd2 (gdb.Command):" "" \ 80 " def __init__ (self):" "" \ 81 " super (prefix_cmd2, self).__init__ (\"prefix_cmd2\", gdb.COMMAND_OBSCURE, prefix = True, completer_class = gdb.COMPLETE_FILENAME)" "" \ 82 " def invoke (self, arg, from_tty):" "" \ 83 " print (\"prefix_cmd2 output, arg = %s\" % arg)" "" \ 84 "prefix_cmd2 ()" "" \ 85 "end" "" 86 87gdb_test "prefix_cmd2 argh" "prefix_cmd2 output, arg = argh" "call prefix command, keyword arguments" 88 89gdb_py_test_multiple "input subcommand under prefix_cmd2" \ 90 "python" "" \ 91 "class subcmd (gdb.Command):" "" \ 92 " def __init__ (self):" "" \ 93 " super (subcmd, self).__init__ (\"prefix_cmd2 subcmd\", gdb.COMMAND_OBSCURE)" "" \ 94 " def invoke (self, arg, from_tty):" "" \ 95 " print (\"subcmd output, arg = %s\" % arg)" "" \ 96 "subcmd ()" "" \ 97 "end" "" 98 99gdb_test "prefix_cmd2 subcmd ugh" "subcmd output, arg = ugh" "call subcmd under prefix_cmd2" 100 101# Test a subcommand in an existing GDB prefix. 102 103gdb_py_test_multiple "input new subcommand" \ 104 "python" "" \ 105 "class newsubcmd (gdb.Command):" "" \ 106 " def __init__ (self):" "" \ 107 " super (newsubcmd, self).__init__ (\"info newsubcmd\", gdb.COMMAND_OBSCURE)" "" \ 108 " def invoke (self, arg, from_tty):" "" \ 109 " print (\"newsubcmd output, arg = %s\" % arg)" "" \ 110 "newsubcmd ()" "" \ 111 "end" "" 112 113gdb_test "info newsubcmd ugh" "newsubcmd output, arg = ugh" "call newsubcmd" 114 115# Test a command that throws gdb.GdbError. 116 117gdb_py_test_multiple "input command to throw error" \ 118 "python" "" \ 119 "class test_error_cmd (gdb.Command):" "" \ 120 " def __init__ (self):" "" \ 121 " super (test_error_cmd, self).__init__ (\"test_error_cmd\", gdb.COMMAND_OBSCURE)" "" \ 122 " def invoke (self, arg, from_tty):" "" \ 123 " raise gdb.GdbError ('you lose!')" "" \ 124 "test_error_cmd ()" "" \ 125 "end" "" 126 127gdb_test "test_error_cmd ugh" "you lose!" "call error command" 128 129# Test gdb.string_to_argv. 130 131gdb_test "python print (gdb.string_to_argv (\"1 2 3\"))" \ 132 {\['1', '2', '3'\]} \ 133 "string_to_argv (\"1 2 3\")" 134 135gdb_test "python print (gdb.string_to_argv (\"'1 2' 3\"))" \ 136 {\['1 2', '3'\]} \ 137 "string_to_argv (\"'1 2' 3\")" 138 139gdb_test "python print (gdb.string_to_argv ('\"1 2\" 3'))" \ 140 {\['1 2', '3'\]} \ 141 "string_to_argv ('\"1 2\" 3')" 142 143gdb_test "python print (gdb.string_to_argv ('1\\ 2 3'))" \ 144 {\['1 2', '3'\]} \ 145 "string_to_argv ('1\\ 2 3')" 146 147# Test user-defined python commands. 148gdb_py_test_multiple "input simple user-defined command" \ 149 "python" "" \ 150 "class test_help (gdb.Command):" "" \ 151 " \"\"\"Docstring\"\"\"" "" \ 152 " def __init__ (self):" "" \ 153 " super (test_help, self).__init__ (\"test_help\", gdb.COMMAND_USER)" "" \ 154 " def invoke (self, arg, from_tty):" "" \ 155 " print (\"test_cmd output, arg = %s\" % arg)" "" \ 156 "test_help ()" "" \ 157 "end" "" 158 159gdb_test "test_help ugh" "test_cmd output, arg = ugh" "call simple user-defined command" 160 161# Make sure the command shows up in `help user-defined`. 162gdb_test "help user-defined" "User-defined commands.\[\r\n\]+The commands in this class are those defined by the user.\[\r\n\]+Use the \"define\" command to define a command.\[\r\n\]+\[\r\n\]+List of commands:\[\r\n\]+\[\r\n\]+test_help -- Docstring\[\r\n\]+\[\r\n\]+Type \"help\" followed by command name for full documentation.\[\r\n\]+Type \"apropos word\" to search for commands related to \"word\".\[\r\n\]+Command name abbreviations are allowed if unambiguous.\[\r\n\]+" "see user-defined command in `help user-defined`" 163 164# Make sure the command does not show up in `show user`. 165gdb_test "show user test_help" "Not a user command\." \ 166 "don't show user-defined python command in `show user command`" 167 168# Test expression completion on fields 169gdb_py_test_multiple "expression completion command" \ 170 "python" "" \ 171 "class expr_test (gdb.Command):" "" \ 172 " def __init__ (self):" "" \ 173 " super (expr_test, self).__init__ (\"expr_test\", gdb.COMMAND_USER, gdb.COMPLETE_EXPRESSION)" "" \ 174 " def invoke (self, arg, from_tty):" "" \ 175 " print (\"invoked on = %s\" % arg)" "" \ 176 "expr_test ()" "" \ 177 "end" "" 178 179 180gdb_test "complete expr_test bar\." \ 181 "expr_test bar\.bc.*expr_test bar\.ij.*" \ 182 "Test completion through complete command" 183 184if { [readline_is_used] } { 185 set test "complete 'expr_test bar.i'" 186 send_gdb "expr_test bar\.i\t\t" 187 gdb_test_multiple "" "$test" { 188 -re "expr_test bar\.ij \\\x07$" { 189 send_gdb "\n" 190 gdb_test_multiple "" $test { 191 -re "invoked on = bar.ij.*$gdb_prompt $" { 192 pass "$test" 193 } 194 } 195 } 196 } 197} 198