mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-26 23:09:03 -04:00
6e0cbc8947
Summary: Each check can implement readOptions and storeOptions methods to read and store custom options. Each check's options are stored in a local namespace to avoid name collisions and provide some sort of context to the user. Reviewers: bkramer, klimek Reviewed By: klimek Subscribers: cfe-commits Differential Revision: http://reviews.llvm.org/D5296 llvm-svn: 217661
44 lines
1.7 KiB
C++
44 lines
1.7 KiB
C++
//===--- 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:
|
|
HeaderGuardCheck(StringRef Name, ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context) {}
|
|
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
|