Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/regex/regex search"

From cppreference.com
< cpp‎ | regex
(fixed typo: express -> expression)
m (Use since= and until= params of {{dcl}} template.)
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header | regex}}
 
{{dcl header | regex}}
−
{{dcl | num=1 | notes={{mark since c++11}} | 1=
+
{{dcl | num=1 | since=c++11 | 1=
 
template< class BidirIt,  
 
template< class BidirIt,  
 
           class Alloc, class CharT, class Traits >
 
           class Alloc, class CharT, class Traits >
Line 12: Line 12:
 
                       std::regex_constants::match_default );
 
                       std::regex_constants::match_default );
 
}}
 
}}
−
{{dcl | num=2 | notes={{mark since c++11}} | 1=
+
{{dcl | num=2 | since=c++11 | 1=
 
template< class Alloc, class CharT, class Traits >
 
template< class Alloc, class CharT, class Traits >
 
bool regex_search( const CharT* str,
 
bool regex_search( const CharT* str,
Line 20: Line 20:
 
                       std::regex_constants::match_default );
 
                       std::regex_constants::match_default );
 
}}
 
}}
−
{{dcl | num=3 | notes={{mark since c++11}} | 1=
+
{{dcl | num=3 | since=c++11 | 1=
 
template< class STraits, class SAlloc,
 
template< class STraits, class SAlloc,
 
           class Alloc, class CharT, class Traits >
 
           class Alloc, class CharT, class Traits >
Line 32: Line 32:
 
                       std::regex_constants::match_default );
 
                       std::regex_constants::match_default );
 
}}
 
}}
−
{{dcl | num=4 | notes={{mark since c++11}} | 1=
+
{{dcl | num=4 | since=c++11 | 1=
 
template< class BidirIt,
 
template< class BidirIt,
 
           class CharT, class Traits >
 
           class CharT, class Traits >
Line 40: Line 40:
 
                       std::regex_constants::match_default );
 
                       std::regex_constants::match_default );
 
}}
 
}}
−
{{dcl | num=5 | notes={{mark since c++11}} | 1=
+
{{dcl | num=5 | since=c++11 | 1=
 
template< class CharT, class Traits >
 
template< class CharT, class Traits >
 
bool regex_search( const CharT* str,
 
bool regex_search( const CharT* str,
Line 47: Line 47:
 
                       std::regex_constants::match_default );
 
                       std::regex_constants::match_default );
 
}}
 
}}
−
{{dcl | num=6 | notes={{mark since c++11}} | 1=
+
{{dcl | num=6 | since=c++11 | 1=
 
template< class STraits, class SAlloc,
 
template< class STraits, class SAlloc,
 
           class CharT, class Traits >
 
           class CharT, class Traits >

Revision as of 15:46, 1 July 2013

 
C++
 
Regular expressions library
Classes
(C++11)
(C++11)
(C++11)
Algorithms
(C++11)
regex_search
(C++11)
(C++11)
Iterators
(C++11)
(C++11)
Exceptions
(C++11)
Traits
(C++11)
Constants
(C++11)
(C++11)
(C++11)
Regex Grammar
(C++11)
 
Defined in header <regex>
template< class BidirIt,

          class Alloc, class CharT, class Traits >
bool regex_search( BidirIt first, BidirIt last,
                   std::match_results<BidirIt,Alloc>& m,
                   const std::basic_regex<CharT,Traits>& e,
                   std::regex_constants::match_flag_type flags =

                       std::regex_constants::match_default );
 (1) (since C++11)
template< class Alloc, class CharT, class Traits >

bool regex_search( const CharT* str,
                   std::match_results<BidirIt,Alloc>& m,
                   const std::basic_regex<CharT,Traits>& e,
                   std::regex_constants::match_flag_type flags =

                       std::regex_constants::match_default );
 (2) (since C++11)
template< class STraits, class SAlloc,

          class Alloc, class CharT, class Traits >
bool regex_search( const std::basic_string<CharT,STraits,SAlloc>& s,
                   std::match_results<
                       typename std::basic_string<CharT,STraits,SAlloc>::const_iterator,
                       Alloc
                   >& m,
                   const std::basic_regex<CharT, Traits>& e,
                   std::regex_constants::match_flag_type flags =

                       std::regex_constants::match_default );
 (3) (since C++11)
template< class BidirIt,

          class CharT, class Traits >
bool regex_search( BidirIt first, BidirIt last,
                   const std::basic_regex<CharT,Traits>& e,
                   std::regex_constants::match_flag_type flags =

                       std::regex_constants::match_default );
 (4) (since C++11)
template< class CharT, class Traits >

bool regex_search( const CharT* str,
                   const std::basic_regex<CharT,Traits>& e,
                   std::regex_constants::match_flag_type flags =

                       std::regex_constants::match_default );
 (5) (since C++11)
template< class STraits, class SAlloc,

          class CharT, class Traits >
bool regex_search( const std::basic_string<CharT,STraits,SAlloc>& s,
                   const std::basic_regex<CharT,Traits>& e,
                   std::regex_constants::match_flag_type flags =

                       std::regex_constants::match_default );
 (6) (since C++11)

Determines if there is a match between the regular expression e and some subsequence in the target character sequence.

1) Analyzes generic range [first,last). Match results are returned in m.
2) Analyzes a null-terminates string pointed to by str. Match results are returned in m.
3) Analyzes a string s. Match results are returned in m.
4-6) Equivalent to (1-3), just omits the match results.

