exception 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. // Exception Handling support header for -*- C++ -*-
  2. // Copyright (C) 1995-2015 Free Software Foundation, Inc.
  3. //
  4. // This file is part of GCC.
  5. //
  6. // GCC is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU General Public License as published by
  8. // the Free Software Foundation; either version 3, or (at your option)
  9. // any later version.
  10. //
  11. // GCC is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU General Public License for more details.
  15. //
  16. // Under Section 7 of GPL version 3, you are granted additional
  17. // permissions described in the GCC Runtime Library Exception, version
  18. // 3.1, as published by the Free Software Foundation.
  19. // You should have received a copy of the GNU General Public License and
  20. // a copy of the GCC Runtime Library Exception along with this program;
  21. // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
  22. // <http://www.gnu.org/licenses/>.
  23. /** @file exception
  24. * This is a Standard C++ Library header.
  25. */
  26. #ifndef __EXCEPTION__
  27. #define __EXCEPTION__
  28. #pragma GCC system_header
  29. #pragma GCC visibility push(default)
  30. #include <bits/c++config.h>
  31. #include <bits/atomic_lockfree_defines.h>
  32. extern "C++" {
  33. namespace std
  34. {
  35. /**
  36. * @defgroup exceptions Exceptions
  37. * @ingroup diagnostics
  38. *
  39. * Classes and functions for reporting errors via exception classes.
  40. * @{
  41. */
  42. /**
  43. * @brief Base class for all library exceptions.
  44. *
  45. * This is the base class for all exceptions thrown by the standard
  46. * library, and by certain language expressions. You are free to derive
  47. * your own %exception classes, or use a different hierarchy, or to
  48. * throw non-class data (e.g., fundamental types).
  49. */
  50. class exception
  51. {
  52. public:
  53. exception() _GLIBCXX_USE_NOEXCEPT { }
  54. virtual ~exception() _GLIBCXX_USE_NOEXCEPT;
  55. /** Returns a C-style character string describing the general cause
  56. * of the current error. */
  57. virtual const char* what() const _GLIBCXX_USE_NOEXCEPT;
  58. };
  59. /** If an %exception is thrown which is not listed in a function's
  60. * %exception specification, one of these may be thrown. */
  61. class bad_exception : public exception
  62. {
  63. public:
  64. bad_exception() _GLIBCXX_USE_NOEXCEPT { }
  65. // This declaration is not useless:
  66. // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
  67. virtual ~bad_exception() _GLIBCXX_USE_NOEXCEPT;
  68. // See comment in eh_exception.cc.
  69. virtual const char* what() const _GLIBCXX_USE_NOEXCEPT;
  70. };
  71. /// If you write a replacement %terminate handler, it must be of this type.
  72. typedef void (*terminate_handler) ();
  73. /// If you write a replacement %unexpected handler, it must be of this type.
  74. typedef void (*unexpected_handler) ();
  75. /// Takes a new handler function as an argument, returns the old function.
  76. terminate_handler set_terminate(terminate_handler) _GLIBCXX_USE_NOEXCEPT;
  77. #if __cplusplus >= 201103L
  78. /// Return the current terminate handler.
  79. terminate_handler get_terminate() noexcept;
  80. #endif
  81. /** The runtime will call this function if %exception handling must be
  82. * abandoned for any reason. It can also be called by the user. */
  83. void terminate() _GLIBCXX_USE_NOEXCEPT __attribute__ ((__noreturn__));
  84. /// Takes a new handler function as an argument, returns the old function.
  85. unexpected_handler set_unexpected(unexpected_handler) _GLIBCXX_USE_NOEXCEPT;
  86. #if __cplusplus >= 201103L
  87. /// Return the current unexpected handler.
  88. unexpected_handler get_unexpected() noexcept;
  89. #endif
  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__));
  93. /** [18.6.4]/1: 'Returns true after completing evaluation of a
  94. * throw-expression until either completing initialization of the
  95. * exception-declaration in the matching handler or entering @c unexpected()
  96. * due to the throw; or after entering @c terminate() for any reason
  97. * other than an explicit call to @c terminate(). [Note: This includes
  98. * stack unwinding [15.2]. end note]'
  99. *
  100. * 2: 'When @c uncaught_exception() is true, throwing an
  101. * %exception can result in a call of @c terminate()
  102. * (15.5.1).'
  103. */
  104. bool uncaught_exception() _GLIBCXX_USE_NOEXCEPT __attribute__ ((__pure__));
  105. // @} group exceptions
  106. } // namespace std
  107. namespace __gnu_cxx
  108. {
  109. _GLIBCXX_BEGIN_NAMESPACE_VERSION
  110. /**
  111. * @brief A replacement for the standard terminate_handler which
  112. * prints more information about the terminating exception (if any)
  113. * on stderr.
  114. *
  115. * @ingroup exceptions
  116. *
  117. * Call
  118. * @code
  119. * std::set_terminate(__gnu_cxx::__verbose_terminate_handler)
  120. * @endcode
  121. * to use. For more info, see
  122. * http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt02ch06s02.html
  123. *
  124. * In 3.4 and later, this is on by default.
  125. */
  126. void __verbose_terminate_handler();
  127. _GLIBCXX_END_NAMESPACE_VERSION
  128. } // namespace
  129. } // extern "C++"
  130. #pragma GCC visibility pop
  131. #if (__cplusplus >= 201103L) && (ATOMIC_INT_LOCK_FREE > 1)
  132. #include <bits/exception_ptr.h>
  133. #include <bits/nested_exception.h>
  134. #endif
  135. #endif