Google Git
Sign in
android / toolchain / rustc / refs/heads/main / . / src / llvm-project / clang-tools-extra / clangd / Hover.cpp
blob: de103e011c70852641e1552741067af647150015 [file] [log] [blame] [edit]
//===--- Hover.cpp - Information about code at the cursor location --------===//
//
// 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 "Hover.h"
#include "AST.h"
#include "CodeCompletionStrings.h"
#include "Config.h"
#include "FindTarget.h"
#include "Headers.h"
#include "IncludeCleaner.h"
#include "ParsedAST.h"
#include "Selection.h"
#include "SourceCode.h"
#include "clang-include-cleaner/Analysis.h"
#include "clang-include-cleaner/IncludeSpeller.h"
#include "clang-include-cleaner/Types.h"
#include "index/SymbolCollector.h"
#include "support/Markup.h"
#include "support/Trace.h"
#include "clang/AST/ASTContext.h"
#include "clang/AST/ASTDiagnostic.h"
#include "clang/AST/ASTTypeTraits.h"
#include "clang/AST/Attr.h"
#include "clang/AST/Decl.h"
#include "clang/AST/DeclBase.h"
#include "clang/AST/DeclCXX.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/DeclTemplate.h"
#include "clang/AST/Expr.h"
#include "clang/AST/ExprCXX.h"
#include "clang/AST/OperationKinds.h"
#include "clang/AST/PrettyPrinter.h"
#include "clang/AST/RecordLayout.h"
#include "clang/AST/Type.h"
#include "clang/Basic/CharInfo.h"
#include "clang/Basic/LLVM.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/Specifiers.h"
#include "clang/Basic/TokenKinds.h"
#include "clang/Index/IndexSymbol.h"
#include "clang/Tooling/Syntax/Tokens.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/ScopedPrinter.h"
#include "llvm/Support/raw_ostream.h"
#include <algorithm>
#include <optional>
#include <string>
#include <vector>
namespace clang {
namespace clangd {
namespace {
PrintingPolicy getPrintingPolicy(PrintingPolicy Base) {
Base.AnonymousTagLocations = false;
Base.TerseOutput = true;
Base.PolishForDeclaration = true;
Base.ConstantsAsWritten = true;
Base.SuppressTemplateArgsInCXXConstructors = true;
return Base;
}
/// Given a declaration \p D, return a human-readable string representing the
/// local scope in which it is declared, i.e. class(es) and method name. Returns
/// an empty string if it is not local.
std::string getLocalScope(const Decl *D) {
std::vector<std::string> Scopes;
const DeclContext *DC = D->getDeclContext();
// ObjC scopes won't have multiple components for us to join, instead:
// - Methods: "-[Class methodParam1:methodParam2]"
// - Classes, categories, and protocols: "MyClass(Category)"
if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC))
return printObjCMethod(*MD);
if (const ObjCContainerDecl *CD = dyn_cast<ObjCContainerDecl>(DC))
return printObjCContainer(*CD);
auto GetName = [](const TypeDecl *D) {
if (!D->getDeclName().isEmpty()) {
PrintingPolicy Policy = D->getASTContext().getPrintingPolicy();
Policy.SuppressScope = true;
return declaredType(D).getAsString(Policy);
}
if (auto *RD = dyn_cast<RecordDecl>(D))
return ("(anonymous " + RD->getKindName() + ")").str();
return std::string("");
};
while (DC) {
if (const TypeDecl *TD = dyn_cast<TypeDecl>(DC))
Scopes.push_back(GetName(TD));
else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(DC))
Scopes.push_back(FD->getNameAsString());
DC = DC->getParent();
}
return llvm::join(llvm::reverse(Scopes), "::");
}
/// Returns the human-readable representation for namespace containing the
/// declaration \p D. Returns empty if it is contained global namespace.
std::string getNamespaceScope(const Decl *D) {
const DeclContext *DC = D->getDeclContext();
// ObjC does not have the concept of namespaces, so instead we support
// local scopes.
if (isa<ObjCMethodDecl, ObjCContainerDecl>(DC))
return "";
if (const TagDecl *TD = dyn_cast<TagDecl>(DC))
return getNamespaceScope(TD);
if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(DC))
return getNamespaceScope(FD);
if (const NamespaceDecl *NSD = dyn_cast<NamespaceDecl>(DC)) {
// Skip inline/anon namespaces.
if (NSD->isInline() || NSD->isAnonymousNamespace())
return getNamespaceScope(NSD);
}
if (const NamedDecl *ND = dyn_cast<NamedDecl>(DC))
return printQualifiedName(*ND);
return "";
}
std::string printDefinition(const Decl *D, PrintingPolicy PP,
const syntax::TokenBuffer &TB) {
if (auto *VD = llvm::dyn_cast<VarDecl>(D)) {
if (auto *IE = VD->getInit()) {
// Initializers might be huge and result in lots of memory allocations in
// some catostrophic cases. Such long lists are not useful in hover cards
// anyway.
if (200 < TB.expandedTokens(IE->getSourceRange()).size())
PP.SuppressInitializers = true;
}
}
std::string Definition;
llvm::raw_string_ostream OS(Definition);
D->print(OS, PP);
OS.flush();
return Definition;
}
const char *getMarkdownLanguage(const ASTContext &Ctx) {
const auto &LangOpts = Ctx.getLangOpts();
if (LangOpts.ObjC && LangOpts.CPlusPlus)
return "objective-cpp";
return LangOpts.ObjC ? "objective-c" : "cpp";
}
HoverInfo::PrintedType printType(QualType QT, ASTContext &ASTCtx,
const PrintingPolicy &PP) {
// TypePrinter doesn't resolve decltypes, so resolve them here.
// FIXME: This doesn't handle composite types that contain a decltype in them.
// We should rather have a printing policy for that.
while (!QT.isNull() && QT->isDecltypeType())
QT = QT->castAs<DecltypeType>()->getUnderlyingType();
HoverInfo::PrintedType Result;
llvm::raw_string_ostream OS(Result.Type);
// Special case: if the outer type is a tag type without qualifiers, then
// include the tag for extra clarity.
// This isn't very idiomatic, so don't attempt it for complex cases, including
// pointers/references, template specializations, etc.
if (!QT.isNull() && !QT.hasQualifiers() && PP.SuppressTagKeyword) {
if (auto *TT = llvm::dyn_cast<TagType>(QT.getTypePtr()))
OS << TT->getDecl()->getKindName() << " ";
}
QT.print(OS, PP);
OS.flush();
const Config &Cfg = Config::current();
if (!QT.isNull() && Cfg.Hover.ShowAKA) {
bool ShouldAKA = false;
QualType DesugaredTy = clang::desugarForDiagnostic(ASTCtx, QT, ShouldAKA);
if (ShouldAKA)
Result.AKA = DesugaredTy.getAsString(PP);
}
return Result;
}
HoverInfo::PrintedType printType(const TemplateTypeParmDecl *TTP) {
HoverInfo::PrintedType Result;
Result.Type = TTP->wasDeclaredWithTypename() ? "typename" : "class";
if (TTP->isParameterPack())
Result.Type += "...";
return Result;
}
HoverInfo::PrintedType printType(const NonTypeTemplateParmDecl *NTTP,
const PrintingPolicy &PP) {
auto PrintedType = printType(NTTP->getType(), NTTP->getASTContext(), PP);
if (NTTP->isParameterPack()) {
PrintedType.Type += "...";
if (PrintedType.AKA)
*PrintedType.AKA += "...";
}
return PrintedType;
}
HoverInfo::PrintedType printType(const TemplateTemplateParmDecl *TTP,
const PrintingPolicy &PP) {
HoverInfo::PrintedType Result;
llvm::raw_string_ostream OS(Result.Type);
OS << "template <";
llvm::StringRef Sep = "";
for (const Decl *Param : *TTP->getTemplateParameters()) {
OS << Sep;
Sep = ", ";
if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
OS << printType(TTP).Type;
else if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param))
OS << printType(NTTP, PP).Type;
else if (const auto *TTPD = dyn_cast<TemplateTemplateParmDecl>(Param))
OS << printType(TTPD, PP).Type;
}
// FIXME: TemplateTemplateParameter doesn't store the info on whether this
// param was a "typename" or "class".
OS << "> class";
OS.flush();
return Result;
}
std::vector<HoverInfo::Param>
fetchTemplateParameters(const TemplateParameterList *Params,
const PrintingPolicy &PP) {
assert(Params);
std::vector<HoverInfo::Param> TempParameters;
for (const Decl *Param : *Params) {
HoverInfo::Param P;
if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(Param)) {
P.Type = printType(TTP);
if (!TTP->getName().empty())
P.Name = TTP->getNameAsString();
if (TTP->hasDefaultArgument()) {
P.Default.emplace();
llvm::raw_string_ostream Out(*P.Default);
TTP->getDefaultArgument().getArgument().print(PP, Out,
/*IncludeType=*/false);
}
} else if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param)) {
P.Type = printType(NTTP, PP);
if (IdentifierInfo *II = NTTP->getIdentifier())
P.Name = II->getName().str();
if (NTTP->hasDefaultArgument()) {
P.Default.emplace();
llvm::raw_string_ostream Out(*P.Default);
NTTP->getDefaultArgument().getArgument().print(PP, Out,
/*IncludeType=*/false);
}
} else if (const auto *TTPD = dyn_cast<TemplateTemplateParmDecl>(Param)) {
P.Type = printType(TTPD, PP);
if (!TTPD->getName().empty())
P.Name = TTPD->getNameAsString();
if (TTPD->hasDefaultArgument()) {
P.Default.emplace();
llvm::raw_string_ostream Out(*P.Default);
TTPD->getDefaultArgument().getArgument().print(PP, Out,
/*IncludeType*/ false);
}
}
TempParameters.push_back(std::move(P));
}
return TempParameters;
}
const FunctionDecl *getUnderlyingFunction(const Decl *D) {
// Extract lambda from variables.
if (const VarDecl *VD = llvm::dyn_cast<VarDecl>(D)) {
auto QT = VD->getType();
if (!QT.isNull()) {
while (!QT->getPointeeType().isNull())
QT = QT->getPointeeType();
if (const auto *CD = QT->getAsCXXRecordDecl())
return CD->getLambdaCallOperator();
}
}
// Non-lambda functions.
return D->getAsFunction();
}
// Returns the decl that should be used for querying comments, either from index
// or AST.
const NamedDecl *getDeclForComment(const NamedDecl *D) {
const NamedDecl *DeclForComment = D;
if (const auto *TSD = llvm::dyn_cast<ClassTemplateSpecializationDecl>(D)) {
// Template may not be instantiated e.g. if the type didn't need to be
// complete; fallback to primary template.
if (TSD->getTemplateSpecializationKind() == TSK_Undeclared)
DeclForComment = TSD->getSpecializedTemplate();
else if (const auto *TIP = TSD->getTemplateInstantiationPattern())
DeclForComment = TIP;
} else if (const auto *TSD =
llvm::dyn_cast<VarTemplateSpecializationDecl>(D)) {
if (TSD->getTemplateSpecializationKind() == TSK_Undeclared)
DeclForComment = TSD->getSpecializedTemplate();
else if (const auto *TIP = TSD->getTemplateInstantiationPattern())
DeclForComment = TIP;
} else if (const auto *FD = D->getAsFunction())
if (const auto *TIP = FD->getTemplateInstantiationPattern())
DeclForComment = TIP;
// Ensure that getDeclForComment(getDeclForComment(X)) = getDeclForComment(X).
// This is usually not needed, but in strange cases of comparision operators
// being instantiated from spasceship operater, which itself is a template
// instantiation the recursrive call is necessary.
if (D != DeclForComment)
DeclForComment = getDeclForComment(DeclForComment);
return DeclForComment;
}
// Look up information about D from the index, and add it to Hover.
void enhanceFromIndex(HoverInfo &Hover, const NamedDecl &ND,
const SymbolIndex *Index) {
assert(&ND == getDeclForComment(&ND));
// We only add documentation, so don't bother if we already have some.
if (!Hover.Documentation.empty() || !Index)
return;
// Skip querying for non-indexable symbols, there's no point.
// We're searching for symbols that might be indexed outside this main file.
if (!SymbolCollector::shouldCollectSymbol(ND, ND.getASTContext(),
SymbolCollector::Options(),
/*IsMainFileOnly=*/false))
return;
auto ID = getSymbolID(&ND);
if (!ID)
return;
LookupRequest Req;
Req.IDs.insert(ID);
Index->lookup(Req, [&](const Symbol &S) {
Hover.Documentation = std::string(S.Documentation);
});
}
// Default argument might exist but be unavailable, in the case of unparsed
// arguments for example. This function returns the default argument if it is
// available.
const Expr *getDefaultArg(const ParmVarDecl *PVD) {
// Default argument can be unparsed or uninstantiated. For the former we
// can't do much, as token information is only stored in Sema and not
// attached to the AST node. For the latter though, it is safe to proceed as
// the expression is still valid.
if (!PVD->hasDefaultArg() || PVD->hasUnparsedDefaultArg())
return nullptr;
return PVD->hasUninstantiatedDefaultArg() ? PVD->getUninstantiatedDefaultArg()
: PVD->getDefaultArg();
}
HoverInfo::Param toHoverInfoParam(const ParmVarDecl *PVD,
const PrintingPolicy &PP) {
HoverInfo::Param Out;
Out.Type = printType(PVD->getType(), PVD->getASTContext(), PP);
if (!PVD->getName().empty())
Out.Name = PVD->getNameAsString();
if (const Expr *DefArg = getDefaultArg(PVD)) {
Out.Default.emplace();
llvm::raw_string_ostream OS(*Out.Default);
DefArg->printPretty(OS, nullptr, PP);
}
return Out;
}
// Populates Type, ReturnType, and Parameters for function-like decls.
void fillFunctionTypeAndParams(HoverInfo &HI, const Decl *D,
const FunctionDecl *FD,
const PrintingPolicy &PP) {
HI.Parameters.emplace();
for (const ParmVarDecl *PVD : FD->parameters())
HI.Parameters->emplace_back(toHoverInfoParam(PVD, PP));
// We don't want any type info, if name already contains it. This is true for
// constructors/destructors and conversion operators.
const auto NK = FD->getDeclName().getNameKind();
if (NK == DeclarationName::CXXConstructorName ||
NK == DeclarationName::CXXDestructorName ||
NK == DeclarationName::CXXConversionFunctionName)
return;
HI.ReturnType = printType(FD->getReturnType(), FD->getASTContext(), PP);
QualType QT = FD->getType();
if (const VarDecl *VD = llvm::dyn_cast<VarDecl>(D)) // Lambdas
QT = VD->getType().getDesugaredType(D->getASTContext());
HI.Type = printType(QT, D->getASTContext(), PP);
// FIXME: handle variadics.
}
// Non-negative numbers are printed using min digits
// 0 => 0x0
// 100 => 0x64
// Negative numbers are sign-extended to 32/64 bits
// -2 => 0xfffffffe
// -2^32 => 0xffffffff00000000
static llvm::FormattedNumber printHex(const llvm::APSInt &V) {
assert(V.getSignificantBits() <= 64 && "Can't print more than 64 bits.");
uint64_t Bits =
V.getBitWidth() > 64 ? V.trunc(64).getZExtValue() : V.getZExtValue();
if (V.isNegative() && V.getSignificantBits() <= 32)
return llvm::format_hex(uint32_t(Bits), 0);
return llvm::format_hex(Bits, 0);
}
std::optional<std::string> printExprValue(const Expr *E,
const ASTContext &Ctx) {
// InitListExpr has two forms, syntactic and semantic. They are the same thing
// (refer to a same AST node) in most cases.
// When they are different, RAV returns the syntactic form, and we should feed
// the semantic form to EvaluateAsRValue.
if (const auto *ILE = llvm::dyn_cast<InitListExpr>(E)) {
if (!ILE->isSemanticForm())
E = ILE->getSemanticForm();
}
// Evaluating [[foo]]() as "&foo" isn't useful, and prevents us walking up
// to the enclosing call. Evaluating an expression of void type doesn't
// produce a meaningful result.
QualType T = E->getType();
if (T.isNull() || T->isFunctionType() || T->isFunctionPointerType() ||
T->isFunctionReferenceType() || T->isVoidType())
return std::nullopt;
Expr::EvalResult Constant;
// Attempt to evaluate. If expr is dependent, evaluation crashes!
if (E->isValueDependent() || !E->EvaluateAsRValue(Constant, Ctx) ||
// Disable printing for record-types, as they are usually confusing and
// might make clang crash while printing the expressions.
Constant.Val.isStruct() || Constant.Val.isUnion())
return std::nullopt;
// Show enums symbolically, not numerically like APValue::printPretty().
if (T->isEnumeralType() && Constant.Val.isInt() &&
Constant.Val.getInt().getSignificantBits() <= 64) {
// Compare to int64_t to avoid bit-width match requirements.
int64_t Val = Constant.Val.getInt().getExtValue();
for (const EnumConstantDecl *ECD :
T->castAs<EnumType>()->getDecl()->enumerators())
if (ECD->getInitVal() == Val)
return llvm::formatv("{0} ({1})", ECD->getNameAsString(),
printHex(Constant.Val.getInt()))
.str();
}
// Show hex value of integers if they're at least 10 (or negative!)
if (T->isIntegralOrEnumerationType() && Constant.Val.isInt() &&
Constant.Val.getInt().getSignificantBits() <= 64 &&
Constant.Val.getInt().uge(10))
return llvm::formatv("{0} ({1})", Constant.Val.getAsString(Ctx, T),
printHex(Constant.Val.getInt()))
.str();
return Constant.Val.getAsString(Ctx, T);
}
struct PrintExprResult {
/// The evaluation result on expression `Expr`.
std::optional<std::string> PrintedValue;
/// The Expr object that represents the closest evaluable
/// expression.
const clang::Expr *TheExpr;
/// The node of selection tree where the traversal stops.
const SelectionTree::Node *TheNode;
};
// Seek the closest evaluable expression along the ancestors of node N
// in a selection tree. If a node in the path can be converted to an evaluable
// Expr, a possible evaluation would happen and the associated context
// is returned.
// If evaluation couldn't be done, return the node where the traversal ends.
PrintExprResult printExprValue(const SelectionTree::Node *N,
const ASTContext &Ctx) {
for (; N; N = N->Parent) {
// Try to evaluate the first evaluatable enclosing expression.
if (const Expr *E = N->ASTNode.get<Expr>()) {
// Once we cross an expression of type 'cv void', the evaluated result
// has nothing to do with our original cursor position.
if (!E->getType().isNull() && E->getType()->isVoidType())
break;
if (auto Val = printExprValue(E, Ctx))
return PrintExprResult{/*PrintedValue=*/std::move(Val), /*Expr=*/E,
/*Node=*/N};
} else if (N->ASTNode.get<Decl>() || N->ASTNode.get<Stmt>()) {
// Refuse to cross certain non-exprs. (TypeLoc are OK as part of Exprs).
// This tries to ensure we're showing a value related to the cursor.
break;
}
}
return PrintExprResult{/*PrintedValue=*/std::nullopt, /*Expr=*/nullptr,
/*Node=*/N};
}
std::optional<StringRef> fieldName(const Expr *E) {
const auto *ME = llvm::dyn_cast<MemberExpr>(E->IgnoreCasts());
if (!ME || !llvm::isa<CXXThisExpr>(ME->getBase()->IgnoreCasts()))
return std::nullopt;
const auto *Field = llvm::dyn_cast<FieldDecl>(ME->getMemberDecl());
if (!Field || !Field->getDeclName().isIdentifier())
return std::nullopt;
return Field->getDeclName().getAsIdentifierInfo()->getName();
}
// If CMD is of the form T foo() { return FieldName; } then returns "FieldName".
std::optional<StringRef> getterVariableName(const CXXMethodDecl *CMD) {
assert(CMD->hasBody());
if (CMD->getNumParams() != 0 || CMD->isVariadic())
return std::nullopt;
const auto *Body = llvm::dyn_cast<CompoundStmt>(CMD->getBody());
const auto *OnlyReturn = (Body && Body->size() == 1)
? llvm::dyn_cast<ReturnStmt>(Body->body_front())
: nullptr;
if (!OnlyReturn || !OnlyReturn->getRetValue())
return std::nullopt;
return fieldName(OnlyReturn->getRetValue());
}
// If CMD is one of the forms:
// void foo(T arg) { FieldName = arg; }
// R foo(T arg) { FieldName = arg; return *this; }
// void foo(T arg) { FieldName = std::move(arg); }
// R foo(T arg) { FieldName = std::move(arg); return *this; }
// then returns "FieldName"
std::optional<StringRef> setterVariableName(const CXXMethodDecl *CMD) {
assert(CMD->hasBody());
if (CMD->isConst() || CMD->getNumParams() != 1 || CMD->isVariadic())
return std::nullopt;
const ParmVarDecl *Arg = CMD->getParamDecl(0);
if (Arg->isParameterPack())
return std::nullopt;
const auto *Body = llvm::dyn_cast<CompoundStmt>(CMD->getBody());
if (!Body || Body->size() == 0 || Body->size() > 2)
return std::nullopt;
// If the second statement exists, it must be `return this` or `return *this`.
if (Body->size() == 2) {
auto *Ret = llvm::dyn_cast<ReturnStmt>(Body->body_back());
if (!Ret || !Ret->getRetValue())
return std::nullopt;
const Expr *RetVal = Ret->getRetValue()->IgnoreCasts();
if (const auto *UO = llvm::dyn_cast<UnaryOperator>(RetVal)) {
if (UO->getOpcode() != UO_Deref)
return std::nullopt;
RetVal = UO->getSubExpr()->IgnoreCasts();
}
if (!llvm::isa<CXXThisExpr>(RetVal))
return std::nullopt;
}
// The first statement must be an assignment of the arg to a field.
const Expr *LHS, *RHS;
if (const auto *BO = llvm::dyn_cast<BinaryOperator>(Body->body_front())) {
if (BO->getOpcode() != BO_Assign)
return std::nullopt;
LHS = BO->getLHS();
RHS = BO->getRHS();
} else if (const auto *COCE =
llvm::dyn_cast<CXXOperatorCallExpr>(Body->body_front())) {
if (COCE->getOperator() != OO_Equal || COCE->getNumArgs() != 2)
return std::nullopt;
LHS = COCE->getArg(0);
RHS = COCE->getArg(1);
} else {
return std::nullopt;
}
// Detect the case when the item is moved into the field.
if (auto *CE = llvm::dyn_cast<CallExpr>(RHS->IgnoreCasts())) {
if (CE->getNumArgs() != 1)
return std::nullopt;
auto *ND = llvm::dyn_cast_or_null<NamedDecl>(CE->getCalleeDecl());
if (!ND || !ND->getIdentifier() || ND->getName() != "move" ||
!ND->isInStdNamespace())
return std::nullopt;
RHS = CE->getArg(0);
}
auto *DRE = llvm::dyn_cast<DeclRefExpr>(RHS->IgnoreCasts());
if (!DRE || DRE->getDecl() != Arg)
return std::nullopt;
return fieldName(LHS);
}
std::string synthesizeDocumentation(const NamedDecl *ND) {
if (const auto *CMD = llvm::dyn_cast<CXXMethodDecl>(ND)) {
// Is this an ordinary, non-static method whose definition is visible?
if (CMD->getDeclName().isIdentifier() && !CMD->isStatic() &&
(CMD = llvm::dyn_cast_or_null<CXXMethodDecl>(CMD->getDefinition())) &&
CMD->hasBody()) {
if (const auto GetterField = getterVariableName(CMD))
return llvm::formatv("Trivial accessor for `{0}`.", *GetterField);
if (const auto SetterField = setterVariableName(CMD))
return llvm::formatv("Trivial setter for `{0}`.", *SetterField);
}
}
return "";
}
/// Generate a \p Hover object given the declaration \p D.
HoverInfo getHoverContents(const NamedDecl *D, const PrintingPolicy &PP,
const SymbolIndex *Index,
const syntax::TokenBuffer &TB) {
HoverInfo HI;
auto &Ctx = D->getASTContext();
HI.AccessSpecifier = getAccessSpelling(D->getAccess()).str();
HI.NamespaceScope = getNamespaceScope(D);
if (!HI.NamespaceScope->empty())
HI.NamespaceScope->append("::");
HI.LocalScope = getLocalScope(D);
if (!HI.LocalScope.empty())
HI.LocalScope.append("::");
HI.Name = printName(Ctx, *D);
const auto *CommentD = getDeclForComment(D);
HI.Documentation = getDeclComment(Ctx, *CommentD);
enhanceFromIndex(HI, *CommentD, Index);
if (HI.Documentation.empty())
HI.Documentation = synthesizeDocumentation(D);
HI.Kind = index::getSymbolInfo(D).Kind;
// Fill in template params.
if (const TemplateDecl *TD = D->getDescribedTemplate()) {
HI.TemplateParameters =
fetchTemplateParameters(TD->getTemplateParameters(), PP);
D = TD;
} else if (const FunctionDecl *FD = D->getAsFunction()) {
if (const auto *FTD = FD->getDescribedTemplate()) {
HI.TemplateParameters =
fetchTemplateParameters(FTD->getTemplateParameters(), PP);
D = FTD;
}
}
// Fill in types and params.
if (const FunctionDecl *FD = getUnderlyingFunction(D))
fillFunctionTypeAndParams(HI, D, FD, PP);
else if (const auto *VD = dyn_cast<ValueDecl>(D))
HI.Type = printType(VD->getType(), Ctx, PP);
else if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(D))
HI.Type = TTP->wasDeclaredWithTypename() ? "typename" : "class";
else if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(D))
HI.Type = printType(TTP, PP);
else if (const auto *VT = dyn_cast<VarTemplateDecl>(D))
HI.Type = printType(VT->getTemplatedDecl()->getType(), Ctx, PP);
else if (const auto *TN = dyn_cast<TypedefNameDecl>(D))
HI.Type = printType(TN->getUnderlyingType().getDesugaredType(Ctx), Ctx, PP);
else if (const auto *TAT = dyn_cast<TypeAliasTemplateDecl>(D))
HI.Type = printType(TAT->getTemplatedDecl()->getUnderlyingType(), Ctx, PP);
// Fill in value with evaluated initializer if possible.
if (const auto *Var = dyn_cast<VarDecl>(D); Var && !Var->isInvalidDecl()) {
if (const Expr *Init = Var->getInit())
HI.Value = printExprValue(Init, Ctx);
} else if (const auto *ECD = dyn_cast<EnumConstantDecl>(D)) {
// Dependent enums (e.g. nested in template classes) don't have values yet.
if (!ECD->getType()->isDependentType())
HI.Value = toString(ECD->getInitVal(), 10);
}
HI.Definition = printDefinition(D, PP, TB);
return HI;
}
/// The standard defines __func__ as a "predefined variable".
std::optional<HoverInfo>
getPredefinedExprHoverContents(const PredefinedExpr &PE, ASTContext &Ctx,
const PrintingPolicy &PP) {
HoverInfo HI;
HI.Name = PE.getIdentKindName();
HI.Kind = index::SymbolKind::Variable;
HI.Documentation = "Name of the current function (predefined variable)";
if (const StringLiteral *Name = PE.getFunctionName()) {
HI.Value.emplace();
llvm::raw_string_ostream OS(*HI.Value);
Name->outputString(OS);
HI.Type = printType(Name->getType(), Ctx, PP);
} else {
// Inside templates, the approximate type `const char[]` is still useful.
QualType StringType = Ctx.getIncompleteArrayType(Ctx.CharTy.withConst(),
ArraySizeModifier::Normal,
/*IndexTypeQuals=*/0);
HI.Type = printType(StringType, Ctx, PP);
}
return HI;
}
HoverInfo evaluateMacroExpansion(unsigned int SpellingBeginOffset,
unsigned int SpellingEndOffset,
llvm::ArrayRef<syntax::Token> Expanded,
ParsedAST &AST) {
auto &Context = AST.getASTContext();
auto &Tokens = AST.getTokens();
auto PP = getPrintingPolicy(Context.getPrintingPolicy());
auto Tree = SelectionTree::createRight(Context, Tokens, SpellingBeginOffset,
SpellingEndOffset);
// If macro expands to one single token, rule out punctuator or digraph.
// E.g., for the case `array L_BRACKET 42 R_BRACKET;` where L_BRACKET and
// R_BRACKET expand to
// '[' and ']' respectively, we don't want the type of
// 'array[42]' when user hovers on L_BRACKET.
if (Expanded.size() == 1)
if (tok::getPunctuatorSpelling(Expanded[0].kind()))
return {};
auto *StartNode = Tree.commonAncestor();
if (!StartNode)
return {};
// If the common ancestor is partially selected, do evaluate if it has no
// children, thus we can disallow evaluation on incomplete expression.
// For example,
// #define PLUS_2 +2
// 40 PL^US_2
// In this case we don't want to present 'value: 2' as PLUS_2 actually expands
// to a non-value rather than a binary operand.
if (StartNode->Selected == SelectionTree::Selection::Partial)
if (!StartNode->Children.empty())
return {};
HoverInfo HI;
// Attempt to evaluate it from Expr first.
auto ExprResult = printExprValue(StartNode, Context);
HI.Value = std::move(ExprResult.PrintedValue);
if (auto *E = ExprResult.TheExpr)
HI.Type = printType(E->getType(), Context, PP);
// If failed, extract the type from Decl if possible.
if (!HI.Value && !HI.Type && ExprResult.TheNode)
if (auto *VD = ExprResult.TheNode->ASTNode.get<VarDecl>())
HI.Type = printType(VD->getType(), Context, PP);
return HI;
}
/// Generate a \p Hover object given the macro \p MacroDecl.
HoverInfo getHoverContents(const DefinedMacro &Macro, const syntax::Token &Tok,
ParsedAST &AST) {
HoverInfo HI;
SourceManager &SM = AST.getSourceManager();
HI.Name = std::string(Macro.Name);
HI.Kind = index::SymbolKind::Macro;
// FIXME: Populate documentation
// FIXME: Populate parameters
// Try to get the full definition, not just the name
SourceLocation StartLoc = Macro.Info->getDefinitionLoc();
SourceLocation EndLoc = Macro.Info->getDefinitionEndLoc();
// Ensure that EndLoc is a valid offset. For example it might come from
// preamble, and source file might've changed, in such a scenario EndLoc still
// stays valid, but getLocForEndOfToken will fail as it is no longer a valid
// offset.
// Note that this check is just to ensure there's text data inside the range.
// It will still succeed even when the data inside the range is irrelevant to
// macro definition.
if (SM.getPresumedLoc(EndLoc, /*UseLineDirectives=*/false).isValid()) {
EndLoc = Lexer::getLocForEndOfToken(EndLoc, 0, SM, AST.getLangOpts());
bool Invalid;
StringRef Buffer = SM.getBufferData(SM.getFileID(StartLoc), &Invalid);
if (!Invalid) {
unsigned StartOffset = SM.getFileOffset(StartLoc);
unsigned EndOffset = SM.getFileOffset(EndLoc);
if (EndOffset <= Buffer.size() && StartOffset < EndOffset)
HI.Definition =
("#define " + Buffer.substr(StartOffset, EndOffset - StartOffset))
.str();
}
}
if (auto Expansion = AST.getTokens().expansionStartingAt(&Tok)) {
// We drop expansion that's longer than the threshold.
// For extremely long expansion text, it's not readable from hover card
// anyway.
std::string ExpansionText;
for (const auto &ExpandedTok : Expansion->Expanded) {
ExpansionText += ExpandedTok.text(SM);
ExpansionText += " ";
if (ExpansionText.size() > 2048) {
ExpansionText.clear();
break;
}
}
if (!ExpansionText.empty()) {
if (!HI.Definition.empty()) {
HI.Definition += "\n\n";
}
HI.Definition += "// Expands to\n";
HI.Definition += ExpansionText;
}
auto Evaluated = evaluateMacroExpansion(
/*SpellingBeginOffset=*/SM.getFileOffset(Tok.location()),
/*SpellingEndOffset=*/SM.getFileOffset(Tok.endLocation()),
/*Expanded=*/Expansion->Expanded, AST);
HI.Value = std::move(Evaluated.Value);
HI.Type = std::move(Evaluated.Type);
}
return HI;
}
std::string typeAsDefinition(const HoverInfo::PrintedType &PType) {
std::string Result;
llvm::raw_string_ostream OS(Result);
OS << PType.Type;
if (PType.AKA)
OS << " // aka: " << *PType.AKA;
OS.flush();
return Result;
}
std::optional<HoverInfo> getThisExprHoverContents(const CXXThisExpr *CTE,
ASTContext &ASTCtx,
const PrintingPolicy &PP) {
QualType OriginThisType = CTE->getType()->getPointeeType();
QualType ClassType = declaredType(OriginThisType->getAsTagDecl());
// For partial specialization class, origin `this` pointee type will be
// parsed as `InjectedClassNameType`, which will ouput template arguments
// like "type-parameter-0-0". So we retrieve user written class type in this
// case.
QualType PrettyThisType = ASTCtx.getPointerType(
QualType(ClassType.getTypePtr(), OriginThisType.getCVRQualifiers()));
HoverInfo HI;
HI.Name = "this";
HI.Definition = typeAsDefinition(printType(PrettyThisType, ASTCtx, PP));
return HI;
}
/// Generate a HoverInfo object given the deduced type \p QT
HoverInfo getDeducedTypeHoverContents(QualType QT, const syntax::Token &Tok,
ASTContext &ASTCtx,
const PrintingPolicy &PP,
const SymbolIndex *Index) {
HoverInfo HI;
// FIXME: distinguish decltype(auto) vs decltype(expr)
HI.Name = tok::getTokenName(Tok.kind());
HI.Kind = index::SymbolKind::TypeAlias;
if (QT->isUndeducedAutoType()) {
HI.Definition = "/* not deduced */";
} else {
HI.Definition = typeAsDefinition(printType(QT, ASTCtx, PP));
if (const auto *D = QT->getAsTagDecl()) {
const auto *CommentD = getDeclForComment(D);
HI.Documentation = getDeclComment(ASTCtx, *CommentD);
enhanceFromIndex(HI, *CommentD, Index);
}
}
return HI;
}
HoverInfo getStringLiteralContents(const StringLiteral *SL,
const PrintingPolicy &PP) {
HoverInfo HI;
HI.Name = "string-literal";
HI.Size = (SL->getLength() + 1) * SL->getCharByteWidth() * 8;
HI.Type = SL->getType().getAsString(PP).c_str();
return HI;
}
bool isLiteral(const Expr *E) {
// Unfortunately there's no common base Literal classes inherits from
// (apart from Expr), therefore these exclusions.
return llvm::isa<CompoundLiteralExpr>(E) ||
llvm::isa<CXXBoolLiteralExpr>(E) ||
llvm::isa<CXXNullPtrLiteralExpr>(E) ||
llvm::isa<FixedPointLiteral>(E) || llvm::isa<FloatingLiteral>(E) ||
llvm::isa<ImaginaryLiteral>(E) || llvm::isa<IntegerLiteral>(E) ||
llvm::isa<StringLiteral>(E) || llvm::isa<UserDefinedLiteral>(E);
}
llvm::StringLiteral getNameForExpr(const Expr *E) {
// FIXME: Come up with names for `special` expressions.
//
// It's an known issue for GCC5, https://godbolt.org/z/Z_tbgi. Work around
// that by using explicit conversion constructor.
//
// TODO: Once GCC5 is fully retired and not the minimal requirement as stated
// in `GettingStarted`, please remove the explicit conversion constructor.
return llvm::StringLiteral("expression");
}
void maybeAddCalleeArgInfo(const SelectionTree::Node *N, HoverInfo &HI,
const PrintingPolicy &PP);
// Generates hover info for `this` and evaluatable expressions.
// FIXME: Support hover for literals (esp user-defined)
std::optional<HoverInfo> getHoverContents(const SelectionTree::Node *N,
const Expr *E, ParsedAST &AST,
const PrintingPolicy &PP,
const SymbolIndex *Index) {
std::optional<HoverInfo> HI;
if (const StringLiteral *SL = dyn_cast<StringLiteral>(E)) {
// Print the type and the size for string literals
HI = getStringLiteralContents(SL, PP);
} else if (isLiteral(E)) {
// There's not much value in hovering over "42" and getting a hover card
// saying "42 is an int", similar for most other literals.
// However, if we have CalleeArgInfo, it's still useful to show it.
maybeAddCalleeArgInfo(N, HI.emplace(), PP);
if (HI->CalleeArgInfo) {
// FIXME Might want to show the expression's value here instead?
// E.g. if the literal is in hex it might be useful to show the decimal
// value here.
HI->Name = "literal";
return HI;
}
return std::nullopt;
}
// For `this` expr we currently generate hover with pointee type.
if (const CXXThisExpr *CTE = dyn_cast<CXXThisExpr>(E))
HI = getThisExprHoverContents(CTE, AST.getASTContext(), PP);
if (const PredefinedExpr *PE = dyn_cast<PredefinedExpr>(E))
HI = getPredefinedExprHoverContents(*PE, AST.getASTContext(), PP);
// For expressions we currently print the type and the value, iff it is
// evaluatable.
if (auto Val = printExprValue(E, AST.getASTContext())) {
HI.emplace();
HI->Type = printType(E->getType(), AST.getASTContext(), PP);
HI->Value = *Val;
HI->Name = std::string(getNameForExpr(E));
}
if (HI)
maybeAddCalleeArgInfo(N, *HI, PP);
return HI;
}
// Generates hover info for attributes.
std::optional<HoverInfo> getHoverContents(const Attr *A, ParsedAST &AST) {
HoverInfo HI;
HI.Name = A->getSpelling();
if (A->hasScope())
HI.LocalScope = A->getScopeName()->getName().str();
{
llvm::raw_string_ostream OS(HI.Definition);
A->printPretty(OS, AST.getASTContext().getPrintingPolicy());
}
HI.Documentation = Attr::getDocumentation(A->getKind()).str();
return HI;
}
bool isParagraphBreak(llvm::StringRef Rest) {
return Rest.ltrim(" \t").starts_with("\n");
}
bool punctuationIndicatesLineBreak(llvm::StringRef Line) {
constexpr llvm::StringLiteral Punctuation = R"txt(.:,;!?)txt";
Line = Line.rtrim();
return !Line.empty() && Punctuation.contains(Line.back());
}
bool isHardLineBreakIndicator(llvm::StringRef Rest) {
// '-'/'*' md list, '@'/'\' documentation command, '>' md blockquote,
// '#' headings, '`' code blocks
constexpr llvm::StringLiteral LinebreakIndicators = R"txt(-*@\>#`)txt";
Rest = Rest.ltrim(" \t");
if (Rest.empty())
return false;
if (LinebreakIndicators.contains(Rest.front()))
return true;
if (llvm::isDigit(Rest.front())) {
llvm::StringRef AfterDigit = Rest.drop_while(llvm::isDigit);
if (AfterDigit.starts_with(".") || AfterDigit.starts_with(")"))
return true;
}
return false;
}
bool isHardLineBreakAfter(llvm::StringRef Line, llvm::StringRef Rest) {
// Should we also consider whether Line is short?
return punctuationIndicatesLineBreak(Line) || isHardLineBreakIndicator(Rest);
}
void addLayoutInfo(const NamedDecl &ND, HoverInfo &HI) {
if (ND.isInvalidDecl())
return;
const auto &Ctx = ND.getASTContext();
if (auto *RD = llvm::dyn_cast<RecordDecl>(&ND)) {
if (auto Size = Ctx.getTypeSizeInCharsIfKnown(RD->getTypeForDecl()))
HI.Size = Size->getQuantity() * 8;
if (!RD->isDependentType() && RD->isCompleteDefinition())
HI.Align = Ctx.getTypeAlign(RD->getTypeForDecl());
return;
}
if (const auto *FD = llvm::dyn_cast<FieldDecl>(&ND)) {
const auto *Record = FD->getParent();
if (Record)
Record = Record->getDefinition();
if (Record && !Record->isInvalidDecl() && !Record->isDependentType()) {
HI.Align = Ctx.getTypeAlign(FD->getType());
const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(Record);
HI.Offset = Layout.getFieldOffset(FD->getFieldIndex());
if (FD->isBitField())
HI.Size = FD->getBitWidthValue(Ctx);
else if (auto Size = Ctx.getTypeSizeInCharsIfKnown(FD->getType()))
HI.Size = FD->isZeroSize(Ctx) ? 0 : Size->getQuantity() * 8;
if (HI.Size) {
unsigned EndOfField = *HI.Offset + *HI.Size;
// Calculate padding following the field.
if (!Record->isUnion() &&
FD->getFieldIndex() + 1 < Layout.getFieldCount()) {
// Measure padding up to the next class field.
unsigned NextOffset = Layout.getFieldOffset(FD->getFieldIndex() + 1);
if (NextOffset >= EndOfField) // next field could be a bitfield!
HI.Padding = NextOffset - EndOfField;
} else {
// Measure padding up to the end of the object.
HI.Padding = Layout.getSize().getQuantity() * 8 - EndOfField;
}
}
// Offset in a union is always zero, so not really useful to report.
if (Record->isUnion())
HI.Offset.reset();
}
return;
}
}
HoverInfo::PassType::PassMode getPassMode(QualType ParmType) {
if (ParmType->isReferenceType()) {
if (ParmType->getPointeeType().isConstQualified())
return HoverInfo::PassType::ConstRef;
return HoverInfo::PassType::Ref;
}
return HoverInfo::PassType::Value;
}
// If N is passed as argument to a function, fill HI.CalleeArgInfo with
// information about that argument.
void maybeAddCalleeArgInfo(const SelectionTree::Node *N, HoverInfo &HI,
const PrintingPolicy &PP) {
const auto &OuterNode = N->outerImplicit();
if (!OuterNode.Parent)
return;
const FunctionDecl *FD = nullptr;
llvm::ArrayRef<const Expr *> Args;
if (const auto *CE = OuterNode.Parent->ASTNode.get<CallExpr>()) {
FD = CE->getDirectCallee();
Args = {CE->getArgs(), CE->getNumArgs()};
} else if (const auto *CE =
OuterNode.Parent->ASTNode.get<CXXConstructExpr>()) {
FD = CE->getConstructor();
Args = {CE->getArgs(), CE->getNumArgs()};
}
if (!FD)
return;
// For non-function-call-like operators (e.g. operator+, operator<<) it's
// not immediately obvious what the "passed as" would refer to and, given
// fixed function signature, the value would be very low anyway, so we choose
// to not support that.
// Both variadic functions and operator() (especially relevant for lambdas)
// should be supported in the future.
if (!FD || FD->isOverloadedOperator() || FD->isVariadic())
return;
HoverInfo::PassType PassType;
auto Parameters = resolveForwardingParameters(FD);
// Find argument index for N.
for (unsigned I = 0; I < Args.size() && I < Parameters.size(); ++I) {
if (Args[I] != OuterNode.ASTNode.get<Expr>())
continue;
// Extract matching argument from function declaration.
if (const ParmVarDecl *PVD = Parameters[I]) {
HI.CalleeArgInfo.emplace(toHoverInfoParam(PVD, PP));
if (N == &OuterNode)
PassType.PassBy = getPassMode(PVD->getType());
}
break;
}
if (!HI.CalleeArgInfo)
return;
// If we found a matching argument, also figure out if it's a
// [const-]reference. For this we need to walk up the AST from the arg itself
// to CallExpr and check all implicit casts, constructor calls, etc.
if (const auto *E = N->ASTNode.get<Expr>()) {
if (E->getType().isConstQualified())
PassType.PassBy = HoverInfo::PassType::ConstRef;
}
for (auto *CastNode = N->Parent;
CastNode != OuterNode.Parent && !PassType.Converted;
CastNode = CastNode->Parent) {
if (const auto *ImplicitCast = CastNode->ASTNode.get<ImplicitCastExpr>()) {
switch (ImplicitCast->getCastKind()) {
case CK_NoOp:
case CK_DerivedToBase:
case CK_UncheckedDerivedToBase:
// If it was a reference before, it's still a reference.
if (PassType.PassBy != HoverInfo::PassType::Value)
PassType.PassBy = ImplicitCast->getType().isConstQualified()
? HoverInfo::PassType::ConstRef
: HoverInfo::PassType::Ref;
break;
case CK_LValueToRValue:
case CK_ArrayToPointerDecay:
case CK_FunctionToPointerDecay:
case CK_NullToPointer:
case CK_NullToMemberPointer:
// No longer a reference, but we do not show this as type conversion.
PassType.PassBy = HoverInfo::PassType::Value;
break;
default:
PassType.PassBy = HoverInfo::PassType::Value;
PassType.Converted = true;
break;
}
} else if (const auto *CtorCall =
CastNode->ASTNode.get<CXXConstructExpr>()) {
// We want to be smart about copy constructors. They should not show up as
// type conversion, but instead as passing by value.
if (CtorCall->getConstructor()->isCopyConstructor())
PassType.PassBy = HoverInfo::PassType::Value;
else
PassType.Converted = true;
} else if (CastNode->ASTNode.get<MaterializeTemporaryExpr>()) {
// Can't bind a non-const-ref to a temporary, so has to be const-ref
PassType.PassBy = HoverInfo::PassType::ConstRef;
} else { // Unknown implicit node, assume type conversion.
PassType.PassBy = HoverInfo::PassType::Value;
PassType.Converted = true;
}
}
HI.CallPassType.emplace(PassType);
}
const NamedDecl *pickDeclToUse(llvm::ArrayRef<const NamedDecl *> Candidates) {
if (Candidates.empty())
return nullptr;
// This is e.g the case for
// namespace ns { void foo(); }
// void bar() { using ns::foo; f^oo(); }
// One declaration in Candidates will refer to the using declaration,
// which isn't really useful for Hover. So use the other one,
// which in this example would be the actual declaration of foo.
if (Candidates.size() <= 2) {
if (llvm::isa<UsingDecl>(Candidates.front()))
return Candidates.back();
return Candidates.front();
}
// For something like
// namespace ns { void foo(int); void foo(char); }
// using ns::foo;
// template <typename T> void bar() { fo^o(T{}); }
// we actually want to show the using declaration,
// it's not clear which declaration to pick otherwise.
auto BaseDecls = llvm::make_filter_range(
Candidates, [](const NamedDecl *D) { return llvm::isa<UsingDecl>(D); });
if (std::distance(BaseDecls.begin(), BaseDecls.end()) == 1)
return *BaseDecls.begin();
return Candidates.front();
}
void maybeAddSymbolProviders(ParsedAST &AST, HoverInfo &HI,
include_cleaner::Symbol Sym) {
trace::Span Tracer("Hover::maybeAddSymbolProviders");
const SourceManager &SM = AST.getSourceManager();
llvm::SmallVector<include_cleaner::Header> RankedProviders =
include_cleaner::headersForSymbol(Sym, SM, &AST.getPragmaIncludes());
if (RankedProviders.empty())
return;
std::string Result;
include_cleaner::Includes ConvertedIncludes = convertIncludes(AST);
for (const auto &P : RankedProviders) {
if (P.kind() == include_cleaner::Header::Physical &&
P.physical() == SM.getFileEntryForID(SM.getMainFileID()))
// Main file ranked higher than any #include'd file
break;
// Pick the best-ranked #include'd provider
auto Matches = ConvertedIncludes.match(P);
if (!Matches.empty()) {
Result = Matches[0]->quote();
break;
}
}
if (!Result.empty()) {
HI.Provider = std::move(Result);
return;
}
// Pick the best-ranked non-#include'd provider
const auto &H = RankedProviders.front();
if (H.kind() == include_cleaner::Header::Physical &&
H.physical() == SM.getFileEntryForID(SM.getMainFileID()))
// Do not show main file as provider, otherwise we'll show provider info
// on local variables, etc.
return;
HI.Provider = include_cleaner::spellHeader(
{H, AST.getPreprocessor().getHeaderSearchInfo(),
SM.getFileEntryForID(SM.getMainFileID())});
}
// FIXME: similar functions are present in FindHeaders.cpp (symbolName)
// and IncludeCleaner.cpp (getSymbolName). Introduce a name() method into
// include_cleaner::Symbol instead.
std::string getSymbolName(include_cleaner::Symbol Sym) {
std::string Name;
switch (Sym.kind()) {
case include_cleaner::Symbol::Declaration:
if (const auto *ND = llvm::dyn_cast<NamedDecl>(&Sym.declaration()))
Name = ND->getDeclName().getAsString();
break;
case include_cleaner::Symbol::Macro:
Name = Sym.macro().Name->getName();
break;
}
return Name;
}
void maybeAddUsedSymbols(ParsedAST &AST, HoverInfo &HI, const Inclusion &Inc) {
auto Converted = convertIncludes(AST);
llvm::DenseSet<include_cleaner::Symbol> UsedSymbols;
include_cleaner::walkUsed(
AST.getLocalTopLevelDecls(), collectMacroReferences(AST),
&AST.getPragmaIncludes(), AST.getPreprocessor(),
[&](const include_cleaner::SymbolReference &Ref,
llvm::ArrayRef<include_cleaner::Header> Providers) {
if (Ref.RT != include_cleaner::RefType::Explicit ||
UsedSymbols.contains(Ref.Target))
return;
if (isPreferredProvider(Inc, Converted, Providers))
UsedSymbols.insert(Ref.Target);
});
for (const auto &UsedSymbolDecl : UsedSymbols)
HI.UsedSymbolNames.push_back(getSymbolName(UsedSymbolDecl));
llvm::sort(HI.UsedSymbolNames);
HI.UsedSymbolNames.erase(
std::unique(HI.UsedSymbolNames.begin(), HI.UsedSymbolNames.end()),
HI.UsedSymbolNames.end());
}
} // namespace
std::optional<HoverInfo> getHover(ParsedAST &AST, Position Pos,
const format::FormatStyle &Style,
const SymbolIndex *Index) {
static constexpr trace::Metric HoverCountMetric(
"hover", trace::Metric::Counter, "case");
PrintingPolicy PP =
getPrintingPolicy(AST.getASTContext().getPrintingPolicy());
const SourceManager &SM = AST.getSourceManager();
auto CurLoc = sourceLocationInMainFile(SM, Pos);
if (!CurLoc) {
llvm::consumeError(CurLoc.takeError());
return std::nullopt;
}
const auto &TB = AST.getTokens();
auto TokensTouchingCursor = syntax::spelledTokensTouching(*CurLoc, TB);
// Early exit if there were no tokens around the cursor.
if (TokensTouchingCursor.empty())
return std::nullopt;
// Show full header file path if cursor is on include directive.
for (const auto &Inc : AST.getIncludeStructure().MainFileIncludes) {
if (Inc.Resolved.empty() || Inc.HashLine != Pos.line)
continue;
HoverCountMetric.record(1, "include");
HoverInfo HI;
HI.Name = std::string(llvm::sys::path::filename(Inc.Resolved));
// FIXME: We don't have a fitting value for Kind.
HI.Definition =
URIForFile::canonicalize(Inc.Resolved, AST.tuPath()).file().str();
HI.DefinitionLanguage = "";
maybeAddUsedSymbols(AST, HI, Inc);
return HI;
}
// To be used as a backup for highlighting the selected token, we use back as
// it aligns better with biases elsewhere (editors tend to send the position
// for the left of the hovered token).
CharSourceRange HighlightRange =
TokensTouchingCursor.back().range(SM).toCharRange(SM);
std::optional<HoverInfo> HI;
// Macros and deducedtype only works on identifiers and auto/decltype keywords
// respectively. Therefore they are only trggered on whichever works for them,
// similar to SelectionTree::create().
for (const auto &Tok : TokensTouchingCursor) {
if (Tok.kind() == tok::identifier) {
// Prefer the identifier token as a fallback highlighting range.
HighlightRange = Tok.range(SM).toCharRange(SM);
if (auto M = locateMacroAt(Tok, AST.getPreprocessor())) {
HoverCountMetric.record(1, "macro");
HI = getHoverContents(*M, Tok, AST);
if (auto DefLoc = M->Info->getDefinitionLoc(); DefLoc.isValid()) {
include_cleaner::Macro IncludeCleanerMacro{
AST.getPreprocessor().getIdentifierInfo(Tok.text(SM)), DefLoc};
maybeAddSymbolProviders(AST, *HI,
include_cleaner::Symbol{IncludeCleanerMacro});
}
break;
}
} else if (Tok.kind() == tok::kw_auto || Tok.kind() == tok::kw_decltype) {
HoverCountMetric.record(1, "keyword");
if (auto Deduced = getDeducedType(AST.getASTContext(), Tok.location())) {
HI = getDeducedTypeHoverContents(*Deduced, Tok, AST.getASTContext(), PP,
Index);
HighlightRange = Tok.range(SM).toCharRange(SM);
break;
}
// If we can't find interesting hover information for this
// auto/decltype keyword, return nothing to avoid showing
// irrelevant or incorrect informations.
return std::nullopt;
}
}
// If it wasn't auto/decltype or macro, look for decls and expressions.
if (!HI) {
auto Offset = SM.getFileOffset(*CurLoc);
// Editors send the position on the left of the hovered character.
// So our selection tree should be biased right. (Tested with VSCode).
SelectionTree ST =
SelectionTree::createRight(AST.getASTContext(), TB, Offset, Offset);
if (const SelectionTree::Node *N = ST.commonAncestor()) {
// FIXME: Fill in HighlightRange with range coming from N->ASTNode.
auto Decls = explicitReferenceTargets(N->ASTNode, DeclRelation::Alias,
AST.getHeuristicResolver());
if (const auto *DeclToUse = pickDeclToUse(Decls)) {
HoverCountMetric.record(1, "decl");
HI = getHoverContents(DeclToUse, PP, Index, TB);
// Layout info only shown when hovering on the field/class itself.
if (DeclToUse == N->ASTNode.get<Decl>())
addLayoutInfo(*DeclToUse, *HI);
// Look for a close enclosing expression to show the value of.
if (!HI->Value)
HI->Value = printExprValue(N, AST.getASTContext()).PrintedValue;
maybeAddCalleeArgInfo(N, *HI, PP);
if (!isa<NamespaceDecl>(DeclToUse))
maybeAddSymbolProviders(AST, *HI,
include_cleaner::Symbol{*DeclToUse});
} else if (const Expr *E = N->ASTNode.get<Expr>()) {
HoverCountMetric.record(1, "expr");
HI = getHoverContents(N, E, AST, PP, Index);
} else if (const Attr *A = N->ASTNode.get<Attr>()) {
HoverCountMetric.record(1, "attribute");
HI = getHoverContents(A, AST);
}
// FIXME: support hovers for other nodes?
// - built-in types
}
}
if (!HI)
return std::nullopt;
// Reformat Definition
if (!HI->Definition.empty()) {
auto Replacements = format::reformat(
Style, HI->Definition, tooling::Range(0, HI->Definition.size()));
if (auto Formatted =
tooling::applyAllReplacements(HI->Definition, Replacements))
HI->Definition = *Formatted;
}
HI->DefinitionLanguage = getMarkdownLanguage(AST.getASTContext());
HI->SymRange = halfOpenToRange(SM, HighlightRange);
return HI;
}
// Sizes (and padding) are shown in bytes if possible, otherwise in bits.
static std::string formatSize(uint64_t SizeInBits) {
uint64_t Value = SizeInBits % 8 == 0 ? SizeInBits / 8 : SizeInBits;
const char *Unit = Value != 0 && Value == SizeInBits ? "bit" : "byte";
return llvm::formatv("{0} {1}{2}", Value, Unit, Value == 1 ? "" : "s").str();
}
// Offsets are shown in bytes + bits, so offsets of different fields
// can always be easily compared.
static std::string formatOffset(uint64_t OffsetInBits) {
const auto Bytes = OffsetInBits / 8;
const auto Bits = OffsetInBits % 8;
auto Offset = formatSize(Bytes * 8);
if (Bits != 0)
Offset += " and " + formatSize(Bits);
return Offset;
}
markup::Document HoverInfo::present() const {
markup::Document Output;
// Header contains a text of the form:
// variable `var`
//
// class `X`
//
// function `foo`
//
// expression
//
// Note that we are making use of a level-3 heading because VSCode renders
// level 1 and 2 headers in a huge font, see
// https://github.com/microsoft/vscode/issues/88417 for details.
markup::Paragraph &Header = Output.addHeading(3);
if (Kind != index::SymbolKind::Unknown)
Header.appendText(index::getSymbolKindString(Kind)).appendSpace();
assert(!Name.empty() && "hover triggered on a nameless symbol");
Header.appendCode(Name);
if (!Provider.empty()) {
markup::Paragraph &DI = Output.addParagraph();
DI.appendText("provided by");
DI.appendSpace();
DI.appendCode(Provider);
Output.addRuler();
}
// Put a linebreak after header to increase readability.
Output.addRuler();
// Print Types on their own lines to reduce chances of getting line-wrapped by
// editor, as they might be long.
if (ReturnType) {
// For functions we display signature in a list form, e.g.:
// → `x`
// Parameters:
// - `bool param1`
// - `int param2 = 5`
Output.addParagraph().appendText("→ ").appendCode(
llvm::to_string(*ReturnType));
}
if (Parameters && !Parameters->empty()) {
Output.addParagraph().appendText("Parameters: ");
markup::BulletList &L = Output.addBulletList();
for (const auto &Param : *Parameters)
L.addItem().addParagraph().appendCode(llvm::to_string(Param));
}
// Don't print Type after Parameters or ReturnType as this will just duplicate
// the information
if (Type && !ReturnType && !Parameters)
Output.addParagraph().appendText("Type: ").appendCode(
llvm::to_string(*Type));
if (Value) {
markup::Paragraph &P = Output.addParagraph();
P.appendText("Value = ");
P.appendCode(*Value);
}
if (Offset)
Output.addParagraph().appendText("Offset: " + formatOffset(*Offset));
if (Size) {
auto &P = Output.addParagraph().appendText("Size: " + formatSize(*Size));
if (Padding && *Padding != 0) {
P.appendText(
llvm::formatv(" (+{0} padding)", formatSize(*Padding)).str());
}
if (Align)
P.appendText(", alignment " + formatSize(*Align));
}
if (CalleeArgInfo) {
assert(CallPassType);
std::string Buffer;
llvm::raw_string_ostream OS(Buffer);
OS << "Passed ";
if (CallPassType->PassBy != HoverInfo::PassType::Value) {
OS << "by ";
if (CallPassType->PassBy == HoverInfo::PassType::ConstRef)
OS << "const ";
OS << "reference ";
}
if (CalleeArgInfo->Name)
OS << "as " << CalleeArgInfo->Name;
else if (CallPassType->PassBy == HoverInfo::PassType::Value)
OS << "by value";
if (CallPassType->Converted && CalleeArgInfo->Type)
OS << " (converted to " << CalleeArgInfo->Type->Type << ")";
Output.addParagraph().appendText(OS.str());
}
if (!Documentation.empty())
parseDocumentation(Documentation, Output);
if (!Definition.empty()) {
Output.addRuler();
std::string Buffer;
if (!Definition.empty()) {
// Append scope comment, dropping trailing "::".
// Note that we don't print anything for global namespace, to not annoy
// non-c++ projects or projects that are not making use of namespaces.
if (!LocalScope.empty()) {
// Container name, e.g. class, method, function.
// We might want to propagate some info about container type to print
// function foo, class X, method X::bar, etc.
Buffer +=
"// In " + llvm::StringRef(LocalScope).rtrim(':').str() + '\n';
} else if (NamespaceScope && !NamespaceScope->empty()) {
Buffer += "// In namespace " +
llvm::StringRef(*NamespaceScope).rtrim(':').str() + '\n';
}
if (!AccessSpecifier.empty()) {
Buffer += AccessSpecifier + ": ";
}
Buffer += Definition;
}
Output.addCodeBlock(Buffer, DefinitionLanguage);
}
if (!UsedSymbolNames.empty()) {
Output.addRuler();
markup::Paragraph &P = Output.addParagraph();
P.appendText("provides ");
const std::vector<std::string>::size_type SymbolNamesLimit = 5;
auto Front = llvm::ArrayRef(UsedSymbolNames).take_front(SymbolNamesLimit);
llvm::interleave(
Front, [&](llvm::StringRef Sym) { P.appendCode(Sym); },
[&] { P.appendText(", "); });
if (UsedSymbolNames.size() > Front.size()) {
P.appendText(" and ");
P.appendText(std::to_string(UsedSymbolNames.size() - Front.size()));
P.appendText(" more");
}
}
return Output;
}
// If the backtick at `Offset` starts a probable quoted range, return the range
// (including the quotes).
std::optional<llvm::StringRef> getBacktickQuoteRange(llvm::StringRef Line,
unsigned Offset) {
assert(Line[Offset] == '`');
// The open-quote is usually preceded by whitespace.
llvm::StringRef Prefix = Line.substr(0, Offset);
constexpr llvm::StringLiteral BeforeStartChars = " \t(=";
if (!Prefix.empty() && !BeforeStartChars.contains(Prefix.back()))
return std::nullopt;
// The quoted string must be nonempty and usually has no leading/trailing ws.
auto Next = Line.find('`', Offset + 1);
if (Next == llvm::StringRef::npos)
return std::nullopt;
llvm::StringRef Contents = Line.slice(Offset + 1, Next);
if (Contents.empty() || isWhitespace(Contents.front()) ||
isWhitespace(Contents.back()))
return std::nullopt;
// The close-quote is usually followed by whitespace or punctuation.
llvm::StringRef Suffix = Line.substr(Next + 1);
constexpr llvm::StringLiteral AfterEndChars = " \t)=.,;:";
if (!Suffix.empty() && !AfterEndChars.contains(Suffix.front()))
return std::nullopt;
return Line.slice(Offset, Next + 1);
}
void parseDocumentationLine(llvm::StringRef Line, markup::Paragraph &Out) {
// Probably this is appendText(Line), but scan for something interesting.
for (unsigned I = 0; I < Line.size(); ++I) {
switch (Line[I]) {
case '`':
if (auto Range = getBacktickQuoteRange(Line, I)) {
Out.appendText(Line.substr(0, I));
Out.appendCode(Range->trim("`"), /*Preserve=*/true);
return parseDocumentationLine(Line.substr(I + Range->size()), Out);
}
break;
}
}
Out.appendText(Line).appendSpace();
}
void parseDocumentation(llvm::StringRef Input, markup::Document &Output) {
std::vector<llvm::StringRef> ParagraphLines;
auto FlushParagraph = [&] {
if (ParagraphLines.empty())
return;
auto &P = Output.addParagraph();
for (llvm::StringRef Line : ParagraphLines)
parseDocumentationLine(Line, P);
ParagraphLines.clear();
};
llvm::StringRef Line, Rest;
for (std::tie(Line, Rest) = Input.split('\n');
!(Line.empty() && Rest.empty());
std::tie(Line, Rest) = Rest.split('\n')) {
// After a linebreak remove spaces to avoid 4 space markdown code blocks.
// FIXME: make FlushParagraph handle this.
Line = Line.ltrim();
if (!Line.empty())
ParagraphLines.push_back(Line);
if (isParagraphBreak(Rest) || isHardLineBreakAfter(Line, Rest)) {
FlushParagraph();
}
}
FlushParagraph();
}
llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
const HoverInfo::PrintedType &T) {
OS << T.Type;
if (T.AKA)
OS << " (aka " << *T.AKA << ")";
return OS;
}
llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
const HoverInfo::Param &P) {
if (P.Type)
OS << P.Type->Type;
if (P.Name)
OS << " " << *P.Name;
if (P.Default)
OS << " = " << *P.Default;
if (P.Type && P.Type->AKA)
OS << " (aka " << *P.Type->AKA << ")";
return OS;
}
} // namespace clangd
} // namespace clang