1 // Exception Handling support header (exception_ptr class) for -*- C++ -*-
3 // Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation
5 // This file is part of GCC.
7 // GCC 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 3, or (at your option)
12 // GCC 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 bits/exception_ptr.h
27 * This is an internal header file, included by other library headers.
28 * Do not attempt to use it directly. @headername{exception}
31 #ifndef _EXCEPTION_PTR_H
32 #define _EXCEPTION_PTR_H
34 #pragma GCC visibility push(default)
36 #include <bits/c++config.h>
37 #include <bits/exception_defines.h>
39 #if ATOMIC_INT_LOCK_FREE < 2
40 # error This platform does not support exception propagation.
48 * @addtogroup exceptions
51 namespace __exception_ptr
56 using __exception_ptr::exception_ptr;
58 /** Obtain an exception_ptr to the currently handled exception. If there
59 * is none, or the currently handled exception is foreign, return the null
62 exception_ptr current_exception() _GLIBCXX_USE_NOEXCEPT;
64 /// Throw the object pointed to by the exception_ptr.
65 void rethrow_exception(exception_ptr) __attribute__ ((__noreturn__));
67 namespace __exception_ptr
70 * @brief An opaque pointer to an arbitrary exception.
75 void* _M_exception_object;
77 explicit exception_ptr(void* __e) _GLIBCXX_USE_NOEXCEPT;
79 void _M_addref() _GLIBCXX_USE_NOEXCEPT;
80 void _M_release() _GLIBCXX_USE_NOEXCEPT;
82 void *_M_get() const _GLIBCXX_NOEXCEPT __attribute__ ((__pure__));
84 friend exception_ptr std::current_exception() _GLIBCXX_USE_NOEXCEPT;
85 friend void std::rethrow_exception(exception_ptr);
88 exception_ptr() _GLIBCXX_USE_NOEXCEPT;
90 exception_ptr(const exception_ptr&) _GLIBCXX_USE_NOEXCEPT;
92 #ifdef __GXX_EXPERIMENTAL_CXX0X__
93 exception_ptr(nullptr_t) noexcept
94 : _M_exception_object(0)
97 exception_ptr(exception_ptr&& __o) noexcept
98 : _M_exception_object(__o._M_exception_object)
99 { __o._M_exception_object = 0; }
102 #if !defined (__GXX_EXPERIMENTAL_CXX0X__) || defined (_GLIBCXX_EH_PTR_COMPAT)
103 typedef void (exception_ptr::*__safe_bool)();
105 // For construction from nullptr or 0.
106 exception_ptr(__safe_bool) _GLIBCXX_USE_NOEXCEPT;
110 operator=(const exception_ptr&) _GLIBCXX_USE_NOEXCEPT;
112 #ifdef __GXX_EXPERIMENTAL_CXX0X__
114 operator=(exception_ptr&& __o) noexcept
116 exception_ptr(static_cast<exception_ptr&&>(__o)).swap(*this);
121 ~exception_ptr() _GLIBCXX_USE_NOEXCEPT;
124 swap(exception_ptr&) _GLIBCXX_USE_NOEXCEPT;
126 #ifdef _GLIBCXX_EH_PTR_COMPAT
127 // Retained for compatibility with CXXABI_1.3.
128 void _M_safe_bool_dummy() _GLIBCXX_USE_NOEXCEPT
129 __attribute__ ((__const__));
130 bool operator!() const _GLIBCXX_USE_NOEXCEPT
131 __attribute__ ((__pure__));
132 operator __safe_bool() const _GLIBCXX_USE_NOEXCEPT;
135 #ifdef __GXX_EXPERIMENTAL_CXX0X__
136 explicit operator bool() const
137 { return _M_exception_object; }
141 operator==(const exception_ptr&, const exception_ptr&)
142 _GLIBCXX_USE_NOEXCEPT __attribute__ ((__pure__));
144 const class type_info*
145 __cxa_exception_type() const _GLIBCXX_USE_NOEXCEPT
146 __attribute__ ((__pure__));
150 operator==(const exception_ptr&, const exception_ptr&)
151 _GLIBCXX_USE_NOEXCEPT __attribute__ ((__pure__));
154 operator!=(const exception_ptr&, const exception_ptr&)
155 _GLIBCXX_USE_NOEXCEPT __attribute__ ((__pure__));
158 swap(exception_ptr& __lhs, exception_ptr& __rhs)
159 { __lhs.swap(__rhs); }
161 } // namespace __exception_ptr
164 /// Obtain an exception_ptr pointing to a copy of the supplied object.
165 template<typename _Ex>
167 copy_exception(_Ex __ex) _GLIBCXX_USE_NOEXCEPT
177 return current_exception();
181 // _GLIBCXX_RESOLVE_LIB_DEFECTS
182 // 1130. copy_exception name misleading
183 /// Obtain an exception_ptr pointing to a copy of the supplied object.
184 template<typename _Ex>
186 make_exception_ptr(_Ex __ex) _GLIBCXX_USE_NOEXCEPT
187 { return std::copy_exception<_Ex>(__ex); }
189 // @} group exceptions
194 #pragma GCC visibility pop