Zengtudor/ccls
1
0
Fork 0
mirror of https://github.com/MaskRay/ccls.git synced 2024-11-22 23:55:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Serialize decl comments and use them in GetHoverForSymbol

Browse Source
This commit is contained in:
romix 2017-12-23 18:22:22 -08:00 committed by Fangrui Song
parent 338db49637
commit 03b50ea3cc
7 changed files with 51 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/clang_cursor.cc
View File

@ -182,12 +182,15 @@ std::string ClangCursor::get_type_description() const {
return ::ToString(clang_getTypeSpelling(type));
}
std::string ClangCursor::get_comments() const {
optional<std::string> ClangCursor::get_comments() const {
return nullopt;
// TODO
ClangCursor referenced = get_referenced();
if (referenced)
// Get unformatted comments. Returns multiple paragraphs.
return ::ToString(clang_Cursor_getRawCommentText(referenced.cx_cursor));
return "";
// Get formatted comments. Returns only the first paragraph.
return ::ToString(clang_Cursor_getBriefCommentText(referenced.cx_cursor));
}
std::string ClangCursor::ToString() const {

6
src/clang_cursor.h
View File

@ -1,10 +1,14 @@
#pragma once
#include <optional.h>
#include <clang-c/Index.h>
#include <string>
#include <vector>
using std::experimental::optional;
class ClangType {
public:
ClangType();
@ -65,7 +69,7 @@ class ClangCursor {
bool is_valid_kind() const;
std::string get_type_description() const;
std::string get_comments() const;
optional<std::string> get_comments() const;
std::string ToString() const;

10
src/indexer.cc
View File

@ -1012,6 +1012,7 @@ ClangCursor::VisitResult VisitMacroDefinitionAndExpansions(ClangCursor cursor,
var_def->def.hover =
"#define " + GetDocumentContentInRange(param->tu->cx_tu, cx_extent);
var_def->def.cls = VarClass::Macro;
var_def->def.comments = cursor.get_comments();
var_def->def.definition_spelling = decl_loc_spelling;
var_def->def.definition_extent = Resolve(cx_extent, nullptr);
}
@ -1154,6 +1155,7 @@ void OnIndexDeclaration(CXClientData client_data, const CXIdxDeclInfo* decl) {
// string. Shorten it to just "lambda".
if (type_name.find("(lambda at") != std::string::npos)
type_name = "lambda";
var->def.comments = decl_cursor.get_comments();
{
std::string qualified_name =
@ -1246,6 +1248,7 @@ void OnIndexDeclaration(CXClientData client_data, const CXIdxDeclInfo* decl) {
IndexFuncId func_id = db->ToFuncId(decl_cursor_resolved.cx_cursor);
IndexFunc* func = db->Resolve(func_id);
func->def.comments = decl_cursor.get_comments();
// We don't actually need to know the return type, but we need to mark it
// as an interesting usage.
@ -1428,6 +1431,9 @@ void OnIndexDeclaration(CXClientData client_data, const CXIdxDeclInfo* decl) {
type->def.detailed_name =
ns->QualifiedName(decl->semanticContainer, type->def.short_name);
ClangCursor decl_cursor = decl->cursor;
type->def.comments = decl_cursor.get_comments();
// For Typedef/CXXTypeAlias spanning a few lines, display the declaration
// line, with spelling name replaced with qualified name.
// TODO Think how to display multi-line declaration like `typedef struct {
@ -1481,6 +1487,8 @@ void OnIndexDeclaration(CXClientData client_data, const CXIdxDeclInfo* decl) {
type->def.detailed_name =
ns->QualifiedName(decl->semanticContainer, type->def.short_name);
ClangCursor decl_cursor = decl->cursor;
type->def.comments = decl_cursor.get_comments();
// }
if (decl->isDefinition) {
@ -1594,6 +1602,8 @@ void OnIndexReference(CXClientData client_data, const CXIdxEntityRefInfo* ref) {
clang_getTypeSpelling(clang_getCursorType(referenced.cx_cursor)));
var->def.detailed_name = type_name + " " + var->def.short_name;
var->def.cls = VarClass::Member;
ClangCursor decl_cursor = referenced;
var->def.comments = decl_cursor.get_comments();
UniqueAdd(var->uses, ResolveSpelling(referenced.cx_cursor));
AddDeclInitializerUsages(db, referenced.cx_cursor);
// TODO Use proper semantic_container and lexical_container.

6
src/indexer.h
View File

@ -150,6 +150,7 @@ struct TypeDefDefinitionData {
std::string short_name;
std::string detailed_name;
optional<std::string> hover;
optional<std::string> comments;
// While a class/type can technically have a separate declaration/definition,
// it doesn't really happen in practice. The declaration never contains
@ -201,6 +202,7 @@ void Reflect(TVisitor& visitor,
REFLECT_MEMBER(short_name);
REFLECT_MEMBER(detailed_name);
REFLECT_MEMBER(hover);
REFLECT_MEMBER(comments);
REFLECT_MEMBER(definition_spelling);
REFLECT_MEMBER(definition_extent);
REFLECT_MEMBER(alias_of);
@ -247,6 +249,7 @@ struct FuncDefDefinitionData {
std::string short_name;
std::string detailed_name;
optional<std::string> hover;
optional<std::string> comments;
optional<Range> definition_spelling;
optional<Range> definition_extent;
@ -295,6 +298,7 @@ void Reflect(
REFLECT_MEMBER(short_name);
REFLECT_MEMBER(detailed_name);
REFLECT_MEMBER(hover);
REFLECT_MEMBER(comments);
REFLECT_MEMBER(definition_spelling);
REFLECT_MEMBER(definition_extent);
REFLECT_MEMBER(declaring_type);
@ -375,6 +379,7 @@ struct VarDefDefinitionData {
std::string short_name;
std::string detailed_name;
optional<std::string> hover;
optional<std::string> comments;
optional<Range> declaration;
// TODO: definitions should be a list of ranges, since there can be more
// than one - when??
@ -419,6 +424,7 @@ void Reflect(TVisitor& visitor,
REFLECT_MEMBER(short_name);
REFLECT_MEMBER(detailed_name);
REFLECT_MEMBER(hover);
REFLECT_MEMBER(comments);
REFLECT_MEMBER(definition_spelling);
REFLECT_MEMBER(definition_extent);
REFLECT_MEMBER(variable_type);

33
src/messages/text_document_hover.cc
View File

@ -3,33 +3,36 @@
namespace {
static std::string getHoverString(const optional<std::string>& hover,
const optional<std::string>& comments,
const std::string& detailed_name) {
// TODO: Properly format multi-line comments.
std::string ret;
if (comments) {
ret += *comments;
ret += '\n';
}
return ret + hover.value_or(detailed_name);
}
std::string GetHoverForSymbol(QueryDatabase* db, const SymbolIdx& symbol) {
switch (symbol.kind) {
case SymbolKind::Type: {
QueryType& type = db->types[symbol.idx];
if (type.def) {
if (type.def->hover)
return *type.def->hover;
return type.def->detailed_name;
}
if (type.def)
return getHoverString(type.def->hover, type.def->comments, type.def->detailed_name);
break;
}
case SymbolKind::Func: {
QueryFunc& func = db->funcs[symbol.idx];
if (func.def) {
if (func.def->hover)
return *func.def->hover;
return func.def->detailed_name;
}
if (func.def)
return getHoverString(func.def->hover, func.def->comments, func.def->detailed_name);
break;
}
case SymbolKind::Var: {
QueryVar& var = db->vars[symbol.idx];
if (var.def) {
if (var.def->hover)
return *var.def->hover;
return var.def->detailed_name;
}
if (var.def)
return getHoverString(var.def->hover, var.def->comments, var.def->detailed_name);
break;
}
case SymbolKind::File:

3
src/query.cc
View File

@ -27,6 +27,7 @@ optional<QueryType::Def> ToQuery(const IdMap& id_map,
result.short_name = type.short_name;
result.detailed_name = type.detailed_name;
result.hover = type.hover;
result.comments = type.comments;
result.definition_spelling = id_map.ToQuery(type.definition_spelling);
result.definition_extent = id_map.ToQuery(type.definition_extent);
result.alias_of = id_map.ToQuery(type.alias_of);
@ -46,6 +47,7 @@ optional<QueryFunc::Def> ToQuery(const IdMap& id_map,
result.short_name = func.short_name;
result.detailed_name = func.detailed_name;
result.hover = func.hover;
result.comments = func.comments;
result.definition_spelling = id_map.ToQuery(func.definition_spelling);
result.definition_extent = id_map.ToQuery(func.definition_extent);
result.declaring_type = id_map.ToQuery(func.declaring_type);
@ -64,6 +66,7 @@ optional<QueryVar::Def> ToQuery(const IdMap& id_map, const IndexVar::Def& var) {
result.short_name = var.short_name;
result.detailed_name = var.detailed_name;
result.hover = var.hover;
result.comments = var.comments;
result.declaration = id_map.ToQuery(var.declaration);
result.definition_spelling = id_map.ToQuery(var.definition_spelling);
result.definition_extent = id_map.ToQuery(var.definition_extent);

3
src/serializer.cc
View File

@ -100,6 +100,7 @@ void Reflect(TVisitor& visitor, IndexType& value) {
REFLECT_MEMBER2("short_name", value.def.short_name);
REFLECT_MEMBER2("detailed_name", value.def.detailed_name);
REFLECT_MEMBER2("hover", value.def.hover);
REFLECT_MEMBER2("comments", value.def.comments);
REFLECT_MEMBER2("definition_spelling", value.def.definition_spelling);
REFLECT_MEMBER2("definition_extent", value.def.definition_extent);
REFLECT_MEMBER2("alias_of", value.def.alias_of);
@ -122,6 +123,7 @@ void Reflect(TVisitor& visitor, IndexFunc& value) {
REFLECT_MEMBER2("short_name", value.def.short_name);
REFLECT_MEMBER2("detailed_name", value.def.detailed_name);
REFLECT_MEMBER2("hover", value.def.hover);
REFLECT_MEMBER2("comments", value.def.comments);
REFLECT_MEMBER2("declarations", value.declarations);
REFLECT_MEMBER2("definition_spelling", value.def.definition_spelling);
REFLECT_MEMBER2("definition_extent", value.def.definition_extent);
@ -142,6 +144,7 @@ void Reflect(TVisitor& visitor, IndexVar& value) {
REFLECT_MEMBER2("short_name", value.def.short_name);
REFLECT_MEMBER2("detailed_name", value.def.detailed_name);
REFLECT_MEMBER2("hover", value.def.hover);
REFLECT_MEMBER2("comments", value.def.comments);
REFLECT_MEMBER2("declaration", value.def.declaration);
REFLECT_MEMBER2("definition_spelling", value.def.definition_spelling);
REFLECT_MEMBER2("definition_extent", value.def.definition_extent);