]>
Commit | Line | Data |
---|---|---|
6305f20a | 1 | // Exception Handling support header for -*- C++ -*- |
d34786e3 BK |
2 | |
3 | // Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001 Free Software Foundation | |
e2c09482 | 4 | // |
6305f20a BK |
5 | // This file is part of GNU CC. |
6 | // | |
7 | // GNU CC is free software; you can redistribute it and/or modify | |
8 | // it under the terms of the GNU General Public License as published by | |
9 | // the Free Software Foundation; either version 2, or (at your option) | |
10 | // any later version. | |
11 | // | |
12 | // GNU CC 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. | |
16 | // | |
17 | // You should have received a copy of the GNU General Public License | |
18 | // along with GNU CC; see the file COPYING. If not, write to | |
19 | // the Free Software Foundation, 59 Temple Place - Suite 330, | |
20 | // Boston, MA 02111-1307, USA. | |
21 | ||
22 | // As a special exception, you may use this file as part of a free software | |
23 | // library without restriction. Specifically, if other files instantiate | |
24 | // templates or use macros or inline functions from this file, or you compile | |
25 | // this file and link it with other files to produce an executable, this | |
26 | // file does not by itself cause the resulting executable to be covered by | |
27 | // the GNU General Public License. This exception does not however | |
28 | // invalidate any other reasons why the executable file might be covered by | |
29 | // the GNU General Public License. | |
30 | ||
669f7a03 PE |
31 | /** @file exception |
32 | * This header defines several types and functions relating to the | |
33 | * handling of exceptions in a C++ program. | |
34 | */ | |
35 | ||
6305f20a BK |
36 | #ifndef __EXCEPTION__ |
37 | #define __EXCEPTION__ | |
38 | ||
6305f20a BK |
39 | extern "C++" { |
40 | ||
d34786e3 BK |
41 | namespace std |
42 | { | |
669f7a03 PE |
43 | /** This is the base class for all exceptions thrown by the standard |
44 | * library, and by certain language expressions. You are free to derive | |
45 | * your own %exception classes, or use a different hierarchy, or to | |
46 | * throw non-class data (e.g., fundamental types). | |
47 | * @brief Base class for all library exceptions. | |
48 | */ | |
d34786e3 BK |
49 | class exception |
50 | { | |
51 | public: | |
52 | exception() throw() { } | |
f68147f7 | 53 | virtual ~exception() throw(); |
669f7a03 PE |
54 | /** Returns a C-style character string describing the general cause |
55 | * of the current error. */ | |
d34786e3 BK |
56 | virtual const char* what() const throw(); |
57 | }; | |
6305f20a | 58 | |
669f7a03 PE |
59 | /** If an %exception is thrown which is not listed in a function's |
60 | * %exception specification, one of these may be thrown. */ | |
d34786e3 BK |
61 | class bad_exception : public exception |
62 | { | |
63 | public: | |
64 | bad_exception() throw() { } | |
f68147f7 | 65 | virtual ~bad_exception() throw(); |
d34786e3 | 66 | }; |
6305f20a | 67 | |
669f7a03 | 68 | /// If you write a replacement %terminate handler, it must be of this type. |
d34786e3 | 69 | typedef void (*terminate_handler) (); |
669f7a03 | 70 | /// If you write a replacement %unexpected handler, it must be of this type. |
d34786e3 | 71 | typedef void (*unexpected_handler) (); |
6305f20a | 72 | |
669f7a03 | 73 | /// Takes a new handler function as an argument, returns the old function. |
d34786e3 | 74 | terminate_handler set_terminate(terminate_handler) throw(); |
669f7a03 PE |
75 | /** The runtime will call this function if %exception handling must be |
76 | * abandoned for any reason. */ | |
d34786e3 | 77 | void terminate() __attribute__ ((__noreturn__)); |
6305f20a | 78 | |
669f7a03 | 79 | /// Takes a new handler function as an argument, returns the old function. |
d34786e3 | 80 | unexpected_handler set_unexpected(unexpected_handler) throw(); |
669f7a03 PE |
81 | /** The runtime will call this function if an %exception is thrown which |
82 | * violates the function's %exception specification. */ | |
d34786e3 | 83 | void unexpected() __attribute__ ((__noreturn__)); |
6305f20a | 84 | |
669f7a03 PE |
85 | /** [18.6.4]/1: "Returns true after completing evaluation of a |
86 | * throw-expression until either completing initialization of the | |
87 | * exception-declaration in the matching handler or entering @c unexpected() | |
88 | * due to the throw; or after entering @c terminate() for any reason | |
89 | * other than an explicit call to @c terminate(). [Note: This includes | |
90 | * stack unwinding [15.2]. end note]" | |
91 | * | |
92 | * 2: "When @c uncaught_exception() is true, throwing an %exception can | |
93 | * result in a call of @c terminate() (15.5.1)." | |
94 | */ | |
d34786e3 | 95 | bool uncaught_exception() throw(); |
6305f20a BK |
96 | } // namespace std |
97 | ||
98 | } // extern "C++" | |
99 | ||
100 | #endif |