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 server440 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.

16,269 bytes · SHA-256 42cd6cfc8f0de649… · View upstream ↗

1// Copyright (c) 2011-present 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#ifndef BITCOIN_QT_GUIUTIL_H
6#define BITCOIN_QT_GUIUTIL_H
7
8#include <consensus/amount.h>
9#include <net.h>
10#include <netaddress.h>
11#include <util/check.h>
12#include <util/fs.h>
13
14#include <QApplication>
15#include <QEvent>
16#include <QHeaderView>
17#include <QItemDelegate>
18#include <QLabel>
19#include <QMessageBox>
20#include <QMetaObject>
21#include <QObject>
22#include <QProgressBar>
23#include <QString>
24#include <QTableView>
25
26#include <cassert>
27#include <chrono>
28#include <utility>
29
30class PlatformStyle;
31class QValidatedLineEdit;
32class SendCoinsRecipient;
33
34namespace interfaces
35{
36    class Node;
37}
38
39QT_BEGIN_NAMESPACE
40class QAbstractButton;
41class QAbstractItemView;
42class QAction;
43class QDateTime;
44class QDialog;
45class QFont;
46class QKeySequence;
47class QLineEdit;
48class QMenu;
49class QPoint;
50class QProgressDialog;
51class QUrl;
52class QWidget;
53QT_END_NAMESPACE
54
55/** Utility functions used by the Bitcoin Qt UI.
56 */
57namespace GUIUtil
58{
59    // Use this flags to prevent a "What's This" button in the title bar of the dialog on Windows.
60    constexpr auto dialog_flags = Qt::WindowTitleHint | Qt::WindowSystemMenuHint | Qt::WindowCloseButtonHint;
61
62    // Create human-readable string from date
63    QString dateTimeStr(const QDateTime &datetime);
64    QString dateTimeStr(qint64 nTime);
65
66    // Return a monospace font
67    QFont fixedPitchFont(bool use_embedded_font = false);
68
69    // Set up widget for address
70    void setupAddressWidget(QValidatedLineEdit *widget, QWidget *parent);
71
72    /**
73     * Connects an additional shortcut to a QAbstractButton. Works around the
74     * one shortcut limitation of the button's shortcut property.
75     * @param[in] button    QAbstractButton to assign shortcut to
76     * @param[in] shortcut  QKeySequence to use as shortcut
77     */
78    void AddButtonShortcut(QAbstractButton* button, const QKeySequence& shortcut);
79
80    // Parse "bitcoin:" URI into recipient object, return true on successful parsing
81    bool parseBitcoinURI(const QUrl &uri, SendCoinsRecipient *out);
82    bool parseBitcoinURI(QString uri, SendCoinsRecipient *out);
83    QString formatBitcoinURI(const SendCoinsRecipient &info);
84
85    // Returns true if given address+amount meets "dust" definition
86    bool isDust(interfaces::Node& node, const QString& address, const CAmount& amount);
87
88    // HTML escaping for rich text controls
89    QString HtmlEscape(const QString& str, bool fMultiLine=false);
90    QString HtmlEscape(const std::string& str, bool fMultiLine=false);
91
92    /** Copy a field of the currently selected entry of a view to the clipboard. Does nothing if nothing
93        is selected.
94       @param[in] column  Data column to extract from the model
95       @param[in] role    Data role to extract from the model
96       @see  TransactionView::copyLabel, TransactionView::copyAmount, TransactionView::copyAddress
97     */
98    void copyEntryData(const QAbstractItemView *view, int column, int role=Qt::EditRole);
99
100    /** Return a field of the currently selected entry as a QString. Does nothing if nothing
101        is selected.
102       @param[in] column  Data column to extract from the model
103       @see  TransactionView::copyLabel, TransactionView::copyAmount, TransactionView::copyAddress
104     */
105    QList<QModelIndex> getEntryData(const QAbstractItemView *view, int column);
106
107    /** Returns true if the specified field of the currently selected view entry is not empty.
108       @param[in] column  Data column to extract from the model
109       @param[in] role    Data role to extract from the model
110       @see  TransactionView::contextualMenu
111     */
112    bool hasEntryData(const QAbstractItemView *view, int column, int role);
113
114    void setClipboard(const QString& str);
115
116    /**
117     * Loads the font from the file specified by file_name, aborts if it fails.
118     */
119    void LoadFont(const QString& file_name);
120
121    /**
122     * Determine default data directory for operating system.
123     */
124    QString getDefaultDataDirectory();
125
126    /**
127     * Extract first suffix from filter pattern "Description (*.foo)" or "Description (*.foo *.bar ...).
128     *
129     * @param[in] filter Filter specification such as "Comma Separated Files (*.csv)"
130     * @return QString
131     */
132    QString ExtractFirstSuffixFromFilter(const QString& filter);
133
134    /** Get save filename, mimics QFileDialog::getSaveFileName, except that it appends a default suffix
135        when no suffix is provided by the user.
136
137      @param[in] parent  Parent window (or 0)
138      @param[in] caption Window caption (or empty, for default)
139      @param[in] dir     Starting directory (or empty, to default to documents directory)
140      @param[in] filter  Filter specification such as "Comma Separated Files (*.csv)"
141      @param[out] selectedSuffixOut  Pointer to return the suffix (file type) that was selected (or 0).
142                  Can be useful when choosing the save file format based on suffix.
143     */
144    QString getSaveFileName(QWidget *parent, const QString &caption, const QString &dir,
145        const QString &filter,
146        QString *selectedSuffixOut);
147
148    /** Get open filename, convenience wrapper for QFileDialog::getOpenFileName.
149
150      @param[in] parent  Parent window (or 0)
151      @param[in] caption Window caption (or empty, for default)
152      @param[in] dir     Starting directory (or empty, to default to documents directory)
153      @param[in] filter  Filter specification such as "Comma Separated Files (*.csv)"
154      @param[out] selectedSuffixOut  Pointer to return the suffix (file type) that was selected (or 0).
155                  Can be useful when choosing the save file format based on suffix.
156     */
157    QString getOpenFileName(QWidget *parent, const QString &caption, const QString &dir,
158        const QString &filter,
159        QString *selectedSuffixOut);
160
161    /** Get connection type to call object slot in GUI thread with invokeMethod. The call will be blocking.
162
163       @returns If called from the GUI thread, return a Qt::DirectConnection.
164                If called from another thread, return a Qt::BlockingQueuedConnection.
165    */
166    Qt::ConnectionType blockingGUIThreadConnection();
167
168    // Determine whether a widget is hidden behind other windows
169    bool isObscured(QWidget *w);
170
171    // Activate, show and raise the widget
172    void bringToFront(QWidget* w);
173
174    // Set shortcut to close window
175    void handleCloseWindowShortcut(QWidget* w);
176
177    // Open debug.log
178    void openDebugLogfile();
179
180    // Open the config file
181    bool openBitcoinConf();
182
183    /** Qt event filter that intercepts ToolTipChange events, and replaces the tooltip with a rich text
184      representation if needed. This assures that Qt can word-wrap long tooltip messages.
185      Tooltips longer than the provided size threshold (in characters) are wrapped.
186     */
187    class ToolTipToRichTextFilter : public QObject
188    {
189        Q_OBJECT
190
191    public:
192        explicit ToolTipToRichTextFilter(int size_threshold, QObject *parent = nullptr);
193
194    protected:
195        bool eventFilter(QObject *obj, QEvent *evt) override;
196
197    private:
198        int size_threshold;
199    };
200
201    /**
202     * Qt event filter that intercepts QEvent::FocusOut events for QLabel objects, and
203     * resets their `textInteractionFlags' property to get rid of the visible cursor.
204     *
205     * This is a temporary fix of QTBUG-59514.
206     */
207    class LabelOutOfFocusEventFilter : public QObject
208    {
209        Q_OBJECT
210
211    public:
212        explicit LabelOutOfFocusEventFilter(QObject* parent);
213        bool eventFilter(QObject* watched, QEvent* event) override;
214    };
215
216    bool GetStartOnSystemStartup();
217    bool SetStartOnSystemStartup(bool fAutoStart);
218
219    /** Convert QString to OS specific boost path through UTF-8 */
220    fs::path QStringToPath(const QString &path);
221
222    /** Convert OS specific boost path to QString through UTF-8 */
223    QString PathToQString(const fs::path &path);
224
225    /** Convert enum Network to QString */
226    QString NetworkToQString(Network net);
227
228    /** Convert enum ConnectionType to QString */
229    QString ConnectionTypeToQString(ConnectionType conn_type, bool prepend_direction);
230
231    /// Convert a duration into a QString with days, hours, mins, secs. This ignores sub-seconds.
232    QString formatDurationStr(std::chrono::nanoseconds dur);
233
234    /** Convert peer connection time to a QString denominated in the most relevant unit. */
235    QString FormatPeerAge(NodeClock::time_point connected);
236
237    /** Format CNodeStats.nServices bitmask into a user-readable string */
238    QString formatServicesStr(quint64 mask);
239
240    /// Format a CNodeStats.m_last_ping_time/m_min_ping_time/m_ping_wait into a user-readable string if it exists, or display N/A
241    QString formatPingTime(NodeClock::duration ping_time);
242
243    /** Format a CNodeStateStats.time_offset into a user-readable string */
244    QString formatTimeOffset(int64_t time_offset);
245
246    QString formatNiceTimeOffset(qint64 secs);
247
248    QString formatBytes(uint64_t bytes);
249
250    qreal calculateIdealFontSize(int width, const QString& text, QFont font, qreal minPointSize = 4, qreal startPointSize = 14);

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

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.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.