Skip to content

Commit 28d6494

Browse files
gselzerclaude
andcommitted
Merge PositionMap into ScriptDocument
A script document maps positions between its script and its text itself: by offset, and by LSP position and range. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 8ff4804 commit 28d6494

4 files changed

Lines changed: 78 additions & 155 deletions

File tree

‎code-lsp/src/main/java/org/scijava/code/lsp/script/PositionMap.java‎

Lines changed: 0 additions & 97 deletions
This file was deleted.

‎code-lsp/src/main/java/org/scijava/code/lsp/script/ScriptDocument.java‎

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@
3636
import java.util.List;
3737
import java.util.Map;
3838
import java.util.Set;
39+
40+
import org.eclipse.lsp4j.Position;
41+
import org.eclipse.lsp4j.Range;
3942
import org.scijava.code.lsp.Environment;
43+
import org.scijava.code.lsp.Positions;
4044

4145
/**
4246
* A SciJava script as plain code of its language (a "virtual document"), for
@@ -45,7 +49,10 @@
4549
* time, and lines that are not of the language blanked.
4650
* <p>
4751
* The transformation only prepends one header line and blanks lines in place
48-
* (with spaces), so {@link #map() positions} map back trivially.
52+
* (with spaces), so positions in the script just shift by the header (see
53+
* {@link #toTransformed(int)} and {@link #toOriginal(int)}). Offsets count
54+
* {@code char}s, i.e. UTF-16 code units, as do Java strings and the Language
55+
* Server Protocol.
4956
* </p>
5057
*
5158
* @author Gabriel Selzer
@@ -55,17 +62,18 @@ public final class ScriptDocument {
5562

5663
private final String original;
5764
private final String text;
58-
private final PositionMap map;
65+
/** Number of characters prepended. */
66+
private final int headerLength;
5967
private final Map<String, String> parameters;
6068
private final Environment environment;
6169

6270
private ScriptDocument(final String original, final String text,
63-
final PositionMap map, final Map<String, String> parameters,
71+
final int headerLength, final Map<String, String> parameters,
6472
final Environment environment)
6573
{
6674
this.original = original;
6775
this.text = text;
68-
this.map = map;
76+
this.headerLength = headerLength;
6977
this.parameters = Collections.unmodifiableMap(parameters);
7078
this.environment = environment;
7179
}
@@ -102,7 +110,7 @@ public static ScriptDocument of(final String script,
102110
.separator(), statements) + "\n";
103111

104112
return new ScriptDocument(script, header + blank(script, dialect),
105-
new PositionMap(header.length(), header.isEmpty() ? 0 : 1), types,
113+
header.length(), types,
106114
environment == null ? Environment.NONE : environment);
107115
}
108116

@@ -116,9 +124,42 @@ public String text() {
116124
return text;
117125
}
118126

