GNU g++  v5.2.1
GNU Standard C++
__gnu_debug::_Safe_sequence< _Sequence > Class Template Reference

Base class for constructing a safe sequence type that tracks iterators that reference it. More...

#include <safe_sequence.h>

Inheritance diagram for __gnu_debug::_Safe_sequence< _Sequence >:
Collaboration diagram for __gnu_debug::_Safe_sequence< _Sequence >:

Public Member Functions

void _M_attach (_Safe_iterator_base *__it, bool __constant)
 Attach an iterator to this sequence. More...
 
void _M_attach_single (_Safe_iterator_base *__it, bool __constant) throw ()
 Likewise but not thread safe. More...
 
void _M_detach (_Safe_iterator_base *__it)
 Detach an iterator from this sequence. More...
 
void _M_detach_single (_Safe_iterator_base *__it) throw ()
 Likewise but not thread safe. More...
 
void _M_invalidate_all () const
 Invalidates all iterators. More...
 
template<typename _Predicate >
void _M_invalidate_if (_Predicate __pred)
 Invalidates all iterators x that reference this sequence, are not singular, and for which __pred(x) returns true. More...
 
template<typename _Predicate >
void _M_transfer_from_if (_Safe_sequence &__from, _Predicate __pred)
 Transfers all iterators x that reference from sequence, are not singular, and for which __pred(x) returns true. More...
 

Public Attributes

_Safe_iterator_base_M_const_iterators
 The list of constant iterators that reference this container. More...
 
_Safe_iterator_base_M_iterators
 The list of mutable iterators that reference this container. More...
 
unsigned int _M_version
 The container version number. This number may never be 0. More...
 

Protected Member Functions

void _M_detach_all ()
 Detach all iterators, leaving them singular. More...
 
void _M_detach_singular ()
 Detach all singular iterators. More...
 
__gnu_cxx::__mutex & _M_get_mutex () throw ()
 For use in _Safe_sequence. More...
 
void _M_revalidate_singular ()
 Revalidates all attached singular iterators. More...
 
void _M_swap (_Safe_sequence_base &__x) _GLIBCXX_USE_NOEXCEPT
 Swap this sequence with the given sequence. More...
 

Detailed Description

template<typename _Sequence>
class __gnu_debug::_Safe_sequence< _Sequence >

Base class for constructing a safe sequence type that tracks iterators that reference it.

The class template _Safe_sequence simplifies the construction of safe sequences that track the iterators that reference the sequence, so that the iterators are notified of changes in the sequence that may affect their operation, e.g., if the container invalidates its iterators or is destructed. This class template may only be used by deriving from it and passing the name of the derived class as its template parameter via the curiously recurring template pattern. The derived class must have iterator and const_iterator types that are instantiations of class template _Safe_iterator for this sequence. Iterators will then be tracked automatically.

Member Function Documentation

void __gnu_debug::_Safe_sequence_base::_M_attach ( _Safe_iterator_base __it,
bool  __constant 
)
inherited

Attach an iterator to this sequence.

void __gnu_debug::_Safe_sequence_base::_M_attach_single ( _Safe_iterator_base __it,
bool  __constant 
)
throw (
)
inherited

Likewise but not thread safe.

void __gnu_debug::_Safe_sequence_base::_M_detach ( _Safe_iterator_base __it)
inherited

Detach an iterator from this sequence.

void __gnu_debug::_Safe_sequence_base::_M_detach_all ( )
protectedinherited

Detach all iterators, leaving them singular.

Referenced by __gnu_debug::_Safe_sequence_base::~_Safe_sequence_base().

Here is the caller graph for this function:

void __gnu_debug::_Safe_sequence_base::_M_detach_single ( _Safe_iterator_base __it)
throw (
)
inherited

Likewise but not thread safe.

void __gnu_debug::_Safe_sequence_base::_M_detach_singular ( )
protectedinherited

Detach all singular iterators.

Postcondition
for all iterators i attached to this sequence, i->_M_version == _M_version.
__gnu_cxx::__mutex& __gnu_debug::_Safe_sequence_base::_M_get_mutex ( )
throw (
)
protectedinherited

For use in _Safe_sequence.

void __gnu_debug::_Safe_sequence_base::_M_invalidate_all ( ) const
inlineinherited

Invalidates all iterators.

template<typename _Sequence>
template<typename _Predicate >
void __gnu_debug::_Safe_sequence< _Sequence >::_M_invalidate_if ( _Predicate  __pred)

Invalidates all iterators x that reference this sequence, are not singular, and for which __pred(x) returns true.

__pred will be invoked with the normal iterators nested in the safe ones.

Referenced by __gnu_debug::_Safe_node_sequence< _Sequence >::_M_invalidate_all().

Here is the caller graph for this function:

void __gnu_debug::_Safe_sequence_base::_M_revalidate_singular ( )
protectedinherited

Revalidates all attached singular iterators.

This method may be used to validate iterators that were invalidated before (but for some reason, such as an exception, need to become valid again).

void __gnu_debug::_Safe_sequence_base::_M_swap ( _Safe_sequence_base __x)
protectedinherited

Swap this sequence with the given sequence.

This operation also swaps ownership of the iterators, so that when the operation is complete all iterators that originally referenced one container now reference the other container.

template<typename _Sequence>
template<typename _Predicate >
void __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if ( _Safe_sequence< _Sequence > &  __from,
_Predicate  __pred 
)

Transfers all iterators x that reference from sequence, are not singular, and for which __pred(x) returns true.

__pred will be invoked with the normal iterators nested in the safe ones.

Member Data Documentation

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_const_iterators
inherited

The list of constant iterators that reference this container.

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_iterators
inherited

The list of mutable iterators that reference this container.

unsigned int __gnu_debug::_Safe_sequence_base::_M_version
mutableinherited

The container version number. This number may never be 0.


The documentation for this class was generated from the following files: