21#include "llvm/ADT/StringSwitch.h"
43 TL = AttrTL.getModifiedLoc();
61DeclarationFragments::appendUnduplicatedTextCharacter(
char Character) {
62 if (!Fragments.empty()) {
63 Fragment &
Last = Fragments.back();
67 if (
Last.Spelling.back() != Character) {
68 Last.Spelling.push_back(Character);
72 Fragments.back().Spelling.push_back(Character);
80 return appendUnduplicatedTextCharacter(
' ');
84 return appendUnduplicatedTextCharacter(
';');
88 if (Fragments.empty())
93 Last.Spelling.pop_back();
114 return "typeIdentifier";
116 return "genericParameter";
118 return "externalParam";
120 return "internalParam";
125 llvm_unreachable(
"Unhandled FragmentKind");
130 return llvm::StringSwitch<FragmentKind>(S)
136 .Case(
"typeIdentifier",
138 .Case(
"genericParameter",
149 switch (ExceptionSpec) {
182 llvm_unreachable(
"Unhandled exception specification");
190 else if (
Record->isUnion())
208 Fragments.
append(getFragmentsForNNS(NNS->
getPrefix(), Context, After));
231 Fragments.
append(Alias->getName(),
256 Fragments.
append(getFragmentsForType(
T, Context, After));
269 assert(
T &&
"invalid type");
286 Fragments.
append(getFragmentsForNNS(NNS, Context, After));
290 return Fragments.
append(getFragmentsForType(ET->desugar(), Context, After));
298 if (
const TypedefType *TypedefTy = dyn_cast<TypedefType>(
T)) {
301 std::string USR = TypedefResolver.getUSRForType(
QualType(
T, 0));
310 USR, TypedefResolver.getUnderlyingTypeDecl(
QualType(
T, 0)));
341 getFragmentsForType(LRT->getPointeeTypeAsWritten(), Context, After))
349 getFragmentsForType(RRT->getPointeeTypeAsWritten(), Context, After))
362 switch (AT->getSizeModifier()) {
379 CAT->getSize().toStringUnsigned(Size);
386 getFragmentsForType(AT->getElementType(), Context, After));
395 if (
const TagType *TagTy = dyn_cast<TagType>(
Base)) {
398 if (
Decl->getName().empty())
399 return Fragments.
append(
"{ ... }",
410 if (
const auto *ObjCIT = dyn_cast<ObjCInterfaceType>(
Base)) {
411 const auto *
Decl = ObjCIT->getDecl();
429DeclarationFragmentsBuilder::getFragmentsForQualifiers(
const Qualifiers Quals) {
443 assert(!QT.
isNull() &&
"invalid type");
445 if (
const ParenType *PT = dyn_cast<ParenType>(QT)) {
447 return getFragmentsForType(PT->getInnerType(), Context, After)
454 getFragmentsForType(SQT.
Ty, Context, After);
456 TypeFragments.replace(
"bool", 0);
459 return TypeFragments;
479 return TypeFragments.appendSpace().append(std::move(QualsFragments));
488 if (!
Decl->isAnonymousNamespace())
527 Fragments.
append(getFragmentsForBlock(Var, BlockLoc, BlockProtoLoc, After));
555 if (StringRef(ArgumentFragment.
begin()->Spelling)
556 .starts_with(
"type-parameter")) {
557 std::string ProperArgName =
T.getAsString();
558 ArgumentFragment.
begin()->Spelling.swap(ProperArgName);
560 Fragments.
append(std::move(ArgumentFragment))
568DeclarationFragmentsBuilder::getFragmentsForParam(
const ParmVarDecl *Param) {
579 findTypeLocForBlockDecl(TSInfo, BlockLoc, BlockProtoLoc);
584 getFragmentsForBlock(Param, BlockLoc, BlockProtoLoc, After));
588 if (StringRef(TypeFragments.
begin()->Spelling)
589 .starts_with(
"type-parameter")) {
591 TypeFragments.
begin()->Spelling.swap(ProperArgName);
596 .
append(std::move(TypeFragments))
602 Fragments.
append(std::move(TypeFragments));
608 .
append(std::move(After));
619 auto ReturnValueFragment = getFragmentsForType(
622 Fragments.
append(std::move(ReturnValueFragment))
623 .
append(std::move(RetTyAfter))
628 unsigned NumParams =
Block.getNumParams();
630 if (!BlockProto || NumParams == 0) {
637 for (
unsigned I = 0; I != NumParams; ++I) {
640 After.append(getFragmentsForParam(
Block.getParam(I)));
654 switch (
Func->getStorageClass()) {
668 llvm_unreachable(
"invalid for functions");
670 if (
Func->isConsteval())
673 else if (
Func->isConstexpr())
679 auto ReturnValueFragment =
680 getFragmentsForType(
Func->getReturnType(),
Func->getASTContext(), After);
681 if (StringRef(ReturnValueFragment.begin()->Spelling)
682 .starts_with(
"type-parameter")) {
683 std::string ProperArgName =
Func->getReturnType().getAsString();
684 ReturnValueFragment.begin()->Spelling.swap(ProperArgName);
687 Fragments.
append(std::move(ReturnValueFragment))
691 if (
Func->getTemplateSpecializationInfo()) {
694 for (
unsigned i = 0, end =
Func->getNumParams(); i != end; ++i) {
698 getFragmentsForType(
Func->getParamDecl(i)->getType(),
699 Func->getParamDecl(i)->getASTContext(), After));
703 Fragments.
append(std::move(After));
706 unsigned NumParams =
Func->getNumParams();
707 for (
unsigned i = 0; i != NumParams; ++i) {
710 Fragments.
append(getFragmentsForParam(
Func->getParamDecl(i)));
713 if (
Func->isVariadic()) {
721 Func->getExceptionSpecType()));
746 if (!IntegerType.
isNull())
751 .
append(std::move(After));
764 if (Field->isMutable())
769 getFragmentsForType(Field->getType(), Field->getASTContext(), After))
788 if (!
Record->getName().empty())
805 if (!
Record->getName().empty())
817 if (
const auto *Constructor = dyn_cast<CXXConstructorDecl>(Method)) {
819 if (Constructor->isExplicit())
822 }
else if (isa<CXXDestructorDecl>(Method))
827 .
append(std::move(After));
829 for (
unsigned i = 0, end = Method->
getNumParams(); i != end; ++i) {
845 StringRef Name = Method->
getName();
863 .
append(std::move(After));
865 for (
unsigned i = 0, end = Method->
getNumParams(); i != end; ++i) {
887 if (ConversionFunction->isExplicit())
895 .
append(ConversionFunction->getConversionType().getAsString(),
898 for (
unsigned i = 0, end = ConversionFunction->getNumParams(); i != end;
902 Fragments.
append(getFragmentsForParam(ConversionFunction->getParamDecl(i)));
906 if (ConversionFunction->isConst())
926 .
append(std::move(After));
928 for (
unsigned i = 0, end = Method->
getNumParams(); i != end; ++i) {
950 for (
unsigned i = 0, end = ParameterArray.size(); i != end; ++i) {
956 dyn_cast<TemplateTypeParmDecl>(ParameterArray[i]);
991 for (
unsigned i = 0, end = TemplateArguments.size(); i != end; ++i) {
996 std::string
Type = TemplateArguments[i].getAsType().getAsString();
999 getFragmentsForType(TemplateArguments[i].getAsType(), Context, After);
1001 if (StringRef(ArgumentFragment.
begin()->Spelling)
1002 .starts_with(
"type-parameter")) {
1003 std::string ProperArgName = TemplateArgumentLocs.value()[i]
1004 .getTypeSourceInfo()
1007 ArgumentFragment.
begin()->Spelling.swap(ProperArgName);
1009 Fragments.
append(std::move(ArgumentFragment));
1011 if (TemplateArguments[i].isPackExpansion())
1024 Concept->getTemplateParameters()->asArray()))
1028 .
append(Concept->getName().str(),
1044 if (isa<TypeAliasTemplateDecl>(RedeclarableTemplate))
1064 cast<CXXRecordDecl>(
Decl)))
1082 Decl->getTemplateParameters()->asArray()))
1086 cast<CXXRecordDecl>(
Decl)))
1091 Decl->getTemplateArgsAsWritten()->arguments()))
1124 Decl->getTemplateParameters()->asArray()))
1132 Decl->getTemplateArgsAsWritten()->arguments()))
1146 Decl->getTemplateParameters()->asArray()))
1174 if (MI->isFunctionLike()) {
1176 unsigned numParameters = MI->getNumParams();
1177 if (MI->isC99Varargs())
1179 for (
unsigned i = 0; i < numParameters; ++i) {
1182 Fragments.
append(MI->params()[i]->getName(),
1185 if (MI->isVariadic()) {
1186 if (numParameters && MI->isC99Varargs())
1230 .
append(SuperClass->getName(),
1251 .
append(std::move(After))
1264 for (
unsigned i = 0, end = Method->
param_size(); i != end; ++i) {
1270 ParamID.append(
":");
1276 Fragments.
append(getFragmentsForParam(Param));
1289 const auto Attributes =
Property->getPropertyAttributesAsWritten();
1296 auto RenderAttribute =
1302 if ((Attributes & Kind) && !Spelling.empty()) {
1307 Fragments.
append(Spelling,
1330 "unsafe_unretained");
1334 Property->getGetterName().getAsString());
1336 Property->getSetterName().getAsString());
1341 if (
const auto Nullability =
1347 Fragments.
append(
"null_resettable",
1364 findTypeLocForBlockDecl(
Property->getTypeSourceInfo(), BlockLoc,
1367 auto PropType =
Property->getType();
1370 .
append(getFragmentsForType(PropType,
Property->getASTContext(), After))
1374 getFragmentsForBlock(
Property, BlockLoc, BlockProtoLoc, After));
1379 .
append(std::move(After))
1389 .
append(Protocol->getName(),
1393 if (!Protocol->protocols().empty()) {
1396 It != Protocol->protocol_end(); It++) {
1398 if (It != Protocol->protocol_begin())
1403 Fragments.
append((*It)->getName(),
1418 .
append(getFragmentsForType(
Decl->getUnderlyingType(),
1420 .
append(std::move(After))
1439 if (isa<CXXConstructorDecl>(
Decl) || isa<CXXDestructorDecl>(
Decl))
1442 else if (isa<CXXConversionDecl>(
Decl)) {
1446 }
else if (isa<CXXMethodDecl>(
Decl) &&
1447 cast<CXXMethodDecl>(
Decl)->isOverloadedOperator()) {
1450 }
else if (!
Decl->getName().empty())
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate....
This file defines the Declaration Fragments related classes.
llvm::MachO::Record Record
Defines the clang::TypeLoc interface and its subclasses.
C Language Family Type Representation.
This file defines the UnderlyingTypeResolver which is a helper type for resolving the undelrying type...
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
QualType getUnqualifiedObjCPointerType(QualType type) const
getUnqualifiedObjCPointerType - Returns version of Objective-C pointer type with lifetime qualifier r...
Represents an array type, per C99 6.7.5.2 - Array Declarators.
Type source information for an attributed type.
static std::optional< NullabilityKind > stripOuterNullability(QualType &T)
Strip off the top-level nullability annotation on the given type, if it's there.
Represents a block literal declaration, which is like an unnamed FunctionDecl.
Wrapper for source info for block pointers.
Represents a C++ conversion function within a class.
Represents a static or instance method of a struct/union/class.
Represents a C++ struct/union/class.
Represents a class template specialization, which refers to a class template with a given set of temp...
Declaration of a C++20 concept.
Represents the canonical version of C arrays with a specified constant size.
Decl - This represents one declaration (or definition), e.g.
ASTContext & getASTContext() const LLVM_READONLY
FunctionDecl * getAsFunction() LLVM_READONLY
Returns the function itself, or the templated function if this is a function template.
DeclContext * getDeclContext()
TypeSourceInfo * getTypeSourceInfo() const
Represents a type that was referred to using an elaborated type keyword, e.g., struct S,...
An instance of this object exists for each enum constant that is defined.
QualType getIntegerType() const
Return the integer type this enum decl corresponds to.
Represents a member of a struct/union/class.
Represents a function declaration or definition.
const ParmVarDecl * getParamDecl(unsigned i) const
ExceptionSpecificationType getExceptionSpecType() const
Gets the ExceptionSpecificationType as declared.
QualType getReturnType() const
bool isConstexpr() const
Whether this is a (C++11) constexpr function or constexpr constructor.
unsigned getNumParams() const
Return the number of parameters this function must have based on its FunctionType.
bool isVariadic() const
Whether this function prototype is variadic.
Declaration of a template function.
Wrapper for source info for functions.
StringRef getName() const
Return the actual identifier string.
const TypeClass * getTypePtr() const
An lvalue reference type, per C++11 [dcl.ref].
Encapsulates changes to the "macros namespace" (the location where the macro name became active,...
const MacroInfo * getMacroInfo() const
This represents a decl that may have a name.
StringRef getName() const
Get the name of identifier for this declaration as a StringRef.
std::string getNameAsString() const
Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ c...
Represents a C++ namespace alias.
Represent a C++ namespace.
bool isAnonymousNamespace() const
Returns true if this is an anonymous namespace declaration.
Represents a C++ nested name specifier, such as "\::std::vector<int>::".
SpecifierKind getKind() const
Determine what kind of nested name specifier is stored.
NamespaceAliasDecl * getAsNamespaceAlias() const
Retrieve the namespace alias stored in this nested name specifier.
IdentifierInfo * getAsIdentifier() const
Retrieve the identifier stored in this nested name specifier.
NestedNameSpecifier * getPrefix() const
Return the prefix of this nested name specifier.
@ NamespaceAlias
A namespace alias, stored as a NamespaceAliasDecl*.
@ TypeSpec
A type, stored as a Type*.
@ TypeSpecWithTemplate
A type that was preceded by the 'template' keyword, stored as a Type*.
@ Super
Microsoft's '__super' specifier, stored as a CXXRecordDecl* of the class it appeared in.
@ Identifier
An identifier, stored as an IdentifierInfo*.
@ Global
The global specifier '::'. There is no stored value.
@ Namespace
A namespace, stored as a NamespaceDecl*.
NamespaceDecl * getAsNamespace() const
Retrieve the namespace stored in this nested name specifier.
const Type * getAsType() const
Retrieve the type stored in this nested name specifier.
ObjCCategoryDecl - Represents a category declaration.
Represents an ObjC class declaration.
ObjCMethodDecl - Represents an instance or class method declaration.
unsigned param_size() const
Selector getSelector() const
bool isInstanceMethod() const
ParmVarDecl * getParamDecl(unsigned Idx)
QualType getReturnType() const
bool isClassMethod() const
Represents a pointer to an Objective C object.
bool isObjCQualifiedIdType() const
True if this is equivalent to 'id.
bool isObjCIdOrClassType() const
True if this is equivalent to the 'id' or 'Class' type,.
Represents one property declaration in an Objective-C interface.
Represents an Objective-C protocol declaration.
ObjCProtocolList::iterator protocol_iterator
Sugar for parentheses used when specifying types.
Represents a parameter to a function.
bool isObjCMethodParameter() const
QualType getOriginalType() const
A (possibly-)qualified type.
bool isNull() const
Return true if this QualType doesn't point to a type yet.
SplitQualType split() const
Divides a QualType into its unqualified type and a set of local qualifiers.
static std::string getAsString(SplitQualType split, const PrintingPolicy &Policy)
Wrapper of type source information for a type with non-trivial direct qualifiers.
The collection of all-type qualifiers we support.
An rvalue reference type, per C++11 [dcl.ref].
Represents a struct/union/class.
Declaration of a redeclarable template.
Smart pointer class that efficiently represents Objective-C method names.
StringRef getNameForSlot(unsigned argIndex) const
Retrieve the name at a given position in the selector.
unsigned getNumArgs() const
Represents the declaration of a struct/union/class/enum.
TypedefNameDecl * getTypedefNameForAnonDecl() const
TemplateParameterList * getTemplateParameters() const
Get the list of template parameters.
ArrayRef< NamedDecl * > asArray()
Base wrapper for a particular "section" of type source info.
UnqualTypeLoc getUnqualifiedLoc() const
Skips past any qualifiers, if this is qualified.
T getAs() const
Convert to the specified TypeLoc type, returning a null TypeLoc if this TypeLoc is not of the desired...
TypeLoc IgnoreParens() const
A container of type source information.
TypeLoc getTypeLoc() const
Return the TypeLoc wrapper for the type source info.
QualType getType() const
Return the type wrapped by this type source info.
static StringRef getKeywordName(ElaboratedTypeKeyword Keyword)
The base class of the type hierarchy.
bool isBlockPointerType() const
bool isFunctionPointerType() const
bool isPointerType() const
CanQualType getCanonicalTypeUnqualified() const
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee.
bool isObjCIdType() const
const ArrayType * getAsArrayTypeUnsafe() const
A variant of getAs<> for array types which silently discards qualifiers from the outermost type.
bool isObjCObjectPointerType() const
bool isAnyPointerType() const
const T * getAs() const
Member-template getAs<specific type>'.
Base class for declarations which introduce a typedef-name.
Represents a variable declaration or definition.
bool isConstexpr() const
Whether this variable is (C++11) constexpr.
static const char * getStorageClassSpecifierString(StorageClass SC)
Return the string used to specify the storage class SC.
bool isStaticDataMember() const
Determines whether this is a static data member.
StorageClass getStorageClass() const
Returns the storage class as written in the source.
Represents a variable template specialization, which refers to a variable template with a given set o...
@ kind_nullability
Indicates that the nullability of the type was spelled with a property attribute rather than a type q...
@ After
Like System, but searched after the system directories.
bool generateUSRForType(QualType T, ASTContext &Ctx, SmallVectorImpl< char > &Buf)
Generates a USR for a type.
bool generateUSRForDecl(const Decl *D, SmallVectorImpl< char > &Buf)
Generate a USR for a Decl, including the USR prefix.
@ Unspecified
Whether values of this type can be null is (explicitly) unspecified.
StorageClass
Storage classes.
@ Property
The type of a property.
llvm::StringRef getNullabilitySpelling(NullabilityKind kind, bool isContextSensitive=false)
Retrieve the spelling of the given nullability kind.
const FunctionProtoType * T
llvm::StringRef getAsString(SyncScope S)
ElaboratedTypeKeyword
The elaboration keyword that precedes a qualified type name or introduces an elaborated-type-specifie...
@ Interface
The "__interface" keyword introduces the elaborated-type-specifier.
@ None
No keyword precedes the qualified type name.
ExceptionSpecificationType
The various types of exception specifications that exist in C++11.
@ EST_DependentNoexcept
noexcept(expression), value-dependent
@ EST_None
no exception specification
@ EST_BasicNoexcept
noexcept
@ EST_NoexceptFalse
noexcept(expression), evals to 'false'
@ EST_NoexceptTrue
noexcept(expression), evals to 'true'
@ EST_Dynamic
throw(T1, T2)
Diagnostic wrappers for TextAPI types for error reporting.
A std::pair-like structure for storing a qualified type split into its local qualifiers and its local...
const Type * Ty
The locally-unqualified type.
Qualifiers Quals
The local qualifiers.