Merge pull request #1608 from rayat-amperity/wip/rayat/issue-#1607/selection-cursor-api-cleanup

WIP: #1607 - Cleanup selection/cursor API

Author: PEZ

CHANGELOG.md

@@ -3,6 +3,7 @@
 Changes to Calva.
 
 ## [Unreleased]
+- Maintenance: [Cleanup/removal of EditableDocument.selectionLeft/Right APIs](https://github.com/BetterThanTomorrow/calva/issues/1607)]
 
 ## [2.0.261] - 2022-04-01
 - Fix: [Results doc gets in a bad state and does not update](https://github.com/BetterThanTomorrow/calva/issues/1509)

src/cursor-doc/model.ts

@@ -104,8 +104,6 @@ export interface EditableModel {
 }
 
 export interface EditableDocument {
-  readonly selectionLeft: number;
-  readonly selectionRight: number;
   selection: ModelEditSelection;
   model: EditableModel;
   selectionStack: ModelEditSelection[];
@@ -534,17 +532,7 @@ export class StringDocument implements EditableDocument {
     }
   }
 
-  selectionLeft: number;
-  selectionRight: number;
-
-  get selection() {
-    return new ModelEditSelection(this.selectionLeft, this.selectionRight);
-  }
-
-  set selection(sel: ModelEditSelection) {
-    this.selectionLeft = sel.anchor;
-    this.selectionRight = sel.active;
-  }
+  selection: ModelEditSelection;
 
   model: LineInputModel = new LineInputModel(1, this);
 
@@ -565,14 +553,14 @@ export class StringDocument implements EditableDocument {
   getSelectionText: () => string;
 
   delete() {
-    const p = this.selectionLeft;
+    const p = this.selection.anchor;
     return this.model.edit([new ModelEdit('deleteRange', [p, 1])], {
       selection: new ModelEditSelection(p),
     });
   }
 
   backspace() {
-    const p = this.selectionLeft;
+    const p = this.selection.anchor;
     return this.model.edit([new ModelEdit('deleteRange', [p - 1, 1])], {
       selection: new ModelEditSelection(p - 1),
     });

src/cursor-doc/paredit.ts

@@ -1,4 +1,3 @@
-import { includes } from 'lodash';
 import { validPair } from './clojure-lexer';
 import { ModelEdit, EditableDocument, ModelEditSelection } from './model';
 import { LispTokenCursor } from './token-cursor';
@@ -16,8 +15,8 @@ import { LispTokenCursor } from './token-cursor';
 export function killRange(
   doc: EditableDocument,
   range: [number, number],
-  start = doc.selectionLeft,
-  end = doc.selectionRight
+  start = doc.selection.anchor,
+  end = doc.selection.active
 ) {
   const [left, right] = [Math.min(...range), Math.max(...range)];
   void doc.model.edit([new ModelEdit('deleteRange', [left, right - left, [start, end]])], {
@@ -86,7 +85,7 @@ export function selectBackwardDownSexp(doc: EditableDocument) {
 }
 
 export function selectForwardUpSexp(doc: EditableDocument) {
-  selectRangeForward(doc, rangeToForwardUpList(doc, doc.selectionRight));
+  selectRangeForward(doc, rangeToForwardUpList(doc, doc.selection.active));
 }
 
 export function selectBackwardUpSexp(doc: EditableDocument) {
@@ -98,7 +97,7 @@ export function selectBackwardUpSexp(doc: EditableDocument) {
 }
 
 export function selectCloseList(doc: EditableDocument) {
-  selectRangeForward(doc, rangeToForwardList(doc, doc.selectionRight));
+  selectRangeForward(doc, rangeToForwardList(doc, doc.selection.active));
 }
 
 export function selectOpenList(doc: EditableDocument) {
@@ -159,7 +158,7 @@ export function backwardSexpRange(
 
 export function forwardListRange(
   doc: EditableDocument,
-  start: number = doc.selectionRight
+  start: number = doc.selection.active
 ): [number, number] {
   const cursor = doc.getTokenCursor(start);
   cursor.forwardList();
@@ -168,7 +167,7 @@ export function forwardListRange(
 
 export function backwardListRange(
   doc: EditableDocument,
-  start: number = doc.selectionRight
+  start: number = doc.selection.active
 ): [number, number] {
   const cursor = doc.getTokenCursor(start);
   cursor.backwardList();
@@ -358,8 +357,8 @@ export function wrapSexpr(
   doc: EditableDocument,
   open: string,
   close: string,
-  start: number = doc.selectionLeft,
-  end: number = doc.selectionRight,
+  start: number = doc.selection.anchor,
+  end: number = doc.selection.active,
   options = { skipFormat: false }
 ): Thenable<boolean> {
   const cursor = doc.getTokenCursor(end);
@@ -407,8 +406,8 @@ export function rewrapSexpr(
   doc: EditableDocument,
   open: string,
   close: string,
-  start: number = doc.selectionLeft,
-  end: number = doc.selectionRight
+  start: number = doc.selection.anchor,
+  end: number = doc.selection.active
 ): Thenable<boolean> {
   const cursor = doc.getTokenCursor(end);
   if (cursor.backwardList()) {
@@ -428,7 +427,7 @@ export function rewrapSexpr(
   }
 }
 
-export function splitSexp(doc: EditableDocument, start: number = doc.selectionRight) {
+export function splitSexp(doc: EditableDocument, start: number = doc.selection.active) {
   const cursor = doc.getTokenCursor(start);
   if (!cursor.withinString() && !(cursor.isWhiteSpace() || cursor.previousIsWhiteSpace())) {
     cursor.forwardWhitespace();
@@ -452,7 +451,7 @@ export function splitSexp(doc: EditableDocument, start: number = doc.selectionRi
  */
 export function joinSexp(
   doc: EditableDocument,
-  start: number = doc.selectionRight
+  start: number = doc.selection.active
 ): Thenable<boolean> {
   const cursor = doc.getTokenCursor(start);
   cursor.backwardWhitespace();
@@ -481,7 +480,7 @@ export function joinSexp(
 
 export function spliceSexp(
   doc: EditableDocument,
-  start: number = doc.selectionRight,
+  start: number = doc.selection.active,
   undoStopBefore = true
 ): Thenable<boolean> {
   const cursor = doc.getTokenCursor(start);
@@ -542,7 +541,7 @@ export function killForwardList(
 
 export function forwardSlurpSexp(
   doc: EditableDocument,
-  start: number = doc.selectionRight,
+  start: number = doc.selection.active,
   extraOpts = { formatDepth: 1 }
 ) {
   const cursor = doc.getTokenCursor(start);
@@ -587,7 +586,7 @@ export function forwardSlurpSexp(
 
 export function backwardSlurpSexp(
   doc: EditableDocument,
-  start: number = doc.selectionRight,
+  start: number = doc.selection.active,
   extraOpts = {}
 ) {
   const cursor = doc.getTokenCursor(start);
@@ -621,7 +620,7 @@ export function backwardSlurpSexp(
   }
 }
 
-export function forwardBarfSexp(doc: EditableDocument, start: number = doc.selectionRight) {
+export function forwardBarfSexp(doc: EditableDocument, start: number = doc.selection.active) {
   const cursor = doc.getTokenCursor(start);
   cursor.forwardList();
   if (cursor.getToken().type == 'close') {
@@ -644,7 +643,7 @@ export function forwardBarfSexp(doc: EditableDocument, start: number = doc.selec
   }
 }
 
-export function backwardBarfSexp(doc: EditableDocument, start: number = doc.selectionRight) {
+export function backwardBarfSexp(doc: EditableDocument, start: number = doc.selection.active) {
   const cursor = doc.getTokenCursor(start);
   cursor.backwardList();
   const tk = cursor.getPrevToken();
@@ -674,9 +673,9 @@ export function open(
   doc: EditableDocument,
   open: string,
   close: string,
-  start: number = doc.selectionRight
+  start: number = doc.selection.active
 ) {
-  const [cs, ce] = [doc.selectionLeft, doc.selectionRight];
+  const [cs, ce] = [doc.selection.anchor, doc.selection.active];
   doc.insertString(open + doc.getSelectionText() + close);
   if (cs != ce) {
     doc.selection = new ModelEditSelection(cs + open.length, ce + open.length);
@@ -694,7 +693,7 @@ function docIsBalanced(doc: EditableDocument, start: number = doc.selection.acti
   return cursor.atEnd();
 }
 
-export function close(doc: EditableDocument, close: string, start: number = doc.selectionRight) {
+export function close(doc: EditableDocument, close: string, start: number = doc.selection.active) {
   const cursor = doc.getTokenCursor(start);
   const inString = cursor.withinString();
   cursor.forwardWhitespace(false);
@@ -754,8 +753,8 @@ export function backspace(
 
 export function deleteForward(
   doc: EditableDocument,
-  start: number = doc.selectionLeft,
-  end: number = doc.selectionRight
+  start: number = doc.selection.anchor,
+  end: number = doc.selection.active
 ) {
   if (start != end) {
     void doc.delete();
@@ -788,8 +787,8 @@ export function deleteForward(
 
 export function stringQuote(
   doc: EditableDocument,
-  start: number = doc.selectionLeft,
-  end: number = doc.selectionRight
+  start: number = doc.selection.anchor,
+  end: number = doc.selection.active
 ) {
   if (start != end) {
     doc.insertString('"');
@@ -826,8 +825,8 @@ export function stringQuote(
 
 export function growSelection(
   doc: EditableDocument,
-  start: number = doc.selectionLeft,
-  end: number = doc.selectionRight
+  start: number = doc.selection.anchor,
+  end: number = doc.selection.active
 ) {
   const startC = doc.getTokenCursor(start),
     endC = doc.getTokenCursor(end),
@@ -876,7 +875,7 @@ export function growSelectionStack(doc: EditableDocument, range: [number, number
   const [start, end] = range;
   if (doc.selectionStack.length > 0) {
     const prev = doc.selectionStack[doc.selectionStack.length - 1];
-    if (!(doc.selectionLeft == prev.anchor && doc.selectionRight == prev.active)) {
+    if (!(doc.selection.anchor == prev.anchor && doc.selection.active == prev.active)) {
       setSelectionStack(doc);
     } else if (prev.anchor === range[0] && prev.active === range[1]) {
       return;
@@ -893,8 +892,8 @@ export function shrinkSelection(doc: EditableDocument) {
     const latest = doc.selectionStack.pop();
     if (
       doc.selectionStack.length &&
-      latest.anchor == doc.selectionLeft &&
-      latest.active == doc.selectionRight
+      latest.anchor == doc.selection.anchor &&
+      latest.active == doc.selection.active
     ) {
       doc.selection = doc.selectionStack[doc.selectionStack.length - 1];
     }
@@ -907,8 +906,8 @@ export function setSelectionStack(doc: EditableDocument, selection = doc.selecti
 
 export function raiseSexp(
   doc: EditableDocument,
-  start = doc.selectionLeft,
-  end = doc.selectionRight
+  start = doc.selection.anchor,
+  end = doc.selection.active
 ) {
   const cursor = doc.getTokenCursor(end);
   const [formStart, formEnd] = cursor.rangeForCurrentForm(start);
@@ -937,8 +936,8 @@ export function raiseSexp(
 
 export function convolute(
   doc: EditableDocument,
-  start = doc.selectionLeft,
-  end = doc.selectionRight
+  start = doc.selection.anchor,
+  end = doc.selection.active
 ) {
   if (start == end) {
     const cursorStart = doc.getTokenCursor(end);
@@ -977,8 +976,8 @@ export function convolute(
 
 export function transpose(
   doc: EditableDocument,
-  left = doc.selectionLeft,
-  right = doc.selectionRight,
+  left = doc.selection.anchor,
+  right = doc.selection.active,
   newPosOffset: { fromLeft?: number; fromRight?: number } = {}
 ) {
   const cursor = doc.getTokenCursor(right);
@@ -1088,8 +1087,8 @@ function currentSexpsRange(
 export function dragSexprBackward(
   doc: EditableDocument,
   pairForms = bindingForms,
-  left = doc.selectionLeft,
-  right = doc.selectionRight
+  left = doc.selection.anchor,
+  right = doc.selection.active
 ) {
   const cursor = doc.getTokenCursor(right);
   const usePairs = isInPairsList(cursor, pairForms);
@@ -1115,8 +1114,8 @@ export function dragSexprBackward(
 export function dragSexprForward(
   doc: EditableDocument,
   pairForms = bindingForms,
-  left = doc.selectionLeft,
-  right = doc.selectionRight
+  left = doc.selection.anchor,
+  right = doc.selection.active
 ) {
   const cursor = doc.getTokenCursor(right);
   const usePairs = isInPairsList(cursor, pairForms);
@@ -1161,7 +1160,7 @@ export type WhitespaceInfo = {
  */
 export function collectWhitespaceInfo(
   doc: EditableDocument,
-  p = doc.selectionRight
+  p = doc.selection.active
 ): WhitespaceInfo {
   const cursor = doc.getTokenCursor(p);
   const currentRange = cursor.rangeForCurrentForm(p);
@@ -1189,7 +1188,7 @@ export function collectWhitespaceInfo(
   };
 }
 
-export function dragSexprBackwardUp(doc: EditableDocument, p = doc.selectionRight) {
+export function dragSexprBackwardUp(doc: EditableDocument, p = doc.selection.active) {
   const wsInfo = collectWhitespaceInfo(doc, p);
   const cursor = doc.getTokenCursor(p);
   const currentRange = cursor.rangeForCurrentForm(p);
@@ -1230,7 +1229,7 @@ export function dragSexprBackwardUp(doc: EditableDocument, p = doc.selectionRigh
   }
 }
 
-export function dragSexprForwardDown(doc: EditableDocument, p = doc.selectionRight) {
+export function dragSexprForwardDown(doc: EditableDocument, p = doc.selection.active) {
   const wsInfo = collectWhitespaceInfo(doc, p);
   const currentRange = doc.getTokenCursor(p).rangeForCurrentForm(p);
   const newPosOffset = p - currentRange[0];
@@ -1266,7 +1265,7 @@ export function dragSexprForwardDown(doc: EditableDocument, p = doc.selectionRig
   }
 }
 
-export function dragSexprForwardUp(doc: EditableDocument, p = doc.selectionRight) {
+export function dragSexprForwardUp(doc: EditableDocument, p = doc.selection.active) {
   const wsInfo = collectWhitespaceInfo(doc, p);
   const cursor = doc.getTokenCursor(p);
   const currentRange = cursor.rangeForCurrentForm(p);
@@ -1297,7 +1296,7 @@ export function dragSexprForwardUp(doc: EditableDocument, p = doc.selectionRight
   }
 }
 
-export function dragSexprBackwardDown(doc: EditableDocument, p = doc.selectionRight) {
+export function dragSexprBackwardDown(doc: EditableDocument, p = doc.selection.active) {
   const wsInfo = collectWhitespaceInfo(doc, p);
   const currentRange = doc.getTokenCursor(p).rangeForCurrentForm(p);
   const newPosOffset = p - currentRange[0];