Add factories for stages and scope handlers

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

@@ -1,5 +1,6 @@
 import { Snippets } from "../core/Snippets";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
+import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
 import { Bring, Move, Swap } from "./BringMoveSwap";
 import Call from "./Call";
 import Clear from "./Clear";
@@ -58,16 +59,28 @@ import { ActionRecord } from "./actions.types";
  * Keeps a map from action names to objects that implement the given action
  */
 export class Actions implements ActionRecord {
-  constructor(private snippets: Snippets, private rangeUpdater: RangeUpdater) {}
+  constructor(
+    private snippets: Snippets,
+    private rangeUpdater: RangeUpdater,
+    private modifierStageFactory: ModifierStageFactory,
+  ) {}
 
   callAsFunction = new Call(this);
   clearAndSetSelection = new Clear(this);
   copyToClipboard = new CopyToClipboard(this.rangeUpdater);
   cutToClipboard = new CutToClipboard(this);
   deselect = new Deselect();
-  editNew = new EditNew(this.rangeUpdater, this);
-  editNewLineAfter = new EditNewAfter(this.rangeUpdater, this);
-  editNewLineBefore = new EditNewBefore(this.rangeUpdater, this);
+  editNew = new EditNew(this.rangeUpdater, this, this.modifierStageFactory);
+  editNewLineAfter = new EditNewAfter(
+    this.rangeUpdater,
+    this,
+    this.modifierStageFactory,
+  );
+  editNewLineBefore = new EditNewBefore(
+    this.rangeUpdater,
+    this,
+    this.modifierStageFactory,
+  );
   executeCommand = new ExecuteCommand(this.rangeUpdater);
   extractVariable = new ExtractVariable(this.rangeUpdater);
   findInWorkspace = new FindInWorkspace(this);
@@ -77,12 +90,23 @@ export class Actions implements ActionRecord {
   getText = new GetText();
   highlight = new Highlight();
   indentLine = new IndentLine(this.rangeUpdater);
-  insertCopyAfter = new InsertCopyAfter(this.rangeUpdater);
-  insertCopyBefore = new InsertCopyBefore(this.rangeUpdater);
+  insertCopyAfter = new InsertCopyAfter(
+    this.rangeUpdater,
+    this.modifierStageFactory,
+  );
+  insertCopyBefore = new InsertCopyBefore(
+    this.rangeUpdater,
+    this.modifierStageFactory,
+  );
   insertEmptyLineAfter = new InsertEmptyLineAfter(this.rangeUpdater);
   insertEmptyLineBefore = new InsertEmptyLineBefore(this.rangeUpdater);
   insertEmptyLinesAround = new InsertEmptyLinesAround(this.rangeUpdater);
-  insertSnippet = new InsertSnippet(this.rangeUpdater, this.snippets, this);
+  insertSnippet = new InsertSnippet(
+    this.rangeUpdater,
+    this.snippets,
+    this,
+    this.modifierStageFactory,
+  );
   moveToTarget = new Move(this.rangeUpdater);
   outdentLine = new OutdentLine(this.rangeUpdater);
   pasteFromClipboard = new PasteFromClipboard(this.rangeUpdater, this);
@@ -94,7 +118,10 @@ export class Actions implements ActionRecord {
   revealDefinition = new RevealDefinition(this.rangeUpdater);
   revealTypeDefinition = new RevealTypeDefinition(this.rangeUpdater);
   reverseTargets = new Reverse(this);
-  rewrapWithPairedDelimiter = new Rewrap(this.rangeUpdater);
+  rewrapWithPairedDelimiter = new Rewrap(
+    this.rangeUpdater,
+    this.modifierStageFactory,
+  );
   scrollToBottom = new ScrollToBottom();
   scrollToCenter = new ScrollToCenter();
   scrollToTop = new ScrollToTop();
@@ -107,9 +134,13 @@ export class Actions implements ActionRecord {
   showReferences = new ShowReferences(this.rangeUpdater);
   sortTargets = new Sort(this);
   swapTargets = new Swap(this.rangeUpdater);
-  toggleLineBreakpoint = new ToggleBreakpoint();
+  toggleLineBreakpoint = new ToggleBreakpoint(this.modifierStageFactory);
   toggleLineComment = new ToggleLineComment(this.rangeUpdater);
   unfoldRegion = new Unfold(this.rangeUpdater);
   wrapWithPairedDelimiter = new Wrap(this.rangeUpdater);
-  wrapWithSnippet = new WrapWithSnippet(this.rangeUpdater, this.snippets);
+  wrapWithSnippet = new WrapWithSnippet(
+    this.rangeUpdater,
+    this.snippets,
+    this.modifierStageFactory,
+  );
 }

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

@@ -1,6 +1,7 @@
 import { RangeUpdater } from "../../core/updateSelections/RangeUpdater";
-import { containingLineIfUntypedStage } from "../../processTargets/modifiers/commonContainingScopeIfUntypedStages";
+import { containingLineIfUntypedModifier } from "../../processTargets/modifiers/commonContainingScopeIfUntypedModifiers";
 import PositionStage from "../../processTargets/modifiers/PositionStage";
+import { ModifierStageFactory } from "../../processTargets/ModifierStageFactory";
 import { ModifierStage } from "../../processTargets/PipelineStages.types";
 import { ide } from "../../singletons/ide.singleton";
 import { Target } from "../../typings/target.types";
@@ -15,10 +16,14 @@ import { runEditNewNotebookCellTargets } from "./runNotebookCellTargets";
 
 export class EditNew implements Action {
   getFinalStages(): ModifierStage[] {
-    return [containingLineIfUntypedStage];
+    return [this.modifierStageFactory.create(containingLineIfUntypedModifier)];
   }
 
-  constructor(private rangeUpdater: RangeUpdater, private actions: Actions) {
+  constructor(
+    private rangeUpdater: RangeUpdater,
+    private actions: Actions,
+    private modifierStageFactory: ModifierStageFactory,
+  ) {
     this.run = this.run.bind(this);
   }
 

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

@@ -8,17 +8,24 @@ import {
 import { flatten, zip } from "lodash";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import { performEditsAndUpdateSelectionsWithBehavior } from "../core/updateSelections/updateSelections";
-import { containingLineIfUntypedStage } from "../processTargets/modifiers/commonContainingScopeIfUntypedStages";
+import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
+import { containingLineIfUntypedModifier } from "../processTargets/modifiers/commonContainingScopeIfUntypedModifiers";
 import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import { setSelectionsWithoutFocusingEditor } from "../util/setSelectionsAndFocusEditor";
 import { createThatMark, runOnTargetsForEachEditor } from "../util/targetUtils";
 import { Action, ActionReturnValue } from "./actions.types";
 
 class InsertCopy implements Action {
-  getFinalStages = () => [containingLineIfUntypedStage];
+  getFinalStages = () => [
+    this.modifierStageFactory.create(containingLineIfUntypedModifier),
+  ];
 
-  constructor(private rangeUpdater: RangeUpdater, private isBefore: boolean) {
+  constructor(
+    private rangeUpdater: RangeUpdater,
+    private modifierStageFactory: ModifierStageFactory,
+    private isBefore: boolean,
+  ) {
     this.run = this.run.bind(this);
     this.runForEditor = this.runForEditor.bind(this);
   }
@@ -90,13 +97,19 @@ class InsertCopy implements Action {
 }
 
 export class CopyContentBefore extends InsertCopy {
-  constructor(rangeUpdater: RangeUpdater) {
-    super(rangeUpdater, true);
+  constructor(
+    rangeUpdater: RangeUpdater,
+    modifierStageFactory: ModifierStageFactory,
+  ) {
+    super(rangeUpdater, modifierStageFactory, true);
   }
 }
 
 export class CopyContentAfter extends InsertCopy {
-  constructor(rangeUpdater: RangeUpdater) {
-    super(rangeUpdater, false);
+  constructor(
+    rangeUpdater: RangeUpdater,
+    modifierStageFactory: ModifierStageFactory,
+  ) {
+    super(rangeUpdater, modifierStageFactory, false);
   }
 }

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

@@ -11,6 +11,7 @@ import {
   callFunctionAndUpdateSelectionInfos,
   getSelectionInfo,
 } from "../core/updateSelections/updateSelections";
+import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
 import { ModifyIfUntypedExplicitStage } from "../processTargets/modifiers/ConditionalModifierStages";
 import { ide } from "../singletons/ide.singleton";
 import {
@@ -43,6 +44,7 @@ export default class InsertSnippet implements Action {
     private rangeUpdater: RangeUpdater,
     private snippets: Snippets,
     private actions: Actions,
+    private modifierStageFactory: ModifierStageFactory,
   ) {
     this.run = this.run.bind(this);
   }
@@ -53,7 +55,7 @@ export default class InsertSnippet implements Action {
     return defaultScopeTypes.length === 0
       ? []
       : [
-          new ModifyIfUntypedExplicitStage({
+          new ModifyIfUntypedExplicitStage(this.modifierStageFactory, {
             type: "cascading",
             modifiers: defaultScopeTypes.map((scopeType) => ({
               type: "containingScope",

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

@@ -1,7 +1,8 @@
 import { FlashStyle } from "@cursorless/common";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import { performEditsAndUpdateRanges } from "../core/updateSelections/updateSelections";
-import { containingSurroundingPairIfUntypedStage } from "../processTargets/modifiers/commonContainingScopeIfUntypedStages";
+import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
+import { containingSurroundingPairIfUntypedModifier } from "../processTargets/modifiers/commonContainingScopeIfUntypedModifiers";
 import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import {
@@ -12,9 +13,16 @@ import {
 import { Action, ActionReturnValue } from "./actions.types";
 
 export default class Rewrap implements Action {
-  getFinalStages = () => [containingSurroundingPairIfUntypedStage];
+  getFinalStages = () => [
+    this.modifierStageFactory.create(
+      containingSurroundingPairIfUntypedModifier,
+    ),
+  ];
 
-  constructor(private rangeUpdater: RangeUpdater) {
+  constructor(
+    private rangeUpdater: RangeUpdater,
+    private modifierStageFactory: ModifierStageFactory,
+  ) {
     this.run = this.run.bind(this);
   }
 

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

@@ -1,14 +1,17 @@
+import { BreakpointDescriptor, FlashStyle } from "@cursorless/common";
+import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
+import { containingLineIfUntypedModifier } from "../processTargets/modifiers/commonContainingScopeIfUntypedModifiers";
 import { ide } from "../singletons/ide.singleton";
-import { containingLineIfUntypedStage } from "../processTargets/modifiers/commonContainingScopeIfUntypedStages";
 import { Target } from "../typings/target.types";
 import { flashTargets, runOnTargetsForEachEditor } from "../util/targetUtils";
 import { Action, ActionReturnValue } from "./actions.types";
-import { BreakpointDescriptor, FlashStyle } from "@cursorless/common";
 
 export default class ToggleBreakpoint implements Action {
-  getFinalStages = () => [containingLineIfUntypedStage];
+  getFinalStages = () => [
+    this.modifierStageFactory.create(containingLineIfUntypedModifier),
+  ];
 
-  constructor() {
+  constructor(private modifierStageFactory: ModifierStageFactory) {
     this.run = this.run.bind(this);
   }
 

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

@@ -2,6 +2,7 @@ import { FlashStyle, ScopeType } from "@cursorless/common";
 import { Snippets } from "../core/Snippets";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import { callFunctionAndUpdateSelections } from "../core/updateSelections/updateSelections";
+import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
 import { ModifyIfUntypedStage } from "../processTargets/modifiers/ConditionalModifierStages";
 import { ide } from "../singletons/ide.singleton";
 import {
@@ -29,7 +30,11 @@ type WrapWithSnippetArg = NamedSnippetArg | CustomSnippetArg;
 export default class WrapWithSnippet implements Action {
   private snippetParser = new SnippetParser();
 
-  constructor(private rangeUpdater: RangeUpdater, private snippets: Snippets) {
+  constructor(
+    private rangeUpdater: RangeUpdater,
+    private snippets: Snippets,
+    private modifierStageFactory: ModifierStageFactory,
+  ) {
     this.run = this.run.bind(this);
   }
 
@@ -41,7 +46,7 @@ export default class WrapWithSnippet implements Action {
     }
 
     return [
-      new ModifyIfUntypedStage({
+      new ModifyIfUntypedStage(this.modifierStageFactory, {
         type: "modifyIfUntyped",
         modifier: {
           type: "containingScope",

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

@@ -9,25 +9,26 @@ import { ActionRecord } from "../../actions/actions.types";
 // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
 import { Actions } from "../../actions/Actions";
 import { TestCaseRecorder } from "../../index";
-import processTargets from "../../processTargets";
+import { TargetPipeline } from "../../processTargets";
+import { MarkStageFactory } from "../../processTargets/MarkStageFactory";
+import { ModifierStageFactory } from "../../processTargets/ModifierStageFactory";
 import { ide } from "../../singletons/ide.singleton";
-import { Target } from "../../typings/target.types";
 import { TreeSitter } from "../../typings/TreeSitter";
 import {
   ProcessedTargetsContext,
   SelectionWithEditor,
 } from "../../typings/Types";
+import { Target } from "../../typings/target.types";
 import { isString } from "../../util/type";
+import { Debug } from "../Debug";
+import { ThatMark } from "../ThatMark";
 import {
   canonicalizeAndValidateCommand,
   checkForOldInference,
 } from "../commandVersionUpgrades/canonicalizeAndValidateCommand";
-import { Debug } from "../Debug";
 import inferFullTargets from "../inferFullTargets";
-import { ThatMark } from "../ThatMark";
 import { selectionToThatTarget } from "./selectionToThatTarget";
 
-// TODO: Do this using the graph once we migrate its dependencies onto the graph
 export class CommandRunner {
   constructor(
     private treeSitter: TreeSitter,
@@ -37,6 +38,8 @@ export class CommandRunner {
     private actions: ActionRecord,
     private thatMark: ThatMark,
     private sourceMark: ThatMark,
+    private modifierStageFactory: ModifierStageFactory,
+    private markStageFactory: MarkStageFactory,
   ) {
     this.runCommandBackwardCompatible =
       this.runCommandBackwardCompatible.bind(this);
@@ -137,11 +140,17 @@ export class CommandRunner {
       // warning.
       checkForOldInference(partialTargetDescriptors);
 
-      const targets = processTargets(
+      // FIXME: Construct this on a per-request basis in the composition root.
+      // Then we don't need `CommandRunner` to depend on these factories and be
+      // tightly coupled to `TargetPipeline`.
+      const pipeline = new TargetPipeline(
+        this.modifierStageFactory,
+        this.markStageFactory,
         processedTargetsContext,
-        targetDescriptors,
       );
 
+      const targets = pipeline.processTargets(targetDescriptors);
+
       const {
         returnValue,
         thatSelections: newThatSelections,

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -5,6 +5,9 @@ import { Debug } from "./core/Debug";
 import { HatTokenMapImpl } from "./core/HatTokenMapImpl";
 import { Snippets } from "./core/Snippets";
 import { RangeUpdater } from "./core/updateSelections/RangeUpdater";
+import { MarkStageFactoryImpl } from "./processTargets/MarkStageFactoryImpl";
+import { ModifierStageFactoryImpl } from "./processTargets/ModifierStageFactoryImpl";
+import { ScopeHandlerFactoryImpl } from "./processTargets/modifiers/scopeHandlers";
 import { injectIde } from "./singletons/ide.singleton";
 
 export function createCursorlessEngine(
@@ -33,7 +36,12 @@ export function createCursorlessEngine(
 
   const testCaseRecorder = new TestCaseRecorder(hatTokenMap);
 
-  const actions = new Actions(snippets, rangeUpdater);
+  const scopeHandlerFactory = new ScopeHandlerFactoryImpl();
+  const markStageFactory = new MarkStageFactoryImpl();
+  const modifierStageFactory = new ModifierStageFactoryImpl(
+    scopeHandlerFactory,
+  );
+  const actions = new Actions(snippets, rangeUpdater, modifierStageFactory);
 
   const thatMark = new ThatMark();
   const sourceMark = new ThatMark();
@@ -46,6 +54,8 @@ export function createCursorlessEngine(
     actions,
     thatMark,
     sourceMark,
+    modifierStageFactory,
+    markStageFactory,
   );
 
   return {

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

@@ -0,0 +1,6 @@
+import { Mark } from "@cursorless/common";
+import { MarkStage } from "./PipelineStages.types";
+
+export interface MarkStageFactory {
+  create(mark: Mark): MarkStage;
+}