clang-tools-extra/clang-tidy/misc/HeaderIncludeCycleCheck.h

   1 //===--- HeaderIncludeCycleCheck.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_MISC_HEADERINCLUDECYCLECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_HEADERINCLUDECYCLECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include <vector>
  14
  15 namespace clang::tidy::misc {
  16
  17 /// Check detects cyclic #include dependencies between user-defined headers.
  18 ///
  19 /// For the user-facing documentation see:
  20 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/header-include-cycle.html
  21 class HeaderIncludeCycleCheck : public ClangTidyCheck {
  22 public:
  23   HeaderIncludeCycleCheck(StringRef Name, ClangTidyContext *Context);
  24   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  25                            Preprocessor *ModuleExpanderPP) override;
  26   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  27
  28 private:
  29   const std::vector<StringRef> IgnoredFilesList;
  30 };
  31
  32 } // namespace clang::tidy::misc
  33
  34 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_HEADERINCLUDECYCLECHECK_H