Index: clang-tidy/abseil/AbseilTidyModule.cpp =================================================================== --- clang-tidy/abseil/AbseilTidyModule.cpp +++ clang-tidy/abseil/AbseilTidyModule.cpp @@ -10,6 +10,7 @@ #include "../ClangTidy.h" #include "../ClangTidyModule.h" #include "../ClangTidyModuleRegistry.h" +#include "AnonymousEnclosedAliasesCheck.h" #include "DurationDivisionCheck.h" #include "DurationFactoryFloatCheck.h" #include "FasterStrsplitDelimiterCheck.h" @@ -26,6 +27,8 @@ class AbseilModule : public ClangTidyModule { public: void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override { + CheckFactories.registerCheck( + "abseil-anonymous-enclosed-aliases"); CheckFactories.registerCheck( "abseil-duration-division"); CheckFactories.registerCheck( Index: clang-tidy/abseil/AnonymousEnclosedAliasesCheck.h =================================================================== --- /dev/null +++ clang-tidy/abseil/AnonymousEnclosedAliasesCheck.h @@ -0,0 +1,40 @@ +//===--- AnonymousEnclosedAliasesCheck.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_ABSEIL_ANONYMOUSENCLOSEDALIASESCHECK_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_ANONYMOUSENCLOSEDALIASESCHECK_H + +#include "../ClangTidy.h" +#include + +namespace clang { +namespace tidy { +namespace abseil { + +/// Detecting incorrect practice of putting using declarations outside an +/// anonymous namespace when there exists one. +/// For the user-facing documentation see: +/// http://clang.llvm.org/extra/clang-tidy/checks/ +/// abseil-anonymous-enclosed-aliases.html +class AnonymousEnclosedAliasesCheck : public ClangTidyCheck { +public: + AnonymousEnclosedAliasesCheck(StringRef Name, ClangTidyContext *Context) + : ClangTidyCheck(Name, Context) {} + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; +private: + const NamespaceDecl* AnonymousNamespaceDecl; + std::vector MatchedUsingDecls; +}; + +} // namespace abseil +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_ANONYMOUSENCLOSEDALIASESCHECK_H Index: clang-tidy/abseil/AnonymousEnclosedAliasesCheck.cpp =================================================================== --- /dev/null +++ clang-tidy/abseil/AnonymousEnclosedAliasesCheck.cpp @@ -0,0 +1,66 @@ +//===--- AnonymousEnclosedAliasesCheck.cpp - clang-tidy -------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "AnonymousEnclosedAliasesCheck.h" +#include "clang/AST/ASTContext.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace tidy { +namespace abseil { + +void AnonymousEnclosedAliasesCheck::registerMatchers(MatchFinder *Finder) { + // We try to match two nodes: + // 1. anonymous namespace declarations, + // 2. using declarations that are not inside an anonymous declaration + Finder->addMatcher( + namespaceDecl(isAnonymous()).bind("anonymous_namespace"), this); + Finder->addMatcher( + usingDecl(unless(hasAncestor( + namespaceDecl(isAnonymous())))).bind("using_decl"), this); +} + +void AnonymousEnclosedAliasesCheck::check(const MatchFinder::MatchResult &Result) { + + const auto *MatchedUsingDecl = + Result.Nodes.getNodeAs("using_decl"); + // If a potential using declaration is matched, + if (MatchedUsingDecl) { + // and if an anonymous namespace declaration has already been found, + // the matched using declaration is a target, and we print out + // the diagnostics for it. Otherwise, we add the using declaration + // to the vector containing all candidate using declarations. + if (AnonymousNamespaceDecl) { + diag(MatchedUsingDecl->getLocation(), + "UsingDecl %0 should be in the anonymous namespace") + << MatchedUsingDecl; + } else { + MatchedUsingDecls.push_back(MatchedUsingDecl); + } + return; + } + // Otherwise, an anonymous namespace declaration is matched. In this case, + // all the previously matched namespace declarations in the vector + // CurrentUsingDecl are our targets, and we print out the + // diagnostics for all of them. + AnonymousNamespaceDecl = + Result.Nodes.getNodeAs("anonymous_namespace"); + for (const auto* CurrentUsingDecl: MatchedUsingDecls) { + diag(CurrentUsingDecl->getLocation(), + "UsingDecl %0 should be in the anonymous namespace. See: " + "https://abseil.io/tips/119") + << CurrentUsingDecl; + } +} + +} // namespace abseil +} // namespace tidy +} // namespace clang Index: clang-tidy/abseil/CMakeLists.txt =================================================================== --- clang-tidy/abseil/CMakeLists.txt +++ clang-tidy/abseil/CMakeLists.txt @@ -2,6 +2,7 @@ add_clang_library(clangTidyAbseilModule AbseilTidyModule.cpp + AnonymousEnclosedAliasesCheck.cpp DurationDivisionCheck.cpp DurationFactoryFloatCheck.cpp FasterStrsplitDelimiterCheck.cpp Index: docs/ReleaseNotes.rst =================================================================== --- docs/ReleaseNotes.rst +++ docs/ReleaseNotes.rst @@ -67,6 +67,12 @@ Improvements to clang-tidy -------------------------- +- New :doc:`abseil-anonymous-enclosed-aliases + ` check. + + Finds instances of using declarations not in an anonymous namespace + when there exists one. + - New :doc:`abseil-duration-division ` check. Index: docs/clang-tidy/checks/abseil-anonymous-enclosed-aliases.rst =================================================================== --- /dev/null +++ docs/clang-tidy/checks/abseil-anonymous-enclosed-aliases.rst @@ -0,0 +1,20 @@ +.. title:: clang-tidy - abseil-anonymous-enclosed-aliases + +abseil-anonymous-enclosed-aliases +================================= + +Finds using declarations outside of anonymous namespaces, and +suggests those declarations be moved to that namespace. + +Example: +.. code-block:: c++ + + namespace foo { + + using something; // should be inside the anonymous namespace below + + namespace { + + } // anonymous namespace + + } // foo Index: docs/clang-tidy/checks/list.rst =================================================================== --- docs/clang-tidy/checks/list.rst +++ docs/clang-tidy/checks/list.rst @@ -4,14 +4,15 @@ ================= .. toctree:: + abseil-anonymous-enclosed-aliases abseil-duration-division abseil-duration-factory-float abseil-faster-strsplit-delimiter abseil-no-internal-dependencies abseil-no-namespace abseil-redundant-strcat-calls - abseil-string-find-startswith abseil-str-cat-append + abseil-string-find-startswith android-cloexec-accept android-cloexec-accept4 android-cloexec-creat @@ -151,6 +152,7 @@ hicpp-special-member-functions (redirects to cppcoreguidelines-special-member-functions) hicpp-static-assert (redirects to misc-static-assert) hicpp-undelegated-constructor (redirects to bugprone-undelegated-constructor) + hicpp-uppercase-literal-suffix (redirects to readability-uppercase-literal-suffix) hicpp-use-auto (redirects to modernize-use-auto) hicpp-use-emplace (redirects to modernize-use-emplace) hicpp-use-equals-default (redirects to modernize-use-equals-default) @@ -159,7 +161,6 @@ hicpp-use-nullptr (redirects to modernize-use-nullptr) hicpp-use-override (redirects to modernize-use-override) hicpp-vararg (redirects to cppcoreguidelines-pro-type-vararg) - hicpp-uppercase-literal-suffix (redirects to readability-uppercase-literal-suffix) llvm-header-guard llvm-include-order llvm-namespace-comment Index: test/clang-tidy/abseil-anonymous-enclosed-aliases.cpp =================================================================== --- /dev/null +++ test/clang-tidy/abseil-anonymous-enclosed-aliases.cpp @@ -0,0 +1,27 @@ +// RUN: %check_clang_tidy %s abseil-anonymous-enclosed-aliases %t +namespace bar { + +class something { + +}; +} + +namespace foo { + +using bar::something; + +namespace { + +} // anonymous namespace +} // namespace foo +// CHECK-MESSAGES: :[[@LINE-6]]:12: warning: UsingDecl 'something' should be in the anonymous namespace. See: https://abseil.io/tips/119 [abseil-anonymous-enclosed-aliases] + + +namespace foo { + +namespace { + +using ::bar::something; + +} // anonymous namespace +} // namespace foo