ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dolphin/Source/Core/Common/Assert.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

51 lines
3.5 KiB
C
Raw Normal View History

Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
// Copyright 2015 Dolphin Emulator Project
treewide: convert GPLv2+ license info to SPDX tags SPDX standardizes how source code conveys its copyright and licensing information. See https://spdx.github.io/spdx-spec/1-rationale/ . SPDX tags are adopted in many large projects, including things like the Linux kernel.
2021-07-05 01:22:19 +00:00
// SPDX-License-Identifier: GPL-2.0-or-later
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
#pragma once
Mark more strings for translation
2015-11-20 10:33:47 +00:00
#include "Common/Common.h"
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
#include "Common/CommonFuncs.h"
#include "Common/Logging/Log.h"
#include "Common/MsgHandler.h"
Assert: Uppercase assertion macros Macros should be all upper-cased. This is also kind of a wart that's been sticking out for quite a while now (we avoid prefixing underscores).
2018-03-15 00:34:35 +00:00
#define ASSERT_MSG(_t_, _a_, _fmt_, ...) \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
do \
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
{ \
[[unlikely]] ASSERT and other ASSERT usage changes
2022-07-28 04:54:27 +00:00
if (!(_a_)) [[unlikely]] \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
{ \
Common/Assert: Actually use the ASSERT_MSG's log type parameter Since it was unused, nonexistent values were used in a few places. I've replaced them.
2021-11-11 02:34:28 +00:00
if (!PanicYesNoFmtAssert(_t_, \
"An error occurred.\n\n" _fmt_ "\n\n" \
" Condition: {}\n File: {}\n Line: {}\n Function: {}\n\n" \
"Ignore and continue?", \
Use `__VA_OPT__(, ) __VA_ARGS__` instead of `##__VA_ARGS__` Per https://en.cppreference.com/w/cpp/preprocessor/replace#.23_and_.23.23_operators the `##` behavior is a nonstandard extension; this extension seems to be supported by all compilers we care about, but IntelliSense in visual studio doesn't correctly handle it, resulting in false errors in the IDE (but not when compiling). Per https://en.cppreference.com/w/cpp/preprocessor/replace#Function-like_macros C++20 introduced a workaround, where `__VA_OPT__(, )` generates a comma if and only if `__VA_ARGS__` is non-empty. This PR replaces all occurrences, with the exception of Externals, DSPSpy (which is not likely to be edited in MSVC and does not target C++20 currently), and JitArm64_Integer.cpp (which uses `Function(__VA_ARGS__)`, and thus does not ever need a comma).
2022-08-23 18:14:47 +00:00
__VA_ARGS__ __VA_OPT__(, ) #_a_, __FILE__, __LINE__, __func__)) \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
Crash(); \
} \
} while (0)
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
Common/Assert: Include the condition and function in the message
2021-11-10 21:39:36 +00:00
#define DEBUG_ASSERT_MSG(_t_, _a_, _fmt_, ...) \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
do \
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
{ \
Convert LOG_TYPE and LOG_LEVELS to enum class
2021-10-21 19:11:07 +00:00
if constexpr (Common::Log::MAX_LOGLEVEL >= Common::Log::LogLevel::LDEBUG) \
Use `__VA_OPT__(, ) __VA_ARGS__` instead of `##__VA_ARGS__` Per https://en.cppreference.com/w/cpp/preprocessor/replace#.23_and_.23.23_operators the `##` behavior is a nonstandard extension; this extension seems to be supported by all compilers we care about, but IntelliSense in visual studio doesn't correctly handle it, resulting in false errors in the IDE (but not when compiling). Per https://en.cppreference.com/w/cpp/preprocessor/replace#Function-like_macros C++20 introduced a workaround, where `__VA_OPT__(, )` generates a comma if and only if `__VA_ARGS__` is non-empty. This PR replaces all occurrences, with the exception of Externals, DSPSpy (which is not likely to be edited in MSVC and does not target C++20 currently), and JitArm64_Integer.cpp (which uses `Function(__VA_ARGS__)`, and thus does not ever need a comma).
2022-08-23 18:14:47 +00:00
ASSERT_MSG(_t_, _a_, _fmt_ __VA_OPT__(, ) __VA_ARGS__); \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
} while (0)
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
Assert: Uppercase assertion macros Macros should be all upper-cased. This is also kind of a wart that's been sticking out for quite a while now (we avoid prefixing underscores).
2018-03-15 00:34:35 +00:00
#define ASSERT(_a_) \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
do \
{ \
[[unlikely]] ASSERT and other ASSERT usage changes
2022-07-28 04:54:27 +00:00
if (!(_a_)) [[unlikely]] \
Common/Assert: Include the condition and function in the message
2021-11-10 21:39:36 +00:00
{ \
Common/Assert: Switch to fmt
2021-11-10 22:42:49 +00:00
if (!PanicYesNoFmt("An error occurred.\n\n" \
" Condition: {}\n File: {}\n Line: {}\n Function: {}\n\n" \
"Ignore and continue?", \
#_a_, __FILE__, __LINE__, __func__)) \
Common/Assert: Include the condition and function in the message
2021-11-10 21:39:36 +00:00
Crash(); \
} \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
} while (0)
Common: Move asserts to their own header
2015-09-26 20:39:47 +00:00
Assert: Remove unused parameter from DEBUG_ASSERT This brings the macro in line with the regular ASSERT macro, which only has one macro parameter.
2018-03-16 16:57:36 +00:00
#define DEBUG_ASSERT(_a_) \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
do \
{ \
Convert LOG_TYPE and LOG_LEVELS to enum class
2021-10-21 19:11:07 +00:00
if constexpr (Common::Log::MAX_LOGLEVEL >= Common::Log::LogLevel::LDEBUG) \
Assert: Wrap assertion macro bodies in do {} while (0) Enforces the termination of the macro with a semicolon. Aside from that requirement, behavior remains the same.
2018-03-16 16:06:24 +00:00
ASSERT(_a_); \
} while (0)