16#include "clang/AST/AST.h"
17#include "clang/AST/ASTConsumer.h"
18#include "clang/AST/ASTContext.h"
19#include "clang/AST/Decl.h"
20#include "clang/AST/RecursiveASTVisitor.h"
21#include "clang/ASTMatchers/ASTMatchFinder.h"
22#include "clang/Lex/Lexer.h"
23#include "clang/Tooling/Refactoring.h"
24#include "llvm/ADT/STLExtras.h"
25#include "llvm/ADT/SetVector.h"
29namespace reorder_fields {
31using llvm::SmallSetVector;
37 ASTContext &Context) {
39 match(recordDecl(hasName(RecordName), isDefinition()).bind(
"recordDecl"),
42 llvm::errs() <<
"Definition of " << RecordName <<
" not found\n";
46 llvm::errs() <<
"The name " << RecordName
47 <<
" is ambiguous, several definitions found\n";
50 return selectFirst<RecordDecl>(
"recordDecl",
Results);
56static SmallVector<unsigned, 4>
58 ArrayRef<std::string> DesiredFieldsOrder) {
59 assert(Definition &&
"Definition is null");
61 llvm::StringMap<unsigned> NameToIndex;
62 for (
const auto *
Field : Definition->fields())
63 NameToIndex[
Field->getName()] =
Field->getFieldIndex();
65 if (DesiredFieldsOrder.size() != NameToIndex.size()) {
66 llvm::errs() <<
"Number of provided fields (" << DesiredFieldsOrder.size()
67 <<
") doesn't match definition (" << NameToIndex.size()
71 SmallVector<unsigned, 4> NewFieldsOrder;
72 for (
const auto &
Name : DesiredFieldsOrder) {
73 if (!NameToIndex.count(
Name)) {
74 llvm::errs() <<
"Field " <<
Name <<
" not found in definition.\n";
77 NewFieldsOrder.push_back(NameToIndex[
Name]);
79 assert(NewFieldsOrder.size() == NameToIndex.size());
80 return NewFieldsOrder;
87 std::map<std::string, tooling::Replacements> &Replacements) {
89 Lexer::getSourceText(CharSourceRange::getTokenRange(New),
90 Context.getSourceManager(), Context.getLangOpts());
91 tooling::Replacement R(Context.getSourceManager(),
92 CharSourceRange::getTokenRange(Old), NewText,
93 Context.getLangOpts());
94 consumeError(Replacements[std::string(R.getFilePath())].add(R));
101static SmallSetVector<FieldDecl *, 1>
103 ASTContext &Context) {
104 SmallSetVector<FieldDecl *, 1>
Results;
109 auto FoundExprs = match(
112 findAll(memberExpr(hasObjectExpression(cxxThisExpr())).bind(
"ME"))),
113 *Initializer->getInit(), Context);
114 for (BoundNodes &BN : FoundExprs)
115 if (
auto *MemExpr = BN.getNodeAs<MemberExpr>(
"ME"))
116 if (
auto *FD = dyn_cast<FieldDecl>(MemExpr->getMemberDecl()))
123 const SourceManager &SM,
124 const LangOptions &LangOpts) {
127 const unsigned Line = SM.getPresumedLineNumber(
Loc);
128 const unsigned Column = SM.getPresumedColumnNumber(
Loc);
129 std::optional<Token> Tok =
130 Lexer::findPreviousToken(
Loc, SM, LangOpts,
true);
131 while (Tok && Tok->is(tok::comment)) {
132 const SourceLocation CommentLoc =
133 Lexer::GetBeginningOfToken(Tok->getLocation(), SM, LangOpts);
134 if (SM.getPresumedLineNumber(CommentLoc) !=
Line &&
135 SM.getPresumedColumnNumber(CommentLoc) !=
Column) {
139 Tok = Lexer::findPreviousToken(
Loc, SM, LangOpts,
true);
146 const SourceManager &SM,
147 const LangOptions &LangOpts) {
150 const unsigned Column = SM.getPresumedColumnNumber(
Loc);
151 std::optional<Token> Tok =
152 Lexer::findNextToken(
Loc, SM, LangOpts,
true);
153 while (Tok && Tok->is(tok::comment) &&
154 SM.getPresumedColumnNumber(Tok->getLocation()) >
Column) {
155 Loc = Tok->getEndLoc();
156 Tok = Lexer::findNextToken(
Loc, SM, LangOpts,
true);
165 const ASTContext &Context) {
166 const SourceRange
Range =
Field.getSourceRange();
167 SourceLocation Begin =
Range.getBegin();
168 SourceLocation End =
Range.getEnd();
169 const SourceManager &SM = Context.getSourceManager();
170 const LangOptions &LangOpts = Context.getLangOpts();
172 std::optional<Token> CurrentToken = Lexer::findNextToken(End, SM, LangOpts);
175 return SourceRange(Begin, End);
177 if (CurrentToken->is(tok::eof))
180 End = CurrentToken->getLastLoc();
182 if (CurrentToken->is(tok::semi))
187 return SourceRange(Begin, End);
196 const RecordDecl *Definition, ArrayRef<unsigned> NewFieldsOrder,
197 const ASTContext &Context,
198 std::map<std::string, tooling::Replacements> &Replacements) {
199 assert(Definition &&
"Definition is null");
201 SmallVector<const FieldDecl *, 10> Fields;
202 for (
const auto *
Field : Definition->fields())
203 Fields.push_back(
Field);
206 for (
const auto *
Field : Definition->fields()) {
207 const auto FieldIndex =
Field->getFieldIndex();
208 if (
Field->getAccess() != Fields[NewFieldsOrder[FieldIndex]]->getAccess()) {
209 llvm::errs() <<
"Currently reordering of fields with different accesses "
210 "is not supported\n";
215 for (
const auto *
Field : Definition->fields()) {
216 const auto FieldIndex =
Field->getFieldIndex();
217 if (FieldIndex == NewFieldsOrder[FieldIndex])
222 Context, Replacements);
233 const CXXConstructorDecl *CtorDecl, ArrayRef<unsigned> NewFieldsOrder,
235 std::map<std::string, tooling::Replacements> &Replacements) {
236 assert(CtorDecl &&
"Constructor declaration is null");
237 if (CtorDecl->isImplicit() || CtorDecl->getNumCtorInitializers() <= 1)
243 assert(CtorDecl->isThisDeclarationADefinition() &&
"Not a definition");
245 SmallVector<unsigned, 10> NewFieldsPositions(NewFieldsOrder.size());
246 for (
unsigned i = 0, e = NewFieldsOrder.size(); i < e; ++i)
247 NewFieldsPositions[NewFieldsOrder[i]] = i;
249 SmallVector<const CXXCtorInitializer *, 10> OldWrittenInitializersOrder;
250 SmallVector<const CXXCtorInitializer *, 10> NewWrittenInitializersOrder;
251 for (
const auto *Initializer : CtorDecl->inits()) {
252 if (!Initializer->isMemberInitializer() || !Initializer->isWritten())
256 const FieldDecl *ThisM = Initializer->getMember();
258 for (
const FieldDecl *UM : UsedMembers) {
259 if (NewFieldsPositions[UM->getFieldIndex()] >
260 NewFieldsPositions[ThisM->getFieldIndex()]) {
261 DiagnosticsEngine &DiagEngine = Context.getDiagnostics();
262 auto Description = (
"reordering field " + UM->getName() +
" after " +
263 ThisM->getName() +
" makes " + UM->getName() +
264 " uninitialized when used in init expression")
266 unsigned ID = DiagEngine.getDiagnosticIDs()->getCustomDiagID(
267 DiagnosticIDs::Warning, Description);
268 DiagEngine.Report(Initializer->getSourceLocation(),
ID);
272 OldWrittenInitializersOrder.push_back(Initializer);
273 NewWrittenInitializersOrder.push_back(Initializer);
275 auto ByFieldNewPosition = [&](
const CXXCtorInitializer *LHS,
276 const CXXCtorInitializer *RHS) {
278 return NewFieldsPositions[LHS->getMember()->getFieldIndex()] <
279 NewFieldsPositions[RHS->getMember()->getFieldIndex()];
281 llvm::sort(NewWrittenInitializersOrder, ByFieldNewPosition);
282 assert(OldWrittenInitializersOrder.size() ==
283 NewWrittenInitializersOrder.size());
284 for (
unsigned i = 0, e = NewWrittenInitializersOrder.size(); i < e; ++i)
285 if (OldWrittenInitializersOrder[i] != NewWrittenInitializersOrder[i])
287 NewWrittenInitializersOrder[i]->getSourceRange(), Context,
296 const InitListExpr *InitListEx, ArrayRef<unsigned> NewFieldsOrder,
297 const ASTContext &Context,
298 std::map<std::string, tooling::Replacements> &Replacements) {
299 assert(InitListEx &&
"Init list expression is null");
302 if (!InitListEx->isExplicit())
306 if (
const auto *SyntacticForm = InitListEx->getSyntacticForm())
307 InitListEx = SyntacticForm;
309 if (!InitListEx->getNumInits())
311 if (InitListEx->getNumInits() != NewFieldsOrder.size()) {
312 llvm::errs() <<
"Currently only full initialization is supported\n";
315 for (
unsigned i = 0, e = InitListEx->getNumInits(); i < e; ++i)
316 if (i != NewFieldsOrder[i])
318 InitListEx->getInit(NewFieldsOrder[i])->getSourceRange(),
319 Context, Replacements);
325 StringRef RecordName;
326 ArrayRef<std::string> DesiredFieldsOrder;
327 std::map<std::string, tooling::Replacements> &Replacements;
330 ReorderingConsumer(StringRef RecordName,
331 ArrayRef<std::string> DesiredFieldsOrder,
332 std::map<std::string, tooling::Replacements> &Replacements)
333 : RecordName(RecordName), DesiredFieldsOrder(DesiredFieldsOrder),
334 Replacements(Replacements) {}
336 ReorderingConsumer(
const ReorderingConsumer &) =
delete;
337 ReorderingConsumer &operator=(
const ReorderingConsumer &) =
delete;
339 void HandleTranslationUnit(ASTContext &Context)
override {
343 SmallVector<unsigned, 4> NewFieldsOrder =
345 if (NewFieldsOrder.empty())
351 const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD);
353 for (
const auto *
C : CXXRD->ctors())
354 if (
const auto *D = dyn_cast<CXXConstructorDecl>(
C->getDefinition()))
356 NewFieldsOrder, Context, Replacements);
363 if (!CXXRD || CXXRD->isAggregate())
365 match(initListExpr(hasType(equalsNode(RD))).bind(
"initListExpr"),
368 Result.getNodeAs<InitListExpr>(
"initListExpr"), NewFieldsOrder,
369 Context, Replacements)) {
370 Replacements.clear();
378 return std::make_unique<ReorderingConsumer>(RecordName, DesiredFieldsOrder,
llvm::SmallString< 256U > Name
std::vector< CodeCompletionResult > Results
CharSourceRange Range
SourceRange for the file name.
This file contains the declarations of the ReorderFieldsAction class and the FieldPosition struct.
std::unique_ptr< ASTConsumer > newASTConsumer()
static SourceLocation getStartOfLeadingComment(SourceLocation Loc, const SourceManager &SM, const LangOptions &LangOpts)
Returns the start of the leading comments before Loc.
static void reorderFieldsInConstructor(const CXXConstructorDecl *CtorDecl, ArrayRef< unsigned > NewFieldsOrder, ASTContext &Context, std::map< std::string, tooling::Replacements > &Replacements)
Reorders initializers in a C++ struct/class constructor.
static const RecordDecl * findDefinition(StringRef RecordName, ASTContext &Context)
Finds the definition of a record by name.
static bool reorderFieldsInInitListExpr(const InitListExpr *InitListEx, ArrayRef< unsigned > NewFieldsOrder, const ASTContext &Context, std::map< std::string, tooling::Replacements > &Replacements)
Reorders initializers in the brace initialization of an aggregate.
static void addReplacement(SourceRange Old, SourceRange New, const ASTContext &Context, std::map< std::string, tooling::Replacements > &Replacements)
Replaces one range of source code by another.
static SourceRange getFullFieldSourceRange(const FieldDecl &Field, const ASTContext &Context)
Returns the full source range for the field declaration up to (including) the trailing semicolumn,...
static SourceLocation getEndOfTrailingComment(SourceLocation Loc, const SourceManager &SM, const LangOptions &LangOpts)
Returns the end of the trailing comments after Loc.
static SmallSetVector< FieldDecl *, 1 > findMembersUsedInInitExpr(const CXXCtorInitializer *Initializer, ASTContext &Context)
Find all member fields used in the given init-list initializer expr that belong to the same record.
static bool reorderFieldsInDefinition(const RecordDecl *Definition, ArrayRef< unsigned > NewFieldsOrder, const ASTContext &Context, std::map< std::string, tooling::Replacements > &Replacements)
Reorders fields in the definition of a struct/class.
static SmallVector< unsigned, 4 > getNewFieldsOrder(const RecordDecl *Definition, ArrayRef< std::string > DesiredFieldsOrder)
Calculates the new order of fields.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//