1 // Standard exception classes -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2005, 2007, 2009, 2010
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
26 /** @file include/stdexcept
27 * This is a Standard C++ Library header.
31 // ISO C++ 19.1 Exception classes
34 #ifndef _GLIBCXX_STDEXCEPT
35 #define _GLIBCXX_STDEXCEPT 1
37 #pragma GCC system_header
42 namespace std _GLIBCXX_VISIBILITY(default)
44 _GLIBCXX_BEGIN_NAMESPACE_VERSION
47 * @addtogroup exceptions
51 /** Logic errors represent problems in the internal logic of a program;
52 * in theory, these are preventable, and even detectable before the
53 * program runs (e.g., violations of class invariants).
54 * @brief One of two subclasses of exception.
56 class logic_error : public exception
61 /** Takes a character string describing the error. */
63 logic_error(const string& __arg);
66 ~logic_error() throw();
68 /** Returns a C-style character string describing the general cause of
69 * the current error (the same string passed to the ctor). */
74 /** Thrown by the library, or by you, to report domain errors (domain in
75 * the mathematical sense). */
76 class domain_error : public logic_error
79 explicit domain_error(const string& __arg);
82 /** Thrown to report invalid arguments to functions. */
83 class invalid_argument : public logic_error
86 explicit invalid_argument(const string& __arg);
89 /** Thrown when an object is constructed that would exceed its maximum
90 * permitted size (e.g., a basic_string instance). */
91 class length_error : public logic_error
94 explicit length_error(const string& __arg);
97 /** This represents an argument whose value is not within the expected
98 * range (e.g., boundary checks in basic_string). */
99 class out_of_range : public logic_error
102 explicit out_of_range(const string& __arg);
105 /** Runtime errors represent problems outside the scope of a program;
106 * they cannot be easily predicted and can generally only be caught as
107 * the program executes.
108 * @brief One of two subclasses of exception.
110 class runtime_error : public exception
115 /** Takes a character string describing the error. */
117 runtime_error(const string& __arg);
120 ~runtime_error() throw();
122 /** Returns a C-style character string describing the general cause of
123 * the current error (the same string passed to the ctor). */
125 what() const throw();
128 /** Thrown to indicate range errors in internal computations. */
129 class range_error : public runtime_error
132 explicit range_error(const string& __arg);
135 /** Thrown to indicate arithmetic overflow. */
136 class overflow_error : public runtime_error
139 explicit overflow_error(const string& __arg);
142 /** Thrown to indicate arithmetic underflow. */
143 class underflow_error : public runtime_error
146 explicit underflow_error(const string& __arg);
149 // @} group exceptions
151 _GLIBCXX_END_NAMESPACE_VERSION
154 #endif /* _GLIBCXX_STDEXCEPT */