All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyTracing.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_PYTRACING_H
25 #define TF_PYTRACING_H
26 
27 #include <Python.h>
28 
29 #include "pxr/pxr.h"
30 
31 #include "pxr/base/tf/api.h"
32 
33 #include <functional>
34 #include <memory>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
41 struct TfPyTraceInfo {
42  PyObject *arg;
43  char const *funcName;
44  char const *fileName;
45  int funcLine;
46  int what;
47 };
48 
49 typedef std::function<void (TfPyTraceInfo const &)> TfPyTraceFn;
50 typedef std::shared_ptr<TfPyTraceFn> TfPyTraceFnId;
51 
55 TF_API TfPyTraceFnId TfPyRegisterTraceFn(TfPyTraceFn const &f);
56 
57 // For internal use only. Do not use.
58 TF_API void Tf_PyFabricateTraceEvent(TfPyTraceInfo const &info);
59 
60 // For internal use only. Do not use.
61 TF_API void Tf_PyTracingPythonInitialized();
62 
63 PXR_NAMESPACE_CLOSE_SCOPE
64 
65 #endif // TF_PYTRACING_H
Structure passed to python trace functions.
Definition: pyTracing.h:41