git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/dlist.h

   1 /*
   2  *   Version $Id$
   3  */
   4 /*
   5    Copyright (C) 2003-2005 Kern Sibbald
   6
   7    This program is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License
   9    version 2 as ammended with additional clauses defined in the
  10    file LICENSE in the main source directory.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15    the file LICENSE for additional details.
  16
  17  */
  18
  19
  20 /* ========================================================================
  21  *
  22  *   Doubly linked list  -- dlist
  23  *
  24  *    Kern Sibbald, MMIV
  25  *
  26  */
  27
  28 #define M_ABORT 1
  29
  30 /* In case you want to specifically specify the offset to the link */
  31 #define OFFSET(item, link) ((char *)(link) - (char *)(item))
  32 /*
  33  * There is a lot of extra casting here to work around the fact
  34  * that some compilers (Sun and Visual C++) do not accept
  35  * (void *) as an lvalue on the left side of an equal.
  36  *
  37  * Loop var through each member of list
  38  */
  39 #define foreach_dlist(var, list) \
  40     for((var)=NULL; (*((void **)&(var))=(void*)((list)->next(var))); )
  41
  42 #ifdef the_old_way
  43 #define foreach_dlist(var, list) \
  44         for((var)=NULL; (((void *)(var))=(list)->next(var)); )
  45 #endif
  46
  47
  48 struct dlink {
  49    void *next;
  50    void *prev;
  51 };
  52
  53 class dlist : public SMARTALLOC {
  54    void *head;
  55    void *tail;
  56    int16_t loffset;
  57    uint32_t num_items;
  58 public:
  59    dlist(void *item, dlink *link);
  60    dlist(void);
  61    ~dlist() { destroy(); }
  62    void init(void *item, dlink *link);
  63    void prepend(void *item);
  64    void append(void *item);
  65    void insert_before(void *item, void *where);
  66    void insert_after(void *item, void *where);
  67    void *unique_binary_insert(void *item, int compare(void *item1, void *item2));
  68    void binary_insert(void *item, int compare(void *item1, void *item2));
  69    void remove(void *item);
  70    bool empty() const;
  71    int  size() const;
  72    void *next(const void *item) const;
  73    void *prev(const void *item) const;
  74    void destroy();
  75    void *first() const;
  76    void *last() const;
  77 };
  78
  79
  80 /*
  81  * This allows us to do explicit initialization,
  82  *   allowing us to mix C++ classes inside malloc'ed
  83  *   C structures. Define before called in constructor.
  84  */
  85 inline void dlist::init(void *item, dlink *link)
  86 {
  87    head = tail = NULL;
  88    loffset = (char *)link - (char *)item;
  89    if (loffset < 0 || loffset > 5000) {
  90       Emsg0(M_ABORT, 0, "Improper dlist initialization.\n");
  91    }
  92    num_items = 0;
  93 }
  94
  95 /*
  96  * Constructor called with the address of a
  97  *   member of the list (not the list head), and
  98  *   the address of the link within that member.
  99  * If the link is at the beginning of the list member,
 100  *   then there is no need to specify the link address
 101  *   since the offset is zero.
 102  */
 103 inline dlist::dlist(void *item, dlink *link)
 104 {
 105    init(item, link);
 106 }
 107
 108 /* Constructor with link at head of item */
 109 inline dlist::dlist(void) : head(0), tail(0), loffset(0), num_items(0)
 110 {
 111 }
 112
 113 inline bool dlist::empty() const
 114 {
 115    return head == NULL;
 116 }
 117
 118 inline int dlist::size() const
 119 {
 120    return num_items;
 121 }
 122
 123
 124
 125 inline void * dlist::first() const
 126 {
 127    return head;
 128 }
 129
 130 inline void * dlist::last() const
 131 {
 132    return tail;
 133 }