1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
//===--- RawCommentList.cpp - Processing raw comments -----------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "clang/AST/RawCommentList.h"
#include "llvm/ADT/STLExtras.h"
using namespace clang;
namespace {
/// Get comment kind and bool describing if it is a trailing comment.
std::pair<RawComment::CommentKind, bool> getCommentKind(StringRef Comment) {
if (Comment.size() < 3 || Comment[0] != '/')
return std::make_pair(RawComment::CK_Invalid, false);
RawComment::CommentKind K;
if (Comment[1] == '/') {
if (Comment.size() < 3)
return std::make_pair(RawComment::CK_OrdinaryBCPL, false);
if (Comment[2] == '/')
K = RawComment::CK_BCPLSlash;
else if (Comment[2] == '!')
K = RawComment::CK_BCPLExcl;
else
return std::make_pair(RawComment::CK_OrdinaryBCPL, false);
} else {
assert(Comment.size() >= 4);
// Comment lexer does not understand escapes in comment markers, so pretend
// that this is not a comment.
if (Comment[1] != '*' ||
Comment[Comment.size() - 2] != '*' ||
Comment[Comment.size() - 1] != '/')
return std::make_pair(RawComment::CK_Invalid, false);
if (Comment[2] == '*')
K = RawComment::CK_JavaDoc;
else if (Comment[2] == '!')
K = RawComment::CK_Qt;
else
return std::make_pair(RawComment::CK_OrdinaryC, false);
}
const bool TrailingComment = (Comment.size() > 3) && (Comment[3] == '<');
return std::make_pair(K, TrailingComment);
}
bool mergedCommentIsTrailingComment(StringRef Comment) {
return (Comment.size() > 3) && (Comment[3] == '<');
}
} // unnamed namespace
RawComment::RawComment(const SourceManager &SourceMgr, SourceRange SR,
bool Merged) :
Range(SR), RawTextValid(false), IsAlmostTrailingComment(false),
BeginLineValid(false), EndLineValid(false) {
// Extract raw comment text, if possible.
if (getRawText(SourceMgr).empty()) {
Kind = CK_Invalid;
return;
}
if (!Merged) {
// Guess comment kind.
std::pair<CommentKind, bool> K = getCommentKind(RawText);
Kind = K.first;
IsTrailingComment = K.second;
IsAlmostTrailingComment = RawText.startswith("//<") ||
RawText.startswith("/*<");
} else {
Kind = CK_Merged;
IsTrailingComment = mergedCommentIsTrailingComment(RawText);
}
}
unsigned RawComment::getBeginLine(const SourceManager &SM) const {
if (BeginLineValid)
return BeginLine;
std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Range.getBegin());
BeginLine = SM.getLineNumber(LocInfo.first, LocInfo.second);
BeginLineValid = true;
return BeginLine;
}
unsigned RawComment::getEndLine(const SourceManager &SM) const {
if (EndLineValid)
return EndLine;
std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Range.getEnd());
EndLine = SM.getLineNumber(LocInfo.first, LocInfo.second);
EndLineValid = true;
return EndLine;
}
StringRef RawComment::getRawTextSlow(const SourceManager &SourceMgr) const {
FileID BeginFileID;
FileID EndFileID;
unsigned BeginOffset;
unsigned EndOffset;
llvm::tie(BeginFileID, BeginOffset) =
SourceMgr.getDecomposedLoc(Range.getBegin());
llvm::tie(EndFileID, EndOffset) =
SourceMgr.getDecomposedLoc(Range.getEnd());
const unsigned Length = EndOffset - BeginOffset;
if (Length < 2)
return StringRef();
// The comment can't begin in one file and end in another.
assert(BeginFileID == EndFileID);
bool Invalid = false;
const char *BufferStart = SourceMgr.getBufferData(BeginFileID,
&Invalid).data();
if (Invalid)
return StringRef();
return StringRef(BufferStart + BeginOffset, Length);
}
namespace {
bool containsOnlyWhitespace(StringRef Str) {
return Str.find_first_not_of(" \t\f\v\r\n") == StringRef::npos;
}
bool onlyWhitespaceBetweenComments(SourceManager &SM,
const RawComment &C1, const RawComment &C2) {
std::pair<FileID, unsigned> C1EndLocInfo = SM.getDecomposedLoc(
C1.getSourceRange().getEnd());
std::pair<FileID, unsigned> C2BeginLocInfo = SM.getDecomposedLoc(
C2.getSourceRange().getBegin());
// Question does not make sense if comments are located in different files.
if (C1EndLocInfo.first != C2BeginLocInfo.first)
return false;
bool Invalid = false;
const char *Buffer = SM.getBufferData(C1EndLocInfo.first, &Invalid).data();
if (Invalid)
return false;
StringRef TextBetweenComments(Buffer + C1EndLocInfo.second,
C2BeginLocInfo.second - C1EndLocInfo.second);
return containsOnlyWhitespace(TextBetweenComments);
}
} // unnamed namespace
void RawCommentList::addComment(const RawComment &RC) {
if (RC.isInvalid())
return;
assert((Comments.empty() ||
Comments.back().getSourceRange().getEnd() ==
RC.getSourceRange().getBegin() ||
SourceMgr.isBeforeInTranslationUnit(
Comments.back().getSourceRange().getEnd(),
RC.getSourceRange().getBegin())) &&
"comments are not coming in source order");
if (OnlyWhitespaceSeen) {
if (!onlyWhitespaceBetweenComments(SourceMgr, LastComment, RC))
OnlyWhitespaceSeen = false;
}
LastComment = RC;
// Ordinary comments are not interesting for us.
if (RC.isOrdinary())
return;
// If this is the first Doxygen comment, save it (because there isn't
// anything to merge it with).
if (Comments.empty()) {
Comments.push_back(RC);
OnlyWhitespaceSeen = true;
return;
}
const RawComment &C1 = Comments.back();
const RawComment &C2 = RC;
// Merge comments only if there is only whitespace between them.
// Can't merge trailing and non-trailing comments.
// Merge trailing comments if they are on same or consecutive lines.
if (OnlyWhitespaceSeen &&
(C1.isTrailingComment() == C2.isTrailingComment()) &&
(!C1.isTrailingComment() ||
C1.getEndLine(SourceMgr) + 1 >= C2.getBeginLine(SourceMgr))) {
SourceRange MergedRange(C1.getSourceRange().getBegin(),
C2.getSourceRange().getEnd());
RawComment Merged(SourceMgr, MergedRange, true);
Comments.pop_back();
Comments.push_back(Merged);
} else
Comments.push_back(RC);
OnlyWhitespaceSeen = true;
}
|
