_String_const_iterator< _Mystr > Class Template Reference

Inheritance diagram for _String_const_iterator< _Mystr >:

Public Types
typedef _String_const_iterator< _Mystr >	_Myiter
typedef random_access_iterator_tag	iterator_category
typedef _Mystr::value_type	value_type
typedef _Mystr::difference_type	difference_type
typedef _Mystr::const_pointer	pointer
typedef _Mystr::const_reference	reference
typedef pointer	_Unchecked_type
Public Types inherited from _Iterator012< random_access_iterator_tag, _Mystr::value_type, _Mystr::difference_type, _Mystr::const_pointer, _Mystr::const_reference, _Iterator_base >
typedef random_access_iterator_tag	iterator_category
typedef _Mystr::value_type	value_type
typedef _Mystr::difference_type	difference_type
typedef _Mystr::const_pointer	pointer
typedef _Mystr::const_reference	reference

Public Member Functions
	_String_const_iterator ()
	_String_const_iterator (pointer _Parg, const _Container_base *_Pstring)
_Myiter &	_Rechecked (_Unchecked_type _Right)
_Unchecked_type	_Unchecked () const
reference	operator* () const
pointer	operator-> () const
_Myiter &	operator++ ()
_Myiter	operator++ (int)
_Myiter &	operator-- ()
_Myiter	operator-- (int)
_Myiter &	operator+= (const difference_type _Off)
_Myiter	operator+ (const difference_type _Off) const
_Myiter &	operator-= (const difference_type _Off)
_Myiter	operator- (const difference_type _Off) const
difference_type	operator- (const _Myiter &_Right) const
reference	operator[] (const difference_type _Off) const
bool	operator== (const _Myiter &_Right) const
bool	operator!= (const _Myiter &_Right) const
bool	operator< (const _Myiter &_Right) const
bool	operator> (const _Myiter &_Right) const
bool	operator<= (const _Myiter &_Right) const
bool	operator>= (const _Myiter &_Right) const
void	_Compat (const _Myiter &) const
Public Member Functions inherited from _Iterator_base0
void	_Adopt (const void *)
const _Container_base0 *	_Getcont () const

Public Attributes
pointer	_Ptr

Member Typedef Documentation

template<class _Mystr>

typedef _String_const_iterator<_Mystr> _String_const_iterator< _Mystr >::_Myiter

template<class _Mystr>

typedef pointer _String_const_iterator< _Mystr >::_Unchecked_type

template<class _Mystr>

typedef _Mystr::difference_type _String_const_iterator< _Mystr >::difference_type

template<class _Mystr>

typedef random_access_iterator_tag _String_const_iterator< _Mystr >::iterator_category

template<class _Mystr>

typedef _Mystr::const_pointer _String_const_iterator< _Mystr >::pointer

template<class _Mystr>

typedef _Mystr::const_reference _String_const_iterator< _Mystr >::reference

template<class _Mystr>

typedef _Mystr::value_type _String_const_iterator< _Mystr >::value_type

Constructor & Destructor Documentation

template<class _Mystr>

_String_const_iterator< _Mystr >::_String_const_iterator ( )

inline

        : _Ptr()
        {   // construct with null pointer
        }

template<class _Mystr>

_String_const_iterator< _Mystr >::_String_const_iterator ( pointer  _Parg, const _Container_base *  _Pstring  )

inline

        : _Ptr(_Parg)
        {   // construct with pointer _Parg
        this->_Adopt(_Pstring);
        }

Member Function Documentation

template<class _Mystr>

void _String_const_iterator< _Mystr >::_Compat ( const _Myiter &  ) const

inline

        {   // test for compatible iterator pair
        }

template<class _Mystr>

_Myiter& _String_const_iterator< _Mystr >::_Rechecked ( _Unchecked_type  _Right )

inline

        {   // reset from unchecked iterator
        _Ptr = _Right;
        return (*this);
        }

template<class _Mystr>

_Unchecked_type _String_const_iterator< _Mystr >::_Unchecked ( ) const

inline

        {   // make an unchecked iterator
        return (_Ptr);
        }

template<class _Mystr>

bool _String_const_iterator< _Mystr >::operator!= ( const _Myiter &  _Right ) const

inline

        {   // test for iterator inequality
        return (!(*this == _Right));
        }

template<class _Mystr>

reference _String_const_iterator< _Mystr >::operator* ( ) const

inline

        {   // return designated object
#if _ITERATOR_DEBUG_LEVEL >= 1
        _IDL_VERIFY(_Ptr, "cannot dereference value-initialized string iterator");
        const auto _Mycont = static_cast<const _Mystr *>(this->_Getcont());
        _IDL_VERIFY(_Mycont, "cannot dereference string iterator because the iterator was"
            " invalidated (e.g. reallocation occurred, or the string was destroyed)");
        const auto _Contptr = _Mycont->_Myptr();
        const auto _Rawptr = _Unfancy(_Ptr);
        _IDL_VERIFY(_Contptr <= _Rawptr && _Rawptr < _Contptr + _Mycont->_Mysize,
            "cannot dereference string iterator because it is out of range (e.g. an end iterator)");
#endif /* _ITERATOR_DEBUG_LEVEL >= 1 */

        _Analysis_assume_(_Ptr);
        return (*_Ptr);
        }

template<class _Mystr>

_Myiter _String_const_iterator< _Mystr >::operator+ ( const difference_type  _Off ) const

inline

        {   // return this + integer
        _Myiter _Tmp = *this;
        return (_Tmp += _Off);
        }

