# Copyright 2003-2024 Free Software Foundation, Inc.

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

# This is a test for the gdb invocation option --args.

# Skip test if target does not support argument passing.
require {!target_info exists noargs}

# This test requires starting new inferior processes, skip it if the target
# board is a stub.
require !use_gdb_stub

standard_testfile

if {[build_executable $testfile.exp $testfile $srcfile] == -1} {
    untested "failed to compile"
    return -1
}

# NAME is the name to use for the tests and ARGLIST is the list of
# arguments that are passed to GDB when it is started.

proc args_test { name arglist } {
    save_vars { ::GDBFLAGS } {
	set ::GDBFLAGS "$::GDBFLAGS --args $::binfile $arglist"

	clean_restart $::binfile

	runto_main
	gdb_breakpoint [gdb_get_line_number "set breakpoint here"]
	gdb_continue_to_breakpoint "breakpoint for $name"

	set expected_len [expr 1 + [llength $arglist]]
	gdb_test "print argc" "\\\$$::decimal = $expected_len" "argc for $name"

	set i 1
	foreach arg $arglist {
	    if { $arg eq "\n" } {
		set arg {\\n}
	    }
	    gdb_test "print argv\[$i\]" "\\\$$::decimal = $::hex \"$arg\"" \
		"argv\[$i\] for $name"
	    set i [expr $i + 1]
	}
    }
}

# Test that the --args are processed correctly.

args_test basic {{1} {3}}

# Test that the --args are processed correctly even if one of them is
# empty.

args_test "one empty" {{1} {} {3}}

# Try with 2 empty args.

args_test "two empty" {{1} {} {} 3}

# Try with arguments containing literal single quotes.

args_test "one empty with single quotes" {{1} {''} {3}}

args_test "two empty with single quotes" {{1} {''} {''} {3}}

# Try with arguments containing literal newlines.

args_test "one newline" {{1} "\n" {3}}

args_test "two newlines" {{1} "\n" "\n" {3}}