generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2024-12-17 03:55:59 +01:00
Code Issues Projects Releases Wiki Activity

Redefine Poco assertions for static analysis

Browse Source 
Static analyzers typically don't do cross-translation unit analysis, so
they don't understand that most of the Poco::Bugcheck methods never
return.

Unfortunately, some of them also don't understand noreturn annotations
(see e.g. http://en.cppreference.com/w/cpp/language/attributes), so
decorating Bugcheck doesn't help.

Instead redefine all the Poco assertion macros to just call abort() iff
we're parsed by a known static analyzer.
This commit is contained in:
Kim Grasman 2016-07-13 15:14:45 +02:00
parent dd941cbad1
commit dd4a3b583a
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Foundation/include/Poco/Bugcheck.h
View File

@ -81,6 +81,25 @@ protected:
//
// useful macros (these automatically supply line number and file name)
//
#if defined(__KLOCWORK__) || defined(__clang_analyzer__)
// Short-circuit these macros when under static analysis.
// Ideally, static analysis tools should understand and reason correctly about
// noreturn methods such as Bugcheck::bugcheck. In practice, they don't.
// Help them by turning these macros into 'abort' as described here:
// https://developer.klocwork.com/documentation/en/insight/10-1/tuning-cc-analysis#Usingthe__KLOCWORK__macro
#include <cstdlib> // for abort
#define poco_assert_dbg(cond) do { if (!(cond)) abort(); } while (0)
#define poco_assert_msg_dbg(cond, text) do { if (!(cond)) abort(); } while (0)
#define poco_assert(cond) do { if (!(cond)) abort(); } while (0)
#define poco_assert_msg(cond, text) do { if (!(cond)) abort(); } while (0)
#define poco_check_ptr(ptr) do { if (!(ptr)) abort(); } while (0)
#define poco_bugcheck() do { abort(); } while (0)
#define poco_bugcheck_msg(msg) do { abort(); } while (0)
#else // defined(__KLOCWORK__) || defined(__clang_analyzer__)
#if defined(_DEBUG)
#define poco_assert_dbg(cond) \
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__); else (void) 0
@ -112,6 +131,7 @@ protected:
#define poco_bugcheck_msg(msg) \
Poco::Bugcheck::bugcheck(msg, __FILE__, __LINE__)
#endif // defined(__KLOCWORK__) || defined(__clang_analyzer__)
#define poco_unexpected() \
Poco::Bugcheck::unexpected(__FILE__, __LINE__);