Skip to content

Escape backslashes properly when converting to the DSL #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 28, 2022
Merged

Escape backslashes properly when converting to the DSL #436

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
451c907
Fix an issue where we weren't properly escaping backslashes in quoted…
DaveEwing May 24, 2022
4c7f595
From review: use raw strings for find/replace when quoting a string.
DaveEwing May 25, 2022
21b30cb
From review: remove an extra `\` from the regex pattern. (The regex p…
DaveEwing May 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Sources/_StringProcessing/PrintAsPattern.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ extension PrettyPrinter {
extension String {
// TODO: Escaping?
fileprivate var _quoted: String {
"\"\(self._replacing("\"", with: "\\\""))\""
"\"\(self._replacing("\\", with: "\\\\")._replacing("\"", with: "\\\""))\""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"\"\(self._replacing("\\", with: "\\\\")._replacing("\"", with: "\\\""))\""
"\"\(self._replacing(#"\"#, with: #"\\"#)._replacing(#"""#, with: #"\""#))\""

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or we can emit it as a raw string if it has any backslashes or quotes inside it. We could do a quick check to count the number of hashes prior to a backslash and emit a raw string with one additional one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about counting hashes, but it seemed like it wasn't worth the effort. But I'm all for using raw strings in your suggested change. I was mostly preserving the way it had been written.

}
}

Expand Down
8 changes: 8 additions & 0 deletions Tests/RegexTests/RenderDSLTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,12 @@ extension RenderDSLTests {
""")
}
}

func testQuoting() throws {
try testConversion(#"\\\"a\""#, #"""
Regex {
"\\\"a\""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the right conversion? The input is raw, so IIUC it has 3 full backslashes, then a quote then a full backslash and another quote.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll update the test. The \s in \" in the regex to convert is ignored when parsing, but not necessary.

}
"""#)
}
}