HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
callContext.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_CALL_CONTEXT_H
25 #define PXR_BASE_TF_CALL_CONTEXT_H
26 
27 /// \file tf/callContext.h
28 /// Functions for recording call locations.
29 ///
30 /// Many macros want to record the location in which they are invoked. In
31 /// fact, this is the most useful feature that function-like macros have over
32 /// regular functions. This code provides a standard way to collect and pass
33 /// that contextual information around. There are two parts. First is a
34 /// small structure which holds the contextual information. Next is a macro
35 /// which will produce a temporary structure containing the local contextual
36 /// information. The intended usage is in a macro.
37 
38 #include "pxr/pxr.h"
39 #include "pxr/base/tf/api.h"
41 
42 #include <stddef.h>
43 
45 
46 /// \hideinitializer
47 #define TF_CALL_CONTEXT \
48 TfCallContext(__ARCH_FILE__, __ARCH_FUNCTION__, __LINE__, __ARCH_PRETTY_FUNCTION__)
49 
51 {
52 public:
53  constexpr TfCallContext()
54  : _file(nullptr)
55  , _function(nullptr)
56  , _line(0)
57  , _prettyFunction(nullptr)
58  , _hidden(false) {}
59 
60  constexpr TfCallContext(char const *file,
61  char const *function,
62  size_t line,
63  char const *prettyFunction) :
64  _file(file),
65  _function(function),
66  _line(line),
67  _prettyFunction(prettyFunction),
68  _hidden(false)
69  {
70  }
71 
72  char const *GetFile() const {
73  return _file;
74  }
75 
76  char const *GetFunction() const {
77  return _function;
78  }
79 
80  size_t GetLine() const {
81  return _line;
82  }
83 
84  char const *GetPrettyFunction() const {
85  return _prettyFunction;
86  }
87 
88  TfCallContext const& Hide() const {
89  _hidden = true;
90  return *this;
91  }
92 
93  bool IsHidden() const {
94  return _hidden;
95  }
96 
97  explicit operator bool() const { return _file && _function; }
98 
99  private:
100 
101  char const *_file;
102  char const *_function;
103  size_t _line;
104  char const *_prettyFunction;
105  mutable bool _hidden;
106 };
107 
109 
110 #endif // PXR_BASE_TF_CALL_CONTEXT_H
constexpr TfCallContext()
Definition: callContext.h:53
char const * GetPrettyFunction() const
Definition: callContext.h:84
size_t GetLine() const
Definition: callContext.h:80
char const * GetFile() const
Definition: callContext.h:72
bool IsHidden() const
Definition: callContext.h:93
TfCallContext const & Hide() const
Definition: callContext.h:88
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
constexpr TfCallContext(char const *file, char const *function, size_t line, char const *prettyFunction)
Definition: callContext.h:60
char const * GetFunction() const
Definition: callContext.h:76