[clang-tidy] Add a namespace checker.

[bkramer]

Summary

This warns on two constructs.

1. anonymous namespaces in header files.
2. using namespace directives everywhere.

[bkramer]

Remove test that should've been part of D4522.

[djasper]

clang-tidy/google/GoogleTidyModule.cpp

34–35

I think both the check name and the class Name should be more specific, e.g. UnnamedNamespaceInHeaderCheck. Or do you envision this to be a more generic check?

clang-tidy/google/NamespacesCheck.cpp

27 ↗

(On Diff #11455)

nit: I'd probably remove the empty lines inside the ast_matchers namespace but add an empty line before starting the tidy namespace.

clang-tidy/google/NamespacesCheck.h

19 ↗

(On Diff #11455)

IMO, "using namespace directives" should be detected in a separate check, there doesn't seem to be a strong relation to the empty namespaces in headers.

20 ↗

(On Diff #11455)

I actually don't think we should keep references to a different tool. The meaning of "build/namespaces" might change making this comment stale. This check is good on its own without a specific reference.

[alexfh]

clang-tidy/google/NamespacesCheck.h

19 ↗

(On Diff #11455)

nit: Add an empty line after the \brief line?

20 ↗

(On Diff #11455)

The main use of this is if we'll want to support categorized NOLINT comments: "// NOLINT(build/namespaces)", then it would be nice to have them in the same form.

[bkramer]

• Split into two checkers.
• Now depends on D4517.

[alexfh]

clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp

39

nit: I'd use early return instead.

42

The list of header file extensions may be a good candidate for being stored in ClangTidyOptions, so we can configure it when needed.

clang-tidy/google/UsingNamespaceDirectiveCheck.cpp

31

nit: Use early exit instead? (Especially, if we're going to implement fix-its)

32

Further down the line we may want to suggest the list of using declarations as a replacement. Could you add a TODO?

[bkramer]

clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp

42

Hmm, we don't have a way of accessing ClangTidyOptions from within a checker?

[alexfh]

clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp

42

Not yet. I meant, that we should do this in general, not necessarily now. Sorry for ambiguous language.

[bkramer]

Use early exits, add TODOs.

[alexfh]

Looks good. Thanks!

[bkramer]

Closed by commit rL213153 (authored by d0k).

clang-tidy/google/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS support)
 
 add_clang_library(clangTidyGoogleModule
   AvoidCStyleCastsCheck.cpp
   ExplicitConstructorCheck.cpp
   ExplicitMakePairCheck.cpp
   GoogleTidyModule.cpp
   NamedParameterCheck.cpp
   OverloadedUnaryAndCheck.cpp
   StringReferenceMemberCheck.cpp
+  UnnamedNamespaceInHeaderCheck.cpp
+  UsingNamespaceDirectiveCheck.cpp
 
   LINK_LIBS
   clangAST
   clangASTMatchers
   clangBasic
   clangLex
   clangTidy
   )

clang-tidy/google/GoogleTidyModule.cpp

 #include "../ClangTidyModule.h"
 #include "../ClangTidyModuleRegistry.h"
 #include "AvoidCStyleCastsCheck.h"
 #include "ExplicitConstructorCheck.h"
 #include "ExplicitMakePairCheck.h"
 #include "NamedParameterCheck.h"
 #include "OverloadedUnaryAndCheck.h"
 #include "StringReferenceMemberCheck.h"
+#include "UnnamedNamespaceInHeaderCheck.h"
+#include "UsingNamespaceDirectiveCheck.h"
 
 using namespace clang::ast_matchers;
 
 namespace clang {
 namespace tidy {
 
 class GoogleModule : public ClangTidyModule {
 public:
   void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
     CheckFactories.addCheckFactory(
         "google-build-explicit-make-pair",
         new ClangTidyCheckFactory<build::ExplicitMakePairCheck>());
     CheckFactories.addCheckFactory(
+        "google-build-namespaces",
+        new ClangTidyCheckFactory<build::UnnamedNamespaceInHeaderCheck>());
+    CheckFactories.addCheckFactory(
+        "google-build-using-namespace",
+        new ClangTidyCheckFactory<build::UsingNamespaceDirectiveCheck>());
+    CheckFactories.addCheckFactory(
         "google-explicit-constructor",
         new ClangTidyCheckFactory<ExplicitConstructorCheck>());
     CheckFactories.addCheckFactory(
         "google-runtime-operator",
         new ClangTidyCheckFactory<runtime::OverloadedUnaryAndCheck>());
     CheckFactories.addCheckFactory(
         "google-runtime-member-string-references",
         new ClangTidyCheckFactory<runtime::StringReferenceMemberCheck>());

clang-tidy/google/UnnamedNamespaceInHeaderCheck.h

+//===--- UnnamedNamespaceInHeaderCheck.h - clang-tidy -----------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_UNNAMED_NAMESPACE_IN_HEADER_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_UNNAMED_NAMESPACE_IN_HEADER_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+namespace build {
+
+/// \brief Finds anonymous namespaces in headers.
+///
+/// Corresponding cpplint.py check name: 'build/namespaces'.
+class UnnamedNamespaceInHeaderCheck : public ClangTidyCheck {
+public:
+  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+};
+
+} // namespace build
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_UNNAMED_NAMESPACE_IN_HEADER_H

clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp

+//===--- UnnamedNamespaceInHeaderCheck.cpp - clang-tidy ---------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "UnnamedNamespaceInHeaderCheck.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/ASTMatchers/ASTMatchers.h"
+#include "clang/AST/ASTContext.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace ast_matchers {
+AST_MATCHER(NamespaceDecl, isAnonymousNamespace) {
+  return Node.isAnonymousNamespace();
+}
+} // namespace ast_matchers
+
+namespace tidy {
+namespace build {
+
+void UnnamedNamespaceInHeaderCheck::registerMatchers(
+    ast_matchers::MatchFinder *Finder) {
+  Finder->addMatcher(
+      namespaceDecl(isAnonymousNamespace()).bind("anonymousNamespace"), this);
+}
+
+void
+UnnamedNamespaceInHeaderCheck::check(const MatchFinder::MatchResult &Result) {
+  SourceManager *SM = Result.SourceManager;
+  const auto *N = Result.Nodes.getNodeAs<NamespaceDecl>("anonymousNamespace");
+  SourceLocation Loc = N->getLocStart();
+  if (!Loc.isValid())
+    return;
+
+  // Look if we're inside a header, check for common suffixes only.
+  // TODO: Allow configuring the set of file extensions.
+  StringRef FileName = SM->getPresumedLoc(Loc).getFilename();
+  if (FileName.endswith(".h") || FileName.endswith(".hh") ||
+      FileName.endswith(".hpp") || FileName.endswith(".hxx"))
+    diag(Loc, "do not use unnamed namespaces in header files.");
+}
+
+} // namespace build
+} // namespace tidy
+} // namespace clang

clang-tidy/google/UsingNamespaceDirectiveCheck.h

+//===--- UsingNamespaceDirectiveCheck.h - clang-tidy ------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USING_NAMESPACE_CHECK_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USING_NAMESPACE_CHECK_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+namespace build {
+
+/// \brief Finds using namespace directives.
+///
+/// Corresponding cpplint.py check name: 'build/namespaces'.
+class UsingNamespaceDirectiveCheck : public ClangTidyCheck {
+public:
+  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+};
+
+} // namespace build
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USING_NAMESPACE_CHECK_H

clang-tidy/google/UsingNamespaceDirectiveCheck.cpp

+//===--- UsingNamespaceDirectiveCheck.cpp - clang-tidy ----------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "UsingNamespaceDirectiveCheck.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/ASTMatchers/ASTMatchers.h"
+#include "clang/AST/ASTContext.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace build {
+
+void UsingNamespaceDirectiveCheck::registerMatchers(
+    ast_matchers::MatchFinder *Finder) {
+  Finder->addMatcher(usingDirectiveDecl().bind("usingNamespace"), this);
+}
+
+void
+UsingNamespaceDirectiveCheck::check(const MatchFinder::MatchResult &Result) {
+  const auto *U = Result.Nodes.getNodeAs<UsingDirectiveDecl>("usingNamespace");
+  SourceLocation Loc = U->getLocStart();
+  if (U->isImplicit() || !Loc.isValid())
+    return;
+
+  diag(Loc, "do not use namespace using-directives. Use using-declarations "
+            "instead.");
+  // TODO: We could suggest a list of using directives replacing the using
+  //       namespace directive.
+}
+
+} // namespace build
+} // namespace tidy
+} // namespace clang

test/clang-tidy/Inputs/google-namespaces.h

+namespace {
+int x;
+}
+
+namespace spaaaace {
+class core;
+}

test/clang-tidy/google-namespaces.cpp

+// RUN: clang-tidy %s -checks='-*,google-build-namespaces,google-build-using-namespace' -header-filter='.*' -- | FileCheck %s -implicit-check-not="{{warning|error}}:"
+#include "Inputs/google-namespaces.h"
+// CHECK: warning: do not use unnamed namespaces in header files.
+
+using namespace spaaaace;
+// CHECK: :[[@LINE-1]]:1: warning: do not use namespace using-directives. Use using-declarations instead.
+
+using spaaaace::core; // no-warning