Skip to content

Commit

Permalink
Optimize pretty printing performance
Browse files Browse the repository at this point in the history
swift-format#883 fixed outputting incorrect line numbers, but introduced
a performance regression. swift-format#901 improved this back to around
the original, but had to be reverted as it introduced a an issue due to
counting codepoints rather than characters.

Introduce a similar optimization again, but only for the first portion
of the string (prior to the last newline).

Fixes swift-format#894 again.
  • Loading branch information
bnbarham committed Jan 10, 2025
1 parent e82cdd7 commit 3ca204b
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 11 deletions.
25 changes: 14 additions & 11 deletions Sources/SwiftFormat/PrettyPrint/PrettyPrintBuffer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -119,18 +119,21 @@ struct PrettyPrintBuffer {
consecutiveNewlineCount = 0
pendingSpaces = 0

// In case of comments, we may get a multi-line string.
// To account for that case, we need to correct the lineNumber count.
// The new column is only the position within the last line.
let lines = text.split(separator: "\n")
lineNumber += lines.count - 1
if lines.count > 1 {
// in case we have inserted new lines, we need to reset the column
column = lines.last?.count ?? 0
// In case of comments, we may get a multi-line string. To account for that case, we need to correct the
// `lineNumber` count. The new `column` is the position within the last line.

var lastNewlineIndex: String.Index? = nil
for i in text.utf8.indices {
if text.utf8[i] == UInt8(ascii: "\n") {
lastNewlineIndex = i
lineNumber += 1
}
}

if let lastNewlineIndex {
column = text.distance(from: text.utf8.index(after: lastNewlineIndex), to: text.endIndex)
} else {
// in case it is an end of line comment or a single line comment,
// we just add to the current column
column += lines.last?.count ?? 0
column += text.count
}
}

Expand Down
34 changes: 34 additions & 0 deletions Tests/SwiftFormatTests/PrettyPrint/LineNumbersTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,38 @@ final class LineNumbersTests: PrettyPrintTestCase {
]
)
}

func testCharacterVsCodepoint() {
let input =
"""
let fo = 1 // 🤥
"""

assertPrettyPrintEqual(
input: input,
expected: input,
linelength: 16,
whitespaceOnly: true,
findings: []
)
}

func testCharacterVsCodepointMultiline() {
let input =
#"""
/// This is a multiline
/// comment that is in 🤥
/// fact perfectly sized
"""#

assertPrettyPrintEqual(
input: input,
expected: input,
linelength: 25,
whitespaceOnly: true,
findings: []
)
}
}

0 comments on commit 3ca204b

Please sign in to comment.