Fix name conflicts caused by the SystemParam and WorldQuery macros
#8012
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
joseph-gio
added
C-Bug
| /// | ||
| /// Note that the returned identifier can still conflict in niche cases, | ||
| /// such as if an identifier in `haystack` is hidden behind an un-expanded macro. | ||
| pub fn ensure_no_collision(value: Ident, haystack: TokenStream) -> Ident { |
There was a problem hiding this comment.
I love that this is reusable :D
alice-i-cecile
requested changes
Mar 14, 2023
james7132
requested changes
Mar 16, 2023
alice-i-cecile
approved these changes
Mar 16, 2023
james7132
approved these changes
Mar 22, 2023
james7132
added
the
S-Ready-For-Final-Review
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.
Objective
Fix #1727
Fix #8010
Meta types generated by the
SystemParamandWorldQueryderive macros can conflict with user-defined types if they happen to have the same name.Solution
In order to check if an identifier would conflict with user-defined types, we can just search the original
TokenStreampassed to the macro to see if it contains the identifier (since the meta types are defined in an anonymous scope, it's only possible for them to conflict with the struct definition itself). When generating an identifier for meta types, we can simply check if it would conflict, and then add additional characters to the name until it no longer conflicts with anything.The
WorldQuery"Item" and read-only structs are a part of a module's public API, and thus it is intended for them to conflict with user-defined types.