HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyTracing.h
Go to the documentation of this file.
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 PXR_BASE_TF_PY_TRACING_H
25 #define PXR_BASE_TF_PY_TRACING_H
26 
28 
29 #include "pxr/pxr.h"
30 
31 #include "pxr/base/tf/api.h"
32 
33 #include <functional>
34 #include <memory>
35 
37 
38 /// \struct TfPyTraceInfo
39 /// Structure passed to python trace functions. See the Python C API
40 /// documentation reference for the meaning of \a what and \a arg.
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 
52 /// Register \a f as a python trace function.
53 /// It will be invoked for python tracing events. If python is not yet
54 /// initialized, the function will not be invoked until python is initialized.
56 
57 // For internal use only. Do not use.
58 void Tf_PyFabricateTraceEvent(TfPyTraceInfo const &info);
59 
60 // For internal use only. Do not use.
62 
64 
65 #endif // PXR_BASE_TF_PY_TRACING_H
char const * fileName
Definition: pyTracing.h:44
#define TF_API
Definition: api.h:40
void Tf_PyTracingPythonInitialized()
std::shared_ptr< TfPyTraceFn > TfPyTraceFnId
Definition: pyTracing.h:50
GLclampf f
Definition: glew.h:3499
TF_API TfPyTraceFnId TfPyRegisterTraceFn(TfPyTraceFn const &f)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
PyObject * arg
Definition: pyTracing.h:42
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
char const * funcName
Definition: pyTracing.h:43
void Tf_PyFabricateTraceEvent(TfPyTraceInfo const &info)
std::function< void(TfPyTraceInfo const &)> TfPyTraceFn
Definition: pyTracing.h:49