Started implementing set highlight for cursorless everywhere

Author: AndreasArvidsson

cursorless-everywhere-talon/cursorless_everywhere_talon.py

@@ -1,9 +1,15 @@
 import json
-from typing import Any
+from typing import Any, Optional, Union
 
 from talon import Context, Module, actions
 
-from .cursorless_everywhere_types import EditorEdit, EditorState, SelectionOffsets
+from .cursorless_everywhere_types import (
+    CharacterRangeOffsets,
+    EditorEdit,
+    EditorState,
+    LineRange,
+    SelectionOffsets,
+)
 
 mod = Module()
 
@@ -71,5 +77,13 @@ def private_cursorless_talonjs_run_no_wait(
     ):
         """Executes a Cursorless command, but does not wait for it to finish, nor return the response"""
 
-    def private_cursorless_talonjs_get_response_json() -> str:
+    def private_cursorless_talonjs_get_response_json() -> str:  # pyright: ignore [reportReturnType]
         """Returns the response from the last Cursorless command"""
+
+    def cursorless_everywhere_set_highlight_ranges(
+        ranges: list[Union[CharacterRangeOffsets, LineRange]],  # pyright: ignore [reportGeneralTypeIssues]
+        highlightId: Optional[str] = None,
+    ):
+        """Set focused element highlight ranges"""
+        print("Setting highlight ranges", ranges, highlightId)
+        actions.skip()

cursorless-everywhere-talon/cursorless_everywhere_types.py

@@ -1,11 +1,23 @@
-from typing import TypedDict
+from typing import Literal, TypedDict
 
 
 class SelectionOffsets(TypedDict):
     anchor: int
     active: int
 
 
+class CharacterRangeOffsets(TypedDict):
+    type: Literal["character"]
+    start: int
+    end: int
+
+
+class LineRange(TypedDict):
+    type: Literal["line"]
+    start: int
+    end: int
+
+
 class EditorState(TypedDict):
     text: str
     selections: list[SelectionOffsets]

packages/cursorless-everywhere-talon-core/src/ide/TalonJsCapabilities.ts

@@ -1,6 +1,8 @@
 import type { Capabilities, CommandCapabilityMap } from "@cursorless/common";
 
 const COMMAND_CAPABILITIES: CommandCapabilityMap = {
+  highlight: { acceptsLocation: true },
+
   clipboardCopy: undefined,
   clipboardPaste: undefined,
   toggleLineComment: undefined,
@@ -12,7 +14,6 @@ const COMMAND_CAPABILITIES: CommandCapabilityMap = {
   showDebugHover: undefined,
   extractVariable: undefined,
   fold: undefined,
-  highlight: undefined,
   unfold: undefined,
   showReferences: undefined,
   insertLineAfter: undefined,

packages/cursorless-everywhere-talon-core/src/ide/TalonJsIDE.ts

@@ -24,6 +24,7 @@ import { Notifier, type KeyValueStore } from "@cursorless/common";
 import { pull } from "lodash-es";
 import type { Talon } from "../types/talon.types";
 import type { EditorState } from "../types/types";
+import { setHighlightRanges } from "./setHighlightRanges";
 import { TalonJsCapabilities } from "./TalonJsCapabilities";
 import { TalonJsClipboard } from "./TalonJsClipboard";
 import { TalonJsConfiguration } from "./TalonJsConfiguration";
@@ -139,11 +140,11 @@ export class TalonJsIDE implements IDE {
   }
 
   setHighlightRanges(
-    _highlightId: string | undefined,
-    _editor: TextEditor,
-    _ranges: GeneralizedRange[],
+    highlightId: string | undefined,
+    editor: TextEditor,
+    ranges: GeneralizedRange[],
   ): Promise<void> {
-    throw new Error("setHighlightRanges not implemented.");
+    return setHighlightRanges(this.talon, editor, ranges, highlightId);
   }
 
   onDidChangeTextDocument(

packages/cursorless-everywhere-talon-core/src/ide/setHighlightRanges.ts

@@ -0,0 +1,34 @@
+import type {
+  GeneralizedRange,
+  LineRange,
+  TextEditor,
+} from "@cursorless/common";
+import type { Talon } from "../types/talon.types";
+import type { CharacterRangeOffsets } from "../types/types";
+
+export function setHighlightRanges(
+  talon: Talon,
+  editor: TextEditor,
+  ranges: GeneralizedRange[],
+  highlightId: string | undefined,
+): Promise<void> {
+  const offsetRanges = ranges.map(
+    (range): CharacterRangeOffsets | LineRange => {
+      if (range.type === "line") {
+        return range;
+      }
+      return {
+        type: "character",
+        start: editor.document.offsetAt(range.start),
+        end: editor.document.offsetAt(range.end),
+      };
+    },
+  );
+
+  talon.actions.user.cursorless_everywhere_set_highlight_ranges(
+    offsetRanges,
+    highlightId,
+  );
+
+  return Promise.resolve();
+}

packages/cursorless-everywhere-talon-core/src/types/talon.types.ts

@@ -1,4 +1,10 @@
-import type { EditorEdit, EditorState, SelectionOffsets } from "./types";
+import type { LineRange } from "@cursorless/common";
+import type {
+  CharacterRangeOffsets,
+  EditorEdit,
+  EditorState,
+  SelectionOffsets,
+} from "./types";
 
 export type TalonNamespace = "user";
 
@@ -17,6 +23,10 @@ export interface TalonActions {
     cursorless_everywhere_get_editor_state(): EditorState;
     cursorless_everywhere_set_selections(selections: SelectionOffsets[]): void;
     cursorless_everywhere_edit_text(edit: EditorEdit): void;
+    cursorless_everywhere_set_highlight_ranges(
+      ranges: (CharacterRangeOffsets | LineRange)[],
+      highlightId: string | undefined,
+    ): void;
   };
 }
 

packages/cursorless-everywhere-talon-core/src/types/types.ts

@@ -14,6 +14,12 @@ export interface SelectionOffsets {
   active: number;
 }
 
+export interface CharacterRangeOffsets {
+  type: "character";
+  start: number;
+  end: number;
+}
+
 export interface EditorState {
   text: string;
   languageId?: string;

packages/cursorless-everywhere-talon-e2e/src/talonMock.ts

@@ -53,6 +53,12 @@ const actions: TalonActions = {
       }
       _finalEditorState.text = edit.text;
     },
+    cursorless_everywhere_set_highlight_ranges(
+      _ranges: any[],
+      _highlightId: string | undefined,
+    ): void {
+      // Do nothing
+    },
   },
 };