blob: b517486b5a8ee4e87a0ce173fb0ffaa39befd015 [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>
Howard Hinnantc51e1022010-05-11 19:42:16 +000084
Shoaib Meenaicfd19602017-10-09 19:25:17 +000085#if defined(_LIBCPP_ABI_MICROSOFT) && !defined(_LIBCPP_NO_VCRUNTIME)
Eric Fiselierec3a1672017-02-10 08:57:35 +000086#include <vcruntime_exception.h>
87#endif
88
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000089#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000090#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000091#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000092
93namespace std // purposefully not using versioning namespace
94{
95
Shoaib Meenaicfd19602017-10-09 19:25:17 +000096#if !defined(_LIBCPP_ABI_MICROSOFT) || defined(_LIBCPP_NO_VCRUNTIME)
Howard Hinnantc51e1022010-05-11 19:42:16 +000097class _LIBCPP_EXCEPTION_ABI exception
98{
99public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000100 _LIBCPP_INLINE_VISIBILITY exception() _NOEXCEPT {}
101 virtual ~exception() _NOEXCEPT;
102 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000103};
104
105class _LIBCPP_EXCEPTION_ABI bad_exception
106 : public exception
107{
108public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000109 _LIBCPP_INLINE_VISIBILITY bad_exception() _NOEXCEPT {}
110 virtual ~bad_exception() _NOEXCEPT;
111 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000112};
Shoaib Meenaicfd19602017-10-09 19:25:17 +0000113#endif // !_LIBCPP_ABI_MICROSOFT || _LIBCPP_NO_VCRUNTIME
Howard Hinnantc51e1022010-05-11 19:42:16 +0000114
Eric Fiselierddd77792017-02-17 03:25:08 +0000115#if _LIBCPP_STD_VER <= 14 \
116 || defined(_LIBCPP_ENABLE_CXX17_REMOVED_UNEXPECTED_FUNCTIONS) \
117 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000118typedef void (*unexpected_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000119_LIBCPP_FUNC_VIS unexpected_handler set_unexpected(unexpected_handler) _NOEXCEPT;
120_LIBCPP_FUNC_VIS unexpected_handler get_unexpected() _NOEXCEPT;
121_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void unexpected();
Eric Fiselierddd77792017-02-17 03:25:08 +0000122#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000123
124typedef void (*terminate_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000125_LIBCPP_FUNC_VIS terminate_handler set_terminate(terminate_handler) _NOEXCEPT;
126_LIBCPP_FUNC_VIS terminate_handler get_terminate() _NOEXCEPT;
127_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void terminate() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000128
Howard Hinnant8331b762013-03-06 23:30:19 +0000129_LIBCPP_FUNC_VIS bool uncaught_exception() _NOEXCEPT;
Mehdi Amini228053d2017-05-04 17:08:54 +0000130_LIBCPP_FUNC_VIS _LIBCPP_AVAILABILITY_UNCAUGHT_EXCEPTIONS int uncaught_exceptions() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000131
Howard Hinnant8331b762013-03-06 23:30:19 +0000132class _LIBCPP_TYPE_VIS exception_ptr;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000133
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000134_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
135_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000136
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000137#ifndef _LIBCPP_ABI_MICROSOFT
138
Howard Hinnant8331b762013-03-06 23:30:19 +0000139class _LIBCPP_TYPE_VIS exception_ptr
Howard Hinnantc51e1022010-05-11 19:42:16 +0000140{
141 void* __ptr_;
142public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000143 _LIBCPP_INLINE_VISIBILITY exception_ptr() _NOEXCEPT : __ptr_() {}
144 _LIBCPP_INLINE_VISIBILITY exception_ptr(nullptr_t) _NOEXCEPT : __ptr_() {}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000145
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000146 exception_ptr(const exception_ptr&) _NOEXCEPT;
147 exception_ptr& operator=(const exception_ptr&) _NOEXCEPT;
148 ~exception_ptr() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000149
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000150 _LIBCPP_INLINE_VISIBILITY _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT
151 {return __ptr_ != nullptr;}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000152
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000153 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000154 bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000155 {return __x.__ptr_ == __y.__ptr_;}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000156
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000157 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000158 bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000159 {return !(__x == __y);}
160
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000161 friend _LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
162 friend _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000163};
164
Howard Hinnantc834c512011-11-29 18:15:50 +0000165template<class _Ep>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000166exception_ptr
Howard Hinnantc834c512011-11-29 18:15:50 +0000167make_exception_ptr(_Ep __e) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000168{
Howard Hinnant72f73582010-08-11 17:04:31 +0000169#ifndef _LIBCPP_NO_EXCEPTIONS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000170 try
171 {
172 throw __e;
173 }
174 catch (...)
175 {
176 return current_exception();
177 }
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000178#else
Eric Fiselier6003c772016-12-23 23:37:52 +0000179 ((void)__e);
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000180 _VSTD::abort();
181#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000182}
183
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000184#else // _LIBCPP_ABI_MICROSOFT
185
186class _LIBCPP_TYPE_VIS exception_ptr
187{
188#if defined(__clang__)
189#pragma clang diagnostic push
190#pragma clang diagnostic ignored "-Wunused-private-field"
191#endif
192 void* __ptr1_;
193 void* __ptr2_;
194#if defined(__clang__)
195#pragma clang diagnostic pop
196#endif
197public:
198 exception_ptr() _NOEXCEPT;
199 exception_ptr(nullptr_t) _NOEXCEPT;
200 exception_ptr(const exception_ptr& __other) _NOEXCEPT;
201 exception_ptr& operator=(const exception_ptr& __other) _NOEXCEPT;
202 exception_ptr& operator=(nullptr_t) _NOEXCEPT;
203 ~exception_ptr() _NOEXCEPT;
204 _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT;
205};
206
207_LIBCPP_FUNC_VIS
208bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT;
209
210inline _LIBCPP_INLINE_VISIBILITY
211bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
212 {return !(__x == __y);}
213
214_LIBCPP_FUNC_VIS void swap(exception_ptr&, exception_ptr&) _NOEXCEPT;
215
216_LIBCPP_FUNC_VIS exception_ptr __copy_exception_ptr(void *__except, const void* __ptr);
217_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
218_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr p);
219
220// This is a built-in template function which automagically extracts the required
221// information.
222template <class _E> void *__GetExceptionInfo(_E);
223
224template<class _Ep>
225exception_ptr
226make_exception_ptr(_Ep __e) _NOEXCEPT
227{
228 return __copy_exception_ptr(_VSTD::addressof(__e), __GetExceptionInfo(__e));
229}
230
231#endif // _LIBCPP_ABI_MICROSOFT
Howard Hinnante4f92722010-05-27 17:06:52 +0000232// nested_exception
233
234class _LIBCPP_EXCEPTION_ABI nested_exception
235{
236 exception_ptr __ptr_;
237public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000238 nested_exception() _NOEXCEPT;
239// nested_exception(const nested_exception&) noexcept = default;
240// nested_exception& operator=(const nested_exception&) noexcept = default;
241 virtual ~nested_exception() _NOEXCEPT;
Howard Hinnante4f92722010-05-27 17:06:52 +0000242
243 // access functions
Richard Smithcabd3922012-07-26 02:04:22 +0000244 _LIBCPP_NORETURN void rethrow_nested() const;
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000245 _LIBCPP_INLINE_VISIBILITY exception_ptr nested_ptr() const _NOEXCEPT {return __ptr_;}
Howard Hinnante4f92722010-05-27 17:06:52 +0000246};
247
248template <class _Tp>
249struct __nested
250 : public _Tp,
251 public nested_exception
252{
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000253 _LIBCPP_INLINE_VISIBILITY explicit __nested(const _Tp& __t) : _Tp(__t) {}
Howard Hinnante4f92722010-05-27 17:06:52 +0000254};
255
Howard Hinnant72f73582010-08-11 17:04:31 +0000256#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000257template <class _Tp, class _Up, bool>
258struct __throw_with_nested;
259
260template <class _Tp, class _Up>
261struct __throw_with_nested<_Tp, _Up, true> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000262 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000263#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000264 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000265#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000266 __do_throw (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000267#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000268 {
269 throw __nested<_Up>(_VSTD::forward<_Tp>(__t));
270 }
271};
272
273template <class _Tp, class _Up>
274struct __throw_with_nested<_Tp, _Up, false> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000275 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000276#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000277 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000278#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000279 __do_throw (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000280#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000281 {
282 throw _VSTD::forward<_Tp>(__t);
283 }
284};
Howard Hinnant72f73582010-08-11 17:04:31 +0000285#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000286
287template <class _Tp>
Richard Smithcabd3922012-07-26 02:04:22 +0000288_LIBCPP_NORETURN
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000289void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000290#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000291throw_with_nested(_Tp&& __t)
292#else
293throw_with_nested (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000294#endif // _LIBCPP_CXX03_LANG
Howard Hinnante4f92722010-05-27 17:06:52 +0000295{
Howard Hinnant72f73582010-08-11 17:04:31 +0000296#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clow94a38502017-04-13 16:57:42 +0000297 typedef typename decay<_Tp>::type _Up;
298 static_assert( is_copy_constructible<_Up>::value, "type thrown must be CopyConstructible");
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000299 __throw_with_nested<_Tp, _Up,
300 is_class<_Up>::value &&
301 !is_base_of<nested_exception, _Up>::value &&
302 !__libcpp_is_final<_Up>::value>::
303 __do_throw(_VSTD::forward<_Tp>(__t));
Eric Fiselier6003c772016-12-23 23:37:52 +0000304#else
305 ((void)__t);
306 // FIXME: Make this abort
Howard Hinnant72f73582010-08-11 17:04:31 +0000307#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000308}
309
Marshall Clowb75c89c2017-03-14 17:08:47 +0000310template <class _From, class _To>
311struct __can_dynamic_cast : public _LIBCPP_BOOL_CONSTANT(
312 is_polymorphic<_From>::value &&
313 (!is_base_of<_To, _From>::value ||
314 is_convertible<const _From*, const _To*>::value)) {};
315
Howard Hinnantc834c512011-11-29 18:15:50 +0000316template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000317inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000318void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000319rethrow_if_nested(const _Ep& __e,
320 typename enable_if< __can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000321{
Marshall Clowe993abe2015-12-14 18:01:56 +0000322 const nested_exception* __nep = dynamic_cast<const nested_exception*>(_VSTD::addressof(__e));
Howard Hinnant3615a192010-05-28 13:35:41 +0000323 if (__nep)
324 __nep->rethrow_nested();
Howard Hinnante4f92722010-05-27 17:06:52 +0000325}
326
Howard Hinnantc834c512011-11-29 18:15:50 +0000327template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000328inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000329void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000330rethrow_if_nested(const _Ep&,
331 typename enable_if<!__can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000332{
333}
334
Howard Hinnantc51e1022010-05-11 19:42:16 +0000335} // std
336
Howard Hinnantc51e1022010-05-11 19:42:16 +0000337#endif // _LIBCPP_EXCEPTION