Fix ODR violation for plFactory and avoid including it everywhere
#1452
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
It was only used by two plCreatable methods: Create and HasDerivedClass. Both of them are completely unused and trivial to replace. plClassName::Create() can always be replaced by new plClassName() (avoiding plFactory entirely) and plClassName::HasDerivedClass(hDer) can be replaced by plFactory::DerivesFrom(plClassName::Index(), hDer). This allows removing the plFactory.h include from plCreatable.h - most users of plCreatable don't need plFactory.
Now that plFactory.h is no longer included *everywhere* via plCreatable.h, this is less of an issue. This fixes a violation of the One Definition Rule, which e. g. GCC warned about (although in practice it didn't cause any issues).
dpogue
approved these changes
Aug 8, 2023
Hoikas
approved these changes
Aug 8, 2023
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.
Touching the core plCreatable headers, part two.
The private members of
plFactorywere only conditionally defined in plFactory.h, which is an ODR violation and gives warnings with GCC for example (although apparently it has never caused any issues in practice). I'm not sure why it was done that way (perhaps to reduce header pollution very slightly?), but it seems safe to define everything unconditionally.Regardless, to avoid pulling in
plFactoryin many places where it's not needed, I also adjusted plCreatable.h to not automatically include plFactory.h anymore. This required removing a couple ofplCreatablemethods, but they weren't used anywhere and are trivial to replace.