Files
carbon-lang/common/check.h
T
Jon Meow 20728dbd3a CARBON_ header guards (#1261)
This modifies scripts/check_header_guards.py to add the CARBON_ prefix; everything else is pre-commit.
2022-05-12 17:25:43 -07:00

51 lines
2.0 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef CARBON_COMMON_CHECK_H_
#define CARBON_COMMON_CHECK_H_
#include "common/check_internal.h"
namespace Carbon {
// Raw exiting stream. This should be used when building other forms of exiting
// macros like those below. It evaluates to a temporary `ExitingStream` object
// that can be manipulated, streamed into, and then will exit the program.
#define CARBON_RAW_EXITING_STREAM() \
Carbon::Internal::ExitingStream::Helper() | Carbon::Internal::ExitingStream()
// Checks the given condition, and if it's false, prints a stack, streams the
// error message, then exits. This should be used for unexpected errors, such as
// a bug in the application.
//
// For example:
// CARBON_CHECK(is_valid) << "Data is not valid!";
#define CARBON_CHECK(condition) \
(condition) ? (void)0 \
: CARBON_RAW_EXITING_STREAM() \
<< "CHECK failure at " << __FILE__ << ":" << __LINE__ \
<< ": " #condition \
<< Carbon::Internal::ExitingStream::AddSeparator()
// DCHECK calls CHECK in debug mode, and does nothing otherwise.
#ifndef NDEBUG
#define CARBON_DCHECK(condition) CARBON_CHECK(condition)
#else
#define CARBON_DCHECK(condition) CARBON_CHECK(true || (condition))
#endif
// This is similar to CHECK, but is unconditional. Writing CARBON_FATAL() is
// clearer than CARBON_CHECK(false) because it avoids confusion about control
// flow.
//
// For example:
// CARBON_FATAL() << "Unreachable!";
#define CARBON_FATAL() \
CARBON_RAW_EXITING_STREAM() \
<< "FATAL failure at " << __FILE__ << ":" << __LINE__ << ": "
} // namespace Carbon
#endif // CARBON_COMMON_CHECK_H_