LSST Applications  21.0.0-1-g8760c09+3ec9fa6d59,21.0.0-1-ga51b5d4+1a3c9f8315,21.0.0-13-g5daad6e+0252c796d2,21.0.0-14-g07a2928+6d2a161833,21.0.0-15-g543e7c3+e1f44b4e8b,21.0.0-15-g5a7caf0+22a63f14ab,21.0.0-15-ge3888ae+e70bf517f6,21.0.0-17-g8839fe5+10be924b4e,21.0.0-2-g103fe59+bd743ba87f,21.0.0-2-g45278ab+3ec9fa6d59,21.0.0-2-g5242d73+8a658b4ab3,21.0.0-2-g7f82c8f+82148d848c,21.0.0-2-g8faa9b5+a13d88a6a5,21.0.0-2-ga326454+82148d848c,21.0.0-2-gde069b7+135055f2fa,21.0.0-2-gecfae73+e9d3d7b02c,21.0.0-2-gfc62afb+8a658b4ab3,21.0.0-20-g35aa1e9+9ea05e3f8d,21.0.0-20-g8cd22d88+4d45a66d02,21.0.0-3-g357aad2+262bd63c8d,21.0.0-3-g4a4ce7f+8a658b4ab3,21.0.0-3-g4be5c26+8a658b4ab3,21.0.0-3-g65f322c+de03c300eb,21.0.0-3-ge02ed75+6d2a161833,21.0.0-30-gf21da11f8+33ac405c47,21.0.0-4-g591bb35+6d2a161833,21.0.0-4-g65b4814+10be924b4e,21.0.0-4-ge8a399c+4af7134804,21.0.0-5-g8c1d971+75b22be884,21.0.0-5-gcb07a25+7075ac2890,21.0.0-5-gcc89fd6+a13d88a6a5,21.0.0-5-gd00fb1e+2d6d6ce00a,21.0.0-6-gc675373+8a658b4ab3,21.0.0-7-gdf92d54+3ec9fa6d59,21.0.0-72-gffa78901+7884a7f5e9,21.0.0-8-g5674e7b+3979a46207,21.0.0-8-g72414d6+74174446e7,master-gac4afde19b+6d2a161833,w.2021.16
LSST Data Management Base Package
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 
35 namespace lsst {
36 namespace pex {
37 namespace exceptions {
38 
39 Tracepoint::Tracepoint(char const* file, int line, char const* func, std::string const& message)
40  : _file(file), _line(line), _func(func), _message(message) {}
41 
42 Exception::Exception(char const* file, int line, char const* func, std::string const& message)
43  : _message(message), _traceback(1, Tracepoint(file, line, func, message)) {}
44 
45 Exception::Exception(std::string const& message) : _message(message), _traceback() {}
46 
47 Exception::~Exception(void) noexcept {}
48 
49 void 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 
79 Traceback 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 
99 char const* Exception::what(void) const noexcept { return _message.c_str(); }
100 
101 char const* Exception::getType(void) const noexcept { return "lsst::pex::exceptions::Exception *"; }
102 
103 Exception* Exception::clone(void) const { return new Exception(*this); }
104 
105 std::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)
def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition: ds9.py:104
std::ostream & operator<<(std::ostream &stream, Exception const &e)
Push the text representation of an exception onto a stream.
Definition: Exception.cc:105
A base class for image defects.
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