clang-tidy/performance/AvoidEndlCheck.h

0001 //===--- AvoidEndlCheck.h - clang-tidy --------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::performance {
0015
0016 /// ClangTidyCheck Checks to flag for uses of 'std::endl' on streams and
0017 /// suggests using the newline character '"\n"' instead.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// https://clang.llvm.org/extra/clang-tidy/checks/performance/avoid-endl.html
0021 class AvoidEndlCheck : public ClangTidyCheck {
0022 public:
0023   AvoidEndlCheck(StringRef Name, ClangTidyContext *Context)
0024       : ClangTidyCheck(Name, Context) {}
0025
0026   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0027     return LangOpts.CPlusPlus;
0028   }
0029
0030   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0031   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0032
0033   std::optional<TraversalKind> getCheckTraversalKind() const override {
0034     return TK_IgnoreUnlessSpelledInSource;
0035   }
0036 };
0037
0038 } // namespace clang::tidy::performance
0039
0040 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_AVOIDENDLCHECK_H