clang-tools 6.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_MISC_MACRO_PARENTHESES_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_MACRO_PARENTHESES_H
12
13 #include "../ClangTidy.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace misc {
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.
32 class MacroParenthesesCheck : public ClangTidyCheck {
33 public:
34 MacroParenthesesCheck(StringRef Name, ClangTidyContext *Context)
35 : ClangTidyCheck(Name, Context) {}
36 void registerPPCallbacks(CompilerInstance &Compiler) override;
37 };
38
39 } // namespace misc
40 } // namespace tidy
41 } // namespace clang
42
43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_MACRO_PARENTHESES_H
Name
StringHandle Name
Definition: PreprocessorTracker.cpp:525
clang::tidy::misc::MacroParenthesesCheck::MacroParenthesesCheck
MacroParenthesesCheck(StringRef Name, ClangTidyContext *Context)
Definition: MacroParenthesesCheck.h:34
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
clang::tidy::misc::MacroParenthesesCheck
Finds macros that can have unexpected behaviour due to missing parentheses.
Definition: MacroParenthesesCheck.h:32
clang::tidy::misc::MacroParenthesesCheck::registerPPCallbacks
void registerPPCallbacks(CompilerInstance &Compiler) override
Override this to register PPCallbacks with Compiler.
Definition: MacroParenthesesCheck.cpp:252
clang
Definition: AndroidTidyModule.cpp:28
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:104