poco/Foundation/include/Poco/Bugcheck.h

181 lines
5.4 KiB
C
Raw Normal View History

2012-04-29 20:52:25 +02:00
//
// Bugcheck.h
//
// Library: Foundation
// Package: Core
// Module: Bugcheck
//
// Definition of the Bugcheck class and the self-testing macros.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
2012-04-29 20:52:25 +02:00
//
#ifndef Foundation_Bugcheck_INCLUDED
#define Foundation_Bugcheck_INCLUDED
#include "Poco/Foundation.h"
#include <string>
2016-09-14 17:10:16 +02:00
#include <cstdlib>
2012-04-29 20:52:25 +02:00
#if defined(_DEBUG)
# include <iostream>
#endif
namespace Poco {
class Foundation_API Bugcheck
/// This class provides some static methods that are
/// used by the
2022-07-07 11:18:20 +02:00
/// poco_assert_dbg(), poco_assert(), poco_check_ptr(),
/// poco_bugcheck() and poco_unexpected() macros.
2012-04-29 20:52:25 +02:00
/// You should not invoke these methods
/// directly. Use the macros instead, as they
/// automatically provide useful context information.
{
public:
[[noreturn]] static void assertion(const char* cond, const char* file, LineNumber line, const char* text = 0);
2012-04-29 20:52:25 +02:00
/// An assertion failed. Break into the debugger, if
/// possible, then throw an AssertionViolationException.
2014-12-09 03:13:20 +01:00
[[noreturn]] static void nullPointer(const char* ptr, const char* file, LineNumber line);
2012-04-29 20:52:25 +02:00
/// An null pointer was encountered. Break into the debugger, if
/// possible, then throw an NullPointerException.
[[noreturn]] static void bugcheck(const char* file, LineNumber line);
2012-04-29 20:52:25 +02:00
/// An internal error was encountered. Break into the debugger, if
/// possible, then throw an BugcheckException.
[[noreturn]] static void bugcheck(const char* msg, const char* file, LineNumber line);
2012-04-29 20:52:25 +02:00
/// An internal error was encountered. Break into the debugger, if
/// possible, then throw an BugcheckException.
static void unexpected(const char* file, LineNumber line);
/// An exception was caught in a destructor. Break into debugger,
/// if possible and report exception. Must only be called from
/// within a catch () block as it rethrows the exception to
/// determine its class.
static void debugger(const char* file, LineNumber line);
2012-04-29 20:52:25 +02:00
/// An internal error was encountered. Break into the debugger, if
/// possible.
static void debugger(const char* msg, const char* file, LineNumber line);
2012-04-29 20:52:25 +02:00
/// An internal error was encountered. Break into the debugger, if
/// possible.
protected:
static std::string what(const char* msg, const char* file, LineNumber line, const char* text = 0);
2012-04-29 20:52:25 +02:00
};
} // namespace Poco
//
// useful macros (these automatically supply line number and file name)
//
2016-09-14 17:10:16 +02:00
#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 std::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)) std::abort(); } while (0)
#define poco_assert_msg_dbg(cond, text) do { if (!(cond)) std::abort(); } while (0)
#define poco_assert(cond) do { if (!(cond)) std::abort(); } while (0)
#define poco_assert_msg(cond, text) do { if (!(cond)) std::abort(); } while (0)
#define poco_check_ptr(ptr) do { if (!(ptr)) std::abort(); } while (0)
#define poco_bugcheck() do { std::abort(); } while (0)
#define poco_bugcheck_msg(msg) do { std::abort(); } while (0)
#else // defined(__KLOCWORK__) || defined(__clang_analyzer__)
2012-04-29 20:52:25 +02:00
#if defined(_DEBUG)
#define poco_assert_dbg(cond) \
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__); else (void) 0
2014-11-06 12:04:28 +01:00
#define poco_assert_msg_dbg(cond, text) \
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__, text); else (void) 0
2012-04-29 20:52:25 +02:00
#else
2014-11-06 12:04:28 +01:00
#define poco_assert_msg_dbg(cond, text)
2012-04-29 20:52:25 +02:00
#define poco_assert_dbg(cond)
#endif
#define poco_assert(cond) \
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__); else (void) 0
2014-11-06 12:04:28 +01:00
#define poco_assert_msg(cond, text) \
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__, text); else (void) 0
2012-04-29 20:52:25 +02:00
2014-11-06 12:04:28 +01:00
2012-04-29 20:52:25 +02:00
#define poco_check_ptr(ptr) \
if (!(ptr)) Poco::Bugcheck::nullPointer(#ptr, __FILE__, __LINE__); else (void) 0
#define poco_bugcheck() \
Poco::Bugcheck::bugcheck(__FILE__, __LINE__)
#define poco_bugcheck_msg(msg) \
Poco::Bugcheck::bugcheck(msg, __FILE__, __LINE__)
2014-12-09 03:13:20 +01:00
2016-09-14 17:10:16 +02:00
#endif // defined(__KLOCWORK__) || defined(__clang_analyzer__)
#define poco_unexpected() \
Poco::Bugcheck::unexpected(__FILE__, __LINE__);
2012-04-29 20:52:25 +02:00
#define poco_debugger() \
Poco::Bugcheck::debugger(__FILE__, __LINE__)
#define poco_debugger_msg(msg) \
Poco::Bugcheck::debugger(msg, __FILE__, __LINE__)
#if defined(_DEBUG)
# define poco_stdout_dbg(outstr) \
std::cout << __FILE__ << '(' << std::dec << __LINE__ << "):" << outstr << std::endl;
#else
# define poco_stdout_dbg(outstr)
#endif
#if defined(_DEBUG)
# define poco_stderr_dbg(outstr) \
std::cerr << __FILE__ << '(' << std::dec << __LINE__ << "):" << outstr << std::endl;
#else
# define poco_stderr_dbg(outstr)
#endif
#define poco_static_assert(B) static_assert(B)
2012-04-29 20:52:25 +02:00
#define poco_static_assert_ptr(T) \
static_assert(std::is_pointer_v<T> || \
2024-02-19 10:52:33 +01:00
std::is_same_v<T, std::nullptr_t> || \
std::is_member_pointer_v<T> || \
std::is_member_function_pointer_v<T> || \
std::is_member_object_pointer_v<T>, \
"not a pointer")
2012-04-29 20:52:25 +02:00
#endif // Foundation_Bugcheck_INCLUDED