libstdc++-v3/include/debug/safe_sequence.h

   1 // Safe sequence implementation  -*- C++ -*-
   2
   3 // Copyright (C) 2003, 2004, 2005
   4 // Free Software Foundation, Inc.
   5 //
   6 // This file is part of the GNU ISO C++ Library.  This library is free
   7 // software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the
   9 // Free Software Foundation; either version 2, or (at your option)
  10 // any later version.
  11
  12 // This library 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 // GNU General Public License for more details.
  16
  17 // You should have received a copy of the GNU General Public License along
  18 // with this library; see the file COPYING.  If not, write to the Free
  19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  20 // USA.
  21
  22 // As a special exception, you may use this file as part of a free software
  23 // library without restriction.  Specifically, if other files instantiate
  24 // templates or use macros or inline functions from this file, or you compile
  25 // this file and link it with other files to produce an executable, this
  26 // file does not by itself cause the resulting executable to be covered by
  27 // the GNU General Public License.  This exception does not however
  28 // invalidate any other reasons why the executable file might be covered by
  29 // the GNU General Public License.
  30
  31 #ifndef _GLIBCXX_DEBUG_SAFE_SEQUENCE_H
  32 #define _GLIBCXX_DEBUG_SAFE_SEQUENCE_H 1
  33
  34 #include <debug/debug.h>
  35 #include <debug/macros.h>
  36 #include <debug/functions.h>
  37 #include <debug/safe_base.h>
  38
  39 namespace std
  40 {
  41 namespace __gnu_debug
  42 {
  43   template<typename _Iterator, typename _Sequence>
  44     class _Safe_iterator;
  45
  46   /** A simple function object that returns true if the passed-in
  47    *  value is not equal to the stored value. It saves typing over
  48    *  using both bind1st and not_equal.
  49    */
  50   template<typename _Type>
  51     class _Not_equal_to
  52     {
  53       _Type __value;
  54
  55     public:
  56       explicit _Not_equal_to(const _Type& __v) : __value(__v) { }
  57
  58       bool
  59       operator()(const _Type& __x) const
  60       { return __value != __x; }
  61     };
  62
  63   /** A function object that returns true when the given random access
  64       iterator is at least @c n steps away from the given iterator. */
  65   template<typename _Iterator>
  66     class _After_nth_from
  67     {
  68       typedef typename std::iterator_traits<_Iterator>::difference_type
  69       difference_type;
  70
  71       _Iterator _M_base;
  72       difference_type _M_n;
  73
  74     public:
  75       _After_nth_from(const difference_type& __n, const _Iterator& __base)
  76       : _M_base(__base), _M_n(__n) { }
  77
  78       bool
  79       operator()(const _Iterator& __x) const
  80       { return __x - _M_base >= _M_n; }
  81     };
  82
  83   /**
  84    * @brief Base class for constructing a "safe" sequence type that
  85    * tracks iterators that reference it.
  86    *
  87    * The class template %_Safe_sequence simplifies the construction of
  88    * "safe" sequences that track the iterators that reference the
  89    * sequence, so that the iterators are notified of changes in the
  90    * sequence that may affect their operation, e.g., if the container
  91    * invalidates its iterators or is destructed. This class template
  92    * may only be used by deriving from it and passing the name of the
  93    * derived class as its template parameter via the curiously
  94    * recurring template pattern. The derived class must have @c
  95    * iterator and @const_iterator types that are instantiations of
  96    * class template _Safe_iterator for this sequence. Iterators will
  97    * then be tracked automatically.
  98    */
  99   template<typename _Sequence>
 100     class _Safe_sequence : public _Safe_sequence_base
 101     {
 102     public:
 103       /** Invalidates all iterators @c x that reference this sequence,
 104           are not singular, and for which @c pred(x) returns @c
 105           true. The user of this routine should be careful not to make
 106           copies of the iterators passed to @p pred, as the copies may
 107           interfere with the invalidation. */
 108       template<typename _Predicate>
 109         void
 110         _M_invalidate_if(_Predicate __pred);
 111
 112       /** Transfers all iterators that reference this memory location
 113           to this sequence from whatever sequence they are attached
 114           to. */
 115       template<typename _Iterator>
 116         void
 117         _M_transfer_iter(const _Safe_iterator<_Iterator, _Sequence>& __x);
 118     };
 119
 120   template<typename _Sequence>
 121     template<typename _Predicate>
 122       void
 123       _Safe_sequence<_Sequence>::
 124       _M_invalidate_if(_Predicate __pred)
 125       {
 126         typedef typename _Sequence::iterator iterator;
 127         typedef typename _Sequence::const_iterator const_iterator;
 128
 129         for (_Safe_iterator_base* __iter = _M_iterators; __iter; )
 130         {
 131           iterator* __victim = static_cast<iterator*>(__iter);
 132           __iter = __iter->_M_next;
 133           if (!__victim->_M_singular())
 134           {
 135             if (__pred(__victim->base()))
 136               __victim->_M_invalidate();
 137           }
 138         }
 139
 140         for (_Safe_iterator_base* __iter2 = _M_const_iterators; __iter2; )
 141         {
 142           const_iterator* __victim = static_cast<const_iterator*>(__iter2);
 143           __iter2 = __iter2->_M_next;
 144           if (!__victim->_M_singular())
 145           {
 146             if (__pred(__victim->base()))
 147               __victim->_M_invalidate();
 148           }
 149         }
 150       }
 151
 152   template<typename _Sequence>
 153     template<typename _Iterator>
 154       void
 155       _Safe_sequence<_Sequence>::
 156       _M_transfer_iter(const _Safe_iterator<_Iterator, _Sequence>& __x)
 157       {
 158         _Safe_sequence_base* __from = __x._M_sequence;
 159         if (!__from)
 160           return;
 161
 162         typedef typename _Sequence::iterator iterator;
 163         typedef typename _Sequence::const_iterator const_iterator;
 164
 165         for (_Safe_iterator_base* __iter = __from->_M_iterators; __iter; )
 166         {
 167           iterator* __victim = static_cast<iterator*>(__iter);
 168           __iter = __iter->_M_next;
 169           if (!__victim->_M_singular() && __victim->base() == __x.base())
 170             __victim->_M_attach(static_cast<_Sequence*>(this));
 171         }
 172
 173         for (_Safe_iterator_base* __iter2 = __from->_M_const_iterators;
 174              __iter2;)
 175         {
 176           const_iterator* __victim = static_cast<const_iterator*>(__iter2);
 177           __iter2 = __iter2->_M_next;
 178           if (!__victim->_M_singular() && __victim->base() == __x.base())
 179             __victim->_M_attach(static_cast<_Sequence*>(this));
 180         }
 181       }
 182 } // namespace __gnu_debug
 183 } // namespace std
 184
 185 #endif