STD::REGEX_TOKEN_ITERATOR(3cxx)

📦
version 14-20240412 · 20 versions
, in ubuntu noble

🌸 NAME 🌸

okay so this is the std::regex_tok...e, _Rx_traits >(3cxx) manual page, bestie, and the main character is std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >. Section 3cxx, C++ standard library, no cap. 💖

✨ SYNOPSIS ✨

#include <regex>

🎀 Public Types 🎀

  • typedef std::ptrdiff_t difference_type
  • typedef std::forward_iterator_tag iterator_category
  • typedef std::input_iterator_tag iterator_concept
  • 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 () — Default constructs a regex_token_iterator.
  • 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) — the _Nm-sized int array overload; parameter tea is below.
  • 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) — vector-of-submatch-indices overload; details below.
  • regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type &__re, initializer_list< int > __submatches, regex_constants::match_flag_type __m=regex_constants::match_default) — initializer-list overload; details below.
  • 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) — the one with a single int __submatch=0; details below.
  • template<std::size_t _Nm> regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, const int(&)[_Nm], regex_constants::match_flag_type=regex_constants::match_default)=delete — deleted rvalue-regex overload (=delete), so it's not callable.
  • regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, const std::vector< int > &, regex_constants::match_flag_type=regex_constants::match_default)=delete — deleted rvalue-regex overload.
  • regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, initializer_list< int >, regex_constants::match_flag_type=regex_constants::match_default)=delete — deleted rvalue-regex overload.
  • regex_token_iterator (_Bi_iter, _Bi_iter, const regex_type &&, int=0, regex_constants::match_flag_type=regex_constants::match_default)=delete — deleted rvalue-regex overload.
  • regex_token_iterator (const regex_token_iterator &__rhs) — Copy constructs a regex_token_iterator.
  • const value_type & operator* () const — Dereferences a regex_token_iterator.
  • regex_token_iterator & operator++ () — Increments a regex_token_iterator.
  • regex_token_iterator operator++ (int) — Postincrements a regex_token_iterator.
  • const value_type * operator-> () const — Selects a regex_token_iterator member.
  • regex_token_iterator & operator= (const regex_token_iterator &__rhs) — Assigns a regex_token_iterator to another.
  • bool operator== (const regex_token_iterator &__rhs) const — Compares a regex_token_iterator to another for equality.
  • bool operator== (default_sentinel_t) const noexcept — compares against default_sentinel_t; the docs give no extra description.

💖 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 docs literally start that description with >"Iterates over submatches in a range (or splits a text string). — the stray quote mark is canon, I'm not fixing it. 😭

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.

Since: C++11

🧚 Constructor & Destructor Documentation 🧚

regex_token_iterator ()

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 () [inline]

Default constructs a regex_token_iterator. 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. That's the vibe check: singular, but it matches the one-past-the-end energy. 💅

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)

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) [inline]

Constructs a regex_token_iterator... — yes, the docs really trail off with the ellipsis, and I respect it.

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.

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<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)
    [inline]

Constructs a regex_token_iterator... — ellipsis again, iconic.

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.

regex_token_iterator (_Bi_iter __a, _Bi_iter __b, const regex_type & __re, initializer_list< int > __submatches, regex_constants::match_flag_type __m = regex_constants::match_default)

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, initializer_list< int > __submatches,
    regex_constants::match_flag_type __m = regex_constants::match_default)
    [inline]

Constructs a regex_token_iterator... — the ellipsis stays, periodt.

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.

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)

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) [inline]

Constructs a regex_token_iterator... — the _Nm array girlies, we see you.

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.

regex_token_iterator (const regex_token_iterator & __rhs)

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) [inline]

Copy constructs a regex_token_iterator.

Parameters:

  • __rhs [IN] — A regex_token_iterator to copy.
heads up, bestie: the synopsis also lists four =deleted rvalue-regex constructors. They're up in Public Member Functions, and the detailed docs don't give them their own parameter descriptions.

💅 Member Function Documentation 💅

operator* () const

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* () const [inline]

Dereferences a regex_token_iterator. Obsessed with a one-liner that does exactly what it says. ✨

operator++ ()

template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits >
    regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > &
    std::regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits >::operator++
    ()

Increments a regex_token_iterator.

operator++ (int)

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) [inline]

Postincrements a regex_token_iterator.

operator-> () const

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-> () const [inline]

Selects a regex_token_iterator member.

operator= (const regex_token_iterator & __rhs)

template<typename _Bi_iter , typename _Ch_type , typename _Rx_traits >
    regex_token_iterator< _Bi_iter, _Ch_type, _Rx_traits > &
    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.

operator== (const regex_token_iterator & __rhs) const

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

Compares a regex_token_iterator to another for equality.

also in the synopsis: bool operator== (default_sentinel_t) const noexcept. The docs don't give it a separate detailed description, but it's there, bestie.

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. Slay, automation. 💜

footer vibe check: source/version is libstdc++ (the literal footer line is libstdstd::regex_tok...e, _Rx_traits >(3cxx)), and the date isn't printed on this page — so consider this entry undated, bestie. bye! 🦋💖

📦 where this page comes from