libstdc++
Public Types | Public Member Functions | List of all members
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > Class Template Reference
Regular Expressions

Public Types

typedef std::ptrdiff_t difference_type
 
typedef std::forward_iterator_tag iterator_category
 
typedef const value_type * pointer
 
typedef const value_type & reference
 
typedef basic_regex< _Ch_type,
_Rx_traits > 		regex_type
 
typedef sub_match< _Bi_iter > value_type
 

Public Member Functions

 regex_token_iterator ()
 
 regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, int __submatch=0, regex_constants::match_flag_type __m=regex_constants::match_default)
 
 regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, const std::vector< int > &__submatches, regex_constants::match_flag_type __m=regex_constants::match_default)
 
template<std::size_t _Nm>
 regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, const int(&__submatches)[_Nm], regex_constants::match_flag_type __m=regex_constants::match_default)
 
 regex_token_iterator (const regex_token_iterator &__rhs)
 
bool operator!= (const regex_token_iterator &__rhs)
 
const value_type & operator* ()
 
regex_token_iterator & operator++ ()
 
regex_token_iterator operator++ (int)
 
const value_type * operator-> ()
 
regex_token_iterator & operator= (const regex_token_iterator &__rhs)
 
bool operator== (const regex_token_iterator &__rhs)
 

Detailed Description

template<typename _Bi_iter, typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
class std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >

Iterates over submatches in a range (or splits a text string).

The purpose of this iterator is to enumerate all, or all specified, matches of a regular expression within a text range. The dereferenced value of an iterator of this class is a std::sub_match object.

Definition at line 2353 of file regex.h.

Constructor & Destructor Documentation

template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator ( )

Default constructs a regex_token_iterator.

Todo:
Implement this function.

A default-constructed regex_token_iterator is a singular iterator that will compare equal to the one-past-the-end value for any iterator of the same type.

template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator ( _Bi_iter  __a,
_Bi_iter  __b,
const regex_type &  __re,
int  __submatch = 0,
regex_constants::match_flag_type  __m = regex_constants::match_default 
)

Constructs a regex_token_iterator...

Parameters
a[IN] The start of the text to search.
b[IN] One-past-the-end of the text to search.
re[IN] The regular expression to search for.
submatch[IN] Which submatch to return. There are some special values for this parameter:
  • -1 each enumerated subexpression does NOT match the regular expression (aka field splitting)
  • 0 the entire string matching the subexpression is returned for each match within the text.
  • >0 enumerates only the indicated subexpression from a match within the text.
m[IN] Policy flags for match rules.
Todo:

Implement this function.

Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator ( _Bi_iter  __a,
_Bi_iter  __b,
const regex_type &  __re,
const std::vector< int > &  __submatches,
regex_constants::match_flag_type  __m = regex_constants::match_default 
)

Constructs a regex_token_iterator...

Parameters
a[IN] The start of the text to search.
b[IN] One-past-the-end of the text to search.
re[IN] The regular expression to search for.
submatches[IN] A list of subexpressions to return for each regular expression match within the text.
m[IN] Policy flags for match rules.
Todo:

Implement this function.

Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
template<std::size_t _Nm>
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator ( _Bi_iter  __a,
_Bi_iter  __b,
const regex_type &  __re,
const int(&)  __submatches[_Nm],
regex_constants::match_flag_type  __m = regex_constants::match_default 
)

Constructs a regex_token_iterator...

Parameters
a[IN] The start of the text to search.
b[IN] One-past-the-end of the text to search.
re[IN] The regular expression to search for.
submatches[IN] A list of subexpressions to return for each regular expression match within the text.
m[IN] Policy flags for match rules.
Todo:

Implement this function.

Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::regex_token_iterator ( const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > &  __rhs)

Copy constructs a regex_token_iterator.

Parameters
rhs[IN] A regex_token_iterator to copy.
Todo:
Implement this function.

Member Function Documentation

template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
bool std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator!= ( const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > &  __rhs)

Compares a regex_token_iterator to another for inequality.

Todo:
Implement this function.
template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
const value_type& std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator* ( )

Dereferences a regex_token_iterator.

Todo:
Implement this function.
template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
regex_token_iterator& std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator++ ( )

Increments a regex_token_iterator.

Todo:
Implement this function.
template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
regex_token_iterator std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator++ ( int  )

Postincrements a regex_token_iterator.

Todo:
Implement this function.
template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
const value_type* std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator-> ( )

Selects a regex_token_iterator member.

Todo:
Implement this function.
template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
regex_token_iterator& std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator= ( const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > &  __rhs)

Assigns a regex_token_iterator to another.

Parameters
rhs[IN] A regex_token_iterator to copy.
Todo:
Implement this function.
template<typename _Bi_iter , typename _Ch_type = typename iterator_traits<_Bi_iter>::value_type, typename _Rx_traits = regex_traits<_Ch_type>>
bool std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator== ( const regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > &  __rhs)

Compares a regex_token_iterator to another for equality.

Todo:
Implement this function.
The documentation for this class was generated from the following file: