xref: /dflybsd-src/contrib/gcc-8.0/libstdc++-v3/libsupc++/exception.h (revision 38fd149817dfbff97799f62fcb70be98c4e32523)
1*38fd1498Szrj // Exception Handling support header for -*- C++ -*-
2*38fd1498Szrj 
3*38fd1498Szrj // Copyright (C) 2016-2018 Free Software Foundation, Inc.
4*38fd1498Szrj //
5*38fd1498Szrj // This file is part of GCC.
6*38fd1498Szrj //
7*38fd1498Szrj // GCC is free software; you can redistribute it and/or modify
8*38fd1498Szrj // it under the terms of the GNU General Public License as published by
9*38fd1498Szrj // the Free Software Foundation; either version 3, or (at your option)
10*38fd1498Szrj // any later version.
11*38fd1498Szrj //
12*38fd1498Szrj // GCC is distributed in the hope that it will be useful,
13*38fd1498Szrj // but WITHOUT ANY WARRANTY; without even the implied warranty of
14*38fd1498Szrj // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15*38fd1498Szrj // GNU General Public License for more details.
16*38fd1498Szrj //
17*38fd1498Szrj // Under Section 7 of GPL version 3, you are granted additional
18*38fd1498Szrj // permissions described in the GCC Runtime Library Exception, version
19*38fd1498Szrj // 3.1, as published by the Free Software Foundation.
20*38fd1498Szrj 
21*38fd1498Szrj // You should have received a copy of the GNU General Public License and
22*38fd1498Szrj // a copy of the GCC Runtime Library Exception along with this program;
23*38fd1498Szrj // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
24*38fd1498Szrj // <http://www.gnu.org/licenses/>.
25*38fd1498Szrj 
26*38fd1498Szrj /** @file bits/exception.h
27*38fd1498Szrj  *  This is an internal header file, included by other library headers.
28*38fd1498Szrj  *  Do not attempt to use it directly.
29*38fd1498Szrj  */
30*38fd1498Szrj 
31*38fd1498Szrj #ifndef __EXCEPTION_H
32*38fd1498Szrj #define __EXCEPTION_H 1
33*38fd1498Szrj 
34*38fd1498Szrj #pragma GCC system_header
35*38fd1498Szrj 
36*38fd1498Szrj #pragma GCC visibility push(default)
37*38fd1498Szrj 
38*38fd1498Szrj #include <bits/c++config.h>
39*38fd1498Szrj 
40*38fd1498Szrj extern "C++" {
41*38fd1498Szrj 
42*38fd1498Szrj namespace std
43*38fd1498Szrj {
44*38fd1498Szrj   /**
45*38fd1498Szrj    * @defgroup exceptions Exceptions
46*38fd1498Szrj    * @ingroup diagnostics
47*38fd1498Szrj    *
48*38fd1498Szrj    * Classes and functions for reporting errors via exception classes.
49*38fd1498Szrj    * @{
50*38fd1498Szrj    */
51*38fd1498Szrj 
52*38fd1498Szrj   /**
53*38fd1498Szrj    *  @brief Base class for all library exceptions.
54*38fd1498Szrj    *
55*38fd1498Szrj    *  This is the base class for all exceptions thrown by the standard
56*38fd1498Szrj    *  library, and by certain language expressions.  You are free to derive
57*38fd1498Szrj    *  your own %exception classes, or use a different hierarchy, or to
58*38fd1498Szrj    *  throw non-class data (e.g., fundamental types).
59*38fd1498Szrj    */
60*38fd1498Szrj   class exception
61*38fd1498Szrj   {
62*38fd1498Szrj   public:
exception()63*38fd1498Szrj     exception() _GLIBCXX_USE_NOEXCEPT { }
64*38fd1498Szrj     virtual ~exception() _GLIBCXX_TXN_SAFE_DYN _GLIBCXX_USE_NOEXCEPT;
65*38fd1498Szrj 
66*38fd1498Szrj     /** Returns a C-style character string describing the general cause
67*38fd1498Szrj      *  of the current error.  */
68*38fd1498Szrj     virtual const char*
69*38fd1498Szrj     what() const _GLIBCXX_TXN_SAFE_DYN _GLIBCXX_USE_NOEXCEPT;
70*38fd1498Szrj   };
71*38fd1498Szrj 
72*38fd1498Szrj } // namespace std
73*38fd1498Szrj 
74*38fd1498Szrj }
75*38fd1498Szrj 
76*38fd1498Szrj #pragma GCC visibility pop
77*38fd1498Szrj 
78*38fd1498Szrj #endif
79