diff --git a/clang-tools-extra/clangd/CMakeLists.txt b/clang-tools-extra/clangd/CMakeLists.txt --- a/clang-tools-extra/clangd/CMakeLists.txt +++ b/clang-tools-extra/clangd/CMakeLists.txt @@ -62,6 +62,7 @@ Quality.cpp RIFF.cpp Selection.cpp + SemanticHighlight.cpp SourceCode.cpp Threading.cpp Trace.cpp diff --git a/clang-tools-extra/clangd/ClangdUnit.cpp b/clang-tools-extra/clangd/ClangdUnit.cpp --- a/clang-tools-extra/clangd/ClangdUnit.cpp +++ b/clang-tools-extra/clangd/ClangdUnit.cpp @@ -66,6 +66,7 @@ : TopLevelDecls(TopLevelDecls) {} bool HandleTopLevelDecl(DeclGroupRef DG) override { + //FIXME: There is an edge case where this will still get decls from include files. for (Decl *D : DG) { if (D->isFromASTFile()) continue; diff --git a/clang-tools-extra/clangd/SemanticHighlight.h b/clang-tools-extra/clangd/SemanticHighlight.h new file mode 100644 --- /dev/null +++ b/clang-tools-extra/clangd/SemanticHighlight.h @@ -0,0 +1,37 @@ +//==-- SemanticHighlight.h - Generating highlights from the AST--*- 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 +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_SEMANTICHIGHLIGHT_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_SEMANTICHIGHLIGHT_H + +#include "ClangdUnit.h" +#include "clang/AST/RecursiveASTVisitor.h" + +namespace clang { +namespace clangd { + +enum class SemanticHighlightKind { + Variable, + Function, +}; + +// Contains all information needed for the highlighting a token. +struct SemanticToken { + SemanticHighlightKind Kind; + Range R; +}; + +bool operator==(const SemanticToken &Lhs, const SemanticToken &Rhs); +bool operator!=(const SemanticToken &Lhs, const SemanticToken &Rhs); + +std::vector getSemanticHighlights(ParsedAST &AST); + +} // namespace clangd +} // namespace clang + +#endif diff --git a/clang-tools-extra/clangd/SemanticHighlight.cpp b/clang-tools-extra/clangd/SemanticHighlight.cpp new file mode 100644 --- /dev/null +++ b/clang-tools-extra/clangd/SemanticHighlight.cpp @@ -0,0 +1,85 @@ +//===--- SemanticHighlight.cpp - -------------------------- -----*- 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 "SemanticHighlight.h" +#include "Logger.h" +#include "SourceCode.h" +#include "clang/AST/ASTContext.h" + +namespace clang { +namespace clangd { +namespace { + +// Collects all semantic tokens in an ASTContext. +class SemanticTokenCollector + : public RecursiveASTVisitor { + std::vector Tokens; + ASTContext &Ctx; + const SourceManager &SM; + +public: + SemanticTokenCollector(ParsedAST &AST) + : Ctx(AST.getASTContext()), SM(AST.getSourceManager()) {} + + std::vector collectTokens() { + Tokens.clear(); + TraverseAST(Ctx); + return Tokens; + } + + bool VisitVarDecl(VarDecl *Var) { + addToken(Var, SemanticHighlightKind::Variable); + return true; + } + bool VisitFunctionDecl(FunctionDecl *Func) { + addToken(Func, SemanticHighlightKind::Function); + return true; + } + +private: + void addToken(const NamedDecl *D, SemanticHighlightKind Kind) { + if (D->getLocation().isMacroID()) { + // FIXME: skip tokens inside macros for now. + return; + } + + if (D->getDeclName().isEmpty()) { + // Don't add symbols that don't have any length. + return; + } + + auto R = getTokenRange(SM, Ctx.getLangOpts(), D->getLocation()); + if (!R.hasValue()) { + // R should always have a value, if it doesn't something is very wrong. + elog("Tried to add semantic token with an invalid range"); + return; + } + + SemanticToken S; + S.R = R.getValue(); + S.Kind = Kind; + Tokens.push_back(S); + } +}; + +} // namespace + +bool operator==(const SemanticToken &Lhs, const SemanticToken &Rhs) { + return Lhs.Kind == Rhs.Kind && Lhs.R == Rhs.R; +} +bool operator!=(const SemanticToken &Lhs, const SemanticToken &Rhs) { + return !(Lhs == Rhs); +} + +std::vector getSemanticHighlights(ParsedAST &AST) { + AST.getASTContext().setTraversalScope(AST.getLocalTopLevelDecls()); + return SemanticTokenCollector(AST).collectTokens(); +} + +} // namespace clangd +} // namespace clang diff --git a/clang-tools-extra/clangd/unittests/CMakeLists.txt b/clang-tools-extra/clangd/unittests/CMakeLists.txt --- a/clang-tools-extra/clangd/unittests/CMakeLists.txt +++ b/clang-tools-extra/clangd/unittests/CMakeLists.txt @@ -53,6 +53,7 @@ RenameTests.cpp RIFFTests.cpp SelectionTests.cpp + SemanticHighlightTests.cpp SerializationTests.cpp SourceCodeTests.cpp SymbolCollectorTests.cpp diff --git a/clang-tools-extra/clangd/unittests/SemanticHighlightTests.cpp b/clang-tools-extra/clangd/unittests/SemanticHighlightTests.cpp new file mode 100644 --- /dev/null +++ b/clang-tools-extra/clangd/unittests/SemanticHighlightTests.cpp @@ -0,0 +1,68 @@ +//===- SemanticHighlightTest.cpp - SemanticHighlightTest tests-*- 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 "Annotations.h" +#include "SemanticHighlight.h" +#include "TestTU.h" +#include "gmock/gmock.h" + +namespace clang { +namespace clangd { +namespace { + +std::vector makeSemanticTokens(const std::vector &Ranges, + SemanticHighlightKind Kind) { + std::vector Tokens(Ranges.size()); + for (int I = 0, End = Ranges.size(); I < End; ++I) { + Tokens[I].R = Ranges[I]; + Tokens[I].Kind = Kind; + } + + return Tokens; +} + +void checkHighlights(llvm::StringRef Code) { + Annotations Test(Code); + auto AST = TestTU::withCode(Test.code()).build(); + static const std::map KindToString{ + {SemanticHighlightKind::Variable, "Variable"}, + {SemanticHighlightKind::Function, "Function"}}; + std::vector ExpectedTokens; + for (const auto &KindString : KindToString) { + std::vector Toks = + makeSemanticTokens(Test.ranges(KindString.second), KindString.first); + ExpectedTokens.insert(ExpectedTokens.end(), Toks.begin(), Toks.end()); + } + + auto ActualTokens = getSemanticHighlights(AST); + EXPECT_THAT(ActualTokens, testing::UnorderedElementsAreArray(ExpectedTokens)); +} + +TEST(SemanticTokenCollector, GetsCorrectTokens) { + const char *TestCases[] = { + R"cpp( + struct A { + double SomeMember; + }; + struct {} $Variable[[HStruct]]; + void $Function[[foo]](int $Variable[[a]]) { + auto $Variable[[VeryLongVariableName]] = 12312; + A $Variable[[aa]]; + } + )cpp", + R"cpp( + void $Function[[foo]](int); + )cpp"}; + for (const auto &TestCase : TestCases) { + checkHighlights(TestCase); + } +} + +} // namespace +} // namespace clangd +} // namespace clang