clang-tools-extra/clang-tidy/modernize/UseStdPrintCheck.h

   1 //===--- UseStdPrintCheck.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_USESTDPRINTCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_USESTDPRINTCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include "../utils/IncludeInserter.h"
  14
  15 namespace clang::tidy::modernize {
  16 /// Convert calls to printf-like functions to std::print and std::println
  17 ///
  18 /// For the user-facing documentation see:
  19 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-std-print.html
  20 class UseStdPrintCheck : public ClangTidyCheck {
  21 public:
  22   UseStdPrintCheck(StringRef Name, ClangTidyContext *Context);
  23   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  24     if (ReplacementPrintFunction == "std::print" ||
  25         ReplacementPrintlnFunction == "std::println")
  26       return LangOpts.CPlusPlus23;
  27     return LangOpts.CPlusPlus;
  28   }
  29   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  30                            Preprocessor *ModuleExpanderPP) override;
  31   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  32   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  33   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  34   std::optional<TraversalKind> getCheckTraversalKind() const override {
  35     return TK_IgnoreUnlessSpelledInSource;
  36   }
  37
  38 private:
  39   Preprocessor *PP;
  40   bool StrictMode;
  41   std::vector<StringRef> PrintfLikeFunctions;
  42   std::vector<StringRef> FprintfLikeFunctions;
  43   StringRef ReplacementPrintFunction;
  44   StringRef ReplacementPrintlnFunction;
  45   utils::IncludeInserter IncludeInserter;
  46   std::optional<StringRef> MaybeHeaderToInclude;
  47 };
  48
  49 } // namespace clang::tidy::modernize
  50
  51 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_USESTDPRINTCHECK_H