maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[clangd] Store index::SymbolKind in HoverInfo 

Summary:
LSP's SymbolKind has some shortcomings when it comes to C++ types,
index::SymbolKind has more detailed info like Destructor, Parameter, MACRO etc.

We are planning to make use of that information in our new Hover response, and
it would be nice to display the Symbol type in full detail, rather than some
approximation.

Reviewers: sammccall

Subscribers: ilya-biryukov, MaskRay, jkorous, arphaman, usaxena95, cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D70723
This commit is contained in:
Kadir Cetinkaya 2019-11-26 18:06:17 +01:00
parent 18cf93a6ed
commit 24439a761c
No known key found for this signature in database
GPG Key ID: E39E36B8D2057ED6
3 changed files with 37 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
clang-tools-extra/clangd/Hover.cpp
View File

@ -20,6 +20,8 @@
#include "clang/AST/ASTTypeTraits.h" #include "clang/AST/ASTTypeTraits.h"
#include "clang/AST/DeclTemplate.h" #include "clang/AST/DeclTemplate.h"
#include "clang/AST/PrettyPrinter.h" #include "clang/AST/PrettyPrinter.h"
#include "clang/Index/IndexSymbol.h"
#include "llvm/Support/raw_ostream.h"
namespace clang { namespace clang {
namespace clangd { namespace clangd {
@ -298,7 +300,7 @@ HoverInfo getHoverContents(const Decl *D, const SymbolIndex *Index) {
HI.Name = printName(Ctx, *ND); HI.Name = printName(Ctx, *ND);
} }
HI.Kind = indexSymbolKindToSymbolKind(index::getSymbolInfo(D).Kind); HI.Kind = index::getSymbolInfo(D).Kind;
// Fill in template params. // Fill in template params.
if (const TemplateDecl *TD = D->getDescribedTemplate()) { if (const TemplateDecl *TD = D->getDescribedTemplate()) {
@ -347,7 +349,7 @@ HoverInfo getHoverContents(QualType T, const Decl *D, ASTContext &ASTCtx,
OS.flush(); OS.flush();
if (D) { if (D) {
HI.Kind = indexSymbolKindToSymbolKind(index::getSymbolInfo(D).Kind); HI.Kind = index::getSymbolInfo(D).Kind;
enhanceFromIndex(HI, D, Index); enhanceFromIndex(HI, D, Index);
} }
return HI; return HI;
@ -358,8 +360,7 @@ HoverInfo getHoverContents(const DefinedMacro &Macro, ParsedAST &AST) {
HoverInfo HI; HoverInfo HI;
SourceManager &SM = AST.getSourceManager(); SourceManager &SM = AST.getSourceManager();
HI.Name = Macro.Name; HI.Name = Macro.Name;
HI.Kind = indexSymbolKindToSymbolKind( HI.Kind = index::SymbolKind::Macro;
index::getSymbolInfoForMacro(*Macro.Info).Kind);
// FIXME: Populate documentation // FIXME: Populate documentation
// FIXME: Pupulate parameters // FIXME: Pupulate parameters

6
clang-tools-extra/clangd/Hover.h
View File

@ -28,7 +28,7 @@ struct HoverInfo {
/// - template <ParamType Name = DefaultType> class Foo {}; /// - template <ParamType Name = DefaultType> class Foo {};
struct Param { struct Param {
/// The pretty-printed parameter type, e.g. "int", or "typename" (in /// The pretty-printed parameter type, e.g. "int", or "typename" (in
/// TemplateParameters) /// TemplateParameters), might be None for macro parameters.
llvm::Optional<std::string> Type; llvm::Optional<std::string> Type;
/// None for unnamed parameters. /// None for unnamed parameters.
llvm::Optional<std::string> Name; llvm::Optional<std::string> Name;
@ -53,9 +53,7 @@ struct HoverInfo {
/// Name of the symbol, does not contain any "::". /// Name of the symbol, does not contain any "::".
std::string Name; std::string Name;
llvm::Optional<Range> SymRange; llvm::Optional<Range> SymRange;
/// Scope containing the symbol. e.g, "global namespace", "function x::Y" index::SymbolKind Kind;
/// - None for deduced types, e.g "auto", "decltype" keywords.
SymbolKind Kind;
std::string Documentation; std::string Documentation;
/// Source code containing the definition of the symbol. /// Source code containing the definition of the symbol.
std::string Definition; std::string Definition;

60
clang-tools-extra/clangd/unittests/HoverTests.cpp
View File

@ -32,7 +32,7 @@ TEST(Hover, Structured) {
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "foo"; HI.Name = "foo";
HI.Kind = SymbolKind::Function; HI.Kind = index::SymbolKind::Function;
HI.Documentation = "Best foo ever."; HI.Documentation = "Best foo ever.";
HI.Definition = "void foo()"; HI.Definition = "void foo()";
HI.ReturnType = "void"; HI.ReturnType = "void";
@ -49,7 +49,7 @@ TEST(Hover, Structured) {
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = "ns1::ns2::"; HI.NamespaceScope = "ns1::ns2::";
HI.Name = "foo"; HI.Name = "foo";
HI.Kind = SymbolKind::Function; HI.Kind = index::SymbolKind::Function;
HI.Documentation = "Best foo ever."; HI.Documentation = "Best foo ever.";
HI.Definition = "void foo()"; HI.Definition = "void foo()";
HI.ReturnType = "void"; HI.ReturnType = "void";
@ -68,7 +68,7 @@ TEST(Hover, Structured) {
HI.NamespaceScope = "ns1::ns2::"; HI.NamespaceScope = "ns1::ns2::";
HI.LocalScope = "Foo::"; HI.LocalScope = "Foo::";
HI.Name = "bar"; HI.Name = "bar";
HI.Kind = SymbolKind::Field; HI.Kind = index::SymbolKind::Field;
HI.Definition = "int bar"; HI.Definition = "int bar";
HI.Type = "int"; HI.Type = "int";
}}, }},
@ -86,7 +86,7 @@ TEST(Hover, Structured) {
HI.NamespaceScope = "ns1::ns2::"; HI.NamespaceScope = "ns1::ns2::";
HI.LocalScope = "Foo::foo::"; HI.LocalScope = "Foo::foo::";
HI.Name = "bar"; HI.Name = "bar";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Definition = "int bar"; HI.Definition = "int bar";
HI.Type = "int"; HI.Type = "int";
}}, }},
@ -102,7 +102,7 @@ TEST(Hover, Structured) {
HI.NamespaceScope = "ns1::(anonymous)::"; HI.NamespaceScope = "ns1::(anonymous)::";
HI.LocalScope = "(anonymous struct)::"; HI.LocalScope = "(anonymous struct)::";
HI.Name = "bar"; HI.Name = "bar";
HI.Kind = SymbolKind::Field; HI.Kind = index::SymbolKind::Field;
HI.Definition = "int bar"; HI.Definition = "int bar";
HI.Type = "int"; HI.Type = "int";
}}, }},
@ -114,7 +114,7 @@ TEST(Hover, Structured) {
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "foo"; HI.Name = "foo";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Definition = "Foo<int, char, bool> foo = Foo<int, char, bool>(5)"; HI.Definition = "Foo<int, char, bool> foo = Foo<int, char, bool>(5)";
HI.Type = "Foo<int, char, bool>"; HI.Type = "Foo<int, char, bool>";
}}, }},
@ -126,7 +126,7 @@ TEST(Hover, Structured) {
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "vector"; HI.Name = "vector";
HI.Kind = SymbolKind::Class; HI.Kind = index::SymbolKind::Class;
HI.Definition = "template <typename T> class vector {}"; HI.Definition = "template <typename T> class vector {}";
HI.TemplateParameters = { HI.TemplateParameters = {
{std::string("typename"), std::string("T"), llvm::None}, {std::string("typename"), std::string("T"), llvm::None},
@ -145,7 +145,7 @@ TEST(Hover, Structured) {
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "Foo"; HI.Name = "Foo";
HI.Kind = SymbolKind::Class; HI.Kind = index::SymbolKind::Class;
HI.Definition = HI.Definition =
R"cpp(template <template <typename, bool...> class C, typename = char, int = 0, R"cpp(template <template <typename, bool...> class C, typename = char, int = 0,
bool Q = false, class... Ts> bool Q = false, class... Ts>
@ -175,7 +175,7 @@ class Foo {})cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "foo"; HI.Name = "foo";
HI.Kind = SymbolKind::Function; HI.Kind = index::SymbolKind::Function;
HI.Definition = HI.Definition =
R"cpp(template <template <typename, bool...> class C, typename = char, int = 0, R"cpp(template <template <typename, bool...> class C, typename = char, int = 0,
bool Q = false, class... Ts> bool Q = false, class... Ts>
@ -204,7 +204,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "foo"; HI.Name = "foo";
HI.Kind = SymbolKind::Function; HI.Kind = index::SymbolKind::Function;
HI.Definition = "Foo<bool, true, false> foo(int, bool T = false)"; HI.Definition = "Foo<bool, true, false> foo(int, bool T = false)";
HI.ReturnType = "Foo<bool, true, false>"; HI.ReturnType = "Foo<bool, true, false>";
HI.Type = "Foo<bool, true, false> (int, bool)"; HI.Type = "Foo<bool, true, false> (int, bool)";
@ -225,7 +225,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "foo::"; HI.LocalScope = "foo::";
HI.Name = "c"; HI.Name = "c";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Definition = "auto *c = &b"; HI.Definition = "auto *c = &b";
HI.Type = "class (lambda) **"; HI.Type = "class (lambda) **";
HI.ReturnType = "bool"; HI.ReturnType = "bool";
@ -246,7 +246,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "foo::"; HI.LocalScope = "foo::";
HI.Name = "bar"; HI.Name = "bar";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Parameter;
HI.Definition = "decltype(lamb) &bar"; HI.Definition = "decltype(lamb) &bar";
HI.Type = "decltype(lamb) &"; HI.Type = "decltype(lamb) &";
HI.ReturnType = "bool"; HI.ReturnType = "bool";
@ -267,7 +267,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "foo::"; HI.LocalScope = "foo::";
HI.Name = "bar"; HI.Name = "bar";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Parameter;
HI.Definition = "decltype(lamb) bar"; HI.Definition = "decltype(lamb) bar";
HI.Type = "class (lambda)"; HI.Type = "class (lambda)";
HI.ReturnType = "bool"; HI.ReturnType = "bool";
@ -290,7 +290,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "foo::"; HI.LocalScope = "foo::";
HI.Name = "lamb"; HI.Name = "lamb";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Definition = "auto lamb = [&bar](int T, bool B) -> bool {}"; HI.Definition = "auto lamb = [&bar](int T, bool B) -> bool {}";
HI.Type = "class (lambda)"; HI.Type = "class (lambda)";
HI.ReturnType = "bool"; HI.ReturnType = "bool";
@ -310,7 +310,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "foo::(anonymous class)::operator()::"; HI.LocalScope = "foo::(anonymous class)::operator()::";
HI.Name = "test"; HI.Name = "test";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Definition = "int test"; HI.Definition = "int test";
HI.Type = "int"; HI.Type = "int";
}}, }},
@ -322,7 +322,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "X<T *>"; HI.Name = "X<T *>";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Kind = SymbolKind::Class; HI.Kind = index::SymbolKind::Class;
HI.Definition = "template <typename T> class X<T *> {}"; HI.Definition = "template <typename T> class X<T *> {}";
}}, }},
// Constructor of partially-specialized class template // Constructor of partially-specialized class template
@ -334,7 +334,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "X"; HI.Name = "X";
HI.LocalScope = "X<T *>::"; // FIXME: X<T *, void>:: HI.LocalScope = "X<T *>::"; // FIXME: X<T *, void>::
HI.Kind = SymbolKind::Constructor; HI.Kind = index::SymbolKind::Constructor;
HI.ReturnType = "X<T *>"; HI.ReturnType = "X<T *>";
HI.Definition = "X()"; HI.Definition = "X()";
HI.Parameters.emplace(); HI.Parameters.emplace();
@ -344,7 +344,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Name = "~X"; HI.Name = "~X";
HI.LocalScope = "X::"; HI.LocalScope = "X::";
HI.Kind = SymbolKind::Constructor; HI.Kind = index::SymbolKind::Destructor;
HI.ReturnType = "void"; HI.ReturnType = "void";
HI.Definition = "~X()"; HI.Definition = "~X()";
HI.Parameters.emplace(); HI.Parameters.emplace();
@ -358,7 +358,7 @@ void foo())cpp";
)cpp", )cpp",
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "class (lambda)"; HI.Name = "class (lambda)";
HI.Kind = SymbolKind::Class; HI.Kind = index::SymbolKind::Class;
}}, }},
// auto on template instantiation // auto on template instantiation
{R"cpp( {R"cpp(
@ -369,7 +369,7 @@ void foo())cpp";
)cpp", )cpp",
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "class Foo<int>"; HI.Name = "class Foo<int>";
HI.Kind = SymbolKind::Class; HI.Kind = index::SymbolKind::Class;
}}, }},
// auto on specialized template // auto on specialized template
{R"cpp( {R"cpp(
@ -381,7 +381,7 @@ void foo())cpp";
)cpp", )cpp",
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "class Foo<int>"; HI.Name = "class Foo<int>";
HI.Kind = SymbolKind::Class; HI.Kind = index::SymbolKind::Class;
}}, }},
// macro // macro
@ -391,7 +391,7 @@ void foo())cpp";
[[MAC^RO]](int, double d, bool z = false); [[MAC^RO]](int, double d, bool z = false);
)cpp", )cpp",
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "MACRO", HI.Kind = SymbolKind::String, HI.Name = "MACRO", HI.Kind = index::SymbolKind::Macro,
HI.Definition = "#define MACRO(x, y, z) void foo(x, y, z);"; HI.Definition = "#define MACRO(x, y, z) void foo(x, y, z);";
}}, }},
@ -403,7 +403,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "bar"; HI.Name = "bar";
HI.Definition = "int bar = add(1, 2)"; HI.Definition = "int bar = add(1, 2)";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Type = "int"; HI.Type = "int";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Value = "3"; HI.Value = "3";
@ -414,7 +414,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "bar"; HI.Name = "bar";
HI.Definition = "int bar = sizeof(char)"; HI.Definition = "int bar = sizeof(char)";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Type = "int"; HI.Type = "int";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Value = "1"; HI.Value = "1";
@ -428,7 +428,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "bar"; HI.Name = "bar";
HI.Definition = "int bar = Add<1, 2>::result"; HI.Definition = "int bar = Add<1, 2>::result";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Type = "int"; HI.Type = "int";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Value = "3"; HI.Value = "3";
@ -442,7 +442,7 @@ void foo())cpp";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "Color::"; HI.LocalScope = "Color::";
HI.Definition = "GREEN"; HI.Definition = "GREEN";
HI.Kind = SymbolKind::EnumMember; HI.Kind = index::SymbolKind::EnumConstant;
HI.Type = "enum Color"; HI.Type = "enum Color";
HI.Value = "1"; // Numeric when hovering on the enumerator name. HI.Value = "1"; // Numeric when hovering on the enumerator name.
}}, }},
@ -455,7 +455,7 @@ void foo())cpp";
HI.Name = "x"; HI.Name = "x";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Definition = "enum Color x = GREEN"; HI.Definition = "enum Color x = GREEN";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Type = "enum Color"; HI.Type = "enum Color";
HI.Value = "GREEN (1)"; // Symbolic when hovering on an expression. HI.Value = "GREEN (1)"; // Symbolic when hovering on an expression.
}}, }},
@ -470,7 +470,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "result"; HI.Name = "result";
HI.Definition = "static constexpr int result = a + b"; HI.Definition = "static constexpr int result = a + b";
HI.Kind = SymbolKind::Property; HI.Kind = index::SymbolKind::StaticProperty;
HI.Type = "const int"; HI.Type = "const int";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.LocalScope = "Add<a, b>::"; HI.LocalScope = "Add<a, b>::";
@ -483,7 +483,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "answer"; HI.Name = "answer";
HI.Definition = "constexpr int answer()"; HI.Definition = "constexpr int answer()";
HI.Kind = SymbolKind::Function; HI.Kind = index::SymbolKind::Function;
HI.Type = "int ()"; HI.Type = "int ()";
HI.ReturnType = "int"; HI.ReturnType = "int";
HI.Parameters.emplace(); HI.Parameters.emplace();
@ -496,7 +496,7 @@ void foo())cpp";
[](HoverInfo &HI) { [](HoverInfo &HI) {
HI.Name = "bar"; HI.Name = "bar";
HI.Definition = "const char *bar = \"1234\""; HI.Definition = "const char *bar = \"1234\"";
HI.Kind = SymbolKind::Variable; HI.Kind = index::SymbolKind::Variable;
HI.Type = "const char *"; HI.Type = "const char *";
HI.NamespaceScope = ""; HI.NamespaceScope = "";
HI.Value = "&\"1234\"[0]"; HI.Value = "&\"1234\"[0]";