UtfString
Public Member Functions | List of all members
UtfString::Utf16String::reverse_iterator Class Reference

An iterator that iterates through the code points in a UTF-16 string in reverse order. More...

#include <Utf16String.h>

Inherits iterator< std::random_access_iterator_tag, Utf16Char >.

Public Member Functions

 reverse_iterator (std::basic_string< UInt16 > &basicString, const std::basic_string< UInt16 >::reverse_iterator &basicStringIterator)
 Constructs a reverse iterator for Utf16String using the base class iterator. More...
 
 reverse_iterator (const Utf16String::reverse_iterator &otherIterator)
 Constructs a reverse iterator for Utf16String using another iterator. More...
 
 reverse_iterator (const Utf16String::iterator &iterator)
 Constructs a reverse iterator for Utf16String using an iterator. More...
 
reverse_iteratoroperator= (const Utf16String::reverse_iterator &otherIterator)
 Assigns the value of another reverse iterator to this reverse iterator. More...
 
 ~reverse_iterator ()
 Cleans up before the iterator is destroyed.
 
bool operator== (const reverse_iterator &otherIterator) const
 Compares this reverse iterator with another reverse iterator and tests for equality. More...
 
bool operator!= (const reverse_iterator &otherIterator) const
 Compares this reverse iterator with another reverse iterator and tests for inequality. More...
 
bool operator< (const reverse_iterator &otherIterator)
 Compares this iterator to another iterator and tests whether this iterator comes before the other iterator in the string. More...
 
bool operator<= (const reverse_iterator &otherIterator)
 Compares this iterator to another iterator and tests whether this iterator comes before or is at the same position the other iterator in the string. More...
 
bool operator> (const reverse_iterator &otherIterator)
 Compares this iterator to another iterator and tests whether this iterator comes after the other iterator in the string. More...
 
bool operator>= (const reverse_iterator &otherIterator)
 Compares this iterator to another iterator and tests whether this iterator comes after or is at the same position the other iterator in the string. More...
 
reverse_iteratoroperator++ ()
 Increments this reverse iterator to the previous position in the Utf16String. More...
 
reverse_iterator operator++ (int)
 Increments this reverse iterator to the previous position in the Utf16String. More...
 
reverse_iteratoroperator+= (size_t offset)
 Increments this iterator by a specific offset. More...
 
reverse_iterator operator+ (size_t offset)
 Creates an iterator that has the position of this iterator incremented by a specific offset. More...
 
reverse_iteratoroperator-- ()
 Decrements this reverse iterator to the next position in the Utf16String. More...
 
reverse_iterator operator-- (int)
 Decrements this reverse iterator to the next position in the Utf16String. More...
 
reverse_iteratoroperator-= (size_t offset)
 Decrements this iterator by a specific offset. More...
 
reverse_iterator operator- (size_t offset)
 Creates an iterator that has the position of this iterator decremented by a specific offset. More...
 
Utf16CharReference operator* ()
 Gets the character at the position of this reverse iterator. More...
 
Utf16CharReferenceoperator-> ()
 Gets a pointer to the character at the position of this reverse iterator. More...
 

Detailed Description

An iterator that iterates through the code points in a UTF-16 string in reverse order.

This iterator assumes that the UTF-16 string being iterated over is a valid UTF-16 string.

Constructor & Destructor Documentation

UtfString::Utf16String::reverse_iterator::reverse_iterator ( std::basic_string< UInt16 > &  basicString,
const std::basic_string< UInt16 >::reverse_iterator basicStringIterator 
)

Constructs a reverse iterator for Utf16String using the base class iterator.

This function assumes that basicStringIterator is a valid reverse iterator

Parameters
[in]basicStringA reference to the string that baseStringIterator points to
[in]basicStringIteratorThe base class reverse iterator to use in constructing this iterator
UtfString::Utf16String::reverse_iterator::reverse_iterator ( const Utf16String::reverse_iterator otherIterator)

Constructs a reverse iterator for Utf16String using another iterator.

This iterator will take on the same characteristics and position as the other iterator

Parameters
[in]otherIteratorThe other reverse iterator to use in constructing this reverse iterator
UtfString::Utf16String::reverse_iterator::reverse_iterator ( const Utf16String::iterator iterator)

Constructs a reverse iterator for Utf16String using an iterator.

This reverse iterator will take on the same position as the iterator.

Parameters
[in]iteratorThe iterator to use in constructing this reverse iterator

Member Function Documentation

bool UtfString::Utf16String::reverse_iterator::operator!= ( const reverse_iterator otherIterator) const

Compares this reverse iterator with another reverse iterator and tests for inequality.

Parameters
[in]otherIteratorThe other reverse iterator to be compared with this reverse iterator
Returns
false if otherIterator is pointing to the same position as this reverse iterator, otherwise true
Utf16CharReference UtfString::Utf16String::reverse_iterator::operator* ( )

Gets the character at the position of this reverse iterator.

If this reverse iterator is not pointing to a position in a Utf16String, the result will be undefined.

The reference returned by this function will be invalidated if the iterator is changed in any way. Changing the value of the returned object will not change the string.

