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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* Based on LLVM/Clang.
*
* This file is distributed under the University of Illinois Open Source
* License. See LICENSE.TXT for details.
*
*/
#ifndef LO_CLANG_SHARED_PLUGINS
#include <cassert>
#include <string>
#include <iostream>
#include <fstream>
#include <set>
#include "plugin.hxx"
/*
Check for child statements inside a compound statement that do not share the same indentation.
TODO if an open-brace starts on a new line by itself, check that it lines up with it's closing-brace
TODO else should line up with if
*/
namespace
{
class Indentation : public loplugin::FilteringPlugin<Indentation>
{
public:
explicit Indentation(loplugin::InstantiationData const& data)
: FilteringPlugin(data)
{
}
virtual bool preRun() override
{
std::string fn(handler.getMainFileName());
loplugin::normalizeDotDotInFilePath(fn);
// include another file to build a table
if (fn == SRCDIR "/sc/source/core/tool/cellkeytranslator.cxx")<--- If condition 'fn==SRCDIR' is true, the function will return/exit
return false;
// weird structure
if (fn == SRCDIR "/sc/source/core/tool/compiler.cxx")<--- Testing identical condition 'fn==SRCDIR'<--- If condition 'fn==SRCDIR' is true, the function will return/exit
return false;
// looks like lex/yacc output
if (fn == SRCDIR "/hwpfilter/source/grammar.cxx")<--- Testing identical condition 'fn==SRCDIR'
return false;
// the QEMIT macros
if (loplugin::hasPathnamePrefix(fn, SRCDIR "/vcl/qt5/")
|| loplugin::isSamePathname(fn, SRCDIR "/vcl/unx/gtk3_kde5/kde5_filepicker_ipc.cxx"))
return false;
return true;
}
virtual void run() override
{
if (preRun())
TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
}
bool VisitCompoundStmt(CompoundStmt const*);
bool PreTraverseSwitchStmt(SwitchStmt*);
bool PostTraverseSwitchStmt(SwitchStmt*, bool);
bool TraverseSwitchStmt(SwitchStmt*);
bool VisitSwitchStmt(SwitchStmt const*);
private:
std::vector<const Stmt*> switchStmtBodies;
};
bool Indentation::PreTraverseSwitchStmt(SwitchStmt* switchStmt)
{
switchStmtBodies.push_back(switchStmt->getBody());
return true;
}
bool Indentation::PostTraverseSwitchStmt(SwitchStmt*, bool)
{
switchStmtBodies.pop_back();
return true;
}
bool Indentation::TraverseSwitchStmt(SwitchStmt* switchStmt)
{
PreTraverseSwitchStmt(switchStmt);
auto ret = FilteringPlugin::TraverseSwitchStmt(switchStmt);
PostTraverseSwitchStmt(switchStmt, ret);
return ret;
}
bool Indentation::VisitCompoundStmt(CompoundStmt const* compoundStmt)
{
if (ignoreLocation(compoundStmt))
return true;
// these are kind of free form
if (!switchStmtBodies.empty() && switchStmtBodies.back() == compoundStmt)
return true;
constexpr unsigned MAX = std::numeric_limits<unsigned>::max();
unsigned column = MAX;
Stmt const* firstStmt = nullptr;
unsigned curLine = MAX;
unsigned prevLine = MAX;
SourceLocation prevEnd;
auto& SM = compiler.getSourceManager();
for (auto i = compoundStmt->body_begin(); i != compoundStmt->body_end(); ++i)
{
auto stmt = *i;
auto const actualPrevEnd = prevEnd;
prevEnd = compat::getEndLoc(stmt); // compute early, before below `continue`s
// these show up in macro expansions, not interesting
if (isa<NullStmt>(stmt))
continue;
// these are always weirdly indented
if (isa<LabelStmt>(stmt))
continue;
#if CLANG_VERSION < 100000
// Before
// <https://github.com/llvm/llvm-project/commit/dc3957ec215dd17b8d293461f18696566637a6cd>
// "Include leading attributes in DeclStmt's SourceRange", getBeginLoc of a VarDecl DeclStmt
// with an UnusedAttr pointed after the attr (and getLocation of the attr pointed at
// "maybe_unused", not at the leading "[["), so just ignore those in old compiler versions:
if (auto const declStmt = dyn_cast<DeclStmt>(stmt))
{
if (declStmt->decl_begin() != declStmt->decl_end())
{
if (auto const decl = dyn_cast<VarDecl>(*declStmt->decl_begin()))
{
if (decl->hasAttr<UnusedAttr>())
{
continue;
}
}
}
}
#endif
auto stmtLoc = compat::getBeginLoc(stmt);
StringRef macroName;
bool partOfMacro = false;
if (SM.isMacroArgExpansion(stmtLoc) || SM.isMacroBodyExpansion(stmtLoc))
{
partOfMacro = true;
macroName = Lexer::getImmediateMacroNameForDiagnostics(
stmtLoc, compiler.getSourceManager(), compiler.getLangOpts());
// CPPUNIT_TEST_SUITE/CPPUNIT_TEST/CPPUNIT_TEST_SUITE_END work together, so the one is indented inside the other
if (macroName == "CPPUNIT_TEST_SUITE")
continue;
// similar thing in dbaccess/
if (macroName == "DECL_PROP_IMPL")
continue;
// similar thing in forms/
if (macroName == "DECL_IFACE_PROP_IMPL" || macroName == "DECL_BOOL_PROP_IMPL")
continue;
#if CLANG_VERSION >= 70000
stmtLoc = SM.getExpansionRange(stmtLoc).getBegin();
#else
stmtLoc = SM.getExpansionRange(stmtLoc).first;
#endif
}
// check for comment to the left of the statement
{
const char* p1 = SM.getCharacterData(stmtLoc);
--p1;
bool foundComment = false;
while (*p1 && *p1 != '\n')
{
if (*p1 == '/')
{
foundComment = true;
break;
}
--p1;
}
if (foundComment)
continue;
}
bool invalid1 = false;
bool invalid2 = false;
unsigned tmpColumn = SM.getPresumedColumnNumber(stmtLoc, &invalid1);
unsigned tmpLine = SM.getPresumedLineNumber(stmtLoc, &invalid2);
if (invalid1 || invalid2)
continue;
prevLine = curLine;
curLine = tmpLine;
if (column == MAX)
{
column = tmpColumn;
firstStmt = stmt;
}
else if (curLine == prevLine)
{
// ignore multiple statements on same line
}
else if (column != tmpColumn)
{
if (containsPreprocessingConditionalInclusion(SourceRange(
locationAfterToken(compiler.getSourceManager().getExpansionLoc(actualPrevEnd)),
compiler.getSourceManager().getExpansionLoc(compat::getBeginLoc(stmt)))))
continue;
report(DiagnosticsEngine::Warning, "statement mis-aligned compared to neighbours %0",
stmtLoc)
<< macroName;
report(DiagnosticsEngine::Note, "measured against this one",
compat::getBeginLoc(firstStmt));
//getParentStmt(compoundStmt)->dump();
//stmt->dump();
}
if (!partOfMacro)
if (auto ifStmt = dyn_cast<IfStmt>(stmt))
{
auto bodyStmt = ifStmt->getThen();
if (bodyStmt && !isa<CompoundStmt>(bodyStmt))
{
stmtLoc = compat::getBeginLoc(bodyStmt);
invalid1 = false;
invalid2 = false;
unsigned bodyColumn = SM.getPresumedColumnNumber(stmtLoc, &invalid1);
unsigned bodyLine = SM.getPresumedLineNumber(stmtLoc, &invalid2);
if (invalid1 || invalid2)
return true;
if (bodyLine != tmpLine && bodyColumn <= tmpColumn)
report(DiagnosticsEngine::Warning, "if body should be indented", stmtLoc);
}
auto elseStmt = ifStmt->getElse();
if (elseStmt && !isa<CompoundStmt>(elseStmt) && !isa<IfStmt>(elseStmt))
{
stmtLoc = compat::getBeginLoc(elseStmt);
invalid1 = false;
invalid2 = false;
unsigned elseColumn = SM.getPresumedColumnNumber(stmtLoc, &invalid1);
unsigned elseLine = SM.getPresumedLineNumber(stmtLoc, &invalid2);
if (invalid1 || invalid2)
return true;
if (elseLine != tmpLine && elseColumn <= tmpColumn)
report(DiagnosticsEngine::Warning, "else body should be indented", stmtLoc);
}
if (elseStmt && !isa<CompoundStmt>(bodyStmt))
{
stmtLoc = ifStmt->getElseLoc();
invalid1 = false;
invalid2 = false;
unsigned elseColumn = SM.getPresumedColumnNumber(stmtLoc, &invalid1);
unsigned elseLine = SM.getPresumedLineNumber(stmtLoc, &invalid2);
if (invalid1 || invalid2)
return true;
if (elseLine != tmpLine && elseColumn != tmpColumn)
report(DiagnosticsEngine::Warning, "if and else not aligned", stmtLoc);
}
}
}
return true;
}
bool Indentation::VisitSwitchStmt(SwitchStmt const* switchStmt)<--- The function 'VisitSwitchStmt' is never used.
{
if (ignoreLocation(switchStmt))
return true;
constexpr unsigned MAX = std::numeric_limits<unsigned>::max();
unsigned column = MAX;
Stmt const* firstStmt = nullptr;
unsigned curLine = MAX;
unsigned prevLine = MAX;
auto& SM = compiler.getSourceManager();
auto compoundStmt = dyn_cast<CompoundStmt>(switchStmt->getBody());
if (!compoundStmt)
return true;
for (auto i = compoundStmt->body_begin(); i != compoundStmt->body_end(); ++i)
{
Stmt const* caseStmt = dyn_cast<CaseStmt>(*i);
if (!caseStmt)
caseStmt = dyn_cast<DefaultStmt>(*i);
if (!caseStmt)
continue;
auto stmtLoc = compat::getBeginLoc(caseStmt);
bool invalid1 = false;
bool invalid2 = false;
unsigned tmpColumn = SM.getPresumedColumnNumber(stmtLoc, &invalid1);
unsigned tmpLine = SM.getPresumedLineNumber(stmtLoc, &invalid2);
if (invalid1 || invalid2)
continue;
prevLine = curLine;
curLine = tmpLine;
if (column == MAX)
{
column = tmpColumn;
firstStmt = caseStmt;
}
else if (curLine == prevLine)
{
// ignore multiple statements on same line
}
else if (column != tmpColumn)
{
// disable this for now, ends up touching some very large switch statements in sw/ and sc/
(void)firstStmt;
// report(DiagnosticsEngine::Warning, "statement mis-aligned compared to neighbours",
// stmtLoc);
// report(DiagnosticsEngine::Note, "measured against this one",
// compat::getBeginLoc(firstStmt));
//getParentStmt(compoundStmt)->dump();
//stmt->dump();
}
}
return true;
}
loplugin::Plugin::Registration<Indentation> indentation("indentation");
} // namespace
#endif // LO_CLANG_SHARED_PLUGINS
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|