1 # Copyright 1998-2019 Free Software Foundation, Inc.
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.
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.
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/>.
16 # This file was written by Elena Zannoni (ezannoni@cygnus.com)
18 # This file is part of the gdb testsuite.
21 # tests for command completion
23 # Here are some useful test cases for completion.
24 # They should be tested with both M-? and TAB.
26 # "show output-" "radix"
27 # "show output" "-radix"
28 # "p" ambiguous (commands starting with p--path, print, printf, etc.)
29 # "p " ambiguous (all symbols)
30 # "info t foo" no completions
31 # "info t " no completions
32 # "info t" ambiguous ("info target", "info terminal", etc.)
33 # "info ajksdlfk" no completions
34 # "info ajksdlfk " no completions
36 # "info " ambiguous (all info commands)
37 # "p \"break1" unambiguous (completes to filename "break1.c")
38 # "p \"break1." unambiguous (should complete to "break1.c" but does not,
39 # due to readline limitations)
40 # "p 'arg" ambiguous (all symbols starting with arg)
41 # "p b-arg" ambiguous (all symbols starting with arg)
42 # "p b-" ambiguous (all symbols)
43 # "file Make" "file" (word break hard to screw up here)
44 # "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
50 # test running programs
53 standard_testfile break.c break1.c
55 if [get_compiler_info] {
59 if {[prepare_for_testing "failed to prepare" $testfile \
60 [list $srcfile $srcfile2] {debug nowarnings}]} {
64 if ![runto_main] then {
65 perror "tests suppressed"
69 gdb_test_no_output "set max-completions unlimited"
71 gdb_test_no_output "complete print values\[0\].x." \
72 "field completion with invalid field"
74 # If there is a non-deprecated completion, it should be returned.
75 gdb_test "complete sav" "save" "test non-deprecated completion"
76 # If there is only a deprecated completion, then it should be returned.
77 gdb_test "complete save-t" "save-tracepoints" "test deprecated completion"
81 # Tag name completion.
84 gdb_test "complete ptype struct some_" "ptype struct some_struct"
85 gdb_test "complete ptype enum some_" "ptype enum some_enum"
86 gdb_test "complete ptype union some_" "ptype union some_union"
89 gdb_test "complete set gnutarget aut" "set gnutarget auto"
92 gdb_test "complete set cp-abi aut" "set cp-abi auto"
94 # Test that completion of commands 'target FOO' works well.
95 set targets [list "core" "tfile" "exec"]
97 # Test that completion of command 'target ctf' if GDB supports ctf
99 gdb_test_multiple "target ctf" "" {
100 -re "Undefined target command: \"ctf\"\. Try \"help target\"\.\r\n$gdb_prompt $" {
102 -re "No CTF directory specified.*\r\n$gdb_prompt $" {
103 lappend targets "ctf"
107 # Test artifacts are put in different locations depending on test
108 # is a parallel run or not. Firstly check file exists, and then
109 # do the test on file completion.
111 foreach dir1 [ list "./gdb.base" "./outputs/gdb.base/completion" ] {
112 if { [remote_file host exists ${dir1}/completion]
113 && [remote_file host exists ${dir1}/completion0.o]
114 && [remote_file host exists ${dir1}/completion1.o] } {
115 foreach target_name ${targets} {
116 gdb_test "complete target ${target_name} ${dir1}/completion" \
117 "target ${target_name} ${dir1}/completion.*${dir1}/completion0\\.o.*${dir1}/completion1\\.o.*" \
118 "complete target ${target_name}"
125 # "set foo unlimited" completion.
128 # A var_uinteger command.
129 gdb_test "complete set height " "set height unlimited"
130 gdb_test "complete set height u" "set height unlimited"
132 # A var_integer command.
133 gdb_test "complete set listsize " "set listsize unlimited"
134 gdb_test "complete set listsize unl" "set listsize unlimited"
136 # A var_zuinteger_unlimited command.
137 gdb_test "complete set trace-buffer-size " "set trace-buffer-size unlimited"
138 gdb_test "complete set trace-buffer-size unl" "set trace-buffer-size unlimited"
140 # Test "info registers" completion: First determine this
141 # architecture's registers and reggroups...
143 set regs_output [capture_command_output "mt print registers" \
144 ".*Name.*Nr.*Rel.*Offset.*Size.*Type.\[^\n\]*\n"]
145 append regs_output "\n"
146 append regs_output [capture_command_output "mt print reggroups" \
147 ".*Group.*Type\[^\n]*\n"]
148 append regs_output "\n"
149 append regs_output [capture_command_output "mt print user-registers" \
150 ".*Name.*Nr\[^\n]*\n"]
152 foreach {- reg} [regexp -all -inline -line {^\s+(\w+)} $regs_output] {
153 lappend all_regs $reg
156 set all_regs [join [lsort -unique $all_regs]]
158 # ... and then compare them to the completion of "info registers".
160 set regs_output [capture_command_output "complete info registers " ""]
161 set completed_regs {}
162 foreach {-> reg} [regexp -all -inline -line {^info registers (\w+\S*)} $regs_output] {
163 lappend completed_regs $reg
165 set completed_regs [join [lsort $completed_regs]]
166 gdb_assert {{$all_regs eq $completed_regs}} "complete 'info registers '"
168 # Tests below are about tab-completion, which doesn't work if readline
169 # library isn't used. Check it first.
171 if { ![readline_is_used] } {
175 set test "complete 'hfgfh'"
177 gdb_test_multiple "" "$test" {
178 -re "^hfgfh\\\x07$" {
180 gdb_test_multiple "" $test {
181 -re "Undefined command: \"hfgfh\"\\. Try \"help\"\\..*$gdb_prompt $" {
190 set test "complete 'show output'"
191 send_gdb "show output\t"
192 gdb_test_multiple "" "$test" {
193 -re "^show output-radix $" {
195 gdb_test_multiple "" "$test" {
196 -re "Default output radix for printing of values is 10\\..*$gdb_prompt $" {
203 set test "complete 'show output-'"
204 send_gdb "show output-\t"
205 gdb_test_multiple "" "$test" {
206 -re "^show output-radix $" {
208 gdb_test_multiple "" "$test" {
209 -re "Default output radix for printing of values is 10\\..*$gdb_prompt $" {
216 set test "complete 'p'"
218 gdb_test_multiple "" "$test" {
221 gdb_test_multiple "" "$test" {
222 -re "The history is empty\\..*$gdb_prompt $" {
229 set test "complete 'p '"
231 gdb_test_multiple "" "$test" {
234 gdb_test_multiple "" "$test" {
235 -re "The history is empty\\..*$gdb_prompt $" {
242 set test "complete 'info t foo'"
243 send_gdb "info t foo\t"
244 gdb_test_multiple "" "$test" {
245 -re "^info t foo\\\x07$" {
247 gdb_test_multiple "" "$test" {
248 -re "Ambiguous info command \"t foo\": target, tasks, terminal, threads, tp, tracepoints, tvariables, (type-printers, )?types\\..*$gdb_prompt $" {
255 set test "complete 'info t'"
257 gdb_test_multiple "" "$test" {
258 -re "^info t\\\x07$" {
260 gdb_test_multiple "" "$test" {
261 -re "Ambiguous info command \"t\": target, tasks, terminal, threads, tp, tracepoints, tvariables, (type-printers, )?types\\..*$gdb_prompt $" {
268 set test "complete 'info t '"
270 gdb_test_multiple "" "$test" {
271 -re "^info t \\\x07$" {
273 gdb_test_multiple "" "$test" {
274 -re "Ambiguous info command \"t \": target, tasks, terminal, threads, tp, tracepoints, tvariables, (type-printers, )?types\\..*$gdb_prompt $" {
281 set test "complete 'info asdfgh'"
282 send_gdb "info asdfgh\t"
283 gdb_test_multiple "" "$test" {
284 -re "^info asdfgh\\\x07$" {
286 gdb_test_multiple "" "$test" {
287 -re "Undefined info command: \"asdfgh\". Try \"help info\"\\..*$gdb_prompt $" {
294 set test "complete 'info asdfgh '"
295 send_gdb "info asdfgh \t"
296 gdb_test_multiple "" "$test" {
297 -re "^info asdfgh \\\x07$" {
299 gdb_test_multiple "" "$test" {
300 -re "Undefined info command: \"asdfgh \". Try \"help info\"\\..*$gdb_prompt $" {
307 set test "complete 'info'"
309 gdb_test_multiple "" "$test" {
312 gdb_test_multiple "" "$test" {
313 -re "\"info\" must be followed by the name of an info command\\.\r\nList of info subcommands.*$gdb_prompt $" {
320 set test "complete 'info '"
322 gdb_test_multiple "" "$test" {
323 -re "^info \\\x07$" {
325 gdb_test_multiple "" "$test" {
326 -re "\"info\" must be followed by the name of an info command\\.\r\nList of info subcommands:\r\n\r\n.*$gdb_prompt $" {
333 set test "complete (2) 'info '"
335 gdb_test_multiple "" "$test" {
336 -re "^info \\\x07$" {
338 gdb_test_multiple "" "$test" {
339 -re "address.*types.*$gdb_prompt " {
341 gdb_test_multiple "" "$test" {
342 -re "\"info\".*unambiguous\\..*$gdb_prompt $" {
351 set test "complete 'help info wat'"
352 send_gdb "help info wat\t"
353 gdb_test_multiple "" "$test" {
354 -re "^help info watchpoints $" {
356 gdb_test_multiple "" "$test" {
357 -re "Status of specified watchpoints.*\r\n.*$gdb_prompt $" {
362 -re "^help info wat\\\x07$" {
367 set test "complete 'p \"break1'"
368 send_gdb "p \"break1\t"
369 gdb_test_multiple "" "$test" {
370 -re "^p \"break1\\\x07$" {
372 gdb_test_multiple "" "$test" {}
374 -re "^p \"break1\\.c\"$" {
376 gdb_test_multiple "" "$test" {
377 -re "$gdb_prompt $" {
385 set test "complete 'p \"break1.'"
386 send_gdb "p \"break1.\t"
387 gdb_test_multiple "" "$test" {
388 -re "^p \"break1\\.\\\x07$" {
390 gdb_test_multiple "" "$test" {}
392 -re "^p \"break1\\.c\"$" {
394 gdb_test_multiple "" "$test" {
395 -re "$gdb_prompt $" {
400 -re "^p \"break1\\..*$" {
402 gdb_test_multiple "" "$test" {}
406 set test "complete 'p 'arg'"
408 gdb_test_multiple "" "$test" {
409 -re "^p 'arg\\\x07$" {
411 gdb_test_multiple "" "$test" {
412 -re "(Invalid character constant\\.|Unmatched single quote\\.).*$gdb_prompt $" {
419 set test "complete (2) 'p 'arg'"
421 gdb_test_multiple "" "$test" {
422 -re "^p 'arg\\\x07$" {
424 gdb_test_multiple "" "$test" {
425 -re "argv.*$gdb_prompt " {
427 gdb_test_multiple "" "$test" {
428 -re "(Invalid character constant\\.|Unmatched single quote\\.).*$gdb_prompt $" {
433 -re "(There are $decimal possibilities\\. Do you really\r\nwish to see them all.|Display all $decimal possibilities.) \\(y or n\\)$" {
435 gdb_test_multiple "" "$test" {
436 -re "\\(gdb\\) p 'arg$" {
438 gdb_test_multiple "" "$test" {
439 -re "(Invalid character constant\\.|Unmatched single quote\\.).*$gdb_prompt $" {
450 set test "complete 'handle signal'"
451 send_gdb "handle sigq\t"
452 gdb_test_multiple "" "$test" {
453 -re "^handle sigq
\b\b\b\bSIGQUIT $" {
455 gdb_test_multiple "" "$test" {
456 -re "SIGQUIT.*Quit.*$gdb_prompt $" {
463 set test "complete 'handle keyword'"
464 send_gdb "handle nos\t"
465 gdb_test_multiple "" "$test" {
466 -re "^handle nostop $" {
468 gdb_test_multiple "" "$test" {
469 -re "$gdb_prompt $" {
476 set test "complete help aliases"
477 send_gdb "help user-define\t"
478 gdb_test_multiple "" "$test" {
479 -re "^help user-defined $" {
481 gdb_test_multiple "" "$test" {
482 -re "$gdb_prompt $" {
490 # These tests used to try completing the shorter "p b-a".
491 # Unfortunately, on some systems, there are .o files in system
492 # libraries which declare static variables named `b'. Of course,
493 # those variables aren't really in scope, as far as the compiler is
494 # concerned. But GDB deliberately tries to be more liberal: if you
495 # enter an identifier that doesn't have any binding in scope, GDB will
496 # search all the program's compilation units for a static variable of
499 # This behavior can help avoid a lot of pedantry, so it's usually a
500 # good thing. But in this test case, it causes GDB to print the value
501 # of some random variable, instead of giving us the "No symbol..."
502 # error we were expecting.
504 # For example, on S/390 linux, the file s_atan.c in libm.a declares a
505 # `b', which is a structure containing an int and a float, so GDB says
506 # ``Argument to arithmetic operation not a number or boolean'' instead
507 # of ``No symbol ...''.
509 # So, I'm hoping that there is no system with a static library variable named
510 # `no_var_by_this_name'.
512 set test "complete 'p no_var_named_this-arg'"
513 send_gdb "p no_var_named_this-arg\t"
514 gdb_test_multiple "" "$test" {
515 -re "^p no_var_named_this-arg\\\x07$" {
517 gdb_test_multiple "" "$test" {
518 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
525 set test "complete (2) 'p no_var_named_this-arg'"
526 send_gdb "p no_var_named_this-arg\t"
527 gdb_test_multiple "" "$test" {
528 -re "^p no_var_named_this-arg\\\x07$" {
530 gdb_test_multiple "" "$test" {
531 -re "argv.*$gdb_prompt " {
533 gdb_test_multiple "" "$test" {
534 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
539 -re "(There are $decimal possibilities\\. Do you really\r\nwish to see them all.|Display all $decimal possibilities.) \\(y or n\\)$" {
545 pass "$test (eat prompt)"
548 fail "(timeout) $test (eat prompt)"
552 gdb_test_multiple "" "$test" {
553 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
562 set test "complete (2) 'p no_var_named_this-'"
563 send_gdb "p no_var_named_this-\t"
564 gdb_test_multiple "" "$test" {
565 -re "^p no_var_named_this-\\\x07$" {
567 gdb_test_multiple "" "$test" {
568 -re "(There are $decimal possibilities\\. Do you really\r\nwish to see them all.|Display all $decimal possibilities.) \\(y or n\\)$" {
574 pass "$test (eat prompt)"
577 fail "(timeout) $test (eat prompt)"
581 gdb_test_multiple "" "$test" {
582 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
587 -re "argv.*$gdb_prompt $" {
589 gdb_test_multiple "" "$test" {
590 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
599 set test "complete 'p values\[0\].a'"
600 send_gdb "p values\[0\].a\t"
601 gdb_test_multiple "" "$test" {
602 -re "^p values.0..a_field $" {
604 gdb_test_multiple "" "$test" {
605 -re " = 0.*$gdb_prompt $" {
612 set test "complete 'p values\[0\] . a'"
613 send_gdb "p values\[0\] . a\t"
614 gdb_test_multiple "" "$test" {
615 -re "^p values.0. . a_field $" {
617 gdb_test_multiple "" "$test" {
618 -re " = 0.*$gdb_prompt $" {
625 set test "complete 'p &values\[0\] -> a'"
626 send_gdb "p &values\[0\] -> a\t"
627 gdb_test_multiple "" "$test" {
628 -re "^p &values.0. -> a_field $" {
630 gdb_test_multiple "" "$test" {
631 -re " = .*0x\[0-9a-fA-F\]*.*$gdb_prompt $" {
638 gdb_test "complete p &values\[0\]->z" \
639 "p &values.0.->z_field" \
640 "completion of field in anonymous union"
642 gdb_test "complete ptype &values\[0\]->z" \
643 "ptype &values.0.->z_field" \
644 "ptype completion of field in anonymous union"
646 gdb_test "complete whatis &values\[0\]->z" \
647 "whatis &values.0.->z_field" \
648 "whatis completion of field in anonymous union"
650 # The following tests used to simply try to complete `${objdir}/file',
651 # and so on. The problem is that ${objdir} can be very long; the
652 # completed filename may be more than eighty characters wide. When
653 # this happens, readline tries to manage things, producing output that
654 # may make sense on the screen, but is rather hard for our script to
657 # In the case that motivated this change, the (gdb) prompt occupied
658 # the leftmost six columns, and `${objdir}/' was seventy-four
659 # characters long --- eighty in all. After printing the slash,
660 # readline emitted a space, a carriage return, and then `Makefile'
661 # (the tab character being received as input after `Make'.
663 # Basically, you have to let readline do whatever it's going to do to
664 # make the screen look right. If it happens to use a different
665 # strategy on Tuesdays to get the cursor in the right place, that's
666 # not something the testsuite should care about.
668 # So, we avoid long lines. We `cd' to ${objdir} first, and then do
669 # the completion relative to the current directory.
671 # ${srcdir} may be a relative path. We want to make sure we end up
672 # in the right directory - so make sure we know where it is.
678 # If the directory name contains a '+' we must escape it, adding a backslash.
679 # If not, the test below will fail because it will interpret the '+' as a
680 # regexp operator. We use string_to_regexp for this purpose.
682 gdb_test "cd ${fullsrcdir}" \
683 "Working directory [string_to_regexp ${fullsrcdir}].*" \
687 # GDB used to fail adding / on directories, on the first try only.
688 set uniquedir ../testsuite/gdb.base/comp-dir
689 set escapeduniquedir [string_to_regexp ${uniquedir}]
691 set uniquesub ${uniquesu}r
692 set escapeuniquesub [string_to_regexp ${uniquesub}]
693 send_gdb "dir ${uniquedir}\t"
695 -re "${escapeduniquedir}/" {
696 pass "directory completion"
697 send_gdb "${uniquesu}\t"
699 -re "${escapeduniquedir} $" {
700 fail "directory completion (old gdb bug)"
701 send_gdb "\b/${uniquesu}\t"
704 fail "directory completion (timeout)"
705 send_gdb "\ndir ${uniquedir}/${uniquesu}\t"
710 -re "${escapeuniquesub}/$" {
711 pass "directory completion 2"
714 fail "directory completion 2"
718 # Empty COMMAND sends no newline while " " sends the newline we need.
719 gdb_test " " "Source directories searched: .*" "glob remaining of directory test"
721 gdb_test "complete file ./gdb.base/compl" \
722 "file ./gdb.base/completion\\.exp.*" \
723 "complete-command 'file ./gdb.base/compl'"
725 set test "complete 'file ./gdb.base/completi'"
726 send_gdb "file ./gdb.base/completi\t"
727 gdb_test_multiple "" "$test" {
728 -re "^file ./gdb.base/completion\\.exp $" {
730 # Ignore the exact error message.
731 gdb_test_multiple "" "complete 'file ./gdb.base/completi'" {
732 -re "\r\nA program is being debugged already\\.\[\r\n\]+Are you sure you want to change the file\\? \\(y or n\\) $" {
736 -re "$gdb_prompt $" {
743 set test "complete 'info func marke'"
744 send_gdb "info func marke\t"
745 gdb_test_multiple "" "$test" {
746 -re "^info func marke.*r$" {
748 gdb_test_multiple "" "$test" {
749 -re "marker1.*$gdb_prompt " {
751 gdb_test_multiple "" "$test" {
752 -re "All functions matching regular expression \"marker\":.*File.*break1.c:.*\tint marker1\\((void|)\\);\r\n.*:\tint marker2\\(int\\).*marker3\\(char.*char.*\\).*marker4\\(long( int)?\\);.*$gdb_prompt $" {
762 set test "complete 'set follow-fork-mode'"
763 send_gdb "set follow-fork-mode \t\t"
764 gdb_test_multiple "" "$test" {
765 -re "child.*parent.*$gdb_prompt " {
767 gdb_test_multiple "" "$test" {
768 -re "Requires an argument.*child.*parent.*$gdb_prompt $" {
771 -re "Ambiguous item \"\"\\..*$gdb_prompt $" {
779 # Tests for the location completer
782 # Turn off pending breakpoint support so that we don't get queried
784 gdb_test_no_output "set breakpoint pending off"
786 set subsrc [string range $srcfile 0 [expr {[string length $srcfile] - 3}]]
787 set test "tab complete break $subsrc"
788 send_gdb "break $subsrc\t\t"
789 gdb_test_multiple "" $test {
790 -re "break\.c.*break1\.c.*$gdb_prompt " {
792 gdb_test_multiple "" $test {
793 -re "malformed linespec error: unexpected end of input\r\n$gdb_prompt " {
796 -re "$gdb_prompt p$" {
802 -re "$gdb_prompt p$" {
807 gdb_test "complete break $subsrc" "break\.c.*break1\.c"
809 set test "tab complete break need"
810 send_gdb "break need\t"
811 gdb_test_multiple "" $test {
812 -re "break need_malloc " {
814 gdb_test_multiple "" $test {
815 -re ".*Breakpoint.*at .*/$srcfile, line .*$gdb_prompt " {
817 gdb_test_no_output "delete breakpoint \$bpnum" \
818 "delete breakpoint for $test"
820 -re "$gdb_prompt p$" {
825 -re "$gdb_prompt p$" {
830 gdb_test "complete break need" "need_malloc"
833 # Enabling max-completions is necessary to trigger the bug.
834 gdb_test_no_output "set max-completions 10"
835 set test "tab complete break $srcfile:ma"
836 send_gdb "break $srcfile:ma\t"
837 gdb_test_multiple "" $test {
838 -re "break $srcfile:main " {
840 gdb_test_multiple "" $test {
841 -re ".*Breakpoint.*at .*/$srcfile, line .*$gdb_prompt " {
843 gdb_test_no_output "delete breakpoint \$bpnum" \
844 "delete breakpoint for $test"
846 -re "$gdb_prompt p$" {
851 -re "$gdb_prompt p$" {
856 gdb_test "complete break $srcfile:ma" "break\.c:main"
858 # End of gdb/17960 testing.
861 # Completion limiting.
864 gdb_test_no_output "set max-completions 5"
866 proc ignore_and_resync {cmd result test} {
869 gdb_test_multiple "" "$test" {
871 # Complete the command and ignore the output
872 # to resync gdb for the next test.
874 gdb_test_multiple "" "$test" {
875 -re "$gdb_prompt $" {
883 proc test_tab_complete {cmd test} {
887 gdb_test_multiple "" "$test" {
888 -re "^${cmd}\\\x07$" {
890 gdb_test_multiple "" "$test" {
891 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt " {
892 ignore_and_resync $cmd pass $test
895 ignore_and_resync $cmd fail $test
902 test_tab_complete "p" \
903 "command-name completion limiting using tab character"
905 set test "command-name completion limiting using complete command"
906 send_gdb "complete p\n"
907 gdb_test_multiple "" "$test" {
908 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt $" {
913 gdb_test_no_output "set max-completions 3"
915 test_tab_complete "p marker" \
916 "symbol-name completion limiting using tab character"
918 set test "symbol-name completion limiting using complete command"
919 send_gdb "complete p mark\n"
920 gdb_test_multiple "" "$test" {
921 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt $" {