clang-tidy/modernize/UseStdPrintCheck.h

0001 //===--- UseStdPrintCheck.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_USESTDPRINTCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_USESTDPRINTCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "../utils/IncludeInserter.h"
0014
0015 namespace clang::tidy::modernize {
0016 /// Convert calls to printf-like functions to std::print and std::println
0017 ///
0018 /// For the user-facing documentation see:
0019 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-std-print.html
0020 class UseStdPrintCheck : public ClangTidyCheck {
0021 public:
0022   UseStdPrintCheck(StringRef Name, ClangTidyContext *Context);
0023   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0024     if (ReplacementPrintFunction == "std::print" ||
0025         ReplacementPrintlnFunction == "std::println")
0026       return LangOpts.CPlusPlus23;
0027     return LangOpts.CPlusPlus;
0028   }
0029   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
0030                            Preprocessor *ModuleExpanderPP) override;
0031   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0032   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0033   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0034   std::optional<TraversalKind> getCheckTraversalKind() const override {
0035     return TK_IgnoreUnlessSpelledInSource;
0036   }
0037
0038 private:
0039   Preprocessor *PP;
0040   bool StrictMode;
0041   std::vector<StringRef> PrintfLikeFunctions;
0042   std::vector<StringRef> FprintfLikeFunctions;
0043   StringRef ReplacementPrintFunction;
0044   StringRef ReplacementPrintlnFunction;
0045   utils::IncludeInserter IncludeInserter;
0046   std::optional<StringRef> MaybeHeaderToInclude;
0047 };
0048
0049 } // namespace clang::tidy::modernize
0050
0051 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_USESTDPRINTCHECK_H