Implemented head tail modifier that works on multiple scope types

Author: pokey

src/processTargets/modifiers/HeadTailStage.ts

@@ -1,22 +1,40 @@
-import { Position, Range, TextEditor } from "vscode";
+import { Range, TextEditor } from "vscode";
 import { Target } from "../../typings/target.types";
 import {
   HeadModifier,
   TailModifier,
 } from "../../typings/targetDescriptor.types";
 import { ProcessedTargetsContext } from "../../typings/Types";
 import { ModifierStage } from "../PipelineStages.types";
-import TokenTarget from "../targets/TokenTarget";
+import PlainTarget from "../targets/PlainTarget";
+import { toLineTarget } from "./scopeTypeStages/LineStage";
 
 abstract class HeadTailStage implements ModifierStage {
-  abstract update(editor: TextEditor, range: Range): Range;
+  abstract update(
+    editor: TextEditor,
+    previousRange: Range,
+    nextRange: Range
+  ): Range;
 
   constructor(private isReversed: boolean) {}
 
   run(context: ProcessedTargetsContext, target: Target): Target[] {
-    const contentRange = this.update(target.editor, target.contentRange);
+    const { previousRange, nextRange } = (() => {
+      if (target.previousTarget != null) {
+        return {
+          previousRange: target.previousTarget.contentRange,
+          nextRange: target.contentRange,
+        };
+      }
+      return {
+        previousRange: target.contentRange,
+        nextRange: toLineTarget(target).contentRange,
+      };
+    })();
+
+    const contentRange = this.update(target.editor, previousRange, nextRange);
     return [
-      new TokenTarget({
+      new PlainTarget({
         editor: target.editor,
         isReversed: this.isReversed,
         contentRange,
@@ -30,8 +48,8 @@ export class HeadStage extends HeadTailStage {
     super(true);
   }
 
-  update(editor: TextEditor, range: Range) {
-    return new Range(new Position(range.start.line, 0), range.end);
+  update(editor: TextEditor, previousRange: Range, nextRange: Range) {
+    return new Range(nextRange.start, previousRange.end);
   }
 }
 
@@ -40,7 +58,7 @@ export class TailStage extends HeadTailStage {
     super(false);
   }
 
-  update(editor: TextEditor, range: Range) {
-    return new Range(range.start, editor.document.lineAt(range.end).range.end);
+  update(editor: TextEditor, previousRange: Range, nextRange: Range) {
+    return new Range(previousRange.start, nextRange.end);
   }
 }

src/processTargets/modifiers/OrdinalRangeSubTokenStage.ts

@@ -130,6 +130,7 @@ export default class OrdinalRangeSubTokenStage implements ModifierStage {
         insertionDelimiter,
         leadingDelimiterRange,
         trailingDelimiterRange,
+        previousTarget: target,
       }),
     ];
   }

src/processTargets/modifiers/SurroundingPairStage.ts

@@ -50,6 +50,7 @@ function processedSurroundingPairTarget(
       ...pairInfo,
       editor: target.editor,
       isReversed: target.isReversed,
+      previousTarget: target,
     }),
   ];
 }

src/processTargets/modifiers/scopeTypeStages/ContainingSyntaxScopeStage.ts

@@ -32,10 +32,12 @@ export default class implements ModifierStage {
   ) {}
 
   run(context: ProcessedTargetsContext, target: Target): ScopeTypeTarget[] {
+    const isEveryScope = this.modifier.type === "everyScope";
+
     const nodeMatcher = getNodeMatcher(
       target.editor.document.languageId,
       this.modifier.scopeType.type,
-      this.modifier.type === "everyScope"
+      isEveryScope
     );
 
     const node: SyntaxNode | null = context.getNodeAtLocation(
@@ -82,6 +84,7 @@ export default class implements ModifierStage {
         delimiter: containingListDelimiter,
         leadingDelimiterRange,
         trailingDelimiterRange,
+        previousTarget: isEveryScope ? undefined : target,
       });
     });
   }

src/processTargets/modifiers/scopeTypeStages/DocumentStage.ts

@@ -17,6 +17,7 @@ export default class implements ModifierStage {
         editor: target.editor,
         isReversed: target.isReversed,
         contentRange: getDocumentRange(target.editor),
+        previousTarget: target,
       }),
     ];
   }

src/processTargets/modifiers/scopeTypeStages/LineStage.ts

