All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stackTrace.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_STACKTRACE_H
25 #define TF_STACKTRACE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/tf/api.h"
29 
30 #include <cstdio>
31 #include <iosfwd>
32 #include <string>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 class TfCallContext;
37 
39 TF_API std::string TfGetStackTrace();
40 
42 TF_API
43 void TfPrintStackTrace(FILE *file, const std::string &reason);
44 
46 TF_API
47 void TfPrintStackTrace(std::ostream &out, std::string const &reason);
48 
54 TF_API
55 void TfLogStackTrace(const std::string &reason, bool logtodb=false);
56 
66 TF_API
67 void TfLogCrash(const std::string &reason,
68  const std::string &message, const std::string &additionalInfo,
69  TfCallContext const &context, bool logToDB);
70 
72 TF_API
73 time_t TfGetAppLaunchTime();
74 
75 PXR_NAMESPACE_CLOSE_SCOPE
76 
77 #endif