clang-tools 20.0.0git
HeaderIncludeCycleCheck.h
Go to the documentation of this file.
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
15namespace 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
22public:
24 void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
25 Preprocessor *ModuleExpanderPP) override;
26 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
27
28private:
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
llvm::SmallString< 256U > Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Check detects cyclic #include dependencies between user-defined headers.
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
llvm::StringMap< ClangTidyValue > OptionMap