@@ -47,11 +47,12 @@ export default class implements ModifierStage {
 }
 
 export function toLineTarget(target: Target): LineTarget {
-  return createLineTarget(
-    target.editor,
-    target.contentRange,
-    target.isReversed
-  );
+  return new LineTarget({
+    editor: target.editor,
+    isReversed: target.isReversed,
+    contentRange: fitRangeToLineContent(target.editor, target.contentRange),
+    previousTarget: target,
+  });
 }
 
 export function createLineTarget(

src/processTargets/modifiers/scopeTypeStages/ParagraphStage.ts

@@ -72,14 +72,16 @@ export default class implements ModifierStage {
   }
 
   getSingleTarget(target: Target): ParagraphTarget {
-    return this.getTargetFromRange(target);
+    const range = calculateRange(target);
+    return new ParagraphTarget({
+      editor: target.editor,
+      isReversed: target.isReversed,
+      contentRange: fitRangeToLineContent(target.editor, range),
+      previousTarget: target,
+    });
   }
 
-  getTargetFromRange(target: Target, range?: Range): ParagraphTarget {
-    if (range == null) {
-      range = calculateRange(target);
-    }
-
+  getTargetFromRange(target: Target, range: Range): ParagraphTarget {
     return new ParagraphTarget({
       editor: target.editor,
       isReversed: target.isReversed,

src/processTargets/modifiers/scopeTypeStages/RegexStage.ts

@@ -60,7 +60,13 @@ class RegexStage implements ModifierStage {
     const start = this.getMatchForPos(editor, target.contentRange.start).start;
     const end = this.getMatchForPos(editor, target.contentRange.end).end;
     const contentRange = new Range(start, end);
-    return this.getTargetFromRange(target, contentRange);
+    return new ScopeTypeTarget({
+      scopeTypeType: this.modifier.scopeType.type,
+      editor: target.editor,
+      isReversed: target.isReversed,
+      contentRange,
+      previousTarget: target,
+    });
   }
 
   getTargetFromRange(target: Target, range: Range): ScopeTypeTarget {

src/processTargets/targets/BaseTarget.ts

@@ -15,6 +15,7 @@ export interface CommonTargetParameters {
   readonly isReversed: boolean;
   readonly contentRange: Range;
   readonly thatTarget?: Target;
+  readonly previousTarget?: Target;
 }
 
 export interface CloneWithParameters {
@@ -35,6 +36,7 @@ export default abstract class BaseTarget implements Target {
       isReversed: parameters.isReversed,
       contentRange: parameters.contentRange,
       thatTarget: parameters.thatTarget,
+      previousTarget: parameters.previousTarget,
     };
   }
 
@@ -51,6 +53,10 @@ export default abstract class BaseTarget implements Target {
       : this;
   }
 
+  get previousTarget(): Target | undefined {
+    return this.state.previousTarget;
+  }
+
   get contentText(): string {
     return this.editor.document.getText(this.contentRange);
   }

src/processTargets/targets/SurroundingPairTarget.ts

@@ -52,6 +52,7 @@ export default class SurroundingPairTarget extends BaseTarget {
         editor: this.editor,
         isReversed: this.isReversed,
         contentRange: this.interiorRange_,
+        previousTarget: this.previousTarget,
       }),
     ];
   }

src/test/suite/fixtures/recorded/compoundTargets/takeLineVestAndAir.yml

@@ -31,4 +31,6 @@ finalState:
   thatMark:
     - anchor: {line: 0, character: 4}
       active: {line: 0, character: 17}
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 17}
 fullTargets: [{type: list, elements: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: v}, selectionType: line, position: contents, insideOutsideType: inside, modifier: {type: identity}}, {type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: a}, selectionType: line, position: contents, insideOutsideType: inside, modifier: {type: identity}}]}]

src/test/suite/fixtures/recorded/selectionTypes/clearHeadCore.yml

@@ -0,0 +1,26 @@
+languageId: plaintext
+command:
+  spokenForm: clear head core
+  version: 2
+  targets:
+    - type: primitive
+      modifiers:
+        - {type: head}
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: foo(bar baz)
+  selections:
+    - anchor: {line: 0, character: 10}
+      active: {line: 0, character: 10}
+  marks: {}
+finalState:
+  documentContents: foo(z)
+  selections:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}
+  thatMark:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: head}, {type: interiorOnly}]}]

src/test/suite/fixtures/recorded/selectionTypes/clearHeadFunk.yml

@@ -0,0 +1,32 @@
+languageId: typescript
+command:
+  spokenForm: clear head funk
+  version: 2
+  targets:
+    - type: primitive
+      modifiers:
+        - {type: head}
+        - type: containingScope
+          scopeType: {type: namedFunction}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: |-
+    function whatever() {
+        
+    }
+  selections:
+    - anchor: {line: 1, character: 4}
+      active: {line: 1, character: 4}
+  marks: {}
+finalState:
+  documentContents: |-
+
+    }
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  thatMark:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: head}, {type: containingScope, scopeType: {type: namedFunction}}]}]

src/typings/target.types.ts

@@ -46,6 +46,8 @@ export interface Target {
   /** Internal target that should be used for the that mark */
   readonly thatTarget: Target;
 
+  readonly previousTarget: Target | undefined;
+
   getInteriorStrict(): Target[];
   getBoundaryStrict(): Target[];
   /** The range of the delimiter before the content selection */