+# Test the output of GDB_COMMAND matches the pattern obtained
+# by concatenating all elements of EXPECTED_LINES. This makes
+# it possible to split otherwise very long string into pieces.
+# If third argument is not empty, it's used as the name of the
+# test to be printed on pass/fail.
+proc help_test_raw { gdb_command expected_lines args } {
+ set message $gdb_command
+ if [llength $args]>0 then {
+ set message [lindex $args 0]
+ }
+ set expected_output [join $expected_lines ""]
+ gdb_test "${gdb_command}" "${expected_output}" $message
+}
+
+# Test the output of "help COMMNAD_CLASS". EXPECTED_INITIAL_LINES
+# are regular expressions that should match the beginning of output,
+# before the list of commands in that class. The presence of
+# command list and standard epilogue will be tested automatically.
+proc test_class_help { command_class expected_initial_lines args } {
+ set l_stock_body {
+ "List of commands\:.*\[\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\."
+ }
+ set l_entire_body [concat $expected_initial_lines $l_stock_body]
+
+ eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
+}
+
+# COMMAND_LIST should have either one element -- command to test, or
+# two elements -- abbreviated command to test, and full command the first
+# element is abbreviation of.
+# The command must be a prefix command. EXPECTED_INITIAL_LINES
+# are regular expressions that should match the beginning of output,
+# before the list of subcommands. The presence of
+# subcommand list and standard epilogue will be tested automatically.
+proc test_prefix_command_help { command_list expected_initial_lines args } {
+ set command [lindex $command_list 0]
+ if {[llength $command_list]>1} {
+ set full_command [lindex $command_list 1]
+ } else {
+ set full_command $command
+ }
+ # Use 'list' and not just {} because we want variables to
+ # be expanded in this list.
+ set l_stock_body [list\
+ "List of $full_command subcommands\:.*\[\r\n\]+"\
+ "Type \"help $full_command\" followed by $full_command subcommand 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\."]
+ set l_entire_body [concat $expected_initial_lines $l_stock_body]
+ if {[llength $args]>0} {
+ help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
+ } else {
+ help_test_raw "help ${command}" $l_entire_body
+ }
+}
+
+# Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
+# provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
+# to pass to untested, if something is wrong. OPTIONS are passed
+# to gdb_compile directly.
+proc build_executable { testname executable {sources ""} {options {debug}} } {
+
+ global objdir
+ global subdir
+ global srcdir
+ if {[llength $sources]==0} {
+ set sources ${executable}.c
+ }
+
+ set binfile ${objdir}/${subdir}/${executable}
+
+ set objects {}
+ for {set i 0} "\$i<[llength $sources]" {incr i} {
+ set s [lindex $sources $i]
+ if { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $options] != "" } {
+ untested $testname
+ return -1
+ }
+ lappend objects "${binfile}${i}.o"
+ }
+
+ if { [gdb_compile $objects "${binfile}" executable $options] != "" } {
+ untested $testname
+ return -1
+ }
+
+ if [get_compiler_info ${binfile}] {
+ return -1
+ }
+ return 0
+}
+
+# Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
+# the name of binary in ${objdir}/${subdir}.
+proc clean_restart { executable } {
+ global srcdir
+ global objdir
+ global subdir
+ set binfile ${objdir}/${subdir}/${executable}
+
+ gdb_exit
+ gdb_start
+ gdb_reinitialize_dir $srcdir/$subdir
+ gdb_load ${binfile}
+
+ if [target_info exists gdb_stub] {
+ gdb_step_for_stub;
+ }
+}
+
+# Prepares for testing, by calling build_executable, and then clean_restart.
+# Please refer to build_executable for parameter description.
+proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
+
+ if {[build_executable $testname $executable $sources $options] == -1} {
+ return -1
+ }
+ clean_restart $executable
+
+ return 0
+}