Merge pull request #125 from MikhailArkhipov/master

Add document URI to the completion extensibility

Author: Mikhail Arkhipov

src/Analysis/Engine/Impl/Definitions/IModuleAnalysis.cs

@@ -14,16 +14,38 @@
 // See the Apache Version 2.0 License for specific language governing
 // permissions and limitations under the License.
 
+using System;
 using System.Collections.Generic;
 using Microsoft.PythonTools.Interpreter;
 using Microsoft.PythonTools.Parsing.Ast;
 
 namespace Microsoft.PythonTools.Analysis {
     public interface IModuleAnalysis {
+        /// <summary>
+        /// Module document/file URI. Can be null if there is no associated document.
+        /// </summary>
+        Uri DocumentUri { get; }
+
+        /// <summary>
+        /// Analysis version
+        /// </summary>
         int Version { get; }
+
         IModuleContext InterpreterContext { get; }
+
+        /// <summary>
+        /// Python analyzer
+        /// </summary>
         PythonAnalyzer ProjectState { get; }
+
+        /// <summary>
+        /// Scope of the analysis
+        /// </summary>
         IScope Scope { get; }
+
+        /// <summary>
+        /// Module name.
+        /// </summary>
         string ModuleName { get; }
 
         /// <summary>

src/Analysis/Engine/Impl/ModuleAnalysis.cs

@@ -41,13 +41,15 @@ public sealed class ModuleAnalysis : IModuleAnalysis {
         private static readonly IEnumerable<IOverloadResult> GetSignaturesError =
             new[] { new OverloadResult(new ParameterResult[0], "Unknown", "IntellisenseError_Sigs", null) };
 
-        internal ModuleAnalysis(AnalysisUnit unit, InterpreterScope scope, int version) {
+        internal ModuleAnalysis(AnalysisUnit unit, InterpreterScope scope, Uri documentUri, int version) {
             _unit = unit;
             Scope = scope;
+            DocumentUri = documentUri;
             Version = version;
         }
 
         #region Public API
+        public Uri DocumentUri { get; }
         public int Version { get; }
         /// <summary>
         /// Evaluates the given expression in at the provided line number and returns the values

src/Analysis/Engine/Impl/ProjectEntry.cs

@@ -315,6 +315,7 @@ where lastDot > 0
             Analysis = new ModuleAnalysis(
                 _unit,
                 ((ModuleScope)_unit.Scope).CloneForPublish(),
+                DocumentUri,
                 AnalysisVersion
             );
         }

src/Analysis/Engine/Test/LanguageServerTests.cs

@@ -644,7 +644,7 @@ public Task<IReadOnlyDictionary<string, object>> ExecuteCommand(string command,
             #endregion
 
             #region ICompletionExtension
-            public Task HandleCompletionAsync(IModuleAnalysis analysis, PythonAst tree, SourceLocation location, CompletionList completions, CancellationToken token) {
+            public Task HandleCompletionAsync(Uri documentUri, IModuleAnalysis analysis, PythonAst tree, SourceLocation location, CompletionList completions, CancellationToken token) {
                 Assert.IsNotNull(tree);
                 Assert.IsNotNull(analysis);
                 for (int i = 0; i < completions.items.Length; ++i) {

src/LanguageServer/Impl/Extensions/ICompletionExtension.cs

@@ -14,6 +14,7 @@
 // See the Apache Version 2.0 License for specific language governing
 // permissions and limitations under the License.
 
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.PythonTools;
@@ -22,6 +23,6 @@
 
 namespace Microsoft.Python.LanguageServer.Extensions {
     public interface ICompletionExtension {
-        Task HandleCompletionAsync(IModuleAnalysis analysis, PythonAst tree, SourceLocation location, CompletionList completions, CancellationToken token);
+        Task HandleCompletionAsync(Uri documentUri, IModuleAnalysis analysis, PythonAst tree, SourceLocation location, CompletionList completions, CancellationToken token);
     }
 }

src/LanguageServer/Impl/Implementation/Server.Completion.cs

@@ -98,7 +98,7 @@ public override async Task<CompletionList> Completion(CompletionParams @params,
             }
 
             await InvokeExtensionsAsync((ext, token)
-                => (ext as ICompletionExtension)?.HandleCompletionAsync(analysis, tree, @params.position, res, cancellationToken), cancellationToken);
+                => (ext as ICompletionExtension)?.HandleCompletionAsync(uri, analysis, tree, @params.position, res, cancellationToken), cancellationToken);
 
             return res;
         }