regex_error.h
Go to the documentation of this file.
// Errors for std::regex -*- C++ -*-
// Copyright (C) 2010-2023 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 3, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.
// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/**
* @file bits/regex_error.h
* @brief Error and exception objects for the std regex library.
*
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{regex}
*/
namespace std _GLIBCXX_VISIBILITY(default)
{
_GLIBCXX_BEGIN_NAMESPACE_VERSION
/**
* @addtogroup regex
* @{
*/
namespace regex_constants
{
/**
* @name 5.3 Error Types
*/
///@{
enum error_type
{
_S_error_collate, // XXX should have been a non-zero value
_S_error_ctype,
_S_error_escape,
_S_error_backref,
_S_error_brack,
_S_error_paren,
_S_error_brace,
_S_error_badbrace,
_S_error_range,
_S_error_space,
_S_error_badrepeat,
_S_error_complexity,
_S_error_stack,
_S_null,
_S_grammar
};
/** The expression contained an invalid collating element name. */
_GLIBCXX17_INLINE constexpr error_type error_collate(_S_error_collate);
/** The expression contained an invalid character class name. */
_GLIBCXX17_INLINE constexpr error_type error_ctype(_S_error_ctype);
/**
* The expression contained an invalid escaped character, or a trailing
* escape.
*/
_GLIBCXX17_INLINE constexpr error_type error_escape(_S_error_escape);
/** The expression contained an invalid back reference. */
_GLIBCXX17_INLINE constexpr error_type error_backref(_S_error_backref);
/** The expression contained mismatched [ and ]. */
_GLIBCXX17_INLINE constexpr error_type error_brack(_S_error_brack);
/** The expression contained mismatched ( and ). */
_GLIBCXX17_INLINE constexpr error_type error_paren(_S_error_paren);
/** The expression contained mismatched { and } */
_GLIBCXX17_INLINE constexpr error_type error_brace(_S_error_brace);
/** The expression contained an invalid range in a {} expression. */
_GLIBCXX17_INLINE constexpr error_type error_badbrace(_S_error_badbrace);
/**
* The expression contained an invalid character range,
* such as [b-a] in most encodings.
*/
_GLIBCXX17_INLINE constexpr error_type error_range(_S_error_range);
/**
* There was insufficient memory to convert the expression into a
* finite state machine.
*/
_GLIBCXX17_INLINE constexpr error_type error_space(_S_error_space);
/**
* One of <em>*?+{</em> was not preceded by a valid regular expression.
*/
_GLIBCXX17_INLINE constexpr error_type error_badrepeat(_S_error_badrepeat);
/**
* The complexity of an attempted match against a regular expression
* exceeded a pre-set level.
*/
_GLIBCXX17_INLINE constexpr error_type error_complexity(_S_error_complexity);
/**
* There was insufficient memory to determine whether the
* regular expression could match the specified character sequence.
*/
_GLIBCXX17_INLINE constexpr error_type error_stack(_S_error_stack);
///@}
} // namespace regex_constants
// [7.8] Class regex_error
/**
* @brief A regular expression exception class.
* @ingroup exceptions
*
* The regular expression library throws objects of this class on error.
*
* @headerfile regex
* @since C++11
*/
class regex_error : public std::runtime_error
{
using error_type = regex_constants::error_type;
error_type _M_code;
public:
/**
* @brief Constructs a regex_error object.
*
* @param __ecode the regex error code.
*/
explicit
regex_error(error_type __ecode);
virtual ~regex_error() throw();
/**
* @brief Gets the regex error code.
*
* @returns the regex error code.
*/
regex_constants::error_type
code() const noexcept
{ return _M_code; }
private:
/// @cond undocumented
regex_error(error_type __ecode, const char* __what)
: std::runtime_error(__what), _M_code(__ecode)
{ }
[[__noreturn__]]
friend void
__throw_regex_error(error_type __ecode __attribute__((__unused__)),
const char* __what __attribute__((__unused__)))
{ _GLIBCXX_THROW_OR_ABORT(regex_error(__ecode, __what)); }
/// @endcond
};
/// @cond undocumented
[[__noreturn__]]
void
__throw_regex_error(regex_constants::error_type __ecode);
[[__noreturn__]]
inline void
__throw_regex_error(regex_constants::error_type __ecode, const char* __what);
/// @endcond
///@} // group regex
_GLIBCXX_END_NAMESPACE_VERSION
} // namespace std
std
ISO C++ entities toplevel namespace is std.
std::regex_constants::error_space
constexpr error_type error_space(_S_error_space)
std::regex_constants::error_ctype
constexpr error_type error_ctype(_S_error_ctype)
std::regex_constants::error_brace
constexpr error_type error_brace(_S_error_brace)
std::regex_constants::error_badbrace
constexpr error_type error_badbrace(_S_error_badbrace)
std::regex_constants::error_escape
constexpr error_type error_escape(_S_error_escape)
std::regex_constants::error_range
constexpr error_type error_range(_S_error_range)
std::regex_constants::error_badrepeat
constexpr error_type error_badrepeat(_S_error_badrepeat)
std::regex_constants::error_paren
constexpr error_type error_paren(_S_error_paren)
std::regex_constants::error_stack
constexpr error_type error_stack(_S_error_stack)
std::regex_constants::error_brack
constexpr error_type error_brack(_S_error_brack)
std::regex_constants::error_backref
constexpr error_type error_backref(_S_error_backref)
std::regex_constants::error_complexity
constexpr error_type error_complexity(_S_error_complexity)
std::regex_constants::error_collate
constexpr error_type error_collate(_S_error_collate)
std::regex_constants::error_type
error_type
Definition regex_error.h:50
std::runtime_error
One of two subclasses of exception.
Definition stdexcept:220
std::regex_error
A regular expression exception class.
Definition regex_error.h:138
std::regex_error::regex_error
regex_error(error_type __ecode)
Constructs a regex_error object.
std::regex_error::code
regex_constants::error_type code() const noexcept
Gets the regex error code.
Definition regex_error.h:160
std::auto_ptr_ref
Definition auto_ptr.h:49