Fixes wrong escape when creating a string literal where a pound sign follows a sequence of double quotes or backslashes #1813
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
…follows a sequence of double quotes or backslashes. This pull request fixes a problem where escaping fails when a pound sign follows a sequence of double quotes or backslashes. As shown in the added test case, `foobar""#` and `foobar\\#` require two pound signs as delimiter for escaping, but the current implementation only adds one pound sign, resulting in an incorrect string literal. The reason for this is that a sequence of double quotes or backslashes will stop counting pound signs if they are not followed by a pound sign. If a double quotation mark or backslash is followed by a double quotation mark or backslash, it must continue in pound sign counting mode.
ahoppen
reviewed
Jun 19, 2023
Comment on lines
291
to
292
| countingPounds = true | ||
| requiresEscaping = true |
Member
There was a problem hiding this comment.
Shouldn’t this just be continue? AFAICT countingPounds = true is already true because of the case condition and AFAICT requiresEscaping = true is already true because we entered case (false, "\""), (false, "\\"): before.
Contributor
Author
There was a problem hiding this comment.
You are right, it is better to use continue. Fixed.
Member
|
@swift-ci Please test |
Member
|
@kishikawakatsumi Would you mind also opening a cherry-pick PR to release/5.9? I think it’s worth fixing this formatting issue in SwiftSyntax 509. |
Contributor
Author
Member
|
Oh, sorry. I completely forgot to merge this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 pull request fixes a problem where escaping fails when a pound sign follows a sequence of double quotes or backslashes.
As shown in the added test case,
foobar""#andfoobar\\#require two pound signs as delimiter for escaping, but the current implementation only adds one pound sign, resulting in an incorrect string literal.The reason for this is that a sequence of double quotes or backslashes will stop counting pound signs if they are not followed by a pound sign.
If a double quotation mark or backslash is followed by a double quotation mark or backslash, it must continue in pound sign counting mode.