libstdc++
std::sub_match Class Reference
Inheritance diagram for std::sub_match:

List of all members.

Public Types

Public Member Functions

Public Attributes


Detailed Description

A sequence of characters matched by a particular marked sub-expression.

An object of this class is essentially a pair of iterators marking a matched subexpression within a regular expression pattern match. Such objects can be converted to and compared with std::basic_string objects of a similar base character type as the pattern matched by the regular expression.

The iterators that make up the pair are the usual half-open interval referencing the actual original pattern matched.


Member Typedef Documentation

typedef _T2 std::pair::second_type [inherited]

first_type is the first bound type

Definition at line 90 of file stl_pair.h.


Member Function Documentation

int std::sub_match::compare ( const sub_match __s) const [inline]

Compares this and another matched sequence.

Parameters:
sAnother matched sequence to compare to this one.
Return values:
<0this matched sequence will collate before s.
=0this matched sequence is equivalent to s.
<0this matched sequence will collate after s.

Definition at line 818 of file regex.h.

Referenced by std::operator<(), std::operator<=(), and std::operator==().

int std::sub_match::compare ( const string_type __s) const [inline]

Compares this sub_match to a string.

Parameters:
sA string to compare to this sub_match.
Return values:
<0this matched sequence will collate before s.
=0this matched sequence is equivalent to s.
<0this matched sequence will collate after s.

Definition at line 831 of file regex.h.

int std::sub_match::compare ( const value_type *  __s) const [inline]

Compares this sub_match to a C-style string.

Parameters:
sA C-style string to compare to this sub_match.
Return values:
<0this matched sequence will collate before s.
=0this matched sequence is equivalent to s.
<0this matched sequence will collate after s.

Definition at line 844 of file regex.h.

difference_type std::sub_match::length ( ) const [inline]

Gets the length of the matching sequence.

Definition at line 775 of file regex.h.

std::sub_match::operator string_type ( ) const [inline]

Gets the matching sequence as a string.

Returns:
the matching sequence as a string.

This is the implicit conversion operator. It is identical to the str() member function except that it will want to pop up in unexpected places and cause a great deal of confusion and cursing from the unwary.

Definition at line 788 of file regex.h.

string_type std::sub_match::str ( ) const [inline]

Gets the matching sequence as a string.

Returns:
the matching sequence as a string.

Definition at line 801 of file regex.h.

Referenced by std::sub_match< _Bi_iter >::compare(), and std::operator<<().


Member Data Documentation

_T1 std::pair::first [inherited]

second_type is the second bound type

Definition at line 92 of file stl_pair.h.

Referenced by std::sub_match< _Bi_iter >::length(), std::sub_match< _Bi_iter >::operator string_type(), and std::sub_match< _Bi_iter >::str().

_T2 std::pair::second [inherited]

first is a copy of the first object

Definition at line 93 of file stl_pair.h.

Referenced by std::sub_match< _Bi_iter >::length(), std::sub_match< _Bi_iter >::operator string_type(), and std::sub_match< _Bi_iter >::str().


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