Fix preview results. (#4365)

* Fix preview results.
* Refactoring.

Author: sean-mcmanus

Extension/CHANGELOG.md

@@ -1,6 +1,6 @@
 # C/C++ for Visual Studio Code Change Log
 
-## Version 0.26.0-insiders: September 30, 2019
+## Version 0.26.0-insiders: October 1, 2019
 ### New Features
 * Add localization support (translated text) via `Configure Display Language`. [#7](https://github.com/microsoft/vscode-cpptools/issues/7)
 * Add `Rename Symbol` with a pending rename UI. [#296](https://github.com/microsoft/vscode-cpptools/issues/296),  [PR #4277](https://github.com/microsoft/vscode-cpptools/pull/4277)

Extension/src/LanguageServer/client.ts

@@ -628,9 +628,8 @@ export class DefaultClient implements Client {
                                             return;
                                         }
                                         referencesRequestPending = true;
-                                        this.client.languageClient.sendNotification(FindAllReferencesNotification, params);
                                         // Register a single-fire handler for the reply.
-                                        this.client.references.setResultsCallback((result) => {
+                                        let resultCallback: refs.ReferencesResultCallback = (result: refs.ReferencesResult) => {
                                             referencesRequestPending = false;
                                             if (referencesPendingCancellations.length > 0) {
                                                 while (referencesPendingCancellations.length > 1) {
@@ -643,15 +642,22 @@ export class DefaultClient implements Client {
                                                 pendingCancel.callback();
                                             }
                                             let locations: vscode.Location[] = [];
-                                            result.referenceInfos.forEach(referenceInfo => {
+                                            result.referenceInfos.forEach((referenceInfo: refs.ReferenceInfo) => {
                                                 if (referenceInfo.type === refs.ReferenceType.Confirmed) {
                                                     let uri: vscode.Uri = vscode.Uri.file(referenceInfo.file);
                                                     let range: vscode.Range = new vscode.Range(referenceInfo.position.line, referenceInfo.position.character, referenceInfo.position.line, referenceInfo.position.character + result.text.length);
                                                     locations.push(new vscode.Location(uri, range));
                                                 }
                                             });
                                             resolve(locations);
-                                        });
+                                        };
+                                        if (this.client.references.lastResults) {
+                                            resultCallback(this.client.references.lastResults);
+                                            this.client.references.lastResults = null;
+                                        } else {
+                                            this.client.languageClient.sendNotification(FindAllReferencesNotification, params);
+                                            this.client.references.setResultsCallback(resultCallback);
+                                        }
                                     });
                                     token.onCancellationRequested(e => {
                                         if (params === referencesParams) {
@@ -710,7 +716,7 @@ export class DefaultClient implements Client {
                                         }
                                         referencesRequestPending = true;
                                         this.client.languageClient.sendNotification(RenameNotification, params);
-                                        this.client.references.setResultsCallback((referencesResult) => {
+                                        this.client.references.setResultsCallback((referencesResult: refs.ReferencesResult) => {
                                             referencesRequestPending = false;
                                             --renameRequestsPending;
                                             let workspaceEdit: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();

Extension/src/LanguageServer/references.ts

@@ -36,6 +36,8 @@ export interface ReferencesResult {
     isFinished: boolean;
 }
 
+export type ReferencesResultCallback = (result: ReferencesResult) => void;
+
 export interface ReferencesResultMessage {
     referencesResult: ReferencesResult;
 }
@@ -149,7 +151,7 @@ export class ReferencesManager {
     private visibleRangesDecreasedTicks: number = 0;
     private readonly ticksForDetectingPeek: number = 1000; // TODO: Might need tweeking?
 
-    private resultsCallback: (results: ReferencesResult) => void;
+    private resultsCallback: ReferencesResultCallback;
     private currentUpdateProgressTimer: NodeJS.Timeout;
     private currentUpdateProgressResolve: () => void;
 
@@ -385,11 +387,18 @@ export class ReferencesManager {
             } else if (currentReferenceCommandMode === ReferencesCommandMode.Find) {
                 this.findAllRefsView.show(true);
             }
-            this.resultsCallback(referencesResult);
+            if (referencesResult.isFinished && this.referencesRequestHasOccurred) {
+                this.lastResults = referencesResult;
+                vscode.commands.executeCommand("references-view.refresh");
+            } else {
+                this.resultsCallback(referencesResult);
+            }
         }
     }
 
-    public setResultsCallback(callback: (results: ReferencesResult) => void): void {
+    public lastResults: ReferencesResult = null; // Saved for the final request after a preview occurs.
+
+    public setResultsCallback(callback: ReferencesResultCallback): void {
         this.symbolSearchInProgress = true;
         this.resultsCallback = callback;
     }

Extension/src/LanguageServer/renameModel.ts

@@ -4,7 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 'use strict';
 import * as vscode from 'vscode';
-import { ReferenceType, ReferencesResult, ReferenceInfo } from './references';
+import { ReferenceType, ReferencesResult, ReferenceInfo, ReferencesResultCallback } from './references';
 import { RenameDataProvider } from './renameDataProvider';
 
 export class RenamePendingItem {
@@ -237,10 +237,10 @@ let currentRenameModel: RenameModel;
 export class RenameModel {
     private pendingGroup: RenamePendingFilesGroupItem;
     private candidatesGroup: RenameCandidateReferenceTypeGroupItem;
-    private renameResultsCallback: (results: ReferencesResult) => void;
+    private renameResultsCallback: ReferencesResultCallback;
     private originalText: string;
 
-    constructor(resultsInput: ReferencesResult, readonly pendingProvider: RenameDataProvider, readonly candidateProvider: RenameDataProvider, resultsCallback: (results: ReferencesResult) => void) {
+    constructor(resultsInput: ReferencesResult, readonly pendingProvider: RenameDataProvider, readonly candidateProvider: RenameDataProvider, resultsCallback: ReferencesResultCallback) {
         currentRenameModel = this;
         this.originalText = resultsInput.text;
         this.renameResultsCallback = resultsCallback;
@@ -284,7 +284,7 @@ export class RenameModel {
 
     cancel(): void {
         if (this.renameResultsCallback) {
-            let callback: (results: ReferencesResult) => void = this.renameResultsCallback;
+            let callback: ReferencesResultCallback = this.renameResultsCallback;
             this.renameResultsCallback = null;
             callback(null);
         }
@@ -308,7 +308,7 @@ export class RenameModel {
             text: this.originalText,
             isFinished: true
         };
-        let callback: (results: ReferencesResult) => void = this.renameResultsCallback;
+        let callback: ReferencesResultCallback = this.renameResultsCallback;
         this.renameResultsCallback = null;
         callback(results);
     }

Extension/src/LanguageServer/renameView.ts

@@ -4,7 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 'use strict';
 import * as vscode from 'vscode';
-import { ReferencesResult } from './references';
+import { ReferencesResult, ReferencesResultCallback } from './references';
 import { RenameDataProvider } from './renameDataProvider';
 import { RenameModel } from './renameModel';
 
@@ -39,7 +39,7 @@ export class RenameView {
         }
     }
 
-    setData(results: ReferencesResult, resultsCallback: (results: ReferencesResult) => void): void {
+    setData(results: ReferencesResult, resultsCallback: ReferencesResultCallback): void {
         this.model = new RenameModel(results, this.renamePendingDataProvider, this.renameCandidatesDataProvider, resultsCallback);
         this.renamePendingDataProvider.setModel(this.model);
         this.renameCandidatesDataProvider.setModel(this.model);