refactor(developer): replace VERIFY_KEYBOARD_VERSION() calls with VerifyKeyboardVersion() 🌋
#12063
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…VerifyKeyboardVersion()` Remove the `VERIFY_KEYBOARD_VERSION()` and `VERIFY_KEYBOARD_VERSION_ret()` macros, and instead use `VerifyKeyboardVersion()`. The DRYing out of this function call pattern moved the return statement into a macro, which is an inappropriate way to reduce repetition, because (a) it is hard for devs to spot function exits, and (b) automated code analysis tools stumble on it. Also means that we uncover more clearly the return mismatches between `KMX_DWORD` and `KMX_BOOL` through the compiler source. Fixes: #12047
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
jahorton
approved these changes
Jul 30, 2024
Base automatically changed from
chore/developer/support-message-filename-kmcmplib
to
master
August 3, 2024 10:57
mcdurdin
deleted the
refactor/developer/12047-remove-VERIFY_KEYBOARD_VERSION
branch
|
Changes in this pull request will be available for download in Keyman version 18.0.81-alpha |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Remove the
VERIFY_KEYBOARD_VERSION()andVERIFY_KEYBOARD_VERSION_ret()macros, and instead useVerifyKeyboardVersion(). The DRYing out of this function call pattern moved the return statement into a macro, which is an inappropriate way to reduce repetition, because (a) it is hard for devs to spot function exits, and (b) automated code analysis tools stumble on it.Also means that we uncover more clearly the return mismatches between
KMX_DWORDandKMX_BOOLthrough the compiler source.I think this is the last PR in this chain, for now. See #12062 for further cleanup (waiting for other unit tests to be completed first).
Relates-to: #10866
Fixes: #12047
@keymanapp-test-bot skip