elements/src/qt
fanquake 45b2a91897
Merge bitcoin/bitcoin#29404: refactor: bitcoin-config.h includes cleanup
9d1dbbd4ce scripted-diff: Fix bitcoin_config_h includes (TheCharlatan)

Pull request description:

  As mentioned in https://github.com/bitcoin/bitcoin/pull/26924#issuecomment-1403449932 and https://github.com/bitcoin/bitcoin/pull/29263#issuecomment-1922334399, it is currently not safe to remove `bitcoin-config.h` includes from headers because some unrelated file might be depending on it.

  See also #26972 for discussion.

  Solve this by including the file directly everywhere it's required, regardless of whether or not it's already included by another header.

  There should be no functional change here, but it will allow us to safely remove includes from headers in the future.

  ~I'm afraid it's a bit tedious to reproduce these commits, but it's reasonably straightforward:~
  Edit: See note below

  ```bash
  # All commands executed from the src/ subdir.

  # Collect all tokens from bitcoin-config.h.in
  # Isolate the tokens and remove blank lines
  # Replace newlines with | and remove the last trailing one
  # Collect all files which use these tokens
  # Filter out subprojects (proper forwarding can be verified from Makefiles)
  # Filter out .rc files
  # Save to a text file
  git grep -E -l `grep undef config/bitcoin-config.h.in | cut -d" " -f2 | grep -v '^$' | tr '\n' '|' | sed 's/|$//'` | grep -v -e "^leveldb/" -e "^secp256k1/" -e "^crc32c/" -e "^minisketch/" -e "^Makefile" -e "\.rc$" > files-with-config-include.txt

  # Find all files from the above list which don't include bitcoin-config.h
  git grep -L -E "config/bitcoin-config.h" -- `cat files-with-config-include.txt`

  # Include them manually with the exception of some files in crypto:
  # crypto/sha256_arm_shani.cpp crypto/sha256_avx2.cpp crypto/sha256_sse41.cpp crypto/sha256_x86_shani.cpp
  # These are exceptions which don't use bitcoin-config.h, rather the Makefile.am adds these cppflags manually.

  # Commit changes. This should match the first commit of this PR.

  # Use the same search as above to find all files which DON'T use any config tokens
  git grep -E -L `grep undef config/bitcoin-config.h.in | cut -d" " -f2 | grep -v '^$' | tr '\n' '|' | sed 's/|$//'` | grep -v -e "^leveldb/" -e "^secp256k1/" -e "^crc32c/" -e "^minisketch/" -e "^Makefile" -e "\.rc$" > files-without-config-include.txt

  # Manually remove the includes and commit changes. This should match the second commit of this PR.
  ```

  Edit: I'll keep this old description for posterity, but the manual approach has been replaced with a scripted diff from TheCharlatan

ACKs for top commit:
  maflcko:
    ACK 9d1dbbd4ce 🚪
  TheCharlatan:
    ACK 9d1dbbd4ce
  hebasto:
    ACK 9d1dbbd4ce, I have reviewed the code and it looks OK.
  fanquake:
    ACK 9d1dbbd4ce

