mirror of
https://github.com/pocoproject/poco.git
synced 2025-12-10 18:14:58 +01:00
8a4a2955d5
* chore(CppParser): 0, NULL --> nullptr * chore(Crypto): 0, NULL --> nullptr * chore(DNSSD): 0, NULL --> nullptr * chore(Encodings): 0, NULL --> nullptr * chore(CppUnit): Correct indentation. * chore(Foundation): 0, NULL --> nullptr * chore(CMake): Always warn about wrong nullptr usage when compiling with GCC or CLang * chore(Net): 0, NULL --> nullptr * chore(Foundation): 0, NULL --> nullptr * chore(Data): 0, NULL --> nullptr * chore(macOS): 0, NULL --> nullptr * chore(XML): 0, NULL --> nullptr * chore(Zip): 0, NULL --> nullptr * chore(Util): 0, NULL --> nullptr * chore(Net/NetSSL): 0, NULL --> nullptr * chore(Bonjour): 0, NULL --> nullptr * chore(MongoDB, Redis): 0, NULL --> nullptr * chore(Poco): 0, NULL --> nullptr * chore(Win32): 0, NULL --> nullptr * chore(CMake): Only warn about nullptr when verbose warnings are enabled. * Potential fix for code scanning alert no. 1634: Guarded Free Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> * chore(Net): Fix warning reported by gitlab. * chore(gitlab CI): attempt to clean to gain disk space on the runner. * chore(gitlab CI): Run build with --parallel 4, correct docker cleanup. --------- Co-authored-by: Aleksandar Fabijanic <aleks-f@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
181 lines
5.4 KiB
C++
181 lines
5.4 KiB
C++
//
|
|
// 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
|
|
//
|
|
|
|
|
|
#ifndef Foundation_Bugcheck_INCLUDED
|
|
#define Foundation_Bugcheck_INCLUDED
|
|
|
|
|
|
#include "Poco/Foundation.h"
|
|
#include <string>
|
|
#include <cstdlib>
|
|
#if defined(_DEBUG)
|
|
# include <iostream>
|
|
#endif
|
|
|
|
|
|
namespace Poco {
|
|
|
|
|
|
class Foundation_API Bugcheck
|
|
/// This class provides some static methods that are
|
|
/// used by the
|
|
/// poco_assert_dbg(), poco_assert(), poco_check_ptr(),
|
|
/// poco_bugcheck() and poco_unexpected() macros.
|
|
/// 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 = nullptr);
|
|
/// An assertion failed. Break into the debugger, if
|
|
/// possible, then throw an AssertionViolationException.
|
|
|
|
[[noreturn]] static void nullPointer(const char* ptr, const char* file, LineNumber line);
|
|
/// An null pointer was encountered. Break into the debugger, if
|
|
/// possible, then throw an NullPointerException.
|
|
|
|
[[noreturn]] static void bugcheck(const char* file, LineNumber line);
|
|
/// 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);
|
|
/// 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);
|
|
/// An internal error was encountered. Break into the debugger, if
|
|
/// possible.
|
|
|
|
static void debugger(const char* msg, const char* file, LineNumber line);
|
|
/// 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 = nullptr);
|
|
};
|
|
|
|
|
|
} // namespace Poco
|
|
|
|
|
|
//
|
|
// 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 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__)
|
|
|
|
|
|
#if defined(_DEBUG)
|
|
#define poco_assert_dbg(cond) \
|
|
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__); else (void) nullptr
|
|
|
|
#define poco_assert_msg_dbg(cond, text) \
|
|
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__, text); else (void) nullptr
|
|
#else
|
|
#define poco_assert_msg_dbg(cond, text)
|
|
#define poco_assert_dbg(cond)
|
|
#endif
|
|
|
|
|
|
#define poco_assert(cond) \
|
|
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__); else (void) nullptr
|
|
|
|
|
|
#define poco_assert_msg(cond, text) \
|
|
if (!(cond)) Poco::Bugcheck::assertion(#cond, __FILE__, __LINE__, text); else (void) nullptr
|
|
|
|
|
|
#define poco_check_ptr(ptr) \
|
|
if (!(ptr)) Poco::Bugcheck::nullPointer(#ptr, __FILE__, __LINE__); else (void) nullptr
|
|
|
|
|
|
#define poco_bugcheck() \
|
|
Poco::Bugcheck::bugcheck(__FILE__, __LINE__)
|
|
|
|
|
|
#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__)
|
|
|
|
|
|
#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)
|
|
|
|
|
|
#define poco_static_assert_ptr(T) \
|
|
static_assert(std::is_pointer_v<T> || \
|
|
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")
|
|
|
|
|
|
#endif // Foundation_Bugcheck_INCLUDED
|