1 // Exception Handling support header for -*- C++ -*-
3 // Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001, 2002, 2005
4 // Free Software Foundation
6 // This file is part of GCC.
8 // GCC is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2, or (at your option)
13 // GCC is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with GCC; see the file COPYING. If not, write to
20 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
21 // Boston, MA 02110-1301, USA.
23 // As a special exception, you may use this file as part of a free software
24 // library without restriction. Specifically, if other files instantiate
25 // templates or use macros or inline functions from this file, or you compile
26 // this file and link it with other files to produce an executable, this
27 // file does not by itself cause the resulting executable to be covered by
28 // the GNU General Public License. This exception does not however
29 // invalidate any other reasons why the executable file might be covered by
30 // the GNU General Public License.
33 * This header defines several types and functions relating to the
34 * handling of exceptions in a C++ program.
40 #pragma GCC visibility push(default)
42 #include <bits/c++config.h>
49 * @brief Base class for all library exceptions.
51 * This is the base class for all exceptions thrown by the standard
52 * library, and by certain language expressions. You are free to derive
53 * your own %exception classes, or use a different hierarchy, or to
54 * throw non-class data (e.g., fundamental types).
59 exception() throw() { }
60 virtual ~exception() throw();
61 /** Returns a C-style character string describing the general cause
62 * of the current error. */
63 virtual const char* what() const throw();
66 /** If an %exception is thrown which is not listed in a function's
67 * %exception specification, one of these may be thrown. */
68 class bad_exception : public exception
71 bad_exception() throw() { }
72 // This declaration is not useless:
73 // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
74 virtual ~bad_exception() throw();
77 /// If you write a replacement %terminate handler, it must be of this type.
78 typedef void (*terminate_handler) ();
79 /// If you write a replacement %unexpected handler, it must be of this type.
80 typedef void (*unexpected_handler) ();
82 /// Takes a new handler function as an argument, returns the old function.
83 terminate_handler set_terminate(terminate_handler) throw();
84 /** The runtime will call this function if %exception handling must be
85 * abandoned for any reason. It can also be called by the user. */
86 void terminate() __attribute__ ((__noreturn__));
88 /// Takes a new handler function as an argument, returns the old function.
89 unexpected_handler set_unexpected(unexpected_handler) throw();
90 /** The runtime will call this function if an %exception is thrown which
91 * violates the function's %exception specification. */
92 void unexpected() __attribute__ ((__noreturn__));
94 /** [18.6.4]/1: "Returns true after completing evaluation of a
95 * throw-expression until either completing initialization of the
96 * exception-declaration in the matching handler or entering @c unexpected()
97 * due to the throw; or after entering @c terminate() for any reason
98 * other than an explicit call to @c terminate(). [Note: This includes
99 * stack unwinding [15.2]. end note]"
101 * 2: "When @c uncaught_exception() is true, throwing an %exception can
102 * result in a call of @c terminate() (15.5.1)."
104 bool uncaught_exception() throw();
107 _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
109 /** A replacement for the standard terminate_handler which prints more
110 information about the terminating exception (if any) on stderr. Call
112 std::set_terminate (__gnu_cxx::__verbose_terminate_handler)
114 to use. For more info, see
115 http://gcc.gnu.org/onlinedocs/libstdc++/19_diagnostics/howto.html#4
117 In 3.4 and later, this is on by default.
119 void __verbose_terminate_handler ();
121 _GLIBCXX_END_NAMESPACE
125 #pragma GCC visibility pop