From 2252cbf4e89d76b1c39da89b01d67b3e2b73154b Mon Sep 17 00:00:00 2001 From: Benjamin Kramer Date: Wed, 16 Jul 2014 14:16:56 +0000 Subject: [PATCH] [clang-tidy] Add namespaces checkers. This change contains of two checkers that warn about 1. anonymous namespaces in header files. 2. 'using namespace' directives everywhere. Differential Revision: http://reviews.llvm.org/D4523 llvm-svn: 213153 --- clang-tools-extra/clang-tidy/google/CMakeLists.txt | 2 + .../clang-tidy/google/GoogleTidyModule.cpp | 8 ++++ .../google/UnnamedNamespaceInHeaderCheck.cpp | 51 ++++++++++++++++++++++ .../google/UnnamedNamespaceInHeaderCheck.h | 32 ++++++++++++++ .../google/UsingNamespaceDirectiveCheck.cpp | 41 +++++++++++++++++ .../google/UsingNamespaceDirectiveCheck.h | 32 ++++++++++++++ .../test/clang-tidy/Inputs/google-namespaces.h | 7 +++ .../test/clang-tidy/google-namespaces.cpp | 8 ++++ 8 files changed, 181 insertions(+) create mode 100644 clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp create mode 100644 clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.h create mode 100644 clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.cpp create mode 100644 clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.h create mode 100644 clang-tools-extra/test/clang-tidy/Inputs/google-namespaces.h create mode 100644 clang-tools-extra/test/clang-tidy/google-namespaces.cpp diff --git a/clang-tools-extra/clang-tidy/google/CMakeLists.txt b/clang-tools-extra/clang-tidy/google/CMakeLists.txt index 0f62db9..725a417 100644 --- a/clang-tools-extra/clang-tidy/google/CMakeLists.txt +++ b/clang-tools-extra/clang-tidy/google/CMakeLists.txt @@ -8,6 +8,8 @@ add_clang_library(clangTidyGoogleModule NamedParameterCheck.cpp OverloadedUnaryAndCheck.cpp StringReferenceMemberCheck.cpp + UnnamedNamespaceInHeaderCheck.cpp + UsingNamespaceDirectiveCheck.cpp LINK_LIBS clangAST diff --git a/clang-tools-extra/clang-tidy/google/GoogleTidyModule.cpp b/clang-tools-extra/clang-tidy/google/GoogleTidyModule.cpp index 43eacfc3..416f48d 100644 --- a/clang-tools-extra/clang-tidy/google/GoogleTidyModule.cpp +++ b/clang-tools-extra/clang-tidy/google/GoogleTidyModule.cpp @@ -16,6 +16,8 @@ #include "NamedParameterCheck.h" #include "OverloadedUnaryAndCheck.h" #include "StringReferenceMemberCheck.h" +#include "UnnamedNamespaceInHeaderCheck.h" +#include "UsingNamespaceDirectiveCheck.h" using namespace clang::ast_matchers; @@ -29,6 +31,12 @@ public: "google-build-explicit-make-pair", new ClangTidyCheckFactory()); CheckFactories.addCheckFactory( + "google-build-namespaces", + new ClangTidyCheckFactory()); + CheckFactories.addCheckFactory( + "google-build-using-namespace", + new ClangTidyCheckFactory()); + CheckFactories.addCheckFactory( "google-explicit-constructor", new ClangTidyCheckFactory()); CheckFactories.addCheckFactory( diff --git a/clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp b/clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp new file mode 100644 index 0000000..dc2d170 --- /dev/null +++ b/clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.cpp @@ -0,0 +1,51 @@ +//===--- 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("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 diff --git a/clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.h b/clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.h new file mode 100644 index 0000000..4034623 --- /dev/null +++ b/clang-tools-extra/clang-tidy/google/UnnamedNamespaceInHeaderCheck.h @@ -0,0 +1,32 @@ +//===--- 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 diff --git a/clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.cpp b/clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.cpp new file mode 100644 index 0000000..d8f38cb --- /dev/null +++ b/clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.cpp @@ -0,0 +1,41 @@ +//===--- 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("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 diff --git a/clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.h b/clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.h new file mode 100644 index 0000000..3410666 --- /dev/null +++ b/clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.h @@ -0,0 +1,32 @@ +//===--- 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 diff --git a/clang-tools-extra/test/clang-tidy/Inputs/google-namespaces.h b/clang-tools-extra/test/clang-tidy/Inputs/google-namespaces.h new file mode 100644 index 0000000..f4d87f5 --- /dev/null +++ b/clang-tools-extra/test/clang-tidy/Inputs/google-namespaces.h @@ -0,0 +1,7 @@ +namespace { +int x; +} + +namespace spaaaace { +class core; +} diff --git a/clang-tools-extra/test/clang-tidy/google-namespaces.cpp b/clang-tools-extra/test/clang-tidy/google-namespaces.cpp new file mode 100644 index 0000000..12c0b2d --- /dev/null +++ b/clang-tools-extra/test/clang-tidy/google-namespaces.cpp @@ -0,0 +1,8 @@ +// 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 -- 2.7.4