Forbid implicit bools for cvar ctor args #1632
Open
Conversation
This file contains hidden or 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
Require the bMin and bMax values of ConVar constructors to be evaluated from boolean values, to prevent bugs with typo'd argument order where an incorrect argument would silently get evaluated as the boolean value without raising a compiler error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Require the
bMinandbMaxvalues ofConVarconstructors be evaluated from boolean types, to prevent bugs with typo'd argument order where an incorrect argument would silently get evaluated as the boolean value, and/or be swapped with the intended float min/max bound, without raising a compiler error.For example, for the
ConVarctor arguments:bool bMin, float fMin, bool bMax, float fMaxone could accidentally write:
100, true, 2000, truewhich would implictly get converted to:
bMin=bool(100)=true, fMin=float(true)=1, bMax=bool(2000)=true, fMax=float(true)=1instead of the intended:
bMin=true, fMin=100, bMax=true, fMax=2000.By introducing specialized deleted constructors for non-boolean inputs to the
bMin/bMaxandbCompMin/bCompMaxargs, we can cause the compiler to error in such cases to catch these bugs.In the rare case where the programmer really meant to evaluate a non-boolean type for these args, they can still explicitly cast it to bool to express that intent, and make it work.
Toolchain
Linked Issues