summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/clang-tidy/utils/HeaderGuard.h
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/clang-tidy/utils/HeaderGuard.h')
-rw-r--r--clang-tools-extra/clang-tidy/utils/HeaderGuard.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/clang-tools-extra/clang-tidy/utils/HeaderGuard.h b/clang-tools-extra/clang-tidy/utils/HeaderGuard.h
new file mode 100644
index 00000000000..7439a908ca7
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/utils/HeaderGuard.h
@@ -0,0 +1,41 @@
+//===--- HeaderGuard.h - clang-tidy -----------------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_UTILS_HEADER_GUARD_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_UTILS_HEADER_GUARD_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+
+/// \brief Finds and fixes header guards.
+class HeaderGuardCheck : public ClangTidyCheck {
+public:
+ void registerPPCallbacks(CompilerInstance &Compiler) override;
+
+ /// \brief Returns true if the checker should suggest inserting a trailing
+ /// comment on the #endif of the header guard. It will use the same name as
+ /// returned by getHeaderGuard.
+ virtual bool shouldSuggestEndifComment(StringRef Filename);
+ /// \brief Returns true if the checker should suggest changing an existing
+ /// header guard to the string returned by getHeaderGuard.
+ virtual bool shouldFixHeaderGuard(StringRef Filename);
+ /// \brief Returns true if the checker should add a header guard to the file
+ /// if it has none.
+ virtual bool shouldSuggestToAddHeaderGuard(StringRef Filename);
+ /// \brief Get the canonical header guard for a file.
+ virtual std::string getHeaderGuard(StringRef Filename,
+ StringRef OldGuard = StringRef()) = 0;
+};
+
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_UTILS_HEADER_GUARD_H
OpenPOWER on IntegriCloud