1 /* Pending_List 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_Pending_List_defs_hh
25 #define PPL_Pending_List_defs_hh 1
26 
27 #include "Pending_List_types.hh"
28 #include "Pending_Element_defs.hh"
29 #include "EList_defs.hh"
30 #include "Handler_types.hh"
31 
32 //! An ordered list for recording pending watchdog events.
33 template <typename Traits>
34 class Parma_Polyhedra_Library::Implementation::Watchdog::Pending_List {
35 public:
36   //! A non-const iterator to traverse the list.
37   typedef typename EList<Pending_Element<typename Traits::Threshold> >::iterator iterator;
38 
39   //! A const iterator to traverse the list.
40   typedef typename EList<Pending_Element<typename Traits::Threshold> >::const_iterator const_iterator;
41 
42   //! Constructs an empty list.
43   Pending_List();
44 
45   //! Destructor.
46   ~Pending_List();
47 
48   //! Inserts a new Pending_Element object with the given attributes.
49   iterator insert(const typename Traits::Threshold& deadline,
50                   const Handler& handler,
51                   bool& expired_flag);
52 
53   /*! \brief
54     Removes the element pointed to by \p position, returning
55     an iterator pointing to the next element, if any, or end(), otherwise.
56   */
57   iterator erase(iterator position);
58 
59   //! Returns <CODE>true</CODE> if and only if the list is empty.
60   bool empty() const;
61 
62   //! Returns an iterator pointing to the beginning of the list.
63   iterator begin();
64 
65   //! Returns an iterator pointing one past the last element in the list.
66   iterator end();
67 
68   //! Checks if all the invariants are satisfied.
69   bool OK() const;
70 
71 private:
72   EList<Pending_Element<typename Traits::Threshold> > active_list;
73   EList<Pending_Element<typename Traits::Threshold> > free_list;
74 };
75 
76 #include "Pending_List_inlines.hh"
77 #include "Pending_List_templates.hh"
78 
79 #endif // !defined(PPL_Pending_List_defs_hh)
80