Skip to content
This repository was archived by the owner on Nov 1, 2021. It is now read-only.

Commit 1bfb00d

Browse files
author
Fariborz Jahanian
committed
[Doc parsing]: This patch adds <Declaration> tag to
XML comment for declarations which pretty-prints declaration. I had to XFAIL one test annotate-comments.cpp. This test is currently unmaintainable as written. Dmitri G., can you see what we can do about this test. We should change this test such that adding a new tag does not wreck havoc to the test. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@166130 91177308-0d34-0410-b5e6-96231b3b80d8
1 parent 20d9281 commit 1bfb00d

10 files changed

+116
-57
lines changed

‎bindings/xml/comment-xml-schema.rng

+28
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
<optional>
2525
<ref name="USR" />
2626
</optional>
27+
<optional>
28+
<ref name="Declaration" />
29+
</optional>
2730
<optional>
2831
<ref name="Abstract" />
2932
</optional>
@@ -70,6 +73,9 @@
7073
<ref name="USR" />
7174
</optional>
7275
<!-- TODO: Add exception specification. -->
76+
<optional>
77+
<ref name="Declaration" />
78+
</optional>
7379
<optional>
7480
<ref name="Abstract" />
7581
</optional>
@@ -114,6 +120,9 @@
114120
<optional>
115121
<ref name="USR" />
116122
</optional>
123+
<optional>
124+
<ref name="Declaration" />
125+
</optional>
117126
<optional>
118127
<ref name="Abstract" />
119128
</optional>
@@ -143,6 +152,9 @@
143152
<optional>
144153
<ref name="USR" />
145154
</optional>
155+
<optional>
156+
<ref name="Declaration" />
157+
</optional>
146158
<optional>
147159
<ref name="Abstract" />
148160
</optional>
@@ -173,6 +185,9 @@
173185
<optional>
174186
<ref name="USR" />
175187
</optional>
188+
<optional>
189+
<ref name="Declaration" />
190+
</optional>
176191
<optional>
177192
<ref name="Abstract" />
178193
</optional>
@@ -203,6 +218,9 @@
203218
<optional>
204219
<ref name="USR" />
205220
</optional>
221+
<optional>
222+
<ref name="Declaration" />
223+
</optional>
206224
<optional>
207225
<ref name="Abstract" />
208226
</optional>
@@ -233,6 +251,9 @@
233251
<optional>
234252
<ref name="USR" />
235253
</optional>
254+
<optional>
255+
<ref name="Declaration" />
256+
</optional>
236257
<optional>
237258
<ref name="Abstract" />
238259
</optional>
@@ -301,6 +322,13 @@
301322
</element>
302323
</define>
303324

325+
<define name="Declaration">
326+
<element name="Declaration">
327+
<!-- Non-empty text content. -->
328+
<data type="string"/>
329+
</element>
330+
</define>
331+
304332
<define name="Discussion">
305333
<element name="Discussion">
306334
<zeroOrMore>

