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

   1 /*
   2    Bacula(R) - The Network Backup Solution
   3
   4    Copyright (C) 2003-2012 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version three of the GNU Affero General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU Affero General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula(R) is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *  Kern Sibbald, June MMIII
  30  */
  31
  32
  33 /*
  34  * There is a lot of extra casting here to work around the fact
  35  * that some compilers (Sun and Visual C++) do not accept
  36  * (void *) as an lvalue on the left side of an equal.
  37  *
  38  * Loop var through each member of list
  39  */
  40 #ifdef HAVE_TYPEOF
  41 #define foreach_alist(var, list) \
  42         for((var)=(typeof(var))(list)->first(); (var); (var)=(typeof(var))(list)->next() )
  43 #else
  44 #define foreach_alist(var, list) \
  45     for((*((void **)&(var))=(void*)((list)->first())); \
  46          (var); \
  47          (*((void **)&(var))=(void*)((list)->next())))
  48 #endif
  49
  50 #ifdef HAVE_TYPEOF
  51 #define foreach_alist_index(inx, var, list) \
  52         for(inx=0; ((var)=(typeof(var))(list)->get(inx)); inx++ )
  53 #else
  54 #define foreach_alist_index(inx, var, list) \
  55     for(inx=0; ((*((void **)&(var))=(void*)((list)->get(inx)))); inx++ )
  56 #endif
  57
  58
  59
  60
  61 /* Second arg of init */
  62 enum {
  63   owned_by_alist = true,
  64   not_owned_by_alist = false
  65 };
  66
  67 /*
  68  * Array list -- much like a simplified STL vector
  69  *   array of pointers to inserted items
  70  */
  71 class alist : public SMARTALLOC {
  72    void **items;
  73    int num_items;
  74    int max_items;
  75    int num_grow;
  76    int cur_item;
  77    bool own_items;
  78    void grow_list(void);
  79 public:
  80    alist(int num = 1, bool own=true);
  81    ~alist();
  82    void init(int num = 1, bool own=true);
  83    void append(void *item);
  84    void prepend(void *item);
  85    void *remove(int index);
  86    void *get(int index);
  87    bool empty() const;
  88    void *prev();
  89    void *next();
  90    void *first();
  91    void *last();
  92    void * operator [](int index) const;
  93    int current() const { return cur_item; };
  94    int size() const;
  95    void destroy();
  96    void grow(int num);
  97
  98    /* Use it as a stack, pushing and poping from the end */
  99    void push(void *item) { append(item); };
 100    void *pop() { return remove(num_items-1); };
 101 };
 102
 103 /*
 104  * Define index operator []
 105  */
 106 inline void * alist::operator [](int index) const {
 107    if (index < 0 || index >= num_items) {
 108       return NULL;
 109    }
 110    return items[index];
 111 }
 112
 113 inline bool alist::empty() const
 114 {
 115    /* Check for null pointer */
 116    return this ? num_items == 0 : true;
 117 }
 118
 119 /*
 120  * This allows us to do explicit initialization,
 121  *   allowing us to mix C++ classes inside malloc'ed
 122  *   C structures. Define before called in constructor.
 123  */
 124 inline void alist::init(int num, bool own)
 125 {
 126    items = NULL;
 127    num_items = 0;
 128    max_items = 0;
 129    num_grow = num;
 130    own_items = own;
 131 }
 132
 133 /* Constructor */
 134 inline alist::alist(int num, bool own)
 135 {
 136    init(num, own);
 137 }
 138
 139 /* Destructor */
 140 inline alist::~alist()
 141 {
 142    destroy();
 143 }
 144
 145
 146
 147 /* Current size of list */
 148 inline int alist::size() const
 149 {
 150    /*
 151     * Check for null pointer, which allows test
 152     *  on size to succeed even if nothing put in
 153     *  alist.
 154     */
 155    return this ? num_items : 0;
 156 }
 157
 158 /* How much to grow by each time */
 159 inline void alist::grow(int num)
 160 {
 161    num_grow = num;
 162 }