From 213fd9faf563ce5726ce66c8104cbaba44ba9c09 Mon Sep 17 00:00:00 2001
From: Pedro Alves <palves@redhat.com>
Date: Thu, 4 Jul 2019 16:45:23 +0100
Subject: [PATCH] Fix foreach_with_prefix regression

Fix a silly bug in commit a26c8de0ee93 ("Fix early return in
foreach_with_prefix").

That patch made foreach_with_prefix always return after the first
iteration, making ~10k tests disappear from test runs...

This fixes it, and as penance, adds a testcase that exercises all
kinds of different returns possible (ok, error, return, break,
continue).  I've written it with regular "foreach", and then switched
to foreach_with_prefix and made sure we get the same results.  I put
the testcase in a new gdb.testsuite/ subdir, since this is exercising
the testsuite harness bits.  We can move this elsewhere if people
prefer a different place, but I'm going ahead in order to unbreak the
testsuite ASAP.

gdb/testsuite/ChangeLog:
2019-07-04  Pedro Alves  <palves@redhat.com>

	* lib/gdb.exp (foreach_with_prefix): Don't return early if
	body returned ok(0), break(3) or continue(4).
	* gdb.testsuite/foreach_with_prefix.exp: New file.
---
 gdb/testsuite/ChangeLog                            |  6 ++
 .../gdb.testsuite/foreach_with_prefix.exp          | 98 ++++++++++++++++++++++
 gdb/testsuite/lib/gdb.exp                          |  4 +-
 3 files changed, 107 insertions(+), 1 deletion(-)
 create mode 100644 gdb/testsuite/gdb.testsuite/foreach_with_prefix.exp

diff --git a/gdb/testsuite/ChangeLog b/gdb/testsuite/ChangeLog
index 2ad89ac..7631cce 100644
--- a/gdb/testsuite/ChangeLog
+++ b/gdb/testsuite/ChangeLog
@@ -1,3 +1,9 @@
+2019-07-04  Pedro Alves  <palves@redhat.com>
+
+	* lib/gdb.exp (foreach_with_prefix): Don't return early if
+	body returned ok(0), break(3) or continue(4).
+	* gdb.testsuite/foreach_with_prefix.exp: New file.
+
 2019-07-04  Alan Hayward  <alan.hayward@arm.com>
 
 	* gdb.server/unittest.exp: Allow 0 unit tests to run.
diff --git a/gdb/testsuite/gdb.testsuite/foreach_with_prefix.exp b/gdb/testsuite/gdb.testsuite/foreach_with_prefix.exp
new file mode 100644
index 0000000..9cd4149
--- /dev/null
+++ b/gdb/testsuite/gdb.testsuite/foreach_with_prefix.exp
@@ -0,0 +1,98 @@
+# Copyright 2019 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/>.
+
+# Testsuite self-tests for foreach_with_prefix.
+
+# Check that SEQVAR and EXPECTED_SEQ hold the same sequence.
+proc check_sequence {seqvar expected_seq} {
+    verbose -log "\"$seqvar\" eq \"$expected_seq\"?"
+
+    set test "sequence matches"
+    if {$seqvar eq $expected_seq} {
+	pass $test
+    } else {
+	fail $test
+    }
+}
+
+# Test TCL_OK (0).
+with_test_prefix "ok" {
+    set seq ""
+    foreach_with_prefix var1 {0 1} {
+	foreach_with_prefix var2 {0 1} {
+	    lappend seq $var1 $var2
+	}
+    }
+
+    check_sequence $seq "0 0 0 1 1 0 1 1"
+}
+
+# Test TCL_ERROR (1).
+with_test_prefix "error" {
+    catch {
+	set seq ""
+	foreach_with_prefix var1 {0 1} {
+	    foreach_with_prefix var2 {0 1} {
+		lappend seq $var1 $var2
+		error $seq
+	    }
+	}
+	return "unreachable"
+    } seq
+
+    check_sequence $seq "0 0"
+}
+
+# Test TCL_RETURN (2).
+with_test_prefix "return" {
+    proc test_return {} {
+	set seq ""
+	foreach_with_prefix var1 {0 1} {
+	    foreach_with_prefix var2 {0 1} {
+		lappend seq $var1 $var2
+		return $seq
+	    }
+	}
+	return $seq
+    }
+
+    set seq [test_return]
+    check_sequence $seq "0 0"
+}
+
+# Test TCL_BREAK (3).
+with_test_prefix "break" {
+    set seq ""
+    foreach_with_prefix var1 {0 1} {
+	foreach_with_prefix var2 {0 1} {
+	    lappend seq $var1 $var2
+	    break
+	}
+    }
+
+    check_sequence $seq "0 0 1 0"
+}
+
+# Test TCL_CONTINUE (4).
+with_test_prefix "continue" {
+    set seq ""
+    foreach_with_prefix var1 {0 1} {
+	foreach_with_prefix var2 {0 1} {
+	    lappend seq $var1 $var2
+	    continue
+	}
+    }
+
+    check_sequence $seq "0 0 0 1 1 0 1 1"
+}
diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp
index 41f0ef5..49ec8b2 100644
--- a/gdb/testsuite/lib/gdb.exp
+++ b/gdb/testsuite/lib/gdb.exp
@@ -2031,7 +2031,9 @@ proc foreach_with_prefix {var list body} {
 	if {$code == 1} {
 	    global errorInfo errorCode
 	    return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
-	} else {
+	} elseif {$code == 3} {
+	    break
+	} elseif {$code == 2} {
 	    return -code $code $result
 	}
     }
-- 
2.7.4