Merge pull request #37878 from rintaro/5.5-ide-completion-flair

[5.5][CodeCompletion] Fine grained prioritization

Author: tkremenek

include/swift/IDE/CodeCompletion.h

@@ -16,6 +16,7 @@
 #include "swift/AST/Identifier.h"
 #include "swift/Basic/Debug.h"
 #include "swift/Basic/LLVM.h"
+#include "swift/Basic/OptionSet.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/StringMap.h"
 #include "llvm/ADT/StringRef.h"
@@ -32,12 +33,14 @@ class Decl;
 class DeclContext;
 class FrontendOptions;
 class ModuleDecl;
+class SourceFile;
 
 namespace ide {
 
 class CodeCompletionCache;
 class CodeCompletionContext;
 class CodeCompletionResultBuilder;
+struct CodeCompletionResultSink;
 struct RequestedCachedModule;
 
 /// A routine to remove code completion tokens from code completion
@@ -375,33 +378,6 @@ enum class SemanticContextKind {
   /// Used in cases when the concept of semantic context is not applicable.
   None,
 
-  /// This is a highly-likely expression-context-specific completion
-  /// result.  This description is intentionally vague: this is a catch-all
-  /// category for all heuristics for highly-likely results.
-  ///
-  /// For example, the name of an overridden superclass member inside a nominal
-  /// member function has ExpressionSpecific context:
-  /// \code
-  ///   class Base {
-  ///     init() {}
-  ///     init(a: Int) {}
-  ///     func foo() {}
-  ///     func bar() {}
-  ///   }
-  ///   class Derived {
-  ///     init() {
-  ///       super. // init() -- ExpressionSpecific
-  ///              // init(a: Int) -- Super
-  ///     }
-  ///
-  ///     func foo() {
-  ///       super. // foo() -- ExpressionSpecific
-  ///              // bar() -- Super
-  ///     }
-  ///   }
-  /// \endcode
-  ExpressionSpecific,
-
   /// A declaration from the same function.
   Local,
 
@@ -434,6 +410,33 @@ enum class SemanticContextKind {
   OtherModule,
 };
 
+enum class CodeCompletionFlairBit: uint8_t {
+  /// **Deprecated**. Old style catch-all prioritization.
+  ExpressionSpecific = 1 << 0,
+
+  /// E.g. override func foo() { super.foo() ...
+  SuperChain = 1 << 1,
+
+  /// Argument label and type. i.e. 'label: <#Ty#>'.
+  ArgumentLabels = 1 << 2,
+
+  /// E.g. decl introducer or modifiers ('enum', 'protocol', 'public', etc.) at
+  /// top-level.
+  CommonKeywordAtCurrentPosition = 1 << 3,
+
+  /// E.g. type decl introducer ('enum', 'class', etc.) in a function body.
+  RareKeywordAtCurrentPosition = 1 << 4,
+
+  /// E.g. protocol names at an expression position.
+  RareTypeAtCurrentPosition = 1 << 5,
+
+  /// E.g. referencing a type, function, etc… at top level position in a non
+  /// script/main.swift file
+  ExpressionAtNonScriptOrMainFileScope = 1 << 6,
+};
+
+using CodeCompletionFlair = OptionSet<CodeCompletionFlairBit>;
+
 /// The declaration kind of a code completion result, if it is a declaration.
 enum class CodeCompletionDeclKind {
   Module,
@@ -615,7 +618,7 @@ class CodeCompletionResult {
   unsigned AssociatedKind : 8;
   unsigned KnownOperatorKind : 6;
   unsigned SemanticContext : 3;
-  unsigned IsArgumentLabels : 1;
+  unsigned Flair: 8;
   unsigned NotRecommended : 4;
   unsigned IsSystem : 1;
 
@@ -640,15 +643,14 @@ class CodeCompletionResult {
   ///
   /// \note The caller must ensure \c CodeCompletionString outlives this result.
   CodeCompletionResult(ResultKind Kind, SemanticContextKind SemanticContext,
-                       bool IsArgumentLabels, unsigned NumBytesToErase,
+                       CodeCompletionFlair Flair, unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        ExpectedTypeRelation TypeDistance,
                        CodeCompletionOperatorKind KnownOperatorKind =
                            CodeCompletionOperatorKind::None,
                        StringRef BriefDocComment = StringRef())
       : Kind(Kind), KnownOperatorKind(unsigned(KnownOperatorKind)),
-        SemanticContext(unsigned(SemanticContext)),
-        IsArgumentLabels(unsigned(IsArgumentLabels)),
+        SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
         NotRecommended(unsigned(NotRecommendedReason::None)),
         NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
         BriefDocComment(BriefDocComment), TypeDistance(TypeDistance) {
@@ -668,13 +670,13 @@ class CodeCompletionResult {
   /// \note The caller must ensure \c CodeCompletionString outlives this result.
   CodeCompletionResult(CodeCompletionKeywordKind Kind,
                        SemanticContextKind SemanticContext,
-                       bool IsArgumentLabels, unsigned NumBytesToErase,
+                       CodeCompletionFlair Flair,
+                       unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        ExpectedTypeRelation TypeDistance,
                        StringRef BriefDocComment = StringRef())
       : Kind(Keyword), KnownOperatorKind(0),
-        SemanticContext(unsigned(SemanticContext)),
-        IsArgumentLabels(unsigned(IsArgumentLabels)),
+        SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
         NotRecommended(unsigned(NotRecommendedReason::None)),
         NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
         BriefDocComment(BriefDocComment), TypeDistance(TypeDistance) {
@@ -688,12 +690,11 @@ class CodeCompletionResult {
   /// \note The caller must ensure \c CodeCompletionString outlives this result.
   CodeCompletionResult(CodeCompletionLiteralKind LiteralKind,
                        SemanticContextKind SemanticContext,
-                       bool IsArgumentLabels, unsigned NumBytesToErase,
+                       CodeCompletionFlair Flair, unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        ExpectedTypeRelation TypeDistance)
       : Kind(Literal), KnownOperatorKind(0),
-        SemanticContext(unsigned(SemanticContext)),
-        IsArgumentLabels(unsigned(IsArgumentLabels)),
+        SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
         NotRecommended(unsigned(NotRecommendedReason::None)),
         NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
         TypeDistance(TypeDistance) {
@@ -708,7 +709,7 @@ class CodeCompletionResult {
   /// arguments outlive this result, typically by storing them in the same
   /// \c CodeCompletionResultSink as the result itself.
   CodeCompletionResult(SemanticContextKind SemanticContext,
-                       bool IsArgumentLabels, unsigned NumBytesToErase,
+                       CodeCompletionFlair Flair, unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        const Decl *AssociatedDecl, StringRef ModuleName,
                        CodeCompletionResult::NotRecommendedReason NotRecReason,
@@ -717,8 +718,7 @@ class CodeCompletionResult {
                        ArrayRef<std::pair<StringRef, StringRef>> DocWords,
                        enum ExpectedTypeRelation TypeDistance)
       : Kind(ResultKind::Declaration), KnownOperatorKind(0),
-        SemanticContext(unsigned(SemanticContext)),
-        IsArgumentLabels(unsigned(IsArgumentLabels)),
+        SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
         NotRecommended(unsigned(NotRecReason)),
         NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
         ModuleName(ModuleName), BriefDocComment(BriefDocComment),
@@ -737,7 +737,7 @@ class CodeCompletionResult {
 
   // Used by deserialization.
   CodeCompletionResult(SemanticContextKind SemanticContext,
-                       bool IsArgumentLabels, unsigned NumBytesToErase,
+                       CodeCompletionFlair Flair, unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        CodeCompletionDeclKind DeclKind, bool IsSystem,
                        StringRef ModuleName,
@@ -749,8 +749,7 @@ class CodeCompletionResult {
                        CodeCompletionOperatorKind KnownOperatorKind)
       : Kind(ResultKind::Declaration),
         KnownOperatorKind(unsigned(KnownOperatorKind)),
-        SemanticContext(unsigned(SemanticContext)),
-        IsArgumentLabels(unsigned(IsArgumentLabels)),
+        SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
         NotRecommended(unsigned(NotRecReason)), IsSystem(IsSystem),
         NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
         ModuleName(ModuleName), BriefDocComment(BriefDocComment),
@@ -762,6 +761,12 @@ class CodeCompletionResult {
            getOperatorKind() != CodeCompletionOperatorKind::None);
   }
 
+  /// Copy this result to \p Sink with \p newFlair . Note that this does NOT
+  /// copy the value of \c CompletionString , \c AssociatedUSRs etc. it only
+  /// copies the pointers to them.
+  CodeCompletionResult *withFlair(CodeCompletionFlair newFlair,
+                                  CodeCompletionResultSink &Sink);
+
   ResultKind getKind() const { return static_cast<ResultKind>(Kind); }
 
   CodeCompletionDeclKind getAssociatedDeclKind() const {
@@ -813,8 +818,13 @@ class CodeCompletionResult {
     return static_cast<SemanticContextKind>(SemanticContext);
   }
 
-  bool isArgumentLabels() const {
-    return static_cast<bool>(IsArgumentLabels);
+  CodeCompletionFlair getFlair() const {
+    return static_cast<CodeCompletionFlair>(Flair);
+  }
+
+  /// Modify "flair" of this result *in place*.
+  void setFlair(CodeCompletionFlair flair) {
+    Flair = unsigned(flair.toRaw());
   }
 
   bool isNotRecommended() const {
@@ -971,7 +981,7 @@ class CodeCompletionConsumer {
   virtual void
   handleResultsAndModules(CodeCompletionContext &context,
                           ArrayRef<RequestedCachedModule> requestedModules,
-                          DeclContext *DCForModules) = 0;
+                          DeclContext *DC) = 0;
 };
 
 /// A simplified code completion consumer interface that clients can use to get
@@ -1024,14 +1034,15 @@ void lookupCodeCompletionResultsFromModule(CodeCompletionResultSink &targetSink,
                                            const ModuleDecl *module,
                                            ArrayRef<std::string> accessPath,
                                            bool needLeadingDot,
-                                           const DeclContext *currDeclContext);
+                                           const SourceFile *SF);
 
 /// Copy code completion results from \p sourceSink to \p targetSink, possibly
-/// restricting by \p onlyTypes.
-void copyCodeCompletionResults(CodeCompletionResultSink &targetSink,
-                               CodeCompletionResultSink &sourceSink,
-                               bool onlyTypes,
-                               bool onlyPrecedenceGroups);
+/// restricting by \p onlyTypes. Returns copied results in \p targetSink.
+MutableArrayRef<CodeCompletionResult *>
+copyCodeCompletionResults(CodeCompletionResultSink &targetSink,
+                          CodeCompletionResultSink &sourceSink,
+                          bool onlyTypes,
+                          bool onlyPrecedenceGroups);
 
 } // end namespace ide
 } // end namespace swift