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 "../ClangTidyCheck.h"
13 #include "../utils/FileExtensionsUtils.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 semicolon-separated list of filename
25 ///     extensions of header files (the filename extensions should not contain
26 ///     "." prefix). ";h;hh;hpp;hxx" by default.
27 ///
28 ///     For extension-less header files, using an empty string or leaving an
29 ///     empty string between ";" if there are other filename extensions.
30 ///
31 /// For the user-facing documentation see:
32 /// http://clang.llvm.org/extra/clang-tidy/checks/google-global-names-in-headers.html
33 class GlobalNamesInHeadersCheck : public ClangTidyCheck {
34 public:
35   GlobalNamesInHeadersCheck(StringRef Name, ClangTidyContext *Context);
36   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
37   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
38   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
39 
40 private:
41   const std::string RawStringHeaderFileExtensions;
42   utils::FileExtensionsSet HeaderFileExtensions;
43 };
44 
45 } // namespace readability
46 } // namespace google
47 } // namespace tidy
48 } // namespace clang
49 
50 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_GLOBALNAMESINHEADERSCHECK_H
51