utf8::iterator Class Reference

#include <stdTools.hpp>

Public Member Functions

 iterator ()
 
 iterator (std::string &_str)
 
 iterator (std::string &_str, const std::string::iterator &_pos)
 
 iterator (std::string &_str, size_t _pos)
 
 iterator (std::string *_str, const std::string::iterator &_pos)
 
 iterator (std::string *_str, size_t _pos)
 
 iterator (const iterator &_obj)
 
iteratoroperator= (const iterator &_obj)
 
virtual ~iterator ()
 
 operator size_t () const
 
iteratoroperator++ ()
 
iteratoroperator-- ()
 
iterator operator++ (int32_t)
 
iterator operator-- (int32_t)
 
bool operator== (const iterator &_obj) const
 
bool operator!= (const iterator &_obj) const
 
bool operator<= (const iterator &_obj) const
 
bool operator>= (const iterator &_obj) const
 
bool operator< (const iterator &_obj) const
 
bool operator> (const iterator &_obj) const
 
char32_t operator* ()
 
size_t getPos () const
 
iterator operator+ (const int64_t _val) const
 
iterator operator+ (const int32_t _val) const
 
iterator operator+ (const size_t _val) const
 
iterator operator- (const int64_t _val) const
 
iterator operator- (const int32_t _val) const
 
iterator operator- (const size_t _val) const
 

Detailed Description

Iterator on a simple std::string that contain utf8 value.

Constructor & Destructor Documentation

§ iterator() [1/7]

utf8::iterator::iterator ( )
inline

Basic constructor that is not link on a string.

§ iterator() [2/7]

utf8::iterator::iterator ( std::string &  _str)
inline

Basic begin constructor link at the start of the string.

Parameters
[in]_strreference on the string to inspect.

§ iterator() [3/7]

utf8::iterator::iterator ( std::string &  _str,
const std::string::iterator &  _pos 
)
inline

Basic position constructor link at the _pos position of the string.

Parameters
[in]_strreference on the string to inspect.
[in]_posIterator position on the string.

§ iterator() [4/7]

utf8::iterator::iterator ( std::string &  _str,
size_t  _pos 
)
inline

Basic position constructor link at the _pos position of the string.

Parameters
[in]_strreference on the string to inspect.
[in]_posPosition on the string (in AINSI value).

§ iterator() [5/7]

utf8::iterator::iterator ( std::string *  _str,
const std::string::iterator &  _pos 
)
inline

Basic position constructor link at the _pos position of the string.

Parameters
[in]_strPointer on the string to inspect.
[in]_posIterator position on the string.

§ iterator() [6/7]

utf8::iterator::iterator ( std::string *  _str,
size_t  _pos 
)
inline

Basic position constructor link at the _pos position of the string.

Parameters
[in]_strPointer on the string to inspect.
[in]_posPosition on the string (in AINSI value).

§ iterator() [7/7]

utf8::iterator::iterator ( const iterator _obj)
inline

Recopy constructor.

Parameters
[in]_objThe Iterator that might be copy

§ ~iterator()

virtual utf8::iterator::~iterator ( )
inlinevirtual

Basic destructor.

Member Function Documentation

§ getPos()

size_t utf8::iterator::getPos ( ) const
inline

Get the position in the buffer.

Returns
The requested position.

§ operator size_t()

utf8::iterator::operator size_t ( ) const
inline

basic boolean cast

Returns
true if the element is present in buffer

§ operator!=()

bool utf8::iterator::operator!= ( const iterator _obj) const
inline

egality iterator

Parameters
[in]_objIterator to compare
Returns
true if the iterator is identical pos

§ operator*()

char32_t utf8::iterator::operator* ( )

Get the value on the current element.

Returns
The request element value

§ operator+() [1/3]

iterator utf8::iterator::operator+ ( const int64_t  _val) const
inline

move the element position

Parameters
[in]_valValue to add on the Iterator
Returns
a new iterator.

§ operator+() [2/3]

iterator utf8::iterator::operator+ ( const int32_t  _val) const
inline

move the element position (const int64_t)

Parameters
[in]_valValue to add on the Iterator
Returns
a new iterator. (const int64_t)

§ operator+() [3/3]

iterator utf8::iterator::operator+ ( const size_t  _val) const
inline

move the element position (const int64_t)

Parameters
[in]_valValue to add on the Iterator
Returns
a new iterator. (const int64_t)

§ operator++() [1/2]

iterator& utf8::iterator::operator++ ( )

Incremental operator.

Returns
Reference on the current iterator incremented

§ operator++() [2/2]

iterator utf8::iterator::operator++ ( int32_t  )
inline

Incremental operator.

Returns
Reference on a new iterator and increment the other one

§ operator-() [1/3]

iterator utf8::iterator::operator- ( const int64_t  _val) const
inline

move the element position

Parameters
[in]_valValue to remove on the Iterator
Returns
a new iterator.

§ operator-() [2/3]

iterator utf8::iterator::operator- ( const int32_t  _val) const
inline

move the element position (const int64_t)

Parameters
[in]_valValue to remove on the Iterator
Returns
a new iterator. (const int64_t)

§ operator-() [3/3]

iterator utf8::iterator::operator- ( const size_t  _val) const
inline

move the element position (const int64_t)

Parameters
[in]_valValue to remove on the Iterator
Returns
a new iterator. (const int64_t)

§ operator--() [1/2]

iterator& utf8::iterator::operator-- ( )

Decremental operator.

Returns
Reference on the current iterator decremented

§ operator--() [2/2]

iterator utf8::iterator::operator-- ( int32_t  )
inline

Decremental operator.

Returns
Reference on a new iterator and decrement the other one

§ operator<()

bool utf8::iterator::operator< ( const iterator _obj) const
inline

< iterator

Parameters
[in]_objIterator to compare
Returns
true if the iterator is identical pos

§ operator<=()

bool utf8::iterator::operator<= ( const iterator _obj) const
inline

<= iterator

Parameters
[in]_objIterator to compare
Returns
true if the iterator is identical pos

§ operator=()

iterator& utf8::iterator::operator= ( const iterator _obj)
inline

Asignation operator.

Parameters
[in]_objThe Iterator that might be copy
Returns
reference on the curent Iterator

§ operator==()

bool utf8::iterator::operator== ( const iterator _obj) const
inline

egality iterator

Parameters
[in]_objIterator to compare
Returns
true if the iterator is identical pos

§ operator>()

bool utf8::iterator::operator> ( const iterator _obj) const
inline

iterator

Parameters
[in]_objIterator to compare
Returns
true if the iterator is identical pos

§ operator>=()

bool utf8::iterator::operator>= ( const iterator _obj) const
inline

>= iterator

Parameters
[in]_objIterator to compare
Returns
true if the iterator is identical pos

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