llvm-project/clang-tools-extra/clangd/unittests/SemanticHighlightingTests.cpp

614 lines
20 KiB
C++

//==- SemanticHighlightingTests.cpp - SemanticHighlighting 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 "ClangdServer.h"
#include "Protocol.h"
#include "SemanticHighlighting.h"
#include "TestFS.h"
#include "TestTU.h"
#include "gmock/gmock.h"
namespace clang {
namespace clangd {
namespace {
std::vector<HighlightingToken>
makeHighlightingTokens(llvm::ArrayRef<Range> Ranges, HighlightingKind Kind) {
std::vector<HighlightingToken> Tokens(Ranges.size());
for (int I = 0, End = Ranges.size(); I < End; ++I) {
Tokens[I].R = Ranges[I];
Tokens[I].Kind = Kind;
}
return Tokens;
}
std::vector<HighlightingToken> getExpectedTokens(Annotations &Test) {
static const std::map<HighlightingKind, std::string> KindToString{
{HighlightingKind::Variable, "Variable"},
{HighlightingKind::Parameter, "Parameter"},
{HighlightingKind::Function, "Function"},
{HighlightingKind::Class, "Class"},
{HighlightingKind::Enum, "Enum"},
{HighlightingKind::Namespace, "Namespace"},
{HighlightingKind::EnumConstant, "EnumConstant"},
{HighlightingKind::Field, "Field"},
{HighlightingKind::Method, "Method"},
{HighlightingKind::TemplateParameter, "TemplateParameter"},
{HighlightingKind::Primitive, "Primitive"}};
std::vector<HighlightingToken> ExpectedTokens;
for (const auto &KindString : KindToString) {
std::vector<HighlightingToken> Toks = makeHighlightingTokens(
Test.ranges(KindString.second), KindString.first);
ExpectedTokens.insert(ExpectedTokens.end(), Toks.begin(), Toks.end());
}
llvm::sort(ExpectedTokens);
return ExpectedTokens;
}
void checkHighlightings(llvm::StringRef Code,
std::vector<std::pair</*FileName*/ llvm::StringRef,
/*FileContent*/ llvm::StringRef>>
AdditionalFiles = {}) {
Annotations Test(Code);
auto TU = TestTU::withCode(Test.code());
for (auto File : AdditionalFiles)
TU.AdditionalFiles.insert({File.first, File.second});
auto AST = TU.build();
std::vector<HighlightingToken> ActualTokens = getSemanticHighlightings(AST);
EXPECT_THAT(ActualTokens, getExpectedTokens(Test)) << Code;
}
// Any annotations in OldCode and NewCode are converted into their corresponding
// HighlightingToken. The tokens are diffed against each other. Any lines where
// the tokens should diff must be marked with a ^ somewhere on that line in
// NewCode. If there are diffs that aren't marked with ^ the test fails. The
// test also fails if there are lines marked with ^ that don't differ.
void checkDiffedHighlights(llvm::StringRef OldCode, llvm::StringRef NewCode) {
Annotations OldTest(OldCode);
Annotations NewTest(NewCode);
std::vector<HighlightingToken> OldTokens = getExpectedTokens(OldTest);
std::vector<HighlightingToken> NewTokens = getExpectedTokens(NewTest);
llvm::DenseMap<int, std::vector<HighlightingToken>> ExpectedLines;
for (const Position &Point : NewTest.points()) {
ExpectedLines[Point.line]; // Default initialize to an empty line. Tokens
// are inserted on these lines later.
}
std::vector<LineHighlightings> ExpectedLinePairHighlighting;
for (const HighlightingToken &Token : NewTokens) {
auto It = ExpectedLines.find(Token.R.start.line);
if (It != ExpectedLines.end())
It->second.push_back(Token);
}
for (auto &LineTokens : ExpectedLines)
ExpectedLinePairHighlighting.push_back(
{LineTokens.first, LineTokens.second});
std::vector<LineHighlightings> ActualDiffed =
diffHighlightings(NewTokens, OldTokens, NewCode.count('\n'));
EXPECT_THAT(ActualDiffed,
testing::UnorderedElementsAreArray(ExpectedLinePairHighlighting));
}
TEST(SemanticHighlighting, GetsCorrectTokens) {
const char *TestCases[] = {
R"cpp(
struct $Class[[AS]] {
$Primitive[[double]] $Field[[SomeMember]];
};
struct {
} $Variable[[S]];
$Primitive[[void]] $Function[[foo]]($Primitive[[int]] $Parameter[[A]], $Class[[AS]] $Parameter[[As]]) {
$Primitive[[auto]] $Variable[[VeryLongVariableName]] = 12312;
$Class[[AS]] $Variable[[AA]];
$Primitive[[auto]] $Variable[[L]] = $Variable[[AA]].$Field[[SomeMember]] + $Parameter[[A]];
auto $Variable[[FN]] = [ $Variable[[AA]]]($Primitive[[int]] $Parameter[[A]]) -> $Primitive[[void]] {};
$Variable[[FN]](12312);
}
)cpp",
R"cpp(
$Primitive[[void]] $Function[[foo]]($Primitive[[int]]);
$Primitive[[void]] $Function[[Gah]]();
$Primitive[[void]] $Function[[foo]]() {
auto $Variable[[Bou]] = $Function[[Gah]];
}
struct $Class[[A]] {
$Primitive[[void]] $Method[[abc]]();
};
)cpp",
R"cpp(
namespace $Namespace[[abc]] {
template<typename $TemplateParameter[[T]]>
struct $Class[[A]] {
$TemplateParameter[[T]] $Field[[t]];
};
}
template<typename $TemplateParameter[[T]]>
struct $Class[[C]] : $Namespace[[abc]]::$Class[[A]]<$TemplateParameter[[T]]> {
typename $TemplateParameter[[T]]::A* $Field[[D]];
};
$Namespace[[abc]]::$Class[[A]]<$Primitive[[int]]> $Variable[[AA]];
typedef $Namespace[[abc]]::$Class[[A]]<$Primitive[[int]]> $Class[[AAA]];
struct $Class[[B]] {
$Class[[B]]();
~$Class[[B]]();
$Primitive[[void]] operator<<($Class[[B]]);
$Class[[AAA]] $Field[[AA]];
};
$Class[[B]]::$Class[[B]]() {}
$Class[[B]]::~$Class[[B]]() {}
$Primitive[[void]] $Function[[f]] () {
$Class[[B]] $Variable[[BB]] = $Class[[B]]();
$Variable[[BB]].~$Class[[B]]();
$Class[[B]]();
}
)cpp",
R"cpp(
enum class $Enum[[E]] {
$EnumConstant[[A]],
$EnumConstant[[B]],
};
enum $Enum[[EE]] {
$EnumConstant[[Hi]],
};
struct $Class[[A]] {
$Enum[[E]] $Field[[EEE]];
$Enum[[EE]] $Field[[EEEE]];
};
$Primitive[[int]] $Variable[[I]] = $EnumConstant[[Hi]];
$Enum[[E]] $Variable[[L]] = $Enum[[E]]::$EnumConstant[[B]];
)cpp",
R"cpp(
namespace $Namespace[[abc]] {
namespace {}
namespace $Namespace[[bcd]] {
struct $Class[[A]] {};
namespace $Namespace[[cde]] {
struct $Class[[A]] {
enum class $Enum[[B]] {
$EnumConstant[[Hi]],
};
};
}
}
}
using namespace $Namespace[[abc]]::$Namespace[[bcd]];
namespace $Namespace[[vwz]] =
$Namespace[[abc]]::$Namespace[[bcd]]::$Namespace[[cde]];
$Namespace[[abc]]::$Namespace[[bcd]]::$Class[[A]] $Variable[[AA]];
$Namespace[[vwz]]::$Class[[A]]::$Enum[[B]] $Variable[[AAA]] =
$Namespace[[vwz]]::$Class[[A]]::$Enum[[B]]::$EnumConstant[[Hi]];
::$Namespace[[vwz]]::$Class[[A]] $Variable[[B]];
::$Namespace[[abc]]::$Namespace[[bcd]]::$Class[[A]] $Variable[[BB]];
)cpp",
R"cpp(
struct $Class[[D]] {
$Primitive[[double]] $Field[[C]];
};
struct $Class[[A]] {
$Primitive[[double]] $Field[[B]];
$Class[[D]] $Field[[E]];
static $Primitive[[double]] $Variable[[S]];
$Primitive[[void]] $Method[[foo]]() {
$Field[[B]] = 123;
this->$Field[[B]] = 156;
this->$Method[[foo]]();
$Method[[foo]]();
$Variable[[S]] = 90.1;
}
};
$Primitive[[void]] $Function[[foo]]() {
$Class[[A]] $Variable[[AA]];
$Variable[[AA]].$Field[[B]] += 2;
$Variable[[AA]].$Method[[foo]]();
$Variable[[AA]].$Field[[E]].$Field[[C]];
$Class[[A]]::$Variable[[S]] = 90;
}
)cpp",
R"cpp(
struct $Class[[AA]] {
$Primitive[[int]] $Field[[A]];
}
$Primitive[[int]] $Variable[[B]];
$Class[[AA]] $Variable[[A]]{$Variable[[B]]};
)cpp",
R"cpp(
namespace $Namespace[[a]] {
struct $Class[[A]] {};
typedef $Primitive[[char]] $Primitive[[C]];
}
typedef $Namespace[[a]]::$Class[[A]] $Class[[B]];
using $Class[[BB]] = $Namespace[[a]]::$Class[[A]];
enum class $Enum[[E]] {};
typedef $Enum[[E]] $Enum[[C]];
typedef $Enum[[C]] $Enum[[CC]];
using $Enum[[CD]] = $Enum[[CC]];
$Enum[[CC]] $Function[[f]]($Class[[B]]);
$Enum[[CD]] $Function[[f]]($Class[[BB]]);
typedef $Namespace[[a]]::$Primitive[[C]] $Primitive[[PC]];
typedef $Primitive[[float]] $Primitive[[F]];
)cpp",
R"cpp(
template<typename $TemplateParameter[[T]], typename = $Primitive[[void]]>
class $Class[[A]] {
$TemplateParameter[[T]] $Field[[AA]];
$TemplateParameter[[T]] $Method[[foo]]();
};
template<class $TemplateParameter[[TT]]>
class $Class[[B]] {
$Class[[A]]<$TemplateParameter[[TT]]> $Field[[AA]];
};
template<class $TemplateParameter[[TT]], class $TemplateParameter[[GG]]>
class $Class[[BB]] {};
template<class $TemplateParameter[[T]]>
class $Class[[BB]]<$TemplateParameter[[T]], $Primitive[[int]]> {};
template<class $TemplateParameter[[T]]>
class $Class[[BB]]<$TemplateParameter[[T]], $TemplateParameter[[T]]*> {};
template<template<class> class $TemplateParameter[[T]], class $TemplateParameter[[C]]>
$TemplateParameter[[T]]<$TemplateParameter[[C]]> $Function[[f]]();
template<typename>
class $Class[[Foo]] {};
template<typename $TemplateParameter[[T]]>
$Primitive[[void]] $Function[[foo]]($TemplateParameter[[T]] ...);
)cpp",
R"cpp(
template <class $TemplateParameter[[T]]>
struct $Class[[Tmpl]] {$TemplateParameter[[T]] $Field[[x]] = 0;};
extern template struct $Class[[Tmpl]]<$Primitive[[float]]>;
template struct $Class[[Tmpl]]<$Primitive[[double]]>;
)cpp",
// This test is to guard against highlightings disappearing when using
// conversion operators as their behaviour in the clang AST differ from
// other CXXMethodDecls.
R"cpp(
class $Class[[Foo]] {};
struct $Class[[Bar]] {
explicit operator $Class[[Foo]]*() const;
explicit operator $Primitive[[int]]() const;
operator $Class[[Foo]]();
};
$Primitive[[void]] $Function[[f]]() {
$Class[[Bar]] $Variable[[B]];
$Class[[Foo]] $Variable[[F]] = $Variable[[B]];
$Class[[Foo]] *$Variable[[FP]] = ($Class[[Foo]]*)$Variable[[B]];
$Primitive[[int]] $Variable[[I]] = ($Primitive[[int]])$Variable[[B]];
}
)cpp"
R"cpp(
struct $Class[[B]] {};
struct $Class[[A]] {
$Class[[B]] $Field[[BB]];
$Class[[A]] &operator=($Class[[A]] &&$Parameter[[O]]);
};
$Class[[A]] &$Class[[A]]::operator=($Class[[A]] &&$Parameter[[O]]) = default;
)cpp",
R"cpp(
enum $Enum[[En]] {
$EnumConstant[[EC]],
};
class $Class[[Foo]] {};
class $Class[[Bar]] {
$Class[[Foo]] $Field[[Fo]];
$Enum[[En]] $Field[[E]];
$Primitive[[int]] $Field[[I]];
$Class[[Bar]] ($Class[[Foo]] $Parameter[[F]],
$Enum[[En]] $Parameter[[E]])
: $Field[[Fo]] ($Parameter[[F]]), $Field[[E]] ($Parameter[[E]]),
$Field[[I]] (123) {}
};
class $Class[[Bar2]] : public $Class[[Bar]] {
$Class[[Bar2]]() : $Class[[Bar]]($Class[[Foo]](), $EnumConstant[[EC]]) {}
};
)cpp",
R"cpp(
enum $Enum[[E]] {
$EnumConstant[[E]],
};
class $Class[[Foo]] {};
$Enum[[auto]] $Variable[[AE]] = $Enum[[E]]::$EnumConstant[[E]];
$Class[[auto]] $Variable[[AF]] = $Class[[Foo]]();
$Class[[decltype]](auto) $Variable[[AF2]] = $Class[[Foo]]();
$Class[[auto]] *$Variable[[AFP]] = &$Variable[[AF]];
$Enum[[auto]] &$Variable[[AER]] = $Variable[[AE]];
$Primitive[[auto]] $Variable[[Form]] = 10.2 + 2 * 4;
$Primitive[[decltype]]($Variable[[Form]]) $Variable[[F]] = 10;
auto $Variable[[Fun]] = []()->$Primitive[[void]]{};
)cpp",
R"cpp(
class $Class[[G]] {};
template<$Class[[G]] *$TemplateParameter[[U]]>
class $Class[[GP]] {};
template<$Class[[G]] &$TemplateParameter[[U]]>
class $Class[[GR]] {};
template<$Primitive[[int]] *$TemplateParameter[[U]]>
class $Class[[IP]] {
$Primitive[[void]] $Method[[f]]() {
*$TemplateParameter[[U]] += 5;
}
};
template<$Primitive[[unsigned]] $TemplateParameter[[U]] = 2>
class $Class[[Foo]] {
$Primitive[[void]] $Method[[f]]() {
for($Primitive[[int]] $Variable[[I]] = 0;
$Variable[[I]] < $TemplateParameter[[U]];) {}
}
};
$Class[[G]] $Variable[[L]];
$Primitive[[void]] $Function[[f]]() {
$Class[[Foo]]<123> $Variable[[F]];
$Class[[GP]]<&$Variable[[L]]> $Variable[[LL]];
$Class[[GR]]<$Variable[[L]]> $Variable[[LLL]];
}
)cpp",
R"cpp(
template<typename $TemplateParameter[[T]],
$Primitive[[void]] (T::*$TemplateParameter[[method]])($Primitive[[int]])>
struct $Class[[G]] {
$Primitive[[void]] $Method[[foo]](
$TemplateParameter[[T]] *$Parameter[[O]]) {
($Parameter[[O]]->*$TemplateParameter[[method]])(10);
}
};
struct $Class[[F]] {
$Primitive[[void]] $Method[[f]]($Primitive[[int]]);
};
template<$Primitive[[void]] (*$TemplateParameter[[Func]])()>
struct $Class[[A]] {
$Primitive[[void]] $Method[[f]]() {
(*$TemplateParameter[[Func]])();
}
};
$Primitive[[void]] $Function[[foo]]() {
$Class[[F]] $Variable[[FF]];
$Class[[G]]<$Class[[F]], &$Class[[F]]::$Method[[f]]> $Variable[[GG]];
$Variable[[GG]].$Method[[foo]](&$Variable[[FF]]);
$Class[[A]]<$Function[[foo]]> $Variable[[AA]];
)cpp",
// Tokens that share a source range but have conflicting Kinds are not
// highlighted.
R"cpp(
#define DEF_MULTIPLE(X) namespace X { class X { int X; }; }
#define DEF_CLASS(T) class T {};
DEF_MULTIPLE(XYZ);
DEF_MULTIPLE(XYZW);
DEF_CLASS($Class[[A]])
#define MACRO_CONCAT(X, V, T) T foo##X = V
#define DEF_VAR(X, V) int X = V
#define DEF_VAR_T(T, X, V) T X = V
#define DEF_VAR_REV(V, X) DEF_VAR(X, V)
#define CPY(X) X
#define DEF_VAR_TYPE(X, Y) X Y
#define SOME_NAME variable
#define SOME_NAME_SET variable2 = 123
#define INC_VAR(X) X += 2
$Primitive[[void]] $Function[[foo]]() {
DEF_VAR($Variable[[X]], 123);
DEF_VAR_REV(908, $Variable[[XY]]);
$Primitive[[int]] CPY( $Variable[[XX]] );
DEF_VAR_TYPE($Class[[A]], $Variable[[AA]]);
$Primitive[[double]] SOME_NAME;
$Primitive[[int]] SOME_NAME_SET;
$Variable[[variable]] = 20.1;
MACRO_CONCAT(var, 2, $Primitive[[float]]);
DEF_VAR_T($Class[[A]], CPY(CPY($Variable[[Nested]])),
CPY($Class[[A]]()));
INC_VAR($Variable[[variable]]);
}
$Primitive[[void]] SOME_NAME();
DEF_VAR($Variable[[XYZ]], 567);
DEF_VAR_REV(756, $Variable[[AB]]);
#define CALL_FN(F) F();
#define DEF_FN(F) void F ()
DEF_FN($Function[[g]]) {
CALL_FN($Function[[foo]]);
}
)cpp",
R"cpp(
#define fail(expr) expr
#define assert(COND) if (!(COND)) { fail("assertion failed" #COND); }
$Primitive[[int]] $Variable[[x]];
$Primitive[[int]] $Variable[[y]];
$Primitive[[int]] $Function[[f]]();
$Primitive[[void]] $Function[[foo]]() {
assert($Variable[[x]] != $Variable[[y]]);
assert($Variable[[x]] != $Function[[f]]());
}
)cpp"};
for (const auto &TestCase : TestCases) {
checkHighlightings(TestCase);
}
checkHighlightings(R"cpp(
class $Class[[A]] {
#include "imp.h"
};
#endif
)cpp",
{{"imp.h", R"cpp(
int someMethod();
void otherMethod();
)cpp"}});
// A separate test for macros in headers.
checkHighlightings(R"cpp(
#include "imp.h"
DEFINE_Y
DXYZ_Y(A);
)cpp",
{{"imp.h", R"cpp(
#define DXYZ(X) class X {};
#define DXYZ_Y(Y) DXYZ(x##Y)
#define DEFINE(X) int X;
#define DEFINE_Y DEFINE(Y)
)cpp"}});
}
TEST(SemanticHighlighting, GeneratesHighlightsWhenFileChange) {
class HighlightingsCounterDiagConsumer : public DiagnosticsConsumer {
public:
std::atomic<int> Count = {0};
void onDiagnosticsReady(PathRef, std::vector<Diag>) override {}
void onHighlightingsReady(PathRef File,
std::vector<HighlightingToken> Highlightings,
int NLines) override {
++Count;
}
};
auto FooCpp = testPath("foo.cpp");
MockFSProvider FS;
FS.Files[FooCpp] = "";
MockCompilationDatabase MCD;
HighlightingsCounterDiagConsumer DiagConsumer;
ClangdServer Server(MCD, FS, DiagConsumer, ClangdServer::optsForTest());
Server.addDocument(FooCpp, "int a;");
ASSERT_TRUE(Server.blockUntilIdleForTest()) << "Waiting for server";
ASSERT_EQ(DiagConsumer.Count, 1);
}
TEST(SemanticHighlighting, toSemanticHighlightingInformation) {
auto CreatePosition = [](int Line, int Character) -> Position {
Position Pos;
Pos.line = Line;
Pos.character = Character;
return Pos;
};
std::vector<LineHighlightings> Tokens{
{3,
{{HighlightingKind::Variable,
Range{CreatePosition(3, 8), CreatePosition(3, 12)}},
{HighlightingKind::Function,
Range{CreatePosition(3, 4), CreatePosition(3, 7)}}}},
{1,
{{HighlightingKind::Variable,
Range{CreatePosition(1, 1), CreatePosition(1, 5)}}}}};
std::vector<SemanticHighlightingInformation> ActualResults =
toSemanticHighlightingInformation(Tokens);
std::vector<SemanticHighlightingInformation> ExpectedResults = {
{3, "AAAACAAEAAAAAAAEAAMAAg=="}, {1, "AAAAAQAEAAA="}};
EXPECT_EQ(ActualResults, ExpectedResults);
}
TEST(SemanticHighlighting, HighlightingDiffer) {
struct {
llvm::StringRef OldCode;
llvm::StringRef NewCode;
} TestCases[]{{
R"(
$Variable[[A]]
$Class[[B]]
$Function[[C]]
)",
R"(
$Variable[[A]]
$Class[[D]]
$Function[[C]]
)"},
{
R"(
$Class[[C]]
$Field[[F]]
$Variable[[V]]
$Class[[C]] $Variable[[V]] $Field[[F]]
)",
R"(
$Class[[C]]
$Field[[F]]
^$Function[[F]]
$Class[[C]] $Variable[[V]] $Field[[F]]
)"},
{
R"(
$Class[[A]]
$Variable[[A]]
)",
R"(
^
^$Class[[A]]
^$Variable[[A]]
)"},
{
R"(
$Class[[C]]
$Field[[F]]
$Variable[[V]]
$Class[[C]] $Variable[[V]] $Field[[F]]
)",
R"(
$Class[[C]]
^
^
$Class[[C]] $Variable[[V]] $Field[[F]]
)"},
{
R"(
$Class[[A]]
$Variable[[A]]
$Variable[[A]]
)",
R"(
$Class[[A]]
^$Variable[[AA]]
$Variable[[A]]
)"},
{
R"(
$Class[[A]]
$Variable[[A]]
$Class[[A]]
$Variable[[A]]
)",
R"(
$Class[[A]]
$Variable[[A]]
)"},
{
R"(
$Class[[A]]
$Variable[[A]]
)",
R"(
$Class[[A]]
$Variable[[A]]
^$Class[[A]]
^$Variable[[A]]
)"},
{
R"(
$Variable[[A]]
$Variable[[A]]
$Variable[[A]]
)",
R"(
^$Class[[A]]
^$Class[[A]]
^$Class[[A]]
)"}};
for (const auto &Test : TestCases)
checkDiffedHighlights(Test.OldCode, Test.NewCode);
}
} // namespace
} // namespace clangd
} // namespace clang