clang-tools
15.0.0git
llvm-project
clang-tools-extra
clang-tidy
llvm
HeaderGuardCheck.h
Go to the documentation of this file.
1
//===--- HeaderGuardCheck.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_LLVM_HEADERGUARDCHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_HEADERGUARDCHECK_H
11
12
#include "../utils/HeaderGuard.h"
13
14
namespace
clang
{
15
namespace
tidy {
16
namespace
llvm_check {
17
18
/// Finds and fixes header guards that do not adhere to LLVM style.
19
/// For the user-facing documentation see:
20
/// http://clang.llvm.org/extra/clang-tidy/checks/llvm/header-guard.html
21
/// The check supports these options:
22
/// - `HeaderFileExtensions`: a semicolon-separated list of filename
23
/// extensions of header files (The filename extension should not contain
24
/// "." prefix). ";h;hh;hpp;hxx" by default.
25
///
26
/// For extension-less header files, using an empty string or leaving an
27
/// empty string between ";" if there are other filename extensions.
28
class
LLVMHeaderGuardCheck
:
public
utils::HeaderGuardCheck
{
29
public
:
30
LLVMHeaderGuardCheck
(StringRef
Name
,
ClangTidyContext
*Context);
31
32
bool
shouldSuggestEndifComment
(StringRef
Filename
)
override
{
return
false
; }
33
std::string
getHeaderGuard
(StringRef
Filename
, StringRef OldGuard)
override
;
34
};
35
36
}
// namespace llvm_check
37
}
// namespace tidy
38
}
// namespace clang
39
40
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_HEADERGUARDCHECK_H
clang::tidy::llvm_check::LLVMHeaderGuardCheck::getHeaderGuard
std::string getHeaderGuard(StringRef Filename, StringRef OldGuard) override
Gets the canonical header guard for a file.
Definition:
HeaderGuardCheck.cpp:21
Filename
std::string Filename
Filename as a string.
Definition:
IncludeOrderCheck.cpp:39
clang::tidy::llvm_check::LLVMHeaderGuardCheck::LLVMHeaderGuardCheck
LLVMHeaderGuardCheck(StringRef Name, ClangTidyContext *Context)
Definition:
HeaderGuardCheck.cpp:17
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:67
clang::tidy::llvm_check::LLVMHeaderGuardCheck::shouldSuggestEndifComment
bool shouldSuggestEndifComment(StringRef Filename) override
Returns true if the check should suggest inserting a trailing comment on the #endif of the header gua...
Definition:
HeaderGuardCheck.h:32
Name
Token Name
Definition:
MacroToEnumCheck.cpp:89
clang::tidy::utils::HeaderGuardCheck
Finds and fixes header guards.
Definition:
HeaderGuard.h:27
clang::tidy::llvm_check::LLVMHeaderGuardCheck
Finds and fixes header guards that do not adhere to LLVM style.
Definition:
HeaderGuardCheck.h:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
Generated on Tue Jul 5 2022 07:32:33 for clang-tools by
1.8.17