<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libstdc++: exception Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.4 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libstdc++</div> </td> </tr> </tbody> </table> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('a00863.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">exception</div> </div> </div> <div class="contents"> <a href="a00863.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Exception Handling support header for -*- C++ -*-</span> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">// Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,</span> <a name="l00004"></a>00004 <span class="comment">// 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011</span> <a name="l00005"></a>00005 <span class="comment">// Free Software Foundation</span> <a name="l00006"></a>00006 <span class="comment">//</span> <a name="l00007"></a>00007 <span class="comment">// This file is part of GCC.</span> <a name="l00008"></a>00008 <span class="comment">//</span> <a name="l00009"></a>00009 <span class="comment">// GCC is free software; you can redistribute it and/or modify</span> <a name="l00010"></a>00010 <span class="comment">// it under the terms of the GNU General Public License as published by</span> <a name="l00011"></a>00011 <span class="comment">// the Free Software Foundation; either version 3, or (at your option)</span> <a name="l00012"></a>00012 <span class="comment">// any later version.</span> <a name="l00013"></a>00013 <span class="comment">//</span> <a name="l00014"></a>00014 <span class="comment">// GCC is distributed in the hope that it will be useful,</span> <a name="l00015"></a>00015 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00016"></a>00016 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00017"></a>00017 <span class="comment">// GNU General Public License for more details.</span> <a name="l00018"></a>00018 <span class="comment">//</span> <a name="l00019"></a>00019 <span class="comment">// Under Section 7 of GPL version 3, you are granted additional</span> <a name="l00020"></a>00020 <span class="comment">// permissions described in the GCC Runtime Library Exception, version</span> <a name="l00021"></a>00021 <span class="comment">// 3.1, as published by the Free Software Foundation.</span> <a name="l00022"></a>00022 <a name="l00023"></a>00023 <span class="comment">// You should have received a copy of the GNU General Public License and</span> <a name="l00024"></a>00024 <span class="comment">// a copy of the GCC Runtime Library Exception along with this program;</span> <a name="l00025"></a>00025 <span class="comment">// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see</span> <a name="l00026"></a>00026 <span class="comment">// <http://www.gnu.org/licenses/>.</span> <a name="l00027"></a>00027 <span class="comment"></span> <a name="l00028"></a>00028 <span class="comment">/** @file exception</span> <a name="l00029"></a>00029 <span class="comment"> * This is a Standard C++ Library header.</span> <a name="l00030"></a>00030 <span class="comment"> */</span> <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="preprocessor">#ifndef __EXCEPTION__</span> <a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define __EXCEPTION__</span> <a name="l00034"></a>00034 <span class="preprocessor"></span> <a name="l00035"></a>00035 <span class="preprocessor">#pragma GCC system_header</span> <a name="l00036"></a>00036 <span class="preprocessor"></span> <a name="l00037"></a>00037 <span class="preprocessor">#pragma GCC visibility push(default)</span> <a name="l00038"></a>00038 <span class="preprocessor"></span> <a name="l00039"></a>00039 <span class="preprocessor">#include <<a class="code" href="a00781.html">bits/c++config.h</a>></span> <a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="keyword">extern</span> <span class="stringliteral">"C++"</span> { <a name="l00042"></a>00042 <a name="l00043"></a>00043 <span class="keyword">namespace </span>std <a name="l00044"></a>00044 {<span class="comment"></span> <a name="l00045"></a>00045 <span class="comment"> /**</span> <a name="l00046"></a>00046 <span class="comment"> * @defgroup exceptions Exceptions</span> <a name="l00047"></a>00047 <span class="comment"> * @ingroup diagnostics</span> <a name="l00048"></a>00048 <span class="comment"> *</span> <a name="l00049"></a>00049 <span class="comment"> * Classes and functions for reporting errors via exception classes.</span> <a name="l00050"></a>00050 <span class="comment"> * @{</span> <a name="l00051"></a>00051 <span class="comment"> */</span> <a name="l00052"></a>00052 <span class="comment"></span> <a name="l00053"></a>00053 <span class="comment"> /**</span> <a name="l00054"></a>00054 <span class="comment"> * @brief Base class for all library exceptions.</span> <a name="l00055"></a>00055 <span class="comment"> *</span> <a name="l00056"></a>00056 <span class="comment"> * This is the base class for all exceptions thrown by the standard</span> <a name="l00057"></a>00057 <span class="comment"> * library, and by certain language expressions. You are free to derive</span> <a name="l00058"></a>00058 <span class="comment"> * your own %exception classes, or use a different hierarchy, or to</span> <a name="l00059"></a>00059 <span class="comment"> * throw non-class data (e.g., fundamental types).</span> <a name="l00060"></a>00060 <span class="comment"> */</span> <a name="l00061"></a><a class="code" href="a00466.html">00061</a> <span class="keyword">class </span><a class="code" href="a00466.html" title="Base class for all library exceptions.">exception</a> <a name="l00062"></a>00062 { <a name="l00063"></a>00063 <span class="keyword">public</span>: <a name="l00064"></a>00064 <a class="code" href="a00466.html" title="Base class for all library exceptions.">exception</a>() <span class="keywordflow">throw</span>() { } <a name="l00065"></a>00065 <span class="keyword">virtual</span> ~<a class="code" href="a00466.html" title="Base class for all library exceptions.">exception</a>() <span class="keywordflow">throw</span>(); <a name="l00066"></a>00066 <span class="comment"></span> <a name="l00067"></a>00067 <span class="comment"> /** Returns a C-style character string describing the general cause</span> <a name="l00068"></a>00068 <span class="comment"> * of the current error. */</span> <a name="l00069"></a>00069 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a00466.html#af24d0d59881ce88808f4c772f4669370">what</a>() <span class="keyword">const</span> <span class="keywordflow">throw</span>(); <a name="l00070"></a>00070 }; <a name="l00071"></a>00071 <span class="comment"></span> <a name="l00072"></a>00072 <span class="comment"> /** If an %exception is thrown which is not listed in a function's</span> <a name="l00073"></a>00073 <span class="comment"> * %exception specification, one of these may be thrown. */</span> <a name="l00074"></a><a class="code" href="a00391.html">00074</a> <span class="keyword">class </span><a class="code" href="a00391.html">bad_exception</a> : <span class="keyword">public</span> <a class="code" href="a00466.html" title="Base class for all library exceptions.">exception</a> <a name="l00075"></a>00075 { <a name="l00076"></a>00076 <span class="keyword">public</span>: <a name="l00077"></a>00077 <a class="code" href="a00391.html">bad_exception</a>() <span class="keywordflow">throw</span>() { } <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="comment">// This declaration is not useless:</span> <a name="l00080"></a>00080 <span class="comment">// http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118</span> <a name="l00081"></a>00081 <span class="keyword">virtual</span> ~<a class="code" href="a00391.html">bad_exception</a>() <span class="keywordflow">throw</span>(); <a name="l00082"></a>00082 <a name="l00083"></a>00083 <span class="comment">// See comment in eh_exception.cc.</span> <a name="l00084"></a>00084 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a00391.html#a764026483dbeb4a7181feb5d7af4dac7">what</a>() <span class="keyword">const</span> <span class="keywordflow">throw</span>(); <a name="l00085"></a>00085 }; <a name="l00086"></a>00086 <span class="comment"></span> <a name="l00087"></a>00087 <span class="comment"> /// If you write a replacement %terminate handler, it must be of this type.</span> <a name="l00088"></a><a class="code" href="a01164.html#gac6afb78180be4f4f841ae9d32f538f00">00088</a> <span class="comment"></span> <span class="keyword">typedef</span> void (*<a class="code" href="a01164.html#gac6afb78180be4f4f841ae9d32f538f00" title="If you write a replacement terminate handler, it must be of this type.">terminate_handler</a>) (); <a name="l00089"></a>00089 <span class="comment"></span> <a name="l00090"></a>00090 <span class="comment"> /// If you write a replacement %unexpected handler, it must be of this type.</span> <a name="l00091"></a><a class="code" href="a01164.html#gaeeec922393be8c20662a12875c1d09f0">00091</a> <span class="comment"></span> <span class="keyword">typedef</span> void (*<a class="code" href="a01164.html#gaeeec922393be8c20662a12875c1d09f0" title="If you write a replacement unexpected handler, it must be of this type.">unexpected_handler</a>) (); <a name="l00092"></a>00092 <span class="comment"></span> <a name="l00093"></a>00093 <span class="comment"> /// Takes a new handler function as an argument, returns the old function.</span> <a name="l00094"></a>00094 <span class="comment"></span> <a class="code" href="a01164.html#gac6afb78180be4f4f841ae9d32f538f00" title="If you write a replacement terminate handler, it must be of this type.">terminate_handler</a> <a class="code" href="a01164.html#ga30183fa17e6e22fdbdf8f9c632ce586d" title="Takes a new handler function as an argument, returns the old function.">set_terminate</a>(<a class="code" href="a01164.html#gac6afb78180be4f4f841ae9d32f538f00" title="If you write a replacement terminate handler, it must be of this type.">terminate_handler</a>) throw(); <a name="l00095"></a>00095 <span class="comment"></span> <a name="l00096"></a>00096 <span class="comment"> /** The runtime will call this function if %exception handling must be</span> <a name="l00097"></a>00097 <span class="comment"> * abandoned for any reason. It can also be called by the user. */</span> <a name="l00098"></a>00098 <span class="keywordtype">void</span> <a class="code" href="a01164.html#ga5660db471c0077adee5528da17fa9299">terminate</a>() throw() __attribute__ ((__noreturn__)); <a name="l00099"></a>00099 <span class="comment"></span> <a name="l00100"></a>00100 <span class="comment"> /// Takes a new handler function as an argument, returns the old function.</span> <a name="l00101"></a>00101 <span class="comment"></span> <a class="code" href="a01164.html#gaeeec922393be8c20662a12875c1d09f0" title="If you write a replacement unexpected handler, it must be of this type.">unexpected_handler</a> <a class="code" href="a01164.html#gaa1e41141899002f3594018907080ac18" title="Takes a new handler function as an argument, returns the old function.">set_unexpected</a>(<a class="code" href="a01164.html#gaeeec922393be8c20662a12875c1d09f0" title="If you write a replacement unexpected handler, it must be of this type.">unexpected_handler</a>) throw(); <a name="l00102"></a>00102 <span class="comment"></span> <a name="l00103"></a>00103 <span class="comment"> /** The runtime will call this function if an %exception is thrown which</span> <a name="l00104"></a>00104 <span class="comment"> * violates the function's %exception specification. */</span> <a name="l00105"></a>00105 <span class="keywordtype">void</span> <a class="code" href="a01164.html#ga742bf00b19772819acc97ae5e8f4bebe">unexpected</a>() __attribute__ ((__noreturn__)); <a name="l00106"></a>00106 <span class="comment"></span> <a name="l00107"></a>00107 <span class="comment"> /** [18.6.4]/1: 'Returns true after completing evaluation of a</span> <a name="l00108"></a>00108 <span class="comment"> * throw-expression until either completing initialization of the</span> <a name="l00109"></a>00109 <span class="comment"> * exception-declaration in the matching handler or entering @c unexpected()</span> <a name="l00110"></a>00110 <span class="comment"> * due to the throw; or after entering @c terminate() for any reason</span> <a name="l00111"></a>00111 <span class="comment"> * other than an explicit call to @c terminate(). [Note: This includes</span> <a name="l00112"></a>00112 <span class="comment"> * stack unwinding [15.2]. end note]'</span> <a name="l00113"></a>00113 <span class="comment"> *</span> <a name="l00114"></a>00114 <span class="comment"> * 2: 'When @c uncaught_exception() is true, throwing an</span> <a name="l00115"></a>00115 <span class="comment"> * %exception can result in a call of @c terminate()</span> <a name="l00116"></a>00116 <span class="comment"> * (15.5.1).'</span> <a name="l00117"></a>00117 <span class="comment"> */</span> <a name="l00118"></a>00118 <span class="keywordtype">bool</span> <a class="code" href="a01164.html#ga5e8d5961daae4336bc516fcf047c67b3">uncaught_exception</a>() throw() __attribute__ ((__pure__)); <a name="l00119"></a>00119 <a name="l00120"></a>00120 <span class="comment">// @} group exceptions</span> <a name="l00121"></a>00121 } <span class="comment">// namespace std</span> <a name="l00122"></a>00122 <a name="l00123"></a>00123 namespace __gnu_cxx <a name="l00124"></a>00124 { <a name="l00125"></a>00125 _GLIBCXX_BEGIN_NAMESPACE_VERSION <a name="l00126"></a>00126 <span class="comment"></span> <a name="l00127"></a>00127 <span class="comment"> /**</span> <a name="l00128"></a>00128 <span class="comment"> * @brief A replacement for the standard terminate_handler which</span> <a name="l00129"></a>00129 <span class="comment"> * prints more information about the terminating exception (if any)</span> <a name="l00130"></a>00130 <span class="comment"> * on stderr.</span> <a name="l00131"></a>00131 <span class="comment"> *</span> <a name="l00132"></a>00132 <span class="comment"> * @ingroup exceptions</span> <a name="l00133"></a>00133 <span class="comment"> *</span> <a name="l00134"></a>00134 <span class="comment"> * Call</span> <a name="l00135"></a>00135 <span class="comment"> * @code</span> <a name="l00136"></a>00136 <span class="comment"> * std::set_terminate(__gnu_cxx::__verbose_terminate_handler)</span> <a name="l00137"></a>00137 <span class="comment"> * @endcode</span> <a name="l00138"></a>00138 <span class="comment"> * to use. For more info, see</span> <a name="l00139"></a>00139 <span class="comment"> * http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt02ch06s02.html</span> <a name="l00140"></a>00140 <span class="comment"> *</span> <a name="l00141"></a>00141 <span class="comment"> * In 3.4 and later, this is on by default.</span> <a name="l00142"></a>00142 <span class="comment"> */</span> <a name="l00143"></a>00143 <span class="keywordtype">void</span> <a class="code" href="a01164.html#gaf51888cedbc669a114cd79e39e0cd9be" title="A replacement for the standard terminate_handler which prints more information about the terminating ...">__verbose_terminate_handler</a>(); <a name="l00144"></a>00144 <a name="l00145"></a>00145 _GLIBCXX_END_NAMESPACE_VERSION <a name="l00146"></a>00146 } <span class="comment">// namespace</span> <a name="l00147"></a>00147 <a name="l00148"></a>00148 } <span class="comment">// extern "C++"</span> <a name="l00149"></a>00149 <a name="l00150"></a>00150 <span class="preprocessor">#pragma GCC visibility pop</span> <a name="l00151"></a>00151 <span class="preprocessor"></span> <a name="l00152"></a>00152 <span class="preprocessor">#if (defined(__GXX_EXPERIMENTAL_CXX0X__) \</span> <a name="l00153"></a>00153 <span class="preprocessor"> && defined(_GLIBCXX_ATOMIC_BUILTINS_4))</span> <a name="l00154"></a>00154 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00866.html">bits/exception_ptr.h</a>></span> <a name="l00155"></a>00155 <span class="preprocessor">#include <<a class="code" href="a00956.html">bits/nested_exception.h</a>></span> <a name="l00156"></a>00156 <span class="preprocessor">#endif</span> <a name="l00157"></a>00157 <span class="preprocessor"></span> <a name="l00158"></a>00158 <span class="preprocessor">#endif</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="a00863.html">exception</a> </li> <li class="footer">Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li> </ul> </div> </body> </html>