llvm-project/clang/lib/Index/IndexSymbol.cpp

287 lines
9.6 KiB
C++

//===--- IndexSymbol.cpp - Types and functions for indexing symbols -------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "clang/Index/IndexSymbol.h"
#include "clang/AST/DeclCXX.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/DeclTemplate.h"
using namespace clang;
using namespace clang::index;
SymbolInfo index::getSymbolInfo(const Decl *D) {
assert(D);
SymbolInfo Info;
Info.Kind = SymbolKind::Unknown;
Info.TemplateKind = SymbolCXXTemplateKind::NonTemplate;
Info.Lang = SymbolLanguage::C;
if (const TagDecl *TD = dyn_cast<TagDecl>(D)) {
switch (TD->getTagKind()) {
case TTK_Struct:
Info.Kind = SymbolKind::Struct; break;
case TTK_Union:
Info.Kind = SymbolKind::Union; break;
case TTK_Class:
Info.Kind = SymbolKind::CXXClass;
Info.Lang = SymbolLanguage::CXX;
break;
case TTK_Interface:
Info.Kind = SymbolKind::CXXInterface;
Info.Lang = SymbolLanguage::CXX;
break;
case TTK_Enum:
Info.Kind = SymbolKind::Enum; break;
}
if (const CXXRecordDecl *CXXRec = dyn_cast<CXXRecordDecl>(D))
if (!CXXRec->isCLike())
Info.Lang = SymbolLanguage::CXX;
if (isa<ClassTemplatePartialSpecializationDecl>(D)) {
Info.TemplateKind = SymbolCXXTemplateKind::TemplatePartialSpecialization;
} else if (isa<ClassTemplateSpecializationDecl>(D)) {
Info.TemplateKind = SymbolCXXTemplateKind::TemplateSpecialization;
}
} else {
switch (D->getKind()) {
case Decl::Typedef:
Info.Kind = SymbolKind::Typedef; break;
case Decl::Function:
Info.Kind = SymbolKind::Function;
break;
case Decl::ParmVar:
Info.Kind = SymbolKind::Variable;
break;
case Decl::Var:
Info.Kind = SymbolKind::Variable;
if (isa<CXXRecordDecl>(D->getDeclContext())) {
Info.Kind = SymbolKind::CXXStaticVariable;
Info.Lang = SymbolLanguage::CXX;
}
break;
case Decl::Field:
Info.Kind = SymbolKind::Field;
if (const CXXRecordDecl *
CXXRec = dyn_cast<CXXRecordDecl>(D->getDeclContext())) {
if (!CXXRec->isCLike())
Info.Lang = SymbolLanguage::CXX;
}
break;
case Decl::EnumConstant:
Info.Kind = SymbolKind::EnumConstant; break;
case Decl::ObjCInterface:
case Decl::ObjCImplementation:
Info.Kind = SymbolKind::ObjCClass;
Info.Lang = SymbolLanguage::ObjC;
break;
case Decl::ObjCProtocol:
Info.Kind = SymbolKind::ObjCProtocol;
Info.Lang = SymbolLanguage::ObjC;
break;
case Decl::ObjCCategory:
case Decl::ObjCCategoryImpl:
Info.Kind = SymbolKind::ObjCCategory;
Info.Lang = SymbolLanguage::ObjC;
break;
case Decl::ObjCMethod:
if (cast<ObjCMethodDecl>(D)->isInstanceMethod())
Info.Kind = SymbolKind::ObjCInstanceMethod;
else
Info.Kind = SymbolKind::ObjCClassMethod;
Info.Lang = SymbolLanguage::ObjC;
break;
case Decl::ObjCProperty:
Info.Kind = SymbolKind::ObjCProperty;
Info.Lang = SymbolLanguage::ObjC;
break;
case Decl::ObjCIvar:
Info.Kind = SymbolKind::ObjCIvar;
Info.Lang = SymbolLanguage::ObjC;
break;
case Decl::Namespace:
Info.Kind = SymbolKind::CXXNamespace;
Info.Lang = SymbolLanguage::CXX;
break;
case Decl::NamespaceAlias:
Info.Kind = SymbolKind::CXXNamespaceAlias;
Info.Lang = SymbolLanguage::CXX;
break;
case Decl::CXXConstructor:
Info.Kind = SymbolKind::CXXConstructor;
Info.Lang = SymbolLanguage::CXX;
break;
case Decl::CXXDestructor:
Info.Kind = SymbolKind::CXXDestructor;
Info.Lang = SymbolLanguage::CXX;
break;
case Decl::CXXConversion:
Info.Kind = SymbolKind::CXXConversionFunction;
Info.Lang = SymbolLanguage::CXX;
break;
case Decl::CXXMethod: {
const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
if (MD->isStatic())
Info.Kind = SymbolKind::CXXStaticMethod;
else
Info.Kind = SymbolKind::CXXInstanceMethod;
Info.Lang = SymbolLanguage::CXX;
break;
}
case Decl::ClassTemplate:
Info.Kind = SymbolKind::CXXClass;
Info.TemplateKind = SymbolCXXTemplateKind::Template;
break;
case Decl::FunctionTemplate:
Info.Kind = SymbolKind::Function;
Info.TemplateKind = SymbolCXXTemplateKind::Template;
if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(
cast<FunctionTemplateDecl>(D)->getTemplatedDecl())) {
if (isa<CXXConstructorDecl>(MD))
Info.Kind = SymbolKind::CXXConstructor;
else if (isa<CXXDestructorDecl>(MD))
Info.Kind = SymbolKind::CXXDestructor;
else if (isa<CXXConversionDecl>(MD))
Info.Kind = SymbolKind::CXXConversionFunction;
else {
if (MD->isStatic())
Info.Kind = SymbolKind::CXXStaticMethod;
else
Info.Kind = SymbolKind::CXXInstanceMethod;
}
}
break;
case Decl::TypeAliasTemplate:
Info.Kind = SymbolKind::CXXTypeAlias;
Info.TemplateKind = SymbolCXXTemplateKind::Template;
break;
case Decl::TypeAlias:
Info.Kind = SymbolKind::CXXTypeAlias;
Info.Lang = SymbolLanguage::CXX;
break;
default:
break;
}
}
if (Info.Kind == SymbolKind::Unknown)
return Info;
if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
if (FD->getTemplatedKind() ==
FunctionDecl::TK_FunctionTemplateSpecialization)
Info.TemplateKind = SymbolCXXTemplateKind::TemplateSpecialization;
}
if (Info.TemplateKind != SymbolCXXTemplateKind::NonTemplate)
Info.Lang = SymbolLanguage::CXX;
return Info;
}
void index::applyForEachSymbolRole(SymbolRoleSet Roles,
llvm::function_ref<void(SymbolRole)> Fn) {
#define APPLY_FOR_ROLE(Role) \
if (Roles & (unsigned)SymbolRole::Role) \
Fn(SymbolRole::Role)
APPLY_FOR_ROLE(Declaration);
APPLY_FOR_ROLE(Definition);
APPLY_FOR_ROLE(Reference);
APPLY_FOR_ROLE(Read);
APPLY_FOR_ROLE(Write);
APPLY_FOR_ROLE(Call);
APPLY_FOR_ROLE(Dynamic);
APPLY_FOR_ROLE(AddressOf);
APPLY_FOR_ROLE(Implicit);
APPLY_FOR_ROLE(RelationChildOf);
APPLY_FOR_ROLE(RelationBaseOf);
APPLY_FOR_ROLE(RelationOverrideOf);
APPLY_FOR_ROLE(RelationReceivedBy);
#undef APPLY_FOR_ROLE
}
void index::printSymbolRoles(SymbolRoleSet Roles, raw_ostream &OS) {
bool VisitedOnce = false;
applyForEachSymbolRole(Roles, [&](SymbolRole Role) {
if (VisitedOnce)
OS << '/';
else
VisitedOnce = true;
switch (Role) {
case SymbolRole::Declaration: OS << "Decl"; break;
case SymbolRole::Definition: OS << "Def"; break;
case SymbolRole::Reference: OS << "Ref"; break;
case SymbolRole::Read: OS << "Read"; break;
case SymbolRole::Write: OS << "Writ"; break;
case SymbolRole::Call: OS << "Call"; break;
case SymbolRole::Dynamic: OS << "Dyn"; break;
case SymbolRole::AddressOf: OS << "Addr"; break;
case SymbolRole::Implicit: OS << "Impl"; break;
case SymbolRole::RelationChildOf: OS << "RelChild"; break;
case SymbolRole::RelationBaseOf: OS << "RelBase"; break;
case SymbolRole::RelationOverrideOf: OS << "RelOver"; break;
case SymbolRole::RelationReceivedBy: OS << "RelRec"; break;
}
});
}
StringRef index::getSymbolKindString(SymbolKind K) {
switch (K) {
case SymbolKind::Unknown: return "<unknown>";
case SymbolKind::Module: return "module";
case SymbolKind::Macro: return "macro";
case SymbolKind::Enum: return "enum";
case SymbolKind::Struct: return "struct";
case SymbolKind::Union: return "union";
case SymbolKind::Typedef: return "typedef";
case SymbolKind::Function: return "function";
case SymbolKind::Variable: return "variable";
case SymbolKind::Field: return "field";
case SymbolKind::EnumConstant: return "enumerator";
case SymbolKind::ObjCClass: return "objc-class";
case SymbolKind::ObjCProtocol: return "objc-protocol";
case SymbolKind::ObjCCategory: return "objc-category";
case SymbolKind::ObjCInstanceMethod: return "objc-instance-method";
case SymbolKind::ObjCClassMethod: return "objc-class-method";
case SymbolKind::ObjCProperty: return "objc-property";
case SymbolKind::ObjCIvar: return "objc-ivar";
case SymbolKind::CXXClass: return "c++-class";
case SymbolKind::CXXNamespace: return "namespace";
case SymbolKind::CXXNamespaceAlias: return "namespace-alias";
case SymbolKind::CXXStaticVariable: return "c++-static-var";
case SymbolKind::CXXStaticMethod: return "c++-static-method";
case SymbolKind::CXXInstanceMethod: return "c++-instance-method";
case SymbolKind::CXXConstructor: return "constructor";
case SymbolKind::CXXDestructor: return "destructor";
case SymbolKind::CXXConversionFunction: return "coversion-func";
case SymbolKind::CXXTypeAlias: return "type-alias";
case SymbolKind::CXXInterface: return "c++-__interface";
}
}
StringRef index::getTemplateKindStr(SymbolCXXTemplateKind TK) {
switch (TK) {
case SymbolCXXTemplateKind::NonTemplate: return "NT";
case SymbolCXXTemplateKind::Template : return "T";
case SymbolCXXTemplateKind::TemplatePartialSpecialization : return "TPS";
case SymbolCXXTemplateKind::TemplateSpecialization: return "TS";
}
}
StringRef index::getSymbolLanguageString(SymbolLanguage K) {
switch (K) {
case SymbolLanguage::C: return "C";
case SymbolLanguage::ObjC: return "ObjC";
case SymbolLanguage::CXX: return "C++";
}
}