clang-tools  14.0.0git
UsingNamespaceDirectiveCheck.h
Go to the documentation of this file.
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 {
15 namespace tidy {
16 namespace google {
17 namespace build {
18 
19 /// Finds using namespace directives.
20 ///
21 /// https://google.github.io/styleguide/cppguide.html#Namespaces
22 ///
23 /// The check implements the following rule of the Google C++ Style Guide:
24 ///
25 /// You may not use a using-directive to make all names from a namespace
26 /// available.
27 ///
28 /// \code
29 /// // Forbidden -- This pollutes the namespace.
30 /// using namespace foo;
31 /// \endcode
32 ///
33 /// Corresponding cpplint.py check name: `build/namespaces`.
34 ///
35 /// For the user-facing documentation see:
36 /// https://clang.llvm.org/extra/clang-tidy/checks/google-build-using-namespace.html
38 public:
40  : ClangTidyCheck(Name, Context) {}
41  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
42  return LangOpts.CPlusPlus;
43  }
44  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
45  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
46 
47 private:
48  static bool isStdLiteralsNamespace(const NamespaceDecl *NS);
49 };
50 
51 } // namespace build
52 } // namespace google
53 } // namespace tidy
54 } // namespace clang
55 
56 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_USINGNAMESPACEDIRECTIVECHECK_H
clang::tidy::google::build::UsingNamespaceDirectiveCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UsingNamespaceDirectiveCheck.cpp:21
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::google::build::UsingNamespaceDirectiveCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: UsingNamespaceDirectiveCheck.h:41
clang::tidy::google::build::UsingNamespaceDirectiveCheck
Finds using namespace directives.
Definition: UsingNamespaceDirectiveCheck.h:37
clang::tidy::google::build::UsingNamespaceDirectiveCheck::UsingNamespaceDirectiveCheck
UsingNamespaceDirectiveCheck(StringRef Name, ClangTidyContext *Context)
Definition: UsingNamespaceDirectiveCheck.h:39
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::google::build::UsingNamespaceDirectiveCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UsingNamespaceDirectiveCheck.cpp:26