Merge pull request #19647 from nkcsgexi/include-operator-decl

swift-module-digester: include operator declarations in the module dump.

Author: nkcsgexi

include/swift/IDE/DigesterEnums.def

@@ -67,6 +67,7 @@ NODE_KIND(DeclSetter, Setter)
 NODE_KIND(DeclSubscript, Subscript)
 NODE_KIND_RANGE(DeclAbstractFunc, DeclFunction, DeclSubscript)
 
+NODE_KIND(DeclOperator, OperatorDecl)
 NODE_KIND(DeclType, TypeDecl)
 NODE_KIND(DeclVar, Var)
 NODE_KIND(DeclTypeAlias, TypeAlias)

test/api-digester/Inputs/cake.swift

@@ -84,3 +84,5 @@ public let GlobalVar = 1
 public extension P1 {
   static func +(lhs: P1, rhs: P1) -> P1 { return lhs }
 }
+
+infix operator ..*..

test/api-digester/Outputs/cake-abi.json

@@ -1147,6 +1147,16 @@
       "isLet": true,
       "hasStorage": true
     },
+    {
+      "kind": "OperatorDecl",
+      "name": "..*..",
+      "printedName": "..*..",
+      "declKind": "InfixOperator",
+      "moduleName": "cake",
+      "declAttributes": [
+        "Infix"
+      ]
+    },
     {
       "kind": "TypeDecl",
       "name": "Int",

test/api-digester/Outputs/cake.json

@@ -1145,6 +1145,16 @@
       "isLet": true,
       "hasStorage": true
     },
