mprobst updated this revision to Diff 59001.
mprobst added a comment.
- extract method for readability
http://reviews.llvm.org/D20798
Files:
lib/Format/Format.cpp
lib/Format/SortJavaScriptImports.cpp
unittests/Format/SortImportsTestJS.cpp
Index: unittests/Format/SortImportsTestJS.cpp
===================================================================
--- unittests/Format/SortImportsTestJS.cpp
+++ unittests/Format/SortImportsTestJS.cpp
@@ -101,6 +101,13 @@
"import {sym1 as alias1} from 'b';\n");
}
+TEST_F(SortImportsTestJS, SortSymbols) {
+ verifySort("import {sym1, sym2 as a, sym3} from 'b';\n",
+ "import {sym2 as a, sym1, sym3} from 'b';\n");
+ verifySort("import {sym1 /* important! */, /*!*/ sym2 as a} from 'b';\n",
+ "import {/*!*/ sym2 as a, sym1 /* important! */} from 'b';\n");
+}
+
TEST_F(SortImportsTestJS, GroupImports) {
verifySort("import {a} from 'absolute';\n"
"\n"
Index: lib/Format/SortJavaScriptImports.cpp
===================================================================
--- lib/Format/SortJavaScriptImports.cpp
+++ lib/Format/SortJavaScriptImports.cpp
@@ -25,6 +25,7 @@
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/Debug.h"
+#include <algorithm>
#include <string>
#define DEBUG_TYPE "format-formatter"
@@ -40,6 +41,11 @@
struct JsImportedSymbol {
StringRef Symbol;
StringRef Alias;
+ SourceRange Range;
+
+ bool operator==(const JsImportedSymbol &RHS) const {
+ return Symbol == RHS.Symbol && Alias == RHS.Alias;
+ }
};
// An ES6 module reference.
@@ -139,23 +145,14 @@
[&](unsigned LHSI, unsigned RHSI) {
return References[LHSI] < References[RHSI];
});
- // FIXME: Pull this into a common function.
- bool OutOfOrder = false;
- for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
- if (i != Indices[i]) {
- OutOfOrder = true;
- break;
- }
- }
- if (!OutOfOrder)
- return Result;
+ bool ReferencesInOrder = std::is_sorted(Indices.begin(), Indices.end());
- // Replace all existing import/export statements.
std::string ReferencesText;
+ bool SymbolsInOrder = true;
for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
JsModuleReference Reference = References[Indices[i]];
- StringRef ReferenceStmt = getSourceText(Reference.Range);
- ReferencesText += ReferenceStmt;
+ if (appendReference(ReferencesText, Reference))
+ SymbolsInOrder = false;
if (i + 1 < e) {
// Insert breaks between imports and exports.
ReferencesText += "\n";
@@ -167,6 +164,11 @@
ReferencesText += "\n";
}
}
+
+ if (ReferencesInOrder && SymbolsInOrder) {
+ return Result;
+ }
+
// Separate references from the main code body of the file.
if (FirstNonImportLine && FirstNonImportLine->First->NewlinesBefore < 2)
ReferencesText += "\n";
@@ -211,10 +213,44 @@
}
StringRef getSourceText(SourceRange Range) {
+ return getSourceText(Range.getBegin(), Range.getEnd());
+ }
+
+ StringRef getSourceText(SourceLocation Begin, SourceLocation End) {
const SourceManager &SM = Env.getSourceManager();
- return FileContents.substr(SM.getFileOffset(Range.getBegin()),
- SM.getFileOffset(Range.getEnd()) -
- SM.getFileOffset(Range.getBegin()));
+ return FileContents.substr(SM.getFileOffset(Begin),
+ SM.getFileOffset(End) - SM.getFileOffset(Begin));
+ }
+
+ // Appends ``Reference`` to ``Buffer``, returning true if text within the
+ // ``Reference`` changed (e.g. symbol order).
+ bool appendReference(std::string &Buffer, JsModuleReference &Reference) {
+ // Sort the individual symbols within the import.
+ // E.g. `import {b, a} from 'x';` -> `import {a, b} from 'x';`
+ SmallVector<JsImportedSymbol, 1> Symbols = Reference.Symbols;
+ std::stable_sort(Symbols.begin(), Symbols.end(),
+ [&](JsImportedSymbol LHS, JsImportedSymbol RHS) {
+ return LHS.Symbol < RHS.Symbol;
+ });
+ if (Symbols == Reference.Symbols) {
+ // No change in symbol order.
+ StringRef ReferenceStmt = getSourceText(Reference.Range);
+ Buffer += ReferenceStmt;
+ return false;
+ }
+ // Stitch together the module reference start...
+ SourceLocation SymbolsStart = Reference.Symbols.front().Range.getBegin();
+ SourceLocation SymbolsEnd = Reference.Symbols.back().Range.getEnd();
+ Buffer += getSourceText(Reference.Range.getBegin(), SymbolsStart);
+ // ... then the references in order ...
+ for (JsImportedSymbol *I = Symbols.begin(), *E = Symbols.end(); I != E;) {
+ Buffer += getSourceText(I->Range);
+ if (++I != E)
+ Buffer += ",";
+ }
+ // ... followed by the module reference end.
+ Buffer += getSourceText(SymbolsEnd, Reference.Range.getEnd());
+ return true;
}
// Parses module references in the given lines. Returns the module references,
@@ -350,6 +386,9 @@
JsImportedSymbol Symbol;
Symbol.Symbol = Current->TokenText;
+ // Make sure to include any preceding comments.
+ Symbol.Range.setBegin(
+ Current->getPreviousNonComment()->Next->WhitespaceRange.getBegin());
nextToken();
if (Current->is(Keywords.kw_as)) {
@@ -359,6 +398,7 @@
Symbol.Alias = Current->TokenText;
nextToken();
}
+ Symbol.Range.setEnd(Current->Tok.getLocation());
Reference.Symbols.push_back(Symbol);
if (Current->is(tok::r_brace))
Index: lib/Format/Format.cpp
===================================================================
--- lib/Format/Format.cpp
+++ lib/Format/Format.cpp
@@ -34,6 +34,7 @@
#include "llvm/Support/Path.h"
#include "llvm/Support/Regex.h"
#include "llvm/Support/YAMLTraits.h"
+#include <algorithm>
#include <memory>
#include <queue>
#include <string>
@@ -1225,14 +1226,8 @@
// If the #includes are out of order, we generate a single replacement fixing
// the entire block. Otherwise, no replacement is generated.
- bool OutOfOrder = false;
- for (unsigned i = 1, e = Indices.size(); i != e; ++i) {
- if (Indices[i] != i) {
- OutOfOrder = true;
- break;
- }
- }
- if (!OutOfOrder)
+ bool InOrder = std::is_sorted(Indices.begin(), Indices.end());
+ if (InOrder)
return;
std::string result;
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
