phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-11 20:32:35 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions
bitcoin/src/qt
History
W. J. van der Laan 1884ce2f4c
Merge bitcoin/bitcoin#22937: refactor: Forbid calling unsafe fs::path(std::string) constructor and fs::path::string() method 
6544ea5035 refactor: Block unsafe fs::path std::string conversion calls (Russell Yanofsky)
b39a477ec6 refactor: Add fs::PathToString, fs::PathFromString, u8string, u8path functions (Russell Yanofsky)

Pull request description:

  The `fs::path` class has a `std::string` constructor which will implicitly convert from strings. Implicit conversions like this are not great in general because they can hide complexity and inefficiencies in the code, but this case is especially bad, because after the transition from `boost::filesystem` to `std::filesystem` in #20744 the behavior of this constructor on windows will be more complicated and can mangle path strings. The `fs::path` class also has a `.string()` method which is inverse of the constructor and has the same problems.

  Fix this by replacing the unsafe method calls with `PathToString` and `PathFromString` function calls, and by forbidding unsafe method calls in the future.

ACKs for top commit:
  kiminuo:
    ACK 6544ea5035
  laanwj:
    Code review ACK 6544ea5035
  hebasto:
    re-ACK 6544ea5035, only added `fsbridge_stem` test case, updated comment, and rebased since my [previous](https://github.com/bitcoin/bitcoin/pull/22937#pullrequestreview-765503126) review. Verified with the following command:

Tree-SHA512: c36324740eb4ee55151146626166c00d5ccc4b6f3df777e75c112bcb4d1db436c1d9cc8c29a1e7fb96051457d317961ab42e6c380c3be2771d135771b2b49fa0
2021-10-15 10:01:56 +02:00
..
android Add src/qt/android/.gitignore 2021-05-26 23:29:19 +03:00
forms Merge bitcoin-core/gui#430: Improvements to the open up transaction in third-party link action 2021-09-29 13:18:26 +03:00
locale qt: Handle new added plurals in bitcoin_en.ts 2021-08-22 00:03:31 +03:00
res gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
test qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
addressbookpage.cpp Merge bitcoin-core/gui#336: Do not exit and re-enter main event loop during shutdown 2021-09-30 11:35:15 +02:00
addressbookpage.h qt, refactor: Make AddressBookPage::deleteAction a local variable 2021-04-14 18:47:30 +03:00
addresstablemodel.cpp qt, refactor: Use enum type as switch argument in AddressTableModel 2021-02-22 09:34:17 +02:00
addresstablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
askpassphrasedialog.cpp Merge bitcoin-core/gui#85: Remove unused "What's This" button in dialogs on Windows OS 2021-01-28 10:16:55 +01:00
askpassphrasedialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bantablemodel.cpp qt, refactor: Use enum type as switch argument in BanTableModel 2021-02-22 09:34:27 +02:00
bantablemodel.h Fix addrdb includes 2021-09-07 10:44:48 +02:00
bitcoin.cpp qt: Add helper to load font 2021-10-07 17:01:21 +01:00
bitcoin.h Merge bitcoin-core/gui#336: Do not exit and re-enter main event loop during shutdown 2021-09-30 11:35:15 +02:00
bitcoin.qrc gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
bitcoin_locale.qrc qt: Pre-splitoff translations update 2020-10-27 19:40:44 +01: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 qt: Use template function qOverload in signal-slot connections 2021-04-30 00:00:44 +03:00
bitcoinamountfield.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
bitcoingui.cpp Merge bitcoin-core/gui#342: wallet: Move wallets loading out from the main GUI thread 2021-09-30 17:35:14 +03:00
bitcoingui.h Merge bitcoin/bitcoin#22951: consensus: move amount.h into consensus 2021-10-05 09:43:23 +02:00
bitcoinstrings.cpp Translations update 2021-07-01 17:16:14 +03:00
bitcoinunits.cpp [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
bitcoinunits.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
clientmodel.cpp refactor: replace QDateTime::fromTime_t with QDateTime::fromSecsSinceEpoch 2021-08-24 15:06:46 +08:00
clientmodel.h qt: Use PeerTableSortProxy for sorting peer table 2021-03-07 16:57:17 +02:00
coincontroldialog.cpp Include vout when copying transaction ID from coin selection 2021-09-29 11:16:59 +13:00
coincontroldialog.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08: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: ensure external signer option remains disabled without signers 2021-08-05 23:27:53 -04:00
createwalletdialog.h gui: ensure external signer option remains disabled without signers 2021-08-05 23:27:53 -04:00
csvmodelwriter.cpp Don't use zero as null pointer constant (-Wzero-as-null-pointer-constant) 2019-01-13 03:25:14 -08:00
csvmodelwriter.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
editaddressdialog.cpp Merge bitcoin-core/gui#85: Remove unused "What's This" button in dialogs on Windows OS 2021-01-28 10:16:55 +01:00
editaddressdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
guiconstants.h qt: update QT to support signet network 2020-09-18 09:37:57 +09:00
guiutil.cpp Merge bitcoin/bitcoin#22937: refactor: Forbid calling unsafe fs::path(std::string) constructor and fs::path::string() method 2021-10-15 10:01:56 +02:00
guiutil.h qt: Add helper to load font 2021-10-07 17:01:21 +01:00
initexecutor.cpp qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
initexecutor.h qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
intro.cpp refactor: Block unsafe fs::path std::string conversion calls 2021-10-05 11:10:47 -04:00
intro.h scripted-diff: Replace GetDataDir() calls with gArgs.GetDataDirNet() calls 2021-05-24 10:29:58 +02: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 2020-04-16 13:33:09 -04:00
Makefile Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
modaloverlay.cpp scripted-diff: Replace three dots with ellipsis in the UI strings 2021-05-02 22:17:16 +03:00
modaloverlay.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
networkstyle.cpp refactor: iterate arrays via C++11 range-based for loops if idx is not needed 2021-01-31 17:07:46 +01:00
networkstyle.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
notificator.cpp doc: Use https URLs where possible 2021-01-04 12:23:16 +08:00
notificator.h Remove misplaced Q_UNUSED and others enhancements 2018-12-20 01:06:37 +02:00
openuridialog.cpp scripted-diff: Remove unused "What's This" button in dialogs on Windows 2020-09-07 19:09:33 +03:00
openuridialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
optionsdialog.cpp Merge bitcoin-core/gui#336: Do not exit and re-enter main event loop during shutdown 2021-09-30 11:35:15 +02:00
optionsdialog.h qt: Do not exit and re-enter main event loop during shutdown 2021-09-29 17:01:49 +03:00
optionsmodel.cpp gui: add RPC setting 2021-09-16 11:17:31 +02:00
optionsmodel.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
overviewpage.cpp Merge bitcoin-core/gui#365: Draw "eye" sign at the beginning of watch-only addresses 2021-07-05 23:48:21 +03:00
overviewpage.h qt: Drop redundant OverviewPage::handleOutOfSyncWarningClicks slot 2021-06-06 01:04:15 +03:00
paymentserver.cpp scripted-diff: Replace GetDataDir(true) calls with gArgs.GetDataDirNet() calls 2021-05-24 10:29:58 +02:00
paymentserver.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
peertablemodel.cpp Remove GetAddrName 2021-08-26 10:44:26 +02:00
peertablemodel.h Merge bitcoin-core/gui#317: Add Direction column to Peers Tab 2021-08-11 16:55:36 +03:00
peertablesortproxy.cpp Remove GetAddrName 2021-08-26 10:44:26 +02:00
peertablesortproxy.h qt: Add peertablesortproxy module 2021-03-07 16:57:11 +02:00
platformstyle.cpp qt: Make PlatformStyle aware of runtime palette change 2021-05-01 15:07:02 +03:00
platformstyle.h qt: Make PlatformStyle aware of runtime palette change 2021-05-01 15:07:02 +03:00
psbtoperationsdialog.cpp GUI: Ask user to unlock wallet before signing psbt 2021-09-28 13:27:07 +13:00
psbtoperationsdialog.h [gui] PSBT Operations Dialog (sign & broadcast) 2020-06-19 02:20:04 -07:00
qrimagewidget.cpp qt: ensure translator comments end in full stop 2021-09-12 18:25:06 -04:00
qrimagewidget.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
qvalidatedlineedit.cpp Replace remaining 0 with nullptr in Qt code 2019-01-13 03:25:14 -08:00
qvalidatedlineedit.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
qvaluecombobox.cpp qt: Use template function qOverload in signal-slot connections 2021-04-30 00:00:44 +03:00
qvaluecombobox.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
README.md Improve gui/src/qt README.md 2021-01-28 14:03:21 -05:00
receivecoinsdialog.cpp GUI: Add keyboard shortcuts for other context menus 2021-06-12 19:39:38 +00:00
receivecoinsdialog.h qt: Disable requests context menu actions when appropriate 2021-02-23 11:38:22 -05:00
receiverequestdialog.cpp gui: misc external signer fixes and translation hints 2021-06-16 10:48:58 +02:00
receiverequestdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
recentrequeststablemodel.cpp refactor: replace QDateTime::toTime_t with QDateTime::toSecsSinceEpoch 2021-08-24 15:08:04 +08:00
recentrequeststablemodel.h refactor: replace QDateTime::toTime_t with QDateTime::toSecsSinceEpoch 2021-08-24 15:08:04 +08:00
rpcconsole.cpp RPCConsole: Throw when overflowing size_t type for array indices 2021-10-05 14:28:57 +02:00
rpcconsole.h qt: Save/restore column sizes of the tables in the Peers tab 2021-06-05 13:36:53 +03:00
sendcoinsdialog.cpp Merge bitcoin-core/gui#336: Do not exit and re-enter main event loop during shutdown 2021-09-30 11:35:15 +02:00
sendcoinsdialog.h refactor, qt: Simplify SendCoinsDialog::updateCoinControlState 2021-04-18 21:12:57 +01:00
sendcoinsentry.cpp qt: Add SubFeeFromAmount option 2021-08-11 14:48:24 +05:30
sendcoinsentry.h qt: Make SendCoinsEntry aware of runtime palette change 2021-05-01 15:07:09 +03:00
sendcoinsrecipient.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
signverifymessagedialog.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
signverifymessagedialog.h qt: Make SignVerifyMessageDialog aware of runtime palette change 2021-05-01 15:07:09 +03:00
splashscreen.cpp Add include for std::bind. 2021-01-13 02:05:00 +01:00
splashscreen.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
trafficgraphwidget.cpp Fix wrong(1024) divisor for 1000-based prefixes 2021-03-19 19:35:42 +01:00
trafficgraphwidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
transactiondesc.cpp qt, build: Optimize string concatenation 2021-05-15 19:10:38 +03:00
transactiondesc.h Remove unused adjustedTime parameter 2018-10-28 09:04:10 +02:00
transactiondescdialog.cpp Merge bitcoin-core/gui#85: Remove unused "What's This" button in dialogs on Windows OS 2021-01-28 10:16:55 +01:00
transactiondescdialog.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
transactionfilterproxy.cpp refactor: replace QDateTime::fromTime_t with QDateTime::fromSecsSinceEpoch 2021-08-24 15:06:46 +08:00
transactionfilterproxy.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
transactionoverviewwidget.h qt: Add TransactionOverviewWidget class 2021-01-05 22:10:10 +02:00
transactionrecord.cpp Replace boost::variant with std::variant 2021-01-05 10:10:50 +01:00
transactionrecord.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
transactiontablemodel.cpp refactor: replace QDateTime::fromTime_t with QDateTime::fromSecsSinceEpoch 2021-08-24 15:06:46 +08:00
transactiontablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
transactionview.cpp Merge bitcoin-core/gui#336: Do not exit and re-enter main event loop during shutdown 2021-09-30 11:35:15 +02:00
transactionview.h qt: Make TransactionView aware of runtime palette change 2021-05-01 15:07:12 +03:00
utilitydialog.cpp scripted-diff: Replace three dots with ellipsis in the UI strings 2021-05-02 22:17:16 +03:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp qt: Fix WalletControllerActivity progress dialog title 2021-10-06 17:42:04 +05:30
walletcontroller.h qt: Fix WalletControllerActivity progress dialog title 2021-10-06 17:42:04 +05:30
walletframe.cpp Merge bitcoin-core/gui#336: Do not exit and re-enter main event loop during shutdown 2021-09-30 11:35:15 +02:00
walletframe.h qt, refactor: Replace WalletFrame::addWallet with WalletFrame::addView 2021-09-03 00:27:14 +03:00
walletmodel.cpp qt, refactor: Allocate SendConfirmationDialog instances on heap 2021-09-07 09:39:04 +03:00
walletmodel.h Merge bitcoin-core/gui#4: UI external signer support (e.g. hardware wallet) 2021-06-09 18:59:59 +12:00
walletmodeltransaction.cpp gui: send using external signer 2021-05-27 14:37:59 +02:00
walletmodeltransaction.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
walletview.cpp qt, refactor: Keep AskPassphraseDialog in the main event loop 2021-09-07 09:39:03 +03:00
walletview.h [MOVEONLY] consensus: move amount.h into consensus 2021-09-30 07:41:57 +08:00
winshutdownmonitor.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
winshutdownmonitor.h Fix Windows build with --enable-werror on Ubuntu Focal 2021-04-13 10:20:44 +03:00

README.md

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