+    {
+      "kind": "OperatorDecl",
+      "name": "..*..",
+      "printedName": "..*..",
+      "declKind": "InfixOperator",
+      "moduleName": "cake",
+      "declAttributes": [
+        "Infix"
+      ]
+    },
     {
       "kind": "TypeDecl",
       "name": "Int",

tools/swift-api-digester/ModuleAnalyzerNodes.cpp

@@ -39,7 +39,9 @@ struct swift::ide::api::SDKNodeInitInfo {
   std::vector<TypeAttrKind> TypeAttrs;
 
   SDKNodeInitInfo(SDKContext &Ctx) : Ctx(Ctx) {}
+  SDKNodeInitInfo(SDKContext &Ctx, Decl *D);
   SDKNodeInitInfo(SDKContext &Ctx, ValueDecl *VD);
+  SDKNodeInitInfo(SDKContext &Ctx, OperatorDecl *D);
   SDKNodeInitInfo(SDKContext &Ctx, Type Ty, bool IsImplicitlyUnwrappedOptional,
                   bool hasDefaultArgument);
   SDKNode* createSDKNode(SDKNodeKind Kind);
@@ -55,6 +57,15 @@ SDKContext::SDKContext(CheckerOptions Opts): Diags(SourceMgr), Opts(Opts) {
 #undef ADD
 }
 
+void SDKNodeRoot::registerDescendant(SDKNode *D) {
+  // Operator doesn't have usr
+  if (isa<SDKNodeDeclOperator>(D))
+    return;
+  if (auto DD = dyn_cast<SDKNodeDecl>(D)) {
+    assert(!DD->getUsr().empty());
+    DescendantDeclTable[DD->getUsr()].insert(DD);
+  }
+}
 
 SDKNode::SDKNode(SDKNodeInitInfo Info, SDKNodeKind Kind): Ctx(Info.Ctx),
   Name(Info.Name), PrintedName(Info.PrintedName), TheKind(unsigned(Kind)) {}
@@ -86,12 +97,15 @@ SDKNodeTypeFunc::SDKNodeTypeFunc(SDKNodeInitInfo Info):
 SDKNodeTypeAlias::SDKNodeTypeAlias(SDKNodeInitInfo Info):
   SDKNodeType(Info, SDKNodeKind::TypeAlias) {}
 
-SDKNodeDeclType::SDKNodeDeclType(SDKNodeInitInfo Info): 
+SDKNodeDeclType::SDKNodeDeclType(SDKNodeInitInfo Info):
   SDKNodeDecl(Info, SDKNodeKind::DeclType), SuperclassUsr(Info.SuperclassUsr),
   SuperclassNames(Info.SuperclassNames),
   ConformingProtocols(Info.ConformingProtocols),
   EnumRawTypeName(Info.EnumRawTypeName) {}
 
+SDKNodeDeclOperator::SDKNodeDeclOperator(SDKNodeInitInfo Info):
+  SDKNodeDecl(Info, SDKNodeKind::DeclOperator) {}
+
 SDKNodeDeclTypeAlias::SDKNodeDeclTypeAlias(SDKNodeInitInfo Info):
   SDKNodeDecl(Info, SDKNodeKind::DeclTypeAlias) {}
 
@@ -306,6 +320,7 @@ StringRef SDKNodeType::getTypeRoleDescription() const {
   case SDKNodeKind::TypeFunc:
   case SDKNodeKind::TypeAlias:
   case SDKNodeKind::DeclType:
+  case SDKNodeKind::DeclOperator:
     llvm_unreachable("Type Parent is wrong");
   case SDKNodeKind::DeclFunction:
   case SDKNodeKind::DeclConstructor:
@@ -719,6 +734,7 @@ bool static isSDKNodeEqual(SDKContext &Ctx, const SDKNode &L, const SDKNode &R)
       }
       LLVM_FALLTHROUGH;
     }
+    case SDKNodeKind::DeclOperator:
     case SDKNodeKind::DeclTypeAlias: {
       auto Left = L.getAs<SDKNodeDecl>();
       auto Right = R.getAs<SDKNodeDecl>();
@@ -820,14 +836,14 @@ static StringRef calculateUsr(SDKContext &Ctx, ValueDecl *VD) {
   return StringRef();
 }
 
-static StringRef calculateLocation(SDKContext &SDKCtx, ValueDecl *VD) {
+static StringRef calculateLocation(SDKContext &SDKCtx, Decl *D) {
   if (SDKCtx.getOpts().AvoidLocation)
     return StringRef();
-  auto &Ctx = VD->getASTContext();
+  auto &Ctx = D->getASTContext();
   auto &Importer = static_cast<ClangImporter &>(*Ctx.getClangModuleLoader());
 
   clang::SourceManager &SM = Importer.getClangPreprocessor().getSourceManager();
-  if (ClangNode CN = VD->getClangNode()) {
+  if (ClangNode CN = D->getClangNode()) {
     clang::SourceLocation Loc = CN.getLocation();
     Loc = SM.getFileLoc(Loc);
     if (Loc.isValid())
@@ -926,10 +942,10 @@ Requirement getCanonicalRequirement(Requirement &Req) {
   }
 }
 
-static StringRef printGenericSignature(SDKContext &Ctx, ValueDecl *VD) {
+static StringRef printGenericSignature(SDKContext &Ctx, Decl *D) {
   llvm::SmallString<32> Result;
   llvm::raw_svector_ostream OS(Result);
-  if (auto *PD = dyn_cast<ProtocolDecl>(VD)) {
+  if (auto *PD = dyn_cast<ProtocolDecl>(D)) {
     if (PD->getRequirementSignature().empty())
       return StringRef();
     OS << "<";
@@ -949,7 +965,7 @@ static StringRef printGenericSignature(SDKContext &Ctx, ValueDecl *VD) {
     return Ctx.buffer(OS.str());
   }
 
-  if (auto *GC = VD->getAsGenericContext()) {
+  if (auto *GC = D->getAsGenericContext()) {
     if (auto *Sig = GC->getGenericSignature()) {
       if (Ctx.checkingABI())
         Sig->getCanonicalSignature()->print(OS);
@@ -1008,23 +1024,40 @@ SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, Type Ty,
   }
 }
 
+SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, Decl *D):
+      Ctx(Ctx), DKind(D->getKind()),
+      Location(calculateLocation(Ctx, D)),
+      ModuleName(D->getModuleContext()->getName().str()),
+      GenericSig(printGenericSignature(Ctx, D)),
+      IsImplicit(D->isImplicit()),
+      IsDeprecated(D->getAttrs().getDeprecated(D->getASTContext())) {
+  // Capture all attributes.
+  auto AllAttrs = D->getAttrs();
+  std::transform(AllAttrs.begin(), AllAttrs.end(), std::back_inserter(DeclAttrs),
+                 [](DeclAttribute *attr) { return attr->getKind(); });
+}
+
+SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, OperatorDecl *OD):
+    SDKNodeInitInfo(Ctx, cast<Decl>(OD)) {
+  Name = OD->getName().str();
+  PrintedName = OD->getName().str();
+}
+
 SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, ValueDecl *VD)
-    : Ctx(Ctx), DKind(VD->getKind()),
-      Name(VD->hasName() ? getEscapedName(VD->getBaseName()) : Ctx.buffer("_")),
-      PrintedName(getPrintedName(Ctx, VD)),
-      Usr(calculateUsr(Ctx, VD)), Location(calculateLocation(Ctx, VD)),
-      ModuleName(VD->getModuleContext()->getName().str()),
-      GenericSig(printGenericSignature(Ctx, VD)),
-      IsImplicit(VD->isImplicit()),
-      IsThrowing(isFuncThrowing(VD)), IsMutating(isFuncMutating(VD)),
-      IsStatic(VD->isStatic()),
-      IsDeprecated(VD->getAttrs().getDeprecated(VD->getASTContext())),
-      IsOverriding(VD->getOverriddenDecl()),
-      IsProtocolReq(isa<ProtocolDecl>(VD->getDeclContext()) && VD->isProtocolRequirement()),
-      IsOpen(VD->getFormalAccess() == AccessLevel::Open),
-      IsInternal(VD->getFormalAccess() < AccessLevel::Public),
-      SelfIndex(getSelfIndex(VD)), FixedBinaryOrder(getFixedBinaryOrder(VD)),
-      ReferenceOwnership(getReferenceOwnership(VD)) {
+    : SDKNodeInitInfo(Ctx, cast<Decl>(VD)) {
+  Name = VD->hasName() ? getEscapedName(VD->getBaseName()) : Ctx.buffer("_");
+  PrintedName = getPrintedName(Ctx, VD);
+  Usr = calculateUsr(Ctx, VD);
+  IsThrowing = isFuncThrowing(VD);
+  IsMutating = isFuncMutating(VD);
+  IsStatic = VD->isStatic();
+  IsOverriding = VD->getOverriddenDecl();
+  IsProtocolReq = isa<ProtocolDecl>(VD->getDeclContext()) && VD->isProtocolRequirement();
+  IsOpen = VD->getFormalAccess() == AccessLevel::Open;
+  IsInternal = VD->getFormalAccess() < AccessLevel::Public;
+  SelfIndex = getSelfIndex(VD);
+  FixedBinaryOrder = getFixedBinaryOrder(VD);
+  ReferenceOwnership = getReferenceOwnership(VD);
 
   // Calculate usr for its super class.
   if (auto *CD = dyn_cast_or_null<ClassDecl>(VD)) {
@@ -1036,11 +1069,6 @@ SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, ValueDecl *VD)
     }
   }
 
-  // Capture all attributes.
-  auto AllAttrs = VD->getAttrs();
-  std::transform(AllAttrs.begin(), AllAttrs.end(), std::back_inserter(DeclAttrs),
-                 [](DeclAttribute *attr) { return attr->getKind(); });
-
   // Get all protocol names this type decl conforms to.
   if (auto *NTD = dyn_cast<NominalTypeDecl>(VD)) {
     for (auto *P: NTD->getAllProtocols()) {
@@ -1178,8 +1206,6 @@ SwiftDeclCollector::shouldIgnore(Decl *D, const Decl* Parent) {
     return true;
   if (isa<ConstructorDecl>(D))
     return false;
-  if (isa<OperatorDecl>(D))
-    return true;
   if (auto VD = dyn_cast<ValueDecl>(D)) {
     if (VD->getBaseName().empty())
       return true;
@@ -1340,6 +1366,8 @@ void SwiftDeclCollector::lookupVisibleDecls(ArrayRef<ModuleDecl *> Modules) {
       KnownDecls.insert(D);
       if (auto VD = dyn_cast<ValueDecl>(D))
         foundDecl(VD, DeclVisibilityKind::DynamicLookup);
+      else
+        processDecl(D);
     }
   }
 
@@ -1353,7 +1381,7 @@ void SwiftDeclCollector::lookupVisibleDecls(ArrayRef<ModuleDecl *> Modules) {
      });
 
   for (auto *VD : ClangMacros)
-    processDecl(VD);
+    processValueDecl(VD);
 
   // Collect extensions to types from other modules and synthesize type nodes
   // for them.
@@ -1370,7 +1398,18 @@ void SwiftDeclCollector::lookupVisibleDecls(ArrayRef<ModuleDecl *> Modules) {
   }
 }
 
-void SwiftDeclCollector::processDecl(ValueDecl *VD) {
+SDKNode *SwiftDeclCollector::constructOperatorDeclNode(OperatorDecl *OD) {
+  return SDKNodeInitInfo(Ctx, OD).createSDKNode(SDKNodeKind::DeclOperator);
+}
+
+void SwiftDeclCollector::processDecl(Decl *D) {
+  assert(!isa<ValueDecl>(D));
+  if (auto *OD = dyn_cast<OperatorDecl>(D)) {
+    RootNode->addChild(constructOperatorDeclNode(OD));
+  }
+}
+
+void SwiftDeclCollector::processValueDecl(ValueDecl *VD) {
   if (auto FD = dyn_cast<FuncDecl>(VD)) {
     RootNode->addChild(constructFunctionNode(FD, SDKNodeKind::DeclFunction));
   } else if (auto NTD = dyn_cast<NominalTypeDecl>(VD)) {
@@ -1391,7 +1430,7 @@ void SwiftDeclCollector::foundDecl(ValueDecl *VD, DeclVisibilityKind Reason) {
     return;
   }
 
-  processDecl(VD);
+  processValueDecl(VD);
 }
 
 void SDKNode::output(json::Output &out, KeyKind Key, bool Value) {

tools/swift-api-digester/ModuleAnalyzerNodes.h

@@ -339,12 +339,7 @@ class SDKNodeRoot: public SDKNode {
   SDKNodeRoot(SDKNodeInitInfo Info);
   static SDKNode *getInstance(SDKContext &Ctx);
   static bool classof(const SDKNode *N);
-  void registerDescendant(SDKNode *D) {
-    if (auto DD = dyn_cast<SDKNodeDecl>(D)) {
-      assert(!DD->getUsr().empty());
-      DescendantDeclTable[DD->getUsr()].insert(DD);
-    }
-  }
+  void registerDescendant(SDKNode *D);
   ArrayRef<SDKNodeDecl*> getDescendantsByUsr(StringRef Usr) {
     return DescendantDeclTable[Usr].getArrayRef();
   }
@@ -468,6 +463,12 @@ class SDKNodeDeclType: public SDKNodeDecl {
   void diagnose(SDKNode *Right) override;
 };
 
+class SDKNodeDeclOperator : public SDKNodeDecl {
+public:
+  SDKNodeDeclOperator(SDKNodeInitInfo Info);
+  static bool classof(const SDKNode *N);
+};
+
 class SDKNodeDeclTypeAlias : public SDKNodeDecl {
 public:
   SDKNodeDeclTypeAlias(SDKNodeInitInfo Info);
@@ -600,13 +601,15 @@ class SwiftDeclCollector: public VisibleDeclConsumer {
   SDKNode *constructTypeDeclNode(NominalTypeDecl *NTD);
   SDKNode *constructInitNode(ConstructorDecl *CD);
   SDKNode *constructFunctionNode(FuncDecl* FD, SDKNodeKind Kind);
+  SDKNode *constructOperatorDeclNode(OperatorDecl *OD);
   std::vector<SDKNode*> createParameterNodes(ParameterList *PL);
   SDKNode *constructTypeNode(Type T, bool IsImplicitlyUnwrappedOptional = false,
     bool hasDefaultArgument = false);
+  void processValueDecl(ValueDecl *VD);
+  void foundDecl(ValueDecl *VD, DeclVisibilityKind Reason) override;
+  void processDecl(Decl *D);
 public:
   void lookupVisibleDecls(ArrayRef<ModuleDecl *> Modules);
-  void processDecl(ValueDecl *VD);
-  void foundDecl(ValueDecl *VD, DeclVisibilityKind Reason) override;
 };
 
 int dumpSwiftModules(const CompilerInvocation &InitInvok,

tools/swift-api-digester/swift-api-digester.cpp

@@ -1000,6 +1000,7 @@ class PrunePass : public MatchedNodeListener, public SDKTreeDiffPass {
       break;
     }
 
+    case SDKNodeKind::DeclOperator:
     case SDKNodeKind::DeclSubscript:
     case SDKNodeKind::DeclAssociatedType:
     case SDKNodeKind::DeclFunction: