Files
sousa-gecko/mfbt/StaticAnalysisFunctions.h
serge-sans-paille e243ec2784 Bug 2023117 - Ensure we don't have unused includes in mfbt/*.h r=emilio,media-playback-reviewers,padenot
Both debug and non-debug configuration have been tested, through

    for debug in DEBUG NDEBUG; do
    clang-tidy mfbt/*.h '-config={"Checks": ["-*", "misc-include-cleaner"], "CheckOptions": [{"key": "misc-include-cleaner.IgnoreHeaders", "value": ".*-inl.h;.*.inc;new"}, {"key": "misc-include-cleaner.MissingIncludes", "value": false}]}' --extra-arg-before=-xc++ --extra-arg=-std=c++20 --extra-arg=-I$PWD/obj-x86_64-pc-linux-gnu/dist/include --extra-arg=-DXP_UNIX --extra-arg=-I./nsprpub/pr/include/ --extra-arg=-I./config/external/nspr/ --extra-arg=-D$debug
    done

Some IWYU pragma: keep(reason) comments have been added when necessary.

Differential Revision: https://phabricator.services.mozilla.com/D287540
2026-03-18 03:40:28 +00:00

69 lines
1.7 KiB
C++

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_StaticAnalysisFunctions_h
#define mozilla_StaticAnalysisFunctions_h
/*
* Functions that are used as markers in Gecko code for static analysis. Their
* purpose is to have different AST nodes generated during compile time and to
* match them based on different checkers implemented in build/clang-plugin
*/
#ifdef MOZ_CLANG_PLUGIN
# ifndef __cplusplus
# ifndef bool
# include <stdbool.h>
# endif
# define MOZ_CONSTEXPR
# else // __cplusplus
# include "mozilla/Attributes.h"
# define MOZ_CONSTEXPR constexpr
# endif
# ifdef __cplusplus
/**
* MOZ_KnownLive - used to opt an argument out of the CanRunScript checker so
* that we don't check it if is a strong ref.
*
* Example:
* canRunScript(MOZ_KnownLive(rawPointer));
*/
template <typename T>
static MOZ_ALWAYS_INLINE T* MOZ_KnownLive(T* ptr) {
return ptr;
}
/**
* Ditto, but for references.
*/
template <typename T>
static MOZ_ALWAYS_INLINE T& MOZ_KnownLive(T& ref) {
return ref;
}
# endif
/**
* MOZ_AssertAssignmentTest - used in MOZ_ASSERT in order to test the possible
* presence of assignment instead of logical comparisons.
*
* Example:
* MOZ_ASSERT(retVal = true);
*/
static MOZ_ALWAYS_INLINE MOZ_CONSTEXPR bool MOZ_AssertAssignmentTest(
bool exprResult) {
return exprResult;
}
# define MOZ_CHECK_ASSERT_ASSIGNMENT(expr) MOZ_AssertAssignmentTest(!!(expr))
#else
# define MOZ_CHECK_ASSERT_ASSIGNMENT(expr) (!!(expr))
# define MOZ_KnownLive(expr) (expr)
#endif /* MOZ_CLANG_PLUGIN */
#endif /* StaticAnalysisFunctions_h */