Implement usage completion (#701)

Author: Gama11

External/Plugins/HaXeContext/Completion/HaxeComplete.cs

@@ -37,7 +37,7 @@ internal class HaxeComplete
         public HaxeCompleteStatus Status;
         public string Errors;
         private HaxeCompleteResult result;
-        private HaxePositionCompleteResult positionResult;
+        private List<HaxePositionResult> positionResults;
 
         readonly IHaxeCompletionHandler handler;
         readonly string FileName;
@@ -58,23 +58,27 @@ public HaxeComplete(ScintillaControl sci, ASExpr expr, bool autoHide, IHaxeCompl
 
         public void GetList(HaxeCompleteResultHandler<HaxeCompleteResult> callback)
         {
-            PluginBase.MainForm.CallCommand("Save", null);
+            StartThread(callback, () => result);
+        }
 
-            ThreadPool.QueueUserWorkItem(_ =>
-            {
-                Status = ParseLines(handler.GetCompletion(BuildHxmlArgs()));
-                Notify(callback, result);
-            });
+        public void GetPosition(HaxeCompleteResultHandler<HaxePositionResult> callback)
+        {
+            StartThread(callback, () => positionResults.Count > 0 ? positionResults[0] : null);
+        }
+
+        public void GetUsages(HaxeCompleteResultHandler<List<HaxePositionResult>> callback)
+        {
+            StartThread(callback, () => positionResults);
         }
 
-        public void GetPosition(HaxeCompleteResultHandler<HaxePositionCompleteResult> callback)
+        private void StartThread<T>(HaxeCompleteResultHandler<T> callback, Func<T> resultFunc)
         {
             PluginBase.MainForm.CallCommand("Save", null);
 
             ThreadPool.QueueUserWorkItem(_ =>
             {
                 Status = ParseLines(handler.GetCompletion(BuildHxmlArgs()));
-                Notify(callback, positionResult);
+                Notify(callback, resultFunc());
             });
         }
 
@@ -121,8 +125,7 @@ string[] BuildHxmlArgs()
             else
                 hxmlArgs.Add(GetMainClassName());
 
-            String mode = (CompilerService == HaxeCompilerService.COMPLETION) ? "" : "@position";
-            hxmlArgs.Insert(0, String.Format("--display \"{0}\"@{1}{2}", FileName, pos, mode));
+            hxmlArgs.Insert(0, String.Format("--display \"{0}\"@{1}{2}", FileName, pos, GetMode()));
             hxmlArgs.Insert(1, "-D use_rtti_doc");
             hxmlArgs.Insert(2, "-D display-details");
 
@@ -131,6 +134,20 @@ string[] BuildHxmlArgs()
             return hxmlArgs.ToArray();
         }
 
+        string GetMode()
+        {
+            switch (CompilerService)
+            {
+                case HaxeCompilerService.POSITION:
+                    return "@position";
+
+                case HaxeCompilerService.USAGE:
+                    return "@usage";
+            }
+
+            return "";
+        }
+
         void QuotePath(List<string> hxmlArgs)
         {
             for (int i = 0; i < hxmlArgs.Count; i++)
@@ -235,6 +252,7 @@ HaxeCompleteStatus ProcessList(XmlTextReader reader)
         {
             result = new HaxeCompleteResult();
             result.Members = new MemberList();
+            positionResults = new List<HaxePositionResult>();
             MemberModel member = null;
 
             while (reader.Read())
@@ -244,7 +262,19 @@ HaxeCompleteStatus ProcessList(XmlTextReader reader)
                     switch (reader.Name)
                     {
                         case "list":
-                            return HaxeCompleteStatus.MEMBERS;
+                            switch (CompilerService)
+                            {
+                                case HaxeCompilerService.COMPLETION:
+                                    return HaxeCompleteStatus.MEMBERS;
+
+                                case HaxeCompilerService.POSITION:
+                                    return HaxeCompleteStatus.POSITION;
+
+                                case HaxeCompilerService.USAGE:
+                                    return HaxeCompleteStatus.USAGE;
+                            }
+                            break;
+
                         case "i":
                             member = null;
                             break;
@@ -273,16 +303,16 @@ HaxeCompleteStatus ProcessList(XmlTextReader reader)
                         break;
 
                     case "pos":
-                        positionResult = ExtractPos(reader);
-                        return HaxeCompleteStatus.POSITION;
+                        positionResults.Add(ExtractPos(reader));
+                        break;
                 }
             }
             return HaxeCompleteStatus.MEMBERS;
         }
 
-        HaxePositionCompleteResult ExtractPos(XmlTextReader reader)
+        HaxePositionResult ExtractPos(XmlTextReader reader)
         {
-            var result = new HaxePositionCompleteResult();
+            var result = new HaxePositionResult();
 
             string value = ReadValue(reader);
             Match match = rePosition.Match(value);
@@ -388,13 +418,15 @@ enum HaxeCompleteStatus: int
         ERROR = 2,
         TYPE = 3,
         MEMBERS = 4,
-        POSITION = 5
+        POSITION = 5,
+        USAGE = 6
     }
 
     enum HaxeCompilerService
     {
         COMPLETION,
-        POSITION
+        POSITION,
+        USAGE
     }
 
     class HaxeCompleteResult
@@ -403,7 +435,7 @@ class HaxeCompleteResult
         public MemberList Members;
     }
 
-    class HaxePositionCompleteResult
+    class HaxePositionResult
     {
         public string Path;
         public HaxePositionCompleteRangeType RangeType;

External/Plugins/HaXeContext/Context.cs

@@ -1410,23 +1410,23 @@ public override bool HandleGotoDeclaration(ScintillaControl sci, ASExpr expressi
                 return false;
 
             var hc = new HaxeComplete(sci, expression, false, completionModeHandler, HaxeCompilerService.POSITION);
-            hc.GetPosition(OnPositionCompletionResult);
+            hc.GetPosition(OnPositionResult);
             return true;
         }
 
-        internal void OnPositionCompletionResult(HaxeComplete hc, HaxePositionCompleteResult result, HaxeCompleteStatus status)
+        internal void OnPositionResult(HaxeComplete hc, HaxePositionResult result, HaxeCompleteStatus status)
         {
             if (hc.Sci.InvokeRequired)
             {
                 hc.Sci.BeginInvoke((MethodInvoker)delegate
                 {
-                    HandlePositionCompletionResult(hc, result, status); 
+                    HandlePositionResult(hc, result, status); 
                 });
             }
-            else HandlePositionCompletionResult(hc, result, status); 
+            else HandlePositionResult(hc, result, status); 
         }
 
-        private void HandlePositionCompletionResult(HaxeComplete hc, HaxePositionCompleteResult result, HaxeCompleteStatus status)
+        private void HandlePositionResult(HaxeComplete hc, HaxePositionResult result, HaxeCompleteStatus status)
         {
             switch (status)
             {
@@ -1435,6 +1435,8 @@ private void HandlePositionCompletionResult(HaxeComplete hc, HaxePositionComplet
                     break;
 
                 case HaxeCompleteStatus.POSITION:
+                    if (result == null) return;
+
                     ASComplete.SaveLastLookupPosition(hc.Sci);
 
                     PluginBase.MainForm.OpenEditableDocument(result.Path, false);