Add keyboard special target (#2168)

- Depends on #2170

## Checklist

- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [-] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [-] I have not broken the cheatsheet

packages/common/src/StoredTargetKey.ts

@@ -2,5 +2,6 @@ export const storedTargetKeys = [
   "that",
   "source",
   "instanceReference",
+  "keyboard",
 ] as const;
 export type StoredTargetKey = (typeof storedTargetKeys)[number];

packages/common/src/types/command/ActionDescriptor.ts

@@ -49,6 +49,7 @@ const simpleActionNames = [
   "toggleLineBreakpoint",
   "toggleLineComment",
   "unfoldRegion",
+  "private.setKeyboardTarget",
   "private.showParseTree",
   "private.getTargets",
 ] as const;

packages/common/src/types/command/PartialTargetDescriptor.types.ts

@@ -6,6 +6,10 @@ export interface ThatMark {
   type: "that";
 }
 
+export interface KeyboardMark {
+  type: "keyboard";
+}
+
 export interface SourceMark {
   type: "source";
 }
@@ -69,6 +73,7 @@ export type PartialMark =
   | CursorMark
   | ThatMark
   | SourceMark
+  | KeyboardMark
   | DecoratedSymbolMark
   | NothingMark
   | LineNumberMark

packages/cursorless-engine/src/CommandHistory.ts

@@ -194,6 +194,7 @@ function sanitizeActionInPlace(action: ActionDescriptor): void {
     case "swapTargets":
     case "wrapWithPairedDelimiter":
     case "findInDocument":
+    case "private.setKeyboardTarget":
       break;
 
     default: {

packages/cursorless-engine/src/actions/Actions.ts

@@ -134,6 +134,7 @@ export class Actions implements ActionRecord {
   scrollToBottom = new ScrollToBottom();
   scrollToCenter = new ScrollToCenter();
   scrollToTop = new ScrollToTop();
+  ["private.setKeyboardTarget"] = new SetSpecialTarget("keyboard");
   ["experimental.setInstanceReference"] = new SetSpecialTarget(
     "instanceReference",
   );

packages/cursorless-engine/src/actions/actions.types.ts

@@ -52,6 +52,11 @@ export interface ActionReturnValue {
    * to determine either the range for "every", or the start point for "next"
    */
   instanceReferenceTargets?: Target[];
+
+  /**
+   * A list of targets that become the active keybaord targets
+   */
+  keyboardTargets?: Target[];
 }
 
 export interface SimpleAction {

packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts

@@ -54,6 +54,7 @@ export class CommandRunnerImpl implements CommandRunner {
       sourceSelections: newSourceSelections,
       sourceTargets: newSourceTargets,
       instanceReferenceTargets: newInstanceReferenceTargets,
+      keyboardTargets: newKeyboardTargets,
     } = await this.runAction(action);
 
     this.storedTargets.set(
@@ -65,6 +66,7 @@ export class CommandRunnerImpl implements CommandRunner {
       constructStoredTarget(newSourceTargets, newSourceSelections),
     );
     this.storedTargets.set("instanceReference", newInstanceReferenceTargets);
+    this.storedTargets.set("keyboard", newKeyboardTargets);
 
     return returnValue;
   }

packages/cursorless-engine/src/generateSpokenForm/defaultSpokenForms/actions.ts

@@ -65,6 +65,7 @@ export const actions = {
   getText: null,
   replace: null,
   ["private.getTargets"]: null,
+  ["private.setKeyboardTarget"]: null,
 
   // These actions are implemented talon-side, usually using `getText` followed
   // by some other action.

packages/cursorless-engine/src/generateSpokenForm/defaultSpokenForms/marks.ts

@@ -35,6 +35,7 @@ export const marks = {
   source: "source",
   nothing: "nothing",
 
+  keyboard: null,
   explicit: null,
   decoratedSymbol: null,
   lineNumber: null,

packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.ts

@@ -104,6 +104,7 @@ export class SpokenFormGenerator {
       case "replace":
       case "executeCommand":
       case "private.getTargets":
+      case "private.setKeyboardTarget":
         throw new NoSpokenFormError(`Action '${action.name}'`);
 
       case "replaceWithTarget":

packages/cursorless-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts

@@ -302,6 +302,7 @@ export class PrimitiveTargetSpokenFormGenerator {
         throw Error(`Mark '${mark.type}' is not fully implemented`);
       }
       case "explicit":
+      case "keyboard":
         throw new NoSpokenFormError(`Mark '${mark.type}'`);
 
       default:

packages/cursorless-engine/src/processTargets/MarkStageFactoryImpl.ts

@@ -33,6 +33,7 @@ export class MarkStageFactoryImpl implements MarkStageFactory {
         return new CursorStage(mark);
       case "that":
       case "source":
+      case "keyboard":
         return new StoredTargetStage(this.storedTargets, mark.type);
       case "decoratedSymbol":
         return new DecoratedSymbolStage(this.readableHatMap, mark);

packages/cursorless-vscode-e2e/src/suite/keyboard/basic.vscode.test.ts

@@ -20,6 +20,7 @@ suite("Basic keyboard test", async function () {
 
   test("Don't take keyboard control on startup", () => checkKeyboardStartup());
   test("Basic keyboard test", () => basic());
+  test("No automatic token expansion", () => noAutomaticTokenExpansion());
   test("Run vscode command", () => vscodeCommand());
   test("Check that entering and leaving mode is no-op", () =>
     enterAndLeaveIsNoOp());
@@ -65,6 +66,22 @@ async function basic() {
   assert.equal(editor.document.getText().trim(), "a");
 }
 
+async function noAutomaticTokenExpansion() {
+  const { hatTokenMap } = (await getCursorlessApi()).testHelpers!;
+
+  const editor = await openNewEditor("aaa");
+  await hatTokenMap.allocateHats();
+
+  editor.selection = new vscode.Selection(0, 3, 0, 3);
+
+  await vscode.commands.executeCommand("cursorless.keyboard.modal.modeOn");
+
+  // "pour"
+  await typeText("ao");
+
+  assert.isTrue(editor.selection.isEqual(new vscode.Selection(1, 0, 1, 0)));
+}
+
 async function vscodeCommand() {
   const { hatTokenMap } = (await getCursorlessApi()).testHelpers!;
 

packages/cursorless-vscode/src/keyboard/KeyboardCommandHandler.ts

@@ -75,7 +75,7 @@ export class KeyboardCommandHandler {
   }: {
     actionName: SimpleKeyboardActionType;
   }) {
-    this.targeted.performActionOnTarget(actionName);
+    this.targeted.performSimpleActionOnTarget(actionName);
   }
 
   modifyTargetContainingScope(arg: { scopeType: ScopeType }) {