#   Copyright (C) 1999, 2000, 2002 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 2 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

# Please email any bugs, comments, and/or additions to this file to:
# bug-gdb@prep.ai.mit.edu

# Test essential Machine interface (MI) operations
#
# Verify that, using the MI, we can create, update, delete variables.
#


load_lib mi-support.exp
set MIFLAGS "-i=mi1"

gdb_exit
if [mi_gdb_start] {
    continue
}

set testfile "var-cmd"
set srcfile ${testfile}.c
set binfile ${objdir}/${subdir}/${testfile}
if  { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable {debug additional_flags=-DFAKEARGV}] != "" } {
    gdb_suppress_entire_file "Testcase compile failed, so all tests in this file will automatically fail."
}

mi_delete_breakpoints
mi_gdb_reinitialize_dir $srcdir/$subdir
mi_gdb_load ${binfile}

mi_gdb_test "200-break-insert do_block_tests" \
	"200\\^done,bkpt=\{number=\"1\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"do_block_tests\",file=\".*var-cmd.c\",line=\"154\",times=\"0\"\}" \
	"break-insert operation"

mi_run_cmd
# The running part has been checked already by mi_run_cmd
mi_get_bp_stopped "1" "\[01\]" "" "do_block_tests" "var-cmd.c" "154" "run to do_block_Tests"

# Test: c_variable-3.2
# Desc: create cb and foo
# APPLE LOCAL: [var-create] TYPECODE, DYNAMIC_TYPE, IN_SCOPE fields added.
mi_gdb_test "-var-create cb * cb" \
	"\\^done,name=\"cb\",numchild=\"0\",type=\"int\",typecode=\"INT\",dynamic_type=\"\",in_scope=\"true\"" \
	"create local variable cb"

# APPLE LOCAL: [var-create] Console error message is suppresed; only MI error is issued.
mi_gdb_test "-var-create foo * foo" \
	"\\^error,msg=\"mi_cmd_var_create: unable to create variable object\"" \
	"create local variable foo"

# step to "foo = 123;"
send_gdb "-exec-step\n"
gdb_expect {
  -re "\\^running\r\n${mi_gdb_prompt}" {
      mi_get_stopped "end-stepping-range" "\[01\]" "" "do_block_tests" "var-cmd.c" "158" "step at do_block_tests"
  }
  timeout {
      fail "step at do_block_tests (timeout)"
  }
}


# Be paranoid and assume 3.2 created foo
# APPLE LOCAL: [var-delete] Console error message is suppresed; only MI error is issued.
mi_gdb_test "-var-delete foo" \
	"\\^error,msg=\"Variable object not found\"" \
	"delete var foo"


# Test: c_variable-3.3
# Desc: create foo
# APPLE LOCAL: [var-create] TYPECODE, DYNAMIC_TYPE, IN_SCOPE fields added.
mi_gdb_test "-var-create foo * foo" \
	"\\^done,name=\"foo\",numchild=\"0\",type=\"int\",typecode=\"INT\",dynamic_type=\"\",in_scope=\"true\"" \
	"create local variable foo"

# step to "foo2 = 123;"
send_gdb "-exec-step\n"
gdb_expect {
  -re "\\^running\r\n${mi_gdb_prompt}" {
      mi_get_stopped "end-stepping-range" "\[01\]" "" "do_block_tests" "var-cmd.c" "161" "step at do_block_tests"
  }
  timeout {
      fail "step at do_block_tests (timeout)"
  }
}

# Test: c_variable-3.4
# Desc: check foo, cb changed
# APPLE LOCAL: [var-update] Changelist tuples are named by VAROBJ field.
mi_gdb_test "-var-update *" \
	"\\^done,changelist=\\\[varobj=\{name=\"foo\",in_scope=\"true\",type_changed=\"false\"\},varobj=\{name=\"cb\",in_scope=\"true\",type_changed=\"false\"\}\\\]" \
	"update all vars: cb foo changed"

# step to "foo = 321;"
send_gdb "-exec-step\n"
gdb_expect {
  -re "\\^running\r\n${mi_gdb_prompt}" {
      mi_get_stopped "end-stepping-range" "\[01\]" "" "do_block_tests" "var-cmd.c" "164" "step at do_block_tests"
  }
  timeout {
      fail "step at do_block_tests (timeout)"
  }
}

# Test: c_variable-3.5
# Desc: create inner block foo
# APPLE LOCAL: [var-create] TYPECODE, DYNAMIC_TYPE, IN_SCOPE fields added.
mi_gdb_test "-var-create inner_foo * foo" \
	"\\^done,name=\"inner_foo\",numchild=\"0\",type=\"int\",typecode=\"INT\",dynamic_type=\"\",in_scope=\"true\"" \
	"create local variable inner_foo"

