src/libs/utils/qtcassert.h

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "utils_global.h"

namespace Utils {
QTCREATOR_UTILS_EXPORT void writeAssertLocation(const char *msg);
QTCREATOR_UTILS_EXPORT void dumpBacktrace(int maxdepth);
} // Utils

#define QTC_ASSERT_STRINGIFY_HELPER(x) #x
#define QTC_ASSERT_STRINGIFY(x) QTC_ASSERT_STRINGIFY_HELPER(x)
#define QTC_ASSERT_STRING(cond) ::Utils::writeAssertLocation(\
    "\"" cond"\" in " __FILE__ ":" QTC_ASSERT_STRINGIFY(__LINE__))

// The 'do {...} while (0)' idiom is not used for the main block here to be
// able to use 'break' and 'continue' as 'actions'.

#define QTC_ASSERT(cond, action) if (Q_LIKELY(cond)) {} else { QTC_ASSERT_STRING(#cond); action; } do {} while (0)
#define QTC_CHECK(cond) if (Q_LIKELY(cond)) {} else { QTC_ASSERT_STRING(#cond); } do {} while (0)
#define QTC_GUARD(cond) ((Q_LIKELY(cond)) ? true : (QTC_ASSERT_STRING(#cond), false))
Use SPDX license identifiers Replace the current license disclaimer in files by a SPDX-License-Identifier. Task-number: QTBUG-67283 Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813 Reviewed-by: Eike Ziller <eike.ziller@qt.io> 2022-08-19 15:59:36 +02:00			`// Copyright (C) 2016 The Qt Company Ltd.`
Remove GPL-3.0+ from license identifiers Since we also license under GPL-3.0 WITH Qt-GPL-exception-1.0, this applies only to a hypothetical newer version of GPL, that doesn't exist yet. If such a version emerges, we can still decide to relicense... While at it, replace (deprecated) GPL-3.0 with more explicit GPL-3.0-only Change was done by running find . -type f -exec perl -pi -e "s/LicenseRef-Qt-Commercial OR GPL-3.0\+ OR GPL-3.0 WITH Qt-GPL-exception-1.0/LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0/g" {} \; Change-Id: I5097e6ce8d10233993ee30d7e25120e2659eb10b Reviewed-by: Eike Ziller <eike.ziller@qt.io> 2022-12-21 10:12:09 +01:00			`// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0`
more file cosmetics 2008-12-02 15:08:31 +01:00
Wholesale conversion to #pragma once Kudos to cgmb and https://github.com/cgmb/guardonce Change-Id: Ifa8970734b8d43fd08c9260c645bdb0228633791 Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com> 2016-03-18 07:55:01 +01:00			`#pragma once`
Initial import 2008-12-02 12:01:29 +01:00
qtcassert: move actual printing to separate function and enforce style This also allows simple setting of breakpoints on failed asserts. Change-Id: I6dd84cbfaf659d57e39f3447386cebc0221b2b84 Reviewed-by: Daniel Teske <daniel.teske@nokia.com> 2012-04-17 08:01:25 +02:00			`#include "utils_global.h"`
use QTC_ASSERT instead of Q_ASSERT 2008-12-09 15:25:01 +01:00
Utils: Add some backtrace dumping facility to QTC_ASSERT Unix only for now, opt-in, by setting QTC_BACKTRACE_MAXDEPTH=<number> in the environment. Change-Id: Ice110dbf5d25003706a947b27c279fec464df7a1 Reviewed-by: Eike Ziller <eike.ziller@qt.io> 2021-09-23 18:29:05 +02:00			`namespace Utils {`
			`QTCREATOR_UTILS_EXPORT void writeAssertLocation(const char *msg);`
			`QTCREATOR_UTILS_EXPORT void dumpBacktrace(int maxdepth);`
			`} // Utils`
nicer QTC_ASSERT output 2009-05-07 12:11:48 +02:00
qtcassert: move actual printing to separate function and enforce style This also allows simple setting of breakpoints on failed asserts. Change-Id: I6dd84cbfaf659d57e39f3447386cebc0221b2b84 Reviewed-by: Daniel Teske <daniel.teske@nokia.com> 2012-04-17 08:01:25 +02:00			`#define QTC_ASSERT_STRINGIFY_HELPER(x) #x`
			`#define QTC_ASSERT_STRINGIFY(x) QTC_ASSERT_STRINGIFY_HELPER(x)`
			`#define QTC_ASSERT_STRING(cond) ::Utils::writeAssertLocation(\`
Utils: Make assert output standard conformant Most IDEs support the "filename:linenumber" format to create shortcuts to locations in code. This changes QTC_ASSERT() to output this format, to make it easier to understand the reported issues. Change-Id: I74f3f121c04ba262628ab73c457fa3e5fa760a04 Reviewed-by: Eike Ziller <eike.ziller@qt.io> 2022-09-12 10:02:03 +02:00			`"\"" cond"\" in " __FILE__ ":" QTC_ASSERT_STRINGIFY(__LINE__))`
some QTC_ASSERT polishing 2008-12-09 16:18:28 +01:00
qtcassert: move actual printing to separate function and enforce style This also allows simple setting of breakpoints on failed asserts. Change-Id: I6dd84cbfaf659d57e39f3447386cebc0221b2b84 Reviewed-by: Daniel Teske <daniel.teske@nokia.com> 2012-04-17 08:01:25 +02:00			`// The 'do {...} while (0)' idiom is not used for the main block here to be`
			`// able to use 'break' and 'continue' as 'actions'.`
Initial import 2008-12-02 12:01:29 +01:00
QTC_ASSERT: Enclose conditions with Q_LIKELY Change-Id: I330f87c7a28747a7430c45a59ff010c891d071f0 Reviewed-by: André Hartmann <aha_1980@gmx.de> Reviewed-by: Eike Ziller <eike.ziller@qt.io> 2019-01-05 22:29:40 +02:00			`#define QTC_ASSERT(cond, action) if (Q_LIKELY(cond)) {} else { QTC_ASSERT_STRING(#cond); action; } do {} while (0)`
			`#define QTC_CHECK(cond) if (Q_LIKELY(cond)) {} else { QTC_ASSERT_STRING(#cond); } do {} while (0)`
			`#define QTC_GUARD(cond) ((Q_LIKELY(cond)) ? true : (QTC_ASSERT_STRING(#cond), false))`