Add NamespaceCommentCheck to the Google module.

[alexfh]

Summary

This uses a bit hacky way to set the defaults for the spaces before
comments, but it's also one of the simplest ways. Fixed a bug with how the
SpacesBeforeComments option was used.

[djasper]

Hm.. Should we just move this to misc-? Doesn't seem to be specific to either Google or LLVM style..

clang-tidy/llvm/NamespaceCommentCheck.cpp

28

Maybe this should contain a string NameSpaceCommentPrefix so that we can configure more and e.g. also support:

namespace abc {
} // abc

[alexfh]

Moved NamespaceCommentCheck.* to clang-tidy/readability.

[alexfh]

clang-tidy/llvm/NamespaceCommentCheck.cpp

28

It could make sense once we have a style that can't be supported using existing approach.

[djasper]

Looks good, I think, although I find the display of added/deleted files a bit confusing.

clang-tidy/google/GoogleTidyModule.cpp

 #include "IntegerTypesCheck.h"
 #include "MemsetZeroLengthCheck.h"
 #include "NamedParameterCheck.h"
 #include "OverloadedUnaryAndCheck.h"
 #include "StringReferenceMemberCheck.h"
 #include "TodoCommentCheck.h"
 #include "UnnamedNamespaceInHeaderCheck.h"
 #include "UsingNamespaceDirectiveCheck.h"
+#include "../llvm/NamespaceCommentCheck.h"
 
 using namespace clang::ast_matchers;
 
 namespace clang {
 namespace tidy {
 
 class GoogleModule : public ClangTidyModule {
 public:
void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
     CheckFactories.registerCheck<runtime::MemsetZeroLengthCheck>(
         "google-runtime-memset");
     CheckFactories.registerCheck<readability::AvoidCStyleCastsCheck>(
         "google-readability-casting");
     CheckFactories.registerCheck<readability::NamedParameterCheck>(
         "google-readability-function");
     CheckFactories.registerCheck<readability::TodoCommentCheck>(
         "google-readability-todo");
+    CheckFactories.registerCheck<NamespaceCommentCheck>(
+        "google-readability-namespace-comments");
   }
 };
 
 // Register the GoogleTidyModule using this statically initialized variable.
 static ClangTidyModuleRegistry::Add<GoogleModule> X("google-module",
                                                     "Adds Google lint checks.");
 
 // This anchor is used to force the linker to link in the generated object file
 // and thus register the GoogleModule.
 volatile int GoogleModuleAnchorSource = 0;
 
 } // namespace tidy
 } // namespace clang

clang-tidy/llvm/NamespaceCommentCheck.cpp

 
 NamespaceCommentCheck::NamespaceCommentCheck(StringRef Name,
                                              ClangTidyContext *Context)
     : ClangTidyCheck(Name, Context),
       NamespaceCommentPattern("^/[/*] *(end (of )?)? *(anonymous|unnamed)? *"
                               "namespace( +([a-zA-Z0-9_]+))? *(\\*/)?$",
                               llvm::Regex::IgnoreCase),
       ShortNamespaceLines(Options.get("ShortNamespaceLines", 1u)),
-      SpacesBeforeComments(Options.get("SpacesBeforeComments", 1u)) {}
+      SpacesBeforeComments(Options.get("SpacesBeforeComments",
+                                       Name.startswith("google") ? 2u : 1u)) {}
 
 void NamespaceCommentCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
   Options.store(Opts, "ShortNamespaceLines", ShortNamespaceLines);
   Options.store(Opts, "SpacesBeforeComments", SpacesBeforeComments);
 }
 
 void NamespaceCommentCheck::registerMatchers(MatchFinder *Finder) {
   Finder->addMatcher(namespaceDecl().bind("namespace"), this);
 }
 
 bool locationsInSameFile(const SourceManager &Sources, SourceLocation Loc1,
                          SourceLocation Loc2) {
   return Loc1.isFileID() && Loc2.isFileID() &&
          Sources.getFileID(Loc1) == Sources.getFileID(Loc2);
 }
 
-std::string getNamespaceComment(const NamespaceDecl *ND, bool InsertLineBreak,
-                                unsigned SpacesBeforeComments) {
+std::string getNamespaceComment(const NamespaceDecl *ND, bool InsertLineBreak) {
   std::string Fix = "// namespace";
   if (!ND->isAnonymousNamespace())
-    Fix.append(std::string(SpacesBeforeComments, ' '))
-        .append(ND->getNameAsString());
+    Fix.append(" ").append(ND->getNameAsString());
   if (InsertLineBreak)
     Fix.append("\n");
   return Fix;
 }
 
 void NamespaceCommentCheck::check(const MatchFinder::MatchResult &Result) {
   const NamespaceDecl *ND = Result.Nodes.getNodeAs<NamespaceDecl>("namespace");
   const SourceManager &Sources = *Result.SourceManager;
if (NamespaceCommentPattern.match(Comment, &Groups)) {
 
       // Otherwise we need to fix the comment.
       NeedLineBreak = Comment.startswith("/*");
       CharSourceRange OldCommentRange = CharSourceRange::getCharRange(
           SourceRange(Loc, Loc.getLocWithOffset(Tok.getLength())));
       diag(Loc, "namespace closing comment refers to a wrong namespace '%0'")
           << NamespaceNameInComment
           << FixItHint::CreateReplacement(
-                 OldCommentRange,
-                 getNamespaceComment(ND, NeedLineBreak, SpacesBeforeComments));
+                 OldCommentRange, getNamespaceComment(ND, NeedLineBreak));
       return;
     }
 
     // This is not a recognized form of a namespace closing comment.
     // Leave line comment on the same line. Move block comment to the next line,
     // as it can be multi-line or there may be other tokens behind it.
     if (Comment.startswith("//"))
       NeedLineBreak = false;
   }
 
   diag(ND->getLocation(), "namespace not terminated with a closing comment")
-      << FixItHint::CreateInsertion(
-          AfterRBrace,
-          " " + getNamespaceComment(ND, NeedLineBreak, SpacesBeforeComments));
+      << FixItHint::CreateInsertion(AfterRBrace,
+                                    std::string(SpacesBeforeComments, ' ') +
+                                        getNamespaceComment(ND, NeedLineBreak));
 }
 
 } // namespace tidy
 } // namespace clang

test/clang-tidy/google-readability-namespace-comments.cpp

+// RUN: $(dirname %s)/check_clang_tidy_fix.sh %s google-readability-namespace-comments %t
+// REQUIRES: shell
+
+// CHECK-MESSAGES: :[[@LINE+2]]:11: warning: namespace not terminated with a closing comment [google-readability-namespace-comments]
+// CHECK-MESSAGES: :[[@LINE+2]]:11: warning: namespace not terminated with a closing comment [google-readability-namespace-comments]
+namespace n1 {
+namespace n2 {
+
+}
+}
+// CHECK-FIXES: }  // namespace n2
+// CHECK-FIXES: }  // namespace n1
+
+
+namespace short1 { namespace short2 { } }