498cce575f
The implementation is split into a generic part and a LLVM-specific part. Other codebases can implement it with their own style. The specific features supported are: - Verification (and fixing) of header guards against a style based on the file path - Automatic insertion of header guards for headers that are missing them - A warning when the header guard doesn't enable our fancy header guard optimization (e.g. when there's an include preceeding the guard) - Automatic insertion of a comment with the guard name after #endif. For the LLVM style we disable #endif comments for now, they're not very common in the codebase. We also only flag headers in the include directories, there doesn't seem to be a common style outside. Differential Revision: http://reviews.llvm.org/D4867 llvm-svn: 215548
54 lines
1.8 KiB
C++
54 lines
1.8 KiB
C++
//===--- HeaderGuardCheck.cpp - clang-tidy --------------------------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "HeaderGuardCheck.h"
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
|
|
bool LLVMHeaderGuardCheck::shouldFixHeaderGuard(StringRef Filename) {
|
|
return Filename.endswith(".h");
|
|
}
|
|
|
|
std::string LLVMHeaderGuardCheck::getHeaderGuard(StringRef Filename,
|
|
StringRef OldGuard) {
|
|
std::string Guard = tooling::getAbsolutePath(Filename);
|
|
|
|
// Sanitize the path. There are some rules for compatibility with the historic
|
|
// style in include/llvm and include/clang which we want to preserve.
|
|
|
|
// We don't want _INCLUDE_ in our guards.
|
|
size_t PosInclude = Guard.rfind("include/");
|
|
if (PosInclude != StringRef::npos)
|
|
Guard = Guard.substr(PosInclude + std::strlen("include/"));
|
|
|
|
// For clang we drop the _TOOLS_.
|
|
size_t PosToolsClang = Guard.rfind("tools/clang/");
|
|
if (PosToolsClang != StringRef::npos)
|
|
Guard = Guard.substr(PosToolsClang + std::strlen("tools/"));
|
|
|
|
// The remainder is LLVM_FULL_PATH_TO_HEADER_H
|
|
size_t PosLLVM = Guard.rfind("llvm/");
|
|
if (PosLLVM != StringRef::npos)
|
|
Guard = Guard.substr(PosLLVM);
|
|
|
|
std::replace(Guard.begin(), Guard.end(), '/', '_');
|
|
std::replace(Guard.begin(), Guard.end(), '.', '_');
|
|
std::replace(Guard.begin(), Guard.end(), '-', '_');
|
|
|
|
// The prevalent style in clang is LLVM_CLANG_FOO_BAR_H
|
|
if (StringRef(Guard).startswith("clang"))
|
|
Guard = "LLVM_" + Guard;
|
|
|
|
return StringRef(Guard).upper();
|
|
}
|
|
|
|
} // namespace tidy
|
|
} // namespace clang
|