Merge pull request swiftlang#26191 from nkcsgexi/range-info-request

IDE+Evaluator: refactor range info resolver to an IDE evaluator request. NFC

Author: nkcsgexi

include/swift/IDE/IDERequestIDZone.def

@@ -15,3 +15,4 @@
 //
 //===----------------------------------------------------------------------===//
 SWIFT_TYPEID(CursorInfoRequest)
+SWIFT_TYPEID(RangeInfoRequest)

include/swift/IDE/IDERequests.h

@@ -23,6 +23,9 @@
 #include "swift/IDE/IDETypeIDs.h"
 
 namespace swift {
+//----------------------------------------------------------------------------//
+// Cusor info
+//----------------------------------------------------------------------------//
 
 // Input for CursorInfoRequest.
 // Putting the source file and location together allows us to print the request
@@ -76,6 +79,67 @@ class CursorInfoRequest:
   SourceLoc getNearestLoc() const;
 };
 
+//----------------------------------------------------------------------------//
+// Range info
+//----------------------------------------------------------------------------//
+
+// Input for RangeInfoRequest.
+// Putting the source file and location together allows us to print the request
+// input well e.g. file.swift:3:4
+struct RangeInfoOwner {
+  SourceFile *File;
+  SourceLoc StartLoc;
+  SourceLoc EndLoc;
+
+  RangeInfoOwner(SourceFile *File, SourceLoc StartLoc, SourceLoc EndLoc):
+    File(File), StartLoc(StartLoc), EndLoc(EndLoc) {}
+  RangeInfoOwner(SourceFile *File, unsigned Offset, unsigned Length);
+
+  friend llvm::hash_code hash_value(const RangeInfoOwner &CI) {
+    return hash_combine(hash_value(CI.File),
+                        hash_value(CI.StartLoc.getOpaquePointerValue()),
+                        hash_value(CI.EndLoc.getOpaquePointerValue()));
+  }
+
+  friend bool operator==(const RangeInfoOwner &lhs, const RangeInfoOwner &rhs) {
+    return lhs.File == rhs.File && lhs.StartLoc == rhs.StartLoc &&
+      lhs.EndLoc == rhs.EndLoc;
+  }
+
+  friend bool operator!=(const RangeInfoOwner &lhs, const RangeInfoOwner &rhs) {
+    return !(lhs == rhs);
+  }
+
+  bool isValid() const {
+    return File && File->getBufferID() && StartLoc.isValid() && EndLoc.isValid();
+  }
+};
+
+void simple_display(llvm::raw_ostream &out, const RangeInfoOwner &owner);
+
+/// Resolve cursor info at a given location.
+class RangeInfoRequest:
+    public SimpleRequest<RangeInfoRequest,
+                         ide::ResolvedRangeInfo(RangeInfoOwner),
+                         CacheKind::Cached>
+{
+public:
+  using SimpleRequest::SimpleRequest;
+
+private:
+  friend SimpleRequest;
+
+  // Evaluation.
+  llvm::Expected<ide::ResolvedRangeInfo> evaluate(Evaluator &evaluator,
+    RangeInfoOwner CI) const;
+
+public:
+  // Caching
+  bool isCached() const { return true; }
+  // Source location
+  SourceLoc getNearestLoc() const;
+};
+
 /// The zone number for the IDE.
 #define SWIFT_IDE_REQUESTS_TYPEID_ZONE 137
 #define SWIFT_TYPEID_ZONE SWIFT_IDE_REQUESTS_TYPEID_ZONE

include/swift/IDE/IDETypeIDZone.def

@@ -15,3 +15,4 @@
 //
 //===----------------------------------------------------------------------===//
 SWIFT_TYPEID_NAMED(ide::ResolvedCursorInfo, ResolvedCursorInfo)
+SWIFT_TYPEID_NAMED(ide::ResolvedRangeInfo, ResolvedRangeInfo)

include/swift/IDE/Utils.h

@@ -368,32 +368,26 @@ struct ResolvedRangeInfo {
                     TokensInRange, nullptr, /*Commom Expr Parent*/nullptr,
                     /*Single entry*/true, /*unhandled error*/false,
                     OrphanKind::None, {}, {}, {}) {}
-  void print(llvm::raw_ostream &OS);
+  ResolvedRangeInfo(): ResolvedRangeInfo(ArrayRef<Token>()) {}
+  void print(llvm::raw_ostream &OS) const;
   ExitState exit() const { return ExitInfo.Exit; }
   Type getType() const { return ExitInfo.ReturnType; }
 
+  friend bool operator==(const ResolvedRangeInfo &lhs,
+                         const ResolvedRangeInfo &rhs) {
+    if (lhs.TokensInRange.size() != rhs.TokensInRange.size())
+      return false;
+    if (lhs.TokensInRange.empty())
+      return true;
+    return lhs.TokensInRange.front().getLoc() ==
+      rhs.TokensInRange.front().getLoc();
+  }
+
 private:
   static CharSourceRange calculateContentRange(ArrayRef<Token> Tokens);
 };
 
-class RangeResolver : public SourceEntityWalker {
-  struct Implementation;
-  std::unique_ptr<Implementation> Impl;
-  bool walkToExprPre(Expr *E) override;
-  bool walkToExprPost(Expr *E) override;
-  bool walkToStmtPre(Stmt *S) override;
-  bool walkToStmtPost(Stmt *S) override;
-  bool walkToDeclPre(Decl *D, CharSourceRange Range) override;
-  bool walkToDeclPost(Decl *D) override;
-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
-                          ReferenceMetaData Data) override;
-public:
-  RangeResolver(SourceFile &File, SourceLoc Start, SourceLoc End);
-  RangeResolver(SourceFile &File, unsigned Offset, unsigned Length);
-  ~RangeResolver();
-  ResolvedRangeInfo resolve();
-};
+void simple_display(llvm::raw_ostream &out, const ResolvedRangeInfo &info);
 
 /// This provides a utility to view a printed name by parsing the components
 /// of that name. The components include a base name and an array of argument