mikecrowe created this revision.
mikecrowe added a reviewer: PiotrZSL.
Herald added subscribers: carlosgalvezp, xazax.hun.
Herald added a reviewer: njames93.
Herald added a project: All.
mikecrowe requested review of this revision.
Herald added a project: clang-tools-extra.
Herald added a subscriber: cfe-commits.
Add a new clang-tidy check that converts absl::StrFormat (and similar
functions) to std::format (and similar functions.)
Separate the configuration of FormatStringConverter out to a separate
Configuration class so that we don't risk confusion by passing two
boolean configuration parameters into the constructor. Add
AllowTrailingNewlineRemoval option since we never want to remove
trailing newlines in this check.
Depends on D154283 <https://reviews.llvm.org/D154283>
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D154287
Files:
clang-tools-extra/clang-tidy/modernize/CMakeLists.txt
clang-tools-extra/clang-tidy/modernize/ModernizeTidyModule.cpp
clang-tools-extra/clang-tidy/modernize/UseStdFormatCheck.cpp
clang-tools-extra/clang-tidy/modernize/UseStdFormatCheck.h
clang-tools-extra/clang-tidy/modernize/UseStdPrintCheck.cpp
clang-tools-extra/clang-tidy/utils/FormatStringConverter.cpp
clang-tools-extra/clang-tidy/utils/FormatStringConverter.h
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/clang-tidy/checks/list.rst
clang-tools-extra/docs/clang-tidy/checks/modernize/use-std-format.rst
clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format-custom.cpp
clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format-fmt.cpp
clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format.cpp
Index: clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format.cpp
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format.cpp
@@ -0,0 +1,75 @@
+// RUN: %check_clang_tidy \
+// RUN: -std=c++20 %s modernize-use-std-format %t -- \
+// RUN: -config="{CheckOptions: [{key: StrictMode, value: true}]}" \
+// RUN: -- -isystem %clang_tidy_headers
+// RUN: %check_clang_tidy \
+// RUN: -std=c++20 %s modernize-use-std-format %t -- \
+// RUN: -config="{CheckOptions: [{key: StrictMode, value: false}]}" \
+// RUN: -- -isystem %clang_tidy_headers
+#include <string>
+// CHECK-FIXES: #include <format>
+
+namespace absl
+{
+// Use const char * for the format since the real type is hard to mock up.
+template <typename... Args>
+std::string StrFormat(const char *format, const Args&... args);
+} // namespace absl
+
+std::string StrFormat_simple() {
+ return absl::StrFormat("Hello");
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: return std::format("Hello");
+}
+
+std::string StrFormat_complex(const char *name, double value) {
+ return absl::StrFormat("'%s'='%f'", name, value);
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: return std::format("'{}'='{:f}'", name, value);
+}
+
+std::string StrFormat_integer_conversions() {
+ return absl::StrFormat("int:%d int:%d char:%c char:%c", 65, 'A', 66, 'B');
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: return std::format("int:{} int:{:d} char:{:c} char:{}", 65, 'A', 66, 'B');
+}
+
+// FormatConverter is capable of removing newlines from the end of the format
+// string. Ensure that isn't incorrectly happening for std::format.
+std::string StrFormat_no_newline_removal() {
+ return absl::StrFormat("a line\n");
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: return std::format("a line\n");
+}
+
+// FormatConverter is capable of removing newlines from the end of the format
+// string. Ensure that isn't incorrectly happening for std::format.
+std::string StrFormat_cstr_removal(const std::string &s1, const std::string *s2) {
+ return absl::StrFormat("%s %s %s %s", s1.c_str(), s1.data(), s2->c_str(), s2->data());
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: return std::format("{} {} {} {}", s1, s1, *s2, *s2);
+}
+
+std::string StrFormat_strict_conversion() {
+ const unsigned char uc = 'A';
+ return absl::StrFormat("Integer %hhd from unsigned char\n", uc);
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: return std::format("Integer {} from unsigned char\n", uc);
+}
+
+std::string StrFormat_field_width_and_precision() {
+ auto s1 = absl::StrFormat("width only:%*d width and precision:%*.*f precision only:%.*f", 3, 42, 4, 2, 3.14159265358979323846, 5, 2.718);
+ // CHECK-MESSAGES: [[@LINE-1]]:13: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: std::format("width only:{:{}} width and precision:{:{}.{}f} precision only:{:.{}f}", 42, 3, 3.14159265358979323846, 4, 2, 2.718, 5);
+
+ auto s2 = absl::StrFormat("width and precision positional:%1$*2$.*3$f after", 3.14159265358979323846, 4, 2);
+ // CHECK-MESSAGES: [[@LINE-1]]:13: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: std::format("width and precision positional:{0:{1}.{2}f} after", 3.14159265358979323846, 4, 2);
+
+ const int width = 10, precision = 3;
+ auto s3 = absl::StrFormat("width only:%3$*1$d width and precision:%4$*1$.*2$f precision only:%5$.*2$f", width, precision, 42, 3.1415926, 2.718);
+ // CHECK-MESSAGES: [[@LINE-1]]:13: warning: use 'std::format' instead of 'StrFormat' [modernize-use-std-format]
+ // CHECK-FIXES: std::format("width only:{2:{0}} width and precision:{3:{0}.{1}f} precision only:{4:.{1}f}", width, precision, 42, 3.1415926, 2.718);
+
+ return s1 + s2 + s3;
+}
Index: clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format-fmt.cpp
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format-fmt.cpp
@@ -0,0 +1,37 @@
+// RUN: %check_clang_tidy %s modernize-use-std-format %t -- \
+// RUN: -config="{CheckOptions: \
+// RUN: [ \
+// RUN: { \
+// RUN: key: StrictMode, value: true \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.StrFormatLikeFunctions, \
+// RUN: value: 'fmt::sprintf' \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.ReplacementFormatFunction, \
+// RUN: value: 'fmt::format' \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.FormatHeader, \
+// RUN: value: '<fmt/core.h>' \
+// RUN: } \
+// RUN: ] \
+// RUN: }" \
+// RUN: -- -isystem %clang_tidy_headers
+
+// CHECK-FIXES: #include <fmt/core.h>
+#include <string>
+
+namespace fmt
+{
+// Use const char * for the format since the real type is hard to mock up.
+template <typename... Args>
+std::string sprintf(const char *format, const Args&... args);
+} // namespace fmt
+
+std::string fmt_sprintf_simple() {
+ return fmt::sprintf("Hello %s %d", "world", 42);
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'fmt::format' instead of 'sprintf' [modernize-use-std-format]
+ // CHECK-FIXES: fmt::format("Hello {} {}", "world", 42);
+}
Index: clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format-custom.cpp
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/checkers/modernize/use-std-format-custom.cpp
@@ -0,0 +1,69 @@
+// RUN: %check_clang_tidy -check-suffixes=,STRICT \
+// RUN: -std=c++20 %s modernize-use-std-format %t -- \
+// RUN: -config="{CheckOptions: \
+// RUN: [ \
+// RUN: { \
+// RUN: key: StrictMode, value: true \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.StrFormatLikeFunctions, \
+// RUN: value: '::strprintf; mynamespace::strprintf2' \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.ReplacementFormatFunction, \
+// RUN: value: 'fmt::format' \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.FormatHeader, \
+// RUN: value: '<fmt/core.h>' \
+// RUN: } \
+// RUN: ] \
+// RUN: }" \
+// RUN: -- -isystem %clang_tidy_headers
+// RUN: %check_clang_tidy -check-suffixes=,NOTSTRICT \
+// RUN: -std=c++20 %s modernize-use-std-format %t -- \
+// RUN: -config="{CheckOptions: \
+// RUN: [ \
+// RUN: { \
+// RUN: key: modernize-use-std-format.StrFormatLikeFunctions, \
+// RUN: value: '::strprintf; mynamespace::strprintf2' \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.ReplacementFormatFunction, \
+// RUN: value: 'fmt::format' \
+// RUN: }, \
+// RUN: { \
+// RUN: key: modernize-use-std-format.FormatHeader, \
+// RUN: value: '<fmt/core.h>' \
+// RUN: } \
+// RUN: ] \
+// RUN: }" \
+// RUN: -- -isystem %clang_tidy_headers
+
+#include <cstdio>
+#include <string>
+// CHECK-FIXES: #include <fmt/core.h>
+
+std::string strprintf(const char *, ...);
+
+namespace mynamespace {
+ std::string strprintf2(const char *, ...);
+}
+
+std::string strprintf_test(const std::string &name, double value) {
+ return strprintf("'%s'='%f'\n", name.c_str(), value);
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'fmt::format' instead of 'strprintf' [modernize-use-std-format]
+ // CHECK-FIXES: return fmt::format("'{}'='{:f}'\n", name, value);
+
+ return mynamespace::strprintf2("'%s'='%f'\n", name.c_str(), value);
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'fmt::format' instead of 'strprintf2' [modernize-use-std-format]
+ // CHECK-FIXES: return fmt::format("'{}'='{:f}'\n", name, value);
+}
+
+std::string StrFormat_strict_conversion() {
+ const unsigned char uc = 'A';
+ return strprintf("Integer %hhd from unsigned char\n", uc);
+ // CHECK-MESSAGES: [[@LINE-1]]:10: warning: use 'fmt::format' instead of 'strprintf' [modernize-use-std-format]
+ // CHECK-FIXES-NOTSTRICT: return fmt::format("Integer {} from unsigned char\n", uc);
+ // CHECK-FIXES-STRICT: return fmt::format("Integer {} from unsigned char\n", static_cast<signed char>(uc));
+}
Index: clang-tools-extra/docs/clang-tidy/checks/modernize/use-std-format.rst
===================================================================
--- /dev/null
+++ clang-tools-extra/docs/clang-tidy/checks/modernize/use-std-format.rst
@@ -0,0 +1,86 @@
+.. title:: clang-tidy - modernize-use-std-format
+
+modernize-use-std-format
+========================
+
+Converts calls to ``absl::StrFormat`` to equivalent calls to C++20's
+``std::format`` function, modifying the format string appropriately. The
+replaced and replacement functions can be customised by configuration
+options. Each argument that is the result of a call to
+``std::string::c_str()`` and ``std::string::data()`` will have that
+now-unnecessary call removed in a similar manner to the
+`readability-redundant-string-cstr` check.
+
+In other words, it turns lines like:
+
+.. code-block:: c++
+
+ return absl::StrFormat("The %s is %3d\n", description.c_str(), value);
+
+into:
+
+.. code-block:: c++
+
+ return std::format("The {} is {:3}", description, value);
+
+The check uses the same format-string-conversion algorithm as
+`modernize-use-std-print <modernize/use-std-print.html>` and its
+shortcomings are described in the documentation for that check.
+
+Options
+-------
+
+.. option:: StrictMode TODO
+
+ When true, the check will add casts when converting from variadic
+ functions and printing signed or unsigned integer types (including
+ fixed-width integer types from ``<cstdint>``, ``ptrdiff_t``, ``size_t``
+ and ``ssize_t``) as the opposite signedness to ensure that the output
+ would matches that of a simple wrapper for ``std::sprintf`` that
+ accepted a C-style variable argument list. For example, with
+ `StrictMode` enabled:
+
+ .. code-block:: c++
+
+ extern std::string strprintf(const char *format, ...);
+ int i = -42;
+ unsigned int u = 0xffffffff;
+ return strprintf("%d %u\n", i, u);
+
+ would be converted to:
+
+ .. code-block:: c++
+
+ return std::format("{} {}\n", static_cast<unsigned int>(i), static_cast<int>(u));
+
+ to ensure that the output will continue to be the unsigned representation
+ of -42 and the signed representation of 0xffffffff (often 4294967254
+ and -1 respectively.) When false (which is the default), these casts
+ will not be added which may cause a change in the output. Note that this
+ option makes no difference for the default value of
+ `StrFormatLikeFunctions` since ``absl::StrFormat`` takes a function
+ parameter pack and is not a variadic function.
+
+.. option:: StrFormatLikeFunctions
+
+ A semicolon-separated list of (fully qualified) extra function names to
+ replace, with the requirement that the first parameter contains the
+ printf-style format string and the arguments to be formatted follow
+ immediately afterwards. The defaualt value for this option is
+ ``absl::StrFormat``.
+
+.. option:: ReplacementFormatFunction
+
+ The function that will be used to replace the function set by the
+ StrFormatLikeFunctions option rather than the default
+ ``std::format``. It is expected that the function provides an interface
+ that is compatible with ``std::format``. A suitable candidate would be
+ ``fmt::format``.
+
+.. option:: FormatHeader
+
+ The header that must be included for the declaration of
+ `ReplacementFormatFunction` so that a ``#include`` directive can be added if
+ required. If `ReplacementFormatFunction` is ``std::format`` then this option will
+ default to ``<format>``, otherwise this option will default to nothing
+ and no ``#include`` directive will be added.
Index: clang-tools-extra/docs/clang-tidy/checks/list.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -302,6 +302,7 @@
`modernize-use-noexcept <modernize/use-noexcept.html>`_, "Yes"
`modernize-use-nullptr <modernize/use-nullptr.html>`_, "Yes"
`modernize-use-override <modernize/use-override.html>`_, "Yes"
+ `modernize-use-std-format <modernize/use-std-format.html>`_, "Yes"
`modernize-use-std-print <modernize/use-std-print.html>`_, "Yes"
`modernize-use-trailing-return-type <modernize/use-trailing-return-type.html>`_, "Yes"
`modernize-use-transparent-functors <modernize/use-transparent-functors.html>`_, "Yes"
Index: clang-tools-extra/docs/ReleaseNotes.rst
===================================================================
--- clang-tools-extra/docs/ReleaseNotes.rst
+++ clang-tools-extra/docs/ReleaseNotes.rst
@@ -181,6 +181,15 @@
Converts standard library type traits of the form ``traits<...>::type`` and
``traits<...>::value`` into ``traits_t<...>`` and ``traits_v<...>`` respectively.
+- New :doc:`modernize-use-std-format
+ <clang-tidy/checks/modernize/use-std-format>` check.
+
+ 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-unnecessray calls to ``std::string::c_str()`` and
+ ``std::string::data()``.
+
- New :doc:`modernize-use-std-print
<clang-tidy/checks/modernize/use-std-print>` check.
Index: clang-tools-extra/clang-tidy/utils/FormatStringConverter.h
===================================================================
--- clang-tools-extra/clang-tidy/utils/FormatStringConverter.h
+++ clang-tools-extra/clang-tidy/utils/FormatStringConverter.h
@@ -32,8 +32,14 @@
public:
using ConversionSpecifier = clang::analyze_format_string::ConversionSpecifier;
using PrintfSpecifier = analyze_printf::PrintfSpecifier;
+
+ struct Configuration {
+ bool StrictMode = false;
+ bool AllowTrailingNewlineRemoval = false;
+ };
+
FormatStringConverter(ASTContext *Context, const CallExpr *Call,
- unsigned FormatArgOffset, bool StrictMode,
+ unsigned FormatArgOffset, Configuration Config,
const LangOptions &LO);
bool canApply() const { return ConversionNotPossibleReason.empty(); }
@@ -45,6 +51,7 @@
private:
ASTContext *Context;
+ const Configuration Config;
const bool CastMismatchedIntegerTypes;
const Expr *const *Args;
const unsigned NumArgs;
Index: clang-tools-extra/clang-tidy/utils/FormatStringConverter.cpp
===================================================================
--- clang-tools-extra/clang-tidy/utils/FormatStringConverter.cpp
+++ clang-tools-extra/clang-tidy/utils/FormatStringConverter.cpp
@@ -198,10 +198,11 @@
FormatStringConverter::FormatStringConverter(ASTContext *ContextIn,
const CallExpr *Call,
unsigned FormatArgOffset,
- bool StrictMode,
+ const Configuration ConfigIn,
const LangOptions &LO)
- : Context(ContextIn),
- CastMismatchedIntegerTypes(castMismatchedIntegerTypes(Call, StrictMode)),
+ : Context(ContextIn), Config(ConfigIn),
+ CastMismatchedIntegerTypes(
+ castMismatchedIntegerTypes(Call, ConfigIn.StrictMode)),
Args(Call->getArgs()), NumArgs(Call->getNumArgs()),
ArgsOffset(FormatArgOffset + 1), LangOpts(LO) {
assert(ArgsOffset <= NumArgs);
@@ -624,7 +625,8 @@
PrintfFormatString.size() - PrintfFormatStringPos));
PrintfFormatStringPos = PrintfFormatString.size();
- if (StringRef(StandardFormatString).ends_with("\\n") &&
+ if (Config.AllowTrailingNewlineRemoval &&
+ StringRef(StandardFormatString).ends_with("\\n") &&
!StringRef(StandardFormatString).ends_with("\\\\n")) {
UsePrintNewlineFunction = true;
FormatStringNeededRewriting = true;
Index: clang-tools-extra/clang-tidy/modernize/UseStdPrintCheck.cpp
===================================================================
--- clang-tools-extra/clang-tidy/modernize/UseStdPrintCheck.cpp
+++ clang-tools-extra/clang-tidy/modernize/UseStdPrintCheck.cpp
@@ -129,8 +129,11 @@
FormatArgOffset = 1;
}
+ utils::FormatStringConverter::Configuration ConverterConfig;
+ ConverterConfig.StrictMode = StrictMode;
+ ConverterConfig.AllowTrailingNewlineRemoval = true;
utils::FormatStringConverter Converter(
- Result.Context, Printf, FormatArgOffset, StrictMode, getLangOpts());
+ Result.Context, Printf, FormatArgOffset, ConverterConfig, getLangOpts());
const Expr *PrintfCall = Printf->getCallee();
const StringRef ReplacementFunction = Converter.usePrintNewlineFunction()
? ReplacementPrintlnFunction
Index: clang-tools-extra/clang-tidy/modernize/UseStdFormatCheck.h
===================================================================
--- /dev/null
+++ clang-tools-extra/clang-tidy/modernize/UseStdFormatCheck.h
@@ -0,0 +1,50 @@
+//===--- 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 "../ClangTidyCheck.h"
+#include "../utils/IncludeInserter.h"
+
+namespace clang::tidy::modernize {
+
+/// Convert calls to absl::StrFormat-like functions to std::format.
+///
+/// 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;
+};
+
+} // namespace clang::tidy::modernize
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTDFORMATCHECK_H
Index: clang-tools-extra/clang-tidy/modernize/UseStdFormatCheck.cpp
===================================================================
--- /dev/null
+++ clang-tools-extra/clang-tidy/modernize/UseStdFormatCheck.cpp
@@ -0,0 +1,102 @@
+//===--- UseStdFormatCheck.cpp - clang-tidy -------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "UseStdFormatCheck.h"
+#include "../utils/FormatStringConverter.h"
+#include "../utils/Matchers.h"
+#include "../utils/OptionsUtils.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/Lex/Lexer.h"
+#include "clang/Tooling/FixIt.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang::tidy::modernize {
+
+UseStdFormatCheck::UseStdFormatCheck(StringRef Name, ClangTidyContext *Context)
+ : ClangTidyCheck(Name, Context),
+ StrictMode(Options.getLocalOrGlobal("StrictMode", false)),
+ StrFormatLikeFunctions(utils::options::parseStringList(
+ Options.get("StrFormatLikeFunctions", ""))),
+ ReplacementFormatFunction(
+ Options.get("ReplacementFormatFunction", "std::format")),
+ IncludeInserter(Options.getLocalOrGlobal("IncludeStyle",
+ utils::IncludeSorter::IS_LLVM),
+ areDiagsSelfContained()),
+ MaybeHeaderToInclude(Options.get("FormatHeader")) {
+ if (StrFormatLikeFunctions.empty())
+ StrFormatLikeFunctions.push_back("absl::StrFormat");
+
+ if (!MaybeHeaderToInclude && ReplacementFormatFunction == "std::format")
+ MaybeHeaderToInclude = "<format>";
+}
+
+void UseStdFormatCheck::registerPPCallbacks(const SourceManager &SM,
+ Preprocessor *PP,
+ Preprocessor *ModuleExpanderPP) {
+ IncludeInserter.registerPreprocessor(PP);
+}
+
+void UseStdFormatCheck::registerMatchers(MatchFinder *Finder) {
+ StatementMatcher StrFormatMatcher =
+ callExpr(callee(functionDecl(matchers::matchesAnyListedName(
+ StrFormatLikeFunctions))
+ .bind("func_decl")),
+ hasArgument(0, stringLiteral()))
+ .bind("StrFormat");
+ Finder->addMatcher(StrFormatMatcher, this);
+}
+
+void UseStdFormatCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
+ using utils::options::serializeStringList;
+ Options.store(Opts, "StrictMode", StrictMode);
+ Options.store(Opts, "StrFormatLikeFunctions",
+ serializeStringList(StrFormatLikeFunctions));
+ Options.store(Opts, "ReplacementFormatFunction", ReplacementFormatFunction);
+ Options.store(Opts, "IncludeStyle", IncludeInserter.getStyle());
+ if (MaybeHeaderToInclude)
+ Options.store(Opts, "FormatHeader", *MaybeHeaderToInclude);
+}
+
+void UseStdFormatCheck::check(const MatchFinder::MatchResult &Result) {
+ const unsigned FormatArgOffset = 0;
+ const auto *OldFunction = Result.Nodes.getNodeAs<FunctionDecl>("func_decl");
+ const auto *StrFormat = Result.Nodes.getNodeAs<CallExpr>("StrFormat");
+
+ utils::FormatStringConverter::Configuration ConverterConfig;
+ ConverterConfig.StrictMode = StrictMode;
+ utils::FormatStringConverter Converter(Result.Context, StrFormat,
+ FormatArgOffset, ConverterConfig,
+ getLangOpts());
+ const Expr *StrFormatCall = StrFormat->getCallee();
+ if (!Converter.canApply()) {
+ DiagnosticBuilder Diag = diag(StrFormatCall->getBeginLoc(),
+ "unable to use '%0' instead of %1 because %2")
+ << ReplacementFormatFunction
+ << OldFunction->getIdentifier()
+ << Converter.conversionNotPossibleReason();
+ return;
+ }
+
+ DiagnosticBuilder Diag =
+ diag(StrFormatCall->getBeginLoc(), "use '%0' instead of %1")
+ << ReplacementFormatFunction << OldFunction->getIdentifier();
+ Diag << FixItHint::CreateReplacement(
+ CharSourceRange::getTokenRange(StrFormatCall->getBeginLoc(),
+ StrFormatCall->getEndLoc()),
+ ReplacementFormatFunction);
+ Converter.applyFixes(Diag, *Result.SourceManager);
+
+ if (MaybeHeaderToInclude)
+ Diag << IncludeInserter.createIncludeInsertion(
+ Result.Context->getSourceManager().getFileID(
+ StrFormatCall->getBeginLoc()),
+ *MaybeHeaderToInclude);
+}
+
+} // namespace clang::tidy::modernize
Index: clang-tools-extra/clang-tidy/modernize/ModernizeTidyModule.cpp
===================================================================
--- clang-tools-extra/clang-tidy/modernize/ModernizeTidyModule.cpp
+++ clang-tools-extra/clang-tidy/modernize/ModernizeTidyModule.cpp
@@ -38,6 +38,7 @@
#include "UseNoexceptCheck.h"
#include "UseNullptrCheck.h"
#include "UseOverrideCheck.h"
+#include "UseStdFormatCheck.h"
#include "UseStdPrintCheck.h"
#include "UseTrailingReturnTypeCheck.h"
#include "UseTransparentFunctorsCheck.h"
@@ -65,6 +66,7 @@
CheckFactories.registerCheck<MakeSharedCheck>("modernize-make-shared");
CheckFactories.registerCheck<MakeUniqueCheck>("modernize-make-unique");
CheckFactories.registerCheck<PassByValueCheck>("modernize-pass-by-value");
+ CheckFactories.registerCheck<UseStdFormatCheck>("modernize-use-std-format");
CheckFactories.registerCheck<UseStdPrintCheck>("modernize-use-std-print");
CheckFactories.registerCheck<RawStringLiteralCheck>(
"modernize-raw-string-literal");
Index: clang-tools-extra/clang-tidy/modernize/CMakeLists.txt
===================================================================
--- clang-tools-extra/clang-tidy/modernize/CMakeLists.txt
+++ clang-tools-extra/clang-tidy/modernize/CMakeLists.txt
@@ -37,6 +37,7 @@
UseNoexceptCheck.cpp
UseNullptrCheck.cpp
UseOverrideCheck.cpp
+ UseStdFormatCheck.cpp
UseStdPrintCheck.cpp
UseTrailingReturnTypeCheck.cpp
UseTransparentFunctorsCheck.cpp
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
