src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::DLListBase
  27
  28 Description
  29     Base doubly-linked list.
  30
  31 SourceFiles
  32     DLListBase.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef DLListBase_H
  37 #define DLListBase_H
  38
  39 #include "bool.H"
  40 #include "label.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class DLListBase Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class DLListBase
  52 {
  53
  54 public:
  55
  56     //- Link structure
  57     struct link
  58     {
  59         //- Pointer to next entry in list
  60         link *prev_, *next_;
  61
  62         //- Null construct
  63         inline link();
  64
  65         //- Check if the link is registered with the DLListBase
  66         inline bool registered() const;
  67
  68         //- Deregister the link after removal
  69         inline void deregister();
  70     };
  71
  72
  73 private:
  74
  75     // Private data
  76
  77        //- first_ points to first element and last_ points to last element.
  78        link *first_, *last_;
  79
  80        //- Number of elements in in list
  81        label nElmts_;
  82
  83
  84     // Private member functions
  85
  86         //- Disallow default bitwise copy construct
  87         DLListBase(const DLListBase&);
  88
  89         //- Disallow default bitwise assignment
  90         void operator=(const DLListBase&);
  91
  92
  93 public:
  94
  95     // Forward declaration of STL iterators
  96
  97         class iterator;
  98         friend class iterator;
  99
 100         class const_iterator;
 101         friend class const_iterator;
 102
 103
 104     // Constructors
 105
 106         //- Null construct
 107         inline DLListBase();
 108
 109         //- Construct given initial entry
 110         inline DLListBase(link*);
 111
 112
 113     // Destructor
 114
 115         ~DLListBase();
 116
 117
 118     // Member Functions
 119
 120         // Access
 121
 122             //- Return number of elements in list
 123             inline label size() const;
 124
 125             //- Return first entry
 126             inline link* first();
 127
 128             //- Return const access to first entry
 129             inline const link* first() const;
 130
 131             //- Return last entry
 132             inline link* last();
 133
 134             //- Return const access to last entry
 135             inline const link* last() const;
 136
 137
 138         // Edit
 139
 140             //- Add at head of list
 141             void insert(link*);
 142
 143             //- Add at tail of list
 144             void append(link*);
 145
 146             //- Swap this element with the one above unless it is at the top
 147             bool swapUp(link*);
 148
 149             //- Swap this element with the one below unless it is at the bottom
 150             bool swapDown(link*);
 151
 152             //- Remove and return head
 153             link* removeHead();
 154
 155             //- Remove and return element
 156             link* remove(link*);
 157
 158             // Remove and return element specified by iterator
 159             inline link* remove(iterator&);
 160
 161             //- Replace oldLink with newLink and return element
 162             link* replace(link* oldLink, link* newLink);
 163
 164             //- Replace oldIter with newLink and return element
 165             inline link* replace(iterator& oldIter, link* newLink);
 166
 167             //- Clear the list
 168             inline void clear();
 169
 170
 171     // STL iterator
 172
 173         //- An STL iterator
 174         class iterator
 175         {
 176             friend class DLListBase;
 177             friend class const_iterator;
 178
 179             // Private data
 180
 181                 //- Reference to the list this is an iterator for
 182                 DLListBase& curList_;
 183
 184                 //- Current element
 185                 link* curElmt_;
 186
 187                 //- Copy of the link
 188                 link curLink_;
 189
 190         public:
 191
 192             //- Construct for a given DLListBase and link
 193             inline iterator(DLListBase&, link*);
 194
 195             //- Construct for a given DLListBase
 196             //  setting element and link to NULL.
 197             //  Only used to create endIter
 198             inline iterator(DLListBase&);
 199
 200             // Member operators
 201
 202                 inline void operator=(const iterator&);
 203
 204                 inline bool operator==(const iterator&) const;
 205                 inline bool operator!=(const iterator&) const;
 206
 207                 inline link& operator*();
 208
 209                 inline iterator& operator++();
 210                 inline iterator operator++(int);
 211         };
 212
 213         inline iterator begin();
 214
 215         //- iterator returned by end()
 216         static iterator endIter;
 217
 218         inline const iterator& end();
 219
 220
 221     // STL const_iterator
 222
 223         //- An STL const_iterator
 224         class const_iterator
 225         {
 226             // Private data
 227
 228                 //- Reference to the list this is an iterator for
 229                 const DLListBase& curList_;
 230
 231                 //- Current element
 232                 const link* curElmt_;
 233
 234         public:
 235
 236             //- Construct for a given DLListBase and link
 237             inline const_iterator(const DLListBase&, const link*);
 238
 239             //- Construct from a non-const iterator
 240             inline const_iterator(const iterator&);
 241
 242             // Member operators
 243
 244                 inline void operator=(const const_iterator&);
 245
 246                 inline bool operator==(const const_iterator&) const;
 247                 inline bool operator!=(const const_iterator&) const;
 248
 249                 inline const link& operator*();
 250
 251                 inline const_iterator& operator++();
 252                 inline const_iterator operator++(int);
 253         };
 254
 255         inline const_iterator begin() const;
 256
 257         //- const_iterator returned by end()
 258         static const_iterator endConstIter;
 259
 260         inline const const_iterator& end() const;
 261 };
 262
 263
 264 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 265
 266 } // End namespace Foam
 267
 268 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 269
 270 #include "DLListBaseI.H"
 271
 272 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 273
 274 #endif
 275
 276 // ************************************************************************* //