mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-05-18 09:54:08 +02:00
2b541eeb36
242b0ebb5cbtcsignals: use a single shared_ptr for liveness and callback (Cory Fields)b12f43a0a8signals: remove boost::signals2 from depends and vcpkg (Cory Fields)a4b1607983signals: remove boost::signals2 mentions in linters and docs (Cory Fields)375397ebd9signals: remove boost includes where possible (Cory Fields)091736a153signals: re-add forward-declares to interface headers (Cory Fields)9958f4fe49Revert "signals: Temporarily add boost headers to bitcoind and bitcoin-node builds" (Cory Fields)34eabd77a2signals: remove boost compatibility guards (Cory Fields)e60a0b9a22signals: Add a simplified boost-compatible implementation (Cory Fields)63c68e2a3fsignals: add signals tests (Cory Fields)edc2978058signals: use an alias for the boost::signals2 namespace (Cory Fields)9ade3929aasignals: remove forward-declare for signals (Cory Fields)037e58b57bsignals: use forwarding header for boost signals (Cory Fields)2150153f37signals: Temporarily add boost headers to bitcoind and bitcoin-node builds (Cory Fields)fd5e9d9904signals: Use a lambda to avoid connecting a signal to another signal (Cory Fields) Pull request description: This drops our dependency on `boost::signals2`, leaving `boost::multi_index` as the only remaining boost dependency for bitcoind. `boost::signals2` is a complex beast, but we only use a small portion of it. Namely: it's a way for multiple subscribers to connect to the same event, and the ability to later disconnect individual subscribers from that event. `btcsignals` adheres to the subset of the `boost::signals2` API that we currently use, and thus is a drop-in replacement. Rather than implementing a complex `slot` tracking class that we never used anyway (and which was much more useful in the days before std::function existed), callbacks are simply wrapped directly in `std::function`s. The new tests work with either `boost::signals2` or the new `btcsignals` implementation. Reviewers can verify functional equivalency by running the tests in the commit that introduces them against `boost::signals2`, then again with `btcsignals`. The majority of the commits in this PR are preparation and cleanup. Once `boost::signals2` is no longer needed, it is removed from depends. Additionally, a few CMake targets no longer need boost includes as they were previously only required for signals. I think this is actually pretty straightforward to review. I kept things simple, including keeping types unmovable/uncopyable where possible rather than trying to define those semantics. In doing so, the new implementation has even fewer type requirements than boost, which I believe is due to a boost bug. I've opened a PR upstream for that to attempt to maintain parity between the implementations. See individual commits for more details. Closes #26442. ACKs for top commit: fjahr: Code review ACK242b0ebb5cmaflcko: re-review ACK242b0ebb5c🎯 w0xlt: reACK242b0ebb5cTree-SHA512: 9a472afa4f655624fa44493774a63b57509ad30fb61bf1d89b6d0b52000cb9a1409a5b8d515a99c76e0b26b2437c30508206c29a7dd44ea96eb1979d572cd4d4
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 is specified in qt_details.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:
./build/bin/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
bitcoinguiand several models likepeertablemodel.
*page.(h/cpp)
- A controller.
:NAMEpage.cppgenerally includes:NAMEmodel.handforms/:NAME.page.uiwith 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 generatedbitcoinunits.(h/cpp): BTC / mBTC / etc. handlingcallback.hguiconstants.h: UI colors, app name, etc.guiutil.h: several helper functionsmacdockiconhandler.(h/mm): macOS dock icon handlermacnotificationhandler.(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
- Make sure you've installed all dependencies specified in your systems build instructions
- Follow the compile instructions for your system, adding the
-DCMAKE_BUILD_TYPE=Debugbuild flag - Start Qt Creator. At the start page, do:
New->Import Project->Import Existing Project - Enter
bitcoin-qtas the Project Name and enter the absolute path tosrc/qtas Location - Check over the file selection, you may need to select the
formsdirectory (necessary if you intend to edit *.ui files) - Confirm the
Summarypage - In the
Projectstab, selectManage 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
- While in the
Projectstab, ensure that you have thebitcoin-qtexecutable specified underRun
- If the executable is not specified: click
"Choose...", navigate tobuild/bin, and selectbitcoin-qt
- You're all set! Start developing, building, and debugging the Bitcoin Core GUI