24#include "llvm/ADT/StringSwitch.h"
25#include "llvm/Support/ErrorHandling.h"
26#include "llvm/Support/raw_ostream.h"
49 TL = AttrTL.getModifiedLoc();
67DeclarationFragments::appendUnduplicatedTextCharacter(
char Character) {
68 if (!Fragments.empty()) {
69 Fragment &
Last = Fragments.back();
73 if (
Last.Spelling.back() != Character) {
74 Last.Spelling.push_back(Character);
78 Fragments.back().Spelling.push_back(Character);
86 return appendUnduplicatedTextCharacter(
' ');
90 return appendUnduplicatedTextCharacter(
';');
94 if (Fragments.empty())
99 Last.Spelling.pop_back();
120 return "typeIdentifier";
122 return "genericParameter";
124 return "externalParam";
126 return "internalParam";
131 llvm_unreachable(
"Unhandled FragmentKind");
136 return llvm::StringSwitch<FragmentKind>(S)
142 .Case(
"typeIdentifier",
144 .Case(
"genericParameter",
155 switch (ExceptionSpec) {
188 llvm_unreachable(
"Unhandled exception specification");
196 else if (
Record->isUnion())
214 Fragments.
append(getFragmentsForNNS(NNS->
getPrefix(), Context, After));
237 Fragments.
append(Alias->getName(),
262 Fragments.
append(getFragmentsForType(
T, Context, After));
275 assert(
T &&
"invalid type");
292 Fragments.
append(getFragmentsForNNS(NNS, Context, After));
296 return Fragments.
append(getFragmentsForType(ET->desugar(), Context, After));
304 if (
const TypedefType *TypedefTy = dyn_cast<TypedefType>(
T)) {
307 std::string USR = TypedefResolver.getUSRForType(
QualType(
T, 0));
316 USR, TypedefResolver.getUnderlyingTypeDecl(
QualType(
T, 0)));
347 getFragmentsForType(LRT->getPointeeTypeAsWritten(), Context, After))
355 getFragmentsForType(RRT->getPointeeTypeAsWritten(), Context, After))
368 switch (AT->getSizeModifier()) {
385 CAT->getSize().toStringUnsigned(Size);
392 getFragmentsForType(AT->getElementType(), Context, After));
396 dyn_cast<TemplateSpecializationType>(
T)) {
397 const auto TemplName = TemplSpecTy->getTemplateName();
399 raw_string_ostream Stream(Str);
400 TemplName.print(Stream, Context.getPrintingPolicy(),
403 if (
const auto *TemplDecl = TemplName.getAsTemplateDecl())
410 TemplSpecTy->template_arguments(), Context, std::nullopt))
420 if (
const TagType *TagTy = dyn_cast<TagType>(
Base)) {
423 if (
Decl->getName().empty())
424 return Fragments.
append(
"{ ... }",
435 if (
const auto *ObjCIT = dyn_cast<ObjCInterfaceType>(
Base)) {
436 const auto *
Decl = ObjCIT->getDecl();
454DeclarationFragmentsBuilder::getFragmentsForQualifiers(
const Qualifiers Quals) {
468 assert(!QT.
isNull() &&
"invalid type");
470 if (
const ParenType *PT = dyn_cast<ParenType>(QT)) {
472 return getFragmentsForType(PT->getInnerType(), Context, After)
479 getFragmentsForType(SQT.
Ty, Context, After);
481 TypeFragments.replace(
"bool", 0);
484 return TypeFragments;
504 return TypeFragments.appendSpace().append(std::move(QualsFragments));
513 if (!
Decl->isAnonymousNamespace())
552 Fragments.
append(getFragmentsForBlock(Var, BlockLoc, BlockProtoLoc, After));
580 if (StringRef(ArgumentFragment.
begin()->Spelling)
581 .starts_with(
"type-parameter")) {
582 std::string ProperArgName =
T.getAsString();
583 ArgumentFragment.
begin()->Spelling.swap(ProperArgName);
585 Fragments.
append(std::move(ArgumentFragment))
593DeclarationFragmentsBuilder::getFragmentsForParam(
const ParmVarDecl *Param) {
604 findTypeLocForBlockDecl(TSInfo, BlockLoc, BlockProtoLoc);
609 getFragmentsForBlock(Param, BlockLoc, BlockProtoLoc, After));
613 if (StringRef(TypeFragments.
begin()->Spelling)
614 .starts_with(
"type-parameter")) {
616 TypeFragments.
begin()->Spelling.swap(ProperArgName);
621 .
append(std::move(TypeFragments))
627 Fragments.
append(std::move(TypeFragments));
633 .
append(std::move(After));
644 auto ReturnValueFragment = getFragmentsForType(
647 Fragments.
append(std::move(ReturnValueFragment))
648 .
append(std::move(RetTyAfter))
653 unsigned NumParams =
Block.getNumParams();
655 if (!BlockProto || NumParams == 0) {
662 for (
unsigned I = 0; I != NumParams; ++I) {
665 After.append(getFragmentsForParam(
Block.getParam(I)));
678 switch (
Func->getStorageClass()) {
692 llvm_unreachable(
"invalid for functions");
694 if (
Func->isConsteval())
697 else if (
Func->isConstexpr())
703 auto ReturnValueFragment =
704 getFragmentsForType(
Func->getReturnType(),
Func->getASTContext(), After);
705 if (StringRef(ReturnValueFragment.begin()->Spelling)
706 .starts_with(
"type-parameter")) {
707 std::string ProperArgName =
Func->getReturnType().getAsString();
708 ReturnValueFragment.begin()->Spelling.swap(ProperArgName);
711 Fragments.
append(std::move(ReturnValueFragment))
715 if (
Func->getTemplateSpecializationInfo()) {
718 for (
unsigned i = 0, end =
Func->getNumParams(); i != end; ++i) {
722 getFragmentsForType(
Func->getParamDecl(i)->getType(),
723 Func->getParamDecl(i)->getASTContext(), After));
727 Fragments.
append(std::move(After));
730 unsigned NumParams =
Func->getNumParams();
731 for (
unsigned i = 0; i != NumParams; ++i) {
734 Fragments.
append(getFragmentsForParam(
Func->getParamDecl(i)));
737 if (
Func->isVariadic()) {
745 Func->getExceptionSpecType()));
770 if (!IntegerType.
isNull())
775 .
append(std::move(After));
788 if (Field->isMutable())
793 getFragmentsForType(Field->getType(), Field->getASTContext(), After))
812 if (!
Record->getName().empty())
829 if (!
Record->getName().empty())
841 if (
const auto *Constructor = dyn_cast<CXXConstructorDecl>(Method)) {
843 if (Constructor->isExplicit())
846 }
else if (isa<CXXDestructorDecl>(Method))
851 .
append(std::move(After));
853 for (
unsigned i = 0, end = Method->
getNumParams(); i != end; ++i) {
869 StringRef Name = Method->
getName();
887 .
append(std::move(After));
889 for (
unsigned i = 0, end = Method->
getNumParams(); i != end; ++i) {
911 if (ConversionFunction->isExplicit())
919 .
append(ConversionFunction->getConversionType().getAsString(),
922 for (
unsigned i = 0, end = ConversionFunction->getNumParams(); i != end;
926 Fragments.
append(getFragmentsForParam(ConversionFunction->getParamDecl(i)));
930 if (ConversionFunction->isConst())
950 .
append(std::move(After));
952 for (
unsigned i = 0, end = Method->
getNumParams(); i != end; ++i) {
974 for (
unsigned i = 0, end = ParameterArray.size(); i != end; ++i) {
980 dyn_cast<TemplateTypeParmDecl>(ParameterArray[i])) {
988 Fragments.
append(
"typename",
1006 Fragments.
append(std::move(After));
1008 }
else if (
const auto *NTP =
1009 dyn_cast<NonTypeTemplateParmDecl>(ParameterArray[i])) {
1011 const auto TyFragments =
1012 getFragmentsForType(NTP->getType(), NTP->getASTContext(), After);
1013 Fragments.
append(std::move(TyFragments)).
append(std::move(After));
1015 if (NTP->isParameterPack())
1018 if (!NTP->getName().empty())
1023 if (NTP->hasDefaultArgument()) {
1025 raw_svector_ostream Output(ExprStr);
1026 NTP->getDefaultArgument()->printPretty(
1027 Output,
nullptr, NTP->getASTContext().getPrintingPolicy());
1031 }
else if (
const auto *TTP =
1032 dyn_cast<TemplateTemplateParmDecl>(ParameterArray[i])) {
1037 TTP->getTemplateParameters()->asArray()))
1040 .
append(TTP->wasDeclaredWithTypename() ?
"typename" :
"class",
1043 if (TTP->isParameterPack())
1046 if (!TTP->getName().empty())
1050 if (TTP->hasDefaultArgument()) {
1051 const auto Default = TTP->getDefaultArgument();
1072 for (
unsigned i = 0, end = TemplateArguments.size(); i != end; ++i) {
1077 const auto &CTA = TemplateArguments[i];
1078 switch (CTA.getKind()) {
1082 getFragmentsForType(CTA.getAsType(), Context, After);
1084 if (StringRef(ArgumentFragment.
begin()->Spelling)
1085 .starts_with(
"type-parameter")) {
1086 std::string ProperArgName = TemplateArgumentLocs.value()[i]
1087 .getTypeSourceInfo()
1090 ArgumentFragment.
begin()->Spelling.swap(ProperArgName);
1092 Fragments.
append(std::move(ArgumentFragment));
1096 const auto *VD = CTA.getAsDecl();
1099 Fragments.
append(VD->getNameAsString(),
1109 CTA.getAsIntegral().toString(Str);
1115 const auto SVTy = CTA.getStructuralValueType();
1116 Fragments.
append(CTA.getAsStructuralValue().getAsString(Context, SVTy),
1124 raw_string_ostream Stream(Str);
1125 CTA.getAsTemplate().print(Stream, Context.getPrintingPolicy());
1127 if (
const auto *TemplDecl =
1128 CTA.getAsTemplateOrTemplatePattern().getAsTemplateDecl())
1146 raw_svector_ostream Output(ExprStr);
1147 CTA.getAsExpr()->printPretty(Output,
nullptr,
1148 Context.getPrintingPolicy());
1168 Concept->getTemplateParameters()->asArray()))
1173 .
append(Concept->getName().str(),
1190 if (isa<TypeAliasTemplateDecl>(RedeclarableTemplate))
1211 cast<CXXRecordDecl>(
Decl)))
1230 Decl->getTemplateParameters()->asArray()))
1234 cast<CXXRecordDecl>(
Decl)))
1239 Decl->getTemplateArgsAsWritten()->arguments()))
1274 Decl->getTemplateParameters()->asArray()))
1282 Decl->getTemplateArgsAsWritten()->arguments()))
1297 Decl->getTemplateParameters()->asArray()))
1326 if (MI->isFunctionLike()) {
1328 unsigned numParameters = MI->getNumParams();
1329 if (MI->isC99Varargs())
1331 for (
unsigned i = 0; i < numParameters; ++i) {
1334 Fragments.
append(MI->params()[i]->getName(),
1337 if (MI->isVariadic()) {
1338 if (numParameters && MI->isC99Varargs())
1382 .
append(SuperClass->getName(),
1403 .
append(std::move(After))
1416 for (
unsigned i = 0, end = Method->
param_size(); i != end; ++i) {
1422 ParamID.append(
":");
1428 Fragments.
append(getFragmentsForParam(Param));
1441 const auto Attributes =
Property->getPropertyAttributesAsWritten();
1448 auto RenderAttribute =
1454 if ((Attributes & Kind) && !Spelling.empty()) {
1459 Fragments.
append(Spelling,
1482 "unsafe_unretained");
1486 Property->getGetterName().getAsString());
1488 Property->getSetterName().getAsString());
1493 if (
const auto Nullability =
1499 Fragments.
append(
"null_resettable",
1516 findTypeLocForBlockDecl(
Property->getTypeSourceInfo(), BlockLoc,
1519 auto PropType =
Property->getType();
1522 .
append(getFragmentsForType(PropType,
Property->getASTContext(), After))
1526 getFragmentsForBlock(
Property, BlockLoc, BlockProtoLoc, After));
1531 .
append(std::move(After))
1541 .
append(Protocol->getName(),
1545 if (!Protocol->protocols().empty()) {
1548 It != Protocol->protocol_end(); It++) {
1550 if (It != Protocol->protocol_begin())
1555 Fragments.
append((*It)->getName(),
1570 .
append(getFragmentsForType(
Decl->getUnderlyingType(),
1572 .
append(std::move(After))
1591 if (isa<CXXConstructorDecl>(
Decl) || isa<CXXDestructorDecl>(
Decl))
1594 else if (isa<CXXConversionDecl>(
Decl)) {
1598 }
else if (isa<CXXMethodDecl>(
Decl) &&
1599 cast<CXXMethodDecl>(
Decl)->isOverloadedOperator()) {
1602 }
else if (!
Decl->getName().empty())
Forward declaration of all AST node types.
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
@ Declaration
The template argument is a declaration that was provided for a pointer, reference,...
@ Template
The template argument is a template name that was provided for a template template parameter.
@ StructuralValue
The template argument is a non-type template argument that can't be represented by the special-case D...
@ Pack
The template argument is actually a parameter pack.
@ TemplateExpansion
The template argument is a pack expansion of a template name that was provided for a template templat...
@ NullPtr
The template argument is a null pointer or null pointer to member that was provided for a non-type te...
@ Type
The template argument is a type.
@ Null
Represents an empty template argument, e.g., one that has not been deduced.
@ Integral
The template argument is an integral value stored in an llvm::APSInt that was provided for an integra...
@ Expression
The template argument is an expression, and we've not resolved it to one of the other forms yet,...
TemplateParameterList * getTemplateParameters() const
Get the list of template parameters.
ArrayRef< NamedDecl * > asArray()
Represents a type template specialization; the template must be a class template, a type alias templa...
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.