Merge pull request #41525 from ahoppen/pr/split-codecompletion-cpp

[CodeCompletion] Split CodeCompletion.cpp into multiple files

Author: ahoppen

include/swift/IDE/CodeCompletion.h

@@ -15,6 +15,8 @@
 
 #include "swift/Basic/ThreadSafeRefCounted.h"
 #include "swift/IDE/CodeCompletion.h"
+#include "swift/IDE/CodeCompletionResult.h"
+#include "swift/IDE/CodeCompletionString.h"
 #include "llvm/ADT/Hashing.h"
 #include "llvm/ADT/IntrusiveRefCntPtr.h"
 #include "llvm/Support/Chrono.h"

include/swift/IDE/CodeCompletionCache.h

@@ -0,0 +1,52 @@
+//===--- CodeCompletionConsumer.h -----------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IDE_CODECOMPLETIONCONSUMER
+#define SWIFT_IDE_CODECOMPLETIONCONSUMER
+
+#include "swift/IDE/CodeCompletionContext.h"
+#include "swift/Parse/CodeCompletionCallbacks.h"
+
+namespace swift {
+namespace ide {
+
+struct RequestedCachedModule;
+
+/// An abstract base class for consumers of code completion results.
+/// \see \c SimpleCachingCodeCompletionConsumer.
+class CodeCompletionConsumer {
+public:
+  virtual ~CodeCompletionConsumer() {}
+  virtual void
+  handleResultsAndModules(CodeCompletionContext &context,
+                          ArrayRef<RequestedCachedModule> requestedModules,
+                          DeclContext *DC) = 0;
+};
+
+/// A simplified code completion consumer interface that clients can use to get
+/// CodeCompletionResults with automatic caching of top-level completions from
+/// imported modules.
+struct SimpleCachingCodeCompletionConsumer : public CodeCompletionConsumer {
+
+  // Implement the CodeCompletionConsumer interface.
+  void handleResultsAndModules(CodeCompletionContext &context,
+                               ArrayRef<RequestedCachedModule> requestedModules,
+                               DeclContext *DCForModules) override;
+
+  /// Clients should override this method to receive \p Results.
+  virtual void handleResults(CodeCompletionContext &context) = 0;
+};
+
+} // end namespace ide
+} // end namespace swift
+
+#endif // SWIFT_IDE_CODECOMPLETIONCONSUMER

include/swift/IDE/CodeCompletionConsumer.h

@@ -0,0 +1,106 @@
+//===--- CodeCompletionContext.h ------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IDE_CODECOMPLETIONCONTEXT
+#define SWIFT_IDE_CODECOMPLETIONCONTEXT
+
+#include "swift/IDE/CodeCompletionResult.h"
+#include "swift/IDE/CodeCompletionResultSink.h"
+
+namespace swift {
+namespace ide {
+
+class CodeCompletionCache;
+
+class CodeCompletionContext {
+  friend class CodeCompletionResultBuilder;
+
+  /// A set of current completion results.
+  CodeCompletionResultSink CurrentResults;
+
+public:
+  CodeCompletionCache &Cache;
+  CompletionKind CodeCompletionKind = CompletionKind::None;
+
+  enum class TypeContextKind {
+    /// There is no known contextual type. All types are equally good.
+    None,
+
+    /// There is a contextual type from a single-expression closure/function
+    /// body. The context is a hint, and enables unresolved member completion,
+    /// but should not hide any results.
+    SingleExpressionBody,
+
+    /// There are known contextual types, or there aren't but a nonvoid type is
+    /// expected.
+    Required,
+  };
+
+  TypeContextKind typeContextKind = TypeContextKind::None;
+
+  /// Whether there may be members that can use implicit member syntax,
+  /// e.g. `x = .foo`.
+  bool MayUseImplicitMemberExpr = false;
+
+  /// Flag to indicate that the completion is happening reusing ASTContext
+  /// from the previous completion.
+  /// NOTE: Do not use this to change the behavior. This is only for debugging.
+  bool ReusingASTContext = false;
+
+  CodeCompletionContext(CodeCompletionCache &Cache) : Cache(Cache) {}
+
+  void setAnnotateResult(bool flag) { CurrentResults.annotateResult = flag; }
+  bool getAnnotateResult() const { return CurrentResults.annotateResult; }
+
+  void setIncludeObjectLiterals(bool flag) {
+    CurrentResults.includeObjectLiterals = flag;
+  }
+  bool includeObjectLiterals() const {
+    return CurrentResults.includeObjectLiterals;
+  }
+
+  void setAddInitsToTopLevel(bool flag) {
+    CurrentResults.addInitsToTopLevel = flag;
+  }
+  bool getAddInitsToTopLevel() const {
+    return CurrentResults.addInitsToTopLevel;
+  }
+
+  void setCallPatternHeuristics(bool flag) {
+    CurrentResults.enableCallPatternHeuristics = flag;
+  }
+  bool getCallPatternHeuristics() const {
+    return CurrentResults.enableCallPatternHeuristics;
+  }
+
+  void setAddCallWithNoDefaultArgs(bool flag) {
+    CurrentResults.addCallWithNoDefaultArgs = flag;
+  }
+  bool addCallWithNoDefaultArgs() const {
+    return CurrentResults.addCallWithNoDefaultArgs;
+  }
+
+  /// Allocate a string owned by the code completion context.
+  StringRef copyString(StringRef Str);
+
+  /// Sort code completion results in an implementation-defined order
+  /// in place.
+  static std::vector<CodeCompletionResult *>
+  sortCompletionResults(ArrayRef<CodeCompletionResult *> Results);
+
+  CodeCompletionResultSink &getResultSink() { return CurrentResults; }
+};
+
+} // end namespace ide
+} // end namespace swift
+
+#endif // SWIFT_IDE_CODECOMPLETIONCONTEXT