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 
27 #include "pxr/pxr.h"
28 
29 #ifdef PXR_PYTHON_SUPPORT_ENABLED
31 #endif // PXR_PYTHON_SUPPORT_ENABLED
32 
33 #include "pxr/base/tf/api.h"
34 
35 #include <functional>
36 #include <memory>
37 
39 
40 #ifdef PXR_PYTHON_SUPPORT_ENABLED
41 /// \struct TfPyTraceInfo
42 /// Structure passed to python trace functions. See the Python C API
43 /// documentation reference for the meaning of \a what and \a arg.
44 struct TfPyTraceInfo {
45  PyObject *arg;
46  char const *funcName;
47  char const *fileName;
48  int funcLine;
49  int what;
50 };
51 
52 typedef std::function<void (TfPyTraceInfo const &)> TfPyTraceFn;
53 typedef std::shared_ptr<TfPyTraceFn> TfPyTraceFnId;
54 
55 /// Register \a f as a python trace function.
56 /// It will be invoked for python tracing events. If python is not yet
57 /// initialized, the function will not be invoked until python is initialized.
58 TF_API TfPyTraceFnId TfPyRegisterTraceFn(TfPyTraceFn const &f);
59 
60 // For internal use only. Do not use.
61 void Tf_PyFabricateTraceEvent(TfPyTraceInfo const &info);
62 
63 // For internal use only. Do not use.
64 void Tf_PyTracingPythonInitialized();
65 #else
66 /// \struct For storage alignment when PXR_PYTHON_SUPPORT_ENABLED
67 /// is not enabled.
68 struct TfPyTraceInfo;
69 typedef std::function<void (TfPyTraceInfo const &)> TfPyTraceFn;
70 typedef std::shared_ptr<TfPyTraceFn> TfPyTraceFnId;
71 #endif // PXR_PYTHON_SUPPORT_ENABLED
72 
74 
75 #endif // PXR_BASE_TF_PY_TRACING_H
#define TF_API
Definition: api.h:40
auto arg(const Char *name, const T &arg) -> detail::named_arg< Char, T >
Definition: core.h:1736
std::shared_ptr< TfPyTraceFn > TfPyTraceFnId
Definition: pyTracing.h:70
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLfloat f
Definition: glcorearb.h:1926
std::function< void(TfPyTraceInfo const &)> TfPyTraceFn
Definition: pyTracing.h:68