libstdc++-v3/libsupc++/exception

   1 // Exception Handling support header for -*- C++ -*-
   2
   3 // Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001 Free Software Foundation
   4 //
   5 // This file is part of GNU CC.
   6 //
   7 // GNU CC 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 2, or (at your option)
  10 // any later version.
  11 //
  12 // GNU CC 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.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with GNU CC; see the file COPYING.  If not, write to
  19 // the Free Software Foundation, 59 Temple Place - Suite 330,
  20 // Boston, MA 02111-1307, USA.
  21
  22 // As a special exception, you may use this file as part of a free software
  23 // library without restriction.  Specifically, if other files instantiate
  24 // templates or use macros or inline functions from this file, or you compile
  25 // this file and link it with other files to produce an executable, this
  26 // file does not by itself cause the resulting executable to be covered by
  27 // the GNU General Public License.  This exception does not however
  28 // invalidate any other reasons why the executable file might be covered by
  29 // the GNU General Public License.
  30
  31 /** @file exception
  32  *  This header defines several types and functions relating to the
  33  *  handling of exceptions in a C++ program.
  34  */
  35
  36 #ifndef __EXCEPTION__
  37 #define __EXCEPTION__
  38
  39 extern "C++" {
  40
  41 namespace std
  42 {
  43   /** This is the base class for all exceptions thrown by the standard
  44    *  library, and by certain language expressions.  You are free to derive
  45    *  your own %exception classes, or use a different hierarchy, or to
  46    *  throw non-class data (e.g., fundamental types).
  47    *  @brief Base class for all library exceptions.
  48    */
  49   class exception
  50   {
  51   public:
  52     exception() throw() { }
  53     virtual ~exception() throw();
  54     /** Returns a C-style character string describing the general cause
  55      *  of the current error.  */
  56     virtual const char* what() const throw();
  57   };
  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   };
  66
  67   /// If you write a replacement %terminate handler, it must be of this type.
  68   typedef void (*terminate_handler) ();
  69   /// If you write a replacement %unexpected handler, it must be of this type.
  70   typedef void (*unexpected_handler) ();
  71
  72   /// Takes a new handler function as an argument, returns the old function.
  73   terminate_handler set_terminate(terminate_handler) throw();
  74   /** The runtime will call this function if %exception handling must be
  75    *  abandoned for any reason.  */
  76   void terminate() __attribute__ ((__noreturn__));
  77
  78   /// Takes a new handler function as an argument, returns the old function.
  79   unexpected_handler set_unexpected(unexpected_handler) throw();
  80   /** The runtime will call this function if an %exception is thrown which
  81    *  violates the function's %exception specification.  */
  82   void unexpected() __attribute__ ((__noreturn__));
  83
  84   /** [18.6.4]/1:  "Returns true after completing evaluation of a
  85    *  throw-expression until either completing initialization of the
  86    *  exception-declaration in the matching handler or entering @c unexpected()
  87    *  due to the throw; or after entering @c terminate() for any reason
  88    *  other than an explicit call to @c terminate().  [Note: This includes
  89    *  stack unwinding [15.2].  end note]"
  90    *
  91    *  2:  "When @c uncaught_exception() is true, throwing an %exception can
  92    *  result in a call of @c terminate() (15.5.1)."
  93    */
  94   bool uncaught_exception() throw();
  95 } // namespace std
  96
  97 namespace __gnu_cxx
  98 {
  99   /** A replacement for the standard terminate_handler which prints more
 100       information about the terminating exception (if any) on stderr.
 101
 102         std::set_terminate (__gnu_cxx::__verbose_terminate_handler)
 103
 104       to use.  */
 105   void __verbose_terminate_handler ();
 106 } // namespace __gnu_cxx
 107
 108 } // extern "C++"
 109
 110 #endif