clang-tools-extra/clang-tidy/google/GlobalNamesInHeadersCheck.h

   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::tidy::google::readability {
  16
  17 /// Flag global namespace pollution in header files.
  18 /// Right now it only triggers on using declarations and directives.
  19 ///
  20 /// The check supports these options:
  21 ///   - `HeaderFileExtensions`: a semicolon-separated list of filename
  22 ///     extensions of header files (the filename extensions should not contain
  23 ///     "." prefix). ";h;hh;hpp;hxx" by default.
  24 ///
  25 ///     For extension-less header files, using an empty string or leaving an
  26 ///     empty string between ";" if there are other filename extensions.
  27 ///
  28 /// For the user-facing documentation see:
  29 /// http://clang.llvm.org/extra/clang-tidy/checks/google/global-names-in-headers.html
  30 class GlobalNamesInHeadersCheck : public ClangTidyCheck {
  31 public:
  32   GlobalNamesInHeadersCheck(StringRef Name, ClangTidyContext *Context);
  33   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  34   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  35   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  36
  37 private:
  38   StringRef RawStringHeaderFileExtensions;
  39   FileExtensionsSet HeaderFileExtensions;
  40 };
  41
  42 } // namespace clang::tidy::google::readability
  43
  44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_GLOBALNAMESINHEADERSCHECK_H