All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyErrorInternal.h
1 //
2 // Copyright 2016 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 #ifndef TF_PYERRORINTERNAL_H
25 #define TF_PYERRORINTERNAL_H
26 
27 #include "pxr/pxr.h"
28 
29 #include "pxr/base/tf/api.h"
30 #include "pxr/base/tf/pyExceptionState.h"
31 #include <boost/python/handle.hpp>
32 #include <boost/python/object_fwd.hpp>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 enum Tf_PyExceptionErrorCode {
37  TF_PYTHON_EXCEPTION
38 };
39 
40 TF_API TfPyExceptionState Tf_PyFetchPythonExceptionState();
41 TF_API void Tf_PyRestorePythonExceptionState(TfPyExceptionState state);
42 TF_API boost::python::handle<> Tf_PyGetErrorExceptionClass();
43 TF_API void Tf_PySetErrorExceptionClass(boost::python::object const &cls);
44 
48 public:
49  // Save the current exception state but don't unset it.
52  TfPyExceptionStateScope& operator=(const TfPyExceptionStateScope&) = delete;
53 
54  // Restore the exception state as it was in the c'tor.
56 
57  // Restore the exception state as it was in the c'tor.
58  void Restore();
59 
60 private:
61  TfPyExceptionState _state;
62 };
63 
64 PXR_NAMESPACE_CLOSE_SCOPE
65 
66 #endif // TF_PYERRORINTERNAL_H
RAII class to save and restore the Python exception state.