1 # Copyright 1998-2015 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 $testfile.exp $testfile \
60 [list $srcfile $srcfile2] {debug nowarnings}]} {
61 untested $testfile.exp
65 if ![runto_main] then {
66 perror "tests suppressed"
70 gdb_test_no_output "set max-completions unlimited"
72 gdb_test_no_output "complete print values\[0\].x." \
73 "field completion with invalid field"
75 # If there is a non-deprecated completion, it should be returned.
76 gdb_test "complete sav" "save" "test non-deprecated completion"
77 # If there is only a deprecated completion, then it should be returned.
78 gdb_test "complete save-t" "save-tracepoints" "test deprecated completion"
82 # Tag name completion.
85 gdb_test "complete ptype struct some_" "ptype struct some_struct"
86 gdb_test "complete ptype enum some_" "ptype enum some_enum"
87 gdb_test "complete ptype union some_" "ptype union some_union"
90 gdb_test "complete set gnutarget aut" "set gnutarget auto"
93 gdb_test "complete set cp-abi aut" "set cp-abi auto"
95 # Test that completion of commands 'target FOO' works well.
96 set targets [list "core" "tfile" "exec"]
98 # Test that completion of command 'target ctf' if GDB supports ctf
100 gdb_test_multiple "target ctf" "" {
101 -re "Undefined target command: \"ctf\"\. Try \"help target\"\.\r\n$gdb_prompt $" {
103 -re "No CTF directory specified.*\r\n$gdb_prompt $" {
104 lappend targets "ctf"
108 # Test artifacts are put in different locations depending on test
109 # is a parallel run or not. Firstly check file exists, and then
110 # do the test on file completion.
112 foreach dir1 [ list "./gdb.base" "./outputs/gdb.base/completion" ] {
113 if { [remote_file host exists ${dir1}/completion]
114 && [remote_file host exists ${dir1}/completion0.o]
115 && [remote_file host exists ${dir1}/completion1.o] } {
116 foreach target_name ${targets} {
117 gdb_test "complete target ${target_name} ${dir1}/completion" \
118 "target ${target_name} ${dir1}/completion.*${dir1}/completion0\\.o.*${dir1}/completion1\\.o.*" \
119 "complete target ${target_name}"
126 # "set foo unlimited" completion.
129 # A var_uinteger command.
130 gdb_test "complete set height " "set height unlimited"
131 gdb_test "complete set height u" "set height unlimited"
133 # A var_integer command.
134 gdb_test "complete set listsize " "set listsize unlimited"
135 gdb_test "complete set listsize unl" "set listsize unlimited"
137 # A var_zuinteger_unlimited command.
138 gdb_test "complete set trace-buffer-size " "set trace-buffer-size unlimited"
139 gdb_test "complete set trace-buffer-size unl" "set trace-buffer-size unlimited"
141 # Test "info registers" completion: First determine this
142 # architecture's registers and reggroups...
144 set regs_output [capture_command_output "mt print registers" \
145 ".*Name.*Nr.*Rel.*Offset.*Size.*Type.\[^\n\]*\n"]
146 append regs_output "\n"
147 append regs_output [capture_command_output "mt print reggroups" \
148 ".*Group.*Type\[^\n]*\n"]
149 append regs_output "\n"
150 append regs_output [capture_command_output "mt print user-registers" \
151 ".*Name.*Nr\[^\n]*\n"]
153 foreach {- reg} [regexp -all -inline -line {^\s+(\w+)} $regs_output] {
154 lappend all_regs $reg
157 set all_regs [join [lsort -unique $all_regs]]
159 # ... and then compare them to the completion of "info registers".
161 set regs_output [capture_command_output "complete info registers " ""]
162 set completed_regs {}
163 foreach {-> reg} [regexp -all -inline -line {^info registers (\w+\S*)} $regs_output] {
164 lappend completed_regs $reg
166 set completed_regs [join [lsort $completed_regs]]
167 gdb_assert {{$all_regs eq $completed_regs}} "complete 'info registers '"
169 # Tests below are about tab-completion, which doesn't work if readline
170 # library isn't used. Check it first.
172 if { ![readline_is_used] } {
176 set test "complete 'hfgfh'"
178 gdb_test_multiple "" "$test" {
179 -re "^hfgfh\\\x07$" {
181 gdb_test_multiple "" $test {
182 -re "Undefined command: \"hfgfh\"\\. Try \"help\"\\..*$gdb_prompt $" {
191 set test "complete 'show output'"
192 send_gdb "show output\t"
193 gdb_test_multiple "" "$test" {
194 -re "^show output-radix $" {
196 gdb_test_multiple "" "$test" {
197 -re "Default output radix for printing of values is 10\\..*$gdb_prompt $" {
204 set test "complete 'show output-'"
205 send_gdb "show output-\t"
206 gdb_test_multiple "" "$test" {
207 -re "^show output-radix $" {
209 gdb_test_multiple "" "$test" {
210 -re "Default output radix for printing of values is 10\\..*$gdb_prompt $" {
217 set test "complete 'p'"
219 gdb_test_multiple "" "$test" {
222 gdb_test_multiple "" "$test" {
223 -re "The history is empty\\..*$gdb_prompt $" {
230 set test "complete 'p '"
232 gdb_test_multiple "" "$test" {
235 gdb_test_multiple "" "$test" {
236 -re "The history is empty\\..*$gdb_prompt $" {
243 set test "complete 'info t foo'"
244 send_gdb "info t foo\t"
245 gdb_test_multiple "" "$test" {
246 -re "^info t foo\\\x07$" {
248 gdb_test_multiple "" "$test" {
249 -re "Ambiguous info command \"t foo\": target, tasks, terminal, threads, tp, tracepoints, tvariables, (type-printers, )?types\\..*$gdb_prompt $" {
256 set test "complete 'info t'"
258 gdb_test_multiple "" "$test" {
259 -re "^info t\\\x07$" {
261 gdb_test_multiple "" "$test" {
262 -re "Ambiguous info command \"t\": target, tasks, terminal, threads, tp, tracepoints, tvariables, (type-printers, )?types\\..*$gdb_prompt $" {
269 set test "complete 'info t '"
271 gdb_test_multiple "" "$test" {
272 -re "^info t \\\x07$" {
274 gdb_test_multiple "" "$test" {
275 -re "Ambiguous info command \"t \": target, tasks, terminal, threads, tp, tracepoints, tvariables, (type-printers, )?types\\..*$gdb_prompt $" {
282 set test "complete 'info asdfgh'"
283 send_gdb "info asdfgh\t"
284 gdb_test_multiple "" "$test" {
285 -re "^info asdfgh\\\x07$" {
287 gdb_test_multiple "" "$test" {
288 -re "Undefined info command: \"asdfgh\". Try \"help info\"\\..*$gdb_prompt $" {
295 set test "complete 'info asdfgh '"
296 send_gdb "info asdfgh \t"
297 gdb_test_multiple "" "$test" {
298 -re "^info asdfgh \\\x07$" {
300 gdb_test_multiple "" "$test" {
301 -re "Undefined info command: \"asdfgh \". Try \"help info\"\\..*$gdb_prompt $" {
308 set test "complete 'info'"
310 gdb_test_multiple "" "$test" {
313 gdb_test_multiple "" "$test" {
314 -re "\"info\" must be followed by the name of an info command\\.\r\nList of info subcommands.*$gdb_prompt $" {
321 set test "complete 'info '"
323 gdb_test_multiple "" "$test" {
324 -re "^info \\\x07$" {
326 gdb_test_multiple "" "$test" {
327 -re "\"info\" must be followed by the name of an info command\\.\r\nList of info subcommands:\r\n\r\n.*$gdb_prompt $" {
334 set test "complete (2) 'info '"
336 gdb_test_multiple "" "$test" {
337 -re "^info \\\x07$" {
339 gdb_test_multiple "" "$test" {
340 -re "address.*types.*$gdb_prompt " {
342 gdb_test_multiple "" "$test" {
343 -re "\"info\".*unambiguous\\..*$gdb_prompt $" {
352 set test "complete 'help info wat'"
353 send_gdb "help info wat\t"
354 gdb_test_multiple "" "$test" {
355 -re "^help info watchpoints $" {
357 gdb_test_multiple "" "$test" {
358 -re "Status of specified watchpoints.*\r\n.*$gdb_prompt $" {
363 -re "^help info wat\\\x07$" {
368 set test "complete 'p \"break1'"
369 send_gdb "p \"break1\t"
370 gdb_test_multiple "" "$test" {
371 -re "^p \"break1\\\x07$" {
373 gdb_test_multiple "" "$test" {}
375 -re "^p \"break1\\.c\"$" {
377 gdb_test_multiple "" "$test" {
378 -re "$gdb_prompt $" {
386 set test "complete 'p \"break1.'"
387 send_gdb "p \"break1.\t"
388 gdb_test_multiple "" "$test" {
389 -re "^p \"break1\\.\\\x07$" {
391 gdb_test_multiple "" "$test" {}
393 -re "^p \"break1\\.c\"$" {
395 gdb_test_multiple "" "$test" {
396 -re "$gdb_prompt $" {
401 -re "^p \"break1\\..*$" {
403 gdb_test_multiple "" "$test" {}
407 set test "complete 'p 'arg'"
409 gdb_test_multiple "" "$test" {
410 -re "^p 'arg\\\x07$" {
412 gdb_test_multiple "" "$test" {
413 -re "(Invalid character constant\\.|Unmatched single quote\\.).*$gdb_prompt $" {
420 set test "complete (2) 'p 'arg'"
422 gdb_test_multiple "" "$test" {
423 -re "^p 'arg\\\x07$" {
425 gdb_test_multiple "" "$test" {
426 -re "argv.*$gdb_prompt " {
428 gdb_test_multiple "" "$test" {
429 -re "(Invalid character constant\\.|Unmatched single quote\\.).*$gdb_prompt $" {
434 -re "(There are $decimal possibilities\\. Do you really\r\nwish to see them all.|Display all $decimal possibilities.) \\(y or n\\)$" {
436 gdb_test_multiple "" "$test" {
437 -re "\\(gdb\\) p 'arg$" {
439 gdb_test_multiple "" "$test" {
440 -re "(Invalid character constant\\.|Unmatched single quote\\.).*$gdb_prompt $" {
451 set test "complete 'handle signal'"
452 send_gdb "handle sigq\t"
453 gdb_test_multiple "" "$test" {
454 -re "^handle sigq
\b\b\b\bSIGQUIT $" {
456 gdb_test_multiple "" "$test" {
457 -re "SIGQUIT.*Quit.*$gdb_prompt $" {
464 set test "complete 'handle keyword'"
465 send_gdb "handle nos\t"
466 gdb_test_multiple "" "$test" {
467 -re "^handle nostop $" {
469 gdb_test_multiple "" "$test" {
470 -re "$gdb_prompt $" {
477 set test "complete help aliases"
478 send_gdb "help user-define\t"
479 gdb_test_multiple "" "$test" {
480 -re "^help user-defined $" {
482 gdb_test_multiple "" "$test" {
483 -re "$gdb_prompt $" {
491 # These tests used to try completing the shorter "p b-a".
492 # Unfortunately, on some systems, there are .o files in system
493 # libraries which declare static variables named `b'. Of course,
494 # those variables aren't really in scope, as far as the compiler is
495 # concerned. But GDB deliberately tries to be more liberal: if you
496 # enter an identifier that doesn't have any binding in scope, GDB will
497 # search all the program's compilation units for a static variable of
500 # This behavior can help avoid a lot of pedantry, so it's usually a
501 # good thing. But in this test case, it causes GDB to print the value
502 # of some random variable, instead of giving us the "No symbol..."
503 # error we were expecting.
505 # For example, on S/390 linux, the file s_atan.c in libm.a declares a
506 # `b', which is a structure containing an int and a float, so GDB says
507 # ``Argument to arithmetic operation not a number or boolean'' instead
508 # of ``No symbol ...''.
510 # So, I'm hoping that there is no system with a static library variable named
511 # `no_var_by_this_name'.
513 set test "complete 'p no_var_named_this-arg'"
514 send_gdb "p no_var_named_this-arg\t"
515 gdb_test_multiple "" "$test" {
516 -re "^p no_var_named_this-arg\\\x07$" {
518 gdb_test_multiple "" "$test" {
519 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
526 set test "complete (2) 'p no_var_named_this-arg'"
527 send_gdb "p no_var_named_this-arg\t"
528 gdb_test_multiple "" "$test" {
529 -re "^p no_var_named_this-arg\\\x07$" {
531 gdb_test_multiple "" "$test" {
532 -re "argv.*$gdb_prompt " {
534 gdb_test_multiple "" "$test" {
535 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
540 -re "(There are $decimal possibilities\\. Do you really\r\nwish to see them all.|Display all $decimal possibilities.) \\(y or n\\)$" {
546 pass "$test (eat prompt)"
549 fail "(timeout) $test (eat prompt)"
553 gdb_test_multiple "" "$test" {
554 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
563 set test "complete (2) 'p no_var_named_this-'"
564 send_gdb "p no_var_named_this-\t"
565 gdb_test_multiple "" "$test" {
566 -re "^p no_var_named_this-\\\x07$" {
568 gdb_test_multiple "" "$test" {
569 -re "(There are $decimal possibilities\\. Do you really\r\nwish to see them all.|Display all $decimal possibilities.) \\(y or n\\)$" {
575 pass "$test (eat prompt)"
578 fail "(timeout) $test (eat prompt)"
582 gdb_test_multiple "" "$test" {
583 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
588 -re "argv.*$gdb_prompt $" {
590 gdb_test_multiple "" "$test" {
591 -re "No symbol \"no_var_named_this\" in current context\\..*$gdb_prompt $" {
600 set test "complete 'p values\[0\].a'"
601 send_gdb "p values\[0\].a\t"
602 gdb_test_multiple "" "$test" {
603 -re "^p values.0..a_field $" {
605 gdb_test_multiple "" "$test" {
606 -re " = 0.*$gdb_prompt $" {
613 set test "complete 'p values\[0\] . a'"
614 send_gdb "p values\[0\] . a\t"
615 gdb_test_multiple "" "$test" {
616 -re "^p values.0. . a_field $" {
618 gdb_test_multiple "" "$test" {
619 -re " = 0.*$gdb_prompt $" {
626 set test "complete 'p &values\[0\] -> a'"
627 send_gdb "p &values\[0\] -> a\t"
628 gdb_test_multiple "" "$test" {
629 -re "^p &values.0. -> a_field $" {
631 gdb_test_multiple "" "$test" {
632 -re " = .*0x\[0-9a-fA-F\]*.*$gdb_prompt $" {
639 gdb_test "complete p &values\[0\]->z" \
640 "p &values.0.->z_field" \
641 "completion of field in anonymous union"
643 gdb_test "complete ptype &values\[0\]->z" \
644 "ptype &values.0.->z_field" \
645 "ptype completion of field in anonymous union"
647 gdb_test "complete whatis &values\[0\]->z" \
648 "whatis &values.0.->z_field" \
649 "whatis completion of field in anonymous union"
651 # The following tests used to simply try to complete `${objdir}/file',
652 # and so on. The problem is that ${objdir} can be very long; the
653 # completed filename may be more than eighty characters wide. When
654 # this happens, readline tries to manage things, producing output that
655 # may make sense on the screen, but is rather hard for our script to
658 # In the case that motivated this change, the (gdb) prompt occupied
659 # the leftmost six columns, and `${objdir}/' was seventy-four
660 # characters long --- eighty in all. After printing the slash,
661 # readline emitted a space, a carriage return, and then `Makefile'
662 # (the tab character being received as input after `Make'.
664 # Basically, you have to let readline do whatever it's going to do to
665 # make the screen look right. If it happens to use a different
666 # strategy on Tuesdays to get the cursor in the right place, that's
667 # not something the testsuite should care about.
669 # So, we avoid long lines. We `cd' to ${objdir} first, and then do
670 # the completion relative to the current directory.
672 # ${srcdir} may be a relative path. We want to make sure we end up
673 # in the right directory - so make sure we know where it is.
679 # If the directory name contains a '+' we must escape it, adding a backslash.
680 # If not, the test below will fail because it will interpret the '+' as a
681 # regexp operator. We use string_to_regexp for this purpose.
683 gdb_test "cd ${fullsrcdir}" \
684 "Working directory [string_to_regexp ${fullsrcdir}].*" \
688 # GDB used to fail adding / on directories, on the first try only.
689 set uniquedir ../testsuite/gdb.base/comp-dir
690 set escapeduniquedir [string_to_regexp ${uniquedir}]
692 set uniquesub ${uniquesu}r
693 set escapeuniquesub [string_to_regexp ${uniquesub}]
694 send_gdb "dir ${uniquedir}\t"
696 -re "${escapeduniquedir}/" {
697 pass "directory completion"
698 send_gdb "${uniquesu}\t"
700 -re "${escapeduniquedir} $" {
701 fail "directory completion (old gdb bug)"
702 send_gdb "\b/${uniquesu}\t"
705 fail "directory completion (timeout)"
706 send_gdb "\ndir ${uniquedir}/${uniquesu}\t"
711 -re "${escapeuniquesub}/$" {
712 pass "directory completion 2"
715 fail "directory completion 2"
719 # Empty COMMAND sends no newline while " " sends the newline we need.
720 gdb_test " " "Source directories searched: .*" "Glob remaining of directory test"
722 gdb_test "complete file ./gdb.base/compl" \
723 "file ./gdb.base/completion\\.exp.*" \
724 "complete-command 'file ./gdb.base/compl'"
726 set test "complete 'file ./gdb.base/complet'"
727 send_gdb "file ./gdb.base/complet\t"
728 gdb_test_multiple "" "$test" {
729 -re "^file ./gdb.base/completion\\.exp $" {
731 # Ignore the exact error message.
732 gdb_test_multiple "" "complete 'file ./gdb.base/complet'" {
733 -re "\r\nA program is being debugged already\\.\[\r\n\]+Are you sure you want to change the file\\? \\(y or n\\) $" {
737 -re "$gdb_prompt $" {
744 set test "complete 'info func marke'"
745 send_gdb "info func marke\t"
746 gdb_test_multiple "" "$test" {
747 -re "^info func marke.*r$" {
749 gdb_test_multiple "" "$test" {
750 -re "marker1.*$gdb_prompt " {
752 gdb_test_multiple "" "$test" {
753 -re "All functions matching regular expression \"marker\":.*File.*break1.c:\r\nint marker1\\((void|)\\);\r\nint marker2\\(int\\).*marker3\\(char.*char.*\\).*marker4\\(long( int)?\\);.*$gdb_prompt $" {
763 set test "complete 'set follow-fork-mode'"
764 send_gdb "set follow-fork-mode \t\t"
765 gdb_test_multiple "" "$test" {
766 -re "child.*parent.*$gdb_prompt " {
768 gdb_test_multiple "" "$test" {
769 -re "Requires an argument.*child.*parent.*$gdb_prompt $" {
772 -re "Ambiguous item \"\"\\..*$gdb_prompt $" {
780 # Completion limiting.
783 gdb_test_no_output "set max-completions 5"
785 set test "command-name completion limiting using tab character"
787 gdb_test_multiple "" "$test" {
790 gdb_test_multiple "" "$test" {
791 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt p$" {
792 # Complete the command and ignore the output to resync
793 # gdb for the next test.
795 gdb_test_multiple "" "$test" {
796 -re "$gdb_prompt $" {
801 -re "$gdb_prompt p$" {
802 # Complete the command and ignore the output to resync
803 # gdb for the next test.
805 gdb_test_multiple "" "$test" {
806 -re "$gdb_prompt $" {
815 set test "command-name completion limiting using complete command"
816 send_gdb "complete p\n"
817 gdb_test_multiple "" "$test" {
818 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt $" {
823 gdb_test_no_output "set max-completions 3"
825 set test "symbol-name completion limiting using tab character"
826 send_gdb "p marker\t"
827 gdb_test_multiple "" "$test" {
828 -re "^p marker\\\x07$" {
830 gdb_test_multiple "" "$test" {
831 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt p marker$" {
832 # Complete the command and ignore the output to resync
833 # gdb for the next test.
835 gdb_test_multiple "" "$test" {
836 -re "$gdb_prompt $" {
841 -re "$gdb_prompt p marker$" {
842 # Complete the command and ignore the output to resync
843 # gdb for the next test.
845 gdb_test_multiple "" "$test" {
846 -re "$gdb_prompt $" {
855 set test "symbol-name completion limiting using complete command"
856 send_gdb "complete p mark\n"
857 gdb_test_multiple "" "$test" {
858 -re "List may be truncated, max-completions reached.*\r\n$gdb_prompt $" {