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/SetVector.h" 29 namespace reorder_fields {
31 using 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);
56 static 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 doesn't match definition.\n";
69 SmallVector<unsigned, 4> NewFieldsOrder;
70 for (
const auto &
Name : DesiredFieldsOrder) {
71 if (!NameToIndex.count(
Name)) {
72 llvm::errs() <<
"Field " <<
Name <<
" not found in definition.\n";
75 NewFieldsOrder.push_back(NameToIndex[
Name]);
77 assert(NewFieldsOrder.size() == NameToIndex.size());
78 return NewFieldsOrder;
85 std::map<std::string, tooling::Replacements> &Replacements) {
88 Context.getSourceManager(), Context.getLangOpts());
89 tooling::Replacement R(Context.getSourceManager(),
91 Context.getLangOpts());
92 consumeError(Replacements[R.getFilePath()].add(R));
99 static SmallSetVector<FieldDecl *, 1>
101 ASTContext &Context) {
102 SmallSetVector<FieldDecl *, 1>
Results;
108 match(findAll(memberExpr(hasObjectExpression(cxxThisExpr())).bind(
"ME")),
109 *Initializer->getInit(), Context);
110 for (BoundNodes &BN : FoundExprs)
111 if (
auto *MemExpr = BN.getNodeAs<MemberExpr>(
"ME"))
112 if (
auto *FD = dyn_cast<FieldDecl>(MemExpr->getMemberDecl()))
123 const RecordDecl *Definition, ArrayRef<unsigned> NewFieldsOrder,
124 const ASTContext &Context,
125 std::map<std::string, tooling::Replacements> &Replacements) {
126 assert(Definition &&
"Definition is null");
128 SmallVector<const FieldDecl *, 10> Fields;
129 for (
const auto *Field : Definition->fields())
130 Fields.push_back(Field);
133 for (
const auto *Field : Definition->fields()) {
134 const auto FieldIndex = Field->getFieldIndex();
135 if (Field->getAccess() != Fields[NewFieldsOrder[FieldIndex]]->getAccess()) {
136 llvm::errs() <<
"Currently reodering of fields with different accesses " 137 "is not supported\n";
142 for (
const auto *Field : Definition->fields()) {
143 const auto FieldIndex = Field->getFieldIndex();
144 if (FieldIndex == NewFieldsOrder[FieldIndex])
147 Fields[NewFieldsOrder[FieldIndex]]->getSourceRange(),
148 Context, Replacements);
159 const CXXConstructorDecl *CtorDecl, ArrayRef<unsigned> NewFieldsOrder,
161 std::map<std::string, tooling::Replacements> &Replacements) {
162 assert(CtorDecl &&
"Constructor declaration is null");
163 if (CtorDecl->isImplicit() || CtorDecl->getNumCtorInitializers() <= 1)
169 assert(CtorDecl->isThisDeclarationADefinition() &&
"Not a definition");
171 SmallVector<unsigned, 10> NewFieldsPositions(NewFieldsOrder.size());
172 for (
unsigned i = 0, e = NewFieldsOrder.size(); i < e; ++i)
173 NewFieldsPositions[NewFieldsOrder[i]] = i;
175 SmallVector<const CXXCtorInitializer *, 10> OldWrittenInitializersOrder;
176 SmallVector<const CXXCtorInitializer *, 10> NewWrittenInitializersOrder;
177 for (
const auto *Initializer : CtorDecl->inits()) {
178 if (!Initializer->isMemberInitializer() || !Initializer->isWritten())
182 const FieldDecl *ThisM = Initializer->getMember();
184 for (
const FieldDecl *UM : UsedMembers) {
185 if (NewFieldsPositions[UM->getFieldIndex()] >
186 NewFieldsPositions[ThisM->getFieldIndex()]) {
187 DiagnosticsEngine &DiagEngine = Context.getDiagnostics();
188 auto Description = (
"reordering field " + UM->getName() +
" after " +
189 ThisM->getName() +
" makes " + UM->getName() +
190 " uninitialized when used in init expression")
192 unsigned ID = DiagEngine.getDiagnosticIDs()->getCustomDiagID(
194 DiagEngine.Report(Initializer->getSourceLocation(), ID);
198 OldWrittenInitializersOrder.push_back(Initializer);
199 NewWrittenInitializersOrder.push_back(Initializer);
201 auto ByFieldNewPosition = [&](
const CXXCtorInitializer *LHS,
202 const CXXCtorInitializer *RHS) {
204 return NewFieldsPositions[LHS->getMember()->getFieldIndex()] <
205 NewFieldsPositions[RHS->getMember()->getFieldIndex()];
207 std::sort(std::begin(NewWrittenInitializersOrder),
208 std::end(NewWrittenInitializersOrder), ByFieldNewPosition);
209 assert(OldWrittenInitializersOrder.size() ==
210 NewWrittenInitializersOrder.size());
211 for (
unsigned i = 0, e = NewWrittenInitializersOrder.size(); i < e; ++i)
212 if (OldWrittenInitializersOrder[i] != NewWrittenInitializersOrder[i])
214 NewWrittenInitializersOrder[i]->getSourceRange(), Context,
223 const InitListExpr *InitListEx, ArrayRef<unsigned> NewFieldsOrder,
224 const ASTContext &Context,
225 std::map<std::string, tooling::Replacements> &Replacements) {
226 assert(InitListEx &&
"Init list expression is null");
229 if (!InitListEx->isExplicit())
233 if (
const auto *SyntacticForm = InitListEx->getSyntacticForm())
234 InitListEx = SyntacticForm;
236 if (!InitListEx->getNumInits())
238 if (InitListEx->getNumInits() != NewFieldsOrder.size()) {
239 llvm::errs() <<
"Currently only full initialization is supported\n";
242 for (
unsigned i = 0, e = InitListEx->getNumInits(); i < e; ++i)
243 if (i != NewFieldsOrder[i])
245 InitListEx->getInit(NewFieldsOrder[i])->getSourceRange(),
246 Context, Replacements);
253 ArrayRef<std::string> DesiredFieldsOrder;
254 std::map<std::string, tooling::Replacements> &Replacements;
257 ReorderingConsumer(StringRef RecordName,
258 ArrayRef<std::string> DesiredFieldsOrder,
259 std::map<std::string, tooling::Replacements> &Replacements)
260 :
RecordName(RecordName), DesiredFieldsOrder(DesiredFieldsOrder),
261 Replacements(Replacements) {}
263 ReorderingConsumer(
const ReorderingConsumer &) =
delete;
264 ReorderingConsumer &operator=(
const ReorderingConsumer &) =
delete;
266 void HandleTranslationUnit(ASTContext &Context)
override {
270 SmallVector<unsigned, 4> NewFieldsOrder =
272 if (NewFieldsOrder.empty())
278 const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD);
280 for (
const auto *C : CXXRD->ctors())
281 if (
const auto *
D = dyn_cast<CXXConstructorDecl>(C->getDefinition()))
283 NewFieldsOrder, Context, Replacements);
290 if (!CXXRD || CXXRD->isAggregate())
292 match(initListExpr(hasType(equalsNode(RD))).bind(
"initListExpr"),
295 Result.getNodeAs<InitListExpr>(
"initListExpr"), NewFieldsOrder,
296 Context, Replacements)) {
297 Replacements.clear();
305 return llvm::make_unique<ReorderingConsumer>(
RecordName, DesiredFieldsOrder,
static cl::opt< std::string > RecordName("record-name", cl::Required, cl::desc("The name of the struct/class."), cl::cat(ClangReorderFieldsCategory))
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 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 const RecordDecl * findDefinition(StringRef RecordName, ASTContext &Context)
Finds the definition of a record by name.
std::unique_ptr< ASTConsumer > newASTConsumer()
std::vector< CodeCompletionResult > Results
This file contains the declarations of the ReorderFieldsAction class and the FieldPosition struct...
static SmallVector< unsigned, 4 > getNewFieldsOrder(const RecordDecl *Definition, ArrayRef< std::string > DesiredFieldsOrder)
Calculates the new order of fields.
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...
std::vector< std::string > match(const SymbolIndex &I, const FuzzyFindRequest &Req, bool *Incomplete)
static constexpr llvm::StringLiteral Name
llvm::Optional< Range > getTokenRange(const SourceManager &SM, const LangOptions &LangOpts, SourceLocation TokLoc)
Returns the taken range at TokLoc.
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.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
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.