mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-04 22:02:52 +01:00
Jon Meow
af694b97cb
I'm doing this to avoid macro name conflicts, following https://google.github.io/styleguide/cppguide.html#Preprocessor_Macros: "If you do export a macro from a header, it must have a globally unique name. To achieve this, it must be named with a prefix consisting of your project's namespace name (but upper case)." Commands run: ``` sed -i 's/\(DCHECK\|CHECK\|FATAL\|MAKE_UNIQUE_NAME\|MAKE_UNIQUE_NAME_IMPL\|RAW_EXITING_STREAM\|RETURN_IF_ERROR\|RETURN_IF_ERROR_IMPL\|ASSIGN_OR_RETURN\|ASSIGN_OR_RETURN_IMPL\|DIAGNOSTIC_KIND\|RETURN_IF_STACK_LIMITED\)(/CARBON_\1(/g' $(git ls-files *.cpp *.h *.lpp *.ypp *.def ':!third_party') sed -i 's/#undef DIAGNOSTIC_KIND/#undef CARBON_DIAGNOSTIC_KIND/' toolchain/diagnostics/diagnostic_registry.def ``` Note this isn't *quite* everything, but it's intended to be a large pass at everything: ``` ╚╡git grep '#define ' *.cpp *.h *.lpp *.ypp *.def ':!third_party' | grep -v '#define CARBON' | grep -v _H_ explorer/syntax/lexer.lpp: #define YY_USER_ACTION \ explorer/syntax/lexer.lpp: #define SIMPLE_TOKEN(name) \ explorer/syntax/lexer.lpp: #define ARG_TOKEN(name, arg) \ explorer/syntax/parse_and_lex_context.h:#define YY_DECL \ migrate_cpp/cpp_refactoring/var_decl.cpp:#define ABSTRACT_TYPE(Class, Base) migrate_cpp/cpp_refactoring/var_decl.cpp:#define TYPE(Class, Base) \ ``` We may in particular want to do a pass to clean up #ifdef guards and make them be CARBON_ rooted.
51 lines
1.9 KiB
C++
51 lines
1.9 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 COMMON_CHECK_H_
|
|
#define 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 // COMMON_CHECK_H_
|