Improve macro handling of McBopomofoLM and expand test coverage #133
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
lukhnos
changed the title
lukhnos
changed the title
- Allow loading existing in-memory data. - Improve tests. - Disallow copying and moving. - Clearly state that MemoryMappedFile does not manage underlying file changes. - Clearly state that if an existing block of data is used for load() in PhraseReplacementMap or UserPhrasesLM, it is the caller's responsibility to ensure that the data outlives the LM object.
- Removes macro values not handled by the macro converter - Reformats and clarifies McBopomofoLM comments - Rearranges the order of member functions - Adds tests
lukhnos
force-pushed
the
dev/lm-test-coverage
branch
from
e89d074 to
1545e23
Compare
lukhnos
changed the title
zonble
approved these changes
Mar 15, 2024
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.
After this PR, every class in Engine/ will have a test.
Other than that, two notable changes:
MACRO@DATE_TODAY_SHORT) is not handled by the macro converter, we discard the unigram value. This actually implies that it's no longer critical to ensure macros are supported across the board (see Ensure macros in McBopomofo macOS and fcitx5-mcbopomofo are in sync #100), as macros not supported/implemented on one platform will simply not be shown asMACRO@FOOBARin the candidate list. @zonble FYI.I also used the opportunity to audit our mmap and
std::string_viewuses, and have clarified the mmap contract—we map a readable, shared page, butMemoryMappedFileclass itself does not track and won't be aware of file changes. Not that it would affect McBopomofo's existing behavior, but it's good to state the contract more explicitly.