Merge pull request swiftlang#26155 from nkcsgexi/request-cursor-info

Sourcekit+Evaluator: refactor cursor-info resolver to using the evaluator model. NFC

Author: nkcsgexi

include/swift/Basic/Statistics.def

@@ -227,6 +227,7 @@ FRONTEND_STATISTIC(Sema, NumUnloadedLazyIterableDeclContexts)
 #include "swift/AST/AccessTypeIDZone.def"
 #include "swift/AST/NameLookupTypeIDZone.def"
 #include "swift/AST/TypeCheckerTypeIDZone.def"
+#include "swift/IDE/IDERequestIDZone.def"
 #undef SWIFT_TYPEID
 
 /// The next 10 statistics count 5 kinds of SIL entities present

include/swift/IDE/IDERequestIDZone.def

@@ -0,0 +1,17 @@
+//===-------- IDERequestIDZone.def ------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This definition file describes the types in the IDE requests
+//  TypeID zone, for use with the TypeID template.
+//
+//===----------------------------------------------------------------------===//
+SWIFT_TYPEID(CursorInfoRequest)

include/swift/IDE/IDERequests.h

@@ -0,0 +1,99 @@
+//===----- IDERequests.h - IDE functionality Requests -----------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This file defines IDE request using the evaluator model.
+//
+//===----------------------------------------------------------------------===//
+#ifndef SWIFT_IDE_REQUESTS_H
+#define SWIFT_IDE_REQUESTS_H
+
+#include "swift/AST/ASTTypeIDs.h"
+#include "swift/AST/Evaluator.h"
+#include "swift/AST/SimpleRequest.h"
+#include "swift/IDE/Utils.h"
+#include "swift/IDE/IDETypeIDs.h"
+
+namespace swift {
+
+// Input for CursorInfoRequest.
+// Putting the source file and location together allows us to print the request
+// input well e.g. file.swift:3:4
+struct CursorInfoOwner {
+  SourceFile *File;
+  SourceLoc Loc;
+
+  CursorInfoOwner(SourceFile *File, SourceLoc Loc): File(File), Loc(Loc) { }
+
+  friend llvm::hash_code hash_value(const CursorInfoOwner &CI) {
+    return hash_combine(hash_value(CI.File),
+      hash_value(CI.Loc.getOpaquePointerValue()));
+  }
+
+  friend bool operator==(const CursorInfoOwner &lhs, const CursorInfoOwner &rhs) {
+    return lhs.File == rhs.File &&
+      lhs.Loc.getOpaquePointerValue() == rhs.Loc.getOpaquePointerValue();
+  }
+
+  friend bool operator!=(const CursorInfoOwner &lhs, const CursorInfoOwner &rhs) {
+    return !(lhs == rhs);
+  }
+  bool isValid() const {
+    return File && File->getBufferID() && Loc.isValid();
+  }
+};
+
+void simple_display(llvm::raw_ostream &out, const CursorInfoOwner &owner);
+
+/// Resolve cursor info at a given location.
+class CursorInfoRequest:
+    public SimpleRequest<CursorInfoRequest,
+                         ide::ResolvedCursorInfo(CursorInfoOwner),
+                         CacheKind::Cached>
+{
+public:
+  using SimpleRequest::SimpleRequest;
+
+private:
+  friend SimpleRequest;
+
+  // Evaluation.
+  llvm::Expected<ide::ResolvedCursorInfo> evaluate(Evaluator &evaluator,
+    CursorInfoOwner 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
+#define SWIFT_TYPEID_HEADER "swift/IDE/IDERequestIDZone.def"
+#include "swift/Basic/DefineTypeIDZone.h"
+#undef SWIFT_TYPEID_ZONE
+#undef SWIFT_TYPEID_HEADER
+
+// Set up reporting of evaluated requests.
+#define SWIFT_TYPEID(RequestType)                                \
+template<>                                                       \
+inline void reportEvaluatedRequest(UnifiedStatsReporter &stats,  \
+                            const RequestType &request) {        \
+  ++stats.getFrontendCounters().RequestType;                     \
+}
+#include "swift/IDE/IDERequestIDZone.def"
+#undef SWIFT_TYPEID
+
+} // end namespace swift
+
+#endif // SWIFT_IDE_REQUESTS_H

include/swift/IDE/IDETypeIDZone.def

@@ -0,0 +1,17 @@
+//===---------- IDETypeIDZone.def ------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This definition file describes the types in the IDE type
+//  TypeID zone, for use with the TypeID template.
+//
+//===----------------------------------------------------------------------===//
+SWIFT_TYPEID_NAMED(ide::ResolvedCursorInfo, ResolvedCursorInfo)

include/swift/IDE/IDETypeIDs.h

@@ -0,0 +1,30 @@
+//===--- IDETypeIDs.h - IDE Type Ids ----------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2019 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This file defines TypeID support for IDE types.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IDE_IDETYPEIDS_H
+#define SWIFT_IDE_IDETYPEIDS_H
+
+#include "swift/Basic/TypeID.h"
+namespace swift {
+
+#define SWIFT_IDE_TYPEID_ZONE 136
+#define SWIFT_TYPEID_ZONE SWIFT_IDE_TYPEID_ZONE
+#define SWIFT_TYPEID_HEADER "swift/IDE/IDETypeIDZone.def"
+#include "swift/Basic/DefineTypeIDZone.h"
+
+} // end namespace swift
+
+#endif // SWIFT_IDE_IDETYPEIDS_H

include/swift/IDE/Utils.h

@@ -163,7 +163,13 @@ struct ResolvedCursorInfo {
 
   ResolvedCursorInfo() = default;
   ResolvedCursorInfo(SourceFile *SF) : SF(SF) {}
-  
+
+  friend bool operator==(const ResolvedCursorInfo &lhs,
+                         const ResolvedCursorInfo &rhs) {
+    return lhs.SF == rhs.SF &&
+      lhs.Loc.getOpaquePointerValue() == rhs.Loc.getOpaquePointerValue();
+  }
+
   void setValueRef(ValueDecl *ValueD,
                    TypeDecl *CtorTyRef,
                    ExtensionDecl *ExtTyRef,
@@ -196,44 +202,7 @@ struct ResolvedCursorInfo {
   bool isInvalid() const { return Kind == CursorInfoKind::Invalid; }
 };
 
-class CursorInfoResolver : public SourceEntityWalker {
-  SourceFile &SrcFile;
-  SourceLoc LocToResolve;
-  ResolvedCursorInfo CursorInfo;
-  Type ContainerType;
-  llvm::SmallVector<Expr*, 4> TrailingExprStack;
-
-public:
-  explicit CursorInfoResolver(SourceFile &SrcFile) :
-    SrcFile(SrcFile), CursorInfo(&SrcFile) {}
-  ResolvedCursorInfo resolve(SourceLoc Loc);
-  SourceManager &getSourceMgr() const;
-private:
-  bool walkToExprPre(Expr *E) override;
-  bool walkToExprPost(Expr *E) override;
-  bool walkToDeclPre(Decl *D, CharSourceRange Range) override;
-  bool walkToDeclPost(Decl *D) override;
-  bool walkToStmtPre(Stmt *S) override;
-  bool walkToStmtPost(Stmt *S) override;
-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
-                          ReferenceMetaData Data) override;
-  bool visitCallArgName(Identifier Name, CharSourceRange Range,
-                        ValueDecl *D) override;
-  bool visitDeclarationArgumentName(Identifier Name, SourceLoc StartLoc,
-                                    ValueDecl *D) override;
-  bool visitModuleReference(ModuleEntity Mod, CharSourceRange Range) override;
-  bool rangeContainsLoc(SourceRange Range) const;
-  bool rangeContainsLoc(CharSourceRange Range) const;
-  bool isDone() const { return CursorInfo.isValid(); }
-  bool tryResolve(ValueDecl *D, TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
-                  SourceLoc Loc, bool IsRef, Type Ty = Type());
-  bool tryResolve(ModuleEntity Mod, SourceLoc Loc);
-  bool tryResolve(Stmt *St);
-  bool visitSubscriptReference(ValueDecl *D, CharSourceRange Range,
-                               ReferenceMetaData Data,
-                               bool IsOpenBracket) override;
-};
+void simple_display(llvm::raw_ostream &out, const ResolvedCursorInfo &info);
 
 struct UnresolvedLoc {
   SourceLoc Loc;

include/swift/Subsystems.h

@@ -396,6 +396,11 @@ namespace swift {
   /// ASTContext.
   void registerTypeCheckerRequestFunctions(Evaluator &evaluator);
 
+  /// Register IDE-level request functions with the evaluator.
+  ///
+  /// The ASTContext will automatically call these upon construction.
+  void registerIDERequestFunctions(Evaluator &evaluator);
+
 } // end namespace swift
 
 #endif // SWIFT_SUBSYSTEMS_H

lib/IDE/CMakeLists.txt

@@ -14,7 +14,8 @@ add_swift_host_library(swiftIDE STATIC
   IDETypeChecking.cpp
   APIDigesterData.cpp
   SourceEntityWalker.cpp
-  TypeContextInfo.cpp)
+  TypeContextInfo.cpp
+  IDERequests.cpp)
 target_link_libraries(swiftIDE PRIVATE
   swiftAST
   swiftClangImporter