clang-tools-extra/clang-tidy/google/UsingNamespaceDirectiveCheck.h

   1 //===--- UsingNamespaceDirectiveCheck.h - clang-tidy ------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::google::build {
  15
  16 /// Finds using namespace directives.
  17 ///
  18 /// https://google.github.io/styleguide/cppguide.html#Namespaces
  19 ///
  20 /// The check implements the following rule of the Google C++ Style Guide:
  21 ///
  22 ///   You may not use a using-directive to make all names from a namespace
  23 ///   available.
  24 ///
  25 ///   \code
  26 ///     // Forbidden -- This pollutes the namespace.
  27 ///     using namespace foo;
  28 ///   \endcode
  29 ///
  30 /// Corresponding cpplint.py check name: `build/namespaces`.
  31 ///
  32 /// For the user-facing documentation see:
  33 /// https://clang.llvm.org/extra/clang-tidy/checks/google/build-using-namespace.html
  34 class UsingNamespaceDirectiveCheck : public ClangTidyCheck {
  35 public:
  36   UsingNamespaceDirectiveCheck(StringRef Name, ClangTidyContext *Context)
  37       : ClangTidyCheck(Name, Context) {}
  38   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  39     return LangOpts.CPlusPlus;
  40   }
  41   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  42   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  43
  44 private:
  45   static bool isStdLiteralsNamespace(const NamespaceDecl *NS);
  46 };
  47
  48 } // namespace clang::tidy::google::build
  49
  50 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H