32 Regular expressions library [re]

32.7 Class template basic_regex [re.regex]

32.7.1 General [re.regex.general]

For a char-like type charT, specializations of class template basic_regex represent regular expressions constructed from character sequences of charT characters.

In the rest of [re.regex], charT denotes a given char-like type.

Storage for a regular expression is allocated and freed as necessary by the member functions of class basic_regex.

Objects of type specialization of basic_regex are responsible for converting the sequence of charT objects to an internal representation.

It is not specified what form this representation takes, nor how it is accessed by algorithms that operate on regular expressions.

[Note 1:

Implementations will typically declare some function templates as friends of basic_regex to achieve this.

— end note]

The functions described in [re.regex] report errors by throwing exceptions of type regex_error.

🔗

namespace std { template<class charT, class traits = regex_traits<charT>> class basic_regex { public: // types using value_type = charT; using traits_type = traits; using string_type = typename traits::string_type; using flag_type = regex_constants::syntax_option_type; using locale_type = typename traits::locale_type; // [re.synopt], constants static constexpr flag_type icase = regex_constants::icase; static constexpr flag_type nosubs = regex_constants::nosubs; static constexpr flag_type optimize = regex_constants::optimize; static constexpr flag_type collate = regex_constants::collate; static constexpr flag_type ECMAScript = regex_constants::ECMAScript; static constexpr flag_type basic = regex_constants::basic; static constexpr flag_type extended = regex_constants::extended; static constexpr flag_type awk = regex_constants::awk; static constexpr flag_type grep = regex_constants::grep; static constexpr flag_type egrep = regex_constants::egrep; static constexpr flag_type multiline = regex_constants::multiline; // [re.regex.construct], construct/copy/destroy basic_regex(); explicit basic_regex(const charT* p, flag_type f = regex_constants::ECMAScript); basic_regex(const charT* p, size_t len, flag_type f = regex_constants::ECMAScript); basic_regex(const basic_regex&); basic_regex(basic_regex&&) noexcept; template<class ST, class SA> explicit basic_regex(const basic_string<charT, ST, SA>& s, flag_type f = regex_constants::ECMAScript); template<class ForwardIterator> basic_regex(ForwardIterator first, ForwardIterator last, flag_type f = regex_constants::ECMAScript); basic_regex(initializer_list<charT> il, flag_type f = regex_constants::ECMAScript); ~basic_regex(); // [re.regex.assign], assign basic_regex& operator=(const basic_regex& e); basic_regex& operator=(basic_regex&& e) noexcept; basic_regex& operator=(const charT* p); basic_regex& operator=(initializer_list<charT> il); template<class ST, class SA> basic_regex& operator=(const basic_string<charT, ST, SA>& s); basic_regex& assign(const basic_regex& e); basic_regex& assign(basic_regex&& e) noexcept; basic_regex& assign(const charT* p, flag_type f = regex_constants::ECMAScript); basic_regex& assign(const charT* p, size_t len, flag_type f = regex_constants::ECMAScript); template<class ST, class SA> basic_regex& assign(const basic_string<charT, ST, SA>& s, flag_type f = regex_constants::ECMAScript); template<class InputIterator> basic_regex& assign(InputIterator first, InputIterator last, flag_type f = regex_constants::ECMAScript); basic_regex& assign(initializer_list<charT>, flag_type f = regex_constants::ECMAScript); // [re.regex.operations], const operations unsigned mark_count() const; flag_type flags() const; // [re.regex.locale], locale locale_type imbue(locale_type loc); locale_type getloc() const; // [re.regex.swap], swap void swap(basic_regex&); }; template<class ForwardIterator> basic_regex(ForwardIterator, ForwardIterator, regex_constants::syntax_option_type = regex_constants::ECMAScript) -> basic_regex<typename iterator_traits<ForwardIterator>::value_type>; }

32.7.2 Constructors [re.regex.construct]

🔗

basic_regex();

Postconditions: *this does not match any character sequence.

🔗

explicit basic_regex(const charT* p, flag_type f = regex_constants::ECMAScript);

Preconditions: [p, p + char_traits<charT>::length(p)) is a valid range.

Effects: The object's internal finite state machine is constructed from the regular expression contained in the sequence of characters [p, p + char_traits<charT>::length(p)), and interpreted according to the flags f.

Postconditions: flags() returns f.

mark_count() returns the number of marked sub-expressions within the expression.

Throws: regex_error if [p, p + char_traits<charT>::length(p)) is not a valid regular expression.

🔗

basic_regex(const charT* p, size_t len, flag_type f = regex_constants::ECMAScript);

Preconditions: [p, p + len) is a valid range.

Effects: The object's internal finite state machine is constructed from the regular expression contained in the sequence of characters [p, p + len), and interpreted according the flags specified in f.

Postconditions: flags() returns f.

mark_count() returns the number of marked sub-expressions within the expression.

Throws: regex_error if [p, p + len) is not a valid regular expression.

🔗

basic_regex(const basic_regex& e);

Postconditions: flags() and mark_count() return e.flags() and e.mark_count(), respectively.

🔗

basic_regex(basic_regex&& e) noexcept;

Postconditions: flags() and mark_count() return the values that e.flags() and e.mark_count(), respectively, had before construction.

🔗

template<class ST, class SA>
  explicit basic_regex(const basic_string<charT, ST, SA>& s,
                       flag_type f = regex_constants::ECMAScript);

Effects: The object's internal finite state machine is constructed from the regular expression contained in the string s, and interpreted according to the flags specified in f.

Postconditions: flags() returns f.

mark_count() returns the number of marked sub-expressions within the expression.

Throws: regex_error if s is not a valid regular expression.

🔗

template<class ForwardIterator>
  basic_regex(ForwardIterator first, ForwardIterator last,
              flag_type f = regex_constants::ECMAScript);

Effects: The object's internal finite state machine is constructed from the regular expression contained in the sequence of characters [first, last), and interpreted according to the flags specified in f.

Postconditions: flags() returns f.

mark_count() returns the number of marked sub-expressions within the expression.

Throws: regex_error if the sequence [first, last) is not a valid regular expression.

🔗

basic_regex(initializer_list<charT> il, flag_type f = regex_constants::ECMAScript);

Effects: Same as basic_regex(il.begin(), il.end(), f).

32.7.3 Assignment [re.regex.assign]

🔗

basic_regex& operator=(const basic_regex& e);

Postconditions: flags() and mark_count() return e.flags() and e.mark_count(), respectively.

🔗

basic_regex& operator=(basic_regex&& e) noexcept;

Postconditions: flags() and mark_count() return the values that e.flags() and e.mark_count(), respectively, had before assignment.

e is in a valid state with unspecified value.

🔗

basic_regex& operator=(const charT* p);

Effects: Equivalent to: return assign(p);

🔗

basic_regex& operator=(initializer_list<charT> il);

Effects: Equivalent to: return assign(il.begin(), il.end());

🔗

template<class ST, class SA>
  basic_regex& operator=(const basic_string<charT, ST, SA>& s);

Effects: Equivalent to: return assign(s);

🔗

basic_regex& assign(const basic_regex& e);

Effects: Equivalent to: return *this = e;

🔗

basic_regex& assign(basic_regex&& e) noexcept;

Effects: Equivalent to: return *this = std::move(e);

🔗

basic_regex& assign(const charT* p, flag_type f = regex_constants::ECMAScript);

Effects: Equivalent to: return assign(string_type(p), f);

🔗

basic_regex& assign(const charT* p, size_t len, flag_type f = regex_constants::ECMAScript);

Effects: Equivalent to: return assign(string_type(p, len), f);

🔗

template<class ST, class SA>
  basic_regex& assign(const basic_string<charT, ST, SA>& s,
                      flag_type f = regex_constants::ECMAScript);

Effects: Assigns the regular expression contained in the string s, interpreted according the flags specified in f.

If an exception is thrown, *this is unchanged.

Postconditions: If no exception is thrown, flags() returns f and mark_count() returns the number of marked sub-expressions within the expression.

Returns: *this.

Throws: regex_error if s is not a valid regular expression.

🔗

template<class InputIterator>
  basic_regex& assign(InputIterator first, InputIterator last,
                      flag_type f = regex_constants::ECMAScript);

Effects: Equivalent to: return assign(string_type(first, last), f);

🔗

basic_regex& assign(initializer_list<charT> il,
                    flag_type f = regex_constants::ECMAScript);

Effects: Equivalent to: return assign(il.begin(), il.end(), f);

32.7.4 Constant operations [re.regex.operations]

🔗

unsigned mark_count() const;

Effects: Returns the number of marked sub-expressions within the regular expression.

🔗

flag_type flags() const;

Effects: Returns a copy of the regular expression syntax flags that were passed to the object's constructor or to the last call to assign.

32.7.5 Locale [re.regex.locale]

🔗

locale_type imbue(locale_type loc);

Effects: Returns the result of traits_inst.imbue(loc) where traits_inst is a (default-initialized) instance of the template type argument traits stored within the object.

After a call to imbue the basic_regex object does not match any character sequence.

🔗

locale_type getloc() const;

Effects: Returns the result of traits_inst.getloc() where traits_inst is a (default-initialized) instance of the template parameter traits stored within the object.

32.7.6 Swap [re.regex.swap]

🔗

void swap(basic_regex& e);

Effects: Swaps the contents of the two regular expressions.

Postconditions: *this contains the regular expression that was in e, e contains the regular expression that was in *this.

Complexity: Constant time.

32.7.7 Non-member functions [re.regex.nonmemb]

🔗

template<class charT, class traits>
  void swap(basic_regex<charT, traits>& lhs, basic_regex<charT, traits>& rhs);

Effects: Calls lhs.swap(rhs).