fix #306551: make symbols accessible to plugins #6205
Merged
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
To avoid slow MuseScore start caused by creating enumeration wrappers on startup, This is mainly the issue for SymId enumeration because of a large number of its items.
29 tasks
This was referenced Dec 12, 2020
igorkorsukov
added a commit
to igorkorsukov/MuseScore
that referenced
this pull request
Feb 12, 2021
vpereverzev
pushed a commit
that referenced
this pull request
Feb 12, 2021
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.
Resolves: https://musescore.org/en/node/306551
Exposes
SymIdenumeration to plugins thus making possible handling symbols in plugins depending on their type. As mentioned in the issue,Symbolelements can already be accessed (and even be added to a score) by plugins.This PR employs the same technique as #6065 to expose enumeration to plugins while avoiding copying it between files. However
BEGIN_QT_REGISTERED_ENUMandEND_QT_REGISTERED_ENUMmacro definitions needed to be duplicated instyle.handsym.hasmoctool doesn't handle macros from included files (not sure whether it handles#includestatements at all). Also, sinceSymIdenumerators begin from lower case letters, in order to expose their values to QML adding a wrapper for this enumeration was also necessary.Since
SymIdcontains a lot of elements (about 2600) creating a wrapper caused a significant delay on MuseScore startup. In order to avoid this in the second commit I implemented lazy initialization of enumerations exposed to QML plugins framework. Now enumeration wrappers are created when they are actually used for the first time. Therefore first access within a session toSymIdenumeration still causes a significant delay, but it doesn't happen after that, and it doesn't cause any issues for anyone not using plugins accessingSymIdenumeration. This trade-off seems to be the best solution we can afford at the moment if exposingSymIdenumeration in the same way as other enumerations.