Add vimState.document getter

J-Fields · J-Fields · commit c6b4cec68d49 · 2020-11-16T16:04:45.000-05:00
Just removing a bit of boilerplate which will make ripping out unnecessary TextEditor methods slightly less painful. Refs #5663
diff --git a/extensionBase.ts b/extensionBase.ts
@@ -203,7 +203,7 @@ export async function activate(
         if (modeHandler == null || modeHandler.vimState.editor === undefined) {
           shouldDelete = true;
         } else {
-          const document = modeHandler.vimState.editor.document;
+          const document = modeHandler.vimState.document;
           if (!documents.includes(document)) {
             shouldDelete = true;
             if (closedDocument === document) {
diff --git a/src/actions/commands/actions.ts b/src/actions/commands/actions.ts
@@ -577,7 +577,7 @@ abstract class CommandScrollAndMoveCursor extends BaseCommand {
     const newPositionLine = clamp(
       position.line + (this.to === 'down' ? moveLines : -moveLines),
       0,
-      vimState.editor.document.lineCount - 1
+      vimState.document.lineCount - 1
     );
     vimState.cursorStopPosition = new Position(
       newPositionLine,
@@ -747,13 +747,13 @@ class CommandOverrideCopy extends BaseCommand {
       text = vimState.cursors
         .map((range) => {
           const [start, stop] = sorted(range.start, range.stop);
-          return vimState.editor.document.getText(new vscode.Range(start, stop.getRight()));
+          return vimState.document.getText(new vscode.Range(start, stop.getRight()));
         })
         .join('\n');
     } else if (vimState.currentMode === Mode.VisualLine) {
       text = vimState.cursors
         .map((range) => {
-          return vimState.editor.document.getText(
+          return vimState.document.getText(
             new vscode.Range(
               earlierOf(range.start.getLineBegin(), range.stop.getLineBegin()),
               laterOf(range.start.getLineEnd(), range.stop.getLineEnd())
@@ -768,7 +768,7 @@ class CommandOverrideCopy extends BaseCommand {
     } else if (vimState.currentMode === Mode.Insert || vimState.currentMode === Mode.Normal) {
       text = vimState.editor.selections
         .map((selection) => {
-          return vimState.editor.document.getText(new vscode.Range(selection.start, selection.end));
+          return vimState.document.getText(new vscode.Range(selection.start, selection.end));
         })
         .join('\n');
     }
@@ -903,7 +903,7 @@ async function createSearchStateAndMoveToMatch(args: {
 
     reportSearch(
       nextMatch.index,
-      globalState.searchState.getMatchRanges(vimState.editor.document).length,
+      globalState.searchState.getMatchRanges(vimState.document).length,
       vimState
     );
   } else {
@@ -1666,7 +1666,7 @@ async function selectLastSearchWord(vimState: VimState, direction: SearchDirecti
     vimState.cursorStopPosition
   );
 
-  reportSearch(result.index, searchState.getMatchRanges(vimState.editor.document).length, vimState);
+  reportSearch(result.index, searchState.getMatchRanges(vimState.document).length, vimState);
 
   await vimState.setCurrentMode(Mode.Visual);
 }
@@ -2084,7 +2084,7 @@ class CommandNavigateLastBOL extends BaseCommand {
     }
     const jump = new Jump({
       editor: vimState.editor,
-      fileName: vimState.editor.document.fileName,
+      fileName: vimState.document.fileName,
       position: lastJump.position.getLineBegin(),
     });
     globalState.jumpTracker.recordJump(Jump.fromStateNow(vimState), jump);
@@ -3358,7 +3358,7 @@ class CommandUnicodeName extends BaseCommand {
   }
 
   public async exec(position: Position, vimState: VimState): Promise<void> {
-    const char = vimState.editor.document.getText(new vscode.Range(position, position.getRight()));
+    const char = vimState.document.getText(new vscode.Range(position, position.getRight()));
     const charCode = char.charCodeAt(0);
     // TODO: Handle charCode > 127 by also including <M-x>
     StatusBar.setText(
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 = vimState.editor.document.uri;
+      const currentUri = vimState.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(vimState.editor.document).length === 0) {
+      if (searchState.getMatchRanges(vimState.document).length === 0) {
         StatusBar.displayError(
           vimState,
           VimError.fromCode(ErrorCode.PatternNotFound, searchState.searchString)
@@ -408,11 +408,7 @@ class CommandInsertInSearchMode extends BaseCommand {
 
       vimState.cursorStopPosition = nextMatch.pos;
 
-      reportSearch(
-        nextMatch.index,
-        searchState.getMatchRanges(vimState.editor.document).length,
-        vimState
-      );
+      reportSearch(nextMatch.index, searchState.getMatchRanges(vimState.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
@@ -49,7 +49,7 @@ class CommandEscInsertMode extends BaseCommand {
       const lastActionBeforeEsc = vimState.keyHistory[vimState.keyHistory.length - 2];
       if (
         ['o', 'O', '\n'].includes(lastActionBeforeEsc) &&
-        vimState.editor.document.languageId !== 'plaintext' &&
+        vimState.document.languageId !== 'plaintext' &&
         /^\s+$/.test(TextEditor.getLineAt(vimState.cursors[i].stop).text)
       ) {
         vimState.recordedState.transformer.addTransformation({
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(vimState.editor.document).length === 0) {
+    if (searchState.getMatchRanges(vimState.document).length === 0) {
       StatusBar.displayError(
         vimState,
         VimError.fromCode(ErrorCode.PatternNotFound, searchState.searchString)
@@ -454,11 +454,7 @@ class CommandNextSearchMatch extends BaseMovement {
       return position;
     }
 
-    reportSearch(
-      nextMatch.index,
-      searchState.getMatchRanges(vimState.editor.document).length,
-      vimState
-    );
+    reportSearch(nextMatch.index, searchState.getMatchRanges(vimState.document).length, vimState);
 
     return nextMatch.pos;
   }
@@ -479,7 +475,7 @@ class CommandPreviousSearchMatch extends BaseMovement {
     // Turn one of the highlighting flags back on (turned off with :nohl)
     globalState.hl = true;
 
-    if (searchState.getMatchRanges(vimState.editor.document).length === 0) {
+    if (searchState.getMatchRanges(vimState.document).length === 0) {
       StatusBar.displayError(
         vimState,
         VimError.fromCode(ErrorCode.PatternNotFound, searchState.searchString)
@@ -502,11 +498,7 @@ class CommandPreviousSearchMatch extends BaseMovement {
       return position;
     }
 
-    reportSearch(
-      prevMatch.index,
-      searchState.getMatchRanges(vimState.editor.document).length,
-      vimState
-    );
+    reportSearch(prevMatch.index, searchState.getMatchRanges(vimState.document).length, vimState);
 
     return prevMatch.pos;
   }
diff --git a/src/actions/operator.ts b/src/actions/operator.ts
@@ -144,7 +144,7 @@ export class DeleteOperator extends BaseOperator {
       }
     }
 
-    let text = vimState.editor.document.getText(new vscode.Range(start, end));
+    let text = vimState.document.getText(new vscode.Range(start, end));
 
     // If we delete linewise to the final line of the document, we expect the line
     // to be removed. This is actually a special case because the newline
@@ -415,7 +415,7 @@ export class UpperCaseOperator extends BaseOperator {
 
   public async run(vimState: VimState, start: Position, end: Position): Promise<void> {
     const range = new vscode.Range(start, new Position(end.line, end.character + 1));
-    let text = vimState.editor.document.getText(range);
+    let text = vimState.document.getText(range);
 
     await TextEditor.replace(range, text.toUpperCase());
 
@@ -438,7 +438,7 @@ class UpperCaseVisualBlockOperator extends BaseOperator {
   public async run(vimState: VimState, startPos: Position, endPos: Position): Promise<void> {
     for (const { start, end } of TextEditor.iterateLinesInBlock(vimState)) {
       const range = new vscode.Range(start, end);
-      let text = vimState.editor.document.getText(range);
+      let text = vimState.document.getText(range);
       await TextEditor.replace(range, text.toUpperCase());
     }
 
@@ -456,7 +456,7 @@ export class LowerCaseOperator extends BaseOperator {
 
   public async run(vimState: VimState, start: Position, end: Position): Promise<void> {
     const range = new vscode.Range(start, new Position(end.line, end.character + 1));
-    let text = vimState.editor.document.getText(range);
+    let text = vimState.document.getText(range);
 
     await TextEditor.replace(range, text.toLowerCase());
 
@@ -479,7 +479,7 @@ class LowerCaseVisualBlockOperator extends BaseOperator {
   public async run(vimState: VimState, startPos: Position, endPos: Position): Promise<void> {
     for (const { start, end } of TextEditor.iterateLinesInBlock(vimState)) {
       const range = new vscode.Range(start, end);
-      let text = vimState.editor.document.getText(range);
+      let text = vimState.document.getText(range);
       await TextEditor.replace(range, text.toLowerCase());
     }
 
@@ -633,7 +633,7 @@ export class ChangeOperator extends BaseOperator {
   }
 
   public async runRepeat(vimState: VimState, position: Position, count: number): Promise<void> {
-    const thisLineIndent = vimState.editor.document.getText(
+    const thisLineIndent = vimState.document.getText(
       new vscode.Range(position.getLineBegin(), position.getLineBeginRespectingIndent())
     );
 
@@ -646,7 +646,7 @@ export class ChangeOperator extends BaseOperator {
     );
 
     if (configuration.autoindent) {
-      if (vimState.editor.document.languageId === 'plaintext') {
+      if (vimState.document.languageId === 'plaintext') {
         vimState.recordedState.transformer.addTransformation({
           type: 'insertText',
           text: thisLineIndent,
diff --git a/src/actions/plugins/sneak.ts b/src/actions/plugins/sneak.ts
@@ -35,7 +35,7 @@ export class SneakForward extends BaseMovement {
 
     const searchString = this.keysPressed[1] + this.keysPressed[2];
 
-    const document = vimState.editor.document;
+    const document = vimState.document;
     const lineCount = document.lineCount;
     for (let i = position.line; i < lineCount; ++i) {
       const lineText = document.lineAt(i).text;
@@ -99,7 +99,7 @@ export class SneakBackward extends BaseMovement {
 
     const searchString = this.keysPressed[1] + this.keysPressed[2];
 
-    const document = vimState.editor.document;
+    const document = vimState.document;
     for (let i = position.line; i >= 0; --i) {
       const lineText = document.lineAt(i).text;
 
diff --git a/src/cmd_line/commands/close.ts b/src/cmd_line/commands/close.ts
@@ -27,7 +27,7 @@ export class CloseCommand extends node.CommandBase {
   }
 
   async execute(vimState: VimState): Promise<void> {
-    if (vimState.editor.document.isDirty && !this.arguments.bang) {
+    if (vimState.document.isDirty && !this.arguments.bang) {
       throw error.VimError.fromCode(error.ErrorCode.NoWriteSinceLastChange);
     }
 
diff --git a/src/cmd_line/commands/deleteRange.ts b/src/cmd_line/commands/deleteRange.ts
@@ -37,14 +37,14 @@ export class DeleteRangeCommand extends node.CommandBase {
     let start = new Position(startLine, 0);
     let end = new Position(endLine, 0).getLineEndIncludingEOL();
 
-    if (endLine < vimState.editor.document.lineCount - 1) {
+    if (endLine < vimState.document.lineCount - 1) {
       end = end.getRightThroughLineBreaks();
     } else if (startLine > 0) {
       start = start.getLeftThroughLineBreaks();
     }
 
     const range = new vscode.Range(start, end);
-    const text = vimState.editor.document
+    const text = vimState.document
       .getText(range)
       // Remove leading or trailing newline
       .replace(/^\r?\n/, '')
diff --git a/src/cmd_line/commands/quit.ts b/src/cmd_line/commands/quit.ts
@@ -29,11 +29,10 @@ export class QuitCommand extends node.CommandBase {
   async execute(vimState: VimState): Promise<void> {
     // NOTE: We can't currently get all open text editors, so this isn't perfect. See #3809
     const duplicatedInSplit =
-      vscode.window.visibleTextEditors.filter(
-        (editor) => editor.document === vimState.editor.document
-      ).length > 1;
+      vscode.window.visibleTextEditors.filter((editor) => editor.document === vimState.document)
+        .length > 1;
     if (
-      vimState.editor.document.isDirty &&
+      vimState.document.isDirty &&
       !this.arguments.bang &&
       (!duplicatedInSplit || this._arguments.quitAll)
     ) {
diff --git a/src/cmd_line/commands/substitute.ts b/src/cmd_line/commands/substitute.ts
@@ -191,7 +191,7 @@ export class SubstituteCommand extends node.CommandBase {
           globalState.jumpTracker.recordJump(
             new Jump({
               editor: vimState.editor,
-              fileName: vimState.editor.document.fileName,
+              fileName: vimState.document.fileName,
               position: new Position(line, 0),
             }),
             Jump.fromStateNow(vimState)
@@ -208,7 +208,7 @@ export class SubstituteCommand extends node.CommandBase {
       globalState.jumpTracker.recordJump(
         new Jump({
           editor: vimState.editor,
-          fileName: vimState.editor.document.fileName,
+          fileName: vimState.document.fileName,
           position: new Position(line, 0),
         }),
         Jump.fromStateNow(vimState)
diff --git a/src/cmd_line/commands/write.ts b/src/cmd_line/commands/write.ts
@@ -50,18 +50,18 @@ export class WriteCommand extends node.CommandBase {
     }
 
     // defer saving the file to vscode if file is new (to present file explorer) or if file is a remote file
-    if (vimState.editor.document.isUntitled || vimState.editor.document.uri.scheme !== 'file') {
+    if (vimState.document.isUntitled || vimState.document.uri.scheme !== 'file') {
       await this.background(vscode.commands.executeCommand('workbench.action.files.save'));
       return;
     }
 
     try {
-      await fs.accessAsync(vimState.editor.document.fileName, fs.constants.W_OK);
+      await fs.accessAsync(vimState.document.fileName, fs.constants.W_OK);
       return this.save(vimState);
     } catch (accessErr) {
       if (this.arguments.bang) {
         try {
-          await fs.chmodAsync(vimState.editor.document.fileName, 666);
+          await fs.chmodAsync(vimState.document.fileName, 666);
           return this.save(vimState);
         } catch (e) {
           StatusBar.setText(vimState, e.message);
@@ -74,15 +74,15 @@ export class WriteCommand extends node.CommandBase {
 
   private async save(vimState: VimState): Promise<void> {
     await this.background(
-      vimState.editor.document.save().then(
+      vimState.document.save().then(
         () => {
           let text =
             '"' +
-            path.basename(vimState.editor.document.fileName) +
+            path.basename(vimState.document.fileName) +
             '" ' +
-            vimState.editor.document.lineCount +
+            vimState.document.lineCount +
             'L ' +
-            vimState.editor.document.getText().length +
+            vimState.document.getText().length +
             'C written';
           StatusBar.setText(vimState, text);
         },
diff --git a/src/cmd_line/node.ts b/src/cmd_line/node.ts
@@ -68,7 +68,7 @@ export class LineRange {
    */
   public resolve(vimState: VimState): [number, number] {
     if (this.left.length > 0 && this.left[0].type === TokenType.Percent) {
-      return [0, vimState.editor.document.lineCount - 1];
+      return [0, vimState.document.lineCount - 1];
     }
 
     const start = LineRange.resolveLineRef(this.left, vimState) ?? vimState.cursorStopPosition.line;
@@ -88,9 +88,9 @@ export class LineRange {
     // handle first-token special cases (e.g. %, inital line number is "." by default)
     switch (firstToken.type) {
       case TokenType.Percent:
-        return vimState.editor.document.lineCount - 1;
+        return vimState.document.lineCount - 1;
       case TokenType.Dollar:
-        currentLineNum = vimState.editor.document.lineCount - 1;
+        currentLineNum = vimState.document.lineCount - 1;
         break;
       case TokenType.Plus:
       case TokenType.Minus:
@@ -189,7 +189,7 @@ export class LineRange {
 
     // finally, make sure current position is in bounds :)
     currentLineNum = Math.max(0, currentLineNum);
-    currentLineNum = Math.min(vimState.editor.document.lineCount - 1, currentLineNum);
+    currentLineNum = Math.min(vimState.document.lineCount - 1, currentLineNum);
     return currentLineNum;
   }
 }
diff --git a/src/completion/lineCompletionProvider.ts b/src/completion/lineCompletionProvider.ts
@@ -146,7 +146,7 @@ export const lineCompletionProvider = {
    * Quick Pick also allows for searching, which is a nice bonus.
    */
   showLineCompletionsQuickPick: async (position: Position, vimState: VimState): Promise<void> => {
-    const completions = getCompletionsForCurrentLine(position, vimState.editor.document);
+    const completions = getCompletionsForCurrentLine(position, vimState.document);
 
     if (!completions) {
       return;
diff --git a/src/jumps/jump.ts b/src/jumps/jump.ts
diff --git a/src/jumps/jumpTracker.ts b/src/jumps/jumpTracker.ts
diff --git a/src/mode/modeHandler.ts b/src/mode/modeHandler.ts
diff --git a/src/state/vimState.ts b/src/state/vimState.ts
diff --git a/src/transformations/transformer.ts b/src/transformations/transformer.ts
diff --git a/src/util/statusBarTextUtils.ts b/src/util/statusBarTextUtils.ts
diff --git a/test/completion/lineCompletion.test.ts b/test/completion/lineCompletion.test.ts

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export class CloseCommand extends node.CommandBase {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`async execute(vimState: VimState): Promise<void> {`
`30`		`- if (vimState.editor.document.isDirty && !this.arguments.bang) {`
	`30`	`+ if (vimState.document.isDirty && !this.arguments.bang) {`
`31`	`31`	`throw error.VimError.fromCode(error.ErrorCode.NoWriteSinceLastChange);`
`32`	`32`	`}`
`33`	`33`