1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
| //===--- TimeSubtractionCheck.cpp - clang-tidy ----------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "TimeSubtractionCheck.h"
#include "DurationRewriter.h"
#include "clang/AST/ASTContext.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Tooling/FixIt.h"
using namespace clang::ast_matchers;
namespace clang {
namespace tidy {
namespace abseil {
// Returns `true` if `Range` is inside a macro definition.
static bool InsideMacroDefinition(const MatchFinder::MatchResult &Result,
SourceRange Range) {
return !clang::Lexer::makeFileCharRange(
clang::CharSourceRange::getCharRange(Range),
*Result.SourceManager, Result.Context->getLangOpts())
.isValid();
}
static bool isConstructorAssignment(const MatchFinder::MatchResult &Result,
const Expr *Node) {
// For C++14 and earlier there are elidable constructors that must be matched
// in hasParent. The elidable constructors do not exist in C++17 and later and
// therefore an additional check that does not match against the elidable
// constructors are needed for this case.
return selectFirst<const Expr>(
"e",
match(expr(anyOf(
callExpr(hasParent(materializeTemporaryExpr(hasParent(
cxxConstructExpr(hasParent(exprWithCleanups(
hasParent(varDecl()))))))))
.bind("e"),
callExpr(hasParent(varDecl())).bind("e"))),
*Node, *Result.Context)) != nullptr;
}
static bool isArgument(const MatchFinder::MatchResult &Result,
const Expr *Node) {
// For the same reason as in isConstructorAssignment two AST shapes need to be
// matched here.
return selectFirst<const Expr>(
"e",
match(
expr(anyOf(
expr(hasParent(materializeTemporaryExpr(
hasParent(cxxConstructExpr(
hasParent(callExpr()),
unless(hasParent(cxxOperatorCallExpr())))))))
.bind("e"),
expr(hasParent(callExpr()),
unless(hasParent(cxxOperatorCallExpr())))
.bind("e"))),
*Node, *Result.Context)) != nullptr;
}
static bool isReturn(const MatchFinder::MatchResult &Result, const Expr *Node) {
// For the same reason as in isConstructorAssignment two AST shapes need to be
// matched here.
return selectFirst<const Expr>(
"e",
match(expr(anyOf(
expr(hasParent(materializeTemporaryExpr(hasParent(
cxxConstructExpr(hasParent(exprWithCleanups(
hasParent(returnStmt()))))))))
.bind("e"),
expr(hasParent(returnStmt())).bind("e"))),
*Node, *Result.Context)) != nullptr;
}
static bool parensRequired(const MatchFinder::MatchResult &Result,
const Expr *Node) {
// TODO: Figure out any more contexts in which we can omit the surrounding
// parentheses.
return !(isConstructorAssignment(Result, Node) || isArgument(Result, Node) ||
isReturn(Result, Node));
}
void TimeSubtractionCheck::emitDiagnostic(const Expr *Node,
llvm::StringRef Replacement) {
diag(Node->getBeginLoc(), "perform subtraction in the time domain")
<< FixItHint::CreateReplacement(Node->getSourceRange(), Replacement);
}
void TimeSubtractionCheck::registerMatchers(MatchFinder *Finder) {
for (auto ScaleName :
{"Hours", "Minutes", "Seconds", "Millis", "Micros", "Nanos"}) {
std::string TimeInverse = (llvm::Twine("ToUnix") + ScaleName).str();
llvm::Optional<DurationScale> Scale = getScaleForTimeInverse(TimeInverse);
assert(Scale && "Unknow scale encountered");
auto TimeInverseMatcher = callExpr(callee(
functionDecl(hasName((llvm::Twine("::absl::") + TimeInverse).str()))
.bind("func_decl")));
// Match the cases where we know that the result is a 'Duration' and the
// first argument is a 'Time'. Just knowing the type of the first operand
// is not sufficient, since the second operand could be either a 'Time' or
// a 'Duration'. If we know the result is a 'Duration', we can then infer
// that the second operand must be a 'Time'.
auto CallMatcher =
callExpr(
callee(functionDecl(hasName(getDurationFactoryForScale(*Scale)))),
hasArgument(0, binaryOperator(hasOperatorName("-"),
hasLHS(TimeInverseMatcher))
.bind("binop")))
.bind("outer_call");
Finder->addMatcher(CallMatcher, this);
// Match cases where we know the second operand is a 'Time'. Since
// subtracting a 'Time' from a 'Duration' is not defined, in these cases,
// we always know the first operand is a 'Time' if the second is a 'Time'.
auto OperandMatcher =
binaryOperator(hasOperatorName("-"), hasRHS(TimeInverseMatcher))
.bind("binop");
Finder->addMatcher(OperandMatcher, this);
}
}
void TimeSubtractionCheck::check(const MatchFinder::MatchResult &Result) {
const auto *BinOp = Result.Nodes.getNodeAs<BinaryOperator>("binop");
std::string InverseName =
Result.Nodes.getNodeAs<FunctionDecl>("func_decl")->getNameAsString();
if (InsideMacroDefinition(Result, BinOp->getSourceRange()))
return;
llvm::Optional<DurationScale> Scale = getScaleForTimeInverse(InverseName);
if (!Scale)
return;
const auto *OuterCall = Result.Nodes.getNodeAs<CallExpr>("outer_call");
if (OuterCall) {
if (InsideMacroDefinition(Result, OuterCall->getSourceRange()))
return;
// We're working with the first case of matcher, and need to replace the
// entire 'Duration' factory call. (Which also means being careful about
// our order-of-operations and optionally putting in some parenthesis.
bool NeedParens = parensRequired(Result, OuterCall);
emitDiagnostic(
OuterCall,
(llvm::Twine(NeedParens ? "(" : "") +
rewriteExprFromNumberToTime(Result, *Scale, BinOp->getLHS()) + " - " +
rewriteExprFromNumberToTime(Result, *Scale, BinOp->getRHS()) +
(NeedParens ? ")" : ""))
.str());
} else {
// We're working with the second case of matcher, and either just need to
// change the arguments, or perhaps remove an outer function call. In the
// latter case (addressed first), we also need to worry about parenthesis.
const auto *MaybeCallArg = selectFirst<const CallExpr>(
"arg", match(expr(hasAncestor(
callExpr(callee(functionDecl(hasName(
getDurationFactoryForScale(*Scale)))))
.bind("arg"))),
*BinOp, *Result.Context));
if (MaybeCallArg && MaybeCallArg->getArg(0)->IgnoreImpCasts() == BinOp &&
!InsideMacroDefinition(Result, MaybeCallArg->getSourceRange())) {
// Handle the case where the matched expression is inside a call which
// converts it from the inverse to a Duration. In this case, we replace
// the outer with just the subtraction expresison, which gives the right
// type and scale, taking care again about parenthesis.
bool NeedParens = parensRequired(Result, MaybeCallArg);
emitDiagnostic(
MaybeCallArg,
(llvm::Twine(NeedParens ? "(" : "") +
rewriteExprFromNumberToTime(Result, *Scale, BinOp->getLHS()) +
" - " +
rewriteExprFromNumberToTime(Result, *Scale, BinOp->getRHS()) +
(NeedParens ? ")" : ""))
.str());
} else {
// In the last case, just convert the arguments and wrap the result in
// the correct inverse function.
emitDiagnostic(
BinOp,
(llvm::Twine(
getDurationInverseForScale(*Scale).second.str().substr(2)) +
"(" + rewriteExprFromNumberToTime(Result, *Scale, BinOp->getLHS()) +
" - " +
rewriteExprFromNumberToTime(Result, *Scale, BinOp->getRHS()) + ")")
.str());
}
}
}
} // namespace abseil
} // namespace tidy
} // namespace clang
|