1 //===--- Comment.cpp - Comment AST node implementation --------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "clang/AST/Comment.h" 10 #include "clang/AST/ASTContext.h" 11 #include "clang/AST/Decl.h" 12 #include "clang/AST/DeclObjC.h" 13 #include "clang/AST/DeclTemplate.h" 14 #include "clang/Basic/CharInfo.h" 15 #include "llvm/Support/ErrorHandling.h" 16 #include <type_traits> 17 18 namespace clang { 19 namespace comments { 20 21 // Check that no comment class has a non-trival destructor. They are allocated 22 // with a BumpPtrAllocator and therefore their destructor is not executed. 23 #define ABSTRACT_COMMENT(COMMENT) 24 #define COMMENT(CLASS, PARENT) \ 25 static_assert(std::is_trivially_destructible<CLASS>::value, \ 26 #CLASS " should be trivially destructible!"); 27 #include "clang/AST/CommentNodes.inc" 28 #undef COMMENT 29 #undef ABSTRACT_COMMENT 30 31 // DeclInfo is also allocated with a BumpPtrAllocator. 32 static_assert(std::is_trivially_destructible<DeclInfo>::value, 33 "DeclInfo should be trivially destructible!"); 34 35 const char *Comment::getCommentKindName() const { 36 switch (getCommentKind()) { 37 case NoCommentKind: return "NoCommentKind"; 38 #define ABSTRACT_COMMENT(COMMENT) 39 #define COMMENT(CLASS, PARENT) \ 40 case CLASS##Kind: \ 41 return #CLASS; 42 #include "clang/AST/CommentNodes.inc" 43 #undef COMMENT 44 #undef ABSTRACT_COMMENT 45 } 46 llvm_unreachable("Unknown comment kind!"); 47 } 48 49 namespace { 50 struct good {}; 51 struct bad {}; 52 53 template <typename T> 54 good implements_child_begin_end(Comment::child_iterator (T::*)() const) { 55 return good(); 56 } 57 58 LLVM_ATTRIBUTE_UNUSED 59 static inline bad implements_child_begin_end( 60 Comment::child_iterator (Comment::*)() const) { 61 return bad(); 62 } 63 64 #define ASSERT_IMPLEMENTS_child_begin(function) \ 65 (void) good(implements_child_begin_end(function)) 66 67 LLVM_ATTRIBUTE_UNUSED 68 static inline void CheckCommentASTNodes() { 69 #define ABSTRACT_COMMENT(COMMENT) 70 #define COMMENT(CLASS, PARENT) \ 71 ASSERT_IMPLEMENTS_child_begin(&CLASS::child_begin); \ 72 ASSERT_IMPLEMENTS_child_begin(&CLASS::child_end); 73 #include "clang/AST/CommentNodes.inc" 74 #undef COMMENT 75 #undef ABSTRACT_COMMENT 76 } 77 78 #undef ASSERT_IMPLEMENTS_child_begin 79 80 } // end unnamed namespace 81 82 Comment::child_iterator Comment::child_begin() const { 83 switch (getCommentKind()) { 84 case NoCommentKind: llvm_unreachable("comment without a kind"); 85 #define ABSTRACT_COMMENT(COMMENT) 86 #define COMMENT(CLASS, PARENT) \ 87 case CLASS##Kind: \ 88 return static_cast<const CLASS *>(this)->child_begin(); 89 #include "clang/AST/CommentNodes.inc" 90 #undef COMMENT 91 #undef ABSTRACT_COMMENT 92 } 93 llvm_unreachable("Unknown comment kind!"); 94 } 95 96 Comment::child_iterator Comment::child_end() const { 97 switch (getCommentKind()) { 98 case NoCommentKind: llvm_unreachable("comment without a kind"); 99 #define ABSTRACT_COMMENT(COMMENT) 100 #define COMMENT(CLASS, PARENT) \ 101 case CLASS##Kind: \ 102 return static_cast<const CLASS *>(this)->child_end(); 103 #include "clang/AST/CommentNodes.inc" 104 #undef COMMENT 105 #undef ABSTRACT_COMMENT 106 } 107 llvm_unreachable("Unknown comment kind!"); 108 } 109 110 bool TextComment::isWhitespaceNoCache() const { 111 for (StringRef::const_iterator I = Text.begin(), E = Text.end(); 112 I != E; ++I) { 113 if (!clang::isWhitespace(*I)) 114 return false; 115 } 116 return true; 117 } 118 119 bool ParagraphComment::isWhitespaceNoCache() const { 120 for (child_iterator I = child_begin(), E = child_end(); I != E; ++I) { 121 if (const TextComment *TC = dyn_cast<TextComment>(*I)) { 122 if (!TC->isWhitespace()) 123 return false; 124 } else 125 return false; 126 } 127 return true; 128 } 129 130 static TypeLoc lookThroughTypedefOrTypeAliasLocs(TypeLoc &SrcTL) { 131 TypeLoc TL = SrcTL.IgnoreParens(); 132 133 // Look through attribute types. 134 if (AttributedTypeLoc AttributeTL = TL.getAs<AttributedTypeLoc>()) 135 return AttributeTL.getModifiedLoc(); 136 // Look through qualified types. 137 if (QualifiedTypeLoc QualifiedTL = TL.getAs<QualifiedTypeLoc>()) 138 return QualifiedTL.getUnqualifiedLoc(); 139 // Look through pointer types. 140 if (PointerTypeLoc PointerTL = TL.getAs<PointerTypeLoc>()) 141 return PointerTL.getPointeeLoc().getUnqualifiedLoc(); 142 // Look through reference types. 143 if (ReferenceTypeLoc ReferenceTL = TL.getAs<ReferenceTypeLoc>()) 144 return ReferenceTL.getPointeeLoc().getUnqualifiedLoc(); 145 // Look through adjusted types. 146 if (AdjustedTypeLoc ATL = TL.getAs<AdjustedTypeLoc>()) 147 return ATL.getOriginalLoc(); 148 if (BlockPointerTypeLoc BlockPointerTL = TL.getAs<BlockPointerTypeLoc>()) 149 return BlockPointerTL.getPointeeLoc().getUnqualifiedLoc(); 150 if (MemberPointerTypeLoc MemberPointerTL = TL.getAs<MemberPointerTypeLoc>()) 151 return MemberPointerTL.getPointeeLoc().getUnqualifiedLoc(); 152 if (ElaboratedTypeLoc ETL = TL.getAs<ElaboratedTypeLoc>()) 153 return ETL.getNamedTypeLoc(); 154 155 return TL; 156 } 157 158 static bool getFunctionTypeLoc(TypeLoc TL, FunctionTypeLoc &ResFTL) { 159 TypeLoc PrevTL; 160 while (PrevTL != TL) { 161 PrevTL = TL; 162 TL = lookThroughTypedefOrTypeAliasLocs(TL); 163 } 164 165 if (FunctionTypeLoc FTL = TL.getAs<FunctionTypeLoc>()) { 166 ResFTL = FTL; 167 return true; 168 } 169 170 if (TemplateSpecializationTypeLoc STL = 171 TL.getAs<TemplateSpecializationTypeLoc>()) { 172 // If we have a typedef to a template specialization with exactly one 173 // template argument of a function type, this looks like std::function, 174 // boost::function, or other function wrapper. Treat these typedefs as 175 // functions. 176 if (STL.getNumArgs() != 1) 177 return false; 178 TemplateArgumentLoc MaybeFunction = STL.getArgLoc(0); 179 if (MaybeFunction.getArgument().getKind() != TemplateArgument::Type) 180 return false; 181 TypeSourceInfo *MaybeFunctionTSI = MaybeFunction.getTypeSourceInfo(); 182 TypeLoc TL = MaybeFunctionTSI->getTypeLoc().getUnqualifiedLoc(); 183 if (FunctionTypeLoc FTL = TL.getAs<FunctionTypeLoc>()) { 184 ResFTL = FTL; 185 return true; 186 } 187 } 188 189 return false; 190 } 191 192 const char *ParamCommandComment::getDirectionAsString(PassDirection D) { 193 switch (D) { 194 case ParamCommandComment::In: 195 return "[in]"; 196 case ParamCommandComment::Out: 197 return "[out]"; 198 case ParamCommandComment::InOut: 199 return "[in,out]"; 200 } 201 llvm_unreachable("unknown PassDirection"); 202 } 203 204 void DeclInfo::fill() { 205 assert(!IsFilled); 206 207 // Set defaults. 208 Kind = OtherKind; 209 TemplateKind = NotTemplate; 210 IsObjCMethod = false; 211 IsInstanceMethod = false; 212 IsClassMethod = false; 213 IsVariadic = false; 214 ParamVars = None; 215 TemplateParameters = nullptr; 216 217 if (!CommentDecl) { 218 // If there is no declaration, the defaults is our only guess. 219 IsFilled = true; 220 return; 221 } 222 CurrentDecl = CommentDecl; 223 224 Decl::Kind K = CommentDecl->getKind(); 225 const TypeSourceInfo *TSI = nullptr; 226 switch (K) { 227 default: 228 // Defaults are should be good for declarations we don't handle explicitly. 229 break; 230 case Decl::Function: 231 case Decl::CXXMethod: 232 case Decl::CXXConstructor: 233 case Decl::CXXDestructor: 234 case Decl::CXXConversion: { 235 const FunctionDecl *FD = cast<FunctionDecl>(CommentDecl); 236 Kind = FunctionKind; 237 ParamVars = FD->parameters(); 238 ReturnType = FD->getReturnType(); 239 unsigned NumLists = FD->getNumTemplateParameterLists(); 240 if (NumLists != 0) { 241 TemplateKind = TemplateSpecialization; 242 TemplateParameters = 243 FD->getTemplateParameterList(NumLists - 1); 244 } 245 246 if (K == Decl::CXXMethod || K == Decl::CXXConstructor || 247 K == Decl::CXXDestructor || K == Decl::CXXConversion) { 248 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CommentDecl); 249 IsInstanceMethod = MD->isInstance(); 250 IsClassMethod = !IsInstanceMethod; 251 } 252 IsVariadic = FD->isVariadic(); 253 assert(involvesFunctionType()); 254 break; 255 } 256 case Decl::ObjCMethod: { 257 const ObjCMethodDecl *MD = cast<ObjCMethodDecl>(CommentDecl); 258 Kind = FunctionKind; 259 ParamVars = MD->parameters(); 260 ReturnType = MD->getReturnType(); 261 IsObjCMethod = true; 262 IsInstanceMethod = MD->isInstanceMethod(); 263 IsClassMethod = !IsInstanceMethod; 264 IsVariadic = MD->isVariadic(); 265 assert(involvesFunctionType()); 266 break; 267 } 268 case Decl::FunctionTemplate: { 269 const FunctionTemplateDecl *FTD = cast<FunctionTemplateDecl>(CommentDecl); 270 Kind = FunctionKind; 271 TemplateKind = Template; 272 const FunctionDecl *FD = FTD->getTemplatedDecl(); 273 ParamVars = FD->parameters(); 274 ReturnType = FD->getReturnType(); 275 TemplateParameters = FTD->getTemplateParameters(); 276 IsVariadic = FD->isVariadic(); 277 assert(involvesFunctionType()); 278 break; 279 } 280 case Decl::ClassTemplate: { 281 const ClassTemplateDecl *CTD = cast<ClassTemplateDecl>(CommentDecl); 282 Kind = ClassKind; 283 TemplateKind = Template; 284 TemplateParameters = CTD->getTemplateParameters(); 285 break; 286 } 287 case Decl::ClassTemplatePartialSpecialization: { 288 const ClassTemplatePartialSpecializationDecl *CTPSD = 289 cast<ClassTemplatePartialSpecializationDecl>(CommentDecl); 290 Kind = ClassKind; 291 TemplateKind = TemplatePartialSpecialization; 292 TemplateParameters = CTPSD->getTemplateParameters(); 293 break; 294 } 295 case Decl::ClassTemplateSpecialization: 296 Kind = ClassKind; 297 TemplateKind = TemplateSpecialization; 298 break; 299 case Decl::Record: 300 case Decl::CXXRecord: 301 Kind = ClassKind; 302 break; 303 case Decl::Var: 304 if (const VarTemplateDecl *VTD = 305 cast<VarDecl>(CommentDecl)->getDescribedVarTemplate()) { 306 TemplateKind = TemplateSpecialization; 307 TemplateParameters = VTD->getTemplateParameters(); 308 } 309 LLVM_FALLTHROUGH; 310 case Decl::Field: 311 case Decl::EnumConstant: 312 case Decl::ObjCIvar: 313 case Decl::ObjCAtDefsField: 314 case Decl::ObjCProperty: 315 if (const auto *VD = dyn_cast<DeclaratorDecl>(CommentDecl)) 316 TSI = VD->getTypeSourceInfo(); 317 else if (const auto *PD = dyn_cast<ObjCPropertyDecl>(CommentDecl)) 318 TSI = PD->getTypeSourceInfo(); 319 Kind = VariableKind; 320 break; 321 case Decl::VarTemplate: { 322 const VarTemplateDecl *VTD = cast<VarTemplateDecl>(CommentDecl); 323 Kind = VariableKind; 324 TemplateKind = Template; 325 TemplateParameters = VTD->getTemplateParameters(); 326 if (const VarDecl *VD = VTD->getTemplatedDecl()) 327 TSI = VD->getTypeSourceInfo(); 328 break; 329 } 330 case Decl::Namespace: 331 Kind = NamespaceKind; 332 break; 333 case Decl::TypeAlias: 334 case Decl::Typedef: 335 Kind = TypedefKind; 336 TSI = cast<TypedefNameDecl>(CommentDecl)->getTypeSourceInfo(); 337 break; 338 case Decl::TypeAliasTemplate: { 339 const TypeAliasTemplateDecl *TAT = cast<TypeAliasTemplateDecl>(CommentDecl); 340 Kind = TypedefKind; 341 TemplateKind = Template; 342 TemplateParameters = TAT->getTemplateParameters(); 343 if (TypeAliasDecl *TAD = TAT->getTemplatedDecl()) 344 TSI = TAD->getTypeSourceInfo(); 345 break; 346 } 347 case Decl::Enum: 348 Kind = EnumKind; 349 break; 350 } 351 352 // If the type is a typedef / using to something we consider a function, 353 // extract arguments and return type. 354 if (TSI) { 355 TypeLoc TL = TSI->getTypeLoc().getUnqualifiedLoc(); 356 FunctionTypeLoc FTL; 357 if (getFunctionTypeLoc(TL, FTL)) { 358 ParamVars = FTL.getParams(); 359 ReturnType = FTL.getReturnLoc().getType(); 360 if (const auto *FPT = dyn_cast<FunctionProtoType>(FTL.getTypePtr())) 361 IsVariadic = FPT->isVariadic(); 362 assert(involvesFunctionType()); 363 } 364 } 365 366 IsFilled = true; 367 } 368 369 StringRef ParamCommandComment::getParamName(const FullComment *FC) const { 370 assert(isParamIndexValid()); 371 if (isVarArgParam()) 372 return "..."; 373 return FC->getDeclInfo()->ParamVars[getParamIndex()]->getName(); 374 } 375 376 StringRef TParamCommandComment::getParamName(const FullComment *FC) const { 377 assert(isPositionValid()); 378 const TemplateParameterList *TPL = FC->getDeclInfo()->TemplateParameters; 379 for (unsigned i = 0, e = getDepth(); i != e; ++i) { 380 assert(TPL && "Unknown TemplateParameterList"); 381 if (i == e - 1) 382 return TPL->getParam(getIndex(i))->getName(); 383 const NamedDecl *Param = TPL->getParam(getIndex(i)); 384 if (auto *TTP = dyn_cast<TemplateTemplateParmDecl>(Param)) 385 TPL = TTP->getTemplateParameters(); 386 } 387 return ""; 388 } 389 390 } // end namespace comments 391 } // end namespace clang 392 393