Provided by: libstdc++6-4.7-doc_4.7.3-12ubuntu1_all bug

NAME

       std::basic_regex< _Ch_type, _Rx_traits > -

SYNOPSIS

   Public Types
       typedef
           regex_constants::syntax_option_type flag_type"
       typedef traits_type::locale_type locale_type
       typedef traits_type::string_type string_type
       typedef _Rx_traits traits_type
       typedef _Ch_type value_type

   Public Member Functions
       basic_regex ()
       basic_regex (const _Ch_type *__p, flag_type __f=regex_constants::ECMAScript)
       basic_regex (const _Ch_type *__p, std::size_t __len, flag_type __f)
       basic_regex (const basic_regex &__rhs)
       basic_regex (const basic_regex &&__rhs) noexcept
       template<typename _Ch_traits , typename _Ch_alloc > basic_regex (const std::basic_string<
           _Ch_type, _Ch_traits, _Ch_alloc > &__s, flag_type __f=regex_constants::ECMAScript)
       template<typename _InputIterator > basic_regex (_InputIterator __first, _InputIterator
           __last, flag_type __f=regex_constants::ECMAScript)
       basic_regex (initializer_list< _Ch_type > __l, flag_type __f=regex_constants::ECMAScript)
       ~basic_regex ()
       const __regex::_AutomatonPtr & _M_get_automaton () const
       basic_regex & assign (const basic_regex &__rhs)
       basic_regex & assign (basic_regex &&__rhs) noexcept
       basic_regex & assign (const _Ch_type *__p, flag_type __flags=regex_constants::ECMAScript)
       basic_regex & assign (const _Ch_type *__p, std::size_t __len, flag_type __flags)
       template<typename _Ch_typeraits , typename _Allocator > basic_regex & assign (const
           basic_string< _Ch_type, _Ch_typeraits, _Allocator > &__s, flag_type
           __flags=regex_constants::ECMAScript)
       template<typename _InputIterator > basic_regex & assign (_InputIterator __first,
           _InputIterator __last, flag_type __flags=regex_constants::ECMAScript)
       basic_regex & assign (initializer_list< _Ch_type > __l, flag_type
           __flags=regex_constants::ECMAScript)
       flag_type flags () const
       locale_type getloc () const
       locale_type imbue (locale_type __loc)
       unsigned int mark_count () const
       basic_regex & operator= (const basic_regex &__rhs)
       basic_regex & operator= (basic_regex &&__rhs) noexcept
       basic_regex & operator= (const _Ch_type *__p)
       template<typename _Ch_typeraits , typename _Allocator > basic_regex & operator= (const
           basic_string< _Ch_type, _Ch_typeraits, _Allocator > &__s)
       void swap (basic_regex &__rhs)

   Static Public Attributes
       Constants
       std [28.8.1](1)

           static constexpr
               regex_constants::syntax_option_type icase"
           static constexpr
               regex_constants::syntax_option_type nosubs"
           static constexpr
               regex_constants::syntax_option_type optimize"
           static constexpr
               regex_constants::syntax_option_type collate"
           static constexpr
               regex_constants::syntax_option_type ECMAScript"
           static constexpr
               regex_constants::syntax_option_type basic"
           static constexpr
               regex_constants::syntax_option_type extended"
           static constexpr
               regex_constants::syntax_option_type awk"
           static constexpr
               regex_constants::syntax_option_type grep"
           static constexpr
               regex_constants::syntax_option_type egrep"

   Protected Attributes
       __regex::_AutomatonPtr _M_automaton
       flag_type _M_flags
       _Rx_traits _M_traits

Detailed Description

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>>class
       std::basic_regex< _Ch_type, _Rx_traits >
       Objects of specializations of this class represent regular expressions constructed from
       sequences of character type _Ch_type.

       Storage for the regular expression is allocated and deallocated as necessary by the member
       functions of this class.

       Definition at line 342 of file regex.h.

