Started working on target type

Author: AndreasArvidsson

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

@@ -21,7 +21,7 @@ export class CutToClipboard implements SimpleAction {
         const { editor, contentRange } = target;
         const removalHighlightRange = target.getRemovalHighlightRange();
 
-        if (target.isLine) {
+        if (isLine(target)) {
           return [
             {
               editor,
@@ -63,6 +63,11 @@ export class CutToClipboard implements SimpleAction {
   }
 }
 
+function isLine(target: Target): boolean {
+  const { type } = target;
+  return type === "line" || type === "paragraph" || type === "document";
+}
+
 /** Get the possible leading and trailing overflow ranges of the outside range compared to the inside range */
 function getOutsideOverflow(insideRange: Range, outsideRange: Range): Range[] {
   const { start: insideStart, end: insideEnd } = insideRange;

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

@@ -18,7 +18,7 @@ export class EditNew {
   }
 
   async run(destinations: Destination[]): Promise<ActionReturnValue> {
-    if (destinations.some(({ target }) => target.isNotebookCell)) {
+    if (destinations.some(({ target }) => target.type === "notebookCell")) {
       // It is not possible to "pour" a notebook cell and something else,
       // because each notebook cell is its own editor, and you can't have
       // cursors in multiple editors.

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

@@ -142,6 +142,11 @@ function constructChangeEdit(
 ): EditWithFlashType {
   return {
     ...target.toDestination(insertionMode).constructChangeEdit("", true),
-    isLine: target.isLine,
+    isLine: isLine(target),
   };
 }
+
+function isLine(target: Target): boolean {
+  const { type } = target;
+  return type === "line" || type === "paragraph" || type === "document";
+}

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

@@ -25,7 +25,7 @@ export default class ToggleBreakpoint implements SimpleAction {
       const breakpointDescriptors: BreakpointDescriptor[] = targets.map(
         (target) => {
           const range = target.contentRange;
-          return target.isLine
+          return isLine(target)
             ? {
                 type: "line",
                 startLine: range.start.line,
@@ -48,3 +48,8 @@ export default class ToggleBreakpoint implements SimpleAction {
     };
   }
 }
+
+function isLine(target: Target): boolean {
+  const { type } = target;
+  return type === "line" || type === "paragraph" || type === "document";
+}

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

@@ -48,7 +48,7 @@ export function createContinuousRangeTarget(
     }
   }
 
-  if (startTarget.isLine && endTarget.isLine) {
+  if (isLine(startTarget) && isLine(endTarget)) {
     return new LineTarget({
       editor: startTarget.editor,
       isReversed,
@@ -71,7 +71,17 @@ export function createContinuousRangeTarget(
       includeStart,
       includeEnd,
     ),
-    isToken:
-      includeStart && includeEnd && startTarget.isToken && endTarget.isToken,
+    type:
+      includeStart &&
+      includeEnd &&
+      startTarget.type === "token" &&
+      endTarget.type === "token"
+        ? "token"
+        : "character",
   });
 }
+
+function isLine(target: Target): boolean {
+  const { type } = target;
+  return type === "line" || type === "paragraph" || type === "document";
+}

packages/cursorless-engine/src/processTargets/marks/CursorStage.ts

@@ -13,7 +13,7 @@ export class CursorStage implements MarkStage {
           isReversed: selection.selection.isReversed,
           contentRange: selection.selection,
           hasExplicitRange: !selection.selection.isEmpty,
-          isToken: false,
+          type: "character",
         }),
     );
   }

packages/cursorless-engine/src/processTargets/modifiers/InstanceStage.ts

@@ -135,7 +135,7 @@ export class InstanceStage implements ModifierStage {
           contentRange: range,
           editor,
           isReversed: false,
-          isToken: false,
+          type: "character",
         }),
     );
 
@@ -182,19 +182,16 @@ export class InstanceStage implements ModifierStage {
 }
 
 function getFilterScopeType(target: Target): ScopeType | null {
-  if (target.isLine) {
-    return { type: "line" };
+  switch (target.type) {
+    case "line":
+      return { type: "line" };
+    case "token":
+      return { type: "token" };
+    case "word":
+      return { type: "word" };
+    default:
+      return null;
   }
-
-  if (target.isToken) {
-    return { type: "token" };
-  }
-
-  if (target.isWord) {
-    return { type: "word" };
-  }
-
-  return null;
 }
 
 /**

packages/cursorless-engine/src/processTargets/modifiers/PositionStage.ts

@@ -15,7 +15,7 @@ abstract class PositionStage implements ModifierStage {
     return [
       target.isRaw
         ? new RawSelectionTarget(parameters)
-        : new PlainTarget({ ...parameters, isToken: false }),
+        : new PlainTarget({ ...parameters, type: "character" }),
     ];
   }
 

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/CharacterScopeHandler.ts

@@ -39,7 +39,7 @@ export class CharacterScopeHandler extends NestedScopeHandler {
             editor,
             contentRange: range,
             isReversed,
-            isToken: false,
+            type: "character",
           }),
         ],
       }),

packages/cursorless-engine/src/processTargets/targets/BaseTarget.ts

@@ -13,6 +13,7 @@ import type {
   Destination,
   JoinAsType,
   Target,
+  TargetType,
 } from "../../typings/target.types";
 import { DestinationImpl } from "./DestinationImpl";
 import { createContinuousRange } from "./util/createContinuousRange";
@@ -43,17 +44,15 @@ export abstract class BaseTarget<
   in out TParameters extends MinimumTargetParameters,
 > implements Target
 {
-  protected abstract readonly type: string;
+  protected abstract readonly instanceType: string;
   protected readonly state: EnforceUndefined<CommonTargetParameters>;
-  isLine = false;
-  isToken = true;
   hasExplicitScopeType = true;
   hasExplicitRange = true;
   isRaw = false;
   isImplicit = false;
   isNotebookCell = false;
-  isWord = false;
   joinAs: JoinAsType = "line";
+  type: TargetType = "token";
 
   constructor(parameters: TParameters & CommonTargetParameters) {
     this.state = {
@@ -177,14 +176,14 @@ export abstract class BaseTarget<
    *
    * Note that this implementation is quite incomplete, but is suitable for
    * round-tripping {@link UntypedTarget} objects and capturing the fact that an
-   * object is not an un typed target if it is not, via the {@link type}
+   * object is not an un typed target if it is not, via the {@link instanceType}
    * attribute.  In the future, we should override this method in subclasses to
    * provide a more complete representation.
    * @returns A plain object representation of the target
    */
   toPlainObject(): TargetPlainObject {
     return {
-      type: this.type,
+      type: this.instanceType,
       contentRange: rangeToPlainObject(this.contentRange),
       isReversed: this.isReversed,
       hasExplicitRange: this.hasExplicitRange,