nx_video_source_sdk  1.0
Video Source SDK
debug.h
Go to the documentation of this file.
1 // Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
2 
3 #pragma once
4 
12 #include <iostream>
13 #include <cstdint>
14 #include <functional>
15 #include <sstream>
16 #include <memory>
17 
18 #include <nx/kit/utils.h>
19 
20 #if !defined(NX_KIT_API)
21  #define NX_KIT_API /*empty*/
22 #endif
23 
24 namespace nx {
25 namespace kit {
26 namespace debug {
27 
28 //-------------------------------------------------------------------------------------------------
29 // Tools
30 
32 NX_KIT_API char pathSeparator();
33 
34 NX_KIT_API size_t commonPrefixSize(const std::string& s1, const std::string& s2);
35 
40 NX_KIT_API const char* relativeSrcFilename(const char* file);
41 
42 NX_KIT_API std::string fileBaseNameWithoutExt(const char* file);
43 
44 //-------------------------------------------------------------------------------------------------
45 // Output
46 
48 #if defined(NX_PRINT_TO_QDEBUG)
49  #define NX_DEBUG_STREAM qDebug().nospace().noquote()
50  #define NX_DEBUG_ENDL /*empty*/
51  static inline QDebug operator<<(QDebug d, const std::string& s)
52  {
53  return d << QString::fromStdString(s);
54  }
55 #endif
56 
57 #if !defined(NX_DEBUG_INI)
58 
59  #define NX_DEBUG_INI ini().
60 #endif
61 
62 #if !defined(NX_DEBUG_ENABLE_OUTPUT)
63 
64  #define NX_DEBUG_ENABLE_OUTPUT NX_DEBUG_INI enableOutput
65 #endif
66 
67 #if !defined(NX_PRINT_PREFIX)
68 
69  #define NX_PRINT_PREFIX ::nx::kit::debug::detail::printPrefix(__FILE__)
70 #endif
71 
72 #if !defined(NX_DEBUG_STREAM)
73 
74  #define NX_DEBUG_STREAM *::nx::kit::debug::stream()
75 #endif
76 
77 #if !defined(NX_DEBUG_ENDL)
78 
79  #define NX_DEBUG_ENDL << std::endl
80 #endif
81 
86 NX_KIT_API std::ostream*& stream();
87 
88 #if !defined(NX_PRINT)
89 
93  #define NX_PRINT /* << args... */ \
94  /* Allocate a temp value, which prints endl in its destructor, in the "<<" expression. */ \
95  ( []() { struct Endl { ~Endl() { NX_DEBUG_STREAM NX_DEBUG_ENDL; } }; \
96  return std::make_shared<Endl>(); }() ) /*operator,*/, \
97  NX_DEBUG_STREAM << NX_PRINT_PREFIX
98 #endif
99 
103 #define NX_OUTPUT /* << args... */ \
104  for (/* Executed either once or never; `for` instead of `if` gives no warnings. */ \
105  int NX_KIT_DEBUG_DETAIL_CONCAT(nxOutput_, __line__) = 0; \
106  NX_KIT_DEBUG_DETAIL_CONCAT(nxOutput_, __line__) != 1 && (NX_DEBUG_ENABLE_OUTPUT); \
107  ++NX_KIT_DEBUG_DETAIL_CONCAT(nxOutput_, __line__) \
108  ) NX_PRINT
109 
110 //-------------------------------------------------------------------------------------------------
111 // Assertions
112 
128 #define NX_KIT_ASSERT(/* CONDITION, MESSAGE = "" */ ...) \
129  NX_KIT_DEBUG_DETAIL_MSVC_EXPAND(NX_KIT_DEBUG_DETAIL_GET_3RD_ARG( \
130  __VA_ARGS__, NX_KIT_DEBUG_DETAIL_ASSERT2, NX_KIT_DEBUG_DETAIL_ASSERT1, \
131  /* Helps to generate a reasonable compiler error. */ args_required)(__VA_ARGS__))
132 
137 NX_KIT_API void intentionallyCrash(const char* message);
138 
139 //-------------------------------------------------------------------------------------------------
140 // Print info
141 
145 #define LL \
146  NX_PRINT << "####### LL line " << __LINE__ \
147  << NX_KIT_DEBUG_DETAIL_THREAD_ID() \
148  << ", file " << ::nx::kit::debug::relativeSrcFilename(__FILE__);
149 
153 #define NX_PRINT_VALUE(VALUE) \
154  NX_PRINT << "####### " #VALUE ": " << ::nx::kit::utils::toString((VALUE))
155 
159 #define NX_PRINT_HEX_DUMP(CAPTION, BYTES, SIZE) \
160  ::nx::kit::debug::detail::printHexDump( \
161  NX_KIT_DEBUG_DETAIL_PRINT_FUNC, (CAPTION), (const char*) (BYTES), (int) (SIZE))
162 
166 NX_KIT_API std::string hexDumpLine(const char* bytes, int size, int bytesPerLine = 0);
167 
168 //-------------------------------------------------------------------------------------------------
169 // Time
170 
171 #if !defined(NX_DEBUG_ENABLE_TIME)
172 
173  #define NX_DEBUG_ENABLE_TIME NX_DEBUG_INI enableTime
174 #endif
175 
179 #define NX_TIME_BEGIN(TAG) \
180  ::nx::kit::debug::detail::Timer nxTimer_##TAG( \
181  (NX_DEBUG_ENABLE_TIME), NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #TAG)
182 
187 #define NX_TIME_MARK(TAG, MARK) do \
188 { \
189  if (NX_DEBUG_ENABLE_TIME) \
190  nxTimer_##TAG.mark((MARK)); \
191 } while (0)
192 
196 #define NX_TIME_END(TAG) do \
197 { \
198  if (NX_DEBUG_ENABLE_TIME) \
199  nxTimer_##TAG.finish(); \
200 } while (0)
201 
202 //-------------------------------------------------------------------------------------------------
203 // Fps
204 
205 #if !defined(NX_DEBUG_ENABLE_FPS)
206 
207  #define NX_DEBUG_ENABLE_FPS NX_DEBUG_INI enableFps
208 #endif
209 
214 #define NX_FPS(TAG, /*OPTIONAL_MARK*/...) do \
215 { \
216  if (NX_KIT_DEBUG_DETAIL_CONCAT(NX_DEBUG_ENABLE_FPS, TAG)) \
217  { \
218  static ::nx::kit::debug::detail::Fps fps( \
219  NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #TAG); \
220  fps.mark(__VA_ARGS__); \
221  } \
222 } while (0)
223 
224 //-------------------------------------------------------------------------------------------------
225 // Implementation
226 
227 namespace detail {
228 
229 typedef std::function<void(const char*)> PrintFunc;
230 
231 #define NX_KIT_DEBUG_DETAIL_PRINT_FUNC ([&](const char* message) { NX_PRINT << message; })
232 
237 #define NX_KIT_DEBUG_DETAIL_MSVC_EXPAND(ARG) ARG
238 
240 #define NX_KIT_DEBUG_DETAIL_GET_3RD_ARG(ARG1, ARG2, ARG3, ...) ARG3
241 
242 #define NX_KIT_DEBUG_DETAIL_ASSERT1(CONDITION) \
243  ::nx::kit::debug::detail::doAssert( \
244  !!(CONDITION), NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #CONDITION, "", __FILE__, __LINE__)
245 
246 #define NX_KIT_DEBUG_DETAIL_ASSERT2(CONDITION, MESSAGE) \
247  ::nx::kit::debug::detail::doAssert( \
248  !!(CONDITION), NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #CONDITION, MESSAGE, __FILE__, __LINE__)
249 
250 NX_KIT_API void assertionFailed(
251  PrintFunc printFunc, const char* conditionStr, const std::string& message,
252  const char* file, int line);
253 
254 inline bool doAssert(
255  bool condition, PrintFunc printFunc, const char* conditionStr, const std::string& message,
256  const char* file, int line)
257 {
258  if (!condition)
259  assertionFailed(printFunc, conditionStr, message, file, line);
260  return condition;
261 }
262 
263 #define NX_KIT_DEBUG_DETAIL_CONCAT(X, Y) NX_KIT_DEBUG_DETAIL_CONCAT2(X, Y)
264 #define NX_KIT_DEBUG_DETAIL_CONCAT2(X, Y) X##Y
265 
267 NX_KIT_API std::string printPrefix(const char* file);
268 
269 class NX_KIT_API Timer
270 {
271 public:
272  Timer(bool enabled, PrintFunc printFunc, const char* tag);
273  ~Timer();
274  void mark(const char* markStr);
275  void finish();
276 
277 private:
278  struct Impl;
279  Impl* const d;
280 };
281 
282 class NX_KIT_API Fps
283 {
284 public:
285  Fps(PrintFunc printFunc, const char* tag);
286  ~Fps();
287  void mark(const char* markStr = nullptr);
288 
289 private:
290  struct Impl;
291  Impl* const d;
292 };
293 
294 NX_KIT_API void printHexDump(
295  PrintFunc printFunc, const char* caption, const char* bytes, int size);
296 
297 } // namespace detail
298 
299 } // namespace debug
300 } // namespace kit
301 } // namespace nx
302 
303 #if defined(__linux__)
304  #include <pthread.h>
305  #define NX_KIT_DEBUG_DETAIL_THREAD_ID() \
306  ::nx::kit::utils::format(", thread %llx", (long long) pthread_self())
307 #elif defined(QT_CORE_LIB)
308  #include <QtCore/QThread>
309  #define NX_KIT_DEBUG_DETAIL_THREAD_ID() \
310  ::nx::kit::utils::format(", thread %llx", (long long) QThread::currentThreadId())
311 #else
312  // No threading libs available - do not print thread id.
313  #define NX_KIT_DEBUG_DETAIL_THREAD_ID() ""
314 #endif
Definition: debug.h:282
Definition: debug.cpp:289
Definition: debug.cpp:214
Definition: apple_utils.h:6
Definition: debug.h:269