qxLib
assert.h
Go to the documentation of this file.
1 /**
2 
3  @file assert.h
4  @author Khrapov
5  @date 29.10.2020
6  @copyright © Nick Khrapov, 2021. All right reserved.
7 
8 **/
9 #pragma once
10 
11 #include <qx/category.h>
12 #include <qx/logger/logger.h>
13 
14 #include <exception>
15 
16 #if QX_MSVC
17  #define _QX_DEBUG_BREAK __debugbreak()
18 #elif QX_CLANG
19  #define _QX_DEBUG_BREAK __builtin_debugtrap()
20 #elif QX_GNU
21  #include <signal.h>
22  #define _QX_DEBUG_BREAK raise(SIGTRAP)
23 #else
24  #define _QX_DEBUG_BREAK QX_EMPTY_MACRO
25 #endif
26 
27 namespace qx::details
28 {
29 
30 template<verbosity eVerbosity>
31 void resolve_assert_proceeding(
32  // macro args
33  const category& fileCategory,
34  string_view svFunction,
35  string_view svFile,
36  int nLine,
37  string_view svCondition)
38 {
39  QX_LOGGER_INSTANCE.log(eVerbosity, QX_TEXT("[{}] "), fileCategory, svFile, svFunction, nLine, svCondition);
40  QX_LOGGER_INSTANCE.flush();
41 }
42 
43 template<verbosity eVerbosity>
44 void resolve_assert_proceeding(
45  // macro args
46  const category& fileCategory,
47  string_view svFunction,
48  string_view svFile,
49  int nLine,
50  string_view svCondition,
51  // ... args
52  const category& category)
53 {
54  string sMessage;
55  sMessage.append_format(QX_TEXT("[{}] "), svCondition);
56  QX_LOGGER_INSTANCE.log(eVerbosity, sMessage, category, svFile, svFunction, nLine);
57  QX_LOGGER_INSTANCE.flush();
58 }
59 
60 template<verbosity eVerbosity, class... args_t>
61  requires log_acceptable_args<args_t...>
62 void resolve_assert_proceeding(
63  // macro args
64  const category& fileCategory,
65  string_view svFunction,
66  string_view svFile,
67  int nLine,
68  string_view svCondition,
69  // ... args
70  format_string_strong_checks<args_t...> sFormat,
71  const args_t&... args)
72 {
73  string sMessage;
74  sMessage.append_format(QX_TEXT("[{}] "), svCondition);
75  sMessage.append_format(sFormat, args...);
76  QX_LOGGER_INSTANCE.log(eVerbosity, sMessage, fileCategory, svFile, svFunction, nLine);
77  QX_LOGGER_INSTANCE.flush();
78 }
79 
80 template<verbosity eVerbosity>
81 void resolve_assert_proceeding(
82  // macro args
83  const category& fileCategory,
84  string_view svFunction,
85  string_view svFile,
86  int nLine,
87  string_view svCondition,
88  // ... args
89  string_view svMessage)
90 {
91  string sMessage;
92  sMessage.append_format(QX_TEXT("[{}] {}"), svCondition, svMessage);
93  QX_LOGGER_INSTANCE.log(eVerbosity, sMessage, fileCategory, svFile, svFunction, nLine);
94  QX_LOGGER_INSTANCE.flush();
95 }
96 
97 template<verbosity eVerbosity, class... args_t>
98  requires log_acceptable_args<args_t...>
99 void resolve_assert_proceeding(
100  // macro args
101  const category& fileCategory,
102  string_view svFunction,
103  string_view svFile,
104  int nLine,
105  string_view svCondition,
106  // ... args
107  const category& category,
108  format_string_strong_checks<args_t...> sFormat,
109  const args_t&... args)
110 {
111  string sMessage;
112  sMessage.append_format(QX_TEXT("[{}] "), svCondition);
113  sMessage.append_format(sFormat, args...);
114  QX_LOGGER_INSTANCE.log(eVerbosity, sMessage, category, svFile, svFunction, nLine);
115  QX_LOGGER_INSTANCE.flush();
116 }
117 
118 template<verbosity eVerbosity>
119 void resolve_assert_proceeding(
120  // macro args
121  const category& fileCategory,
122  string_view svFunction,
123  string_view svFile,
124  int nLine,
125  string_view svCondition,
126  // ... args
127  const category& category,
128  string_view svMessage)
129 {
130  string sMessage;
131  sMessage.append_format(QX_TEXT("[{}] {}"), svCondition, svMessage);
132  QX_LOGGER_INSTANCE.log(eVerbosity, sMessage, category, svFile, svFunction, nLine);
133  QX_LOGGER_INSTANCE.flush();
134 }
135 
136 } // namespace qx::details
137 
138 // ----------------------------------- setup -----------------------------------
139 
140 #ifndef QX_DEBUG_BREAK
141  #define QX_DEBUG_BREAK _QX_DEBUG_BREAK
142 #endif
143 
144 #ifndef QX_EXPECT_BEFORE_DEBUG_BREAK
145  #define QX_EXPECT_BEFORE_DEBUG_BREAK(condition, ...) \
146  qx::details::resolve_assert_proceeding<qx::verbosity::error>( \
147  QX_FILE_CATEGORY(), \
148  qx::to_string(__FUNCTION__), \
149  QX_SHORT_FILE, \
150  __LINE__, \
151  QX_TEXT(#condition), \
152  ##__VA_ARGS__)
153 #endif
154 
155 #ifndef QX_EXPECT_DEBUG_BREAK
156  #if QX_DEBUG || QX_REL_WITH_DEBUG_INFO
157  #define QX_EXPECT_DEBUG_BREAK QX_DEBUG_BREAK
158  #else
159  #define QX_EXPECT_DEBUG_BREAK QX_EMPTY_MACRO
160  #endif
161 #endif
162 
163 #ifndef QX_EXPECT_AFTER_DEBUG_BREAK
164  #define QX_EXPECT_AFTER_DEBUG_BREAK(condition, ...) QX_EMPTY_MACRO
165 #endif
166 
167 #ifndef QX_ASSERT_BEFORE_DEBUG_BREAK
168  #define QX_ASSERT_BEFORE_DEBUG_BREAK(condition, ...) \
169  qx::details::resolve_assert_proceeding<qx::verbosity::critical>( \
170  QX_FILE_CATEGORY(), \
171  qx::to_string(__FUNCTION__), \
172  QX_SHORT_FILE, \
173  __LINE__, \
174  QX_TEXT(#condition), \
175  ##__VA_ARGS__)
176 #endif
177 
178 #ifndef QX_ASSERT_DEBUG_BREAK
179  #if QX_DEBUG || QX_REL_WITH_DEBUG_INFO
180  #define QX_ASSERT_DEBUG_BREAK QX_DEBUG_BREAK
181  #else
182  #define QX_ASSERT_DEBUG_BREAK QX_EMPTY_MACRO
183  #endif
184 #endif
185 
186 #ifndef QX_ASSERT_AFTER_DEBUG_BREAK
187  #define QX_ASSERT_AFTER_DEBUG_BREAK(condition, ...) std::terminate()
188 #endif
189 
190 // ------------------------------- common macros -------------------------------
191 
192 #define _QX_ASSERT(before_debug_break, debug_break, after_debug_break, condition, ...) \
193  [&]() \
194  { \
195  QX_PUSH_SUPPRESS_MSVC_WARNINGS(4702); \
196  if (!(condition)) [[unlikely]] \
197  { \
198  before_debug_break(condition, ##__VA_ARGS__); \
199  debug_break; \
200  after_debug_break(condition, ##__VA_ARGS__); \
201  return false; \
202  } \
203  else \
204  { \
205  return true; \
206  } \
207  QX_POP_SUPPRESS_WARNINGS(); \
208  }()
209 
210 #define _QX_ASSERT_NO_ENTRY(before_debug_break, debug_break, after_debug_break, ...) \
211  _QX_ASSERT(before_debug_break, debug_break, after_debug_break, !QX_TEXT("No entry"), ##__VA_ARGS__)
212 
213 #define _QX_ASSERT_CONTINUE(before_debug_break, debug_break, after_debug_break, condition, ...) \
214  if (!_QX_ASSERT(before_debug_break, debug_break, after_debug_break, condition, ##__VA_ARGS__)) [[unlikely]] \
215  continue; \
216  else \
217  QX_EMPTY_MACRO
218 
219 #define _QX_ASSERT_BREAK(before_debug_break, debug_break, after_debug_break, condition, ...) \
220  if (!_QX_ASSERT(before_debug_break, debug_break, after_debug_break, condition, ##__VA_ARGS__)) [[unlikely]] \
221  break; \
222  else \
223  QX_EMPTY_MACRO
224 
225 #define _QX_ASSERT_RETURN( \
226  before_debug_break, \
227  debug_break, \
228  after_debug_break, \
229  return_keyword, \
230  condition, \
231  return_value, \
232  ...) \
233  if (!_QX_ASSERT(before_debug_break, debug_break, after_debug_break, condition, ##__VA_ARGS__)) [[unlikely]] \
234  return_keyword return_value; \
235  else \
236  QX_EMPTY_MACRO
237 
238 // -------------------------------- user macros --------------------------------
239 
240 /**
241  @brief Verifies that condition is true
242  @details ASSERT macros generate fatal failures and abort the program execution
243  @param condition - condition to check. if false, assert fails
244  @param ... - "category + format string + format arguments"
245  or "category + format string"
246  or "format string + format arguments"
247  or "format string"
248  or "category"
249 **/
250 #define QX_ASSERT(condition, ...) \
251  _QX_ASSERT( \
252  QX_ASSERT_BEFORE_DEBUG_BREAK, \
253  QX_ASSERT_DEBUG_BREAK, \
254  QX_ASSERT_AFTER_DEBUG_BREAK, \
255  condition, \
256  ##__VA_ARGS__)
257 
258 /**
259  @brief Fails unconditionally if this code should not be executed
260  @details ASSERT macros generate fatal failures and abort the program execution
261  @param ... - "category + format string + format arguments"
262  or "category + format string"
263  or "format string + format arguments"
264  or "format string"
265  or "category"
266 **/
267 #define QX_ASSERT_NO_ENTRY(...) \
268  _QX_ASSERT_NO_ENTRY(QX_ASSERT_BEFORE_DEBUG_BREAK, QX_ASSERT_DEBUG_BREAK, QX_ASSERT_AFTER_DEBUG_BREAK, ##__VA_ARGS__)
269 
270 /**
271  @brief Verifies that condition is true
272  @details EXPECT macros generate nonfatal failures and allow to continue running
273  @param condition - condition to check. if false, assert fails
274  @param ... - "category + format string + format arguments"
275  or "category + format string"
276  or "format string + format arguments"
277  or "format string"
278  or "category"
279 **/
280 #define QX_EXPECT(condition, ...) \
281  _QX_ASSERT( \
282  QX_EXPECT_BEFORE_DEBUG_BREAK, \
283  QX_EXPECT_DEBUG_BREAK, \
284  QX_EXPECT_AFTER_DEBUG_BREAK, \
285  condition, \
286  ##__VA_ARGS__)
287 
288 /**
289  @brief Fails unconditionally if this code should not be executed
290  @details EXPECT macros generate nonfatal failures and allow to continue running
291  @param ... - "category + format string + format arguments"
292  or "category + format string"
293  or "format string + format arguments"
294  or "format string"
295  or "category"
296 **/
297 #define QX_EXPECT_NO_ENTRY(...) \
298  _QX_ASSERT_NO_ENTRY(QX_EXPECT_BEFORE_DEBUG_BREAK, QX_EXPECT_DEBUG_BREAK, QX_EXPECT_AFTER_DEBUG_BREAK, ##__VA_ARGS__)
299 
300 /**
301  @brief Verifies that condition is true and continues loop if false
302  @details EXPECT macros generate nonfatal failures and allow to continue running
303  @param condition - condition to check. if false, assert fails
304  @param ... - "category + format string + format arguments"
305  or "category + format string"
306  or "format string + format arguments"
307  or "format string"
308  or "category"
309 **/
310 #define QX_EXPECT_CONTINUE(condition, ...) \
311  _QX_ASSERT_CONTINUE( \
312  QX_EXPECT_BEFORE_DEBUG_BREAK, \
313  QX_EXPECT_DEBUG_BREAK, \
314  QX_EXPECT_AFTER_DEBUG_BREAK, \
315  condition, \
316  ##__VA_ARGS__)
317 
318 /**
319  @brief Verifies that condition is true and break loop if false
320  @details EXPECT macros generate nonfatal failures and allow to continue running
321  @param condition - condition to check. if false, assert fails
322  @param ... - "category + format string + format arguments"
323  or "category + format string"
324  or "format string + format arguments"
325  or "format string"
326  or "category"
327 **/
328 #define QX_EXPECT_BREAK(condition, ...) \
329  _QX_ASSERT_BREAK( \
330  QX_EXPECT_BEFORE_DEBUG_BREAK, \
331  QX_EXPECT_DEBUG_BREAK, \
332  QX_EXPECT_AFTER_DEBUG_BREAK, \
333  condition, \
334  ##__VA_ARGS__)
335 
336 /**
337  @brief Verifies that condition is true and "return return_value;" if false
338  @details EXPECT macros generate nonfatal failures and allow to continue running
339  @param condition - condition to check. if false, assert fails
340  @param return_value - return value. use empty argument, if return type is void
341  @param ... - "category + format string + format arguments"
342  or "category + format string"
343  or "format string + format arguments"
344  or "format string"
345  or "category"
346 **/
347 #define QX_EXPECT_RETURN(condition, return_value, ...) \
348  _QX_ASSERT_RETURN( \
349  QX_EXPECT_BEFORE_DEBUG_BREAK, \
350  QX_EXPECT_DEBUG_BREAK, \
351  QX_EXPECT_AFTER_DEBUG_BREAK, \
352  return, \
353  condition, \
354  return_value, \
355  ##__VA_ARGS__)
356 
357 /**
358  @brief Verifies that condition is true and "return;" if false
359  @details EXPECT macros generate nonfatal failures and allow to continue running
360  @param condition - condition to check. if false, assert fails
361  @param ... - "category + format string + format arguments"
362  or "category + format string"
363  or "format string + format arguments"
364  or "format string"
365  or "category"
366 **/
367 #define QX_EXPECT_RETURN_VOID(condition, ...) \
368  _QX_ASSERT_RETURN( \
369  QX_EXPECT_BEFORE_DEBUG_BREAK, \
370  QX_EXPECT_DEBUG_BREAK, \
371  QX_EXPECT_AFTER_DEBUG_BREAK, \
372  return, \
373  condition, \
374  , \
375  ##__VA_ARGS__)
376 
377 /**
378  @brief Verifies that condition is true and "co_return return_value;" if false
379  @details EXPECT macros generate nonfatal failures and allow to continue running
380  @param condition - condition to check. if false, assert fails
381  @param return_value - return value. use empty argument, if return type is void
382  @param ... - "category + format string + format arguments"
383  or "category + format string"
384  or "format string + format arguments"
385  or "format string"
386  or "category"
387 **/
388 #define QX_EXPECT_CO_RETURN(condition, return_value, ...) \
389  _QX_ASSERT_RETURN( \
390  QX_EXPECT_BEFORE_DEBUG_BREAK, \
391  QX_EXPECT_DEBUG_BREAK, \
392  QX_EXPECT_AFTER_DEBUG_BREAK, \
393  co_return, \
394  condition, \
395  return_value, \
396  ##__VA_ARGS__)
397 
398 /**
399  @brief Verifies that condition is true and "co_return;" if false
400  @details EXPECT macros generate nonfatal failures and allow to continue running
401  @param condition - condition to check. if false, assert fails
402  @param ... - "category + format string + format arguments"
403  or "category + format string"
404  or "format string + format arguments"
405  or "format string"
406  or "category"
407 **/
408 #define QX_EXPECT_CO_RETURN_VOID(condition, ...) \
409  _QX_ASSERT_RETURN( \
410  QX_EXPECT_BEFORE_DEBUG_BREAK, \
411  QX_EXPECT_DEBUG_BREAK, \
412  QX_EXPECT_AFTER_DEBUG_BREAK, \
413  co_return, \
414  condition, \
415  , \
416  ##__VA_ARGS__)
Generated by doxygen 1.9.1