forked from swiftlang/swift-syntax
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request swiftlang#2226 from kimdv/kimdv/rewrite-fit-it-app…
…lier Rewrite FixItApplier to be string based
- Loading branch information
Showing
5 changed files
with
165 additions
and
81 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,114 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // 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 { | ||
| struct Edit: Equatable { | ||
| var startUtf8Offset: Int | ||
| var endUtf8Offset: Int | ||
| let replacement: String | ||
|
|
||
| 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`, the first Fix-It from each diagnostic is 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] = changes.map(\.edit) | ||
| var source = tree.description | ||
|
|
||
| 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 | ||
| } | ||
|
|
||
| // If the remaining edit starts after or at the end of the edit that we just applied, | ||
| // shift it by the current edit's difference in length. | ||
| if edit.endUtf8Offset <= remainingEdit.startUtf8Offset { | ||
| remainingEdit.startUtf8Offset = remainingEdit.startUtf8Offset - edit.replacementRange.count + edit.replacementLength | ||
| remainingEdit.endUtf8Offset = remainingEdit.endUtf8Offset - edit.replacementRange.count + edit.replacementLength | ||
| } | ||
|
|
||
| return remainingEdit | ||
| } | ||
| } | ||
|
|
||
| return source | ||
| } | ||
| } | ||
|
|
||
| fileprivate extension FixIt.Change { | ||
| var edit: FixItApplier.Edit { | ||
| switch self { | ||
| case .replace(let oldNode, let newNode): | ||
| return FixItApplier.Edit( | ||
| startUtf8Offset: oldNode.position.utf8Offset, | ||
| endUtf8Offset: oldNode.endPosition.utf8Offset, | ||
| replacement: newNode.description | ||
| ) | ||
|
|
||
| case .replaceLeadingTrivia(let token, let newTrivia): | ||
| return FixItApplier.Edit( | ||
| startUtf8Offset: token.position.utf8Offset, | ||
| endUtf8Offset: token.positionAfterSkippingLeadingTrivia.utf8Offset, | ||
| replacement: newTrivia.description | ||
| ) | ||
|
|
||
| case .replaceTrailingTrivia(let token, let newTrivia): | ||
| return FixItApplier.Edit( | ||
| startUtf8Offset: token.endPositionBeforeTrailingTrivia.utf8Offset, | ||
| endUtf8Offset: token.endPosition.utf8Offset, | ||
| replacement: newTrivia.description | ||
| ) | ||
| } | ||
| } | ||
| } |
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.