1 /* Doubly_Linked_Object class declaration.
2    Copyright (C) 2001-2010 Roberto Bagnara <bagnara@cs.unipr.it>
3    Copyright (C) 2010-2016 BUGSENG srl (http://bugseng.com)
4 
5 This file is part of the Parma Polyhedra Library (PPL).
6 
7 The PPL is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 The PPL is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software Foundation,
19 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1307, USA.
20 
21 For the most up-to-date information see the Parma Polyhedra Library
22 site: http://bugseng.com/products/ppl/ . */
23 
24 #ifndef PPL_Doubly_Linked_Object_defs_hh
25 #define PPL_Doubly_Linked_Object_defs_hh 1
26 
27 #include "Doubly_Linked_Object_types.hh"
28 #include "EList_types.hh"
29 #include "EList_Iterator_types.hh"
30 
31 //! A (base) class for doubly linked objects.
32 class Parma_Polyhedra_Library::Implementation::Doubly_Linked_Object {
33 public:
34   //! Default constructor.
35   Doubly_Linked_Object();
36 
37   //! Creates a chain element with forward link \p f and backward link \p b.
38   Doubly_Linked_Object(Doubly_Linked_Object* f, Doubly_Linked_Object* b);
39 
40   //! Inserts \p y before \p *this.
41   void insert_before(Doubly_Linked_Object& y);
42 
43   //! Inserts \p y after \p *this.
44   void insert_after(Doubly_Linked_Object& y);
45 
46   //! Erases \p *this from the chain and returns a pointer to the next element.
47   Doubly_Linked_Object* erase();
48 
49   //! Erases \p *this from the chain.
50   ~Doubly_Linked_Object();
51 
52 private:
53   //! Forward link.
54   Doubly_Linked_Object* next;
55 
56   //! Backward link.
57   Doubly_Linked_Object* prev;
58 
59   template <typename T> friend class EList;
60   template <typename T> friend class EList_Iterator;
61 };
62 
63 #include "Doubly_Linked_Object_inlines.hh"
64 
65 #endif // !defined(PPL_Doubly_Linked_Object_defs_hh)
66