clang-tidy/misc/HeaderIncludeCycleCheck.h

0001 //===--- HeaderIncludeCycleCheck.h - clang-tidy -----------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_HEADERINCLUDECYCLECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_HEADERINCLUDECYCLECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include <vector>
0014
0015 namespace clang::tidy::misc {
0016
0017 /// Check detects cyclic #include dependencies between user-defined headers.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/header-include-cycle.html
0021 class HeaderIncludeCycleCheck : public ClangTidyCheck {
0022 public:
0023   HeaderIncludeCycleCheck(StringRef Name, ClangTidyContext *Context);
0024   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
0025                            Preprocessor *ModuleExpanderPP) override;
0026   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0027
0028 private:
0029   const std::vector<StringRef> IgnoredFilesList;
0030 };
0031
0032 } // namespace clang::tidy::misc
0033
0034 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_HEADERINCLUDECYCLECHECK_H