Macros: Rebuild with a completely different architecture #1094
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
Instead of the `Macros` plugin reading from progmem unconditionally, allow one to override a function (similar to how we can override `Layer.getKey()`), and use that function to read macro data. This allows `DynamicMacros` to re-use most of `Macros`, and not reimplement all of it. The only remaining duplication is `updateDynamicMacroCache()`, which walks the storage to build a macro index->offset map, and as such, needs to be able to parse macros. Signed-off-by: Gergely Nagy <[email protected]>
algernon
added
enhancement
algernon
added
plugin
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.
This is the work in progress pull request aiming to implement the architecture envisioned in #1093.
At the moment, it doesn't accomplish it yet, but goes a long way by reworking
Macros.play()to be reusable byDynamicMacros. We do this in a similar way we allowEEPROM-Keymapto override keys, viaLayer.getKey(): we makeMacros.readMacroByte()a function that other plugins can override. As such,Macros.play()will read byte by byte from wherever we fancy, and play the macro. This lets us remove a large part of the duplication currently inDynamicMacros.We're not where #1093 wants to go yet, though. We need the
onMacroStep()event, which will require further changes. And there remains the problem ofDynamicMacros.updateDynamicMacroCache()which has to parse macros, but not play them. Those will be addressed in future updates to this draft PR.