gopls/internal/lsp/source: move edit logic into the protocol package

Change-Id: I8a2dcafc109bf298b6edfe7a7029f8b9098880d6
Reviewed-on: https://go-review.googlesource.com/c/tools/+/543920
Reviewed-by: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Robert Findley <rfindley@google.com>

Author: findleyr

gopls/internal/cmd/cmd.go

@@ -29,7 +29,6 @@ import (
 	"golang.org/x/tools/gopls/internal/lsp/filecache"
 	"golang.org/x/tools/gopls/internal/lsp/lsprpc"
 	"golang.org/x/tools/gopls/internal/lsp/protocol"
-	"golang.org/x/tools/gopls/internal/lsp/source"
 	"golang.org/x/tools/gopls/internal/settings"
 	"golang.org/x/tools/internal/constraints"
 	"golang.org/x/tools/internal/diff"
@@ -585,7 +584,7 @@ func applyTextEdits(mapper *protocol.Mapper, edits []protocol.TextEdit, flags *E
 	if len(edits) == 0 {
 		return nil
 	}
-	newContent, renameEdits, err := source.ApplyProtocolEdits(mapper, edits)
+	newContent, renameEdits, err := protocol.ApplyEdits(mapper, edits)
 	if err != nil {
 		return err
 	}

gopls/internal/lsp/cache/mod_tidy.go

@@ -457,7 +457,7 @@ func switchDirectness(req *modfile.Require, m *protocol.Mapper, computeEdits set
 	}
 	// Calculate the edits to be made due to the change.
 	edits := computeEdits(string(m.Content), string(newContent))
-	return ToProtocolEdits(m, edits)
+	return protocol.EditsFromDiffEdits(m, edits)
 }
 
 // missingModuleForImport creates an error for a given import path that comes

gopls/internal/lsp/cache/pkg.go

@@ -75,7 +75,6 @@ var (
 	RemoveIntermediateTestVariants = source.RemoveIntermediateTestVariants
 	IsCommandLineArguments         = source.IsCommandLineArguments
 	BundleQuickFixes               = source.BundleQuickFixes
-	ToProtocolEdits                = source.ToProtocolEdits
 	NewFilterer                    = source.NewFilterer
 )
 

gopls/internal/lsp/command.go

@@ -471,7 +471,7 @@ func dropDependency(snapshot source.Snapshot, pm *source.ParsedModule, modulePat
 	}
 	// Calculate the edits to be made due to the change.
 	diff := snapshot.Options().ComputeEdits(string(pm.Mapper.Content), string(newContent))
-	return source.ToProtocolEdits(pm.Mapper, diff)
+	return protocol.EditsFromDiffEdits(pm.Mapper, diff)
 }
 
 func (c *commandHandler) Test(ctx context.Context, uri protocol.DocumentURI, tests, benchmarks []string) error {
@@ -677,7 +677,7 @@ func collectFileEdits(ctx context.Context, snapshot *cache.Snapshot, uri protoco
 
 	m := protocol.NewMapper(fh.URI(), oldContent)
 	diff := snapshot.Options().ComputeEdits(string(oldContent), string(newContent))
-	edits, err := source.ToProtocolEdits(m, diff)
+	edits, err := protocol.EditsFromDiffEdits(m, diff)
 	if err != nil {
 		return nil, err
 	}

gopls/internal/lsp/fake/edit.go

@@ -6,7 +6,6 @@ package fake
 
 import (
 	"golang.org/x/tools/gopls/internal/lsp/protocol"
-	"golang.org/x/tools/gopls/internal/lsp/source"
 	"golang.org/x/tools/internal/diff"
 )
 
@@ -36,7 +35,7 @@ func EditToChangeEvent(e protocol.TextEdit) protocol.TextDocumentContentChangeEv
 // and returns a new slice containing the lines of the patched file.
 // It is a wrapper around diff.Apply; see that function for preconditions.
 func applyEdits(mapper *protocol.Mapper, edits []protocol.TextEdit, windowsLineEndings bool) ([]byte, error) {
-	diffEdits, err := source.FromProtocolEdits(mapper, edits)
+	diffEdits, err := protocol.EditsToDiffEdits(mapper, edits)
 	if err != nil {
 		return nil, err
 	}

gopls/internal/lsp/mod/format.go

@@ -27,5 +27,5 @@ func Format(ctx context.Context, snapshot source.Snapshot, fh file.Handle) ([]pr
 	}
 	// Calculate the edits to be made due to the change.
 	diffs := snapshot.Options().ComputeEdits(string(pm.Mapper.Content), string(formatted))
-	return source.ToProtocolEdits(pm.Mapper, diffs)
+	return protocol.EditsFromDiffEdits(pm.Mapper, diffs)
 }

gopls/internal/lsp/protocol/edits.go

@@ -0,0 +1,62 @@
+// Copyright 2023 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package protocol
+
+import "golang.org/x/tools/internal/diff"
+
+// EditsFromDiffEdits converts diff.Edits to a non-nil slice of LSP TextEdits.
+// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textEditArray
+func EditsFromDiffEdits(m *Mapper, edits []diff.Edit) ([]TextEdit, error) {
+	// LSP doesn't require TextEditArray to be sorted:
+	// this is the receiver's concern. But govim, and perhaps
+	// other clients have historically relied on the order.
+	edits = append([]diff.Edit(nil), edits...)
+	diff.SortEdits(edits)
+
+	result := make([]TextEdit, len(edits))
+	for i, edit := range edits {
+		rng, err := m.OffsetRange(edit.Start, edit.End)
+		if err != nil {
+			return nil, err
+		}
+		result[i] = TextEdit{
+			Range:   rng,
+			NewText: edit.New,
+		}
+	}
+	return result, nil
+}
+
+// EditsToDiffEdits converts LSP TextEdits to diff.Edits.
+// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textEditArray
+func EditsToDiffEdits(m *Mapper, edits []TextEdit) ([]diff.Edit, error) {
+	if edits == nil {
+		return nil, nil
+	}
+	result := make([]diff.Edit, len(edits))
+	for i, edit := range edits {
+		start, end, err := m.RangeOffsets(edit.Range)
+		if err != nil {
+			return nil, err
+		}
+		result[i] = diff.Edit{
+			Start: start,
+			End:   end,
+			New:   edit.NewText,
+		}
+	}
+	return result, nil
+}
+
+// ApplyEdits applies the patch (edits) to m.Content and returns the result.
+// It also returns the edits converted to diff-package form.
+func ApplyEdits(m *Mapper, edits []TextEdit) ([]byte, []diff.Edit, error) {
+	diffEdits, err := EditsToDiffEdits(m, edits)
+	if err != nil {
+		return nil, nil, err
+	}
+	out, err := diff.ApplyBytes(m.Content, diffEdits)
+	return out, diffEdits, err
+}

gopls/internal/lsp/regtest/marker.go

@@ -33,7 +33,6 @@ import (
 	"golang.org/x/tools/gopls/internal/lsp/lsprpc"
 	"golang.org/x/tools/gopls/internal/lsp/protocol"
 	"golang.org/x/tools/gopls/internal/lsp/safetoken"
-	"golang.org/x/tools/gopls/internal/lsp/source"
 	"golang.org/x/tools/gopls/internal/lsp/tests"
 	"golang.org/x/tools/gopls/internal/lsp/tests/compare"
 	"golang.org/x/tools/internal/diff"
@@ -1675,9 +1674,7 @@ func acceptCompletionMarker(mark marker, src protocol.Location, label string, go
 	}
 	filename := mark.path()
 	mapper := mark.mapper()
-	patched, _, err := source.ApplyProtocolEdits(mapper, append([]protocol.TextEdit{
-		*selected.TextEdit,
-	}, selected.AdditionalTextEdits...))
+	patched, _, err := protocol.ApplyEdits(mapper, append([]protocol.TextEdit{*selected.TextEdit}, selected.AdditionalTextEdits...))
 
 	if err != nil {
 		mark.errorf("ApplyProtocolEdits failed: %v", err)
@@ -1739,7 +1736,7 @@ func foldingRangeMarker(mark marker, g *Golden) {
 		mark.errorf("Editor.Mapper(%s) failed: %v", filename, err)
 		return
 	}
-	got, _, err := source.ApplyProtocolEdits(mapper, edits)
+	got, _, err := protocol.ApplyEdits(mapper, edits)
 	if err != nil {
 		mark.errorf("ApplyProtocolEdits failed: %v", err)
 		return
@@ -1766,7 +1763,7 @@ func formatMarker(mark marker, golden *Golden) {
 			mark.errorf("Editor.Mapper(%s) failed: %v", filename, err)
 		}
 
-		got, _, err = source.ApplyProtocolEdits(mapper, edits)
+		got, _, err = protocol.ApplyEdits(mapper, edits)
 		if err != nil {
 			mark.errorf("ApplyProtocolEdits failed: %v", err)
 			return
@@ -2008,7 +2005,7 @@ func applyDocumentChanges(env *Env, changes []protocol.DocumentChanges, fileChan
 			if err != nil {
 				return err
 			}
-			patched, _, err := source.ApplyProtocolEdits(mapper, change.TextDocumentEdit.Edits)
+			patched, _, err := protocol.ApplyEdits(mapper, change.TextDocumentEdit.Edits)
 			if err != nil {
 				return err
 			}
@@ -2400,7 +2397,7 @@ func inlayhintsMarker(mark marker, g *Golden) {
 	}
 
 	m := mark.mapper()
-	got, _, err := source.ApplyProtocolEdits(m, edits)
+	got, _, err := protocol.ApplyEdits(m, edits)
 	if err != nil {
 		mark.errorf("ApplyProtocolEdits: %v", err)
 		return

gopls/internal/lsp/source/change_quote.go

@@ -69,7 +69,7 @@ func ConvertStringLiteral(pgf *ParsedGoFile, fh file.Handle, rng protocol.Range)
 		End:   end,
 		New:   newText,
 	}}
-	pedits, err := ToProtocolEdits(pgf.Mapper, edits)
+	pedits, err := protocol.EditsFromDiffEdits(pgf.Mapper, edits)
 	if err != nil {
 		bug.Reportf("failed to convert diff.Edit to protocol.TextEdit:%v", err)
 		return protocol.CodeAction{}, false

gopls/internal/lsp/source/change_signature.go

@@ -164,7 +164,7 @@ func RemoveUnusedParameter(ctx context.Context, fh file.Handle, rng protocol.Ran
 		}
 		edits := diff.Bytes(before, after)
 		mapper := protocol.NewMapper(uri, before)
-		pedits, err := ToProtocolEdits(mapper, edits)
+		pedits, err := protocol.EditsFromDiffEdits(mapper, edits)
 		if err != nil {
 			return nil, fmt.Errorf("computing edits for %s: %v", uri, err)
 		}