WorkScheduler.runWithAST("Rename", File, std::move(Action));
}
-// May generate several candidate selections, due to SelectionTree ambiguity.
-static llvm::Expected<std::vector<Tweak::Selection>>
+static llvm::Expected<Tweak::Selection>
tweakSelection(const Range &Sel, const InputsAndAST &AST) {
auto Begin = positionToOffset(AST.Inputs.Contents, Sel.start);
if (!Begin)
auto End = positionToOffset(AST.Inputs.Contents, Sel.end);
if (!End)
return End.takeError();
- std::vector<Tweak::Selection> Result;
- SelectionTree::createEach(AST.AST.getASTContext(), AST.AST.getTokens(),
- *Begin, *End, [&](SelectionTree T) {
- Result.emplace_back(AST.Inputs.Index, AST.AST,
- *Begin, *End, std::move(T));
- return false;
- });
- assert(!Result.empty() && "Expected at least one SelectionTree");
- return Result;
+ return Tweak::Selection(AST.Inputs.Index, AST.AST, *Begin, *End);
}
void ClangdServer::enumerateTweaks(PathRef File, Range Sel,
this](Expected<InputsAndAST> InpAST) mutable {
if (!InpAST)
return CB(InpAST.takeError());
- auto Selections = tweakSelection(Sel, *InpAST);
- if (!Selections)
- return CB(Selections.takeError());
+ auto Selection = tweakSelection(Sel, *InpAST);
+ if (!Selection)
+ return CB(Selection.takeError());
std::vector<TweakRef> Res;
- // Don't allow a tweak to fire more than once across ambiguous selections.
- llvm::DenseSet<llvm::StringRef> PreparedTweaks;
- auto Filter = [&](const Tweak &T) {
- return TweakFilter(T) && !PreparedTweaks.count(T.id());
- };
- for (const auto &Sel : *Selections) {
- for (auto &T : prepareTweaks(Sel, Filter)) {
- Res.push_back({T->id(), T->title(), T->intent()});
- PreparedTweaks.insert(T->id());
- }
- }
+ for (auto &T : prepareTweaks(*Selection, TweakFilter))
+ Res.push_back({T->id(), T->title(), T->intent()});
CB(std::move(Res));
};
FS = FSProvider.getFileSystem()](Expected<InputsAndAST> InpAST) mutable {
if (!InpAST)
return CB(InpAST.takeError());
- auto Selections = tweakSelection(Sel, *InpAST);
- if (!Selections)
- return CB(Selections.takeError());
- llvm::Optional<llvm::Expected<Tweak::Effect>> Effect;
- // Try each selection, take the first one that prepare()s.
- // If they all fail, Effect will hold get the last error.
- for (const auto &Selection : *Selections) {
- auto T = prepareTweak(TweakID, Selection);
- if (T) {
- Effect = (*T)->apply(Selection);
- break;
- }
- Effect = T.takeError();
- }
- assert(Effect.hasValue() && "Expected at least one selection");
- if (*Effect) {
- // Tweaks don't apply clang-format, do that centrally here.
- for (auto &It : (*Effect)->ApplyEdits) {
- Edit &E = It.second;
- format::FormatStyle Style =
- getFormatStyleForFile(File, E.InitialCode, FS.get());
- if (llvm::Error Err = reformatEdit(E, Style))
- elog("Failed to format {0}: {1}", It.first(), std::move(Err));
- }
+ auto Selection = tweakSelection(Sel, *InpAST);
+ if (!Selection)
+ return CB(Selection.takeError());
+ auto A = prepareTweak(TweakID, *Selection);
+ if (!A)
+ return CB(A.takeError());
+ auto Effect = (*A)->apply(*Selection);
+ if (!Effect)
+ return CB(Effect.takeError());
+ for (auto &It : Effect->ApplyEdits) {
+ Edit &E = It.second;
+ format::FormatStyle Style =
+ getFormatStyleForFile(File, E.InitialCode, FS.get());
+ if (llvm::Error Err = reformatEdit(E, Style))
+ elog("Failed to format {0}: {1}", It.first(), std::move(Err));
}
return CB(std::move(*Effect));
};
llvm::consumeError(Offset.takeError());
return llvm::None;
}
- // Editors send the position on the left of the hovered character.
- // So our selection tree should be biased right. (Tested with VSCode).
- SelectionTree ST = SelectionTree::createRight(
- AST.getASTContext(), AST.getTokens(), *Offset, *Offset);
+ SelectionTree Selection(AST.getASTContext(), AST.getTokens(), *Offset);
std::vector<const Decl *> Result;
- if (const SelectionTree::Node *N = ST.commonAncestor()) {
+ if (const SelectionTree::Node *N = Selection.commonAncestor()) {
DeclRelationSet Rel = DeclRelation::TemplatePattern | DeclRelation::Alias;
auto Decls = targetDecl(N->ASTNode, Rel);
if (!Decls.empty()) {
Result = SelectionTree::Partial;
}
-// As well as comments, don't count semicolons as real tokens.
-// They're not properly claimed as expr-statement is missing from the AST.
-bool shouldIgnore(const syntax::Token &Tok) {
- return Tok.kind() == tok::comment || Tok.kind() == tok::semi;
-}
// SelectionTester can determine whether a range of tokens from the PP-expanded
// stream (corresponding to an AST node) is considered selected.
});
// Precompute selectedness and offset for selected spelled tokens.
for (const syntax::Token *T = SelFirst; T < SelLimit; ++T) {
- if (shouldIgnore(*T))
+ // As well as comments, don't count semicolons as real tokens.
+ // They're not properly claimed as expr-statement is missing from the AST.
+ if (T->kind() == tok::comment || T->kind() == tok::semi)
continue;
SpelledTokens.emplace_back();
Tok &S = SpelledTokens.back();
return std::move(OS.str());
}
-// Decide which selections emulate a "point" query in between characters.
-// If it's ambiguous (the neighboring characters are selectable tokens), returns
-// both possibilities in preference order.
-// Always returns at least one range - if no tokens touched, and empty range.
-static llvm::SmallVector<std::pair<unsigned, unsigned>, 2>
-pointBounds(unsigned Offset, const syntax::TokenBuffer &Tokens) {
- const auto &SM = Tokens.sourceManager();
- SourceLocation Loc = SM.getComposedLoc(SM.getMainFileID(), Offset);
- llvm::SmallVector<std::pair<unsigned, unsigned>, 2> Result;
- // Prefer right token over left.
- for (const syntax::Token &Tok :
- llvm::reverse(spelledTokensTouching(Loc, Tokens))) {
- if (shouldIgnore(Tok))
- continue;
- unsigned Offset = Tokens.sourceManager().getFileOffset(Tok.location());
- Result.emplace_back(Offset, Offset + Tok.length());
- }
- if (Result.empty())
- Result.emplace_back(Offset, Offset);
- return Result;
-}
-
-bool SelectionTree::createEach(ASTContext &AST,
- const syntax::TokenBuffer &Tokens,
- unsigned Begin, unsigned End,
- llvm::function_ref<bool(SelectionTree)> Func) {
- if (Begin != End)
- return Func(SelectionTree(AST, Tokens, Begin, End));
- for (std::pair<unsigned, unsigned> Bounds : pointBounds(Begin, Tokens))
- if (Func(SelectionTree(AST, Tokens, Bounds.first, Bounds.second)))
- return true;
- return false;
-}
-
-SelectionTree SelectionTree::createRight(ASTContext &AST,
- const syntax::TokenBuffer &Tokens,
- unsigned int Begin, unsigned int End) {
- llvm::Optional<SelectionTree> Result;
- createEach(AST, Tokens, Begin, End, [&](SelectionTree T) {
- Result = std::move(T);
- return true;
- });
- return std::move(*Result);
+// Decide which selection emulates a "point" query in between characters.
+static std::pair<unsigned, unsigned> pointBounds(unsigned Offset, FileID FID,
+ ASTContext &AST) {
+ StringRef Buf = AST.getSourceManager().getBufferData(FID);
+ // Edge-cases where the choice is forced.
+ if (Buf.size() == 0)
+ return {0, 0};
+ if (Offset == 0)
+ return {0, 1};
+ if (Offset == Buf.size())
+ return {Offset - 1, Offset};
+ // We could choose either this byte or the previous. Usually we prefer the
+ // character on the right of the cursor (or under a block cursor).
+ // But if that's whitespace/semicolon, we likely want the token on the left.
+ auto IsIgnoredChar = [](char C) { return isWhitespace(C) || C == ';'; };
+ if (IsIgnoredChar(Buf[Offset]) && !IsIgnoredChar(Buf[Offset - 1]))
+ return {Offset - 1, Offset};
+ return {Offset, Offset + 1};
}
SelectionTree::SelectionTree(ASTContext &AST, const syntax::TokenBuffer &Tokens,
// but that's all clangd has needed so far.
const SourceManager &SM = AST.getSourceManager();
FileID FID = SM.getMainFileID();
+ if (Begin == End)
+ std::tie(Begin, End) = pointBounds(Begin, FID, AST);
PrintPolicy.TerseOutput = true;
PrintPolicy.IncludeNewlines = false;
dlog("Built selection tree\n{0}", *this);
}
+SelectionTree::SelectionTree(ASTContext &AST, const syntax::TokenBuffer &Tokens,
+ unsigned Offset)
+ : SelectionTree(AST, Tokens, Offset, Offset) {}
+
const Node *SelectionTree::commonAncestor() const {
const Node *Ancestor = Root;
while (Ancestor->Children.size() == 1 && !Ancestor->Selected)
// - we determine which low-level nodes are partly or completely covered
// by the selection.
// - we expose a tree of the selected nodes and their lexical parents.
-//
-// Sadly LSP specifies locations as being between characters, and this causes
-// some ambiguities we cannot cleanly resolve:
-// lhs+rhs // targeting '+' or 'lhs'?
-// ^ // in GUI editors, double-clicking 'lhs' yields this position!
-//
-// The best we can do in these cases is try both, which leads to the awkward
-// SelectionTree::createEach() API.
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_SELECTION_H
// point back into the AST it was constructed with.
class SelectionTree {
public:
- // Create selection trees for the given range, and pass them to Func.
- //
- // There may be multiple possible selection trees:
- // - if the range is empty and borders two tokens, a tree for the right token
- // and a tree for the left token will be yielded.
- // - Func should return true on success (stop) and false on failure (continue)
- //
- // Always yields at least one tree. If no tokens are touched, it is empty.
- static bool createEach(ASTContext &AST, const syntax::TokenBuffer &Tokens,
- unsigned Begin, unsigned End,
- llvm::function_ref<bool(SelectionTree)> Func);
-
- // Create a selection tree for the given range.
- //
- // Where ambiguous (range is empty and borders two tokens), prefer the token
- // on the right.
- static SelectionTree createRight(ASTContext &AST,
- const syntax::TokenBuffer &Tokens,
- unsigned Begin, unsigned End);
-
- // Copies are no good - contain pointers to other nodes.
- SelectionTree(const SelectionTree &) = delete;
- SelectionTree &operator=(const SelectionTree &) = delete;
- // Moves are OK though - internal storage is pointer-stable when moved.
- SelectionTree(SelectionTree &&) = default;
- SelectionTree &operator=(SelectionTree &&) = default;
+ // Creates a selection tree at the given byte offset in the main file.
+ // This is approximately equivalent to a range of one character.
+ // (Usually, the character to the right of Offset, sometimes to the left).
+ SelectionTree(ASTContext &AST, const syntax::TokenBuffer &Tokens,
+ unsigned Offset);
+ // Creates a selection tree for the given range in the main file.
+ // The range includes bytes [Start, End).
+ // If Start == End, uses the same heuristics as SelectionTree(AST, Start).
+ SelectionTree(ASTContext &AST, const syntax::TokenBuffer &Tokens,
+ unsigned Start, unsigned End);
// Describes to what extent an AST node is covered by the selection.
enum Selection : unsigned char {
const Node &root() const { return *Root; }
private:
- // Creates a selection tree for the given range in the main file.
- // The range includes bytes [Start, End).
- SelectionTree(ASTContext &AST, const syntax::TokenBuffer &Tokens,
- unsigned Start, unsigned End);
-
std::deque<Node> Nodes; // Stable-pointer storage.
const Node *Root;
clang::PrintingPolicy PrintPolicy;
}
// Get node under the cursor.
- SelectionTree ST = SelectionTree::createRight(
- AST.getASTContext(), AST.getTokens(), *Offset, *Offset);
+ SelectionTree ST(AST.getASTContext(), AST.getTokens(), *Offset);
for (const auto *Node = ST.commonAncestor(); Node != nullptr;
Node = Node->Parent) {
if (const Decl *D = Node->ASTNode.get<Decl>()) {
std::vector<const Decl *> getDeclAtPosition(ParsedAST &AST, SourceLocation Pos,
DeclRelationSet Relations) {
- unsigned Offset = AST.getSourceManager().getDecomposedSpellingLoc(Pos).second;
+ FileID FID;
+ unsigned Offset;
+ std::tie(FID, Offset) = AST.getSourceManager().getDecomposedSpellingLoc(Pos);
+ SelectionTree Selection(AST.getASTContext(), AST.getTokens(), Offset);
std::vector<const Decl *> Result;
- SelectionTree::createEach(AST.getASTContext(), AST.getTokens(), Offset,
- Offset, [&](SelectionTree ST) {
- if (const SelectionTree::Node *N =
- ST.commonAncestor())
- llvm::copy(targetDecl(N->ASTNode, Relations),
- std::back_inserter(Result));
- return !Result.empty();
- });
+ if (const SelectionTree::Node *N = Selection.commonAncestor()) {
+ auto Decls = targetDecl(N->ASTNode, Relations);
+ Result.assign(Decls.begin(), Decls.end());
+ }
return Result;
}
unsigned Offset =
AST.getSourceManager().getDecomposedSpellingLoc(TokenStartLoc).second;
- SelectionTree Selection = SelectionTree::createRight(
- AST.getASTContext(), AST.getTokens(), Offset, Offset);
+ SelectionTree Selection(AST.getASTContext(), AST.getTokens(), Offset);
const SelectionTree::Node *SelectedNode = Selection.commonAncestor();
if (!SelectedNode)
return {};
} // namespace
Tweak::Selection::Selection(const SymbolIndex *Index, ParsedAST &AST,
-<<<<<<< HEAD
unsigned RangeBegin, unsigned RangeEnd)
: Index(Index), AST(&AST), SelectionBegin(RangeBegin),
SelectionEnd(RangeEnd),
ASTSelection(AST.getASTContext(), AST.getTokens(), RangeBegin, RangeEnd) {
-=======
- unsigned RangeBegin, unsigned RangeEnd,
- SelectionTree ASTSelection)
- : Index(Index), AST(&AST), SelectionBegin(RangeBegin),
- SelectionEnd(RangeEnd), ASTSelection(std::move(ASTSelection)) {
->>>>>>> [clangd] Make Tweak::Selection movable. NFC
auto &SM = AST.getSourceManager();
Code = SM.getBufferData(SM.getMainFileID());
Cursor = SM.getComposedLoc(SM.getMainFileID(), RangeBegin);
/// Input to prepare and apply tweaks.
struct Selection {
Selection(const SymbolIndex *Index, ParsedAST &AST, unsigned RangeBegin,
- unsigned RangeEnd, SelectionTree ASTSelection);
+ unsigned RangeEnd);
/// The text of the active document.
llvm::StringRef Code;
/// The Index for handling codebase related queries.
auto AST = TU.build();
EXPECT_THAT(AST.getDiagnostics(), ::testing::IsEmpty()) << Code;
llvm::Annotations::Range R = A.range();
- auto Selection = SelectionTree::createRight(
- AST.getASTContext(), AST.getTokens(), R.Begin, R.End);
+ SelectionTree Selection(AST.getASTContext(), AST.getTokens(), R.Begin,
+ R.End);
const SelectionTree::Node *N = Selection.commonAncestor();
if (!N) {
ADD_FAILURE() << "No node selected!\n" << Code;
}
)cpp",
R"cpp(// Template auto parameter. Nothing (Not useful).
- template<a^uto T>
+ template<^auto T>
void func() {
}
void foo() {
namespace {
using ::testing::UnorderedElementsAreArray;
-// Create a selection tree corresponding to a point or pair of points.
-// This uses the precisely-defined createRight semantics. The fuzzier
-// createEach is tested separately.
SelectionTree makeSelectionTree(const StringRef MarkedCode, ParsedAST &AST) {
Annotations Test(MarkedCode);
switch (Test.points().size()) {
- case 1: { // Point selection.
- unsigned Offset = cantFail(positionToOffset(Test.code(), Test.point()));
- return SelectionTree::createRight(AST.getASTContext(), AST.getTokens(),
- Offset, Offset);
- }
+ case 1: // Point selection.
+ return SelectionTree(AST.getASTContext(), AST.getTokens(),
+ cantFail(positionToOffset(Test.code(), Test.point())));
case 2: // Range selection.
- return SelectionTree::createRight(
+ return SelectionTree(
AST.getASTContext(), AST.getTokens(),
cantFail(positionToOffset(Test.code(), Test.points()[0])),
cantFail(positionToOffset(Test.code(), Test.points()[1])));
default:
ADD_FAILURE() << "Expected 1-2 points for selection.\n" << MarkedCode;
- return SelectionTree::createRight(AST.getASTContext(), AST.getTokens(), 0u,
- 0u);
+ return SelectionTree(AST.getASTContext(), AST.getTokens(), 0u, 0u);
}
}
EXPECT_EQ("CXXConstructExpr", nodeKind(&Str->outerImplicit()));
}
-TEST(SelectionTest, CreateAll) {
- llvm::Annotations Test("int$unique^ a=1$ambiguous^+1; $empty^");
- auto AST = TestTU::withCode(Test.code()).build();
- unsigned Seen = 0;
- SelectionTree::createEach(
- AST.getASTContext(), AST.getTokens(), Test.point("ambiguous"),
- Test.point("ambiguous"), [&](SelectionTree T) {
- // Expect to see the right-biased tree first.
- if (Seen == 0)
- EXPECT_EQ("BinaryOperator", nodeKind(T.commonAncestor()));
- else if (Seen == 1)
- EXPECT_EQ("IntegerLiteral", nodeKind(T.commonAncestor()));
- ++Seen;
- return false;
- });
- EXPECT_EQ(2u, Seen);
-
- Seen = 0;
- SelectionTree::createEach(AST.getASTContext(), AST.getTokens(),
- Test.point("ambiguous"), Test.point("ambiguous"),
- [&](SelectionTree T) {
- ++Seen;
- return true;
- });
- EXPECT_EQ(1u, Seen) << "Return true --> stop iterating";
-
- Seen = 0;
- SelectionTree::createEach(AST.getASTContext(), AST.getTokens(),
- Test.point("unique"), Test.point("unique"),
- [&](SelectionTree T) {
- ++Seen;
- return false;
- });
- EXPECT_EQ(1u, Seen) << "no ambiguity --> only one tree";
-
- Seen = 0;
- SelectionTree::createEach(AST.getASTContext(), AST.getTokens(),
- Test.point("empty"), Test.point("empty"),
- [&](SelectionTree T) {
- EXPECT_FALSE(T.commonAncestor());
- ++Seen;
- return false;
- });
- EXPECT_EQ(1u, Seen) << "empty tree still created";
-
- Seen = 0;
- SelectionTree::createEach(AST.getASTContext(), AST.getTokens(),
- Test.point("unique"), Test.point("ambiguous"),
- [&](SelectionTree T) {
- ++Seen;
- return false;
- });
- EXPECT_EQ(1u, Seen) << "one tree for nontrivial selection";
-}
-
} // namespace
} // namespace clangd
} // namespace clang
cantFail(positionToOffset(A.code(), SelectionRng.end))};
}
-// Prepare and apply the specified tweak based on the selection in Input.
-// Returns None if and only if prepare() failed.
-llvm::Optional<llvm::Expected<Tweak::Effect>>
-applyTweak(ParsedAST &AST, const Annotations &Input, StringRef TweakID,
- const SymbolIndex *Index) {
- auto Range = rangeOrPoint(Input);
- llvm::Optional<llvm::Expected<Tweak::Effect>> Result;
- SelectionTree::createEach(AST.getASTContext(), AST.getTokens(), Range.first,
- Range.second, [&](SelectionTree ST) {
- Tweak::Selection S(Index, AST, Range.first,
- Range.second, std::move(ST));
- if (auto T = prepareTweak(TweakID, S)) {
- Result = (*T)->apply(S);
- return true;
- } else {
- llvm::consumeError(T.takeError());
- return false;
- }
- });
- return Result;
-}
-
MATCHER_P7(TweakIsAvailable, TweakID, Ctx, Header, ExtraArgs, ExtraFiles, Index,
FileName,
(TweakID + (negation ? " is unavailable" : " is available")).str()) {
std::string WrappedCode = wrap(Ctx, arg);
Annotations Input(WrappedCode);
+ auto Selection = rangeOrPoint(Input);
TestTU TU;
TU.Filename = FileName;
TU.HeaderCode = Header;
TU.ExtraArgs = ExtraArgs;
TU.AdditionalFiles = std::move(ExtraFiles);
ParsedAST AST = TU.build();
- auto Result = applyTweak(AST, Input, TweakID, Index);
- // We only care if prepare() succeeded, but must handle Errors.
- if (Result && !*Result)
- consumeError(Result->takeError());
- return Result.hasValue();
+ 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
llvm::StringMap<std::string> *EditedFiles) const {
std::string WrappedCode = wrap(Context, MarkedCode);
Annotations Input(WrappedCode);
+ auto Selection = rangeOrPoint(Input);
+
TestTU TU;
TU.Filename = FileName;
TU.HeaderCode = Header;
TU.Code = Input.code();
TU.ExtraArgs = ExtraArgs;
ParsedAST AST = TU.build();
+ Tweak::Selection S(Index.get(), AST, Selection.first, Selection.second);
- auto Result = applyTweak(AST, Input, TweakID, Index.get());
- if (!Result)
+ auto T = prepareTweak(TweakID, S);
+ if (!T) {
+ llvm::consumeError(T.takeError());
return "unavailable";
- if (!*Result)
- return "fail: " + llvm::toString(Result->takeError());
- const auto &Effect = **Result;
- if ((*Result)->ShowMessage)
- return "message:\n" + *Effect.ShowMessage;
- if (Effect.ApplyEdits.empty())
+ }
+ 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 : Effect.ApplyEdits) {
+ for (auto &It : Result->ApplyEdits) {
auto NewText = It.second.apply();
if (!NewText)
return "bad edits: " + llvm::toString(NewText.takeError());
// Basic check for function body and signature.
EXPECT_AVAILABLE(R"cpp(
class Bar {
- [[void [[f^o^o^]]() [[{ return; }]]]]
+ [[void [[f^o^o]]() [[{ return; }]]]]
};
void foo();