template<class _Mystr>

_Myiter& _String_const_iterator< _Mystr >::operator++ ( )

inline

        {   // preincrement
#if _ITERATOR_DEBUG_LEVEL >= 1
        _IDL_VERIFY(_Ptr, "cannot increment value-initialized string iterator");
        const auto _Mycont = static_cast<const _Mystr *>(this->_Getcont());
        _IDL_VERIFY(_Mycont, "cannot increment string iterator because the iterator was"
            " invalidated (e.g. reallocation occurred, or the string was destroyed)");
        _IDL_VERIFY(_Unfancy(_Ptr) < _Mycont->_Myptr() + _Mycont->_Mysize,
            "cannot increment string iterator past end");
#endif /* _ITERATOR_DEBUG_LEVEL >= 1 */

        ++_Ptr;
        return (*this);
        }

template<class _Mystr>

_Myiter _String_const_iterator< _Mystr >::operator++ ( int  )

inline

        {   // postincrement
        _Myiter _Tmp = *this;
        ++*this;
        return (_Tmp);
        }

template<class _Mystr>

_Myiter& _String_const_iterator< _Mystr >::operator+= ( const difference_type  _Off )

inline

        {   // increment by integer
#if _ITERATOR_DEBUG_LEVEL >= 1
        if (_Off != 0)
            {
            _IDL_VERIFY(_Ptr, "cannot seek value-initialized string iterator");
            const auto _Mycont = static_cast<const _Mystr *>(this->_Getcont());
            _IDL_VERIFY(_Mycont != 0, "cannot seek string iterator because the iterator was"
                " invalidated (e.g. reallocation occurred, or the string was destroyed)");
            const auto _Contptr = _Mycont->_Myptr();
            const auto _Rawptr = _Unfancy(_Ptr);
            _IDL_VERIFY(_Contptr <= _Rawptr + _Off, "cannot seek string iterator before begin");
            _IDL_VERIFY(_Rawptr + _Off <= _Contptr + _Mycont->_Mysize,
                "cannot seek string iterator past end");
            }
#endif /* _ITERATOR_DEBUG_LEVEL >= 1 */

        _Ptr += _Off;
        return (*this);
        }

template<class _Mystr>

_Myiter _String_const_iterator< _Mystr >::operator- ( const difference_type  _Off ) const

inline

        {   // return this - integer
        _Myiter _Tmp = *this;
        return (_Tmp -= _Off);
        }

template<class _Mystr>

difference_type _String_const_iterator< _Mystr >::operator- ( const _Myiter &  _Right ) const

inline

        {   // return difference of iterators
        _Compat(_Right);
        return (_Ptr - _Right._Ptr);
        }

template<class _Mystr>

_Myiter& _String_const_iterator< _Mystr >::operator-- ( )

inline

        {   // predecrement
#if _ITERATOR_DEBUG_LEVEL >= 1
        _IDL_VERIFY(_Ptr, "cannot decrement value-initialized string iterator");
        const auto _Mycont = static_cast<const _Mystr *>(this->_Getcont());
        _IDL_VERIFY(_Mycont, "cannot decrement string iterator because the iterator was"
            " invalidated (e.g. reallocation occurred, or the string was destroyed)");
        _IDL_VERIFY(_Mycont->_Myptr() < _Unfancy(_Ptr), "cannot decrement string iterator before begin");
#endif /* _ITERATOR_DEBUG_LEVEL >= 1 */

        --_Ptr;
        return (*this);
        }

template<class _Mystr>

_Myiter _String_const_iterator< _Mystr >::operator-- ( int  )

inline

        {   // postdecrement
        _Myiter _Tmp = *this;
        --*this;
        return (_Tmp);
        }

template<class _Mystr>

_Myiter& _String_const_iterator< _Mystr >::operator-= ( const difference_type  _Off )

inline

        {   // decrement by integer
        return (*this += -_Off);
        }

template<class _Mystr>

pointer _String_const_iterator< _Mystr >::operator-> ( ) const

inline

        {   // return pointer to class object
        return (pointer_traits<pointer>::pointer_to(**this));
        }

template<class _Mystr>

bool _String_const_iterator< _Mystr >::operator< ( const _Myiter &  _Right ) const

inline

        {   // test if this < _Right
        _Compat(_Right);
        return (_Ptr < _Right._Ptr);
        }

template<class _Mystr>

bool _String_const_iterator< _Mystr >::operator<= ( const _Myiter &  _Right ) const

inline

        {   // test if this <= _Right
        return (!(_Right < *this));
        }

template<class _Mystr>

bool _String_const_iterator< _Mystr >::operator== ( const _Myiter &  _Right ) const

inline

        {   // test for iterator equality
        _Compat(_Right);
        return (_Ptr == _Right._Ptr);
        }

template<class _Mystr>

bool _String_const_iterator< _Mystr >::operator> ( const _Myiter &  _Right ) const

inline

        {   // test if this > _Right
        return (_Right < *this);
        }

template<class _Mystr>

bool _String_const_iterator< _Mystr >::operator>= ( const _Myiter &  _Right ) const

inline

        {   // test if this >= _Right
        return (!(*this < _Right));
        }

template<class _Mystr>

reference _String_const_iterator< _Mystr >::operator[] ( const difference_type  _Off ) const

inline

        {   // subscript
        return (*(*this + _Off));
        }

Member Data Documentation

template<class _Mystr>

pointer _String_const_iterator< _Mystr >::_Ptr

---

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

• VS2017/inc/xstring