ladybird/AK/Assertions.h

/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#if defined(KERNEL)
#    include <Kernel/Assertions.h>
#else
#    include <assert.h>
#    define VERIFY assert
#    define VERIFY_NOT_REACHED() assert(false) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
static constexpr bool TODO = false;
#    define TODO() VERIFY(TODO)
#endif
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 11:38:21 +03:00			`/*`
			`* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>`
			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 11:24:48 +03:00			`* SPDX-License-Identifier: BSD-2-Clause`
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 11:38:21 +03:00			`*/`

Import all this stuff into a single repo called Serenity. 2018-10-10 12:53:07 +03:00			`#pragma once`

AK: Untangle TestSuite assertions a bit 2021-02-23 10:33:03 +03:00			`#if defined(KERNEL)`
			`# include <Kernel/Assertions.h>`
			`#else`
			`# include <assert.h>`
LibC+AK: Remove our custom macros from <assert.h> Other software might not expect these to be defined and behave differently if they _are_ defined, e.g. scummvm which checks if the TODO macro is defined and fails to build if it is. 2021-06-07 15:00:29 +03:00			`# define VERIFY assert`
AK: Suppress false-positive clang-tidy warning in Assertions.h The definition of VERIFY_NOT_REACHED() as `assert(false)` causes the tool to suggest converting it to a static_assert. Which doesn't make any sense in context for what the macro is trying to do: crash the program at runtime. 2021-10-31 00:55:49 +03:00			`# define VERIFY_NOT_REACHED() assert(false) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */`
AK+Kernel: Print TODO when a TODO() is executed Previously we would just print "ASSERTION FAILED: false", which was kinda cryptic and also didn't make it clear whether this was a TODO or an unreachable condition. Now, we actually print "ASSERTION FAILED: TODO", making it crystal clear. 2021-08-03 23:02:19 +03:00			`static constexpr bool TODO = false;`
			`# define TODO() VERIFY(TODO)`
TestSuite: Hijack the ASSERT macros during unit tests. Instead of aborting the program when we hit an assertion, just print a message and keep going. This allows us to write tests that provoke assertions on purpose. 2019-08-02 10:23:03 +03:00			`#endif`