[clang-format] Make NamespaceEndCommentFixer add at most one comment

[krasimir]

Summary

Until now, NamespaceEndCommentFixer was adding missing comments for every run,
which results in multiple end comments for:

namespace {
  int i;
  int j;
}
#if A
  int a = 1;
#else
  int a = 2;
#endif

result before:

namespace {
  int i;
  int j;
}// namespace // namespace
#if A
  int a = 1;
#else
  int a = 2;
#endif

result after:

namespace {
  int i;
  int j;
}// namespace
#if A
  int a = 1;
#else
  int a = 2;
#endif

[djasper]

Would probably be interesting to add these test cases:

#if A
namespace A {
#else
namespace B {
#endif
int i;
int j;
}//namespace A

and:

namespace A {
int i;
int j;
#if A
}//namespace A
#else
}//namespace A
#endif

lib/Format/NamespaceEndCommentsFixer.cpp

139

Use clang-format :). (there should be a linebreak before "continue".

[krasimir]

• Added missing newline

lib/Format/NamespaceEndCommentsFixer.cpp

if (StartLineIndex == UnwrappedLine::kInvalidIndex)
       continue;
     assert(StartLineIndex < E);
     const FormatToken *NamespaceTok = AnnotatedLines[StartLineIndex]->First;
     // Detect "(inline)? namespace" in the beginning of a line.
     if (NamespaceTok->is(tok::kw_inline))
       NamespaceTok = NamespaceTok->getNextNonComment();
     if (NamespaceTok->isNot(tok::kw_namespace))
       continue;
-    const FormatToken *RBraceTok = EndLine->First;
+    FormatToken *RBraceTok = EndLine->First;
+    if (RBraceTok->Finalized) continue;
+    RBraceTok->Finalized = true;
     const std::string NamespaceName = computeName(NamespaceTok);
     bool AddNewline = (I + 1 < E) &&
                       AnnotatedLines[I + 1]->First->NewlinesBefore == 0 &&
                       AnnotatedLines[I + 1]->First->isNot(tok::eof);
     const std::string EndCommentText =
         computeEndCommentText(NamespaceName, AddNewline);
     if (!hasEndComment(RBraceTok)) {
       bool isShort = I - StartLineIndex <= kShortNamespaceMaxLines + 1;

unittests/Format/NamespaceEndCommentsFixerTest.cpp

EXPECT_EQ("#ifdef 1\n"
             fixNamespaceEndComments("#ifdef 1\n"
                                     "namespace A {\n"
                                     "#elseif\n"
                                     "namespace B {\n"
                                     "#endif\n"
                                     "  int i;\n"
                                     "}\n"
                                     "}\n"));
+  EXPECT_EQ("namespace {\n"
+            "  int i;\n"
+            "  int j;\n"
+            "}// namespace\n"
+            "#if A\n"
+            "  int i;\n"
+            "#else\n"
+            "  int j;\n"
+            "#endif",
+            fixNamespaceEndComments("namespace {\n"
+                                    "  int i;\n"
+                                    "  int j;\n"
+                                    "}\n"
+                                    "#if A\n"
+                                    "  int i;\n"
+                                    "#else\n"
+                                    "  int j;\n"
+                                    "#endif"));
 }
 
 TEST_F(NamespaceEndCommentsFixerTest,
        DoesNotAddEndCommentForUnbalancedRBracesAfterNamespaceEnd) {
   EXPECT_EQ("namespace {\n"
             "  int i;\n"
             "} // namespace\n"
             "}",
             fixNamespaceEndComments("namespace {\n"
                                     "  int i;\n"
                                     "} // namespace\n"
                                     "}"));
 }
 } // end namespace
 } // end namespace format
 } // end namespace clang