Tree-SHA512: f11ddc4ae6a887f96b954a6b77f310558ddb271088a3fda3edc833669c4251b7f392515224bbb8e5f67eb2c799b4ffed3b07d96454e82ec635c686d0df545872
2024-02-20 13:07:48 +00:00
..
android Adjust Gradle properties 2023-10-08 14:01:59 +01:00
forms Merge bitcoin-core/gui#497: Enable users to configure their monospace font specifically 2024-02-07 19:28:37 +00:00
locale qt: Update translation source file for v27.0 string freeze 2024-02-13 11:11:52 +00:00
res scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
test Merge bitcoin/bitcoin#29404: refactor: bitcoin-config.h includes cleanup 2024-02-20 13:07:48 +00:00
addressbookpage.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
addressbookpage.h gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
addresstablemodel.cpp gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
addresstablemodel.h gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
askpassphrasedialog.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00: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 refactor: Remove call to StartShutdown from qt 2023-12-04 15:39:15 -04: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 2024-02-07 09:23:42 +00:00
bitcoinaddressvalidator.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
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/bitcoin#29404: refactor: bitcoin-config.h includes cleanup 2024-02-20 13:07:48 +00:00
bitcoingui.h refactor: Remove call to StartShutdown from qt 2023-12-04 15:39:15 -04:00
bitcoinstrings.cpp qt: Update translation source file for v27.0 string freeze 2024-02-13 11:11:52 +00: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 scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
clientmodel.h Remove reindex special case from the progress bar label 2023-02-07 11:02:01 +01:00
coincontroldialog.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
coincontroldialog.h qt: remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-03 18:06:48 +02:00
coincontroltreewidget.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
coincontroltreewidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
createwalletdialog.cpp gui: remove legacy wallet creation 2023-10-06 17:20:54 -03:00
createwalletdialog.h gui: remove legacy wallet creation 2023-10-06 17:20:54 -03: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 Merge bitcoin-core/gui#553: Change address / amount error background 2024-02-07 18:03:11 +00:00
guiutil.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00: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 Merge bitcoin-core/gui#658: Intro: Never change the prune checkbox after the user has touched it 2024-02-12 12:08:46 +00:00
intro.h GUI/Intro: Never change the prune checkbox after the user has touched it 2023-06-29 23:24:39 +00:00
macdockiconhandler.h Remove obj_c for macOS Dock icon menu 2018-11-04 02:42:18 +02:00
macdockiconhandler.mm qt: Replace objc_msgSend with native syntax 2019-08-31 12:25:34 +03:00
macnotificationhandler.h convert C-style (void) parameter lists to C++ style () 2018-09-13 10:36:41 -07:00
macnotificationhandler.mm scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
macos_appnap.h macOS: disable AppNap during sync 2018-11-01 18:22:06 +03:00
macos_appnap.mm macOS: disable AppNap during sync 2018-11-01 18:22:06 +03:00
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 scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +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 scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +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-core/gui#497: Enable users to configure their monospace font specifically 2024-02-07 19:28:37 +00: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 Merge bitcoin-core/gui#497: Enable users to configure their monospace font specifically 2024-02-07 19:28:37 +00:00
optionsmodel.h GUI: OptionsDialog: Replace verbose two-option font selector with simple combobox with Custom... choice 2023-07-21 17:47:17 +00:00
overviewpage.cpp GUI: Move "embedded font or not" decision into new OptionsModel::getFontForMoney method 2023-07-21 17:45:21 +00:00
overviewpage.h GUI: Move "embedded font or not" decision into new OptionsModel::getFontForMoney method 2023-07-21 17:45:21 +00:00
paymentserver.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
paymentserver.h scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +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 scripted-diff: Use DataStream in most places 2023-11-28 12:42:37 +01:00
psbtoperationsdialog.h qt, refactor: Drop superfluous type conversions 2023-10-23 15:06:29 +01: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#758: Update Node window title with the chain type 2024-02-12 13:08:28 +00:00
rpcconsole.h gui: Update Node window title with chain type 2023-09-18 00:46:09 -03:00
sendcoinsdialog.cpp qt, test: Recognize dialog object by name 2024-02-19 13:53:47 +00: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 scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +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: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00: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 scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00: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 scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
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 doc: fix typos 2023-11-07 10:21:51 +09:00
transactiontablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
transactionview.cpp gui: fix crash on selecting "Mask values" in transaction view 2023-10-31 00:27:26 +01:00
transactionview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
utilitydialog.cpp Modify command line help to show support for BIP21 URIs 2024-02-01 00:57:14 -03:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp qt: Avoid error prone leading spaces in translatable strings 2023-10-23 15:06:42 +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#29404: refactor: bitcoin-config.h includes cleanup 2024-02-20 13:07:48 +00:00
walletmodel.h scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
walletmodeltransaction.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +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 refactor: Remove call to StartShutdown from qt 2023-12-04 15:39:15 -04:00
winshutdownmonitor.h qt: Avoid non-self-contained Windows header 2024-01-25 10:26:26 +00: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