[index] Thread through SymbolRoleSet as a generalization of "bool isRef"

As a first step toward having more detailed "role" information, thread
through a SymbolRole bitset.  For now it just contains the existing ref
vs. definition status.

Author: benlangmuir

include/swift/Index/IndexDataConsumer.h

@@ -35,7 +35,7 @@ class IndexDataConsumer {
   virtual bool startSourceEntity(const IndexSymbol &symbol) = 0;
   virtual bool recordRelatedEntity(const IndexSymbol &symbol) = 0;
   virtual bool finishSourceEntity(SymbolKind kind, SymbolSubKind subKind,
-                                  bool isRef) = 0;
+                                  SymbolRoleSet roles) = 0;
 };
 
 } // end namespace index

include/swift/Index/IndexSymbol.h

@@ -14,6 +14,7 @@
 #define SWIFT_INDEX_INDEXSYMBOL_H
 
 #include "swift/Basic/LLVM.h"
+#include "clang/Index/IndexSymbol.h"
 #include "llvm/ADT/SmallString.h"
 
 namespace swift {
@@ -73,13 +74,16 @@ enum class SymbolSubKind {
   ExtensionOfProtocol,
 };
 
+using SymbolRole = clang::index::SymbolRole;
+using SymbolRoleSet = clang::index::SymbolRoleSet;
+
 struct IndexSymbol {
   enum TypeKind { Base, FuncDecl, CallReference };
   TypeKind entityType = Base;
 
   SymbolKind kind;
   SymbolSubKind subKind = SymbolSubKind::None;
-  bool isRef;
+  SymbolRoleSet roles = SymbolRoleSet(0);
   // The following strings are guaranteed to live at least as long as the
   // current indexing action.
   StringRef name;

lib/Index/Index.cpp

@@ -86,7 +86,7 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
     Decl *D;
     SymbolKind Kind;
     SymbolSubKind SubKind;
-    bool IsRef;
+    SymbolRoleSet Roles;
   };
   SmallVector<Entity, 6> EntitiesStack;
   SmallVector<Expr *, 8> ExprStack;
@@ -269,7 +269,7 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
     Entity CurrEnt = EntitiesStack.pop_back_val();
     assert(CurrEnt.Kind != SymbolKind::Unknown);
     if (!IdxConsumer.finishSourceEntity(CurrEnt.Kind, CurrEnt.SubKind,
-                                        CurrEnt.IsRef)) {
+                                        CurrEnt.Roles)) {
       Cancelled = true;
       return false;
     }
@@ -502,7 +502,7 @@ bool IndexSwiftASTWalker::startEntity(ValueDecl *D, const IndexSymbol &Info) {
     return false;
   }
 
-  EntitiesStack.push_back({D, Info.kind, Info.subKind, Info.isRef});
+  EntitiesStack.push_back({D, Info.kind, Info.subKind, Info.roles});
   return true;
 }
 
@@ -582,7 +582,7 @@ bool IndexSwiftASTWalker::reportPseudoAccessor(AbstractStorageDecl *D,
       Cancelled = true;
       return false;
     }
-    if (!IdxConsumer.finishSourceEntity(Info.kind, Info.subKind, Info.isRef)) {
+    if (!IdxConsumer.finishSourceEntity(Info.kind, Info.subKind, Info.roles)) {
       Cancelled = true;
       return false;
     }
@@ -653,7 +653,7 @@ bool IndexSwiftASTWalker::reportExtension(ExtensionDecl *D) {
   if (Cancelled)
     return false;
 
-  EntitiesStack.push_back({D, Info.kind, Info.subKind, Info.isRef});
+  EntitiesStack.push_back({D, Info.kind, Info.subKind, Info.roles});
   return true;
 }
 
@@ -769,7 +769,10 @@ bool IndexSwiftASTWalker::initIndexSymbol(ValueDecl *D, SourceLoc Loc,
     Info.subKind = getSubKindForAccessor(cast<FuncDecl>(D)->getAccessorKind());
   // Cannot be extension, which is not a ValueDecl.
 
-  Info.isRef = IsRef;
+  if (IsRef)
+    Info.roles |= (unsigned)SymbolRole::Reference;
+  else
+    Info.roles |= (unsigned)SymbolRole::Definition;
 
   if (getNameAndUSR(D, Info.name, Info.USR))
     return true;

tools/SourceKit/lib/SwiftLang/SwiftIndexing.cpp

@@ -84,16 +84,18 @@ class SKIndexDataConsumer : public IndexDataConsumer {
   }
 
   bool finishSourceEntity(SymbolKind kind, SymbolSubKind subKind,
-                          bool isRef) override {
+                          SymbolRoleSet roles) override {
+    bool isRef = roles & (unsigned)SymbolRole::Reference;
     auto UID = SwiftLangSupport::getUIDForSymbol(kind, subKind, isRef);
     return impl.finishSourceEntity(UID);
   }
 
   template <typename F>
   bool withEntityInfo(const IndexSymbol &symbol, F func) {
     auto initEntity = [](EntityInfo &info, const IndexSymbol &symbol) {
+      bool isRef = symbol.roles & (unsigned)SymbolRole::Reference;
       info.Kind = SwiftLangSupport::getUIDForSymbol(symbol.kind, symbol.subKind,
-                                                    symbol.isRef);
+                                                    isRef);
       info.Name = symbol.name;
       info.USR = symbol.USR;
       info.Group = symbol.group;

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp

@@ -39,6 +39,8 @@ using namespace swift;
 using namespace swift::ide;
 using swift::index::SymbolKind;
 using swift::index::SymbolSubKind;
+using swift::index::SymbolRole;
+using swift::index::SymbolRoleSet;
 
 static UIdent KindDeclFunctionFree("source.lang.swift.decl.function.free");
 static UIdent KindRefFunctionFree("source.lang.swift.ref.function.free");