Reduce use of activeTextEditor in favor of vimState.editor

J-Fields · J-Fields · commit e191e13d5ffc · 2020-11-16T15:43:41.000-05:00
Refs #5663
diff --git a/src/actions/commands/actions.ts b/src/actions/commands/actions.ts
@@ -417,7 +417,7 @@ class CommandEsc extends BaseCommand {
     }
 
     if (vimState.currentMode === Mode.EasyMotionMode) {
-      vimState.easyMotion.clearDecorations();
+      vimState.easyMotion.clearDecorations(vimState.editor);
     }
 
     // Abort surround operation
@@ -839,7 +839,7 @@ async function searchCurrentWord(
  * Search for the word under the cursor; used by [g]* and [g]# in visual mode when `visualstar` is enabled
  */
 async function searchCurrentSelection(vimState: VimState, direction: SearchDirection) {
-  const selection = TextEditor.getSelection();
+  const selection = vimState.editor.selection;
   const end = new Position(selection.end.line, selection.end.character);
   const currentSelection = TextEditor.getText(selection.with(selection.start, end));
 
@@ -901,7 +901,11 @@ async function createSearchStateAndMoveToMatch(args: {
   if (nextMatch) {
     vimState.cursorStopPosition = nextMatch.pos;
 
-    reportSearch(nextMatch.index, globalState.searchState.getMatchRanges().length, vimState);
+    reportSearch(
+      nextMatch.index,
+      globalState.searchState.getMatchRanges(vimState.editor.document).length,
+      vimState
+    );
   } else {
     StatusBar.displayError(
       vimState,
@@ -1657,12 +1661,12 @@ async function selectLastSearchWord(vimState: VimState, direction: SearchDirecti
   vimState.cursorStopPosition = result.end.getLeftThroughLineBreaks(); // end is exclusive
 
   // Move the cursor, this is a bit hacky...
-  vscode.window.activeTextEditor!.selection = new vscode.Selection(
+  vimState.editor.selection = new vscode.Selection(
     vimState.cursorStartPosition,
     vimState.cursorStopPosition
   );
 
-  reportSearch(result.index, searchState.getMatchRanges().length, vimState);
+  reportSearch(result.index, searchState.getMatchRanges(vimState.editor.document).length, vimState);
 
   await vimState.setCurrentMode(Mode.Visual);
 }
@@ -1742,7 +1746,7 @@ class CommandOpenFile extends BaseCommand {
   public async exec(position: Position, vimState: VimState): Promise<void> {
     let fullFilePath: string;
     if (vimState.currentMode === Mode.Visual) {
-      fullFilePath = TextEditor.getText(TextEditor.getSelection());
+      fullFilePath = TextEditor.getText(vimState.editor.selection);
     } else {
       const range = new vscode.Range(
         getWordLeft(position, WordType.FileName, true),
diff --git a/src/actions/commands/commandLine.ts b/src/actions/commands/commandLine.ts
@@ -91,7 +91,7 @@ class CommandTabInCommandline extends BaseCommand {
       // File completion by searching if there is a space after the first word/command
       // ideally it should be a process of white-listing to selected commands like :e and :vsp
       let filePathInCmd = evalCmd.substring(fileRegex.lastIndex);
-      const currentUri = vscode.window.activeTextEditor!.document.uri;
+      const currentUri = vimState.editor.document.uri;
       const isRemote = !!vscode.env.remoteName;
 
       const { fullDirPath, baseName, partialPath, path: p } = getPathDetails(
@@ -374,7 +374,7 @@ class CommandInsertInSearchMode extends BaseCommand {
       globalState.addSearchStateToHistory(searchState);
       globalState.hl = true;
 
-      if (searchState.getMatchRanges().length === 0) {
+      if (searchState.getMatchRanges(vimState.editor.document).length === 0) {
         StatusBar.displayError(
           vimState,
           VimError.fromCode(ErrorCode.PatternNotFound, searchState.searchString)
@@ -408,7 +408,11 @@ class CommandInsertInSearchMode extends BaseCommand {
 
       vimState.cursorStopPosition = nextMatch.pos;
 
-      reportSearch(nextMatch.index, searchState.getMatchRanges().length, vimState);
+      reportSearch(
+        nextMatch.index,
+        searchState.getMatchRanges(vimState.editor.document).length,
+        vimState
+      );
 
       return;
     } else if (key === '<up>' || key === '<C-p>') {
diff --git a/src/actions/commands/insert.ts b/src/actions/commands/insert.ts
@@ -279,7 +279,7 @@ export class CommandDeleteInInsertMode extends BaseCommand {
   keys = ['<Del>'];
 
   public async exec(position: Position, vimState: VimState): Promise<void> {
-    const selection = TextEditor.getSelection();
+    const selection = vimState.editor.selection;
 
     if (!selection.isEmpty) {
       // If a selection is active, delete it
@@ -559,8 +559,8 @@ class CommandNavigateAutocompleteDown extends BaseCommand {
      * without this we execute it once per multi cursor, meaning it skips over the autocomplete
      * list suggestions
      */
-    if (vimState.isMultiCursor && vscode.window.activeTextEditor) {
-      const selection = vscode.window.activeTextEditor.selections[0];
+    if (vimState.isMultiCursor) {
+      const selection = vimState.editor.selection;
       if (
         selection.active.line === position.line &&
         selection.active.character === position.character
@@ -585,8 +585,8 @@ class CommandNavigateAutocompleteUp extends BaseCommand {
      * without this we execute it once per multi cursor, meaning it skips over the autocomplete
      * list suggestions
      */
-    if (vimState.isMultiCursor && vscode.window.activeTextEditor) {
-      const selection = vscode.window.activeTextEditor.selections[0];
+    if (vimState.isMultiCursor) {
+      const selection = vimState.editor.selection;
       if (
         selection.active.line === position.line &&
         selection.active.character === position.character
diff --git a/src/actions/motion.ts b/src/actions/motion.ts
@@ -421,7 +421,7 @@ class CommandNextSearchMatch extends BaseMovement {
     // Turn one of the highlighting flags back on (turned off with :nohl)
     globalState.hl = true;
 
-    if (searchState.getMatchRanges().length === 0) {
+    if (searchState.getMatchRanges(vimState.editor.document).length === 0) {
       StatusBar.displayError(
         vimState,
         VimError.fromCode(ErrorCode.PatternNotFound, searchState.searchString)
@@ -454,7 +454,11 @@ class CommandNextSearchMatch extends BaseMovement {
       return position;
     }
 
-    reportSearch(nextMatch.index, searchState.getMatchRanges().length, vimState);
+    reportSearch(
+      nextMatch.index,
+      searchState.getMatchRanges(vimState.editor.document).length,
+      vimState
+    );
 
     return nextMatch.pos;
   }
@@ -475,7 +479,7 @@ class CommandPreviousSearchMatch extends BaseMovement {
     // Turn one of the highlighting flags back on (turned off with :nohl)
     globalState.hl = true;
 
-    if (searchState.getMatchRanges().length === 0) {
+    if (searchState.getMatchRanges(vimState.editor.document).length === 0) {
       StatusBar.displayError(
         vimState,
         VimError.fromCode(ErrorCode.PatternNotFound, searchState.searchString)
@@ -498,7 +502,11 @@ class CommandPreviousSearchMatch extends BaseMovement {
       return position;
     }
 
-    reportSearch(prevMatch.index, searchState.getMatchRanges().length, vimState);
+    reportSearch(
+      prevMatch.index,
+      searchState.getMatchRanges(vimState.editor.document).length,
+      vimState
+    );
 
     return prevMatch.pos;
   }
diff --git a/src/actions/plugins/easymotion/easymotion.cmd.ts b/src/actions/plugins/easymotion/easymotion.cmd.ts
@@ -93,7 +93,7 @@ abstract class BaseEasyMotionCommand extends BaseCommand {
           const marker = vimState.easyMotion.markers[0];
           // Set cursor position based on marker entered
           vimState.cursorStopPosition = marker.position;
-          vimState.easyMotion.clearDecorations();
+          vimState.easyMotion.clearDecorations(vimState.editor);
         } else {
           // Store mode to return to after performing easy motion
           vimState.easyMotion.previousMode = vimState.currentMode;
@@ -394,15 +394,15 @@ class MoveEasyMotion extends BaseCommand {
         // Only one found, navigate to it
         const marker = markers[0];
 
-        vimState.easyMotion.clearDecorations();
+        vimState.easyMotion.clearDecorations(vimState.editor);
         // Restore the mode from before easy motion
         await vimState.setCurrentMode(vimState.easyMotion.previousMode);
 
         // Set cursor position based on marker entered
         vimState.cursorStopPosition = marker.position;
       } else if (markers.length === 0) {
         // None found, exit mode
-        vimState.easyMotion.clearDecorations();
+        vimState.easyMotion.clearDecorations(vimState.editor);
         await vimState.setCurrentMode(vimState.easyMotion.previousMode);
       }
     }
diff --git a/src/actions/plugins/easymotion/easymotion.ts b/src/actions/plugins/easymotion/easymotion.ts
@@ -75,9 +75,7 @@ export class EasyMotion {
   /**
    * Clear all decorations
    */
-  public clearDecorations() {
-    const editor = vscode.window.activeTextEditor!;
-
+  public clearDecorations(editor: vscode.TextEditor) {
     for (let i = 1; i <= this.decorations.length; i++) {
       editor.setDecorations(EasyMotion.getDecorationType(i), []);
     }
@@ -225,14 +223,13 @@ export class EasyMotion {
     return this.getMarkerColor(configuration.easymotionDimColor, '#777777');
   }
 
-  public updateDecorations() {
-    this.clearDecorations();
+  public updateDecorations(editor: vscode.TextEditor) {
+    this.clearDecorations(editor);
 
     this.visibleMarkers = [];
     this.decorations = [];
 
     // Set the decorations for all the different marker lengths
-    const editor = vscode.window.activeTextEditor!;
     const dimmingZones: vscode.DecorationOptions[] = [];
     const dimmingRenderOptions: vscode.ThemableDecorationRenderOptions = {
       // we update the color here again in case the configuration has changed
diff --git a/src/actions/plugins/sneak.ts b/src/actions/plugins/sneak.ts
@@ -1,4 +1,3 @@
-import * as vscode from 'vscode';
 import { VimState } from '../../state/vimState';
 import { configuration } from './../../configuration/configuration';
 import { RegisterAction } from './../base';
@@ -29,17 +28,15 @@ export class SneakForward extends BaseMovement {
       vimState.lastCommaRepeatableMovement = new SneakBackward(this.keysPressed, true);
     }
 
-    const editor = vscode.window.activeTextEditor!;
-    const document = editor.document;
-    const lineCount = document.lineCount;
-
     if (this.keysPressed[2] === '\n') {
       // Single key sneak
       this.keysPressed[2] = '';
     }
 
     const searchString = this.keysPressed[1] + this.keysPressed[2];
 
+    const document = vimState.editor.document;
+    const lineCount = document.lineCount;
     for (let i = position.line; i < lineCount; ++i) {
       const lineText = document.lineAt(i).text;
 
@@ -95,16 +92,14 @@ export class SneakBackward extends BaseMovement {
       vimState.lastCommaRepeatableMovement = new SneakForward(this.keysPressed, true);
     }
 
-    const editor = vscode.window.activeTextEditor!;
-    const document = editor.document;
-
     if (this.keysPressed[2] === '\n') {
       // Single key sneak
       this.keysPressed[2] = '';
     }
 
     const searchString = this.keysPressed[1] + this.keysPressed[2];
 
+    const document = vimState.editor.document;
     for (let i = position.line; i >= 0; --i) {
       const lineText = document.lineAt(i).text;
 
diff --git a/src/cmd_line/commandLine.ts b/src/cmd_line/commandLine.ts
@@ -91,11 +91,7 @@ class CommandLine {
    * Prompts the user for a command using an InputBox, and runs the provided command
    */
   public async PromptAndRun(initialText: string, vimState: VimState): Promise<void> {
-    if (!vscode.window.activeTextEditor) {
-      this._logger.debug('No active document');
-      return;
-    }
-    let cmd = await vscode.window.showInputBox(this.getInputBoxOptions(initialText));
+    const cmd = await vscode.window.showInputBox(this.getInputBoxOptions(initialText));
     await this.Run(cmd!, vimState);
   }
 
@@ -109,19 +105,12 @@ class CommandLine {
   }
 
   public async showHistory(initialText: string): Promise<string | undefined> {
-    if (!vscode.window.activeTextEditor) {
-      this._logger.debug('No active document.');
-      return '';
-    }
-
     this._history.add(initialText);
 
-    let cmd = await vscode.window.showQuickPick(this._history.get().slice().reverse(), {
+    return vscode.window.showQuickPick(this._history.get().slice().reverse(), {
       placeHolder: 'Vim command history',
       ignoreFocusOut: false,
     });
-
-    return cmd;
   }
 }
 
diff --git a/src/mode/modeHandler.ts b/src/mode/modeHandler.ts
@@ -1543,7 +1543,7 @@ export class ModeHandler implements vscode.Disposable {
 
     if (this.currentMode === Mode.EasyMotionMode) {
       // Update all EasyMotion decorations
-      this.vimState.easyMotion.updateDecorations();
+      this.vimState.easyMotion.updateDecorations(this.vimState.editor);
     }
 
     StatusBar.clear(this.vimState, false);
diff --git a/src/state/globalState.ts b/src/state/globalState.ts
@@ -103,10 +103,6 @@ class GlobalState {
    * @returns The SearchState that was selected by the user, if there was one.
    */
   public async showSearchHistory(): Promise<SearchState | undefined> {
-    if (!vscode.window.activeTextEditor) {
-      return undefined;
-    }
-
     const items = this._searchStatePrevious
       .slice()
       .reverse()
diff --git a/src/state/searchState.ts b/src/state/searchState.ts
@@ -30,10 +30,7 @@ export class SearchState {
   /**
    * Every range in the document that matches the search string.
    */
-  public getMatchRanges(document?: vscode.TextDocument): vscode.Range[] {
-    if (!document) {
-      document = vscode.window.activeTextEditor!.document;
-    }
+  public getMatchRanges(document: vscode.TextDocument): vscode.Range[] {
     return this.recalculateSearchRanges(document);
   }
   private matchRanges: Map<string, { version: number; ranges: Array<vscode.Range> }> = new Map();
diff --git a/src/state/vimState.ts b/src/state/vimState.ts
@@ -355,15 +355,10 @@ export class VimState implements vscode.Disposable {
     this._currentMode = mode;
 
     if (configuration.smartRelativeLine) {
-      const activeTextEditor = vscode.window.activeTextEditor;
-
-      if (activeTextEditor) {
-        if (mode === Mode.Insert) {
-          activeTextEditor.options.lineNumbers = vscode.TextEditorLineNumbersStyle.On;
-        } else {
-          activeTextEditor.options.lineNumbers = vscode.TextEditorLineNumbersStyle.Relative;
-        }
-      }
+      this.editor.options.lineNumbers =
+        mode === Mode.Insert
+          ? vscode.TextEditorLineNumbersStyle.On
+          : vscode.TextEditorLineNumbersStyle.Relative;
     }
 
     if (mode === Mode.SearchInProgressMode) {
diff --git a/src/textEditor.ts b/src/textEditor.ts
@@ -14,21 +14,6 @@ export class TextEditor {
 
   // TODO: Refactor args
 
-  /**
-   * Verify that a tab is even open for the TextEditor to act upon.
-   *
-   * This class was designed assuming there will usually be an active editor
-   * to act upon, which is usually true with editor hotkeys.
-   *
-   * But there are cases where an editor won't be active, such as running
-   * code on VSCodeVim activation, where you might see the error:
-   * > [Extension Host] Here is the error stack:
-   * > TypeError: Cannot read property 'document' of undefined
-   */
-  static get isActive() {
-    return vscode.window.activeTextEditor != null;
-  }
-
   /**
    * @deprecated Use InsertTextTransformation (or InsertTextVSCodeTransformation) instead.
    */
@@ -77,14 +62,6 @@ export class TextEditor {
     });
   }
 
-  static getDocumentVersion(): number {
-    return vscode.window.activeTextEditor!.document.version;
-  }
-
-  static getDocumentName(): string {
-    return vscode.window.activeTextEditor!.document.fileName;
-  }
-
   /**
    * @deprecated. Use ReplaceTextTransformation instead.
    */
@@ -133,6 +110,7 @@ export class TextEditor {
     return line.text[position.character];
   }
 
+  /** @deprecated Only used in tests. Remove ASAP. */
   static getSelection(): vscode.Range {
     return vscode.window.activeTextEditor!.selection;
   }
diff --git a/src/transformations/transformer.ts b/src/transformations/transformer.ts
diff --git a/test/mode/modeNormal.test.ts b/test/mode/modeNormal.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1543,7 +1543,7 @@ export class ModeHandler implements vscode.Disposable {`
`1543`	`1543`
`1544`	`1544`	`if (this.currentMode === Mode.EasyMotionMode) {`
`1545`	`1545`	`// Update all EasyMotion decorations`
`1546`		`- this.vimState.easyMotion.updateDecorations();`
	`1546`	`+ this.vimState.easyMotion.updateDecorations(this.vimState.editor);`
`1547`	`1547`	`}`
`1548`	`1548`
`1549`	`1549`	`StatusBar.clear(this.vimState, false);`