mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-18 18:26:44 +00:00
cd893308b5
This check flags uses of `std::endl` on streams and suggests using the newline character `'\n'` instead. `std::endl` performs two operations: it writes a newline character to the output stream and then flushes the stream buffer, which can be less efficient than writing a single newline character using `'\n'`. This fixes llvm#35321 Reviewed By: PiotrZSL Differential Revision: https://reviews.llvm.org/D148318
41 lines
1.5 KiB
C++
41 lines
1.5 KiB
C++
//===--- AvoidEndlCheck.h - clang-tidy --------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
|
|
|
|
#include "../ClangTidyCheck.h"
|
|
|
|
namespace clang::tidy::performance {
|
|
|
|
/// ClangTidyCheck Checks to flag for uses of 'std::endl' on streams and
|
|
/// suggests using the newline character '"\n"' instead.
|
|
///
|
|
/// For the user-facing documentation see:
|
|
/// https://clang.llvm.org/extra/clang-tidy/checks/performance/avoid-endl.html
|
|
class AvoidEndlCheck : public ClangTidyCheck {
|
|
public:
|
|
AvoidEndlCheck(StringRef Name, ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context) {}
|
|
|
|
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
|
|
return LangOpts.CPlusPlus;
|
|
}
|
|
|
|
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
|
|
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
|
|
|
|
std::optional<TraversalKind> getCheckTraversalKind() const override {
|
|
return TK_IgnoreUnlessSpelledInSource;
|
|
}
|
|
};
|
|
|
|
} // namespace clang::tidy::performance
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
|