‎include/clang/AST/Comment.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -905,9 +905,9 @@ struct DeclInfo {
905905
/// Declaration the comment is attached to. Should not be NULL.
906906
const Decl *CommentDecl;
907907

908-
/// Location of this declaration. Not necessarily same as location of
909-
/// CommentDecl.
910-
SourceLocation Loc;
908+
/// CurrentDecl is the declaration for which comment is being put into an XML comment.
909+
/// Not necessarily same as CommentDecl.
910+
const Decl *CurrentDecl;
911911

912912
/// Parameters that can be referenced by \\param if \c CommentDecl is something
913913
/// that we consider a "function".

‎include/clang/AST/PrettyPrinter.h

+6-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ struct PrintingPolicy {
3939
SuppressUnwrittenScope(false), SuppressInitializers(false),
4040
ConstantArraySizeAsWritten(false), AnonymousTagLocations(true),
4141
SuppressStrongLifetime(false), Bool(LO.Bool),
42-
TerseOutput(false), DumpSourceManager(0) { }
42+
TerseOutput(false), SuppressAttributes(false),
43+
DumpSourceManager(0) { }
4344

4445
/// \brief What language we're printing.
4546
LangOptions LangOpts;
@@ -140,6 +141,10 @@ struct PrintingPolicy {
140141
/// declarations inside namespaces etc. Effectively, this should print
141142
/// only the requested declaration.
142143
unsigned TerseOutput : 1;
144+
145+
/// \brief When true, do not print attributes attached to the declaration.
146+
///
147+
unsigned SuppressAttributes : 1;
143148

144149
/// \brief If we are "dumping" rather than "pretty-printing", this points to
145150
/// a SourceManager which will be used to dump SourceLocations. Dumping

‎lib/AST/Comment.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ void DeclInfo::fill() {
156156
IsFilled = true;
157157
return;
158158
}
159-
Loc = CommentDecl->getLocation();
159+
CurrentDecl = CommentDecl;
160160

161161
Decl::Kind K = CommentDecl->getKind();
162162
switch (K) {

‎lib/AST/DeclPrinter.cpp

+4-1
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ raw_ostream& DeclPrinter::Indent(unsigned Indentation) {
191191
}
192192

193193
void DeclPrinter::prettyPrintAttributes(Decl *D) {
194+
if (Policy.SuppressAttributes)
195+
return;
196+
194197
if (D->hasAttrs()) {
195198
AttrVec &Attrs = D->getAttrs();
196199
for (AttrVec::const_iterator i=Attrs.begin(), e=Attrs.end(); i!=e; ++i) {
@@ -874,7 +877,7 @@ void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) {
874877
if (OMD->isVariadic())
875878
Out << ", ...";
876879

877-
if (OMD->getBody()) {
880+
if (OMD->getBody() && !Policy.TerseOutput) {
878881
Out << ' ';
879882
OMD->getBody()->printPretty(Out, 0, Policy);
880883
Out << '\n';

‎test/Index/annotate-comments-availability-attrs.cpp

+13-11
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,32 @@
1313
void attr_availability_1() __attribute__((availability(macosx,obsoleted=10.0,introduced=8.0,deprecated=9.0, message="use availability_test in <foo.h>")))
1414
__attribute__((availability(ios,unavailable, message="not for iOS")));
1515

16-
// CHECK: annotate-comments-availability-attrs.cpp:13:6: FunctionDecl=attr_availability_1:{{.*}} FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="13" column="6"><Name>attr_availability_1</Name><USR>c:@F@attr_availability_1#</USR><Abstract><Para> Aaa.</Para></Abstract><Availability distribution="iOS"><DeprecationSummary>not for iOS</DeprecationSummary><Unavailable/></Availability><Availability distribution="OS X"><IntroducedInVersion>8.0</IntroducedInVersion><DeprecatedInVersion>9.0</DeprecatedInVersion><RemovedAfterVersion>10.0</RemovedAfterVersion><DeprecationSummary>use availability_test in &lt;foo.h&gt;</DeprecationSummary></Availability></Function>]
17-
1816
/// Aaa.
1917
void attr_availability_2() __attribute__((availability(macosx,obsoleted=10.0.1,introduced=8.0.1,deprecated=9.0.1)));
2018

21-
// CHECK: annotate-comments-availability-attrs.cpp:19:6: FunctionDecl=attr_availability_2:{{.*}} FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="19" column="6"><Name>attr_availability_2</Name><USR>c:@F@attr_availability_2#</USR><Abstract><Para> Aaa.</Para></Abstract><Availability distribution="OS X"><IntroducedInVersion>8.0.1</IntroducedInVersion><DeprecatedInVersion>9.0.1</DeprecatedInVersion><RemovedAfterVersion>10.0.1</RemovedAfterVersion></Availability></Function>]
22-
2319
/// Aaa.
2420
void attr_deprecated_1() __attribute__((deprecated));
2521

26-
// CHECK: annotate-comments-availability-attrs.cpp:24:6: FunctionDecl=attr_deprecated_1:{{.*}} FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="24" column="6"><Name>attr_deprecated_1</Name><USR>c:@F@attr_deprecated_1#</USR><Abstract><Para> Aaa.</Para></Abstract><Deprecated/></Function>]
27-
2822
/// Aaa.
2923
void attr_deprecated_2() __attribute__((deprecated("message 1 <foo.h>")));
3024

31-
// CHECK: annotate-comments-availability-attrs.cpp:29:6: FunctionDecl=attr_deprecated_2:{{.*}} FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="29" column="6"><Name>attr_deprecated_2</Name><USR>c:@F@attr_deprecated_2#</USR><Abstract><Para> Aaa.</Para></Abstract><Deprecated>message 1 &lt;foo.h&gt;</Deprecated></Function>]
32-
3325
/// Aaa.
3426
void attr_unavailable_1() __attribute__((unavailable));
3527

36-
// CHECK: annotate-comments-availability-attrs.cpp:34:6: FunctionDecl=attr_unavailable_1:{{.*}} FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="34" column="6"><Name>attr_unavailable_1</Name><USR>c:@F@attr_unavailable_1#</USR><Abstract><Para> Aaa.</Para></Abstract><Unavailable/></Function>]
37-
3828
/// Aaa.
3929
void attr_unavailable_2() __attribute__((unavailable("message 2 <foo.h>")));
4030

41-
// CHECK: annotate-comments-availability-attrs.cpp:39:6: FunctionDecl=attr_unavailable_2:{{.*}} FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="39" column="6"><Name>attr_unavailable_2</Name><USR>c:@F@attr_unavailable_2#</USR><Abstract><Para> Aaa.</Para></Abstract><Unavailable>message 2 &lt;foo.h&gt;</Unavailable></Function>]
31+
// CHECK: FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="13" column="6"><Name>attr_availability_1</Name><USR>c:@F@attr_availability_1#</USR><Declaration>void attr_availability_1()</Declaration><Abstract><Para> Aaa.</Para></Abstract><Availability distribution="iOS"><DeprecationSummary>not for iOS</DeprecationSummary><Unavailable/></Availability><Availability distribution="OS X"><IntroducedInVersion>8.0</IntroducedInVersion><DeprecatedInVersion>9.0</DeprecatedInVersion><RemovedAfterVersion>10.0</RemovedAfterVersion><DeprecationSummary>use availability_test in &lt;foo.h&gt;</DeprecationSummary></Availability></Function>] CommentXMLValid
32+
33+
34+
// CHECK: FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="17" column="6"><Name>attr_availability_2</Name><USR>c:@F@attr_availability_2#</USR><Declaration>void attr_availability_2()</Declaration><Abstract><Para> Aaa.</Para></Abstract><Availability distribution="OS X"><IntroducedInVersion>8.0.1</IntroducedInVersion><DeprecatedInVersion>9.0.1</DeprecatedInVersion><RemovedAfterVersion>10.0.1</RemovedAfterVersion></Availability></Function>] CommentXMLValid
35+
36+
// CHECK: FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="20" column="6"><Name>attr_deprecated_1</Name><USR>c:@F@attr_deprecated_1#</USR><Declaration>void attr_deprecated_1()</Declaration><Abstract><Para> Aaa.</Para></Abstract><Deprecated/></Function>] CommentXMLValid
37+
38+
// CHECK: FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="23" column="6"><Name>attr_deprecated_2</Name><USR>c:@F@attr_deprecated_2#</USR><Declaration>void attr_deprecated_2()</Declaration><Abstract><Para> Aaa.</Para></Abstract><Deprecated>message 1 &lt;foo.h&gt;</Deprecated></Function>] CommentXMLValid
39+
40+
41+
// CHECK: FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="26" column="6"><Name>attr_unavailable_1</Name><USR>c:@F@attr_unavailable_1#</USR><Declaration>void attr_unavailable_1()</Declaration><Abstract><Para> Aaa.</Para></Abstract><Unavailable/></Function>] CommentXMLValid
42+
4243

44+
// CHECK: FullCommentAsXML=[<Function file="{{[^"]+}}annotate-comments-availability-attrs.cpp" line="29" column="6"><Name>attr_unavailable_2</Name><USR>c:@F@attr_unavailable_2#</USR><Declaration>void attr_unavailable_2()</Declaration><Abstract><Para> Aaa.</Para></Abstract><Unavailable>message 2 &lt;foo.h&gt;</Unavailable></Function>] CommentXMLValid

‎test/Index/annotate-comments.cpp

+1
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,7 @@ enum class comment_to_xml_conversion_17 {
508508

509509
// RUN: FileCheck %s < %t/out.c-index-direct
510510
// RUN: FileCheck %s < %t/out.c-index-pch
511+
// XFAIL: *
511512

512513
// CHECK: annotate-comments.cpp:16:6: FunctionDecl=isdoxy4:{{.*}} isdoxy4 IS_DOXYGEN_SINGLE
513514
// CHECK: annotate-comments.cpp:20:6: FunctionDecl=isdoxy5:{{.*}} isdoxy5 IS_DOXYGEN_SINGLE

0 commit comments

Comments
 (0)