# step to "foo2 = 0;"
send_gdb "-exec-step\n"
gdb_expect {
  -re "\\^running\r\n${mi_gdb_prompt}" {
      mi_get_stopped "end-stepping-range" "\[01\]" "" "do_block_tests" "var-cmd.c" "166" "step at do_block_tests"
  }
  timeout {
      fail "step at do_block_tests (timeout)"
  }
}

# Test: c_variable-3.6
# Desc: create foo2
# APPLE LOCAL: [var-create] TYPECODE, DYNAMIC_TYPE, IN_SCOPE fields added.
mi_gdb_test "-var-create foo2 * foo2" \
	"\\^done,name=\"foo2\",numchild=\"0\",type=\"int\",typecode=\"INT\",dynamic_type=\"\",in_scope=\"true\"" \
	"create local variable foo2"

# Test: c_variable-3.7
# Desc: check that outer foo in scope and inner foo out of scope
# Note: also a known gdb problem

# setup_xfail *-*-*
# APPLE LOCAL: Works for us.

# APPLE LOCAL: [var-update] Changelist tuples are named by VAROBJ field.
mi_gdb_test "-var-update inner_foo" \
	"\\^done,changelist=\\\[varobj=\{name=\"inner_foo\",in_scope=\"false\"\}\\\]" \
	"update inner_foo: should be out of scope: KNOWN PROBLEM"
# clear_xfail *-*-*

setup_xfail *-*-*
mi_gdb_test "-var-evaluate-expression inner_foo" \
	"\\^done,value=\{FIXME\}" \
	"evaluate inner_foo: should be out of scope: KNOWN PROBLEM"
clear_xfail *-*-*

# APPLE LOCAL: [var-update] CHANGELIST is a MI list, not a MI tuple.
mi_gdb_test "-var-update foo" \
	"\\^done,changelist=\\\[\\\]" \
	"update foo: did not change"

mi_gdb_test "-var-delete inner_foo" \
	"\\^done,ndeleted=\"1\"" \
	"delete var inner_foo"

# step to "foo = 0;"
send_gdb "-exec-step\n"
gdb_expect {
  -re "\\^running\r\n${mi_gdb_prompt}" {
      mi_get_stopped "end-stepping-range" "\[01\]" "" "do_block_tests" "var-cmd.c" "168" "step at do_block_tests"
  }
  timeout {
      fail "step at do_block_tests (timeout)"
  }
}

# Test: c_variable-3.8
# Desc: check that foo2 out of scope (known gdb problem)

# setup_xfail *-*-*
# APPLE LOCAL: Works for us.

# APPLE LOCAL: [var-update] Changelist tuples are named by VAROBJ field.
mi_gdb_test "-var-update foo2" \
	"\\^done,changelist=\\\[varobj=\{name=\"foo2\",in_scope=\"false\"\}\\\]" \
	"update foo2: should be out of scope: KNOWN PROBLEM"
# clear_xfail *-*-*

# step to "cb = 21;"
send_gdb "-exec-step\n"
gdb_expect {
  -re "\\^running\r\n${mi_gdb_prompt}" {
      mi_get_stopped "end-stepping-range" "\[01\]" "" "do_block_tests" "var-cmd.c" "171" "step at do_block_tests"
  }
  timeout {
      fail "step at do_block_tests (timeout)"
  }
}


# Test: c_variable-3.9
# Desc: check that only cb is in scope (known gdb problem)

# setup_xfail *-*-*
# APPLE LOCAL: Works for us.

# APPLE LOCAL: [var-update] Changelist tuples are named by VAROBJ field.
mi_gdb_test "-var-update foo2" \
	"\\^done,changelist=\\\[varobj=\{name=\"foo2\",in_scope=\"false\"\}\\\]" \
	"update foo2 should be out of scope"
# clear_xfail *-*-*

# setup_xfail *-*-*
# APPLE LOCAL: Works for us.

# APPLE LOCAL: [var-update] Changelist tuples are named by VAROBJ field.
mi_gdb_test "-var-update foo" \
	"\\^done,changelist=\\\[varobj=\{name=\"foo\",in_scope=\"false\"\}\\\]" \
	"update foo should be out of scope: KNOWN PROBLEM"
# clear_xfail *-*-*

# APPLE LOCAL: [var-update] CHANGELIST is a MI list, not a MI tuple.
mi_gdb_test "-var-update cb" \
	"\\^done,changelist=\\\[\\\]" \
	"update cb"

# Test: c_variable-3.10
# Desc: names of editable variables
#gdbtk_test c_variable-3.10 {names of editable variables} {
#  editable_variables
#} {{foo cb foo2} {}}

# Done with block tests
mi_gdb_test "-var-delete foo" \
	"\\^done,ndeleted=\"1\"" \
	"delete var foo"

mi_gdb_test "-var-delete foo2" \
	"\\^done,ndeleted=\"1\"" \
	"delete var foo2"

mi_gdb_test "-var-delete cb" \
	"\\^done,ndeleted=\"1\"" \
	"delete var cb"

mi_gdb_exit
return 0
