clang-tools
20.0.0git
llvm-project
clang-tools-extra
clang-tidy
performance
AvoidEndlCheck.h
Go to the documentation of this file.
1
//===--- AvoidEndlCheck.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_PERFORMANCE_AVOIDENDLCHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
11
12
#include "../ClangTidyCheck.h"
13
14
namespace
clang::tidy::performance
{
15
16
/// ClangTidyCheck Checks to flag for uses of 'std::endl' on streams and
17
/// suggests using the newline character '"\n"' instead.
18
///
19
/// For the user-facing documentation see:
20
/// https://clang.llvm.org/extra/clang-tidy/checks/performance/avoid-endl.html
21
class
AvoidEndlCheck
:
public
ClangTidyCheck
{
22
public
:
23
AvoidEndlCheck
(StringRef
Name
,
ClangTidyContext
*Context)
24
:
ClangTidyCheck
(
Name
, Context) {}
25
26
bool
isLanguageVersionSupported
(
const
LangOptions &LangOpts)
const override
{
27
return
LangOpts.CPlusPlus;
28
}
29
30
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
31
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
32
33
std::optional<TraversalKind>
getCheckTraversalKind
()
const override
{
34
return
TK_IgnoreUnlessSpelledInSource;
35
}
36
};
37
38
}
// namespace clang::tidy::performance
39
40
#endif
// LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
Name
llvm::SmallString< 256U > Name
Definition:
ChainedComparisonCheck.cpp:42
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:53
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:69
clang::tidy::performance::AvoidEndlCheck
ClangTidyCheck Checks to flag for uses of 'std::endl' on streams and suggests using the newline chara...
Definition:
AvoidEndlCheck.h:21
clang::tidy::performance::AvoidEndlCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
AvoidEndlCheck.cpp:36
clang::tidy::performance::AvoidEndlCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
AvoidEndlCheck.cpp:22
clang::tidy::performance::AvoidEndlCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition:
AvoidEndlCheck.h:26
clang::tidy::performance::AvoidEndlCheck::getCheckTraversalKind
std::optional< TraversalKind > getCheckTraversalKind() const override
Definition:
AvoidEndlCheck.h:33
clang::tidy::performance::AvoidEndlCheck::AvoidEndlCheck
AvoidEndlCheck(StringRef Name, ClangTidyContext *Context)
Definition:
AvoidEndlCheck.h:23
clang::tidy::performance
Definition:
AvoidEndlCheck.cpp:20
Generated on Sat Oct 12 2024 16:37:31 for clang-tools by
1.9.6