lib/list.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33 #ifndef LIST_H
  34 #define LIST_H 1
  35
  36 /* Doubly linked list. */
  37
  38 #include <stdbool.h>
  39 #include <stddef.h>
  40 #include "util.h"
  41
  42 /* Doubly linked list head or element. */
  43 struct list
  44   {
  45     struct list *prev;     /* Previous list element. */
  46     struct list *next;     /* Next list element. */
  47   };
  48
  49 #define LIST_INITIALIZER(LIST) { LIST, LIST }
  50
  51 void list_init(struct list *);
  52
  53 /* List insertion. */
  54 void list_insert(struct list *, struct list *);
  55 void list_splice(struct list *before, struct list *first, struct list *last);
  56 void list_push_front(struct list *, struct list *);
  57 void list_push_back(struct list *, struct list *);
  58 void list_replace(struct list *, const struct list *);
  59
  60 /* List removal. */
  61 struct list *list_remove(struct list *);
  62 struct list *list_pop_front(struct list *);
  63 struct list *list_pop_back(struct list *);
  64
  65 /* List elements. */
  66 struct list *list_front(struct list *);
  67 struct list *list_back(struct list *);
  68
  69 /* List properties. */
  70 size_t list_size(const struct list *);
  71 bool list_is_empty(const struct list *);
  72
  73 #define LIST_FOR_EACH(ITER, STRUCT, MEMBER, LIST)                   \
  74     for (ITER = CONTAINER_OF((LIST)->next, STRUCT, MEMBER);         \
  75          &(ITER)->MEMBER != (LIST);                                 \
  76          ITER = CONTAINER_OF((ITER)->MEMBER.next, STRUCT, MEMBER))
  77 #define LIST_FOR_EACH_REVERSE(ITER, STRUCT, MEMBER, LIST)           \
  78     for (ITER = CONTAINER_OF((LIST)->prev, STRUCT, MEMBER);         \
  79          &(ITER)->MEMBER != (LIST);                                 \
  80          ITER = CONTAINER_OF((ITER)->MEMBER.prev, STRUCT, MEMBER))
  81 #define LIST_FOR_EACH_SAFE(ITER, NEXT, STRUCT, MEMBER, LIST)        \
  82     for (ITER = CONTAINER_OF((LIST)->next, STRUCT, MEMBER);         \
  83          (NEXT = CONTAINER_OF((ITER)->MEMBER.next, STRUCT, MEMBER), \
  84           &(ITER)->MEMBER != (LIST));                               \
  85          ITER = NEXT)
  86
  87 #endif /* list.h */