exception 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. // Exception Handling support header for -*- C++ -*-
  2. // Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
  3. // 2004, 2005, 2006, 2007, 2008, 2009
  4. // Free Software Foundation
  5. //
  6. // This file is part of GCC.
  7. //
  8. // GCC is free software; you can redistribute it and/or modify
  9. // it under the terms of the GNU General Public License as published by
  10. // the Free Software Foundation; either version 3, or (at your option)
  11. // any later version.
  12. //
  13. // GCC is distributed in the hope that it will be useful,
  14. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. // GNU General Public License for more details.
  17. //
  18. // Under Section 7 of GPL version 3, you are granted additional
  19. // permissions described in the GCC Runtime Library Exception, version
  20. // 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/>.
  25. /** @file exception
  26. * This is a Standard C++ Library header.
  27. */
  28. #ifndef __EXCEPTION__
  29. #define __EXCEPTION__
  30. #pragma GCC visibility push(default)
  31. #include <bits/c++config.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() throw() { }
  54. virtual ~exception() throw();
  55. /** Returns a C-style character string describing the general cause
  56. * of the current error. */
  57. virtual const char* what() const throw();
  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() throw() { }
  65. // This declaration is not useless:
  66. // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
  67. virtual ~bad_exception() throw();
  68. // See comment in eh_exception.cc.
  69. virtual const char* what() const throw();
  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) throw();
  77. /** The runtime will call this function if %exception handling must be
  78. * abandoned for any reason. It can also be called by the user. */
  79. void terminate() __attribute__ ((__noreturn__));
  80. /// Takes a new handler function as an argument, returns the old function.
  81. unexpected_handler set_unexpected(unexpected_handler) throw();
  82. /** The runtime will call this function if an %exception is thrown which
  83. * violates the function's %exception specification. */
  84. void unexpected() __attribute__ ((__noreturn__));
  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. */
  95. bool uncaught_exception() throw();
  96. // @} group exceptions
  97. } // namespace std
  98. _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
  99. /**
  100. * @brief A replacement for the standard terminate_handler which
  101. * prints more information about the terminating exception (if any)
  102. * on stderr.
  103. *
  104. * @ingroup exceptions
  105. *
  106. * Call
  107. * @code
  108. * std::set_terminate(__gnu_cxx::__verbose_terminate_handler)
  109. * @endcode
  110. * to use. For more info, see
  111. * http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt02ch06s02.html
  112. *
  113. * In 3.4 and later, this is on by default.
  114. */
  115. void __verbose_terminate_handler();
  116. _GLIBCXX_END_NAMESPACE
  117. } // extern "C++"
  118. #pragma GCC visibility pop
  119. #if (defined(__GXX_EXPERIMENTAL_CXX0X__) \
  120. && defined(_GLIBCXX_ATOMIC_BUILTINS_4))
  121. #include <exception_ptr.h>
  122. #endif
  123. #endif