Namensräume
Varianten
Aktionen

std::regex_search

Von cppreference.com
< cpp‎ | regex
 
 
 
Bibliothek für reguläre Ausdrücke
Klassen
(C++11)
Algorithmen
regex_search
(C++11)
Iteratoren
Ausnahmen
Traits
Konstanten
(C++11)
Reguläre Ausdrucksgrammatiken
 
Definiert 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) (seit 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 ();
(2) (seit C++11)
template< class CharT, class Alloc, class Traits >

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

                       std::regex_constants::match_default ();
(3) (seit 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 ();
(4) (seit 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 ();
(5) (seit 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) (seit C++11)
template< class STraits, class SAlloc, class Alloc,

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

          std::regex_constants::match_default ) = delete;
(7) (seit C++11)

Ermittelt, ob eine Übereinstimmung zwischen dem regulären Ausdruck e und einer Untersequenz der Zielzeichensequenz besteht. Das detaillierte Übereinstimmungsergebnis wird in m gespeichert (sofern vorhanden).

1,2) Die Zielzeichensequenz wird durch den Bereich [firstlast) dargestellt.

Wenn BidirIt nicht die Anforderungen an einen LegacyBidirectionalIterator erfüllt, ist das Verhalten undefiniert.

(bis C++23)

Wenn BidirIt keinen bidirectional_iterator modelliert, ist das Verhalten undefiniert.

(seit C++23)
3,4) Die Zielzeichensequenz wird durch den Bereich [strstr + std::char_traits<CharT>::length(str)) dargestellt.
5,6) Die Zielzeichensequenz wird durch die Zeichenkette s dargestellt.
7) Die Zielzeichensequenz kann nicht durch einen std::string-Rvalue dargestellt werden.

Wenn keine Übereinstimmung existiert, sollten die folgenden Ausdrücke, die m (falls vorhanden) betreffen, die angegebenen Werte liefern:

 Ausdruck   Wert 
m.ready() true
m.size() 0
m.empty() true

Wenn eine Übereinstimmung existiert, dann liefern für jede der unten aufgeführten Überladungen die folgenden Ausdrücke, die m betreffen, wobei n eine beliebige Ganzzahl im Bereich (0m.size()) ist, die angegebenen Werte:

      Ausdruck       Wert
           Überladung (1)                       Überladung (3)                       Überladung (5)           
m.ready() true
m.size() 1 + e.mark_count()
m.empty() false
m.prefix().first first str s.begin()
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 std::char_traits<CharT>::
    length(str) + str
s.end()
m.suffix().matched m.suffix().first != m.suffix().second
m[0].first Der Anfang der Sequenz, die mit e übereinstimmt
m[0].second Das Ende der Sequenz, die mit e übereinstimmt
m[0].matched true
m[n].first
  • last, wenn die markierte Unterausdruck n nicht an der Übereinstimmung teilgenommen hat
  • Der Anfang der Sequenz, die sonst dem Unterausdruck n entspricht, andernfalls
m[n].second
  • last, wenn die markierte Unterausdruck n nicht an der Übereinstimmung teilgenommen hat
  • Das Ende der Sequenz, die sonst dem Unterausdruck n entspricht, andernfalls
m[n].matched

Inhalt

[edit] Parameter

first, last - der Zielzeichenkettenbereich
str - die nullterminierte C-Style-Zeichenkette
s - die Ziel-std::basic_string
m - die Übereinstimmungsergebnisse
e - der reguläre Ausdruck
flags - Flags, die bestimmen, wie der Abgleich durchgeführt werden soll

[edit] Rückgabewert

Gibt true zurück, wenn eine Übereinstimmung besteht, andernfalls false.

[edit] Anmerkungen

Um alle Übereinstimmungen innerhalb der Zielsequenz zu untersuchen, kann std::regex_search in einer Schleife aufgerufen werden, die jedes Mal ab m[0].second des vorherigen Aufrufs neu gestartet wird. std::regex_iterator bietet eine einfache Schnittstelle für diese Iteration.

[edit] Beispiel

#include <cstddef>
#include <iostream>
#include <regex>
#include <string>
 
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})");
 
    // simple match
    for (const auto& line : lines)
        std::cout << line << ": " << std::boolalpha
                  << std::regex_search(line, color_regex) << '\n';
    std::cout << '\n';
 
    // show contents of marked subexpressions within each match
    std::smatch color_match;
    for (const auto& line : lines)
        if (std::regex_search(line, color_match, color_regex))
        {
            std::cout << "matches for '" << line << "'\n";
            std::cout << "Prefix: '" << color_match.prefix() << "'\n";
            for (std::size_t i = 0; i < color_match.size(); ++i) 
                std::cout << i << ": " << color_match[i] << '\n';
            std::cout << "Suffix: '" << color_match.suffix() << "\'\n\n";
        }
 
    // repeated search (see also std::regex_iterator)
    std::string log(R"(
        Speed:	366
        Mass:	35
        Speed:	378
        Mass:	32
        Speed:	400
	Mass:	30)");
    std::regex r(R"(Speed:\t\d*)");
    for (std::smatch sm; regex_search(log, sm, r);)
    {
        std::cout << sm.str() << '\n';
        log = sm.suffix();
    }
 
    // C-style string demo
    std::cmatch cm;
    if (std::regex_search("this is a test", cm, std::regex("test"))) 
        std::cout << "\nFound " << cm[0] << " at position "
                  << cm.prefix().length() << '\n';
}

Ausgabe

Roses are #ff0000: true
violets are #0000ff: true
all of my base are belong to you: false
 
matches for 'Roses are #ff0000'
Prefix: 'Roses are '
0: #ff0000
1: ff
2: 00
3: 00
Suffix: ''
 
matches for 'violets are #0000ff'
Prefix: 'violets are '
0: #0000ff
1: 00
2: 00
3: ff
Suffix: ''
 
Speed:	366
Speed:	378
Speed:	400
 
Found test at position 10

[edit] Fehlerberichte

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR angewendet auf Verhalten wie veröffentlicht Korrigiertes Verhalten
LWG 2205 C++11 n könnte im Nachzustand Null sein kann nur positiv sein
LWG 2329 C++11 Überladung (5) akzeptierte basic_string-Rvalues,
was zu hängenden Iteratoren führen könnte
abgelehnt durch gelöschte Überladung (7)

[edit] Siehe auch

Objekt für reguläre Ausdrücke
(Klassenvorlage) [bearbeiten]
identifiziert eine Übereinstimmung eines regulären Ausdrucks, einschließlich aller Übereinstimmungen von Unterausdrücken
(Klassenvorlage) [bearbeiten]
versucht, einen regulären Ausdruck an eine gesamte Zeichensequenz anzupassen
(Funktionsvorlage) [bearbeiten]