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