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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
//===--- Transformer.cpp - Transformer library implementation ---*- C++ -*-===//
//
// 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 "clang/Tooling/Refactoring/Transformer.h"
#include "clang/AST/Expr.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Rewrite/Core/Rewriter.h"
#include "clang/Tooling/Refactoring/AtomicChange.h"
#include "clang/Tooling/Refactoring/SourceCode.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Errc.h"
#include "llvm/Support/Error.h"
#include <deque>
#include <string>
#include <utility>
#include <vector>
using namespace clang;
using namespace tooling;
using ast_matchers::MatchFinder;
using ast_type_traits::ASTNodeKind;
using ast_type_traits::DynTypedNode;
using llvm::Error;
using llvm::Expected;
using llvm::Optional;
using llvm::StringError;
using llvm::StringRef;
using llvm::Twine;
using MatchResult = MatchFinder::MatchResult;
// Did the text at this location originate in a macro definition (aka. body)?
// For example,
//
// #define NESTED(x) x
// #define MACRO(y) { int y = NESTED(3); }
// if (true) MACRO(foo)
//
// The if statement expands to
//
// if (true) { int foo = 3; }
// ^ ^
// Loc1 Loc2
//
// For SourceManager SM, SM.isMacroArgExpansion(Loc1) and
// SM.isMacroArgExpansion(Loc2) are both true, but isOriginMacroBody(sm, Loc1)
// is false, because "foo" originated in the source file (as an argument to a
// macro), whereas isOriginMacroBody(SM, Loc2) is true, because "3" originated
// in the definition of MACRO.
static bool isOriginMacroBody(const clang::SourceManager &SM,
clang::SourceLocation Loc) {
while (Loc.isMacroID()) {
if (SM.isMacroBodyExpansion(Loc))
return true;
// Otherwise, it must be in an argument, so we continue searching up the
// invocation stack. getImmediateMacroCallerLoc() gives the location of the
// argument text, inside the call text.
Loc = SM.getImmediateMacroCallerLoc(Loc);
}
return false;
}
static llvm::Error invalidArgumentError(Twine Message) {
return llvm::make_error<StringError>(llvm::errc::invalid_argument, Message);
}
static llvm::Error typeError(StringRef Id, const ASTNodeKind &Kind,
Twine Message) {
return invalidArgumentError(
Message + " (node id=" + Id + " kind=" + Kind.asStringRef() + ")");
}
static llvm::Error missingPropertyError(StringRef Id, Twine Description,
StringRef Property) {
return invalidArgumentError(Description + " requires property '" + Property +
"' (node id=" + Id + ")");
}
static Expected<CharSourceRange>
getTargetRange(StringRef Target, const DynTypedNode &Node, ASTNodeKind Kind,
NodePart TargetPart, ASTContext &Context) {
switch (TargetPart) {
case NodePart::Node: {
// For non-expression statements, associate any trailing semicolon with the
// statement text. However, if the target was intended as an expression (as
// indicated by its kind) then we do not associate any trailing semicolon
// with it. We only associate the exact expression text.
if (Node.get<Stmt>() != nullptr) {
auto ExprKind = ASTNodeKind::getFromNodeKind<clang::Expr>();
if (!ExprKind.isBaseOf(Kind))
return getExtendedRange(Node, tok::TokenKind::semi, Context);
}
return CharSourceRange::getTokenRange(Node.getSourceRange());
}
case NodePart::Member:
if (auto *M = Node.get<clang::MemberExpr>())
return CharSourceRange::getTokenRange(
M->getMemberNameInfo().getSourceRange());
return typeError(Target, Node.getNodeKind(),
"NodePart::Member applied to non-MemberExpr");
case NodePart::Name:
if (const auto *D = Node.get<clang::NamedDecl>()) {
if (!D->getDeclName().isIdentifier())
return missingPropertyError(Target, "NodePart::Name", "identifier");
SourceLocation L = D->getLocation();
auto R = CharSourceRange::getTokenRange(L, L);
// Verify that the range covers exactly the name.
// FIXME: extend this code to support cases like `operator +` or
// `foo<int>` for which this range will be too short. Doing so will
// require subcasing `NamedDecl`, because it doesn't provide virtual
// access to the \c DeclarationNameInfo.
if (getText(R, Context) != D->getName())
return CharSourceRange();
return R;
}
if (const auto *E = Node.get<clang::DeclRefExpr>()) {
if (!E->getNameInfo().getName().isIdentifier())
return missingPropertyError(Target, "NodePart::Name", "identifier");
SourceLocation L = E->getLocation();
return CharSourceRange::getTokenRange(L, L);
}
if (const auto *I = Node.get<clang::CXXCtorInitializer>()) {
if (!I->isMemberInitializer() && I->isWritten())
return missingPropertyError(Target, "NodePart::Name",
"explicit member initializer");
SourceLocation L = I->getMemberLocation();
return CharSourceRange::getTokenRange(L, L);
}
return typeError(
Target, Node.getNodeKind(),
"NodePart::Name applied to neither DeclRefExpr, NamedDecl nor "
"CXXCtorInitializer");
}
llvm_unreachable("Unexpected case in NodePart type.");
}
Expected<SmallVector<Transformation, 1>>
tooling::translateEdits(const MatchResult &Result,
llvm::ArrayRef<ASTEdit> Edits) {
SmallVector<Transformation, 1> Transformations;
auto &NodesMap = Result.Nodes.getMap();
for (const auto &Edit : Edits) {
auto It = NodesMap.find(Edit.Target);
assert(It != NodesMap.end() && "Edit target must be bound in the match.");
Expected<CharSourceRange> Range = getTargetRange(
Edit.Target, It->second, Edit.Kind, Edit.Part, *Result.Context);
if (!Range)
return Range.takeError();
if (Range->isInvalid() ||
isOriginMacroBody(*Result.SourceManager, Range->getBegin()))
return SmallVector<Transformation, 0>();
auto Replacement = Edit.Replacement(Result);
if (!Replacement)
return Replacement.takeError();
Transformation T;
T.Range = *Range;
T.Replacement = std::move(*Replacement);
Transformations.push_back(std::move(T));
}
return Transformations;
}
RewriteRule tooling::makeRule(ast_matchers::internal::DynTypedMatcher M,
SmallVector<ASTEdit, 1> Edits) {
M.setAllowBind(true);
// `tryBind` is guaranteed to succeed, because `AllowBind` was set to true.
return RewriteRule{*M.tryBind(RewriteRule::RootId), std::move(Edits),
nullptr};
}
constexpr llvm::StringLiteral RewriteRule::RootId;
void Transformer::registerMatchers(MatchFinder *MatchFinder) {
MatchFinder->addDynamicMatcher(Rule.Matcher, this);
}
void Transformer::run(const MatchResult &Result) {
if (Result.Context->getDiagnostics().hasErrorOccurred())
return;
// Verify the existence and validity of the AST node that roots this rule.
auto &NodesMap = Result.Nodes.getMap();
auto Root = NodesMap.find(RewriteRule::RootId);
assert(Root != NodesMap.end() && "Transformation failed: missing root node.");
SourceLocation RootLoc = Result.SourceManager->getExpansionLoc(
Root->second.getSourceRange().getBegin());
assert(RootLoc.isValid() && "Invalid location for Root node of match.");
auto Transformations = translateEdits(Result, Rule.Edits);
if (!Transformations) {
Consumer(Transformations.takeError());
return;
}
if (Transformations->empty()) {
// No rewrite applied (but no error encountered either).
RootLoc.print(llvm::errs() << "note: skipping match at loc ",
*Result.SourceManager);
llvm::errs() << "\n";
return;
}
// Record the results in the AtomicChange.
AtomicChange AC(*Result.SourceManager, RootLoc);
for (const auto &T : *Transformations) {
if (auto Err = AC.replace(*Result.SourceManager, T.Range, T.Replacement)) {
Consumer(std::move(Err));
return;
}
}
Consumer(std::move(AC));
}
|
