bitcoin/src/qt
Hennadii Stepanov 88e5a02b8b
Merge bitcoin-core/gui#751: macOS, do not process actions during shutdown
bae209e387 gui: macOS, make appMenuBar part of the main app window (furszy)
e14cc8fc69 gui: macOS, do not process dock icon actions during shutdown (furszy)

Pull request description:

  As the 'QMenuBar' is created without a parent window in MacOS, the app crashes when the user presses the shutdown button and, right after it, triggers any action in the menu bar.

  This happens because the QMenuBar is manually deleted in the BitcoinGUI destructor but the events attached to it children actions are not disconnected, so QActions events such us the 'QMenu::aboutToShow' could try to access null pointers.

  Instead of guarding every single QAction pointer inside the QMenu::aboutToShow slot, or manually disconnecting all registered events in the destructor, we can check if a shutdown was requested and discard the event.

  The 'node' field is a ref whose memory is held by the main application class, so it is safe to use here. Events are disconnected prior destructing the main application object.

  Furthermore, the 'MacDockIconHandler::dockIconClicked' signal can make the app crash during shutdown for the very same reason. The 'show()' call triggers the 'QApplication::focusWindowChanged' event, which is connected to the 'minimize_action' QAction, which is also part of the app menu bar, which could no longer exist.

  Another cause of crashes stems from the shortcuts provided by the `appMenuBar` submenus during shutdown. For instance, executing actions like opening the information dialog (command + I) or the console dialog (command + T) lead to access null pointers. The second commit addresses and resolves these issues.
  Basically, in the present setup, we create a parentless `appMenuBar` whose submenus `QActions` are connected to `qApp` events (the app's global instance). However, at the `BitcoinGUI` destructor, we manually destruct this object without properly disconnecting the events. This leaves `qApp` events, such as `focusWindowChanged`, tied to submenus' `QAction` pointers, which causes the application to crash when it attempts to access them.

  Important Note:
  This happened to me few times. The worst consequence was an inconsistent chain state during IBD. Which triggered a full "replay blocks" process on the next startup. Which was painfully slow.

ACKs for top commit:
  RandyMcMillan:
    utACK bae209e
  hebasto:
    ACK bae209e387.

Tree-SHA512: 432e19c5f7e02c3165b7e7bd7f96f2a902bae5b5e439c2594db1c69d74ab6e0d4509d90f02db8c076f616e567e6a07492ede416ef651b5f749637398291b92fd
2023-10-03 13:56:41 +01:00
..
android qt: Drop no longer supported Android architecture 2022-06-04 11:42:26 +02:00
forms Merge bitcoin-core/gui#719: Remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-04 16:03:30 +01:00
locale qt: Update translation source file 2023-09-01 08:08:36 +01:00
res scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
test Rename script/standard.{cpp/h} to script/solver.{cpp/h} 2023-08-14 17:39:49 -04:00
addressbookpage.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
addressbookpage.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
addresstablemodel.cpp build: Bump minimum supported GCC to g++-9 2023-05-18 12:24:40 +02:00
addresstablemodel.h wallet: Replace use of purpose strings with an enum 2023-04-11 15:55:31 -04:00
askpassphrasedialog.cpp gui: Optionally return passphrase after unlocking 2023-06-23 14:24:31 -04:00
askpassphrasedialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
bantablemodel.cpp gui: fix comments for BanTableModel and BanTablePriv::refreshBanlist() 2023-03-06 16:07:08 +01:00
bantablemodel.h gui: fix comments for BanTableModel and BanTablePriv::refreshBanlist() 2023-03-06 16:07:08 +01:00
bitcoin.cpp gui: make '-min' minimize wallet loading dialog 2023-08-13 20:38:07 -03:00
bitcoin.h gui: return EXIT_FAILURE on post-init fatal errors 2023-06-10 11:10:29 -03:00
bitcoin.qrc gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
bitcoin_locale.qrc qt: Translation updates from Transifex 2023-09-01 07:39:00 +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#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
bitcoinamountfield.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
bitcoingui.cpp Merge bitcoin-core/gui#751: macOS, do not process actions during shutdown 2023-10-03 13:56:41 +01:00
bitcoingui.h Merge bitcoin-core/gui#738: Add menu option to migrate a wallet 2023-09-20 22:32:31 +01:00
bitcoinstrings.cpp qt: Update translation source file 2023-09-01 08:08:36 +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 refactor: Move system from util to common library 2023-05-20 12:08:13 +02:00
clientmodel.h Remove reindex special case from the progress bar label 2023-02-07 11:02:01 +01:00
coincontroldialog.cpp Merge bitcoin-core/gui#719: Remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-04 16:03:30 +01:00
coincontroldialog.h qt: remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-03 18:06:48 +02:00
coincontroltreewidget.cpp
coincontroltreewidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
createwalletdialog.cpp gui: Disable and uncheck blank when private keys are disabled 2023-06-23 13:40:41 -04:00
createwalletdialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
csvmodelwriter.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
csvmodelwriter.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
editaddressdialog.cpp wallet: Replace use of purpose strings with an enum 2023-04-11 15:55:31 -04:00
editaddressdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
guiconstants.h scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
guiutil.cpp Clean up things that include script/standard.h 2023-08-14 17:38:27 -04:00
guiutil.h refactor: Move fs.* to util/fs.* 2023-03-23 12:55:18 +01:00
initexecutor.cpp refactor: Extract util/exception from util/system 2023-03-13 17:09:47 +01:00
initexecutor.h qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
intro.cpp refactor: Replace string chain name constants with ChainTypes 2023-05-09 15:49:14 +02:00
intro.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
macdockiconhandler.h
macdockiconhandler.mm
macnotificationhandler.h
macnotificationhandler.mm
macos_appnap.h
macos_appnap.mm
main.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
Makefile Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
modaloverlay.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
modaloverlay.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
networkstyle.cpp scripted-diff: Remove unused chainparamsbase includes 2023-05-09 15:49:19 +02:00
networkstyle.h refactor: Replace string chain name constants with ChainTypes 2023-05-09 15:49:14 +02:00
notificator.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
notificator.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
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#26261: p2p: cleanup LookupIntern, Lookup and LookupHost 2023-05-30 11:39:59 -04:00
optionsdialog.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
optionsmodel.cpp scripted-diff: move settings to common namespace 2023-05-30 17:26:51 +02:00
optionsmodel.h Merge bitcoin/bitcoin#26889: refactor: wallet, remove global 'ArgsManager' dependency 2023-02-17 12:47:52 -05:00
overviewpage.cpp Merge bitcoin-core/gui#701: Persist Mask Values option 2023-02-09 20:11:11 +00:00
overviewpage.h Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
paymentserver.cpp move-only: Extract common/args and common/config.cpp from util/system 2023-04-19 10:48:30 +02:00
paymentserver.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
peertablemodel.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
peertablemodel.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
peertablesortproxy.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
peertablesortproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.cpp clang-tidy: Add performance-no-automatic-move check 2022-12-27 15:25:51 +00:00
platformstyle.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
psbtoperationsdialog.cpp qt: show own outputs on PSBT signing window 2023-06-21 02:48:55 -03:00
psbtoperationsdialog.h [gui] PSBT Operations Dialog (sign & broadcast) 2020-06-19 02:20:04 -07:00
qrimagewidget.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qrimagewidget.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qvalidatedlineedit.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
qvalidatedlineedit.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
qvaluecombobox.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qvaluecombobox.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
README.md Improve gui/src/qt README.md 2021-01-28 14:03:21 -05:00
receivecoinsdialog.cpp GUI: Support translating address type dropdown entries 2023-03-31 12:21:11 +01:00
receivecoinsdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
receiverequestdialog.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
receiverequestdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
recentrequeststablemodel.cpp Use DataStream where possible 2023-01-26 10:44:05 +01:00
recentrequeststablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
rpcconsole.cpp Merge bitcoin-core/gui#696: Switch RPCConsole wallet selection to the one most recently opened/restored/created 2023-07-04 16:45:54 +01:00
rpcconsole.h Fix RPCConsole wallet selection 2023-07-03 12:07:30 -04:00
sendcoinsdialog.cpp Merge bitcoin-core/gui#719: Remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-04 16:03:30 +01:00
sendcoinsdialog.h Merge bitcoin-core/gui#719: Remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-04 16:03:30 +01:00
sendcoinsentry.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
sendcoinsentry.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
sendcoinsrecipient.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
signverifymessagedialog.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
signverifymessagedialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
splashscreen.cpp refactor: Move system from util to common library 2023-05-20 12:08:13 +02:00
splashscreen.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
trafficgraphwidget.cpp clang-tidy: Add performance-type-promotion-in-math-fn check 2023-03-26 20:18:03 +01:00
trafficgraphwidget.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
transactiondesc.cpp refactor: Fix logging.h includes 2023-08-05 10:42:56 +02:00
transactiondesc.h scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactiondescdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactiondescdialog.h
transactionfilterproxy.cpp Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
transactionfilterproxy.h Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
transactionoverviewwidget.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactionoverviewwidget.h scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactionrecord.cpp Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactionrecord.h Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactiontablemodel.cpp Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactiontablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
transactionview.cpp Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactionview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
utilitydialog.cpp move-only: Extract common/args and common/config.cpp from util/system 2023-04-19 10:48:30 +02:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp Merge bitcoin-core/gui#738: Add menu option to migrate a wallet 2023-09-20 22:32:31 +01:00
walletcontroller.h Merge bitcoin-core/gui#738: Add menu option to migrate a wallet 2023-09-20 22:32:31 +01:00
walletframe.cpp refactor: Move fs.* to util/fs.* 2023-03-23 12:55:18 +01:00
walletframe.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodel.cpp Merge bitcoin/bitcoin#27419: move-only: Extract common/args from util/system 2023-04-21 11:19:08 +01:00
walletmodel.h Clean up things that include script/standard.h 2023-08-14 17:38:27 -04:00
walletmodeltransaction.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
walletmodeltransaction.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
walletview.cpp qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
walletview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
winshutdownmonitor.cpp qt: Silence -Wcast-function-type warning 2023-09-11 16:30:58 +01:00
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