clang-tidy/google/UsingNamespaceDirectiveCheck.h

0001 //===--- UsingNamespaceDirectiveCheck.h - clang-tidy ------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::google::build {
0015
0016 /// Finds using namespace directives.
0017 ///
0018 /// https://google.github.io/styleguide/cppguide.html#Namespaces
0019 ///
0020 /// The check implements the following rule of the Google C++ Style Guide:
0021 ///
0022 ///   You may not use a using-directive to make all names from a namespace
0023 ///   available.
0024 ///
0025 ///   \code
0026 ///     // Forbidden -- This pollutes the namespace.
0027 ///     using namespace foo;
0028 ///   \endcode
0029 ///
0030 /// Corresponding cpplint.py check name: `build/namespaces`.
0031 ///
0032 /// For the user-facing documentation see:
0033 /// https://clang.llvm.org/extra/clang-tidy/checks/google/build-using-namespace.html
0034 class UsingNamespaceDirectiveCheck : public ClangTidyCheck {
0035 public:
0036   UsingNamespaceDirectiveCheck(StringRef Name, ClangTidyContext *Context)
0037       : ClangTidyCheck(Name, Context) {}
0038   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0039     return LangOpts.CPlusPlus;
0040   }
0041   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0042   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0043
0044 private:
0045   static bool isStdLiteralsNamespace(const NamespaceDecl *NS);
0046 };
0047
0048 } // namespace clang::tidy::google::build
0049
0050 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H