Fit interior range to content

Author: pokey

src/processTargets/targets/DocumentTarget.ts

@@ -1,7 +1,7 @@
-import { Range, TextEditor } from "vscode";
-import { fitRangeToLineContent } from "../modifiers/scopeTypeStages/LineStage";
+import { Range } from "vscode";
+import { shrinkRangeToFitContent } from "../../util/selectionUtils";
 import BaseTarget, { CommonTargetParameters } from "./BaseTarget";
-import WeakTarget from "./WeakTarget";
+import PlainTarget from "./PlainTarget";
 
 export default class DocumentTarget extends BaseTarget {
   insertionDelimiter = "\n";
@@ -23,10 +23,11 @@ export default class DocumentTarget extends BaseTarget {
 
   getInteriorStrict() {
     return [
-      new WeakTarget({
+      // Use plain target instead of interior target since we want the same content and removal range for a document interior.
+      new PlainTarget({
         editor: this.editor,
         isReversed: this.isReversed,
-        contentRange: getDocumentContentRange(this.editor),
+        contentRange: shrinkRangeToFitContent(this.editor, this.contentRange),
       }),
     ];
   }
@@ -35,31 +36,3 @@ export default class DocumentTarget extends BaseTarget {
     return this.state;
   }
 }
-
-function getDocumentContentRange(editor: TextEditor) {
-  const { document } = editor;
-  let firstLineNum = 0;
-  let lastLineNum = document.lineCount - 1;
-
-  for (let i = firstLineNum; i < document.lineCount; ++i) {
-    if (!document.lineAt(i).isEmptyOrWhitespace) {
-      firstLineNum = i;
-      break;
-    }
-  }
-
-  for (let i = lastLineNum; i > -1; --i) {
-    if (!document.lineAt(i).isEmptyOrWhitespace) {
-      lastLineNum = i;
-      break;
-    }
-  }
-
-  const firstLine = document.lineAt(firstLineNum);
-  const lastLine = document.lineAt(lastLineNum);
-
-  return fitRangeToLineContent(
-    editor,
-    new Range(firstLine.range.start, lastLine.range.end)
-  );
-}

src/processTargets/targets/InteriorTarget.ts

@@ -0,0 +1,22 @@
+import { shrinkRangeToFitContent } from "../../util/selectionUtils";
+import BaseTarget, { CommonTargetParameters } from "./BaseTarget";
+
+export default class InteriorTarget extends BaseTarget {
+  insertionDelimiter = "";
+
+  constructor(parameters: CommonTargetParameters) {
+    super(parameters);
+  }
+
+  get contentRange() {
+    return shrinkRangeToFitContent(this.editor, this.state.contentRange);
+  }
+
+  getLeadingDelimiterTarget = () => undefined;
+  getTrailingDelimiterTarget = () => undefined;
+  getRemovalRange = () => this.state.contentRange;
+
+  protected getCloneParameters() {
+    return this.state;
+  }
+}

src/processTargets/targets/SurroundingPairTarget.ts

@@ -6,8 +6,8 @@ import {
   getTokenTrailingDelimiterTarget,
 } from "../targetUtil/insertionRemovalBehaviors/TokenInsertionRemovalBehavior";
 import BaseTarget, { CommonTargetParameters } from "./BaseTarget";
+import InteriorTarget from "./InteriorTarget";
 import TokenTarget from "./TokenTarget";
-import WeakTarget from "./WeakTarget";
 
 interface SurroundingPairTargetParameters extends CommonTargetParameters {
   /**
@@ -48,7 +48,7 @@ export default class SurroundingPairTarget extends BaseTarget {
 
   getInteriorStrict() {
     return [
-      new WeakTarget({
+      new InteriorTarget({
         editor: this.editor,
         isReversed: this.isReversed,
         contentRange: this.interiorRange_,

src/test/suite/fixtures/recorded/surroundingPair/chuckCore.yml

@@ -0,0 +1,29 @@
+languageId: typescript
+command:
+  spokenForm: chuck core
+  version: 2
+  targets:
+    - type: primitive
+      modifiers:
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+  action: {name: remove}
+initialState:
+  documentContents: |-
+    [
+        "foo",
+        "bar"
+    ]
+  selections:
+    - anchor: {line: 1, character: 10}
+      active: {line: 1, character: 10}
+  marks: {}
+finalState:
+  documentContents: "[]"
+  selections:
+    - anchor: {line: 0, character: 1}
+      active: {line: 0, character: 1}
+  thatMark:
+    - anchor: {line: 0, character: 1}
+      active: {line: 0, character: 1}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: interiorOnly}]}]

src/test/suite/fixtures/recorded/surroundingPair/chuckCore2.yml

@@ -0,0 +1,25 @@
+languageId: plaintext
+command:
+  spokenForm: chuck core
+  version: 2
+  targets:
+    - type: primitive
+      modifiers:
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+  action: {name: remove}
+initialState:
+  documentContents: ( hello )
+  selections:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+  marks: {}
+finalState:
+  documentContents: ()
+  selections:
+    - anchor: {line: 0, character: 1}
+      active: {line: 0, character: 1}
+  thatMark:
+    - anchor: {line: 0, character: 1}
+      active: {line: 0, character: 1}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: interiorOnly}]}]

src/test/suite/fixtures/recorded/surroundingPair/parseTree/python/clearMatching9.yml renamed to src/test/suite/fixtures/recorded/surroundingPair/parseTree/python/clearInside.yml

@@ -1,7 +1,7 @@
 languageId: python
 command:
   version: 1
-  spokenForm: clear matching
+  spokenForm: clear inside
   action: clearAndSetSelection
   targets:
     - type: primitive
@@ -17,7 +17,9 @@ initialState:
       active: {line: 1, character: 0}
   marks: {}
 finalState:
-  documentContents: "\"\"\"\"\"\""
+  documentContents: |-
+    """
+    """
   selections:
     - anchor: {line: 0, character: 3}
       active: {line: 0, character: 3}

src/test/suite/fixtures/recorded/surroundingPair/parseTree/typescript/takeCore.yml

@@ -29,9 +29,9 @@ finalState:
         )
     }
   selections:
-    - anchor: {line: 1, character: 45}
-      active: {line: 3, character: 4}
+    - anchor: {line: 2, character: 4}
+      active: {line: 2, character: 30}
   thatMark:
-    - anchor: {line: 1, character: 45}
-      active: {line: 3, character: 4}
+    - anchor: {line: 2, character: 4}
+      active: {line: 2, character: 30}
 fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: containingScope, scopeType: {type: surroundingPair, delimiter: any}}, {type: interiorOnly}]}]

src/test/suite/fixtures/recorded/surroundingPair/takeCore.yml

@@ -0,0 +1,33 @@
+languageId: typescript
+command:
+  spokenForm: take core
+  version: 2
+  targets:
+    - type: primitive
+      modifiers:
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+  action: {name: setSelection}
+initialState:
+  documentContents: |-
+    [
+        "foo",
+        "bar"
+    ]
+  selections:
+    - anchor: {line: 1, character: 10}
+      active: {line: 1, character: 10}
+  marks: {}
+finalState:
+  documentContents: |-
+    [
+        "foo",
+        "bar"
+    ]
+  selections:
+    - anchor: {line: 1, character: 4}
+      active: {line: 2, character: 9}
+  thatMark:
+    - anchor: {line: 1, character: 4}
+      active: {line: 2, character: 9}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: interiorOnly}]}]

src/test/suite/fixtures/recorded/surroundingPair/takeCore2.yml

@@ -0,0 +1,25 @@
+languageId: plaintext
+command:
+  spokenForm: take core
+  version: 2
+  targets:
+    - type: primitive
+      modifiers:
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+  action: {name: setSelection}
+initialState:
+  documentContents: ( hello )
+  selections:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+  marks: {}
+finalState:
+  documentContents: ( hello )
+  selections:
+    - anchor: {line: 0, character: 2}
+      active: {line: 0, character: 7}
+  thatMark:
+    - anchor: {line: 0, character: 2}
+      active: {line: 0, character: 7}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: interiorOnly}]}]

src/util/selectionUtils.ts

@@ -1,4 +1,4 @@
-import { Position, Range, Selection } from "vscode";
+import { Position, Range, Selection, TextEditor } from "vscode";
 import { SelectionWithEditor } from "../typings/Types";
 
 export function isForward(selection: Selection) {
@@ -42,3 +42,58 @@ export function selectionFromRange(isReversed: boolean, range: Range) {
   const { start, end } = range;
   return isReversed ? new Selection(end, start) : new Selection(start, end);
 }
+
+export function shrinkRangeToFitContent(editor: TextEditor, range: Range) {
+  const { lineAt } = editor.document;
+
+  const start = (() => {
+    const firstLine = lineAt(range.start);
+    const text = firstLine.text.substring(range.start.character);
+    if (text.trim().length === 0) {
+      for (let i = firstLine.lineNumber + 1; i <= range.end.line; ++i) {
+        const line = lineAt(i);
+        if (!line.isEmptyOrWhitespace) {
+          return new Position(i, line.firstNonWhitespaceCharacterIndex);
+        }
+      }
+      return range.start;
+    }
+    return new Position(
+      firstLine.lineNumber,
+      firstNonWhitespaceCharacterIndex(range, text)
+    );
+  })();
+
+  const end = (() => {
+    const endLine = lineAt(range.end);
+    const text = endLine.text.substring(0, range.end.character);
+    if (text.trim().length === 0) {
+      for (let i = endLine.lineNumber - 1; i >= range.start.line; --i) {
+        const line = lineAt(i);
+        if (!line.isEmptyOrWhitespace) {
+          return new Position(
+            i,
+            lastNonWhitespaceCharacterIndex(line.range, line.text)
+          );
+        }
+      }
+      return range.end;
+    }
+    return new Position(
+      endLine.lineNumber,
+      lastNonWhitespaceCharacterIndex(range, text)
+    );
+  })();
+
+  return new Range(start, end);
+}
+
+function firstNonWhitespaceCharacterIndex(range: Range, text: string) {
+  const characterDelta = text.length - text.trimStart().length;
+  return range.start.character + characterDelta;
+}
+
+function lastNonWhitespaceCharacterIndex(range: Range, text: string) {
+  const characterDelta = text.length - text.trimEnd().length;
+  return range.end.character - characterDelta;
+}