WriteCharsLegacy: Add some notes in comments and rename WC_ECHO #9605
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
WC_ECHO only gates whether a control character Ctrl+X is rendered as "^X" or acted upon.
DHowett
commented
Mar 24, 2021
Comment on lines
+524
to
+527
| // WCL-NOTE: We should never hit this. | ||
| // WCL-NOTE: 1. Normal characters are handled via the early check for IS_GLYPH_CHAR | ||
| // WCL-NOTE: 2. Control characters are handled via the CtrlChar label (if WC_PRINTABLE_CONTROL_CHARS is on) | ||
| // WCL-NOTE: And if they are control characters they will trigger the C1_CNTRL check above. |
Member
Author
There was a problem hiding this comment.
This was observed by fuzzing for ~10 minutes with WC_PRINTABLE_CONTROL_CHARS on or off.
zadjii-msft
approved these changes
Mar 24, 2021
Member
Author
|
Since @j4james has touched this code, this mention is advisory. I've been fuzzing WriteCharsLegacy and using it as a way to generate inputs that satisfy every branch in this function. 😁 |
miniksa
reviewed
Mar 24, 2021
miniksa
reviewed
Mar 24, 2021
miniksa
reviewed
Mar 24, 2021
miniksa
approved these changes
Mar 24, 2021
Member
miniksa
left a comment
miniksa
left a comment
There was a problem hiding this comment.
Good stuff. Normally I'd nag for GH: ID for the bits that are now documented as known wrong... but there's honestly no point. So let's do this.
Member
Author
|
The SA failure is a checkout failure, not a build failure. This passes SA as it it does not change any code. |
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 commit clarifies some things inside WriteCharsLegacy by adding
comments and renaming parameter and enum names. It does not change any
logic.
WC_ECHOwas used extensively to mean only one thing: whether to printa control character like
\x18(Ctrl+X) as^X. It's beenrenamed to make that abundantly clear.