[IDE] Support reporting multiple cursor results

This hooks up the cursor info infrastructure to be able to pass through multiple, ambiguous results. There are still minor issues that cause solver-based cursor info to not actually report the ambiguous results but those will be fixed in a follow-up PR.

Author: ahoppen

include/swift/IDE/CursorInfo.h

@@ -26,7 +26,7 @@ namespace ide {
 class CursorInfoConsumer {
 public:
   virtual ~CursorInfoConsumer() {}
-  virtual void handleResults(ResolvedCursorInfoPtr) = 0;
+  virtual void handleResults(SmallVector<ResolvedCursorInfoPtr>) = 0;
 };
 
 /// Create a factory for code completion callbacks.

include/swift/IDETool/IDEInspectionInstance.h

@@ -81,8 +81,8 @@ struct ConformingMethodListResults {
 
 /// The results returned from \c IDEInspectionInstance::cursorInfo.
 struct CursorInfoResults {
-  /// The actual results. If \c nullptr, no results were found.
-  ResolvedCursorInfoPtr Result;
+  /// The actual results.
+  SmallVector<ResolvedCursorInfoPtr> ResolvedCursorInfos;
   /// Whether an AST was reused to produce the results.
   bool DidReuseAST;
 };

lib/IDE/CursorInfo.cpp

@@ -321,9 +321,9 @@ class CursorInfoDoneParsingCallback : public IDEInspectionCallbacks {
       : IDEInspectionCallbacks(P), Consumer(Consumer),
         RequestedLoc(RequestedLoc) {}
 
-  ResolvedCursorInfoPtr getDeclResult(NodeFinderDeclResult *DeclResult,
-                                      SourceFile *SrcFile,
-                                      NodeFinder &Finder) const {
+  SmallVector<ResolvedCursorInfoPtr>
+  getDeclResult(NodeFinderDeclResult *DeclResult, SourceFile *SrcFile,
+                NodeFinder &Finder) const {
     typeCheckDeclAndParentClosures(DeclResult->getDecl());
     ResolvedValueRefCursorInfoPtr CursorInfo = new ResolvedValueRefCursorInfo(
         new ResolvedCursorInfo(SrcFile), DeclResult->getDecl(),
@@ -333,12 +333,12 @@ class CursorInfoDoneParsingCallback : public IDEInspectionCallbacks {
     CursorInfo->setLoc(RequestedLoc);
     CursorInfo->setShorthandShadowedDecls(
         Finder.getShorthandShadowedDecls(DeclResult->getDecl()));
-    return CursorInfo;
+    return {CursorInfo};
   }
 
-  ResolvedCursorInfoPtr getExprResult(NodeFinderExprResult *ExprResult,
-                                      SourceFile *SrcFile,
-                                      NodeFinder &Finder) const {
+  SmallVector<ResolvedCursorInfoPtr>
+  getExprResult(NodeFinderExprResult *ExprResult, SourceFile *SrcFile,
+                NodeFinder &Finder) const {
     Expr *E = ExprResult->getExpr();
     DeclContext *DC = ExprResult->getDeclContext();
 
@@ -351,7 +351,7 @@ class CursorInfoDoneParsingCallback : public IDEInspectionCallbacks {
 
     if (Callback.getResults().empty()) {
       // No results.
-      return nullptr;
+      return {};
     }
 
     for (auto Info : Callback.getResults()) {
@@ -360,34 +360,32 @@ class CursorInfoDoneParsingCallback : public IDEInspectionCallbacks {
       typeCheckDeclAndParentClosures(Info.ReferencedDecl);
     }
 
-    if (Callback.getResults().size() != 1) {
-      // FIXME: We need to be able to report multiple results.
-      return nullptr;
-    }
-
     // Deliver results
 
-    auto Res = Callback.getResults()[0];
-    ResolvedValueRefCursorInfoPtr CursorInfo = new ResolvedValueRefCursorInfo(
-        new ResolvedCursorInfo(SrcFile), Res.ReferencedDecl,
-        /*CtorTyRef=*/nullptr,
-        /*ExtTyRef=*/nullptr, /*IsRef=*/true, /*Ty=*/Type(),
-        /*ContainerType=*/Res.BaseType);
-    CursorInfo->setLoc(RequestedLoc);
-    CursorInfo->setIsDynamic(Res.IsDynamicRef);
-    if (Res.IsDynamicRef && Res.BaseType) {
-      if (auto ReceiverType = Res.BaseType->getAnyNominal()) {
-        CursorInfo->setReceiverTypes({ReceiverType});
-      } else if (auto MT = Res.BaseType->getAs<AnyMetatypeType>()) {
-        // Look through metatypes to get the nominal type decl.
-        if (auto ReceiverType = MT->getInstanceType()->getAnyNominal()) {
+    SmallVector<ResolvedCursorInfoPtr> Results;
+    for (auto Res : Callback.getResults()) {
+      ResolvedValueRefCursorInfoPtr CursorInfo = new ResolvedValueRefCursorInfo(
+          new ResolvedCursorInfo(SrcFile), Res.ReferencedDecl,
+          /*CtorTyRef=*/nullptr,
+          /*ExtTyRef=*/nullptr, /*IsRef=*/true, /*Ty=*/Type(),
+          /*ContainerType=*/Res.BaseType);
+      CursorInfo->setLoc(RequestedLoc);
+      CursorInfo->setIsDynamic(Res.IsDynamicRef);
+      if (Res.IsDynamicRef && Res.BaseType) {
+        if (auto ReceiverType = Res.BaseType->getAnyNominal()) {
           CursorInfo->setReceiverTypes({ReceiverType});
+        } else if (auto MT = Res.BaseType->getAs<AnyMetatypeType>()) {
+          // Look through metatypes to get the nominal type decl.
+          if (auto ReceiverType = MT->getInstanceType()->getAnyNominal()) {
+            CursorInfo->setReceiverTypes({ReceiverType});
+          }
         }
       }
+      CursorInfo->setShorthandShadowedDecls(
+          Finder.getShorthandShadowedDecls(Res.ReferencedDecl));
+      Results.push_back(CursorInfo);
     }
-    CursorInfo->setShorthandShadowedDecls(
-        Finder.getShorthandShadowedDecls(Res.ReferencedDecl));
-    return CursorInfo;
+    return Results;
   }
 
   void doneParsing(SourceFile *SrcFile) override {
@@ -400,7 +398,7 @@ class CursorInfoDoneParsingCallback : public IDEInspectionCallbacks {
     if (!Result) {
       return;
     }
-    ResolvedCursorInfoPtr CursorInfo;
+    SmallVector<ResolvedCursorInfoPtr> CursorInfo;
     switch (Result->getKind()) {
     case NodeFinderResultKind::Decl:
       CursorInfo = getDeclResult(cast<NodeFinderDeclResult>(Result.get()),

lib/IDETool/IDEInspectionInstance.cpp

@@ -827,7 +827,7 @@ void swift::ide::IDEInspectionInstance::cursorInfo(
         : ReusingASTContext(ReusingASTContext),
           CancellationFlag(CancellationFlag), Callback(Callback) {}
 
-    void handleResults(ResolvedCursorInfoPtr result) override {
+    void handleResults(SmallVector<ResolvedCursorInfoPtr> result) override {
       HandleResultsCalled = true;
       if (CancellationFlag &&
           CancellationFlag->load(std::memory_order_relaxed)) {
@@ -852,8 +852,8 @@ void swift::ide::IDEInspectionInstance::cursorInfo(
                   ide::makeCursorInfoCallbacksFactory(Consumer, RequestedLoc));
 
               if (!Result.DidFindIDEInspectionTarget) {
-                return DeliverTransformed(ResultType::success(
-                    {/*Results=*/nullptr, Result.DidReuseAST}));
+                return DeliverTransformed(
+                    ResultType::success({/*Results=*/{}, Result.DidReuseAST}));
               }
 
               performIDEInspectionSecondPass(
@@ -863,8 +863,8 @@ void swift::ide::IDEInspectionInstance::cursorInfo(
                 // pass, we didn't receive any results. To make sure Callback
                 // gets called exactly once, call it manually with no results
                 // here.
-                DeliverTransformed(ResultType::success(
-                    {/*Results=*/nullptr, Result.DidReuseAST}));
+                DeliverTransformed(
+                    ResultType::success({/*Results=*/{}, Result.DidReuseAST}));
               }
             },
             Callback);

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -586,11 +586,14 @@ struct CursorInfoData {
   // will be empty). Clients can potentially use this to show a diagnostic
   // message to the user in lieu of using the empty response.
   StringRef InternalDiagnostic;
-  llvm::ArrayRef<CursorSymbolInfo> Symbols;
+  llvm::SmallVector<CursorSymbolInfo, 1> Symbols;
   /// All available actions on the code under cursor.
-  llvm::ArrayRef<RefactoringInfo> AvailableActions;
+  llvm::SmallVector<RefactoringInfo, 8> AvailableActions;
   /// Whether the ASTContext was reused for this cursor info.
   bool DidReuseAST = false;
+  /// An allocator that can be used to allocate data that is referenced by this
+  /// \c CursorInfoData.
+  llvm::BumpPtrAllocator Allocator;
 
   void print(llvm::raw_ostream &OS, std::string Indentation) const {
     OS << Indentation << "CursorInfoData" << '\n';