
Expanding all macros in the printf/absl::StrFormat format string before conversion could easily break code if those macros are expanded change their definition between builds. It's important for this check to expand the <inttypes.h> PRI macros though, so let's ensure that the presence of any other macros in the format string causes the check to emit a warning and not perform any conversion.
53 lines
2.1 KiB
C++
53 lines
2.1 KiB
C++
//===--- UseStdFormatCheck.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_MODERNIZE_USESTDFORMATCHECK_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTDFORMATCHECK_H
|
|
|
|
#include "../ClangTidyCheck.h"
|
|
#include "../utils/IncludeInserter.h"
|
|
|
|
namespace clang::tidy::modernize {
|
|
|
|
/// Converts calls to absl::StrFormat, or other functions via configuration
|
|
/// options, to C++20's std::format, or another function via a configuration
|
|
/// option, modifying the format string appropriately and removing
|
|
/// now-unnecessary calls to std::string::c_str() and std::string::data().
|
|
///
|
|
/// For the user-facing documentation see:
|
|
/// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-std-format.html
|
|
class UseStdFormatCheck : public ClangTidyCheck {
|
|
public:
|
|
UseStdFormatCheck(StringRef Name, ClangTidyContext *Context);
|
|
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
|
|
if (ReplacementFormatFunction == "std::format")
|
|
return LangOpts.CPlusPlus20;
|
|
return LangOpts.CPlusPlus;
|
|
}
|
|
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
|
|
Preprocessor *ModuleExpanderPP) override;
|
|
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
|
|
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;
|
|
}
|
|
|
|
private:
|
|
bool StrictMode;
|
|
std::vector<StringRef> StrFormatLikeFunctions;
|
|
StringRef ReplacementFormatFunction;
|
|
utils::IncludeInserter IncludeInserter;
|
|
std::optional<StringRef> MaybeHeaderToInclude;
|
|
Preprocessor *PP = nullptr;
|
|
};
|
|
|
|
} // namespace clang::tidy::modernize
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTDFORMATCHECK_H
|