All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
staticKeyData.h
1 //
2 // Copyright 2018 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 
25 #ifndef TRACE_STATIC_KEY_DATA_H
26 #define TRACE_STATIC_KEY_DATA_H
27 
28 #include "pxr/pxr.h"
29 
30 #include <cstddef>
31 #include <string>
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
43 public:
48  class StringLiteral {
49  public:
51  template <size_t N>
52  constexpr StringLiteral(const char(&s)[N]) : str(s) {}
53 
55  constexpr StringLiteral() : str(nullptr) {}
56 
57  private:
58  const char* str;
59 
60  friend class TraceStaticKeyData;
61  };
62 
64  constexpr TraceStaticKeyData(const StringLiteral name)
65  : _name(name.str) {}
66 
69  constexpr TraceStaticKeyData(
70  const StringLiteral func,
71  const StringLiteral prettyFunc,
72  const StringLiteral name = StringLiteral())
73  : _funcName(func.str)
74  , _prettyFuncName(prettyFunc.str)
75  , _name(name.str) {}
76 
78  bool operator == (const TraceStaticKeyData& other) const;
79 
80  bool operator != (const TraceStaticKeyData& other) const {
81  return !(*this == other);
82  }
83 
85  std::string GetString() const;
86 
87 private:
89 
90  const char* _funcName = nullptr;
91  const char* _prettyFuncName = nullptr;
92  const char* _name = nullptr;
93 
94  friend class TraceDynamicKey;
95 };
96 
97 PXR_NAMESPACE_CLOSE_SCOPE
98 
99 #endif // TRACE_STATIC_KEY_DATA_H
This is a helper class for the constructors of TraceStaticKeyData.
Definition: staticKeyData.h:48
constexpr StringLiteral()
Default Constructor.
Definition: staticKeyData.h:55
This class stores data used to create dynamic keys which can be referenced in TraceEvent instances...
Definition: dynamicKey.h:42
std::string GetString() const
Returns the string representation of the key data.
bool operator==(const TraceStaticKeyData &other) const
Equality comparison. Inequality is also defined.
constexpr TraceStaticKeyData(const StringLiteral func, const StringLiteral prettyFunc, const StringLiteral name=StringLiteral())
Constructor for a function (func, prettyFunc) and optional scope name.
Definition: staticKeyData.h:69
constexpr StringLiteral(const char(&s)[N])
Constructor from string literals.
Definition: staticKeyData.h:52
constexpr TraceStaticKeyData(const StringLiteral name)
Constructor for a name.
Definition: staticKeyData.h:64
This class holds data necessary to create keys for TraceEvent instances.
Definition: staticKeyData.h:42