Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+9666464c73,g0fba68d861+d6c6f70ffa,g1fd858c14a+94f68680cf,g208c678f98+1ca806343c,g271391ec13+ac98094cfc,g2c84ff76c0+120a924478,g2c9e612ef2+a92a2e6025,g35bb328faa+fcb1d3bbc8,g4d2262a081+7c332456db,g4e0f332c67+c58e4b632d,g53246c7159+fcb1d3bbc8,g60b5630c4e+a92a2e6025,g67b6fd64d1+9d1b2ab50a,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+506db7da85,g89139ef638+9d1b2ab50a,g8d6b6b353c+a92a2e6025,g9125e01d80+fcb1d3bbc8,g989de1cb63+9d1b2ab50a,g9f33ca652e+d1749da127,ga2b97cdc51+a92a2e6025,gabe3b4be73+1e0a283bba,gb1101e3267+6ecbd0580e,gb58c049af0+f03b321e39,gb89ab40317+9d1b2ab50a,gb90eeb9370+384e1fc23b,gcf25f946ba+506db7da85,gd315a588df+382ef11c06,gd6cbbdb0b4+75aa4b1db4,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+9984fb7d9e,ge278dab8ac+c61fbefdff,ge410e46f29+9d1b2ab50a,ge82c20c137+e12a08b75a,gf67bdafdda+9d1b2ab50a,gfd5510ef7b+864ead200a,v29.0.0.rc2
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Exception.h
Go to the documentation of this file.
1/*
2 * This file is part of pex_exceptions.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#ifndef LSST_PEX_EXCEPTIONS_EXCEPTION_H
25#define LSST_PEX_EXCEPTIONS_EXCEPTION_H
26
27#include <exception>
28#include <ostream>
29#include <string>
30#include <vector>
31
32#include "lsst/base.h"
33#include "boost/current_function.hpp"
34
35namespace lsst {
36namespace pex {
37namespace exceptions {
38
40#define LSST_EXCEPT_HERE __FILE__, __LINE__, BOOST_CURRENT_FUNCTION
41
48#define LSST_EXCEPT(type, ...) type(LSST_EXCEPT_HERE, __VA_ARGS__)
49
54#define LSST_EXCEPT_ADD(e, m) e.addMessage(LSST_EXCEPT_HERE, m)
55
57#define LSST_EARGS_TYPED char const *ex_file, int ex_line, char const *ex_func, std::string const &ex_message
58
60#define LSST_EARGS_UNTYPED ex_file, ex_line, ex_func, ex_message
61
69#define LSST_EXCEPTION_TYPE(t, b, c) \
70 class LSST_EXPORT t : public b { \
71 public: \
72 t(LSST_EARGS_TYPED) : b(LSST_EARGS_UNTYPED){}; \
73 t(std::string const& message) : b(message){}; \
74 virtual char const* getType(void) const noexcept { return #c " *"; }; \
75 virtual lsst::pex::exceptions::Exception* clone(void) const { return new t(*this); }; \
76 };
77
79struct Tracepoint {
88 Tracepoint(char const* file, int line, char const* func, std::string const& message);
89
90 char const* _file; // Compiled strings only; does not need deletion
91 int _line;
92 char const* _func; // Compiled strings only; does not need deletion
94};
96
108public:
117 Exception(char const* file, int line, char const* func,
118 std::string const& message); // Should use LSST_EARGS_TYPED, but that confuses doxygen.
119
130 explicit Exception(std::string const& message);
131
132 virtual ~Exception(void) noexcept;
133
142 void addMessage(char const* file, int line, char const* func, std::string const& message);
143
145 Traceback const& getTraceback(void) const noexcept;
146
154 virtual std::ostream& addToStream(std::ostream& stream) const;
155
166 virtual char const* what(void) const noexcept;
167
175 virtual char const* getType(void) const noexcept;
176
183 virtual Exception* clone(void) const;
184
185private:
186 std::string _message;
187 Traceback _traceback;
188};
189
198}
199} // namespace pex
200} // namespace lsst
201
202#endif
Basic LSST definitions.
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition base.h:37
Provides consistent interface for LSST exceptions.
Definition Exception.h:107
Traceback const & getTraceback(void) const noexcept
Retrieve the list of tracepoints associated with an exception.
Definition Exception.cc:79
virtual char const * getType(void) const noexcept
Return the fully-specified C++ type of a pointer to the exception.
Definition Exception.cc:101
virtual char const * what(void) const noexcept
Return a character string summarizing this exception.
Definition Exception.cc:99
Exception(char const *file, int line, char const *func, std::string const &message)
Standard constructor, intended for C++ use via the LSST_EXCEPT() macro.
Definition Exception.cc:42
virtual Exception * clone(void) const
Return a copy of the exception as an Exception pointer.
Definition Exception.cc:103
void addMessage(char const *file, int line, char const *func, std::string const &message)
Add a tracepoint and a message to an exception before rethrowing it (access via LSST_EXCEPT_ADD).
Definition Exception.cc:49
virtual std::ostream & addToStream(std::ostream &stream) const
Add a text representation of this exception, including its traceback with messages,...
Definition Exception.cc:81
std::ostream & operator<<(std::ostream &stream, Exception const &e)
Push the text representation of an exception onto a stream.
Definition Exception.cc:105
std::vector< Tracepoint > Traceback
Definition Exception.h:95
Tracepoint(char const *file, int line, char const *func, std::string const &message)
Standard constructor, intended for C++ use.
Definition Exception.cc:39