clang-tools  9.0.0svn
GlobalNamesInHeadersCheck.h
Go to the documentation of this file.
1 //===--- GlobalNamesInHeadersCheck.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_GLOBALNAMESINHEADERSCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_GLOBALNAMESINHEADERSCHECK_H
11 
12 #include "../ClangTidy.h"
13 #include "../utils/HeaderFileExtensionsUtils.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace google {
18 namespace readability {
19 
20 /// Flag global namespace pollution in header files.
21 /// Right now it only triggers on using declarations and directives.
22 ///
23 /// The check supports these options:
24 /// - `HeaderFileExtensions`: a comma-separated list of filename extensions
25 /// of header files (the filename extensions should not contain "." prefix).
26 /// "h" by default.
27 /// For extension-less header files, using an empty string or leaving an
28 /// empty string between "," if there are other filename extensions.
30 public:
31  GlobalNamesInHeadersCheck(StringRef Name, ClangTidyContext *Context);
32  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
33  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
34  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
35 
36 private:
37  const std::string RawStringHeaderFileExtensions;
38  utils::HeaderFileExtensionsSet HeaderFileExtensions;
39 };
40 
41 } // namespace readability
42 } // namespace google
43 } // namespace tidy
44 } // namespace clang
45 
46 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_GLOBALNAMESINHEADERSCHECK_H
Flag global namespace pollution in header files.
Base class for all clang-tidy checks.
Definition: ClangTidy.h:126
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
llvm::SmallSet< llvm::StringRef, 5 > HeaderFileExtensionsSet
static constexpr llvm::StringLiteral Name
std::map< std::string, std::string > OptionMap
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
GlobalNamesInHeadersCheck(StringRef Name, ClangTidyContext *Context)
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...