Implement InMemoryTextEditor (#3214)

Used by TalonJS and unit tests

Author: AndreasArvidsson

packages/common/src/ide/fake/FakeIDE.ts

@@ -11,13 +11,14 @@ import type { TextDocumentChangeEvent } from "../types/Events";
 import type { FlashDescriptor } from "../types/FlashDescriptor";
 import type { QuickPickOptions } from "../types/QuickPickOptions";
 import type {
+  Emit,
   Event,
   TextEditorSelectionChangeEvent,
   TextEditorVisibleRangesChangeEvent,
 } from "../types/events.types";
 import type {
   Disposable,
-  IDE,
+  EmittableIDE,
   OpenUntitledTextDocumentOptions,
   RunMode,
   WorkspaceFolder,
@@ -28,7 +29,7 @@ import FakeConfiguration from "./FakeConfiguration";
 import FakeKeyValueStore from "./FakeKeyValueStore";
 import FakeMessages from "./FakeMessages";
 
-export class FakeIDE implements IDE {
+export class FakeIDE implements EmittableIDE {
   configuration = new FakeConfiguration();
   keyValueStore = new FakeKeyValueStore();
   clipboard = new FakeClipboard();
@@ -47,15 +48,15 @@ export class FakeIDE implements IDE {
   }
 
   async flashRanges(_flashDescriptors: FlashDescriptor[]): Promise<void> {
-    // empty
+    // Empty
   }
 
   async setHighlightRanges(
     _highlightId: string | undefined,
     _editor: TextEditor,
     _ranges: GeneralizedRange[],
   ): Promise<void> {
-    // empty
+    // Empty
   }
 
   onDidOpenTextDocument: Event<TextDocument> = dummyEvent;
@@ -68,6 +69,10 @@ export class FakeIDE implements IDE {
     dummyEvent;
   onDidChangeTextDocument: Event<TextDocumentChangeEvent> = dummyEvent;
 
+  emitDidChangeTextDocument: Emit<TextDocumentChangeEvent> = dummyEmit;
+  emitDidChangeTextEditorSelection: Emit<TextEditorSelectionChangeEvent> =
+    dummyEmit;
+
   mockAssetsRoot(_assetsRoot: string) {
     this.assetsRoot_ = _assetsRoot;
   }
@@ -151,7 +156,11 @@ export class FakeIDE implements IDE {
 function dummyEvent() {
   return {
     dispose() {
-      // empty
+      // Empty
     },
   };
 }
+
+function dummyEmit() {
+  // Empty
+}

…moryTextDocument/InMemoryTextDocument.ts …MemoryTextEditor/InMemoryTextDocument.tspackages/common/src/ide/inMemoryTextDocument/InMemoryTextDocument.ts renamed to packages/common/src/ide/inMemoryTextEditor/InMemoryTextDocument.ts packages/common/src/ide/inMemoryTextDocument/InMemoryTextDocument.ts renamed to packages/common/src/ide/inMemoryTextEditor/InMemoryTextDocument.ts

@@ -1,38 +1,79 @@
 import type {
   Edit,
   EditableTextEditor,
+  EmittableIDE,
   GeneralizedRange,
-  InMemoryTextDocument,
   OpenLinkOptions,
   Range,
   RevealLineAt,
-  Selection,
+  SelectionOffsets,
   SetSelectionsOpts,
+  TextDocument,
   TextEditor,
   TextEditorOptions,
 } from "@cursorless/common";
-import { selectionsEqual } from "@cursorless/common";
-import type { Talon } from "../types/talon.types";
-import { setSelections } from "./setSelections";
-import type { TalonJsIDE } from "./TalonJsIDE";
-import { talonJsPerformEdits } from "./talonJsPerformEdits";
-
-export class TalonJsEditor implements EditableTextEditor {
-  options: TextEditorOptions = {
-    tabSize: 4,
-    insertSpaces: true,
-  };
-
-  isActive = true;
-
-  constructor(
-    private talon: Talon,
-    private ide: TalonJsIDE,
-    public id: string,
-    public document: InMemoryTextDocument,
-    public visibleRanges: Range[],
-    public selections: Selection[],
-  ) {}
+import { Selection, selectionsEqual } from "@cursorless/common";
+import { URI } from "vscode-uri";
+import { InMemoryTextDocument } from "./InMemoryTextDocument";
+
+interface Params {
+  ide: EmittableIDE;
+  languageId?: string;
+  content?: string;
+  options?: TextEditorOptions;
+  visibleRanges?: Range[];
+  selections?: Selection[] | SelectionOffsets[];
+}
+
+export class InMemoryTextEditor implements EditableTextEditor {
+  private static nextId = 0;
+
+  private readonly ide: EmittableIDE;
+  readonly id: string;
+  readonly isActive = true;
+  readonly document: InMemoryTextDocument;
+  readonly options: TextEditorOptions;
+  readonly visibleRanges: Range[];
+  selections: Selection[];
+
+  constructor({
+    ide,
+    languageId = "plaintext",
+    content = "",
+    visibleRanges,
+    selections,
+    options,
+  }: Params) {
+    this.ide = ide;
+    this.id = String(InMemoryTextEditor.nextId++);
+    const uri = URI.parse(`InMemoryTextEditor://${this.id}`);
+    this.document = new InMemoryTextDocument(uri, languageId, content);
+
+    if (visibleRanges != null) {
+      if (visibleRanges.length === 0) {
+        throw new Error("Visible ranges must be non-empty");
+      }
+      this.visibleRanges = visibleRanges;
+    } else {
+      this.visibleRanges = [this.document.range];
+    }
+
+    if (selections != null) {
+      if (selections.length === 0) {
+        throw new Error("Selections must be non-empty");
+      }
+      this.selections = selections.map((s) => {
+        return s instanceof Selection ? s : createSelection(this.document, s);
+      });
+    } else {
+      this.selections = [new Selection(0, 0, 0, 0)];
+    }
+
+    this.options = options ?? {
+      insertSpaces: true,
+      tabSize: 4,
+    };
+  }
 
   isEqual(other: TextEditor): boolean {
     return this.id === other.id;
@@ -42,14 +83,24 @@ export class TalonJsEditor implements EditableTextEditor {
     selections: Selection[],
     _opts?: SetSelectionsOpts,
   ): Promise<void> {
+    if (selections.length === 0) {
+      throw new Error("Selections must be non-empty");
+    }
     if (!selectionsEqual(this.selections, selections)) {
-      await setSelections(this.talon, this.document, selections);
       this.selections = selections;
+      this.ide.emitDidChangeTextEditorSelection({
+        textEditor: this,
+        selections: selections,
+      });
     }
   }
 
   edit(edits: Edit[]): Promise<boolean> {
-    talonJsPerformEdits(this.talon, this.ide, this.document, edits);
+    const changes = this.document.edit(edits);
+    this.ide.emitDidChangeTextDocument({
+      document: this.document,
+      contentChanges: changes,
+    });
     return Promise.resolve(true);
   }
 
@@ -179,3 +230,10 @@ export class TalonJsEditor implements EditableTextEditor {
     throw Error("gitUnstageRange: not implemented");
   }
 }
+
+function createSelection(document: TextDocument, selection: SelectionOffsets) {
+  return new Selection(
+    document.positionAt(selection.anchor),
+    document.positionAt(selection.active),
+  );
+}

…here-talon-core/src/ide/TalonJsEditor.ts …inMemoryTextEditor/InMemoryTextEditor.tspackages/cursorless-everywhere-talon-core/src/ide/TalonJsEditor.ts renamed to packages/common/src/ide/inMemoryTextEditor/InMemoryTextEditor.ts packages/cursorless-everywhere-talon-core/src/ide/TalonJsEditor.ts renamed to packages/common/src/ide/inMemoryTextEditor/InMemoryTextEditor.ts

@@ -29,6 +29,13 @@ export interface Event<T> {
   ): Disposable;
 }
 
+/**
+ * Represents a function that emits an event of type T.
+ */
+export interface Emit<T> {
+  (event: T): void;
+}
+
 /**
  * Represents an event describing the change in a {@link TextEditor.selections text editor's selections}.
  */