Comment.cpp revision 243830
1239313Sdim//===--- Comment.cpp - Comment AST node implementation --------------------===// 2239313Sdim// 3239313Sdim// The LLVM Compiler Infrastructure 4239313Sdim// 5239313Sdim// This file is distributed under the University of Illinois Open Source 6239313Sdim// License. See LICENSE.TXT for details. 7239313Sdim// 8239313Sdim//===----------------------------------------------------------------------===// 9239313Sdim 10243830Sdim#include "clang/AST/ASTContext.h" 11239313Sdim#include "clang/AST/Comment.h" 12239313Sdim#include "clang/AST/Decl.h" 13239313Sdim#include "clang/AST/DeclObjC.h" 14239313Sdim#include "clang/AST/DeclTemplate.h" 15239313Sdim#include "llvm/Support/ErrorHandling.h" 16239313Sdim#include "llvm/Support/raw_ostream.h" 17239313Sdim 18239313Sdimnamespace clang { 19239313Sdimnamespace comments { 20239313Sdim 21239313Sdimconst char *Comment::getCommentKindName() const { 22239313Sdim switch (getCommentKind()) { 23239313Sdim case NoCommentKind: return "NoCommentKind"; 24239313Sdim#define ABSTRACT_COMMENT(COMMENT) 25239313Sdim#define COMMENT(CLASS, PARENT) \ 26239313Sdim case CLASS##Kind: \ 27239313Sdim return #CLASS; 28239313Sdim#include "clang/AST/CommentNodes.inc" 29239313Sdim#undef COMMENT 30239313Sdim#undef ABSTRACT_COMMENT 31239313Sdim } 32239313Sdim llvm_unreachable("Unknown comment kind!"); 33239313Sdim} 34239313Sdim 35239313Sdimvoid Comment::dump() const { 36239313Sdim // It is important that Comment::dump() is defined in a different TU than 37239313Sdim // Comment::dump(raw_ostream, SourceManager). If both functions were defined 38239313Sdim // in CommentDumper.cpp, that object file would be removed by linker because 39239313Sdim // none of its functions are referenced by other object files, despite the 40239313Sdim // LLVM_ATTRIBUTE_USED. 41243830Sdim dump(llvm::errs(), NULL, NULL); 42239313Sdim} 43239313Sdim 44243830Sdimvoid Comment::dump(const ASTContext &Context) const { 45243830Sdim dump(llvm::errs(), &Context.getCommentCommandTraits(), 46243830Sdim &Context.getSourceManager()); 47239313Sdim} 48239313Sdim 49239313Sdimnamespace { 50239313Sdimstruct good {}; 51239313Sdimstruct bad {}; 52239313Sdim 53239313Sdimtemplate <typename T> 54239313Sdimgood implements_child_begin_end(Comment::child_iterator (T::*)() const) { 55239313Sdim return good(); 56239313Sdim} 57239313Sdim 58239313Sdimstatic inline bad implements_child_begin_end( 59239313Sdim Comment::child_iterator (Comment::*)() const) { 60239313Sdim return bad(); 61239313Sdim} 62239313Sdim 63239313Sdim#define ASSERT_IMPLEMENTS_child_begin(function) \ 64239313Sdim (void) sizeof(good(implements_child_begin_end(function))) 65239313Sdim 66239313Sdimstatic inline void CheckCommentASTNodes() { 67239313Sdim#define ABSTRACT_COMMENT(COMMENT) 68239313Sdim#define COMMENT(CLASS, PARENT) \ 69239313Sdim ASSERT_IMPLEMENTS_child_begin(&CLASS::child_begin); \ 70239313Sdim ASSERT_IMPLEMENTS_child_begin(&CLASS::child_end); 71239313Sdim#include "clang/AST/CommentNodes.inc" 72239313Sdim#undef COMMENT 73239313Sdim#undef ABSTRACT_COMMENT 74239313Sdim} 75239313Sdim 76239313Sdim#undef ASSERT_IMPLEMENTS_child_begin 77239313Sdim 78239313Sdim} // end unnamed namespace 79239313Sdim 80239313SdimComment::child_iterator Comment::child_begin() const { 81239313Sdim switch (getCommentKind()) { 82239313Sdim case NoCommentKind: llvm_unreachable("comment without a kind"); 83239313Sdim#define ABSTRACT_COMMENT(COMMENT) 84239313Sdim#define COMMENT(CLASS, PARENT) \ 85239313Sdim case CLASS##Kind: \ 86239313Sdim return static_cast<const CLASS *>(this)->child_begin(); 87239313Sdim#include "clang/AST/CommentNodes.inc" 88239313Sdim#undef COMMENT 89239313Sdim#undef ABSTRACT_COMMENT 90239313Sdim } 91239313Sdim llvm_unreachable("Unknown comment kind!"); 92239313Sdim} 93239313Sdim 94239313SdimComment::child_iterator Comment::child_end() const { 95239313Sdim switch (getCommentKind()) { 96239313Sdim case NoCommentKind: llvm_unreachable("comment without a kind"); 97239313Sdim#define ABSTRACT_COMMENT(COMMENT) 98239313Sdim#define COMMENT(CLASS, PARENT) \ 99239313Sdim case CLASS##Kind: \ 100239313Sdim return static_cast<const CLASS *>(this)->child_end(); 101239313Sdim#include "clang/AST/CommentNodes.inc" 102239313Sdim#undef COMMENT 103239313Sdim#undef ABSTRACT_COMMENT 104239313Sdim } 105239313Sdim llvm_unreachable("Unknown comment kind!"); 106239313Sdim} 107239313Sdim 108239313Sdimbool TextComment::isWhitespaceNoCache() const { 109239313Sdim for (StringRef::const_iterator I = Text.begin(), E = Text.end(); 110239313Sdim I != E; ++I) { 111239313Sdim const char C = *I; 112239313Sdim if (C != ' ' && C != '\n' && C != '\r' && 113239313Sdim C != '\t' && C != '\f' && C != '\v') 114239313Sdim return false; 115239313Sdim } 116239313Sdim return true; 117239313Sdim} 118239313Sdim 119239313Sdimbool ParagraphComment::isWhitespaceNoCache() const { 120239313Sdim for (child_iterator I = child_begin(), E = child_end(); I != E; ++I) { 121239313Sdim if (const TextComment *TC = dyn_cast<TextComment>(*I)) { 122239313Sdim if (!TC->isWhitespace()) 123239313Sdim return false; 124239313Sdim } else 125239313Sdim return false; 126239313Sdim } 127239313Sdim return true; 128239313Sdim} 129239313Sdim 130239313Sdimconst char *ParamCommandComment::getDirectionAsString(PassDirection D) { 131239313Sdim switch (D) { 132239313Sdim case ParamCommandComment::In: 133239313Sdim return "[in]"; 134239313Sdim case ParamCommandComment::Out: 135239313Sdim return "[out]"; 136239313Sdim case ParamCommandComment::InOut: 137239313Sdim return "[in,out]"; 138239313Sdim } 139239313Sdim llvm_unreachable("unknown PassDirection"); 140239313Sdim} 141239313Sdim 142239313Sdimvoid DeclInfo::fill() { 143239313Sdim assert(!IsFilled); 144239313Sdim 145239313Sdim // Set defaults. 146239313Sdim Kind = OtherKind; 147239313Sdim TemplateKind = NotTemplate; 148239313Sdim IsObjCMethod = false; 149239313Sdim IsInstanceMethod = false; 150239313Sdim IsClassMethod = false; 151239313Sdim ParamVars = ArrayRef<const ParmVarDecl *>(); 152239313Sdim TemplateParameters = NULL; 153239313Sdim 154243830Sdim if (!CommentDecl) { 155239313Sdim // If there is no declaration, the defaults is our only guess. 156239313Sdim IsFilled = true; 157239313Sdim return; 158239313Sdim } 159243830Sdim CurrentDecl = CommentDecl; 160243830Sdim 161243830Sdim Decl::Kind K = CommentDecl->getKind(); 162239313Sdim switch (K) { 163239313Sdim default: 164239313Sdim // Defaults are should be good for declarations we don't handle explicitly. 165239313Sdim break; 166239313Sdim case Decl::Function: 167239313Sdim case Decl::CXXMethod: 168239313Sdim case Decl::CXXConstructor: 169239313Sdim case Decl::CXXDestructor: 170239313Sdim case Decl::CXXConversion: { 171243830Sdim const FunctionDecl *FD = cast<FunctionDecl>(CommentDecl); 172239313Sdim Kind = FunctionKind; 173239313Sdim ParamVars = ArrayRef<const ParmVarDecl *>(FD->param_begin(), 174239313Sdim FD->getNumParams()); 175239313Sdim ResultType = FD->getResultType(); 176239313Sdim unsigned NumLists = FD->getNumTemplateParameterLists(); 177239313Sdim if (NumLists != 0) { 178239313Sdim TemplateKind = TemplateSpecialization; 179239313Sdim TemplateParameters = 180239313Sdim FD->getTemplateParameterList(NumLists - 1); 181239313Sdim } 182239313Sdim 183239313Sdim if (K == Decl::CXXMethod || K == Decl::CXXConstructor || 184239313Sdim K == Decl::CXXDestructor || K == Decl::CXXConversion) { 185243830Sdim const CXXMethodDecl *MD = cast<CXXMethodDecl>(CommentDecl); 186239313Sdim IsInstanceMethod = MD->isInstance(); 187239313Sdim IsClassMethod = !IsInstanceMethod; 188239313Sdim } 189239313Sdim break; 190239313Sdim } 191239313Sdim case Decl::ObjCMethod: { 192243830Sdim const ObjCMethodDecl *MD = cast<ObjCMethodDecl>(CommentDecl); 193239313Sdim Kind = FunctionKind; 194239313Sdim ParamVars = ArrayRef<const ParmVarDecl *>(MD->param_begin(), 195239313Sdim MD->param_size()); 196239313Sdim ResultType = MD->getResultType(); 197239313Sdim IsObjCMethod = true; 198239313Sdim IsInstanceMethod = MD->isInstanceMethod(); 199239313Sdim IsClassMethod = !IsInstanceMethod; 200239313Sdim break; 201239313Sdim } 202239313Sdim case Decl::FunctionTemplate: { 203243830Sdim const FunctionTemplateDecl *FTD = cast<FunctionTemplateDecl>(CommentDecl); 204239313Sdim Kind = FunctionKind; 205239313Sdim TemplateKind = Template; 206239313Sdim const FunctionDecl *FD = FTD->getTemplatedDecl(); 207239313Sdim ParamVars = ArrayRef<const ParmVarDecl *>(FD->param_begin(), 208239313Sdim FD->getNumParams()); 209239313Sdim ResultType = FD->getResultType(); 210239313Sdim TemplateParameters = FTD->getTemplateParameters(); 211239313Sdim break; 212239313Sdim } 213239313Sdim case Decl::ClassTemplate: { 214243830Sdim const ClassTemplateDecl *CTD = cast<ClassTemplateDecl>(CommentDecl); 215239313Sdim Kind = ClassKind; 216239313Sdim TemplateKind = Template; 217239313Sdim TemplateParameters = CTD->getTemplateParameters(); 218239313Sdim break; 219239313Sdim } 220239313Sdim case Decl::ClassTemplatePartialSpecialization: { 221239313Sdim const ClassTemplatePartialSpecializationDecl *CTPSD = 222243830Sdim cast<ClassTemplatePartialSpecializationDecl>(CommentDecl); 223239313Sdim Kind = ClassKind; 224239313Sdim TemplateKind = TemplatePartialSpecialization; 225239313Sdim TemplateParameters = CTPSD->getTemplateParameters(); 226239313Sdim break; 227239313Sdim } 228239313Sdim case Decl::ClassTemplateSpecialization: 229239313Sdim Kind = ClassKind; 230239313Sdim TemplateKind = TemplateSpecialization; 231239313Sdim break; 232239313Sdim case Decl::Record: 233239313Sdim case Decl::CXXRecord: 234239313Sdim Kind = ClassKind; 235239313Sdim break; 236239313Sdim case Decl::Var: 237239313Sdim case Decl::Field: 238239313Sdim case Decl::EnumConstant: 239239313Sdim case Decl::ObjCIvar: 240239313Sdim case Decl::ObjCAtDefsField: 241239313Sdim Kind = VariableKind; 242239313Sdim break; 243239313Sdim case Decl::Namespace: 244239313Sdim Kind = NamespaceKind; 245239313Sdim break; 246243830Sdim case Decl::Typedef: { 247243830Sdim Kind = TypedefKind; 248243830Sdim // If this is a typedef to something we consider a function, extract 249243830Sdim // arguments and return type. 250243830Sdim const TypedefDecl *TD = cast<TypedefDecl>(CommentDecl); 251243830Sdim const TypeSourceInfo *TSI = TD->getTypeSourceInfo(); 252243830Sdim if (!TSI) 253243830Sdim break; 254243830Sdim TypeLoc TL = TSI->getTypeLoc().getUnqualifiedLoc(); 255243830Sdim while (true) { 256243830Sdim TL = TL.IgnoreParens(); 257243830Sdim // Look through qualified types. 258243830Sdim if (QualifiedTypeLoc *QualifiedTL = dyn_cast<QualifiedTypeLoc>(&TL)) { 259243830Sdim TL = QualifiedTL->getUnqualifiedLoc(); 260243830Sdim continue; 261243830Sdim } 262243830Sdim // Look through pointer types. 263243830Sdim if (PointerTypeLoc *PointerTL = dyn_cast<PointerTypeLoc>(&TL)) { 264243830Sdim TL = PointerTL->getPointeeLoc().getUnqualifiedLoc(); 265243830Sdim continue; 266243830Sdim } 267243830Sdim if (BlockPointerTypeLoc *BlockPointerTL = 268243830Sdim dyn_cast<BlockPointerTypeLoc>(&TL)) { 269243830Sdim TL = BlockPointerTL->getPointeeLoc().getUnqualifiedLoc(); 270243830Sdim continue; 271243830Sdim } 272243830Sdim if (MemberPointerTypeLoc *MemberPointerTL = 273243830Sdim dyn_cast<MemberPointerTypeLoc>(&TL)) { 274243830Sdim TL = MemberPointerTL->getPointeeLoc().getUnqualifiedLoc(); 275243830Sdim continue; 276243830Sdim } 277243830Sdim // Is this a typedef for a function type? 278243830Sdim if (FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL)) { 279243830Sdim Kind = FunctionKind; 280243830Sdim ArrayRef<ParmVarDecl *> Params = FTL->getParams(); 281243830Sdim ParamVars = ArrayRef<const ParmVarDecl *>(Params.data(), 282243830Sdim Params.size()); 283243830Sdim ResultType = FTL->getResultLoc().getType(); 284243830Sdim break; 285243830Sdim } 286243830Sdim break; 287243830Sdim } 288243830Sdim break; 289243830Sdim } 290239313Sdim case Decl::TypeAlias: 291239313Sdim Kind = TypedefKind; 292239313Sdim break; 293239313Sdim case Decl::TypeAliasTemplate: { 294243830Sdim const TypeAliasTemplateDecl *TAT = cast<TypeAliasTemplateDecl>(CommentDecl); 295239313Sdim Kind = TypedefKind; 296239313Sdim TemplateKind = Template; 297239313Sdim TemplateParameters = TAT->getTemplateParameters(); 298239313Sdim break; 299239313Sdim } 300239313Sdim case Decl::Enum: 301239313Sdim Kind = EnumKind; 302239313Sdim break; 303239313Sdim } 304239313Sdim 305239313Sdim IsFilled = true; 306239313Sdim} 307239313Sdim 308243830SdimStringRef ParamCommandComment::getParamName(const FullComment *FC) const { 309243830Sdim assert(isParamIndexValid()); 310243830Sdim return FC->getThisDeclInfo()->ParamVars[getParamIndex()]->getName(); 311243830Sdim} 312243830Sdim 313243830SdimStringRef TParamCommandComment::getParamName(const FullComment *FC) const { 314243830Sdim assert(isPositionValid()); 315243830Sdim const TemplateParameterList *TPL = FC->getThisDeclInfo()->TemplateParameters; 316243830Sdim for (unsigned i = 0, e = getDepth(); i != e; ++i) { 317243830Sdim if (i == e-1) 318243830Sdim return TPL->getParam(getIndex(i))->getName(); 319243830Sdim const NamedDecl *Param = TPL->getParam(getIndex(i)); 320243830Sdim if (const TemplateTemplateParmDecl *TTP = 321243830Sdim dyn_cast<TemplateTemplateParmDecl>(Param)) 322243830Sdim TPL = TTP->getTemplateParameters(); 323243830Sdim } 324243830Sdim return ""; 325243830Sdim} 326243830Sdim 327239313Sdim} // end namespace comments 328239313Sdim} // end namespace clang 329239313Sdim 330