UtfString::Utf16String::iterator Class Reference

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

#include <Utf16String.h>

Inherits iterator< std::random_access_iterator_tag, Utf16Char >.

Public Member Functions
	iterator (std::basic_string< UInt16 > &basicString, const std::basic_string< UInt16 >::iterator &basicStringIterator)
	Constructs an iterator for Utf16String using the base class iterator. More...
	iterator (const Utf16String::iterator &otherIterator)
	Constructs an iterator for Utf16String using another iterator. More...
	iterator (const Utf16String::reverse_iterator &reverseIterator)
	Constructs an iterator for Utf16String using a reverse iterator. More...
	~iterator ()
	Cleans up before the iterator is destroyed.
iterator &	operator= (const Utf16String::iterator &otherIterator)
	Assigns the value of another iterator to this iterator. More...
bool	operator== (const iterator &otherIterator) const
	Compares this iterator with another iterator and tests for equality. More...
bool	operator!= (const iterator &otherIterator) const
	Compares this iterator with another iterator and tests for inequality. More...
bool	operator< (const 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 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 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 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...
iterator &	operator++ ()
	Increments this iterator to the next position in the Utf16String. More...
iterator	operator++ (int)
	Increments this iterator to the next position in the Utf16String. More...
iterator &	operator+= (size_t offset)
	Increments this iterator by a specific offset. More...
iterator	operator+ (size_t offset)
	Creates an iterator that has the position of this iterator incremented by a specific offset. More...
iterator &	operator-- ()
	Decrements this iterator to the previous position in the Utf16String. More...
iterator	operator-- (int)
	Decrements this iterator to the previous position in the Utf16String. More...
iterator &	operator-= (size_t offset)
	Decrements this iterator by a specific offset. More...
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 iterator. More...
Utf16CharReference *	operator-> ()
	Gets a pointer to the character at the position of this iterator. More...

Detailed Description

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

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

Constructor & Destructor Documentation

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

Constructs an iterator for Utf16String using the base class iterator.

This function assumes that basicStringIterator is a valid iterator

Parameters

[in]	basicString	A reference to the string that baseStringIterator points to
[in]	basicStringIterator	The base class iterator to use in constructing this iterator

UtfString::Utf16String::iterator::iterator

(

const Utf16String::iterator &

otherIterator)

Constructs an iterator for Utf16String using another iterator.

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

Parameters

[in]

otherIterator

The other iterator to use in constructing this iterator

UtfString::Utf16String::iterator::iterator

(

const Utf16String::reverse_iterator &

reverseIterator)

Constructs an iterator for Utf16String using a reverse iterator.

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

Parameters

[in]

reverseIterator

The reverse iterator to use in constructing this iterator

Member Function Documentation

bool UtfString::Utf16String::iterator::operator!=

(

const iterator &

otherIterator)

const

Compares this iterator with another iterator and tests for inequality.

Parameters

[in]

otherIterator

The other iterator to be compared with this iterator

Returns

false if otherIterator is pointing to the same position as this iterator, otherwise true

Utf16CharReference UtfString::Utf16String::iterator::operator*

(

)

Gets the character at the position of this iterator.

If this 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 iterator

iterator UtfString::Utf16String::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]

offset

The offset to be used when incrementing this position of this iterator

Returns

An iterator that points to the offset position

iterator& UtfString::Utf16String::iterator::operator++

(

)

Increments this iterator to the next position in the Utf16String.

This is the prefix operator.

Returns

A reference to this object after the position has been incremented

iterator UtfString::Utf16String::iterator::operator++

(

int

)

Increments this iterator to the next position in the Utf16String.

This is a postfix operator.

Returns

A copy of this object before the position was incremented

iterator& UtfString::Utf16String::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]

offset

The offset to use in incrementing this iterator

Returns

A reference to this iterator

iterator UtfString::Utf16String::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]

offset

The offset to use in decrementing the position of this iterator

Returns

An iterator that points to the offset position

iterator& UtfString::Utf16String::iterator::operator--

(

)

Decrements this iterator to the previous position in the Utf16String.

This is a prefix operator.

Returns

A reference to this object after the position has been decremented

iterator UtfString::Utf16String::iterator::operator--

(

int

)

Decrements this iterator to the previous position in the Utf16String.

This is a postfix operator.

Returns

A copy of this object before the position was decremented

iterator& UtfString::Utf16String::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]

offset

The offset to use in decrementing this iterator

Returns

A reference to this iterator

Utf16CharReference* UtfString::Utf16String::iterator::operator->

(

)

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

If this 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::iterator::operator<

(

const 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]

otherIterator

The 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::iterator::operator<=

(

const 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]

otherIterator

The 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

iterator& UtfString::Utf16String::iterator::operator=

(

const Utf16String::iterator &

otherIterator)

Assigns the value of another iterator to this iterator.

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

Parameters

[in]

otherIterator

The other iterator to be assigned to this iterator

Returns

A reference to this object after the assignment has been completed

bool UtfString::Utf16String::iterator::operator==

(

const iterator &

otherIterator)

const

Compares this iterator with another iterator and tests for equality.

Parameters

[in]

otherIterator

The other iterator to be compared with this iterator

Returns

true if otherIterator is pointing to the same position as this iterator, otherwise false

bool UtfString::Utf16String::iterator::operator>

(

const 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]

otherIterator

The 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::iterator::operator>=

(

const 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]

otherIterator

The 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:

• C:/Development/Libraries/UtfString/include/utfstring/Utf16String.h