9f85e9cb3d scripted-diff: Rename LockAnnotation to LockAssertion (practicalswift)
de9b5dbca3 Make sure the compile-time locking promises given via LockAnnotation:s hold also in practice at runtime (ifdef DEBUG_LOCKORDER) (practicalswift)
3a809446b3 Move LockAnnotation to make it reflect the truth (practicalswift)
cc2588579c Move LockAnnotation from threadsafety.h (imported code) to sync.h (our code) (practicalswift)
Pull request description:
`LockAnnotation lock(mutex);` is a guarantee to the compiler thread-analysis that `mutex` is locked (when it couldn't be determined otherwise).
Before this PR it was possible to make the mistake of adding a `LockAnnotation` where the correct mutex is _not_ held. This in turn makes the thread-analysis reasoning being based on incorrect premises.
This PR adds an assertion in the `LockAnnotation` ctor which checks that the guarantees given by us at compile-time are held also in practice (`ifdef DEBUG_LOCKORDER`).
Issues like the one described in #16028 will be discovered immediately with this PR merged.
Changes in this PR:
* Move `LockAnnotation` from `threadsafety.h` (imported code) to `sync.h` (our code)
* Move `LockAnnotation` in `wallet_tests` to make it reflect the truth
* Make sure the compile-time locking promises given via `LockAnnotation`:s hold also in practice at runtime (`ifdef DEBUG_LOCKORDER`)
* Rename `LockAnnotation` to `LockAssertion`
ACKs for commit 9f85e9:
ryanofsky:
utACK 9f85e9cb3d. No changes at all since last review except clean rebase after base PR #16033 was merged
Tree-SHA512: fb80e78fe362adfd6ea8405bcb142c09b99f834fe8be4397282b223ca2c3a2bb9719a074a47a043b44757f840b239a6fcd2f98d14771f8729204834ecf608c3a
Contains Designer UI files. They are created with Qt Creator, but can be edited using any text editor.
locale
Contains translations. They are periodically updated. The process is described here.
res
Resources such as the icon.
test
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)
Used to process BIP21 and BIP70 (see https://github.com/bitcoin/bitcoin/pull/11622) 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. Specifically for Qt:
don't change local/bitcoin_en.ts; this happens automatically
Using Qt Creator as IDE
You can use Qt Creator as an IDE. This is especially useful if you want to change
the UI layout.
Download and install the community edition of Qt Creator.
Uncheck everything except Qt Creator during the installation process.
65c4bbe629