blob: 584a09c756d4974cc52bbc4e51ed5c122fa7896b [file] [log] [blame]
//===--- HeaderGuard.h - clang-tidy -----------------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "../ClangTidyCheck.h"
#include "../utils/FileExtensionsUtils.h"
namespace clang {
namespace tidy {
namespace utils {
/// Finds and fixes header guards.
/// The check supports these options:
/// - `HeaderFileExtensions`: a semicolon-separated list of filename
/// extensions of header files (The filename extension should not contain
/// "." prefix). ";h;hh;hpp;hxx" by default.
/// For extension-less header files, using an empty string or leaving an
/// empty string between ";" if there are other filename extensions.
class HeaderGuardCheck : public ClangTidyCheck {
HeaderGuardCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context),
"HeaderFileExtensions", utils::defaultHeaderFileExtensions())) {
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
Preprocessor *ModuleExpanderPP) override;
/// Ensure that the provided header guard is a non-reserved identifier.
std::string sanitizeHeaderGuard(StringRef Guard);
/// Returns ``true`` if the check should suggest inserting a trailing comment
/// on the ``#endif`` of the header guard. It will use the same name as
/// returned by ``HeaderGuardCheck::getHeaderGuard``.
virtual bool shouldSuggestEndifComment(StringRef Filename);
/// Returns ``true`` if the check should suggest changing an existing header
/// guard to the string returned by ``HeaderGuardCheck::getHeaderGuard``.
virtual bool shouldFixHeaderGuard(StringRef Filename);
/// Returns ``true`` if the check should add a header guard to the file
/// if it has none.
virtual bool shouldSuggestToAddHeaderGuard(StringRef Filename);
/// Returns a replacement for the ``#endif`` line with a comment mentioning
/// \p HeaderGuard. The replacement should start with ``endif``.
virtual std::string formatEndIf(StringRef HeaderGuard);
/// Gets the canonical header guard for a file.
virtual std::string getHeaderGuard(StringRef Filename,
StringRef OldGuard = StringRef()) = 0;
std::string RawStringHeaderFileExtensions;
utils::FileExtensionsSet HeaderFileExtensions;
} // namespace utils
} // namespace tidy
} // namespace clang