clang-tools 17.0.0git
ASTUtils.cpp
Go to the documentation of this file.
1//===---------- ASTUtils.cpp - clang-tidy ---------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "ASTUtils.h"
10
11#include "clang/ASTMatchers/ASTMatchFinder.h"
12#include "clang/ASTMatchers/ASTMatchers.h"
13#include "clang/Lex/Lexer.h"
14
15namespace clang::tidy::utils {
16using namespace ast_matchers;
17
18const FunctionDecl *getSurroundingFunction(ASTContext &Context,
19 const Stmt &Statement) {
20 return selectFirst<const FunctionDecl>(
21 "function", match(stmt(hasAncestor(functionDecl().bind("function"))),
22 Statement, Context));
23}
24
25bool isBinaryOrTernary(const Expr *E) {
26 const Expr *EBase = E->IgnoreImpCasts();
27 if (isa<BinaryOperator>(EBase) || isa<ConditionalOperator>(EBase)) {
28 return true;
29 }
30
31 if (const auto *Operator = dyn_cast<CXXOperatorCallExpr>(EBase)) {
32 return Operator->isInfixBinaryOp();
33 }
34
35 return false;
36}
37
38bool exprHasBitFlagWithSpelling(const Expr *Flags, const SourceManager &SM,
39 const LangOptions &LangOpts,
40 StringRef FlagName) {
41 // If the Flag is an integer constant, check it.
42 if (isa<IntegerLiteral>(Flags)) {
43 if (!SM.isMacroBodyExpansion(Flags->getBeginLoc()) &&
44 !SM.isMacroArgExpansion(Flags->getBeginLoc()))
45 return false;
46
47 // Get the macro name.
48 auto MacroName = Lexer::getSourceText(
49 CharSourceRange::getTokenRange(Flags->getSourceRange()), SM, LangOpts);
50
51 return MacroName == FlagName;
52 }
53 // If it's a binary OR operation.
54 if (const auto *BO = dyn_cast<BinaryOperator>(Flags))
55 if (BO->getOpcode() == BinaryOperatorKind::BO_Or)
56 return exprHasBitFlagWithSpelling(BO->getLHS()->IgnoreParenCasts(), SM,
57 LangOpts, FlagName) ||
58 exprHasBitFlagWithSpelling(BO->getRHS()->IgnoreParenCasts(), SM,
59 LangOpts, FlagName);
60
61 // Otherwise, assume it has the flag.
62 return true;
63}
64
66 const SourceManager *SM) {
67 // Check if the range is entirely contained within a macro argument.
68 SourceLocation MacroArgExpansionStartForRangeBegin;
69 SourceLocation MacroArgExpansionStartForRangeEnd;
70 bool RangeIsEntirelyWithinMacroArgument =
71 SM &&
72 SM->isMacroArgExpansion(Range.getBegin(),
73 &MacroArgExpansionStartForRangeBegin) &&
74 SM->isMacroArgExpansion(Range.getEnd(),
75 &MacroArgExpansionStartForRangeEnd) &&
76 MacroArgExpansionStartForRangeBegin == MacroArgExpansionStartForRangeEnd;
77
78 return RangeIsEntirelyWithinMacroArgument;
79}
80
81bool rangeContainsMacroExpansion(SourceRange Range, const SourceManager *SM) {
83 Range.getBegin().isMacroID() || Range.getEnd().isMacroID();
84}
85
86bool rangeCanBeFixed(SourceRange Range, const SourceManager *SM) {
89}
90
91} // namespace clang::tidy::utils
const Expr * E
CharSourceRange Range
SourceRange for the file name.
bool rangeCanBeFixed(SourceRange Range, const SourceManager *SM)
Definition: ASTUtils.cpp:86
bool isBinaryOrTernary(const Expr *E)
Definition: ASTUtils.cpp:25
bool rangeContainsMacroExpansion(SourceRange Range, const SourceManager *SM)
Definition: ASTUtils.cpp:81
bool exprHasBitFlagWithSpelling(const Expr *Flags, const SourceManager &SM, const LangOptions &LangOpts, StringRef FlagName)
Checks whether a macro flag is present in the given argument.
Definition: ASTUtils.cpp:38
bool rangeIsEntirelyWithinMacroArgument(SourceRange Range, const SourceManager *SM)
Definition: ASTUtils.cpp:65
const FunctionDecl * getSurroundingFunction(ASTContext &Context, const Stmt &Statement)
Definition: ASTUtils.cpp:18