Migrating scope stages into handlers

src/actions/GenerateSnippet/GenerateSnippet.ts

@@ -5,7 +5,7 @@ import { Offsets } from "../../processTargets/modifiers/surroundingPair/types";
 import isTesting from "../../testUtil/isTesting";
 import { Target } from "../../typings/target.types";
 import { Graph } from "../../typings/Types";
-import { getDocumentRange } from "../../util/range";
+import { getDocumentRange } from "../../util/rangeUtils";
 import { selectionFromRange } from "../../util/selectionUtils";
 import { Action, ActionReturnValue } from "../actions.types";
 import { constructSnippetBody } from "./constructSnippetBody";

src/processTargets/modifiers/getLegacyScopeStage.ts

@@ -10,7 +10,6 @@ import ContainingSyntaxScopeStage, {
   SimpleContainingScopeModifier,
   SimpleEveryScopeModifier,
 } from "./scopeTypeStages/ContainingSyntaxScopeStage";
-import DocumentStage from "./scopeTypeStages/DocumentStage";
 import NotebookCellStage from "./scopeTypeStages/NotebookCellStage";
 import ParagraphStage from "./scopeTypeStages/ParagraphStage";
 import {
@@ -40,8 +39,6 @@ export default function getLegacyScopeStage(
   switch (modifier.scopeType.type) {
     case "notebookCell":
       return new NotebookCellStage(modifier);
-    case "document":
-      return new DocumentStage(modifier);
     case "paragraph":
       return new ParagraphStage(modifier);
     case "nonWhitespaceSequence":

src/processTargets/modifiers/scopeHandlers/DocumentScopeHandler.ts

@@ -0,0 +1,71 @@
+import { Position, Range, TextEditor } from "vscode";
+import { Direction, ScopeType } from "../../../typings/targetDescriptor.types";
+import { getDocumentRange } from "../../../util/rangeUtils";
+import { DocumentTarget } from "../../targets";
+import { OutOfRangeError } from "../targetSequenceUtils";
+import NotHierarchicalScopeError from "./NotHierarchicalScopeError";
+import { IterationScope, TargetScope } from "./scope.types";
+import { ScopeHandler } from "./scopeHandler.types";
+
+export default class DocumentScopeHandler implements ScopeHandler {
+  iterationScopeType = undefined;
+
+  constructor(public scopeType: ScopeType, private languageId: string) {}
+
+  getScopesTouchingPosition(
+    editor: TextEditor,
+    position: Position,
+    ancestorIndex: number = 0
+  ): TargetScope[] {
+    if (ancestorIndex !== 0) {
+      throw new NotHierarchicalScopeError(this.scopeType);
+    }
+
+    return this.getIterationScope(editor).getScopes();
+  }
+
+  getScopesOverlappingRange(editor: TextEditor, _range: Range): TargetScope[] {
+    return this.getIterationScope(editor).getScopes();
+  }
+
+  getIterationScopesTouchingPosition(
+    editor: TextEditor,
+    _position: Position
+  ): IterationScope[] {
+    return [this.getIterationScope(editor)];
+  }
+
+  getScopeRelativeToPosition(
+    editor: TextEditor,
+    position: Position,
+    offset: number,
+    _direction: Direction
+  ): TargetScope {
+    if (offset === 0) {
+      return this.getIterationScope(editor).getScopes()[0];
+    }
+
+    throw new OutOfRangeError();
+  }
+
+  private getIterationScope(editor: TextEditor): IterationScope {
+    const contentRange = getDocumentRange(editor.document);
+
+    return {
+      editor,
+      domain: contentRange,
+      getScopes: () => [
+        {
+          editor,
+          domain: contentRange,
+          getTarget: (isReversed) =>
+            new DocumentTarget({
+              editor,
+              isReversed,
+              contentRange,
+            }),
+        },
+      ],
+    };
+  }
+}

src/processTargets/modifiers/scopeHandlers/LineScopeHandler.ts

@@ -1,7 +1,7 @@
 import { range } from "lodash";
 import { Position, Range, TextEditor } from "vscode";
-import { Direction } from "../../../typings/targetDescriptor.types";
-import { getDocumentRange } from "../../../util/range";
+import { Direction, ScopeType } from "../../../typings/targetDescriptor.types";
+import { getDocumentRange } from "../../../util/rangeUtils";
 import { LineTarget } from "../../targets";
 import { OutOfRangeError } from "../targetSequenceUtils";
 import NotHierarchicalScopeError from "./NotHierarchicalScopeError";
@@ -12,7 +12,7 @@ export default class LineScopeHandler implements ScopeHandler {
   public readonly iterationScopeType = { type: "document" } as const;
 
   constructor(
-    public readonly scopeType: { type: "line" },
+    public readonly scopeType: ScopeType,
     protected languageId: string
   ) {}
 

src/processTargets/modifiers/scopeHandlers/getScopeHandler.ts

@@ -1,5 +1,6 @@
 import {
   CharacterScopeHandler,
+  DocumentScopeHandler,
   IdentifierScopeHandler,
   LineScopeHandler,
   TokenScopeHandler,
@@ -39,7 +40,9 @@ export default function getScopeHandler(
     case "identifier":
       return new IdentifierScopeHandler(scopeType, languageId);
     case "line":
-      return new LineScopeHandler(scopeType as { type: "line" }, languageId);
+      return new LineScopeHandler(scopeType, languageId);
+    case "document":
+      return new DocumentScopeHandler(scopeType, languageId);
     default:
       return undefined;
   }

src/processTargets/modifiers/scopeHandlers/index.ts

@@ -10,5 +10,7 @@ export * from "./WordScopeHandler";
 export { default as WordScopeHandler } from "./WordScopeHandler";
 export * from "./TokenScopeHandler";
 export { default as TokenScopeHandler } from "./TokenScopeHandler";
+export * from "./DocumentScopeHandler";
+export { default as DocumentScopeHandler } from "./DocumentScopeHandler";
 export * from "./getScopeHandler";
 export { default as getScopeHandler } from "./getScopeHandler";

src/testUtil/TestCaseRecorder.ts

@@ -8,7 +8,7 @@ import HatTokenMap from "../core/HatTokenMap";
 import { injectSpyIde, SpyInfo } from "../ide/spies/SpyIDE";
 import { DecoratedSymbolMark } from "../typings/targetDescriptor.types";
 import { Graph } from "../typings/Types";
-import { getDocumentRange } from "../util/range";
+import { getDocumentRange } from "../util/rangeUtils";
 import sleep from "../util/sleep";
 import { extractTargetedMarks } from "./extractTargetedMarks";
 import serialize from "./serialize";

src/util/rangeUtils.ts

@@ -1,4 +1,4 @@
-import { Position, Range, TextEditor } from "vscode";
+import { Position, Range, TextDocument, TextEditor } from "vscode";
 
 export function isAtEndOfLine(editor: TextEditor, position: Position) {
   const endLine = editor.document.lineAt(position);
@@ -50,3 +50,16 @@ export function getRangeLength(editor: TextEditor, range: Range) {
 export function strictlyContains(range1: Range, range2: Range): boolean {
   return range1.start.isBefore(range2.start) && range1.end.isAfter(range2.end);
 }
+
+/**
+ * Get a range that corresponds to the entire contents of the given document.
+ *
+ * @param document The document to consider
+ * @returns A range corresponding to the entire document contents
+ */
+export function getDocumentRange(document: TextDocument) {
+  return new Range(
+    new Position(0, 0),
+    document.lineAt(document.lineCount - 1).range.end
+  );
+}