Skip to content

Commit 3db2874

Browse files
committed
Extend bilingual_str support for tinyformat
Previous bilingual_str tinyformat::format accepted bilingual format strings, but not bilingual arguments. Extend it to accept both. This is useful when embedding one translated string inside another translated string, for example: `strprintf(_("Error: %s"), message)` which would fail previously if `message` was a bilingual_str.
1 parent c361df9 commit 3db2874

File tree

4 files changed

+37
-1
lines changed

4 files changed

+37
-1
lines changed

src/Makefile.test.include

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ BITCOIN_TESTS =\
147147
test/timedata_tests.cpp \
148148
test/torcontrol_tests.cpp \
149149
test/transaction_tests.cpp \
150+
test/translation_tests.cpp \
150151
test/txindex_tests.cpp \
151152
test/txpackage_tests.cpp \
152153
test/txreconciliation_tests.cpp \

src/test/translation_tests.cpp

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Copyright (c) 2023 The Bitcoin Core developers
2+
// Distributed under the MIT software license, see the accompanying
3+
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4+
5+
#include <tinyformat.h>
6+
#include <util/translation.h>
7+
8+
#include <boost/test/unit_test.hpp>
9+
10+
BOOST_AUTO_TEST_SUITE(translation_tests)
11+
12+
BOOST_AUTO_TEST_CASE(translation_namedparams)
13+
{
14+
bilingual_str arg{"original", "translated"};
15+
bilingual_str format{"original [%s]", "translated [%s]"};
16+
bilingual_str result{strprintf(format, arg)};
17+
BOOST_CHECK_EQUAL(result.original, "original [original]");
18+
BOOST_CHECK_EQUAL(result.translated, "translated [translated]");
19+
}
20+
21+
BOOST_AUTO_TEST_SUITE_END()

src/util/translation.h

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,24 @@ inline bilingual_str operator+(bilingual_str lhs, const bilingual_str& rhs)
4747
/** Mark a bilingual_str as untranslated */
4848
inline bilingual_str Untranslated(std::string original) { return {original, original}; }
4949

50+
// Provide an overload of tinyformat::format which can take bilingual_str arguments.
5051
namespace tinyformat {
52+
inline std::string TranslateArg(const bilingual_str& arg, bool translated)
53+
{
54+
return translated ? arg.translated : arg.original;
55+
}
56+
57+
template <typename T>
58+
inline T const& TranslateArg(const T& arg, bool translated)
59+
{
60+
return arg;
61+
}
62+
5163
template <typename... Args>
5264
bilingual_str format(const bilingual_str& fmt, const Args&... args)
5365
{
54-
return bilingual_str{format(fmt.original, args...), format(fmt.translated, args...)};
66+
return bilingual_str{format(fmt.original, TranslateArg(args, false)...),
67+
format(fmt.translated, TranslateArg(args, true)...)};
5568
}
5669
} // namespace tinyformat
5770

test/lint/run-lint-format-strings.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
("src/index/base.cpp", "FatalError(const char* fmt, const Args&... args)"),
1818
("src/netbase.cpp", "LogConnectFailure(bool manual_connection, const char* fmt, const Args&... args)"),
1919
("src/clientversion.cpp", "strprintf(_(COPYRIGHT_HOLDERS).translated, COPYRIGHT_HOLDERS_SUBSTITUTION)"),
20+
("src/test/translation_tests.cpp", "strprintf(format, arg)"),
2021
("src/validationinterface.cpp", "LogPrint(BCLog::VALIDATION, fmt \"\\n\", __VA_ARGS__)"),
2122
("src/wallet/wallet.h", "WalletLogPrintf(std::string fmt, Params... parameters)"),
2223
("src/wallet/wallet.h", "LogPrintf((\"%s \" + fmt).c_str(), GetDisplayName(), parameters...)"),

0 commit comments

Comments
 (0)