Loading...
Searching...
No Matches
exception.h
Go to the documentation of this file.
1//
2// Copyright 2021 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24
25#ifndef PXR_BASE_TF_EXCEPTION_H
26#define PXR_BASE_TF_EXCEPTION_H
27
30
31#include "pxr/pxr.h"
32#include "pxr/base/tf/api.h"
34#include "pxr/base/tf/functionRef.h"
35
36#include <cstdint>
37#include <exception>
38#include <string>
39#include <vector>
40
41PXR_NAMESPACE_OPEN_SCOPE
42
46{
47 explicit TfSkipCallerFrames(int n=0) : numToSkip(n) {}
48 int numToSkip;
49};
50
63class TfBaseException : public std::exception
64{
65public:
66 TF_API
67 virtual ~TfBaseException();
68
71 TF_API
72 explicit TfBaseException(std::string const &message);
73
77 TfCallContext const &GetThrowContext() const {
78 return _callContext;
79 }
80
83 std::vector<uintptr_t> const &GetThrowStack() const {
84 return _throwStack;
85 }
86
89 void MoveThrowStackTo(std::vector<uintptr_t> &out) {
90 out = std::move(_throwStack);
91 _throwStack.clear();
92 }
93
96 TF_API
97 virtual const char *what() const noexcept override;
98
99 // Friend throw support.
100 template <class Derived, class ... Args>
101 friend void
102 Tf_Throw(TfCallContext const &cc,
103 TfSkipCallerFrames skipFrames,
104 Args && ... args);
105
106private:
107 TF_API
108 static void _ThrowImpl(TfCallContext const &cc,
109 TfBaseException &exc,
110 TfFunctionRef<void ()> thrower,
111 int skipNCallerFrames);
112
113 TfCallContext _callContext;
114 std::vector<uintptr_t> _throwStack;
115 std::string _message;
116};
117
118// TF_THROW() support function.
119template <class Exception, class ... Args>
120void
121Tf_Throw(TfCallContext const &cc,
122 TfSkipCallerFrames skipFrames,
123 Args && ... args) {
124 Exception exc(std::forward<Args>(args)...);
125 auto thrower = [&exc]() { throw std::move(exc); };
126 TfBaseException::_ThrowImpl(cc, exc, thrower, skipFrames.numToSkip);
127}
128
129// TF_THROW() support function.
130template <class Exception, class ... Args>
131void Tf_Throw(TfCallContext const &cc, Args && ... args) {
132 Tf_Throw<Exception>(cc, TfSkipCallerFrames(), std::forward<Args>(args)...);
133}
134
135#ifdef doxygen
136
143#define TF_THROW(Exception, Exception-ctor-args...)
144#define TF_THROW(Exception, TfSkipCallerFrames, Exception-ctor-args...)
145
146#else
147
148#define TF_THROW(Exception, ...) \
149 Tf_Throw<Exception>(TF_CALL_CONTEXT, __VA_ARGS__)
150
151#endif
152
153PXR_NAMESPACE_CLOSE_SCOPE
154
155#endif // PXR_BASE_TF_EXCEPTION_H
Functions for recording call locations.
The base class for exceptions supported by the Tf exceptions facilities.
Definition: exception.h:64
void MoveThrowStackTo(std::vector< uintptr_t > &out)
Move the stack frame pointers from the throw point to out.
Definition: exception.h:89
TF_API TfBaseException(std::string const &message)
Construct with message, reported by this class's what() implementation.
virtual TF_API const char * what() const noexcept override
Override std::exception::what() to return the message passed during construction.
TfCallContext const & GetThrowContext() const
Return the call context from the throw point associated with this exception.
Definition: exception.h:77
std::vector< uintptr_t > const & GetThrowStack() const
Return the stack frame pointers from the throw point.
Definition: exception.h:83
This class provides a non-owning reference to a type-erased callable object with a specified signatur...
Definition: functionRef.h:36
STL namespace.
This structure is used to indicate that some number of caller frames should be skipped when capturing...
Definition: exception.h:46