READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server340 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

49,690 bytes · SHA-256 3b1389ff6b6a649a… · View upstream ↗

1// tinyformat.h
2// Copyright (C) 2011, Chris Foster [chris42f (at) gmail (d0t) com]
3//
4// Boost Software License - Version 1.0
5//
6// Permission is hereby granted, free of charge, to any person or organization
7// obtaining a copy of the software and accompanying documentation covered by
8// this license (the "Software") to use, reproduce, display, distribute,
9// execute, and transmit the Software, and to prepare derivative works of the
10// Software, and to permit third-parties to whom the Software is furnished to
11// do so, all subject to the following:
12//
13// The copyright notices in the Software and this entire statement, including
14// the above license grant, this restriction and the following disclaimer,
15// must be included in all copies of the Software, in whole or in part, and
16// all derivative works of the Software, unless such copies or derivative
17// works are solely in the form of machine-executable object code generated by
18// a source language processor.
19//
20// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
23// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
24// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
25// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26// DEALINGS IN THE SOFTWARE.
27
28//------------------------------------------------------------------------------
29// Tinyformat: A minimal type safe printf replacement
30//
31// tinyformat.h is a type safe printf replacement library in a single C++
32// header file.  Design goals include:
33//
34// * Type safety and extensibility for user defined types.
35// * C99 printf() compatibility, to the extent possible using std::ostream
36// * POSIX extension for positional arguments
37// * Simplicity and minimalism.  A single header file to include and distribute
38//   with your projects.
39// * Augment rather than replace the standard stream formatting mechanism
40// * C++98 support, with optional C++11 niceties
41//
42//
43// Main interface example usage
44// ----------------------------
45//
46// To print a date to std::cout for American usage:
47//
48//   std::string weekday = "Wednesday";
49//   const char* month = "July";
50//   size_t day = 27;
51//   long hour = 14;
52//   int min = 44;
53//
54//   tfm::printf("%s, %s %d, %.2d:%.2d\n", weekday, month, day, hour, min);
55//
56// POSIX extension for positional arguments is available.
57// The ability to rearrange formatting arguments is an important feature
58// for localization because the word order may vary in different languages.
59//
60// Previous example for German usage. Arguments are reordered:
61//
62//   tfm::printf("%1$s, %3$d. %2$s, %4$d:%5$.2d\n", weekday, month, day, hour, min);
63//
64// The strange types here emphasize the type safety of the interface; it is
65// possible to print a std::string using the "%s" conversion, and a
66// size_t using the "%d" conversion.  A similar result could be achieved
67// using either of the tfm::format() functions.  One prints on a user provided
68// stream:
69//
70//   tfm::format(std::cerr, "%s, %s %d, %.2d:%.2d\n",
71//               weekday, month, day, hour, min);
72//
73// The other returns a std::string:
74//
75//   std::string date = tfm::format("%s, %s %d, %.2d:%.2d\n",
76//                                  weekday, month, day, hour, min);
77//   std::cout << date;
78//
79// These are the three primary interface functions.  There is also a
80// convenience function printfln() which appends a newline to the usual result
81// of printf() for super simple logging.
82//
83//
84// User defined format functions
85// -----------------------------
86//
87// Simulating variadic templates in C++98 is pretty painful since it requires
88// writing out the same function for each desired number of arguments.  To make
89// this bearable tinyformat comes with a set of macros which are used
90// internally to generate the API, but which may also be used in user code.
91//
92// The three macros TINYFORMAT_ARGTYPES(n), TINYFORMAT_VARARGS(n) and
93// TINYFORMAT_PASSARGS(n) will generate a list of n argument types,
94// type/name pairs and argument names respectively when called with an integer
95// n between 1 and 16.  We can use these to define a macro which generates the
96// desired user defined function with n arguments.  To generate all 16 user
97// defined function bodies, use the macro TINYFORMAT_FOREACH_ARGNUM.  For an
98// example, see the implementation of printf() at the end of the source file.
99//
100// Sometimes it's useful to be able to pass a list of format arguments through
101// to a non-template function.  The FormatList class is provided as a way to do
102// this by storing the argument list in a type-opaque way.  Continuing the
103// example from above, we construct a FormatList using makeFormatList():
104//
105//   FormatListRef formatList = tfm::makeFormatList(weekday, month, day, hour, min);
106//
107// The format list can now be passed into any non-template function and used
108// via a call to the vformat() function:
109//
110//   tfm::vformat(std::cout, "%s, %s %d, %.2d:%.2d\n", formatList);
111//
112//
113// Additional API information
114// --------------------------
115//
116// Error handling: Define TINYFORMAT_ERROR to customize the error handling for
117// format strings which are unsupported or have the wrong number of format
118// specifiers (calls assert() by default).
119//
120// User defined types: Uses operator<< for user defined types by default.
121// Overload formatValue() for more control.
122
123
124#ifndef TINYFORMAT_H_INCLUDED
125#define TINYFORMAT_H_INCLUDED
126
127namespace tinyformat {}
128//------------------------------------------------------------------------------
129// Config section.  Customize to your liking!
130
131// Namespace alias to encourage brevity
132namespace tfm = tinyformat;
133
134// Error handling; calls assert() by default.
135#define TINYFORMAT_ERROR(reasonString) throw tinyformat::format_error(reasonString)
136
137// Define for C++11 variadic templates which make the code shorter & more
138// general.  If you don't define this, C++11 support is autodetected below.
139#define TINYFORMAT_USE_VARIADIC_TEMPLATES
140
141
142//------------------------------------------------------------------------------
143// Implementation details.
144#include <algorithm>
145#include <attributes.h> // Added for Bitcoin Core
146#include <iostream>
147#include <sstream>
148#include <stdexcept> // Added for Bitcoin Core
149#include <util/string.h> // Added for Bitcoin Core
150
151#ifndef TINYFORMAT_ASSERT
152#   include <cassert>
153#   define TINYFORMAT_ASSERT(cond) assert(cond)
154#endif
155
156#ifndef TINYFORMAT_ERROR
157#   include <cassert>
158#   define TINYFORMAT_ERROR(reason) assert(0 && reason)
159#endif
160
161#if !defined(TINYFORMAT_USE_VARIADIC_TEMPLATES) && !defined(TINYFORMAT_NO_VARIADIC_TEMPLATES)
162#   ifdef __GXX_EXPERIMENTAL_CXX0X__
163#       define TINYFORMAT_USE_VARIADIC_TEMPLATES
164#   endif
165#endif
166
167#if defined(__GLIBCXX__) && __GLIBCXX__ < 20080201
168//  std::showpos is broken on old libstdc++ as provided with macOS.  See
169//  http://gcc.gnu.org/ml/libstdc++/2007-11/msg00075.html
170#   define TINYFORMAT_OLD_LIBSTDCPLUSPLUS_WORKAROUND
171#endif
172
173#ifdef __APPLE__
174// Workaround macOS linker warning: Xcode uses different default symbol
175// visibilities for static libs vs executables (see issue #25)
176#   define TINYFORMAT_HIDDEN __attribute__((visibility("hidden")))
177#else
178#   define TINYFORMAT_HIDDEN
179#endif
180
181namespace tinyformat {
182
183// Added for Bitcoin Core. Similar to std::runtime_format from C++26.
184struct RuntimeFormat {
185    const std::string& fmt; // Not a string view, because tinyformat requires a c_str
186    explicit RuntimeFormat(LIFETIMEBOUND const std::string& str) : fmt{str} {}
187};
188
189// Added for Bitcoin Core. Wrapper for checking format strings at compile time.
190// Unlike ConstevalFormatString this supports RunTimeFormat-wrapped std::string
191// for runtime string formatting without compile time checks.
192template <unsigned num_params>
193struct FormatStringCheck {
194    consteval FormatStringCheck(const char* str) : fmt{util::ConstevalFormatString<num_params>{str}.fmt} {}
195    FormatStringCheck(LIFETIMEBOUND const RuntimeFormat& run) : fmt{run.fmt.c_str()} {}
196    FormatStringCheck(util::ConstevalFormatString<num_params> str) : fmt{str.fmt} {}
197    operator const char*() { return fmt; }
198    const char* fmt;
199};
200
201// Added for Bitcoin Core
202class format_error: public std::runtime_error
203{
204public:
205    explicit format_error(const std::string &what): std::runtime_error(what) {
206    }
207};
208
209//------------------------------------------------------------------------------
210namespace detail {
211
212// Test whether type T1 is convertible to type T2
213template <typename T1, typename T2>
214struct is_convertible
215{
216    private:
217        // two types of different size
218        struct fail { char dummy[2]; };
219        struct succeed { char dummy; };
220        // Try to convert a T1 to a T2 by plugging into tryConvert
221        static fail tryConvert(...);
222        static succeed tryConvert(const T2&);
223        static const T1& makeT1();
224    public:
225#       ifdef _MSC_VER
226        // Disable spurious loss of precision warnings in tryConvert(makeT1())
227#       pragma warning(push)
228#       pragma warning(disable:4244)
229#       pragma warning(disable:4267)
230#       endif
231        // Standard trick: the (...) version of tryConvert will be chosen from
232        // the overload set only if the version taking a T2 doesn't match.
233        // Then we compare the sizes of the return types to check which
234        // function matched.  Very neat, in a disgusting kind of way :)
235        static constexpr bool value =
236            sizeof(tryConvert(makeT1())) == sizeof(succeed);
237#       ifdef _MSC_VER
238#       pragma warning(pop)
239#       endif
240};
241
242
243// Detect when a type is not a wchar_t string
244template<typename T> struct is_wchar { typedef int tinyformat_wchar_is_not_supported; };
245template<> struct is_wchar<wchar_t*> {};
246template<> struct is_wchar<const wchar_t*> {};
247template<int n> struct is_wchar<const wchar_t[n]> {};
248template<int n> struct is_wchar<wchar_t[n]> {};
249
250

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.