Rename var_array to nest.

[pspp] / src / libpspp / llx.h

diff --git a/src/libpspp/llx.h b/src/libpspp/llx.h
index 0db6183cc6097515dd81119110d53b21c1a31db5..8f01c70f24aa0b8632e2c2f470f8a60e6f53abc3 100644 (file)
--- a/src/libpspp/llx.h
+++ b/src/libpspp/llx.h
@@ -1,20 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2006 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2006, 2011 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 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.
+   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., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 /* Circular doubly linked lists.
 
@@ -51,7 +49,7 @@
 
 #include <stdbool.h>
 #include <stddef.h>
-#include <libpspp/ll.h>
+#include "libpspp/ll.h"
 
 /* External, circular doubly linked list.
 
@@ -112,6 +110,12 @@ struct llx_list
     struct ll_list ll_list;     /* The list. */
   };
 
+/* Suitable for use as the initializer for a `struct llx_list'
+   named LIST.  Typical usage:
+       struct llx_list list = LLX_INITIALIZER (list);
+   LLX_INITIALIZER() is an alternative to llx_init(). */
+#define LLX_INITIALIZER(LIST) { LL_INITIALIZER ((LIST).ll_list) }
+
 /* Memory manager. */
 struct llx_manager
   {
@@ -182,6 +186,8 @@ size_t llx_remove_if (struct llx *r0, struct llx *r1,
                       const struct llx_manager *);
 
 /* Non-mutating algorithms. */
+struct llx *llx_find (const struct llx *r0, const struct llx *r1,
+                      const void *target);
 struct llx *llx_find_equal (const struct llx *r0, const struct llx *r1,
                             const void *target,
                             llx_compare_func *, void *aux);
@@ -307,5 +313,50 @@ llx_data (const struct llx *llx)
 {
   return llx->data;
 }
+/* Iteration helper macros. */
+
+/* Sets "struct llx *" NODE to each object in LIST in turn, in forward or
+   reverse order.
+
+   Behavior is undefined if NODE is removed from the list between
+   loop iterations. */
+#define llx_for_each(NODE, LIST)                \
+        for ((NODE) = llx_head (LIST);          \
+             (NODE) != llx_null (LIST);         \
+             (NODE) = llx_next (NODE))
+#define llx_for_each_reverse(NODE, LIST)        \
+        for ((NODE) = llx_tail (LIST);          \
+             (NODE) != llx_null (LIST);         \
+             (NODE) = llx_prev (NODE))
+
+/* Sets "struct llx *" NODE to each object in LIST in turn, in forward or
+   reverse order.  NEXT (or PREV) must be another "struct llx *" variable.
+
+   Behavior is well-defined even if NODE is removed from the list between
+   iterations. */
+#define llx_for_each_safe(NODE, NEXT, LIST)     \
+        for (NODE = llx_head (LIST);            \
+             ((NODE) != llx_null (LIST)         \
+              ? ((NEXT) = llx_next (NODE), 1)   \
+              : 0);                             \
+             (NODE) = (NEXT))
+#define llx_for_each_reverse_safe(NODE, PREV, LIST)     \
+        for (NODE = llx_tail (LIST);                    \
+             ((NODE) != llx_null (LIST)                 \
+              ? ((PREV) = llx_prev (NODE), 1)           \
+              : 0);                                     \
+             (NODE) = (PREV))
+
+/* Sets DATA to the data from each object in LIST in turn, in forward or
+   reverse order.  Each object is removed from LIST before its loop
+   iteration. */
+#define llx_for_each_preremove(DATA, LIST, MANAGER)             \
+        while (!llx_is_empty (LIST)                             \
+               ? ((DATA) = llx_pop_head (LIST, MANAGER), 1)     \
+               : 0)
+#define llx_for_each_reverse_preremove(DATA, LIST, MANAGER)     \
+        while (!llx_is_empty (LIST)                             \
+               ? ((DATA) = llx_pop_tail (LIST, MANAGER), 1)     \
+               : 0)
 
 #endif /* llx.h */