Constructor & Destructor Documentation

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::basic_regex () [inline]
       Constructs a basic regular expression that does not match any character sequence.

       Definition at line 384 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::basic_regex (const _Ch_type *__p, flag_type__f =
       regex_constants::ECMAScript) [inline],  [explicit]
       Constructs a basic regular expression from the sequence [__p, __p +
       char_traits<_Ch_type>::length(__p)) interpreted according to the flags in __f.

       Parameters:
           __p A pointer to the start of a C-style null-terminated string containing a regular
           expression.
           __f Flags indicating the syntax rules and options.

       Exceptions:
           regex_error if __p is not a valid regular expression.

       Definition at line 402 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::basic_regex (const _Ch_type *__p, std::size_t__len, flag_type__f)
       [inline]
       Constructs a basic regular expression from the sequence [p, p + len) interpreted according
       to the flags in f.

       Parameters:
           __p A pointer to the start of a string containing a regular expression.
           __len The length of the string containing the regular expression.
           __f Flags indicating the syntax rules and options.

       Exceptions:
           regex_error if __p is not a valid regular expression.

       Definition at line 421 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::basic_regex (const basic_regex< _Ch_type, _Rx_traits > &__rhs)
       [inline]
       Copy-constructs a basic regular expression.

       Parameters:
           __rhs A regex object.

       Definition at line 431 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::basic_regex (const basic_regex< _Ch_type, _Rx_traits > &&__rhs)
       [inline],  [noexcept]
       Move-constructs a basic regular expression.

       Parameters:
           __rhs A regex object.

       Definition at line 441 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> template<typename
       _Ch_traits , typename _Ch_alloc > std::basic_regex< _Ch_type, _Rx_traits >::basic_regex
       (const std::basic_string< _Ch_type, _Ch_traits, _Ch_alloc > &__s, flag_type__f =
       regex_constants::ECMAScript) [inline],  [explicit]
       Constructs a basic regular expression from the string s interpreted according to the flags
       in f.

       Parameters:
           __s A string containing a regular expression.
           __f Flags indicating the syntax rules and options.

       Exceptions:
           regex_error if __s is not a valid regular expression.

       Definition at line 457 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> template<typename
       _InputIterator > std::basic_regex< _Ch_type, _Rx_traits >::basic_regex
       (_InputIterator__first, _InputIterator__last, flag_type__f = regex_constants::ECMAScript)
       [inline]
       Constructs a basic regular expression from the range [first, last) interpreted according
       to the flags in f.

       Parameters:
           __first The start of a range containing a valid regular expression.
           __last The end of a range containing a valid regular expression.
           __f The format flags of the regular expression.

       Exceptions:
           regex_error if [__first, __last) is not a valid regular expression.

       Definition at line 479 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::basic_regex (initializer_list< _Ch_type >__l, flag_type__f =
       regex_constants::ECMAScript) [inline]
       Constructs a basic regular expression from an initializer list.

       Parameters:
           __l The initializer list.
           __f The format flags of the regular expression.

       Exceptions:
           regex_error if __l is not a valid regular expression.

       Definition at line 493 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> std::basic_regex<
       _Ch_type, _Rx_traits >::~basic_regex () [inline]
       Destroys a basic regular expression.

       Definition at line 503 of file regex.h.

