From e8c812b5006faa7f426bc40766aaf2069c7a474e Mon Sep 17 00:00:00 2001
From: Daniel Griscom <griscom@suitable.com>
Date: Sun, 12 May 2013 15:34:26 -0400
Subject: [PATCH] Added test cases and documentation for json_array_foreach()

---
 doc/apiref.rst                | 29 +++++++++++++++++++++++++++++
 test/suites/api/test_array.c  | 26 ++++++++++++++++++++++++++
 test/suites/api/test_object.c |  4 ++--
 3 files changed, 57 insertions(+), 2 deletions(-)

diff --git a/doc/apiref.rst b/doc/apiref.rst
index 9f6a67d..24b6085 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -505,6 +505,35 @@ A JSON array is an ordered collection of other JSON values.
    Appends all elements in *other_array* to the end of *array*.
    Returns 0 on success and -1 on error.
 
+The following macro can be used to iterate through all elements
+in an array.
+
+.. function:: json_array_foreach(array, index, value)
+
+   Iterate over every element of ``array``, running the block
+   of code that follows each time with the proper values set to
+   variables ``index`` and ``value``, of types :type:`int` and
+   :type:`json_t *` respectively. Example::
+
+       /* array is a JSON array */
+       int index;
+       json_t *value;
+
+       json_array_foreach(array, index, value) {
+           /* block of code that uses index and value */
+       }
+
+   The items are returned in increasing index order.
+
+   This macro expands to an ordinary ``for`` statement upon
+   preprocessing, so its performance is equivalent to that of
+   hand-written code using the array access functions.
+   The main advantage of this macro is that it abstracts
+   away the complexity, and makes for shorter, more
+   concise code.
+
+   .. versionadded:: 2.5
+
 
 Object
 ======
diff --git a/test/suites/api/test_array.c b/test/suites/api/test_array.c
index cb273f8..dc1e64f 100644
--- a/test/suites/api/test_array.c
+++ b/test/suites/api/test_array.c
@@ -400,6 +400,31 @@ static void test_circular()
     json_decref(array1);
 }
 
+static void test_array_foreach()
+{
+    int index;
+    json_t *array1, *array2, *value;
+
+    array1 = json_pack("[sisisi]", "foo", 1, "bar", 2, "baz", 3);
+    array2 = json_array();
+
+    printf("before array1: %s\n", json_dumps(array1, 0));
+    printf("before array2: %s\n", json_dumps(array2, 0));
+    
+    json_array_foreach(array1, index, value) {
+        json_array_append(array2, value);
+    }
+    
+    printf("after array1: %s\n", json_dumps(array1, 0));
+    printf("after array2: %s\n", json_dumps(array2, 0));
+
+    if(!json_equal(array1, array2))
+        fail("json_array_foreach failed to iterate all elements");
+
+    json_decref(array1);
+    json_decref(array2);
+}
+
 
 static void run_tests()
 {
@@ -409,4 +434,5 @@ static void run_tests()
     test_clear();
     test_extend();
     test_circular();
+    test_array_foreach();
 }
diff --git a/test/suites/api/test_object.c b/test/suites/api/test_object.c
index 31cadc3..8f6bf8a 100644
--- a/test/suites/api/test_object.c
+++ b/test/suites/api/test_object.c
@@ -479,7 +479,7 @@ static void test_preserve_order()
     json_decref(object);
 }
 
-static void test_foreach()
+static void test_object_foreach()
 {
     const char *key;
     json_t *object1, *object2, *value;
@@ -507,5 +507,5 @@ static void run_tests()
     test_set_nocheck();
     test_iterators();
     test_preserve_order();
-    test_foreach();
+    test_object_foreach();
 }