Add use of queryTranslationUnitSource to determine if custom configuration can be skipped (#3393)

Add call in provideCustomConfiguration to new QueryTranslationUnitSourceRequest. Use result to decide whether it's necessary to request a custom configuration.

* Add queryTranslationUnitSource

* Update "Building the Extension.md"

Author: Colengms

Documentation/Building the Extension.md

@@ -3,7 +3,8 @@
 These steps will allow you to debug the TypeScript code that is part of the Microsoft CppTools extension for Visual Studio Code.
 
 Prerequisite steps:
-  * Clone [this](https://github.com/Microsoft/vscode-cpptools) repository.
+  * Clone the release branch of [this](https://github.com/Microsoft/vscode-cpptools) repository.
+      * git clone -b release https://github.com/Microsoft/vscode-cpptools
   * Install [npm](https://nodejs.org).
   * From a command line, run the following commands from the **Extension** folder in the root of the repository:
       * `npm install` will install the dependencies needed to build the extension.

Extension/src/LanguageServer/client.ts

@@ -113,10 +113,38 @@ interface CompileCommandsPaths {
     paths: string[];
 }
 
+interface QueryTranslationUnitSourceParams {
+    uri: string;
+}
+
+export enum QueryTranslationUnitSourceConfigDisposition {
+
+    /**
+     * No custom config needed for this file
+     */
+    ConfigNotNeeded = 0,
+
+    /**
+     * Custom config is needed for this file
+     */
+    ConfigNeeded = 1,
+
+    /**
+     * Custom config is needed for the ancestor file returned in uri
+     */
+    AncestorConfigNeeded = 2
+}
+
+interface QueryTranslationUnitSourceResult {
+    uri: string;
+    configDisposition: QueryTranslationUnitSourceConfigDisposition;
+}
+
 // Requests
 const NavigationListRequest: RequestType<TextDocumentIdentifier, string, void, void> = new RequestType<TextDocumentIdentifier, string, void, void>('cpptools/requestNavigationList');
 const GoToDeclarationRequest: RequestType<void, void, void, void> = new RequestType<void, void, void, void>('cpptools/goToDeclaration');
 const QueryCompilerDefaultsRequest: RequestType<QueryCompilerDefaultsParams, configs.CompilerDefaults, void, void> = new RequestType<QueryCompilerDefaultsParams, configs.CompilerDefaults, void, void>('cpptools/queryCompilerDefaults');
+const QueryTranslationUnitSourceRequest: RequestType<QueryTranslationUnitSourceParams, QueryTranslationUnitSourceResult, void, void> = new RequestType<QueryTranslationUnitSourceParams, QueryTranslationUnitSourceResult, void, void>('cpptools/queryTranslationUnitSource');
 const SwitchHeaderSourceRequest: RequestType<SwitchHeaderSourceParams, string, void, void> = new RequestType<SwitchHeaderSourceParams, string, void, void>('cpptools/didSwitchHeaderSource');
 
 // Notifications to the server
@@ -609,6 +637,15 @@ class DefaultClient implements Client {
     }
 
     public async provideCustomConfiguration(document: vscode.TextDocument): Promise<void> {
+        let params: QueryTranslationUnitSourceParams = {
+            uri: document.uri.toString()
+        };
+        let response: QueryTranslationUnitSourceResult = await this.languageClient.sendRequest(QueryTranslationUnitSourceRequest, params);
+        if (response.configDisposition === QueryTranslationUnitSourceConfigDisposition.ConfigNotNeeded) {
+            return Promise.resolve();
+        }
+
+        let tuUri: vscode.Uri = vscode.Uri.parse(response.uri);
         let tokenSource: CancellationTokenSource = new CancellationTokenSource();
         let providers: CustomConfigurationProviderCollection = getCustomConfigProviders();
         if (providers.size === 0) {
@@ -633,8 +670,8 @@ class DefaultClient implements Client {
                     }
 
                     providerName = provider.name;
-                    if (await provider.canProvideConfiguration(document.uri, tokenSource.token)) {
-                        return provider.provideConfigurations([document.uri], tokenSource.token);
+                    if (await provider.canProvideConfiguration(tuUri, tokenSource.token)) {
+                        return provider.provideConfigurations([tuUri], tokenSource.token);
                     }
                 }
             } catch (err) {
@@ -647,14 +684,19 @@ class DefaultClient implements Client {
             (configs: SourceFileConfigurationItem[]) => {
                 if (configs && configs.length > 0) {
                     this.sendCustomConfigurations(configs, true);
+                    if (response.configDisposition === QueryTranslationUnitSourceConfigDisposition.AncestorConfigNeeded) {
+                        // replacing uri with original uri
+                        let newConfig: SourceFileConfigurationItem =  { uri: document.uri, configuration: configs[0].configuration };
+                        this.sendCustomConfigurations([newConfig], true);
+                    }
                 }
             },
             (err) => {
                 if (err === notReadyMessage) {
                     return;
                 }
                 let settings: CppSettings = new CppSettings(this.RootUri);
-                if (settings.configurationWarnings === "Enabled" && !this.isExternalHeader(document) && !vscode.debug.activeDebugSession) {
+                if (settings.configurationWarnings === "Enabled" && !this.isExternalHeader(document.uri) && !vscode.debug.activeDebugSession) {
                     const dismiss: string = "Dismiss";
                     const disable: string = "Disable Warnings";
                     let message: string = `'${providerName}' is unable to provide IntelliSense configuration information for '${document.uri.fsPath}'. ` +
@@ -675,8 +717,8 @@ class DefaultClient implements Client {
             });
     }
 
-    private isExternalHeader(document: vscode.TextDocument): boolean {
-        return util.isHeader(document) && !document.uri.toString().startsWith(this.RootUri.toString());
+    private isExternalHeader(uri: vscode.Uri): boolean {
+        return util.isHeader(uri) && !uri.toString().startsWith(this.RootUri.toString());
     }
 
     private getCustomConfigurationProviderId(): Thenable<string|undefined> {

Extension/src/common.ts

@@ -149,8 +149,8 @@ export function getVcpkgRoot(): string {
  * For the purposes of this function, a header file has no extension, or an extension that begins with the letter 'h'.
  * @param document The document to check.
  */
-export function isHeader(document: vscode.TextDocument): boolean {
-    let ext: string = path.extname(document.uri.fsPath);
+export function isHeader(uri: vscode.Uri): boolean {
+    let ext: string = path.extname(uri.fsPath);
     return !ext || ext.startsWith(".h") || ext.startsWith(".H");
 }