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
| //===-- TweakTesting.cpp ------------------------------------------------*-===//
//
// 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 "TweakTesting.h"
#include "Annotations.h"
#include "SourceCode.h"
#include "TestFS.h"
#include "refactor/Tweak.h"
#include "clang/Tooling/Core/Replacement.h"
#include "llvm/Support/Error.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <string>
namespace clang {
namespace clangd {
namespace {
using Context = TweakTest::CodeContext;
std::pair<llvm::StringRef, llvm::StringRef> wrapping(Context Ctx) {
switch (Ctx) {
case TweakTest::File:
return {"",""};
case TweakTest::Function:
return {"void wrapperFunction(){\n", "\n}"};
case TweakTest::Expression:
return {"auto expressionWrapper(){return\n", "\n;}"};
}
llvm_unreachable("Unknown TweakTest::CodeContext enum");
}
std::string wrap(Context Ctx, llvm::StringRef Inner) {
auto Wrapping = wrapping(Ctx);
return (Wrapping.first + Inner + Wrapping.second).str();
}
llvm::StringRef unwrap(Context Ctx, llvm::StringRef Outer) {
auto Wrapping = wrapping(Ctx);
// Unwrap only if the code matches the expected wrapping.
// Don't allow the begin/end wrapping to overlap!
if (Outer.startswith(Wrapping.first) && Outer.endswith(Wrapping.second) &&
Outer.size() >= Wrapping.first.size() + Wrapping.second.size())
return Outer.drop_front(Wrapping.first.size()).drop_back(Wrapping.second.size());
return Outer;
}
std::pair<unsigned, unsigned> rangeOrPoint(const Annotations &A) {
Range SelectionRng;
if (A.points().size() != 0) {
assert(A.ranges().size() == 0 &&
"both a cursor point and a selection range were specified");
SelectionRng = Range{A.point(), A.point()};
} else {
SelectionRng = A.range();
}
return {cantFail(positionToOffset(A.code(), SelectionRng.start)),
cantFail(positionToOffset(A.code(), SelectionRng.end))};
}
MATCHER_P6(TweakIsAvailable, TweakID, Ctx, Header, ExtraArgs, ExtraFiles, Index,
(TweakID + (negation ? " is unavailable" : " is available")).str()) {
std::string WrappedCode = wrap(Ctx, arg);
Annotations Input(WrappedCode);
auto Selection = rangeOrPoint(Input);
TestTU TU;
TU.HeaderCode = Header;
TU.Code = Input.code();
TU.ExtraArgs = ExtraArgs;
TU.AdditionalFiles = std::move(ExtraFiles);
ParsedAST AST = TU.build();
Tweak::Selection S(Index, AST, Selection.first, Selection.second);
auto PrepareResult = prepareTweak(TweakID, S);
if (PrepareResult)
return true;
llvm::consumeError(PrepareResult.takeError());
return false;
}
} // namespace
std::string TweakTest::apply(llvm::StringRef MarkedCode,
llvm::StringMap<std::string> *EditedFiles) const {
std::string WrappedCode = wrap(Context, MarkedCode);
Annotations Input(WrappedCode);
auto Selection = rangeOrPoint(Input);
TestTU TU;
TU.HeaderCode = Header;
TU.AdditionalFiles = std::move(ExtraFiles);
TU.Code = Input.code();
TU.ExtraArgs = ExtraArgs;
ParsedAST AST = TU.build();
Tweak::Selection S(Index.get(), AST, Selection.first, Selection.second);
auto T = prepareTweak(TweakID, S);
if (!T) {
llvm::consumeError(T.takeError());
return "unavailable";
}
llvm::Expected<Tweak::Effect> Result = (*T)->apply(S);
if (!Result)
return "fail: " + llvm::toString(Result.takeError());
if (Result->ShowMessage)
return "message:\n" + *Result->ShowMessage;
if (Result->ApplyEdits.empty())
return "no effect";
std::string EditedMainFile;
for (auto &It : Result->ApplyEdits) {
auto NewText = It.second.apply();
if (!NewText)
return "bad edits: " + llvm::toString(NewText.takeError());
llvm::StringRef Unwrapped = unwrap(Context, *NewText);
if (It.first() == testPath(TU.Filename))
EditedMainFile = Unwrapped;
else {
if (!EditedFiles)
ADD_FAILURE() << "There were changes to additional files, but client "
"provided a nullptr for EditedFiles.";
else
EditedFiles->try_emplace(It.first(), Unwrapped.str());
}
}
return EditedMainFile;
}
::testing::Matcher<llvm::StringRef> TweakTest::isAvailable() const {
return TweakIsAvailable(llvm::StringRef(TweakID), Context, Header, ExtraArgs,
ExtraFiles, Index.get());
}
std::vector<std::string> TweakTest::expandCases(llvm::StringRef MarkedCode) {
Annotations Test(MarkedCode);
llvm::StringRef Code = Test.code();
std::vector<std::string> Cases;
for (const auto& Point : Test.points()) {
size_t Offset = llvm::cantFail(positionToOffset(Code, Point));
Cases.push_back((Code.substr(0, Offset) + "^" + Code.substr(Offset)).str());
}
for (const auto& Range : Test.ranges()) {
size_t Begin = llvm::cantFail(positionToOffset(Code, Range.start));
size_t End = llvm::cantFail(positionToOffset(Code, Range.end));
Cases.push_back((Code.substr(0, Begin) + "[[" +
Code.substr(Begin, End - Begin) + "]]" + Code.substr(End))
.str());
}
assert(!Cases.empty() && "No markings in MarkedCode?");
return Cases;
}
} // namespace clangd
} // namespace clang
|