mirror of
https://github.com/nodejs/node.git
synced 2025-05-21 15:44:52 +00:00
9d7cd9b864
PR-URL: https://github.com/nodejs/node/pull/54077 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
190 lines
7.0 KiB
C++
190 lines
7.0 KiB
C++
//
|
|
// Copyright 2017 The Abseil Authors.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
// -----------------------------------------------------------------------------
|
|
// File: macros.h
|
|
// -----------------------------------------------------------------------------
|
|
//
|
|
// This header file defines the set of language macros used within Abseil code.
|
|
// For the set of macros used to determine supported compilers and platforms,
|
|
// see absl/base/config.h instead.
|
|
//
|
|
// This code is compiled directly on many platforms, including client
|
|
// platforms like Windows, Mac, and embedded systems. Before making
|
|
// any changes here, make sure that you're not breaking any platforms.
|
|
|
|
#ifndef ABSL_BASE_MACROS_H_
|
|
#define ABSL_BASE_MACROS_H_
|
|
|
|
#include <cassert>
|
|
#include <cstddef>
|
|
|
|
#include "absl/base/attributes.h"
|
|
#include "absl/base/config.h"
|
|
#include "absl/base/optimization.h"
|
|
#include "absl/base/port.h"
|
|
|
|
// ABSL_ARRAYSIZE()
|
|
//
|
|
// Returns the number of elements in an array as a compile-time constant, which
|
|
// can be used in defining new arrays. If you use this macro on a pointer by
|
|
// mistake, you will get a compile-time error.
|
|
#define ABSL_ARRAYSIZE(array) \
|
|
(sizeof(::absl::macros_internal::ArraySizeHelper(array)))
|
|
|
|
namespace absl {
|
|
ABSL_NAMESPACE_BEGIN
|
|
namespace macros_internal {
|
|
// Note: this internal template function declaration is used by ABSL_ARRAYSIZE.
|
|
// The function doesn't need a definition, as we only use its type.
|
|
template <typename T, size_t N>
|
|
auto ArraySizeHelper(const T (&array)[N]) -> char (&)[N];
|
|
} // namespace macros_internal
|
|
ABSL_NAMESPACE_END
|
|
} // namespace absl
|
|
|
|
// ABSL_BAD_CALL_IF()
|
|
//
|
|
// Used on a function overload to trap bad calls: any call that matches the
|
|
// overload will cause a compile-time error. This macro uses a clang-specific
|
|
// "enable_if" attribute, as described at
|
|
// https://clang.llvm.org/docs/AttributeReference.html#enable-if
|
|
//
|
|
// Overloads which use this macro should be bracketed by
|
|
// `#ifdef ABSL_BAD_CALL_IF`.
|
|
//
|
|
// Example:
|
|
//
|
|
// int isdigit(int c);
|
|
// #ifdef ABSL_BAD_CALL_IF
|
|
// int isdigit(int c)
|
|
// ABSL_BAD_CALL_IF(c <= -1 || c > 255,
|
|
// "'c' must have the value of an unsigned char or EOF");
|
|
// #endif // ABSL_BAD_CALL_IF
|
|
#if ABSL_HAVE_ATTRIBUTE(enable_if)
|
|
#define ABSL_BAD_CALL_IF(expr, msg) \
|
|
__attribute__((enable_if(expr, "Bad call trap"), unavailable(msg)))
|
|
#endif
|
|
|
|
// ABSL_ASSERT()
|
|
//
|
|
// In C++11, `assert` can't be used portably within constexpr functions.
|
|
// ABSL_ASSERT functions as a runtime assert but works in C++11 constexpr
|
|
// functions. Example:
|
|
//
|
|
// constexpr double Divide(double a, double b) {
|
|
// return ABSL_ASSERT(b != 0), a / b;
|
|
// }
|
|
//
|
|
// This macro is inspired by
|
|
// https://akrzemi1.wordpress.com/2017/05/18/asserts-in-constexpr-functions/
|
|
#if defined(NDEBUG)
|
|
#define ABSL_ASSERT(expr) \
|
|
(false ? static_cast<void>(expr) : static_cast<void>(0))
|
|
#else
|
|
#define ABSL_ASSERT(expr) \
|
|
(ABSL_PREDICT_TRUE((expr)) ? static_cast<void>(0) \
|
|
: [] { assert(false && #expr); }()) // NOLINT
|
|
#endif
|
|
|
|
// `ABSL_INTERNAL_HARDENING_ABORT()` controls how `ABSL_HARDENING_ASSERT()`
|
|
// aborts the program in release mode (when NDEBUG is defined). The
|
|
// implementation should abort the program as quickly as possible and ideally it
|
|
// should not be possible to ignore the abort request.
|
|
#define ABSL_INTERNAL_HARDENING_ABORT() \
|
|
do { \
|
|
ABSL_INTERNAL_IMMEDIATE_ABORT_IMPL(); \
|
|
ABSL_INTERNAL_UNREACHABLE_IMPL(); \
|
|
} while (false)
|
|
|
|
// ABSL_HARDENING_ASSERT()
|
|
//
|
|
// `ABSL_HARDENING_ASSERT()` is like `ABSL_ASSERT()`, but used to implement
|
|
// runtime assertions that should be enabled in hardened builds even when
|
|
// `NDEBUG` is defined.
|
|
//
|
|
// When `NDEBUG` is not defined, `ABSL_HARDENING_ASSERT()` is identical to
|
|
// `ABSL_ASSERT()`.
|
|
//
|
|
// See `ABSL_OPTION_HARDENED` in `absl/base/options.h` for more information on
|
|
// hardened mode.
|
|
#if ABSL_OPTION_HARDENED == 1 && defined(NDEBUG)
|
|
#define ABSL_HARDENING_ASSERT(expr) \
|
|
(ABSL_PREDICT_TRUE((expr)) ? static_cast<void>(0) \
|
|
: [] { ABSL_INTERNAL_HARDENING_ABORT(); }())
|
|
#else
|
|
#define ABSL_HARDENING_ASSERT(expr) ABSL_ASSERT(expr)
|
|
#endif
|
|
|
|
#ifdef ABSL_HAVE_EXCEPTIONS
|
|
#define ABSL_INTERNAL_TRY try
|
|
#define ABSL_INTERNAL_CATCH_ANY catch (...)
|
|
#define ABSL_INTERNAL_RETHROW do { throw; } while (false)
|
|
#else // ABSL_HAVE_EXCEPTIONS
|
|
#define ABSL_INTERNAL_TRY if (true)
|
|
#define ABSL_INTERNAL_CATCH_ANY else if (false)
|
|
#define ABSL_INTERNAL_RETHROW do {} while (false)
|
|
#endif // ABSL_HAVE_EXCEPTIONS
|
|
|
|
// ABSL_DEPRECATE_AND_INLINE()
|
|
//
|
|
// Marks a function or type alias as deprecated and tags it to be picked up for
|
|
// automated refactoring by go/cpp-inliner. It can added to inline function
|
|
// definitions or type aliases. It should only be used within a header file. It
|
|
// differs from `ABSL_DEPRECATED` in the following ways:
|
|
//
|
|
// 1. New uses of the function or type will be discouraged via Tricorder
|
|
// warnings.
|
|
// 2. If enabled via `METADATA`, automated changes will be sent out inlining the
|
|
// functions's body or replacing the type where it is used.
|
|
//
|
|
// For example:
|
|
//
|
|
// ABSL_DEPRECATE_AND_INLINE() inline int OldFunc(int x) {
|
|
// return NewFunc(x, 0);
|
|
// }
|
|
//
|
|
// will mark `OldFunc` as deprecated, and the go/cpp-inliner service will
|
|
// replace calls to `OldFunc(x)` with calls to `NewFunc(x, 0)`. Once all calls
|
|
// to `OldFunc` have been replaced, `OldFunc` can be deleted.
|
|
//
|
|
// See go/cpp-inliner for more information.
|
|
//
|
|
// Note: go/cpp-inliner is Google-internal service for automated refactoring.
|
|
// While open-source users do not have access to this service, the macro is
|
|
// provided for compatibility, and so that users receive deprecation warnings.
|
|
#if ABSL_HAVE_CPP_ATTRIBUTE(deprecated) && \
|
|
ABSL_HAVE_CPP_ATTRIBUTE(clang::annotate)
|
|
#define ABSL_DEPRECATE_AND_INLINE() [[deprecated, clang::annotate("inline-me")]]
|
|
#elif ABSL_HAVE_CPP_ATTRIBUTE(deprecated)
|
|
#define ABSL_DEPRECATE_AND_INLINE() [[deprecated]]
|
|
#else
|
|
#define ABSL_DEPRECATE_AND_INLINE()
|
|
#endif
|
|
|
|
// Requires the compiler to prove that the size of the given object is at least
|
|
// the expected amount.
|
|
#if ABSL_HAVE_ATTRIBUTE(diagnose_if) && ABSL_HAVE_BUILTIN(__builtin_object_size)
|
|
#define ABSL_INTERNAL_NEED_MIN_SIZE(Obj, N) \
|
|
__attribute__((diagnose_if(__builtin_object_size(Obj, 0) < N, \
|
|
"object size provably too small " \
|
|
"(this would corrupt memory)", \
|
|
"error")))
|
|
#else
|
|
#define ABSL_INTERNAL_NEED_MIN_SIZE(Obj, N)
|
|
#endif
|
|
|
|
#endif // ABSL_BASE_MACROS_H_
|