LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
Exception.cc
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 __GNUC__
25#define __attribute__(x) /*NOTHING*/
26#endif
27
28#include <cstring>
29#include <ostream>
30#include <sstream>
31#include <string>
32
34
35namespace lsst {
36namespace pex {
37namespace exceptions {
38
39Tracepoint::Tracepoint(char const* file, int line, char const* func, std::string const& message)
40 : _file(file), _line(line), _func(func), _message(message) {}
41
42Exception::Exception(char const* file, int line, char const* func, std::string const& message)
43 : _message(message), _traceback(1, Tracepoint(file, line, func, message)) {}
44
45Exception::Exception(std::string const& message) : _message(message), _traceback() {}
46
47Exception::~Exception(void) noexcept {}
48
49void Exception::addMessage(char const* file, int line, char const* func, std::string const& message) {
50 std::ostringstream stream;
51 stream << _message;
52 if (_traceback.empty()) {
53 // This means the message-only constructor was used, which should only happen
54 // from Python...but this method isn't accessible from Python, so maybe
55 // this Exception was thrown in Python, then passed back to C++. Or, more
56 // likely, someone didn't read the warning and threw this exception in C++
57 // without using LSST_EXCEPT.
58 // But, because we don't have a traceback for that first message, we can't
59 // add one here without messing up the stringification logic later. Since
60 // this is a rare case (and should be considered a bug, but we don't want
61 // exception code throwing its own exceptions unless it absolutely has to),
62 // we'll proceed by just appending the message and ignoring the traceback.
63 stream << "; " << message;
64 } else {
65 if (_traceback.size() == static_cast<std::size_t>(1)) {
66 // The original message doesn't have an index (because it's faster,
67 // and there's no need if there's only one), so when we add the second,
68 // we have to give it an index.
69 stream << " {0}; ";
70 } else {
71 stream << "; ";
72 }
73 stream << message << " {" << _traceback.size() << "}";
74 _traceback.push_back(Tracepoint(file, line, func, message));
75 }
76 _message = stream.str();
77}
78
79Traceback const& Exception::getTraceback(void) const noexcept { return _traceback; }
80
82 if (_traceback.empty()) {
83 // The exception was raised in Python, so we don't include the traceback, the type, or any
84 // newlines, because Python will print those itself.
85 stream << _message;
86 } else {
87 stream << std::endl; // Start with a newline to separate our stuff from Pythons "<type>: " prefix.
88 for (std::size_t i = 0; i != _traceback.size(); ++i) {
89 stream << " File \"" << _traceback[i]._file << "\", line " << _traceback[i]._line << ", in "
90 << _traceback[i]._func << std::endl;
91 stream << " " << _traceback[i]._message << " {" << i << "}" << std::endl;
92 }
94 stream << type << ": '" << _message << "'" << std::endl;
95 }
96 return stream;
97}
98
99char const* Exception::what(void) const noexcept { return _message.c_str(); }
100
101char const* Exception::getType(void) const noexcept { return "lsst::pex::exceptions::Exception *"; }
102
103Exception* Exception::clone(void) const { return new Exception(*this); }
104
105std::ostream& operator<<(std::ostream& stream, Exception const& e) { return e.addToStream(stream); }
106
107} // namespace exceptions
108} // namespace pex
109} // namespace lsst
table::Key< int > type
Definition Detector.cc:163
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
virtual ~Exception(void) noexcept
Definition Exception.cc:47
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
T empty(T... args)
T endl(T... args)
std::ostream & operator<<(std::ostream &stream, Exception const &e)
Push the text representation of an exception onto a stream.
Definition Exception.cc:105
T push_back(T... args)
T size(T... args)
T str(T... args)
T strlen(T... args)
One point in the Traceback vector held by Exception.
Definition Exception.h:79
Tracepoint(char const *file, int line, char const *func, std::string const &message)
Standard constructor, intended for C++ use.
Definition Exception.cc:39