blob: fdd83d10c3da6faf42318d8925ea2c26318d3322 [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
2//===-------------------------- exception ---------------------------------===//
3//
Howard Hinnantc566dc32010-05-11 21:36:01 +00004// The LLVM Compiler Infrastructure
Howard Hinnantc51e1022010-05-11 19:42:16 +00005//
Howard Hinnantee11c312010-11-16 22:09:02 +00006// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
Howard Hinnantc51e1022010-05-11 19:42:16 +00008//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_EXCEPTION
12#define _LIBCPP_EXCEPTION
13
14/*
15 exception synopsis
16
17namespace std
18{
19
20class exception
21{
22public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000023 exception() noexcept;
24 exception(const exception&) noexcept;
25 exception& operator=(const exception&) noexcept;
26 virtual ~exception() noexcept;
27 virtual const char* what() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000028};
29
30class bad_exception
31 : public exception
32{
33public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000034 bad_exception() noexcept;
35 bad_exception(const bad_exception&) noexcept;
36 bad_exception& operator=(const bad_exception&) noexcept;
37 virtual ~bad_exception() noexcept;
38 virtual const char* what() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000039};
40
41typedef void (*unexpected_handler)();
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000042unexpected_handler set_unexpected(unexpected_handler f ) noexcept;
43unexpected_handler get_unexpected() noexcept;
44[[noreturn]] void unexpected();
Howard Hinnantc51e1022010-05-11 19:42:16 +000045
46typedef void (*terminate_handler)();
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000047terminate_handler set_terminate(terminate_handler f ) noexcept;
48terminate_handler get_terminate() noexcept;
49[[noreturn]] void terminate() noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000050
Marshall Clow209dacc2015-06-02 15:33:38 +000051bool uncaught_exception() noexcept;
52int uncaught_exceptions() noexcept; // C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +000053
54typedef unspecified exception_ptr;
55
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000056exception_ptr current_exception() noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000057void rethrow_exception [[noreturn]] (exception_ptr p);
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000058template<class E> exception_ptr make_exception_ptr(E e) noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000059
60class nested_exception
61{
62public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000063 nested_exception() noexcept;
64 nested_exception(const nested_exception&) noexcept = default;
65 nested_exception& operator=(const nested_exception&) noexcept = default;
Howard Hinnantc51e1022010-05-11 19:42:16 +000066 virtual ~nested_exception() = default;
67
68 // access functions
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000069 [[noreturn]] void rethrow_nested() const;
70 exception_ptr nested_ptr() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000071};
72
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000073template <class T> [[noreturn]] void throw_with_nested(T&& t);
Howard Hinnantc51e1022010-05-11 19:42:16 +000074template <class E> void rethrow_if_nested(const E& e);
75
76} // std
77
78*/
79
80#include <__config>
81#include <cstddef>
Eric Fiselieraae1ccf2016-12-03 03:22:11 +000082#include <cstdlib>
Howard Hinnante4f92722010-05-27 17:06:52 +000083#include <type_traits>
Marshall Clow0a1e7502018-09-12 19:41:40 +000084#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +000085
Shoaib Meenaicfd19602017-10-09 19:25:17 +000086#if defined(_LIBCPP_ABI_MICROSOFT) && !defined(_LIBCPP_NO_VCRUNTIME)
Eric Fiselierec3a1672017-02-10 08:57:35 +000087#include <vcruntime_exception.h>
88#endif
89
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000090#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000091#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000092#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000093
94namespace std // purposefully not using versioning namespace
95{
96
Shoaib Meenaicfd19602017-10-09 19:25:17 +000097#if !defined(_LIBCPP_ABI_MICROSOFT) || defined(_LIBCPP_NO_VCRUNTIME)
Howard Hinnantc51e1022010-05-11 19:42:16 +000098class _LIBCPP_EXCEPTION_ABI exception
99{
100public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000101 _LIBCPP_INLINE_VISIBILITY exception() _NOEXCEPT {}
102 virtual ~exception() _NOEXCEPT;
103 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000104};
105
106class _LIBCPP_EXCEPTION_ABI bad_exception
107 : public exception
108{
109public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000110 _LIBCPP_INLINE_VISIBILITY bad_exception() _NOEXCEPT {}
111 virtual ~bad_exception() _NOEXCEPT;
112 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000113};
Shoaib Meenaicfd19602017-10-09 19:25:17 +0000114#endif // !_LIBCPP_ABI_MICROSOFT || _LIBCPP_NO_VCRUNTIME
Howard Hinnantc51e1022010-05-11 19:42:16 +0000115
Eric Fiselierddd77792017-02-17 03:25:08 +0000116#if _LIBCPP_STD_VER <= 14 \
117 || defined(_LIBCPP_ENABLE_CXX17_REMOVED_UNEXPECTED_FUNCTIONS) \
118 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000119typedef void (*unexpected_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000120_LIBCPP_FUNC_VIS unexpected_handler set_unexpected(unexpected_handler) _NOEXCEPT;
121_LIBCPP_FUNC_VIS unexpected_handler get_unexpected() _NOEXCEPT;
122_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void unexpected();
Eric Fiselierddd77792017-02-17 03:25:08 +0000123#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000124
125typedef void (*terminate_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000126_LIBCPP_FUNC_VIS terminate_handler set_terminate(terminate_handler) _NOEXCEPT;
127_LIBCPP_FUNC_VIS terminate_handler get_terminate() _NOEXCEPT;
128_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void terminate() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000129
Howard Hinnant8331b762013-03-06 23:30:19 +0000130_LIBCPP_FUNC_VIS bool uncaught_exception() _NOEXCEPT;
Mehdi Amini228053d2017-05-04 17:08:54 +0000131_LIBCPP_FUNC_VIS _LIBCPP_AVAILABILITY_UNCAUGHT_EXCEPTIONS int uncaught_exceptions() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000132
Howard Hinnant8331b762013-03-06 23:30:19 +0000133class _LIBCPP_TYPE_VIS exception_ptr;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000134
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000135_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
136_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000137
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000138#ifndef _LIBCPP_ABI_MICROSOFT
139
Howard Hinnant8331b762013-03-06 23:30:19 +0000140class _LIBCPP_TYPE_VIS exception_ptr
Howard Hinnantc51e1022010-05-11 19:42:16 +0000141{
142 void* __ptr_;
143public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000144 _LIBCPP_INLINE_VISIBILITY exception_ptr() _NOEXCEPT : __ptr_() {}
145 _LIBCPP_INLINE_VISIBILITY exception_ptr(nullptr_t) _NOEXCEPT : __ptr_() {}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000146
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000147 exception_ptr(const exception_ptr&) _NOEXCEPT;
148 exception_ptr& operator=(const exception_ptr&) _NOEXCEPT;
149 ~exception_ptr() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000150
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000151 _LIBCPP_INLINE_VISIBILITY _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT
152 {return __ptr_ != nullptr;}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000153
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000154 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000155 bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000156 {return __x.__ptr_ == __y.__ptr_;}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000157
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000158 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000159 bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000160 {return !(__x == __y);}
161
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000162 friend _LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
163 friend _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000164};
165
Howard Hinnantc834c512011-11-29 18:15:50 +0000166template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000167_LIBCPP_INLINE_VISIBILITY exception_ptr
Howard Hinnantc834c512011-11-29 18:15:50 +0000168make_exception_ptr(_Ep __e) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000169{
Howard Hinnant72f73582010-08-11 17:04:31 +0000170#ifndef _LIBCPP_NO_EXCEPTIONS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000171 try
172 {
173 throw __e;
174 }
175 catch (...)
176 {
177 return current_exception();
178 }
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000179#else
Eric Fiselier6003c772016-12-23 23:37:52 +0000180 ((void)__e);
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000181 _VSTD::abort();
182#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000183}
184
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000185#else // _LIBCPP_ABI_MICROSOFT
186
187class _LIBCPP_TYPE_VIS exception_ptr
188{
189#if defined(__clang__)
190#pragma clang diagnostic push
191#pragma clang diagnostic ignored "-Wunused-private-field"
192#endif
193 void* __ptr1_;
194 void* __ptr2_;
195#if defined(__clang__)
196#pragma clang diagnostic pop
197#endif
198public:
199 exception_ptr() _NOEXCEPT;
200 exception_ptr(nullptr_t) _NOEXCEPT;
201 exception_ptr(const exception_ptr& __other) _NOEXCEPT;
202 exception_ptr& operator=(const exception_ptr& __other) _NOEXCEPT;
203 exception_ptr& operator=(nullptr_t) _NOEXCEPT;
204 ~exception_ptr() _NOEXCEPT;
205 _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT;
206};
207
208_LIBCPP_FUNC_VIS
209bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT;
210
211inline _LIBCPP_INLINE_VISIBILITY
212bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
213 {return !(__x == __y);}
214
215_LIBCPP_FUNC_VIS void swap(exception_ptr&, exception_ptr&) _NOEXCEPT;
216
217_LIBCPP_FUNC_VIS exception_ptr __copy_exception_ptr(void *__except, const void* __ptr);
218_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
219_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr p);
220
221// This is a built-in template function which automagically extracts the required
222// information.
223template <class _E> void *__GetExceptionInfo(_E);
224
225template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000226_LIBCPP_INLINE_VISIBILITY exception_ptr
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000227make_exception_ptr(_Ep __e) _NOEXCEPT
228{
229 return __copy_exception_ptr(_VSTD::addressof(__e), __GetExceptionInfo(__e));
230}
231
232#endif // _LIBCPP_ABI_MICROSOFT
Howard Hinnante4f92722010-05-27 17:06:52 +0000233// nested_exception
234
235class _LIBCPP_EXCEPTION_ABI nested_exception
236{
237 exception_ptr __ptr_;
238public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000239 nested_exception() _NOEXCEPT;
240// nested_exception(const nested_exception&) noexcept = default;
241// nested_exception& operator=(const nested_exception&) noexcept = default;
242 virtual ~nested_exception() _NOEXCEPT;
Howard Hinnante4f92722010-05-27 17:06:52 +0000243
244 // access functions
Richard Smithcabd3922012-07-26 02:04:22 +0000245 _LIBCPP_NORETURN void rethrow_nested() const;
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000246 _LIBCPP_INLINE_VISIBILITY exception_ptr nested_ptr() const _NOEXCEPT {return __ptr_;}
Howard Hinnante4f92722010-05-27 17:06:52 +0000247};
248
249template <class _Tp>
250struct __nested
251 : public _Tp,
252 public nested_exception
253{
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000254 _LIBCPP_INLINE_VISIBILITY explicit __nested(const _Tp& __t) : _Tp(__t) {}
Howard Hinnante4f92722010-05-27 17:06:52 +0000255};
256
Howard Hinnant72f73582010-08-11 17:04:31 +0000257#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000258template <class _Tp, class _Up, bool>
259struct __throw_with_nested;
260
261template <class _Tp, class _Up>
262struct __throw_with_nested<_Tp, _Up, true> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000263 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000264#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000265 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000266#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000267 __do_throw (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000268#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000269 {
270 throw __nested<_Up>(_VSTD::forward<_Tp>(__t));
271 }
272};
273
274template <class _Tp, class _Up>
275struct __throw_with_nested<_Tp, _Up, false> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000276 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000277#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000278 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000279#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000280 __do_throw (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000281#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000282 {
283 throw _VSTD::forward<_Tp>(__t);
284 }
285};
Howard Hinnant72f73582010-08-11 17:04:31 +0000286#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000287
288template <class _Tp>
Richard Smithcabd3922012-07-26 02:04:22 +0000289_LIBCPP_NORETURN
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000290void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000291#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000292throw_with_nested(_Tp&& __t)
293#else
294throw_with_nested (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000295#endif // _LIBCPP_CXX03_LANG
Howard Hinnante4f92722010-05-27 17:06:52 +0000296{
Howard Hinnant72f73582010-08-11 17:04:31 +0000297#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clow94a38502017-04-13 16:57:42 +0000298 typedef typename decay<_Tp>::type _Up;
299 static_assert( is_copy_constructible<_Up>::value, "type thrown must be CopyConstructible");
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000300 __throw_with_nested<_Tp, _Up,
301 is_class<_Up>::value &&
302 !is_base_of<nested_exception, _Up>::value &&
303 !__libcpp_is_final<_Up>::value>::
304 __do_throw(_VSTD::forward<_Tp>(__t));
Eric Fiselier6003c772016-12-23 23:37:52 +0000305#else
306 ((void)__t);
307 // FIXME: Make this abort
Howard Hinnant72f73582010-08-11 17:04:31 +0000308#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000309}
310
Marshall Clowb75c89c2017-03-14 17:08:47 +0000311template <class _From, class _To>
312struct __can_dynamic_cast : public _LIBCPP_BOOL_CONSTANT(
313 is_polymorphic<_From>::value &&
314 (!is_base_of<_To, _From>::value ||
315 is_convertible<const _From*, const _To*>::value)) {};
316
Howard Hinnantc834c512011-11-29 18:15:50 +0000317template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000318inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000319void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000320rethrow_if_nested(const _Ep& __e,
321 typename enable_if< __can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000322{
Marshall Clowe993abe2015-12-14 18:01:56 +0000323 const nested_exception* __nep = dynamic_cast<const nested_exception*>(_VSTD::addressof(__e));
Howard Hinnant3615a192010-05-28 13:35:41 +0000324 if (__nep)
325 __nep->rethrow_nested();
Howard Hinnante4f92722010-05-27 17:06:52 +0000326}
327
Howard Hinnantc834c512011-11-29 18:15:50 +0000328template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000329inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000330void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000331rethrow_if_nested(const _Ep&,
332 typename enable_if<!__can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000333{
334}
335
Howard Hinnantc51e1022010-05-11 19:42:16 +0000336} // std
337
Howard Hinnantc51e1022010-05-11 19:42:16 +0000338#endif // _LIBCPP_EXCEPTION