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
|
//===--- NamespaceEndCommentsFixer.cpp --------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
///
/// \file
/// \brief This file implements NamespaceEndCommentsFixer, a TokenAnalyzer that
/// fixes namespace end comments.
///
//===----------------------------------------------------------------------===//
#include "NamespaceEndCommentsFixer.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Regex.h"
#define DEBUG_TYPE "namespace-end-comments-fixer"
namespace clang {
namespace format {
namespace {
// The maximal number of lines that a short namespace spans.
// Short namespaces don't need an end comment.
static const int kShortNamespaceMaxLines = 1;
// Matches a valid namespace end comment.
// Valid namespace end comments don't need to be edited.
static llvm::Regex kNamespaceCommentPattern =
llvm::Regex("^/[/*] *(end (of )?)? *(anonymous|unnamed)? *"
"namespace( +([a-zA-Z0-9:_]+))?\\.? *(\\*/)?$",
llvm::Regex::IgnoreCase);
// Computes the name of a namespace given the namespace token.
// Returns "" for anonymous namespace.
std::string computeName(const FormatToken *NamespaceTok) {
assert(NamespaceTok && NamespaceTok->is(tok::kw_namespace) &&
"expecting a namespace token");
std::string name = "";
// Collects all the non-comment tokens between 'namespace' and '{'.
const FormatToken *Tok = NamespaceTok->getNextNonComment();
while (Tok && !Tok->is(tok::l_brace)) {
name += Tok->TokenText;
Tok = Tok->getNextNonComment();
}
return name;
}
std::string computeEndCommentText(StringRef NamespaceName, bool AddNewline) {
std::string text = "// namespace";
if (!NamespaceName.empty()) {
text += ' ';
text += NamespaceName;
}
if (AddNewline)
text += '\n';
return text;
}
bool isShort(const FormatToken *NamespaceTok, const FormatToken *RBraceTok,
const SourceManager &SourceMgr) {
int StartLine =
SourceMgr.getSpellingLineNumber(NamespaceTok->Tok.getLocation());
int EndLine = SourceMgr.getSpellingLineNumber(RBraceTok->Tok.getLocation());
return EndLine - StartLine + 1 <= kShortNamespaceMaxLines;
}
bool hasEndComment(const FormatToken *RBraceTok) {
return RBraceTok->Next && RBraceTok->Next->is(tok::comment);
}
bool validEndComment(const FormatToken *RBraceTok, StringRef NamespaceName) {
assert(hasEndComment(RBraceTok));
const FormatToken *Comment = RBraceTok->Next;
SmallVector<StringRef, 7> Groups;
if (kNamespaceCommentPattern.match(Comment->TokenText, &Groups)) {
StringRef NamespaceNameInComment = Groups.size() > 5 ? Groups[5] : "";
// Anonymous namespace comments must not mention a namespace name.
if (NamespaceName.empty() && !NamespaceNameInComment.empty())
return false;
StringRef AnonymousInComment = Groups.size() > 3 ? Groups[3] : "";
// Named namespace comments must not mention anonymous namespace.
if (!NamespaceName.empty() && !AnonymousInComment.empty())
return false;
return NamespaceNameInComment == NamespaceName;
}
return false;
}
void addEndComment(const FormatToken *RBraceTok, StringRef EndCommentText,
const SourceManager &SourceMgr,
tooling::Replacements *Fixes) {
auto EndLoc = RBraceTok->Tok.getEndLoc();
auto Range = CharSourceRange::getCharRange(EndLoc, EndLoc);
auto Err = Fixes->add(tooling::Replacement(SourceMgr, Range, EndCommentText));
if (Err) {
llvm::errs() << "Error while adding namespace end comment: "
<< llvm::toString(std::move(Err)) << "\n";
}
}
void updateEndComment(const FormatToken *RBraceTok, StringRef EndCommentText,
const SourceManager &SourceMgr,
tooling::Replacements *Fixes) {
assert(hasEndComment(RBraceTok));
const FormatToken *Comment = RBraceTok->Next;
auto Range = CharSourceRange::getCharRange(Comment->getStartOfNonWhitespace(),
Comment->Tok.getEndLoc());
auto Err = Fixes->add(tooling::Replacement(SourceMgr, Range, EndCommentText));
if (Err) {
llvm::errs() << "Error while updating namespace end comment: "
<< llvm::toString(std::move(Err)) << "\n";
}
}
} // namespace
NamespaceEndCommentsFixer::NamespaceEndCommentsFixer(const Environment &Env,
const FormatStyle &Style)
: TokenAnalyzer(Env, Style) {}
tooling::Replacements NamespaceEndCommentsFixer::analyze(
TokenAnnotator &Annotator, SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
FormatTokenLexer &Tokens) {
const SourceManager &SourceMgr = Env.getSourceManager();
AffectedRangeMgr.computeAffectedLines(AnnotatedLines.begin(),
AnnotatedLines.end());
tooling::Replacements Fixes;
for (size_t I = 0, E = AnnotatedLines.size(); I != E; ++I) {
if (!AnnotatedLines[I]->Affected || AnnotatedLines[I]->InPPDirective ||
!AnnotatedLines[I]->startsWith(tok::r_brace))
continue;
const AnnotatedLine *EndLine = AnnotatedLines[I];
size_t StartLineIndex = EndLine->MatchingOpeningBlockLineIndex;
if (StartLineIndex == UnwrappedLine::kInvalidIndex)
continue;
assert(StartLineIndex < E);
const FormatToken *NamespaceTok = AnnotatedLines[StartLineIndex]->First;
// Detect "(inline)? namespace" in the beginning of a line.
if (NamespaceTok->is(tok::kw_inline))
NamespaceTok = NamespaceTok->getNextNonComment();
if (NamespaceTok->isNot(tok::kw_namespace))
continue;
const FormatToken *RBraceTok = EndLine->First;
const std::string NamespaceName = computeName(NamespaceTok);
bool AddNewline = (I + 1 < E) &&
AnnotatedLines[I + 1]->First->NewlinesBefore == 0 &&
AnnotatedLines[I + 1]->First->isNot(tok::eof);
const std::string EndCommentText =
computeEndCommentText(NamespaceName, AddNewline);
if (!hasEndComment(RBraceTok)) {
if (!isShort(NamespaceTok, RBraceTok, SourceMgr))
addEndComment(RBraceTok, EndCommentText, SourceMgr, &Fixes);
continue;
}
if (!validEndComment(RBraceTok, NamespaceName))
updateEndComment(RBraceTok, EndCommentText, SourceMgr, &Fixes);
}
return Fixes;
}
} // namespace format
} // namespace clang
|
