-
Notifications
You must be signed in to change notification settings - Fork 422
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rewrite FixItApplier to be string based
- Loading branch information
Showing
7 changed files
with
332 additions
and
164 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors | ||
| // Licensed under Apache License v2.0 with Runtime Library Exception | ||
| // | ||
| // See https://swift.org/LICENSE.txt for license information | ||
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import SwiftDiagnostics | ||
| import SwiftSyntax | ||
|
|
||
| public enum FixItApplier { | ||
| fileprivate struct Edit: Equatable { | ||
| var startUtf8Offset: Int | ||
| var endUtf8Offset: Int | ||
| let replacement: String | ||
|
|
||
| var originalLength: Int { | ||
| return endUtf8Offset - startUtf8Offset | ||
| } | ||
|
|
||
| var replacementLength: Int { | ||
| return replacement.utf8.count | ||
| } | ||
|
|
||
| var replacementRange: Range<Int> { | ||
| return startUtf8Offset..<endUtf8Offset | ||
| } | ||
| } | ||
|
|
||
| /// Applies selected or all Fix-Its from the provided diagnostics to a given syntax tree. | ||
| /// | ||
| /// - Parameters: | ||
| /// - diagnostics: An array of `Diagnostic` objects, each containing one or more Fix-Its. | ||
| /// - filterByMessages: An optional array of message strings to filter which Fix-Its to apply. | ||
| /// If `nil`, all Fix-Its in `diagnostics` are applied. | ||
| /// - tree: The syntax tree to which the Fix-Its will be applied. | ||
| /// | ||
| /// - Returns: A ``String`` representation of the modified syntax tree after applying the Fix-Its. | ||
| public static func applyFixes( | ||
| from diagnostics: [Diagnostic], | ||
| filterByMessages messages: [String]?, | ||
| to tree: any SyntaxProtocol | ||
| ) -> String { | ||
| let messages = messages ?? diagnostics.compactMap { $0.fixIts.first?.message.message } | ||
|
|
||
| let changes = | ||
| diagnostics | ||
| .flatMap(\.fixIts) | ||
| .filter { messages.contains($0.message.message) } | ||
| .flatMap(\.changes) | ||
|
|
||
| var edits: [Edit] = [] | ||
|
|
||
| for change in changes { | ||
| switch change { | ||
| case .replace(let oldNode, let newNode): | ||
| edits.append( | ||
| Edit( | ||
| startUtf8Offset: oldNode.position.utf8Offset, | ||
| endUtf8Offset: oldNode.endPosition.utf8Offset, | ||
| replacement: newNode.description | ||
| ) | ||
| ) | ||
|
|
||
| case .replaceLeadingTrivia(let token, let newTrivia): | ||
| edits.append( | ||
| Edit( | ||
| startUtf8Offset: token.position.utf8Offset, | ||
| endUtf8Offset: token.positionAfterSkippingLeadingTrivia.utf8Offset, | ||
| replacement: newTrivia.description | ||
| ) | ||
| ) | ||
|
|
||
| case .replaceTrailingTrivia(let token, let newTrivia): | ||
| edits.append( | ||
| Edit( | ||
| startUtf8Offset: token.endPositionBeforeTrailingTrivia.utf8Offset, | ||
| endUtf8Offset: token.endPosition.utf8Offset, | ||
| replacement: newTrivia.description | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| var source = tree.description | ||
|
|
||
| // As we need to start apply the edits at the end of a source, start by reversing edit | ||
| // and then sort edits by decrementing start offset. If they are equal then descrementing end offset. | ||
| // edits = edits.reversed().sorted(by: { edit1, edit2 in | ||
| // if edit1.startUtf8Offset == edit2.startUtf8Offset { | ||
| // return edit1.endUtf8Offset > edit2.endUtf8Offset | ||
| // } else { | ||
| // return edit1.startUtf8Offset > edit2.startUtf8Offset | ||
| // } | ||
| // }) | ||
|
|
||
| while let edit = edits.first { | ||
| edits = Array(edits.dropFirst()) | ||
|
|
||
| let startIndex = source.utf8.index(source.utf8.startIndex, offsetBy: edit.startUtf8Offset) | ||
| let endIndex = source.utf8.index(source.utf8.startIndex, offsetBy: edit.endUtf8Offset) | ||
|
|
||
| source.replaceSubrange(startIndex..<endIndex, with: edit.replacement) | ||
|
|
||
| edits = edits.compactMap { remainingEdit -> FixItApplier.Edit? in | ||
| var remainingEdit = remainingEdit | ||
|
|
||
| if remainingEdit.replacementRange.overlaps(edit.replacementRange) { | ||
| // The edit overlaps with the previous edit. We can't apply both | ||
| // without conflicts. Apply the one that's listed first and drop the | ||
| // later edit. | ||
| return nil | ||
| } | ||
|
|
||
| // Keep the origianl length as we start to edit the offset. | ||
| let originalLength = remainingEdit.originalLength | ||
|
|
||
| // If the current is after the edit we want to update, don't change the offset. | ||
| // If the remaining edit have same start and end position, don't change the start offset. | ||
| if edit.endUtf8Offset <= remainingEdit.startUtf8Offset { | ||
| // Take the largest value as we in some cases can end up with a negative offset. | ||
| remainingEdit.startUtf8Offset = Swift.max(remainingEdit.startUtf8Offset - edit.originalLength + edit.replacementLength, 0) | ||
| } | ||
|
|
||
| // If we need to replace a string at the end, we need to ensure we don't get an out-of-bounds error. | ||
| remainingEdit.endUtf8Offset = Swift.min(remainingEdit.startUtf8Offset + originalLength, source.utf8.count) | ||
|
|
||
| return remainingEdit | ||
| } | ||
| } | ||
|
|
||
| return source | ||
| } | ||
| } | ||
|
|
||
| //extension Array where Element == FixItApplier.Edit { | ||
| // fileprivate func canInsert(editToApply: Element) -> Bool { | ||
| // return self.contains { edit in | ||
| // return | ||
| // !(editToApply.startUtf8Offset >= edit.startUtf8Offset | ||
| // && editToApply.endUtf8Offset < edit.endUtf8Offset) | ||
| // } | ||
| // } | ||
| //} |
This file contains 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
Oops, something went wrong.