All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
scopeDescriptionPrivate.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_SCOPEDESCRIPTION_PRIVATE_H
25 #define TF_SCOPEDESCRIPTION_PRIVATE_H
26 
27 #include "pxr/pxr.h"
28 
29 PXR_NAMESPACE_OPEN_SCOPE
30 
31 // Helper class for getting the TfScopeDescription stacks as human readable text
32 // for crash reporting.
33 class Tf_ScopeDescriptionStackReportLock
34 {
35  Tf_ScopeDescriptionStackReportLock(
36  Tf_ScopeDescriptionStackReportLock const &) = delete;
37  Tf_ScopeDescriptionStackReportLock &operator=(
38  Tf_ScopeDescriptionStackReportLock const &) = delete;
39 public:
40  // Lock and compute the report message.
41  Tf_ScopeDescriptionStackReportLock();
42 
43  // Unlock.
44  ~Tf_ScopeDescriptionStackReportLock();
45 
46  // Get the report message. This could be nullptr if it was impossible to
47  // obtain the report.
48  char const *GetMessage() const { return _msg; }
49 
50 private:
51  char const *_msg;
52 };
53 
54 PXR_NAMESPACE_CLOSE_SCOPE
55 
56 #endif // TF_SCOPEDESCRIPTION_PRIVATE_H
57