Returns
A reference to the the character being pointed to by this reverse iterator
reverse_iterator UtfString::Utf16String::reverse_iterator::operator+ ( size_t  offset)

Creates an iterator that has the position of this iterator incremented by a specific offset.

Note that since a UTF-16 string contains variable-width characters, we have to iterate over the code units. As a result, this operator has a performance of O(N). Hence, this operator should be used with care.

Parameters
[in]offsetThe offset to be used when incrementing this position of this iterator
Returns
An iterator that points to the offset position
reverse_iterator& UtfString::Utf16String::reverse_iterator::operator++ ( )

Increments this reverse iterator to the previous position in the Utf16String.

This is the prefix operator.

Returns
A reference to this object after the position has been incremented
reverse_iterator UtfString::Utf16String::reverse_iterator::operator++ ( int  )

Increments this reverse iterator to the previous position in the Utf16String.

This is a postfix operator.

Returns
A copy of this object before the position was incremented
reverse_iterator& UtfString::Utf16String::reverse_iterator::operator+= ( size_t  offset)

Increments this iterator by a specific offset.

Note that since a UTF-16 string contains variable-width characters, we have to iterate over the code units. As a result, this operator has a performance of O(N). Hence, this operator should be used with care.

Parameters
[in]offsetThe offset to use in incrementing this iterator
Returns
A reference to this iterator
reverse_iterator UtfString::Utf16String::reverse_iterator::operator- ( size_t  offset)

Creates an iterator that has the position of this iterator decremented by a specific offset.

Note that since a UTF-16 string contains variable-width characters, we have to iterate over the code units. As a result, this operator has a performance of O(N). Hence, this operator should be used with care.

Parameters
[in]offsetThe offset to use in decrementing the position of this iterator
Returns
An iterator that points to the offset position
reverse_iterator& UtfString::Utf16String::reverse_iterator::operator-- ( )

Decrements this reverse iterator to the next position in the Utf16String.

This is a prefix operator.

Returns
A reference to this object after the position has been decremented
reverse_iterator UtfString::Utf16String::reverse_iterator::operator-- ( int  )

Decrements this reverse iterator to the next position in the Utf16String.

This is a postfix operator.

Returns
A copy of this object before the position was decremented
reverse_iterator& UtfString::Utf16String::reverse_iterator::operator-= ( size_t  offset)

Decrements this iterator by a specific offset.

Note that since a UTF-16 string contains variable-width characters, we have to iterate over the code units. As a result, this operator has a performance of O(N). Hence, this operator should be used with care.

Parameters
[in]offsetThe offset to use in decrementing this iterator
Returns
A reference to this iterator
Utf16CharReference* UtfString::Utf16String::reverse_iterator::operator-> ( )

Gets a pointer to the character at the position of this reverse iterator.

If this reverse iterator is not pointing to a position in a Utf16String, the result will be undefined.

The pointer returned by this function will be invalidated if the iterator is changed in any way.

Returns
A pointer to the character being pointed to by this iterator
bool UtfString::Utf16String::reverse_iterator::operator< ( const reverse_iterator otherIterator)

Compares this iterator to another iterator and tests whether this iterator comes before the other iterator in the string.

This operator has a performance of O(1).

Parameters
[in]otherIteratorThe other iterator to be compared with this iterator
Returns
true if this iterator comes before the other iterator in a string, otherwise false
bool UtfString::Utf16String::reverse_iterator::operator<= ( const reverse_iterator otherIterator)

Compares this iterator to another iterator and tests whether this iterator comes before or is at the same position the other iterator in the string.

This operator has a performance of O(1).

Parameters
[in]otherIteratorThe other iterator to be compared with this iterator
Returns
true if this iterator comes before or is at the same position the other iterator in a string, otherwise false
reverse_iterator& UtfString::Utf16String::reverse_iterator::operator= ( const Utf16String::reverse_iterator otherIterator)

Assigns the value of another reverse iterator to this reverse iterator.

This reverse iterator will take on the same characteristics and position as the other reverse iterator

Parameters
[in]otherIteratorThe other reverse iterator to be assigned to this reverse iterator
Returns
A reference to this object after the assignment has been completed
bool UtfString::Utf16String::reverse_iterator::operator== ( const reverse_iterator otherIterator) const

Compares this reverse iterator with another reverse iterator and tests for equality.

Parameters
[in]otherIteratorThe other reverse iterator to be compared with this reverse iterator
Returns
true if otherIterator is pointing to the same position as this reverse iterator, otherwise false
bool UtfString::Utf16String::reverse_iterator::operator> ( const reverse_iterator otherIterator)

Compares this iterator to another iterator and tests whether this iterator comes after the other iterator in the string.

This operator has a performance of O(1).

Parameters
[in]otherIteratorThe other iterator to be compared with this iterator
Returns
true if this iterator comes after the other iterator in a string, otherwise false
bool UtfString::Utf16String::reverse_iterator::operator>= ( const reverse_iterator otherIterator)

Compares this iterator to another iterator and tests whether this iterator comes after or is at the same position the other iterator in the string.

This operator has a performance of O(1).

Parameters
[in]otherIteratorThe other iterator to be compared with this iterator
Returns
true if this iterator comes after or is at the same position the other iterator in a string, otherwise false

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