bitcoin/src/qt
laanwj 132d5f8c2f
Merge bitcoin/bitcoin#25001: Modernize util/strencodings and util/string: string_view and optional
fa7078d84f scripted-diff: Rename ValidAsCString to ContainsNoNUL (MacroFake)
e7d2fbda63 Use std::string_view throughout util strencodings/string (Pieter Wuille)
8ffbd1412d Make DecodeBase{32,64} take string_view arguments (Pieter Wuille)
1a72d62152 Generalize ConvertBits to permit transforming the input (Pieter Wuille)
78f3ac51b7 Make DecodeBase{32,64} return optional instead of taking bool* (Pieter Wuille)
a65931e3ce Make DecodeBase{32,64} always return vector, not string (Pieter Wuille)
a4377a0843 Reject incorrect base64 in HTTP auth (Pieter Wuille)
d648b5120b Make SanitizeString use string_view (Pieter Wuille)
963bc9b576 Make IsHexNumber use string_view (Pieter Wuille)
40062997f2 Make IsHex use string_view (Pieter Wuille)
c1d165a8c2 Make ParseHex use string_view (Pieter Wuille)

Pull request description:

  Make use of `std::string_view` and `std::optional` in the util/{strencodings, string} files.

  This avoids many temporary string/vector objects being created, while making the interface easier to read. Changes include:
  * Make all input arguments in functions in util/strencodings and util/string take `std::string_view` instead of `std::string`.
  * Add `RemovePrefixView` and `TrimStringView` which also *return* `std::string_view` objects (the corresponding `RemovePrefix` and `TrimString` keep returning an `std::string`, as that's needed in many call sites still).
  * Stop returning `std::string` from `DecodeBase32` and `DecodeBase64`, but return vectors. Base32/64 are fundamentally algorithms for encoding bytes as strings; returning `std::string` from those (especially doing it conditionally based on the input arguments/types) is just bizarre.
  * Stop taking a `bool* pf_invalid` output argument pointer in `DecodeBase32` and `DecodeBase64`; return an `std::optional` instead.
  * Make `DecodeBase32` and `DecodeBase64` more efficient by doing the conversion from characters to integer symbols on-the-fly rather than through a temporary vector.

ACKs for top commit:
  MarcoFalke:
    re-ACK fa7078d84f only change is rebase and adding a scripted-diff 🍲
  martinus:
    Code review ACK fa7078d84f, found no issue
  laanwj:
    Code review ACK  fa7078d84f
  sipa:
    utACK fa7078d84f (as far as the commit that isn't mine goes)

Tree-SHA512: 5cf02e541caef0bcd100466747664bdb828a68a05dae568cbcd0632a53dd3a4c4e85cd8c48ebbd168d4247d5c9666689c16005f1c8ad75b0f057d8683931f664
2022-04-27 17:18:54 +02:00
..
android build, qt: No need to set inapplicable QPA backend for Android 2022-01-03 14:45:39 +02:00
forms gui: improve "Addresses Rate-Limited" translator comments and tooltip in peers tab 2022-03-06 17:49:20 +01:00
locale qt: Pre-branch translation updates for 23.x 2022-02-28 16:59:56 +01:00
res scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
test Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
addressbookpage.cpp scripted-diff: Rename ShowModalDialogAndDeleteOnClose 2022-02-12 23:00:45 +02:00
addressbookpage.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
addresstablemodel.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
addresstablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
askpassphrasedialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
askpassphrasedialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bantablemodel.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
bantablemodel.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
bitcoin.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
bitcoin.h qt: Override BitcoinApplication::event() to handle QEvent::Quit 2022-02-12 16:04:57 +02:00
bitcoin.qrc gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
bitcoin_locale.qrc qt: Pre-branch translation updates for 23.x 2022-02-28 16:59:56 +01:00
bitcoinaddressvalidator.cpp
bitcoinaddressvalidator.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bitcoinamountfield.cpp Merge bitcoin-core/gui#579: Getting ready to Qt 6 (2/n). Remove QApplication::globalStrut() 2022-04-15 12:00:53 +02:00
bitcoinamountfield.h qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
bitcoingui.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
bitcoingui.h Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
bitcoinstrings.cpp qt: English (source) translations update 2022-02-24 12:40:00 +01:00
bitcoinunits.cpp qt, refactor: Remove default cases for scoped enum 2022-02-22 13:50:30 -08:00
bitcoinunits.h qt, refactor: Remove BitcoinUnits::valid function 2022-02-22 13:50:30 -08:00
clientmodel.cpp Merge bitcoin/bitcoin#22834: net: respect -onlynet= when making outbound connections 2022-03-01 18:32:01 +01:00
clientmodel.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
coincontroldialog.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
coincontroldialog.h Add src/wallet/* code to wallet:: namespace 2022-01-06 22:14:16 -05:00
coincontroltreewidget.cpp
coincontroltreewidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
createwalletdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
createwalletdialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
csvmodelwriter.cpp
csvmodelwriter.h
editaddressdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
editaddressdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
guiconstants.h qt: Treat unconfirmed txs as unconfirmed 2022-01-14 11:24:58 +01:00
guiutil.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
guiutil.h Revert "qt: Add ObjectInvoke template function" 2022-04-16 19:18:54 +02:00
initexecutor.cpp qt: Replace GUIUtil::ObjectInvoke() with QMetaObject::invokeMethod() 2022-04-16 19:18:25 +02:00
initexecutor.h qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
intro.cpp Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2022-04-26 10:41:45 +01:00
intro.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
macdockiconhandler.h
macdockiconhandler.mm
macnotificationhandler.h
macnotificationhandler.mm
macos_appnap.h
macos_appnap.mm
main.cpp
Makefile Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
modaloverlay.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
modaloverlay.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
networkstyle.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
networkstyle.h
notificator.cpp qt: Do not assume qDBusRegisterMetaType return type 2022-04-13 20:44:23 +02:00
notificator.h
openuridialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
openuridialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
optionsdialog.cpp Merge bitcoin/bitcoin#22834: net: respect -onlynet= when making outbound connections 2022-03-01 18:32:01 +01:00
optionsdialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
optionsmodel.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
optionsmodel.h qt: Skip displayUnitChanged signal if unit is not actually changed 2022-02-22 13:50:30 -08:00
overviewpage.cpp qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
overviewpage.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
paymentserver.cpp qt: Remove network detection based on address in BIP21 2022-03-10 12:56:19 +01:00
paymentserver.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
peertablemodel.cpp Merge bitcoin-core/gui#543: peers-tab: add connection duration column to tableview 2022-04-13 01:11:55 +02:00
peertablemodel.h gui: add Age column to peers tab 2022-03-16 04:54:52 -04:00
peertablesortproxy.cpp gui: add Age column to peers tab 2022-03-16 04:54:52 -04:00
peertablesortproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
psbtoperationsdialog.cpp qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
psbtoperationsdialog.h [gui] PSBT Operations Dialog (sign & broadcast) 2020-06-19 02:20:04 -07:00
qrimagewidget.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
qrimagewidget.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
qvalidatedlineedit.cpp Merge bitcoin-core/gui#404: Fix various edge case bugs in QValidatedLineEdit 2022-02-09 06:23:44 +02:00
qvalidatedlineedit.h Merge bitcoin-core/gui#404: Fix various edge case bugs in QValidatedLineEdit 2022-02-09 06:23:44 +02:00
qvaluecombobox.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
qvaluecombobox.h
README.md Improve gui/src/qt README.md 2021-01-28 14:03:21 -05:00
receivecoinsdialog.cpp Merge bitcoin-core/gui#516: Change 'Show' icon 2022-01-04 12:55:29 +02:00
receivecoinsdialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
receiverequestdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
receiverequestdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
recentrequeststablemodel.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
recentrequeststablemodel.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
rpcconsole.cpp Do not pass WalletModel* to queued connection 2022-04-21 14:04:56 +02:00
rpcconsole.h Do not pass WalletModel* to queued connection 2022-04-21 14:04:56 +02:00
sendcoinsdialog.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
sendcoinsdialog.h gui: restore Send for external signer 2022-03-16 10:28:39 +01:00
sendcoinsentry.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
sendcoinsentry.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
sendcoinsrecipient.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
signverifymessagedialog.cpp doc: Convert remaining comments to clang-tidy format 2022-04-06 15:37:07 +02:00
signverifymessagedialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
splashscreen.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
splashscreen.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
trafficgraphwidget.cpp qt,refactor: Use std::chrono in TrafficGraphWidget class 2022-01-18 20:03:50 +05:30
trafficgraphwidget.h qt,refactor: Use std::chrono in TrafficGraphWidget class 2022-01-18 20:03:50 +05:30
transactiondesc.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
transactiondesc.h Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
transactiondescdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactiondescdialog.h
transactionfilterproxy.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactionfilterproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactionoverviewwidget.h qt: Add TransactionOverviewWidget class 2021-01-05 22:10:10 +02:00
transactionrecord.cpp qt: Treat unconfirmed txs as unconfirmed 2022-01-14 11:24:58 +01:00
transactionrecord.h qt, refactor: Use member initializers in TransactionStatus 2022-04-13 12:24:37 -03:00
transactiontablemodel.cpp Merge bitcoin-core/gui#556: refactor: Make BitcoinUnits::Unit a scoped enum 2022-04-15 11:51:22 +02:00
transactiontablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
transactionview.cpp qt: Avoid potential -Wdeprecated-enum-enum-conversion warning 2022-03-22 12:36:25 +01:00
transactionview.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
utilitydialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp qt: Replace GUIUtil::ObjectInvoke() with QMetaObject::invokeMethod() 2022-04-16 19:18:25 +02:00
walletcontroller.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletframe.cpp Make DecodeBase{32,64} return optional instead of taking bool* 2022-04-27 14:12:55 +02:00
walletframe.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodel.cpp Merge bitcoin/bitcoin#23497: Add src/node/ and src/wallet/ code to node:: and wallet:: namespaces 2022-01-11 11:11:00 +01:00
walletmodel.h Add src/wallet/* code to wallet:: namespace 2022-01-06 22:14:16 -05:00
walletmodeltransaction.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodeltransaction.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletview.cpp qt: Fix headers 2022-04-09 01:11:02 +02:00
walletview.h qt, refactor: Make BitcoinUnits::Unit a scoped enum 2022-02-22 13:50:30 -08:00
winshutdownmonitor.cpp
winshutdownmonitor.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00

This directory contains the source code for the Bitcoin Core graphical user interface (GUI). It uses the Qt cross-platform framework.

The current precise version for Qt 5 is specified in qt.mk.

Compile and run

See build instructions: Unix, macOS, Windows, FreeBSD, NetBSD, OpenBSD

When following your systems build instructions, make sure to install the Qt dependencies.

To run:

./src/qt/bitcoin-qt

Files and Directories

forms/

  • A directory that contains Designer UI files. These files specify the characteristics of form elements in XML. Qt UI files can be edited with Qt Creator or using any text editor.

locale/

  • Contains translations. They are periodically updated and an effort is made to support as many languages as possible. The process of contributing translations is described in doc/translation_process.md.

res/

  • Contains graphical resources used to enhance the UI experience.

test/

  • Functional tests used to ensure proper functionality of the GUI. Significant changes to the GUI code normally require new or updated tests.

bitcoingui.(h/cpp)

  • Represents the main window of the Bitcoin UI.

*model.(h/cpp)

  • The model. When it has a corresponding controller, it generally inherits from QAbstractTableModel. Models that are used by controllers as helpers inherit from other Qt classes like QValidator.
  • ClientModel is used by the main application bitcoingui and several models like peertablemodel.

*page.(h/cpp)

  • A controller. :NAMEpage.cpp generally includes :NAMEmodel.h and forms/:NAME.page.ui with a similar :NAME.

*dialog.(h/cpp)

  • Various dialogs, e.g. to open a URL. Inherit from QDialog.

paymentserver.(h/cpp)

  • (Deprecated) Used to process BIP21 payment URI requests. Also handles URI-based application switching (e.g. when following a bitcoin:... link from a browser).

walletview.(h/cpp)

  • Represents the view to a single wallet.

Other .h/cpp files

  • UI elements like BitcoinAmountField, which inherit from QWidget.
  • bitcoinstrings.cpp: automatically generated
  • bitcoinunits.(h/cpp): BTC / mBTC / etc. handling
  • callback.h
  • guiconstants.h: UI colors, app name, etc.
  • guiutil.h: several helper functions
  • macdockiconhandler.(h/mm): macOS dock icon handler
  • macnotificationhandler.(h/mm): display notifications in macOS

Contribute

See CONTRIBUTING.md for general guidelines.

Note: Do not change local/bitcoin_en.ts. It is updated automatically.

Using Qt Creator as an IDE

Qt Creator is a powerful tool which packages a UI designer tool (Qt Designer) and a C++ IDE into one application. This is especially useful if you want to change the UI layout.

Download Qt Creator

On Unix and macOS, Qt Creator can be installed through your package manager. Alternatively, you can download a binary from the Qt Website.

Note: If installing from a binary grabbed from the Qt Website: During the installation process, uncheck everything except for Qt Creator.

macOS
brew install qt-creator
Ubuntu & Debian
sudo apt-get install qtcreator

Setup Qt Creator

  1. Make sure you've installed all dependencies specified in your systems build instructions
  2. Follow the compile instructions for your system, run ./configure with the --enable-debug flag
  3. Start Qt Creator. At the start page, do: New -> Import Project -> Import Existing Project
  4. Enter bitcoin-qt as the Project Name and enter the absolute path to src/qt as Location
  5. Check over the file selection, you may need to select the forms directory (necessary if you intend to edit *.ui files)
  6. Confirm the Summary page
  7. In the Projects tab, select Manage Kits...

macOS

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "Clang (x86 64bit in /usr/bin)"
  • Under Debuggers: select "LLDB" as debugger (you might need to set the path to your LLDB installation)

Ubuntu & Debian

Note: Some of these options may already be set

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "GCC (x86 64bit in /usr/bin)"
  • Under Debuggers: select "GDB" as debugger
  1. While in the Projects tab, ensure that you have the bitcoin-qt executable specified under Run
  • If the executable is not specified: click "Choose...", navigate to src/qt, and select bitcoin-qt
  1. You're all set! Start developing, building, and debugging the Bitcoin Core GUI