GUI2: harden theme definition parsing #9974
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
- Ensure current_gui is a valid iterator after calling init(). It should match default_gui - Ensure current_gui is always set to guis.end() if the requested theme isn't found in switch_theme(). It's initialized as such in gui_definition.cpp, but we shouldn't rely on that always being the case, especially in a function that changes it. - Only create one schema validator for all themes. Previously, it would have been created anew for each addon with a custom theme. - Add explicit exception handling for an invalid schema path - Add explicit warning for addon themes with the id "default" - Catch `wml_exception` when creating gui_definition objects for core themes (previously, this was only caught for add-on themes) - Fix duplicate theme errors when reloading cache (addresses one part of #9781) - Use `_main.cfg` for core theme entry points - Include macros at global core GUI2 score instead of only in the default theme (they were always available to both themes, this just makes that clearer)
github-actions
bot
added
the
UI
|
Note that no other schema validator use is re-using an instance. I'm going to assume this was throughly tested. |
Vultraz
added a commit
that referenced
this pull request
Mar 5, 2025
Resolves #9973. Reworks #9974, since I misunderstood how schema validators worked. They are indeed stateful and you need one instance per read call. I also decided to do away with the global macro context because I do *not* want to have to deal with people claiming the core GUI2 macros constitute a public API (nor do we want macros from one addon affecting the themes in another in the unlikely event that multiple people make gui2 themes.)
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.
wml_exceptionwhen creating gui_definition objects for all themes (previously, this was only caught for add-on themes)_main.cfgfor core theme entry points