Member Function Documentation

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::assign (const basic_regex< _Ch_type, _Rx_traits
       > &__rhs) [inline]
       the real assignment operator.

       Parameters:
           __rhs Another regular expression object.

       Definition at line 549 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::swap().

       Referenced by std::basic_regex< _Ch_type, _Rx_traits >::assign(), and std::basic_regex<
       _Ch_type, _Rx_traits >::operator=().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::assign (basic_regex< _Ch_type, _Rx_traits >
       &&__rhs) [inline],  [noexcept]
       The move-assignment operator.

       Parameters:
           __rhs Another regular expression object.

       Definition at line 562 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::swap().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::assign (const _Ch_type *__p, flag_type__flags =
       regex_constants::ECMAScript) [inline]
       Assigns a new regular expression to a regex object from a C-style null-terminated string
       containing a regular expression pattern.

       Parameters:
           __p A pointer to a C-style null-terminated string containing a regular expression
           pattern.
           __flags Syntax option flags.

       Exceptions:
           regex_error if __p does not contain a valid regular expression pattern interpreted
           according to __flags. If regex_error is thrown, *this remains unchanged.

       Definition at line 583 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::assign (const _Ch_type *__p, std::size_t__len,
       flag_type__flags) [inline]
       Assigns a new regular expression to a regex object from a C-style string containing a
       regular expression pattern.

       Parameters:
           __p A pointer to a C-style string containing a regular expression pattern.
           __len The length of the regular expression pattern string.
           __flags Syntax option flags.

       Exceptions:
           regex_error if p does not contain a valid regular expression pattern interpreted
           according to __flags. If regex_error is thrown, *this remains unchanged.

       Definition at line 601 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> template<typename
       _Ch_typeraits , typename _Allocator > basic_regex& std::basic_regex< _Ch_type, _Rx_traits
       >::assign (const basic_string< _Ch_type, _Ch_typeraits, _Allocator > &__s,
       flag_type__flags = regex_constants::ECMAScript) [inline]
       Assigns a new regular expression to a regex object from a string containing a regular
       expression pattern.

       Parameters:
           __s A string containing a regular expression pattern.
           __flags Syntax option flags.

       Exceptions:
           regex_error if __s does not contain a valid regular expression pattern interpreted
           according to __flags. If regex_error is thrown, *this remains unchanged.

       Definition at line 617 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::swap().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> template<typename
       _InputIterator > basic_regex& std::basic_regex< _Ch_type, _Rx_traits >::assign
       (_InputIterator__first, _InputIterator__last, flag_type__flags =
       regex_constants::ECMAScript) [inline]
       Assigns a new regular expression to a regex object.

       Parameters:
           __first The start of a range containing a valid regular expression.
           __last The end of a range containing a valid regular expression.
           __flags Syntax option flags.

       Exceptions:
           regex_error if p does not contain a valid regular expression pattern interpreted
           according to __flags. If regex_error is thrown, the object remains unchanged.

       Definition at line 640 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::assign (initializer_list< _Ch_type >__l,
       flag_type__flags = regex_constants::ECMAScript) [inline]
       Assigns a new regular expression to a regex object.

       Parameters:
           __l An initializer list representing a regular expression.
           __flags Syntax option flags.

       Exceptions:
           regex_error if __l does not contain a valid regular expression pattern interpreted
           according to __flags. If regex_error is thrown, the object remains unchanged.

       Definition at line 656 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> flag_type
       std::basic_regex< _Ch_type, _Rx_traits >::flags () const [inline]
       Gets the flags used to construct the regular expression or in the last call to assign().

       Definition at line 674 of file regex.h.

       Referenced by std::basic_regex< _Ch_type, _Rx_traits >::operator=().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> locale_type
       std::basic_regex< _Ch_type, _Rx_traits >::getloc () const [inline]
       Gets the locale currently imbued in the regular expression object.

       Definition at line 692 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> locale_type
       std::basic_regex< _Ch_type, _Rx_traits >::imbue (locale_type__loc) [inline]
       Imbues the regular expression object with the given locale.

       Parameters:
           __loc A locale.

       Definition at line 684 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> unsigned int
       std::basic_regex< _Ch_type, _Rx_traits >::mark_count () const [inline]
       Gets the number of marked subexpressions within the regular expression.

       Definition at line 666 of file regex.h.

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::operator= (const basic_regex< _Ch_type,
       _Rx_traits > &__rhs) [inline]
       Assigns one regular expression to another.

       Definition at line 510 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::operator= (basic_regex< _Ch_type, _Rx_traits >
       &&__rhs) [inline],  [noexcept]
       Move-assigns one regular expression to another.

       Definition at line 517 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> basic_regex&
       std::basic_regex< _Ch_type, _Rx_traits >::operator= (const _Ch_type *__p) [inline]
       Replaces a regular expression with a new one constructed from a C-style null-terminated
       string.

       Parameters:
           __p A pointer to the start of a null-terminated C-style string containing a regular
           expression.

       Definition at line 528 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign(), and std::basic_regex<
       _Ch_type, _Rx_traits >::flags().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> template<typename
       _Ch_typeraits , typename _Allocator > basic_regex& std::basic_regex< _Ch_type, _Rx_traits
       >::operator= (const basic_string< _Ch_type, _Ch_typeraits, _Allocator > &__s) [inline]
       Replaces a regular expression with a new one constructed from a string.

       Parameters:
           __s A pointer to a string containing a regular expression.

       Definition at line 539 of file regex.h.

       References std::basic_regex< _Ch_type, _Rx_traits >::assign(), and std::basic_regex<
       _Ch_type, _Rx_traits >::flags().

   template<typename _Ch_type, typename _Rx_traits = regex_traits<_Ch_type>> void
       std::basic_regex< _Ch_type, _Rx_traits >::swap (basic_regex< _Ch_type, _Rx_traits >
       &__rhs) [inline]
       Swaps the contents of two regular expression objects.

       Parameters:
           __rhs Another regular expression object.

       Definition at line 702 of file regex.h.

       Referenced by std::basic_regex< _Ch_type, _Rx_traits >::assign(), and std::swap().

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

libstdc++                                Thu Mar 20std::basic_regex< _Ch_type, _Rx_traits >(3cxx)