Skip to content

Commit

Permalink
[clangd] Document highlights for clangd
Browse files Browse the repository at this point in the history 
Summary: Implementation of Document Highlights Request as described in
LSP.

Contributed by William Enright (nebiroth).

Reviewers: malaperle, krasimir, bkramer, ilya-biryukov

Reviewed By: malaperle

Subscribers: mgrang, sammccall, klimek, ioeric, rwols, cfe-commits, arphaman, ilya-biryukov

Differential Revision: https://reviews.llvm.org/D38425

llvm-svn: 320474
  • Loading branch information
@ilya-biryukov
ilya-biryukov committed Dec 12, 2017
1 parent b0783cc commit 0e6a51f
Show file tree
Hide file tree
Showing 13 changed files with 315 additions and 46 deletions.
17 changes: 17 additions & 0 deletions clang-tools-extra/clangd/ClangdLSPServer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ void ClangdLSPServer::onInitialize(Ctx C, InitializeParams &Params) {
{"triggerCharacters", {"(", ","}},
}},
{"definitionProvider", true},
{"documentHighlightProvider", true},
{"renameProvider", true},
{"executeCommandProvider",
json::obj{
Expand Down Expand Up @@ -235,6 +236,22 @@ void ClangdLSPServer::onSwitchSourceHeader(Ctx C,
C.reply(Result ? URI::fromFile(*Result).uri : "");
}

void ClangdLSPServer::onDocumentHighlight(Ctx C,
TextDocumentPositionParams &Params) {

auto Highlights = Server.findDocumentHighlights(
Params.textDocument.uri.file,
Position{Params.position.line, Params.position.character});

if (!Highlights) {
C.replyError(ErrorCode::InternalError,
llvm::toString(Highlights.takeError()));
return;
}

C.reply(json::ary(Highlights->Value));
}

ClangdLSPServer::ClangdLSPServer(JSONOutput &Out, unsigned AsyncThreadsCount,
bool StorePreamblesInMemory,
const clangd::CodeCompleteOptions &CCOpts,
Expand Down
1 change: 1 addition & 0 deletions clang-tools-extra/clangd/ClangdLSPServer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ class ClangdLSPServer : private DiagnosticsConsumer, private ProtocolCallbacks {
void onSignatureHelp(Ctx C, TextDocumentPositionParams &Params) override;
void onGoToDefinition(Ctx C, TextDocumentPositionParams &Params) override;
void onSwitchSourceHeader(Ctx C, TextDocumentIdentifier &Params) override;
void onDocumentHighlight(Ctx C, TextDocumentPositionParams &Params) override;
void onFileEvent(Ctx C, DidChangeWatchedFilesParams &Params) override;
void onCommand(Ctx C, ExecuteCommandParams &Params) override;
void onRename(Ctx C, RenameParams &Parames) override;
Expand Down
33 changes: 33 additions & 0 deletions clang-tools-extra/clangd/ClangdServer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,39 @@ llvm::Optional<Path> ClangdServer::switchSourceHeader(PathRef Path) {
return llvm::None;
}

llvm::Expected<Tagged<std::vector<DocumentHighlight>>>
ClangdServer::findDocumentHighlights(PathRef File, Position Pos) {
auto FileContents = DraftMgr.getDraft(File);
if (!FileContents.Draft)
return llvm::make_error<llvm::StringError>(
"findDocumentHighlights called on non-added file",
llvm::errc::invalid_argument);

auto TaggedFS = FSProvider.getTaggedFileSystem(File);

std::shared_ptr<CppFile> Resources = Units.getFile(File);
if (!Resources)
return llvm::make_error<llvm::StringError>(
"findDocumentHighlights called on non-added file",
llvm::errc::invalid_argument);

std::vector<DocumentHighlight> Result;
llvm::Optional<llvm::Error> Err;
Resources->getAST().get()->runUnderLock([Pos, &Result, &Err,
this](ParsedAST *AST) {
if (!AST) {
Err = llvm::make_error<llvm::StringError>("Invalid AST",
llvm::errc::invalid_argument);
return;
}
Result = clangd::findDocumentHighlights(*AST, Pos, Logger);
});

if (Err)
return std::move(*Err);
return make_tagged(Result, TaggedFS.Tag);
}

std::future<void> ClangdServer::scheduleReparseAndDiags(
PathRef File, VersionedDraft Contents, std::shared_ptr<CppFile> Resources,
Tagged<IntrusiveRefCntPtr<vfs::FileSystem>> TaggedFS) {
Expand Down
7 changes: 5 additions & 2 deletions clang-tools-extra/clangd/ClangdServer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,7 @@ class ClangdServer {
ClangdServer(GlobalCompilationDatabase &CDB,
DiagnosticsConsumer &DiagConsumer,
FileSystemProvider &FSProvider, unsigned AsyncThreadsCount,
bool StorePreamblesInMemory,
clangd::Logger &Logger,
bool StorePreamblesInMemory, clangd::Logger &Logger,
llvm::Optional<StringRef> ResourceDir = llvm::None);

/// Set the root path of the workspace.
Expand Down Expand Up @@ -286,6 +285,10 @@ class ClangdServer {
/// given a header file and vice versa.
llvm::Optional<Path> switchSourceHeader(PathRef Path);

/// Get document highlights for a given position.
llvm::Expected<Tagged<std::vector<DocumentHighlight>>>
findDocumentHighlights(PathRef File, Position Pos);

/// Run formatting for \p Rng inside \p File.
std::vector<tooling::Replacement> formatRange(PathRef File, Range Rng);
/// Run formatting for the whole \p File.
Expand Down
214 changes: 171 additions & 43 deletions clang-tools-extra/clangd/ClangdUnit.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,36 +222,43 @@ SourceLocation getMacroArgExpandedLocation(const SourceManager &Mgr,
}

/// Finds declarations locations that a given source location refers to.
class DeclarationLocationsFinder : public index::IndexDataConsumer {
std::vector<Location> DeclarationLocations;
class DeclarationAndMacrosFinder : public index::IndexDataConsumer {
std::vector<const Decl *> Decls;
std::vector<const MacroInfo *> MacroInfos;
const SourceLocation &SearchedLocation;
const ASTContext &AST;
Preprocessor &PP;

public:
DeclarationLocationsFinder(raw_ostream &OS,
DeclarationAndMacrosFinder(raw_ostream &OS,
const SourceLocation &SearchedLocation,
ASTContext &AST, Preprocessor &PP)
: SearchedLocation(SearchedLocation), AST(AST), PP(PP) {}

std::vector<Location> takeLocations() {
// Don't keep the same location multiple times.
std::vector<const Decl *> takeDecls() {
// Don't keep the same declaration multiple times.
// This can happen when nodes in the AST are visited twice.
std::sort(DeclarationLocations.begin(), DeclarationLocations.end());
auto last =
std::unique(DeclarationLocations.begin(), DeclarationLocations.end());
DeclarationLocations.erase(last, DeclarationLocations.end());
return std::move(DeclarationLocations);
std::sort(Decls.begin(), Decls.end());
auto Last = std::unique(Decls.begin(), Decls.end());
Decls.erase(Last, Decls.end());
return std::move(Decls);
}

std::vector<const MacroInfo *> takeMacroInfos() {
// Don't keep the same Macro info multiple times.
std::sort(MacroInfos.begin(), MacroInfos.end());
auto Last = std::unique(MacroInfos.begin(), MacroInfos.end());
MacroInfos.erase(Last, MacroInfos.end());
return std::move(MacroInfos);
}

bool
handleDeclOccurence(const Decl *D, index::SymbolRoleSet Roles,
ArrayRef<index::SymbolRelation> Relations, FileID FID,
unsigned Offset,
index::IndexDataConsumer::ASTNodeInfo ASTNode) override {
if (isSearchedLocation(FID, Offset)) {
addDeclarationLocation(D->getSourceRange());
}
if (isSearchedLocation(FID, Offset))
Decls.push_back(D);
return true;
}

Expand All @@ -262,31 +269,6 @@ class DeclarationLocationsFinder : public index::IndexDataConsumer {
SourceMgr.getFileID(SearchedLocation) == FID;
}

void addDeclarationLocation(const SourceRange &ValSourceRange) {
const SourceManager &SourceMgr = AST.getSourceManager();
const LangOptions &LangOpts = AST.getLangOpts();
SourceLocation LocStart = ValSourceRange.getBegin();
SourceLocation LocEnd = Lexer::getLocForEndOfToken(ValSourceRange.getEnd(),
0, SourceMgr, LangOpts);
Position Begin;
Begin.line = SourceMgr.getSpellingLineNumber(LocStart) - 1;
Begin.character = SourceMgr.getSpellingColumnNumber(LocStart) - 1;
Position End;
End.line = SourceMgr.getSpellingLineNumber(LocEnd) - 1;
End.character = SourceMgr.getSpellingColumnNumber(LocEnd) - 1;
Range R = {Begin, End};
Location L;
if (const FileEntry *F =
SourceMgr.getFileEntryForID(SourceMgr.getFileID(LocStart))) {
StringRef FilePath = F->tryGetRealPathName();
if (FilePath.empty())
FilePath = F->getName();
L.uri = URI::fromFile(FilePath);
L.range = R;
DeclarationLocations.push_back(L);
}
}

void finish() override {
// Also handle possible macro at the searched location.
Token Result;
Expand All @@ -309,16 +291,111 @@ class DeclarationLocationsFinder : public index::IndexDataConsumer {
PP.getMacroDefinitionAtLoc(IdentifierInfo, BeforeSearchedLocation);
MacroInfo *MacroInf = MacroDef.getMacroInfo();
if (MacroInf) {
addDeclarationLocation(SourceRange(MacroInf->getDefinitionLoc(),
MacroInf->getDefinitionEndLoc()));
MacroInfos.push_back(MacroInf);
}
}
}
}
};

/// Finds document highlights that a given list of declarations refers to.
class DocumentHighlightsFinder : public index::IndexDataConsumer {
std::vector<const Decl *> &Decls;
std::vector<DocumentHighlight> DocumentHighlights;
const ASTContext &AST;

public:
DocumentHighlightsFinder(raw_ostream &OS, ASTContext &AST, Preprocessor &PP,
std::vector<const Decl *> &Decls)
: Decls(Decls), AST(AST) {}
std::vector<DocumentHighlight> takeHighlights() {
// Don't keep the same highlight multiple times.
// This can happen when nodes in the AST are visited twice.
std::sort(DocumentHighlights.begin(), DocumentHighlights.end());
auto Last =
std::unique(DocumentHighlights.begin(), DocumentHighlights.end());
DocumentHighlights.erase(Last, DocumentHighlights.end());
return std::move(DocumentHighlights);
}

bool
handleDeclOccurence(const Decl *D, index::SymbolRoleSet Roles,
ArrayRef<index::SymbolRelation> Relations, FileID FID,
unsigned Offset,
index::IndexDataConsumer::ASTNodeInfo ASTNode) override {
const SourceManager &SourceMgr = AST.getSourceManager();
if (SourceMgr.getMainFileID() != FID ||
std::find(Decls.begin(), Decls.end(), D) == Decls.end()) {
return true;
}
SourceLocation Begin, End;
const LangOptions &LangOpts = AST.getLangOpts();
SourceLocation StartOfFileLoc = SourceMgr.getLocForStartOfFile(FID);
SourceLocation HightlightStartLoc = StartOfFileLoc.getLocWithOffset(Offset);
End =
Lexer::getLocForEndOfToken(HightlightStartLoc, 0, SourceMgr, LangOpts);
SourceRange SR(HightlightStartLoc, End);

DocumentHighlightKind Kind = DocumentHighlightKind::Text;
if (static_cast<index::SymbolRoleSet>(index::SymbolRole::Write) & Roles)
Kind = DocumentHighlightKind::Write;
else if (static_cast<index::SymbolRoleSet>(index::SymbolRole::Read) & Roles)
Kind = DocumentHighlightKind::Read;

DocumentHighlights.push_back(getDocumentHighlight(SR, Kind));
return true;
}

private:
DocumentHighlight getDocumentHighlight(SourceRange SR,
DocumentHighlightKind Kind) {
const SourceManager &SourceMgr = AST.getSourceManager();
SourceLocation LocStart = SR.getBegin();
Position Begin;
Begin.line = SourceMgr.getSpellingLineNumber(LocStart) - 1;
Begin.character = SourceMgr.getSpellingColumnNumber(LocStart) - 1;
Position End;
End.line = SourceMgr.getSpellingLineNumber(SR.getEnd()) - 1;
End.character = SourceMgr.getSpellingColumnNumber(SR.getEnd()) - 1;
Range R = {Begin, End};
DocumentHighlight DH;
DH.range = R;
DH.kind = Kind;
return DH;
}
};

} // namespace

llvm::Optional<Location>
getDeclarationLocation(ParsedAST &AST, const SourceRange &ValSourceRange) {
const SourceManager &SourceMgr = AST.getASTContext().getSourceManager();
const LangOptions &LangOpts = AST.getASTContext().getLangOpts();
SourceLocation LocStart = ValSourceRange.getBegin();

const FileEntry *F =
SourceMgr.getFileEntryForID(SourceMgr.getFileID(LocStart));
if (!F)
return llvm::None;
SourceLocation LocEnd = Lexer::getLocForEndOfToken(ValSourceRange.getEnd(), 0,
SourceMgr, LangOpts);
Position Begin;
Begin.line = SourceMgr.getSpellingLineNumber(LocStart) - 1;
Begin.character = SourceMgr.getSpellingColumnNumber(LocStart) - 1;
Position End;
End.line = SourceMgr.getSpellingLineNumber(LocEnd) - 1;
End.character = SourceMgr.getSpellingColumnNumber(LocEnd) - 1;
Range R = {Begin, End};
Location L;

StringRef FilePath = F->tryGetRealPathName();
if (FilePath.empty())
FilePath = F->getName();
L.uri = URI::fromFile(FilePath);
L.range = R;
return L;
}

std::vector<Location> clangd::findDefinitions(ParsedAST &AST, Position Pos,
clangd::Logger &Logger) {
const SourceManager &SourceMgr = AST.getASTContext().getSourceManager();
Expand All @@ -328,18 +405,69 @@ std::vector<Location> clangd::findDefinitions(ParsedAST &AST, Position Pos,

SourceLocation SourceLocationBeg = getBeginningOfIdentifier(AST, Pos, FE);

auto DeclLocationsFinder = std::make_shared<DeclarationLocationsFinder>(
auto DeclMacrosFinder = std::make_shared<DeclarationAndMacrosFinder>(
llvm::errs(), SourceLocationBeg, AST.getASTContext(),
AST.getPreprocessor());
index::IndexingOptions IndexOpts;
IndexOpts.SystemSymbolFilter =
index::IndexingOptions::SystemSymbolFilterKind::All;
IndexOpts.IndexFunctionLocals = true;

indexTopLevelDecls(AST.getASTContext(), AST.getTopLevelDecls(),
DeclMacrosFinder, IndexOpts);

std::vector<const Decl *> Decls = DeclMacrosFinder->takeDecls();
std::vector<const MacroInfo *> MacroInfos =
DeclMacrosFinder->takeMacroInfos();
std::vector<Location> Result;

for (auto Item : Decls) {
auto L = getDeclarationLocation(AST, Item->getSourceRange());
if (L)
Result.push_back(*L);
}

for (auto Item : MacroInfos) {
SourceRange SR(Item->getDefinitionLoc(), Item->getDefinitionEndLoc());
auto L = getDeclarationLocation(AST, SR);
if (L)
Result.push_back(*L);
}

return Result;
}

std::vector<DocumentHighlight>
clangd::findDocumentHighlights(ParsedAST &AST, Position Pos,
clangd::Logger &Logger) {
const SourceManager &SourceMgr = AST.getASTContext().getSourceManager();
const FileEntry *FE = SourceMgr.getFileEntryForID(SourceMgr.getMainFileID());
if (!FE)
return {};

SourceLocation SourceLocationBeg = getBeginningOfIdentifier(AST, Pos, FE);

auto DeclMacrosFinder = std::make_shared<DeclarationAndMacrosFinder>(
llvm::errs(), SourceLocationBeg, AST.getASTContext(),
AST.getPreprocessor());
index::IndexingOptions IndexOpts;
IndexOpts.SystemSymbolFilter =
index::IndexingOptions::SystemSymbolFilterKind::All;
IndexOpts.IndexFunctionLocals = true;

// Macro occurences are not currently handled.
indexTopLevelDecls(AST.getASTContext(), AST.getTopLevelDecls(),
DeclMacrosFinder, IndexOpts);

std::vector<const Decl *> SelectedDecls = DeclMacrosFinder->takeDecls();

auto DocHighlightsFinder = std::make_shared<DocumentHighlightsFinder>(
llvm::errs(), AST.getASTContext(), AST.getPreprocessor(), SelectedDecls);

indexTopLevelDecls(AST.getASTContext(), AST.getTopLevelDecls(),
DeclLocationsFinder, IndexOpts);
DocHighlightsFinder, IndexOpts);

return DeclLocationsFinder->takeLocations();
return DocHighlightsFinder->takeHighlights();
}

void ParsedAST::ensurePreambleDeclsDeserialized() {
Expand Down
4 changes: 3 additions & 1 deletion clang-tools-extra/clangd/ClangdUnit.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,6 @@ class CppFile : public std::enable_shared_from_this<CppFile> {
clangd::Logger &Logger;
};


/// Get the beginning SourceLocation at a specified \p Pos.
SourceLocation getBeginningOfIdentifier(ParsedAST &Unit, const Position &Pos,
const FileEntry *FE);
Expand All @@ -265,6 +264,9 @@ SourceLocation getBeginningOfIdentifier(ParsedAST &Unit, const Position &Pos,
std::vector<Location> findDefinitions(ParsedAST &AST, Position Pos,
clangd::Logger &Logger);

std::vector<DocumentHighlight>
findDocumentHighlights(ParsedAST &AST, Position Pos, clangd::Logger &Logger);

/// For testing/debugging purposes. Note that this method deserializes all
/// unserialized Decls, so use with care.
void dumpAST(ParsedAST &AST, llvm::raw_ostream &OS);
Expand Down
Loading

0 comments on commit 0e6a51f

Please sign in to comment.