File: reference.adoc

package info (click to toggle)
boost1.74 1.74.0%2Bds1-21
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 463,588 kB
  • sloc: cpp: 3,338,117; xml: 131,293; python: 33,088; ansic: 14,292; asm: 4,038; sh: 3,353; makefile: 1,193; perl: 1,036; yacc: 478; php: 212; ruby: 102; lisp: 24; sql: 13; csh: 6
file content (98 lines) | stat: -rw-r--r-- 2,614 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
////
Copyright 2019 Peter Dimov
Distributed under the Boost Software License, Version 1.0.
http://www.boost.org/LICENSE_1_0.txt
////

[#reference]
# Reference
:toc:
:toc-title:
:idprefix:

[#synopsis]
## <boost/throw_exception.hpp> Synopsis

```
#include <boost/assert/source_location.hpp>
#include <boost/config.hpp>
#include <exception>

namespace boost
{

#if defined( BOOST_NO_EXCEPTIONS )

BOOST_NORETURN void throw_exception( std::exception const & e ); // user defined

BOOST_NORETURN void throw_exception( std::exception const & e,
  boost::source_location const & loc ); // user defined

#else

template<class E> BOOST_NORETURN void throw_exception( E const & e );

template<class E> BOOST_NORETURN void throw_exception( E const & e,
  boost::source_location const & loc );

#endif

} // namespace boost

#define BOOST_THROW_EXCEPTION(x) \
  ::boost::throw_exception(x, BOOST_CURRENT_LOCATION)
```

## throw_exception

```
#if defined( BOOST_NO_EXCEPTIONS )

BOOST_NORETURN void throw_exception( std::exception const & e ); // user defined

#else

template<class E> BOOST_NORETURN void throw_exception( E const & e );

#endif
```

Requires: :: `E` must have `std::exception` as a public and unambiguous base
  class.

Effects: ::
  * When exceptions aren't available, the function is declared, but
    not defined. The user is expected to supply an appropriate definition.
  * Otherwise, if `BOOST_EXCEPTION_DISABLE` is defined, the function
    throws `e`.
  * Otherwise, the function throws an object of a type derived from `E`,
    derived from `boost::exception`, if `E` doesn't already derive from
    it, and containing the necessary support for `boost::exception_ptr`.

```
#if defined( BOOST_NO_EXCEPTIONS )

BOOST_NORETURN void throw_exception( std::exception const & e,
  boost::source_location const & loc ); // user defined

#else

template<class E> BOOST_NORETURN void throw_exception( E const & e,
  boost::source_location const & loc );

#endif
```

Requires: :: `E` must have `std::exception` as a public and unambiguous base
  class.

Effects: ::
  * When exceptions aren't available, the function is declared, but
    not defined. The user is expected to supply an appropriate definition.
  * Otherwise, if `BOOST_EXCEPTION_DISABLE` is defined, the function
    throws `e`.
  * Otherwise, the function throws an object of a type derived from `E`,
    derived from `boost::exception`, if `E` doesn't already derive from
    it, and containing the necessary support for `boost::exception_ptr`. The
    `boost::exception` base class is initialized to contain the source
    location `loc`.