119-
/** Maps positions between {@link #original()} and {@link #text()}. */
120-
public PositionMap map() {
121-
return map;
127+
/** Maps an offset in {@link #original()} to one in {@link #text()}. */
128+
public int toTransformed(final int offset) {
129+
return offset + headerLength;
130+
}
131+
132+
/**
133+
* Maps an offset in {@link #text()} to one in {@link #original()}; or
134+
* returns -1 if it lies in the header prepended.
135+
*/
136+
public int toOriginal(final int offset) {
137+
return offset < headerLength ? -1 : offset - headerLength;
138+
}
139+
140+
/** Maps a position in {@link #original()} to one in {@link #text()}. */
141+
public Position toTransformed(final Position p) {
142+
return Positions.position(text, toTransformed(Positions.offset(original,
143+
p)));
144+
}
145+
146+
/**
147+
* Maps a position in {@link #text()} to one in {@link #original()}; or
148+
* returns null if it lies in the header prepended.
149+
*/
150+
public Position toOriginal(final Position p) {
151+
final int offset = toOriginal(Positions.offset(text, p));
152+
return offset < 0 ? null : Positions.position(original, offset);
153+
}
154+
155+
/**
156+
* Maps a range in {@link #text()} to one in {@link #original()}; or returns
157+
* null if either end lies in the header prepended.
158+
*/
159+
public Range toOriginal(final Range r) {
160+
final Position start = toOriginal(r.getStart());
161+
final Position end = toOriginal(r.getEnd());
162+
return start == null || end == null ? null : new Range(start, end);
122163
}
123164

124165
/**

‎code-lsp/src/main/java/org/scijava/code/lsp/script/TransformingLanguageServer.java‎

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@
5555
import org.eclipse.lsp4j.InsertReplaceEdit;
5656
import org.eclipse.lsp4j.MessageActionItem;
5757
import org.eclipse.lsp4j.MessageParams;
58-
import org.eclipse.lsp4j.Position;
5958
import org.eclipse.lsp4j.PublishDiagnosticsParams;
6059
import org.eclipse.lsp4j.Range;
6160
import org.eclipse.lsp4j.ShowMessageRequestParams;
@@ -71,7 +70,6 @@
7170
import org.eclipse.lsp4j.services.LanguageServer;
7271
import org.eclipse.lsp4j.services.TextDocumentService;
7372
import org.eclipse.lsp4j.services.WorkspaceService;
74-
import org.scijava.code.lsp.Positions;
7573

7674
/**
7775
* Shows a language server SciJava scripts as plain code of its language (see
@@ -192,7 +190,7 @@ public void didSave(final DidSaveTextDocumentParams params) {
192190
final ScriptDocument doc = docs.get(params.getTextDocument().getUri());
193191
if (doc == null) return inner.getTextDocumentService().completion(params);
194192
final CompletionParams p = new CompletionParams(params.getTextDocument(),
195-
toTransformed(doc, params.getPosition()), params.getContext());
193+
doc.toTransformed(params.getPosition()), params.getContext());
196194
final CompletableFuture<Either<List<CompletionItem>, CompletionList>> raw =
197195
inner.getTextDocumentService().completion(p);
198196
final CompletableFuture<Either<List<CompletionItem>, CompletionList>> out =
@@ -221,7 +219,7 @@ public CompletableFuture<SignatureHelp> signatureHelp(
221219
if (doc == null) return inner.getTextDocumentService().signatureHelp(
222220
params);
223221
return inner.getTextDocumentService().signatureHelp(new SignatureHelpParams(
224-
params.getTextDocument(), toTransformed(doc, params.getPosition()),
222+
params.getTextDocument(), doc.toTransformed(params.getPosition()),
225223
params.getContext()));
226224
}
227225

@@ -230,12 +228,12 @@ public CompletableFuture<Hover> hover(final HoverParams params) {
230228
final ScriptDocument doc = docs.get(params.getTextDocument().getUri());
231229
if (doc == null) return inner.getTextDocumentService().hover(params);
232230
return inner.getTextDocumentService().hover(new HoverParams(params
233-
.getTextDocument(), toTransformed(doc, params.getPosition()))).thenApply(
231+
.getTextDocument(), doc.toTransformed(params.getPosition()))).thenApply(
234232
h -> {
235233
if (h == null || h.getRange() == null) return h;
236234
final Hover out = new Hover();
237235
out.setContents(h.getContents());
238-
out.setRange(toOriginal(doc, h.getRange()));
236+
out.setRange(doc.toOriginal(h.getRange()));
239237
return out;
240238
});
241239
}
@@ -252,31 +250,6 @@ public void didChangeWatchedFiles(final DidChangeWatchedFilesParams p) {
252250
inner.getWorkspaceService().didChangeWatchedFiles(p);
253251
}
254252

255-
// -- Position mapping --
256-
257-
/** Maps a position in a script to one in its transformed text. */
258-
static Position toTransformed(final ScriptDocument doc, final Position p) {
259-
final int offset = Positions.offset(doc.original(), p);
260-
return Positions.position(doc.text(), doc.map().toTransformed(offset));
261-
}
262-
263-
/**
264-
* Maps a position in the transformed text to one in the script; or returns
265-
* null if it lies in the lines the transformation added.
266-
*/
267-
static Position toOriginal(final ScriptDocument doc, final Position p) {
268-
final PositionMap map = doc.map();
269-
final int offset = map.toOriginal(Positions.offset(doc.text(), p));
270-
return offset < 0 ? null : Positions.position(doc.original(), offset);
271-
}
272-
273-
/** Maps a range back; or returns null if it starts in the added lines. */
274-
static Range toOriginal(final ScriptDocument doc, final Range r) {
275-
final Position start = toOriginal(doc, r.getStart());
276-
final Position end = toOriginal(doc, r.getEnd());
277-
return start == null || end == null ? null : new Range(start, end);
278-
}
279-
280253
/** Maps completions' edits back, leaving out those in the added lines. */
281254
private static CompletionList back(final ScriptDocument doc,
282255
final CompletionList list)
@@ -287,14 +260,14 @@ private static CompletionList back(final ScriptDocument doc,
287260
if (item.getTextEdit() != null) {
288261
if (item.getTextEdit().isLeft()) {
289262
final TextEdit e = item.getTextEdit().getLeft();
290-
final Range r = toOriginal(doc, e.getRange());
263+
final Range r = doc.toOriginal(e.getRange());
291264
if (r == null) continue;
292265
c.setTextEdit(Either.forLeft(new TextEdit(r, e.getNewText())));
293266
}
294267
else {
295268
final InsertReplaceEdit e = item.getTextEdit().getRight();
296-
final Range insert = toOriginal(doc, e.getInsert());
297-
final Range replace = toOriginal(doc, e.getReplace());
269+
final Range insert = doc.toOriginal(e.getInsert());
270+
final Range replace = doc.toOriginal(e.getReplace());
298271
if (insert == null || replace == null) continue;
299272
c.setTextEdit(Either.forRight(new InsertReplaceEdit(e.getNewText(),
300273
insert, replace)));
@@ -303,7 +276,7 @@ private static CompletionList back(final ScriptDocument doc,
303276
if (item.getAdditionalTextEdits() != null) {
304277
final List<TextEdit> edits = new ArrayList<>();
305278
for (final TextEdit e : item.getAdditionalTextEdits()) {
306-
final Range r = toOriginal(doc, e.getRange());
279+
final Range r = doc.toOriginal(e.getRange());
307280
if (r != null) edits.add(new TextEdit(r, e.getNewText()));
308281
}
309282
c.setAdditionalTextEdits(edits);
@@ -327,7 +300,7 @@ public void publishDiagnostics(final PublishDiagnosticsParams p) {
327300
}
328301
final List<Diagnostic> mapped = new ArrayList<>();
329302
for (final Diagnostic d : p.getDiagnostics()) {
330-
final Range r = toOriginal(doc, d.getRange());
303+
final Range r = doc.toOriginal(d.getRange());
331304
if (r == null) continue; // NB: In the added lines.
332305
final Diagnostic m = new Diagnostic();
333306
m.setRange(r);

‎code-lsp/src/test/java/org/scijava/code/lsp/script/ScriptDocumentTest.java‎

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@
4141
import java.util.Map;
4242
import java.util.TreeSet;
4343

44+
import org.eclipse.lsp4j.Position;
45+
import org.eclipse.lsp4j.Range;
4446
import org.junit.jupiter.api.Test;
4547
import org.scijava.code.lsp.Environment;
4648

4749
/**
48-
* Tests {@link ScriptDocument} and {@link PositionMap}.
50+
* Tests {@link ScriptDocument}.
4951
*
5052
* @author Gabriel Selzer
5153
*/
@@ -131,10 +133,9 @@ public void testIdentity() {
131133
final ScriptDocument doc = ScriptDocument.of(script, params(), GROOVY,
132134
null);
133135
assertEquals(script, doc.text());
134-
assertEquals(0, doc.map().headerLength());
135-
assertEquals(0, doc.map().headerLines());
136-
assertEquals(5, doc.map().toTransformed(5));
137-
assertEquals(1, doc.map().lineToOriginal(1));
136+
assertEquals(5, doc.toTransformed(5));
137+
assertEquals(5, doc.toOriginal(5));
138+
assertEquals(new Position(1, 1), doc.toTransformed(new Position(1, 1)));
138139
}
139140

140141
@Test
@@ -145,7 +146,7 @@ public void testBlanking() {
145146
assertEquals("java.lang.String s\n" +
146147
" \r\nprintln s\r\n \n ", doc.text());
147148
// Blanking keeps every offset, and line breaks (incl. CR) in place.
148-
assertEquals(doc.text().length() - doc.map().headerLength(), script
149+
assertEquals(doc.text().length() - doc.toTransformed(0), script
149150
.length());
150151
assertEquals(doc.text().split("\n", -1).length - 1, script.split("\n",
151152
-1).length);
@@ -157,21 +158,26 @@ public void testRoundTrips() {
157158
final String script = "#@ String s\r\nt = \"😀\"\r\ns.len";
158159
final ScriptDocument doc = ScriptDocument.of(script, params("s",
159160
String.class), PYTHON, null);
160-
final PositionMap map = doc.map();
161161
for (int i = 0; i <= script.length(); i++) {
162-
final int t = map.toTransformed(i);
163-
assertEquals(i, map.toOriginal(t));
162+
final int t = doc.toTransformed(i);
163+
assertEquals(i, doc.toOriginal(t));
164164
// The text after a position is the same in both.
165165
assertEquals(script.substring(i), doc.text().substring(t));
166166
}
167167
for (int line = 0; line < 3; line++) {
168-
assertEquals(line, map.lineToOriginal(map.lineToTransformed(line)));
168+
final Position p = new Position(line, 2);
169+
final Position t = doc.toTransformed(p);
170+
assertEquals(new Position(line + 1, 2), t);
171+
assertEquals(p, doc.toOriginal(t));
169172
}
170173
// The header maps to nothing.
171-
assertEquals(-1, map.toOriginal(0));
172-
assertEquals(-1, map.toOriginal(map.headerLength() - 1));
173-
assertEquals(-1, map.lineToOriginal(0));
174-
assertEquals(1, map.lineToTransformed(0));
174+
assertEquals(-1, doc.toOriginal(0));
175+
assertEquals(-1, doc.toOriginal(doc.toTransformed(0) - 1));
176+
assertNull(doc.toOriginal(new Position(0, 0)));
177+
assertNull(doc.toOriginal(new Range(new Position(0, 0), new Position(1,
178+
1))));
179+
assertEquals(new Range(new Position(0, 0), new Position(1, 1)), doc
180+
.toOriginal(new Range(new Position(1, 0), new Position(2, 1))));
175181
}
176182

177183
@Test

0 commit comments

Comments
 (0)