Author: krasimir Date: Thu Nov 9 07:41:23 2017 New Revision: 317794 URL: http://llvm.org/viewvc/llvm-project?rev=317794&view=rev Log: [clang-format] Sort using declarations by splitting on '::'
Summary: This patch improves using declarations sorting. Reviewers: bkramer Reviewed By: bkramer Subscribers: cfe-commits, klimek Differential Revision: https://reviews.llvm.org/D39786 Modified: cfe/trunk/docs/ClangFormatStyleOptions.rst cfe/trunk/docs/tools/dump_format_style.py cfe/trunk/include/clang/Format/Format.h cfe/trunk/lib/Format/UsingDeclarationsSorter.cpp cfe/trunk/unittests/Format/UsingDeclarationsSorterTest.cpp Modified: cfe/trunk/docs/ClangFormatStyleOptions.rst URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/ClangFormatStyleOptions.rst?rev=317794&r1=317793&r2=317794&view=diff ============================================================================== --- cfe/trunk/docs/ClangFormatStyleOptions.rst (original) +++ cfe/trunk/docs/ClangFormatStyleOptions.rst Thu Nov 9 07:41:23 2017 @@ -266,13 +266,9 @@ the configuration (without a prefix: ``A .. code-block:: c++ - true: - int a; // My comment a - int b = 2; // comment b - - false: - int a; // My comment a - int b = 2; // comment about b + true: false: + int a; // My comment a vs. int a; // My comment a + int b = 2; // comment b int b = 2; // comment about b **AllowAllParametersOfDeclarationOnNextLine** (``bool``) If the function declaration doesn't fit on a line, @@ -1541,6 +1537,26 @@ the configuration (without a prefix: ``A +**RawStringFormats** (``std::vector<RawStringFormat>``) + Raw string delimiters denoting that the raw string contents are + code in a particular language and can be reformatted. + + A raw string with a matching delimiter will be reformatted assuming the + specified language based on a predefined style given by 'BasedOnStyle'. + If 'BasedOnStyle' is not found, the formatting is based on llvm style. + + To configure this in the .clang-format file, use: + + .. code-block:: yaml + + RawStringFormats: + - Delimiter: 'pb' + Language: TextProto + BasedOnStyle: llvm + - Delimiter: 'proto' + Language: TextProto + BasedOnStyle: google + **ReflowComments** (``bool``) If ``true``, clang-format will attempt to re-flow comments. @@ -1573,6 +1589,13 @@ the configuration (without a prefix: ``A false: true: using std::cout; vs. using std::cin; using std::cin; using std::cout; + The order of using declarations is defined as follows: + Split the strings by "::" and discard any initial empty strings. The last + element of each list is a non-namespace name; all others are namespace + names. Sort the lists of names lexicographically, where the sort order of + individual names is that all non-namespace names come before all namespace + names, and within those groups, names are in case-insensitive + lexicographic order. **SpaceAfterCStyleCast** (``bool``) If ``true``, a space is inserted after C style casts. Modified: cfe/trunk/docs/tools/dump_format_style.py URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/tools/dump_format_style.py?rev=317794&r1=317793&r2=317794&view=diff ============================================================================== --- cfe/trunk/docs/tools/dump_format_style.py (original) +++ cfe/trunk/docs/tools/dump_format_style.py Thu Nov 9 07:41:23 2017 @@ -177,7 +177,8 @@ def read_options(header): for option in options: if not option.type in ['bool', 'unsigned', 'int', 'std::string', 'std::vector<std::string>', - 'std::vector<IncludeCategory>']: + 'std::vector<IncludeCategory>', + 'std::vector<RawStringFormat>']: if enums.has_key(option.type): option.enum = enums[option.type] elif nested_structs.has_key(option.type): Modified: cfe/trunk/include/clang/Format/Format.h URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Format/Format.h?rev=317794&r1=317793&r2=317794&view=diff ============================================================================== --- cfe/trunk/include/clang/Format/Format.h (original) +++ cfe/trunk/include/clang/Format/Format.h Thu Nov 9 07:41:23 2017 @@ -1390,6 +1390,13 @@ struct FormatStyle { /// using std::cout; vs. using std::cin; /// using std::cin; using std::cout; /// \endcode + /// The order of using declarations is defined as follows: + /// Split the strings by "::" and discard any initial empty strings. The last + /// element of each list is a non-namespace name; all others are namespace + /// names. Sort the lists of names lexicographically, where the sort order of + /// individual names is that all non-namespace names come before all namespace + /// names, and within those groups, names are in case-insensitive + /// lexicographic order. bool SortUsingDeclarations; /// \brief If ``true``, a space is inserted after C style casts. Modified: cfe/trunk/lib/Format/UsingDeclarationsSorter.cpp URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Format/UsingDeclarationsSorter.cpp?rev=317794&r1=317793&r2=317794&view=diff ============================================================================== --- cfe/trunk/lib/Format/UsingDeclarationsSorter.cpp (original) +++ cfe/trunk/lib/Format/UsingDeclarationsSorter.cpp Thu Nov 9 07:41:23 2017 @@ -26,6 +26,45 @@ namespace format { namespace { +// The order of using declaration is defined as follows: +// Split the strings by "::" and discard any initial empty strings. The last +// element of each list is a non-namespace name; all others are namespace +// names. Sort the lists of names lexicographically, where the sort order of +// individual names is that all non-namespace names come before all namespace +// names, and within those groups, names are in case-insensitive lexicographic +// order. +int compareLabels(StringRef A, StringRef B) { + SmallVector<StringRef, 2> NamesA; + A.split(NamesA, "::", /*MaxSplit=*/-1, /*KeepEmpty=*/false); + SmallVector<StringRef, 2> NamesB; + B.split(NamesB, "::", /*MaxSplit=*/-1, /*KeepEmpty=*/false); + size_t SizeA = NamesA.size(); + size_t SizeB = NamesB.size(); + for (size_t I = 0, E = std::min(SizeA, SizeB); I < E; ++I) { + if (I + 1 == SizeA) { + // I is the last index of NamesA and NamesA[I] is a non-namespace name. + + // Non-namespace names come before all namespace names. + if (SizeB > SizeA) + return -1; + + // Two names within a group compare case-insensitively. + return NamesA[I].compare_lower(NamesB[I]); + } + + // I is the last index of NamesB and NamesB[I] is a non-namespace name. + // Non-namespace names come before all namespace names. + if (I + 1 == SizeB) + return 1; + + // Two namespaces names within a group compare case-insensitively. + int C = NamesA[I].compare_lower(NamesB[I]); + if (C != 0) + return C; + } + return 0; +} + struct UsingDeclaration { const AnnotatedLine *Line; std::string Label; @@ -33,27 +72,8 @@ struct UsingDeclaration { UsingDeclaration(const AnnotatedLine *Line, const std::string &Label) : Line(Line), Label(Label) {} - // Compares lexicographically with the exception that '_' is just before 'A'. bool operator<(const UsingDeclaration &Other) const { - size_t Size = Label.size(); - size_t OtherSize = Other.Label.size(); - for (size_t I = 0, E = std::min(Size, OtherSize); I < E; ++I) { - char Rank = rank(Label[I]); - char OtherRank = rank(Other.Label[I]); - if (Rank != OtherRank) - return Rank < OtherRank; - } - return Size < OtherSize; - } - - // Returns the position of c in a lexicographic ordering with the exception - // that '_' is just before 'A'. - static char rank(char c) { - if (c == '_') - return 'A'; - if ('A' <= c && c < '_') - return c + 1; - return c; + return compareLabels(Label, Other.Label) < 0; } }; Modified: cfe/trunk/unittests/Format/UsingDeclarationsSorterTest.cpp URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/unittests/Format/UsingDeclarationsSorterTest.cpp?rev=317794&r1=317793&r2=317794&view=diff ============================================================================== --- cfe/trunk/unittests/Format/UsingDeclarationsSorterTest.cpp (original) +++ cfe/trunk/unittests/Format/UsingDeclarationsSorterTest.cpp Thu Nov 9 07:41:23 2017 @@ -50,8 +50,8 @@ TEST_F(UsingDeclarationsSorterTest, Swap "using aa;", sortUsingDeclarations("using aa;\n" "using a;")); - EXPECT_EQ("using ::a;\n" - "using a;", + EXPECT_EQ("using a;\n" + "using ::a;", sortUsingDeclarations("using a;\n" "using ::a;")); @@ -86,21 +86,32 @@ TEST_F(UsingDeclarationsSorterTest, Swap "using a, b;")); } -TEST_F(UsingDeclarationsSorterTest, SortsCaseSensitively) { +TEST_F(UsingDeclarationsSorterTest, UsingDeclarationOrder) { EXPECT_EQ("using A;\n" "using a;", sortUsingDeclarations("using A;\n" "using a;")); - EXPECT_EQ("using A;\n" - "using a;", + EXPECT_EQ("using a;\n" + "using A;", sortUsingDeclarations("using a;\n" "using A;")); - EXPECT_EQ("using B;\n" - "using a;", + EXPECT_EQ("using a;\n" + "using B;", sortUsingDeclarations("using B;\n" "using a;")); - // Sorts '_' right before 'A'. + // Ignores leading '::'. + EXPECT_EQ("using ::a;\n" + "using A;", + sortUsingDeclarations("using ::a;\n" + "using A;")); + + EXPECT_EQ("using ::A;\n" + "using a;", + sortUsingDeclarations("using ::A;\n" + "using a;")); + + // Sorts '_' before 'a' and 'A'. EXPECT_EQ("using _;\n" "using A;", sortUsingDeclarations("using A;\n" @@ -114,18 +125,58 @@ TEST_F(UsingDeclarationsSorterTest, Sort sortUsingDeclarations("using a::a;\n" "using a::_;")); + // Sorts non-namespace names before namespace names at the same level. EXPECT_EQ("using ::testing::_;\n" "using ::testing::Aardvark;\n" + "using ::testing::kMax;\n" "using ::testing::Xylophone;\n" "using ::testing::apple::Honeycrisp;\n" "using ::testing::zebra::Stripes;", sortUsingDeclarations("using ::testing::Aardvark;\n" "using ::testing::Xylophone;\n" + "using ::testing::kMax;\n" "using ::testing::_;\n" "using ::testing::apple::Honeycrisp;\n" "using ::testing::zebra::Stripes;")); } +TEST_F(UsingDeclarationsSorterTest, SortsStably) { + EXPECT_EQ("using a;\n" + "using a;\n" + "using A;\n" + "using a;\n" + "using A;\n" + "using a;\n" + "using A;\n" + "using a;\n" + "using B;\n" + "using b;\n" + "using b;\n" + "using B;\n" + "using b;\n" + "using b;\n" + "using b;\n" + "using B;\n" + "using b;", + sortUsingDeclarations("using a;\n" + "using B;\n" + "using a;\n" + "using b;\n" + "using A;\n" + "using a;\n" + "using b;\n" + "using B;\n" + "using b;\n" + "using A;\n" + "using a;\n" + "using b;\n" + "using b;\n" + "using B;\n" + "using b;\n" + "using A;\n" + "using a;")); +} + TEST_F(UsingDeclarationsSorterTest, SortsMultipleTopLevelDeclarations) { EXPECT_EQ("using a;\n" "using b;\n" @@ -139,14 +190,14 @@ TEST_F(UsingDeclarationsSorterTest, Sort "using c;")); EXPECT_EQ("#include <iostream>\n" - "using ::std::endl;\n" "using std::cin;\n" "using std::cout;\n" + "using ::std::endl;\n" "int main();", sortUsingDeclarations("#include <iostream>\n" "using std::cout;\n" - "using std::cin;\n" "using ::std::endl;\n" + "using std::cin;\n" "int main();")); } _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
