clang-tools  8.0.0
MacroParenthesesCheck.h
Go to the documentation of this file.
1 //===--- MacroParenthesesCheck.h - clang-tidy--------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_MACROPARENTHESESCHECK_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_MACROPARENTHESESCHECK_H
12 
13 #include "../ClangTidy.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace bugprone {
18 
19 /// Finds macros that can have unexpected behaviour due to missing parentheses.
20 ///
21 /// Macros are expanded by the preprocessor as-is. As a result, there can be
22 /// unexpected behaviour; operators may be evaluated in unexpected order and
23 /// unary operators may become binary operators, etc.
24 ///
25 /// When the replacement list has an expression, it is recommended to surround
26 /// it with parentheses. This ensures that the macro result is evaluated
27 /// completely before it is used.
28 ///
29 /// It is also recommended to surround macro arguments in the replacement list
30 /// with parentheses. This ensures that the argument value is calculated
31 /// properly.
33 public:
35  : ClangTidyCheck(Name, Context) {}
36  void registerPPCallbacks(CompilerInstance &Compiler) override;
37 };
38 
39 } // namespace bugprone
40 } // namespace tidy
41 } // namespace clang
42 
43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_MACROPARENTHESESCHECK_H
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
void registerPPCallbacks(CompilerInstance &Compiler) override
Override this to register PPCallbacks with Compiler.
MacroParenthesesCheck(StringRef Name, ClangTidyContext *Context)
Finds macros that can have unexpected behaviour due to missing parentheses.
static constexpr llvm::StringLiteral Name
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.