regex_search will successfully match any subsequence of the given sequence, whereas std::regex_match will only return true if the regular expression matches the entire sequence.

Contents

Parameters

first, last - a range identifying the target character sequence
str - a pointer to a null-terminated target character sequence
s - a string identifying target character sequence
e - the std::regex that should be applied to the target character sequence
m - the match results
flags - std::regex_constants::match_flag_type governing search behavior
Type requirements

Template:par req concept Template:par req concept

Return value

Returns true if a match exists, false otherwise. In either case, the object m is updated, as follows:

If the match does not exist:

m.ready() == true
m.empty() == true
m.size() == 0

If the match exists:

m.ready() true
m.empty() false
m.size() number of subexpressions plus 1, that is, 1+e.mark_count()
m.prefix().first first
m.prefix().second m[0].first
m.prefix().matched m.prefix().first != m.prefix().second
m.suffix().first m[0].second
m.suffix().second last
m.suffix().matched m.suffix().first != m.suffix().second
m[0].first the start of the matching sequence
m[0].second the end of the matching sequence
m[0].matched true if a match was found, false otherwise
m[n].first the start of the sequence that matched sub-expression n, or last if the subexpression did not participate in the match
m[n].second the end of the sequence that matched sub-expression n, or last if the subexpression did not participate in the match
m[n].matched true if sub-expression n participated in the match, false otherwise

Example

Run this code
#include <iostream>
#include <string>
#include <regex>
 
int main()
{
    std::string lines[] = {"Roses are #ff0000",
                           "violets are #0000ff",
                           "all of my base are belong to you"};
 
    std::regex color_regex("#([a-f0-9]{2})"
                            "([a-f0-9]{2})"
                            "([a-f0-9]{2})");
 
    for (const auto &line : lines) {
        std::cout << line << ": " 
                  << std::regex_search(line, color_regex) << '\n';
    }   
 
    std::smatch color_match;
    for (const auto &line : lines) {
        std::regex_search(line, color_match, color_regex);
        std::cout << "matches for '" << line << "'\n";
        for (size_t i = 0; i < color_match.size(); ++i) {
            std::ssub_match sub_match = color_match[i];
            std::string sub_match_str = sub_match.str();
            std::cout << i << ": " << sub_match_str << '\n';
        }   
    }   
}

Output: 

Roses are #ff0000: 1
violets are #0000ff: 1
all of my base are belong to you: 0
matches for 'Roses are #ff0000'
0: #ff0000
1: ff
2: 00
3: 00
matches for 'violets are #0000ff'
0: #0000ff
1: 00
2: 00
3: ff
matches for 'all of my base are belong to you'

See also

(C++11)
 regular expression object
(class template) [edit]
(C++11)
 identifies one regular expression match, including all sub-expression matches
(class template) [edit]
(C++11)
 attempts to match a regular expression to an entire character sequence
(function template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/regex/regex_search&oldid=62935"