clang-tools  14.0.0git
UnnamedNamespaceInHeaderCheck.h
Go to the documentation of this file.
1 //===--- UnnamedNamespaceInHeaderCheck.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_UNNAMEDNAMESPACEINHEADERCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_UNNAMEDNAMESPACEINHEADERCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "../utils/FileExtensionsUtils.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace google {
18 namespace build {
19 
20 /// Finds anonymous namespaces in headers.
21 ///
22 /// The check supports these options:
23 /// - `HeaderFileExtensions`: a semicolon-separated list of filename
24 /// extensions of header files (The filename extensions should not contain
25 /// "." prefix). ";h;hh;hpp;hxx" by default.
26 ///
27 /// For extension-less header files, using an empty string or leaving an
28 /// empty string between ";" if there are other filename extensions.
29 ///
30 /// https://google.github.io/styleguide/cppguide.html#Namespaces
31 ///
32 /// Corresponding cpplint.py check name: 'build/namespaces'.
33 ///
34 /// For the user-facing documentation see:
35 /// http://clang.llvm.org/extra/clang-tidy/checks/google-build-namespaces.html
37 public:
39  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
40  return LangOpts.CPlusPlus;
41  }
42  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
43  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
44  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
45 
46 private:
47  const std::string RawStringHeaderFileExtensions;
48  utils::FileExtensionsSet HeaderFileExtensions;
49 };
50 
51 } // namespace build
52 } // namespace google
53 } // namespace tidy
54 } // namespace clang
55 
56 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_UNNAMEDNAMESPACEINHEADERCHECK_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::google::build::UnnamedNamespaceInHeaderCheck::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: UnnamedNamespaceInHeaderCheck.h:39
clang::tidy::google::build::UnnamedNamespaceInHeaderCheck::UnnamedNamespaceInHeaderCheck
UnnamedNamespaceInHeaderCheck(StringRef Name, ClangTidyContext *Context)
Definition: UnnamedNamespaceInHeaderCheck.cpp:21
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
clang::tidy::google::build::UnnamedNamespaceInHeaderCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UnnamedNamespaceInHeaderCheck.cpp:39
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::google::build::UnnamedNamespaceInHeaderCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: UnnamedNamespaceInHeaderCheck.cpp:34
clang::tidy::google::build::UnnamedNamespaceInHeaderCheck
Finds anonymous namespaces in headers.
Definition: UnnamedNamespaceInHeaderCheck.h:36
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::google::build::UnnamedNamespaceInHeaderCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UnnamedNamespaceInHeaderCheck.cpp:45
clang::tidy::utils::FileExtensionsSet
llvm::SmallSet< llvm::StringRef, 5 > FileExtensionsSet
Definition: FileExtensionsUtils.h:22