Update all #include directives to the currently preferred style.

[pspp-builds.git] / src / libpspp / llx.h

diff --git a/src/libpspp/llx.h b/src/libpspp/llx.h
index 7523636c946a511d9be0bf63015a8e69ea39c447..80a8a838063e3c2a3e05963c11030f4d141f5803 100644 (file)
--- a/src/libpspp/llx.h
+++ b/src/libpspp/llx.h
@@ -1,21 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2006 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
+/* 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.
 
@@ -52,7 +49,7 @@
 
 #include <stdbool.h>
 #include <stddef.h>
-#include <libpspp/ll.h>
+#include "libpspp/ll.h"
 
 /* External, circular doubly linked list.
 
@@ -83,7 +80,7 @@
    Here's an example of iteration from head to tail:
 
      struct llx *llx;
-     for (llx = llx_head (&list); llx != llx_null (&list); 
+     for (llx = llx_head (&list); llx != llx_null (&list);
           llx = llx_next (llx))
        {
          struct foo *foo = llx_data (llx);
@@ -113,8 +110,14 @@ 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 
+struct llx_manager
   {
     /* Allocates and returns memory for a new struct llx.
        If space is unavailable, returns a null pointer. */
@@ -183,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);
@@ -202,9 +207,9 @@ struct llx *llx_max (const struct llx *r0, const struct llx *r1,
 struct llx *llx_min (const struct llx *r0, const struct llx *r1,
                      llx_compare_func *, void *aux);
 int llx_lexicographical_compare_3way (const struct llx *a0,
-                                      const struct llx *a1, 
+                                      const struct llx *a1,
                                       const struct llx *b0,
-                                      const struct llx *b1, 
+                                      const struct llx *b1,
                                       llx_compare_func *, void *aux);
 
 /* Mutating algorithms. */
@@ -240,14 +245,14 @@ struct llx *llx_find_partition (const struct llx *r0, const struct llx *r1,
 
 /* Returns the llx within which LL is embedded. */
 static struct llx *
-llx_from_ll (struct ll *ll) 
+llx_from_ll (struct ll *ll)
 {
   return ll_data (ll, struct llx, ll);
 }
 
 /* Initializes LIST as an empty list. */
 static inline void
-llx_init (struct llx_list *list) 
+llx_init (struct llx_list *list)
 {
   ll_init (&list->ll_list);
 }
@@ -256,7 +261,7 @@ llx_init (struct llx_list *list)
    false if LIST is not empty (has at least one other node).
    Executes in O(1) time. */
 static inline bool
-llx_is_empty (const struct llx_list *list) 
+llx_is_empty (const struct llx_list *list)
 {
   return ll_is_empty (&list->ll_list);
 }
@@ -264,7 +269,7 @@ llx_is_empty (const struct llx_list *list)
 /* Returns the first node in LIST,
    or the null node if LIST is empty. */
 static inline struct llx *
-llx_head (const struct llx_list *list) 
+llx_head (const struct llx_list *list)
 {
   return llx_from_ll (ll_head (&list->ll_list));
 }
@@ -272,14 +277,14 @@ llx_head (const struct llx_list *list)
 /* Returns the last node in LIST,
    or the null node if LIST is empty. */
 static inline struct llx *
-llx_tail (const struct llx_list *list) 
+llx_tail (const struct llx_list *list)
 {
   return llx_from_ll (ll_tail (&list->ll_list));
 }
 
 /* Returns LIST's null node. */
 static inline struct llx *
-llx_null (const struct llx_list *list) 
+llx_null (const struct llx_list *list)
 {
   return llx_from_ll (ll_null (&list->ll_list));
 }
@@ -288,7 +293,7 @@ llx_null (const struct llx_list *list)
    or the null node if LLX is at the end of its list.
    (In an empty list, the null node follows itself.) */
 static inline struct llx *
-llx_next (const struct llx *llx) 
+llx_next (const struct llx *llx)
 {
   return llx_from_ll (ll_next (&llx->ll));
 }
@@ -304,7 +309,7 @@ llx_prev (const struct llx *llx)
 
 /* Returns the data in node LLX. */
 static inline void *
-llx_data (const struct llx *llx) 
+llx_data (const struct llx *llx)
 {
   return llx->data;
 }