[AST] NFC: Rename getArgumentInterfaceType -> getPayloadInterfaceType

hamishknight · hamishknight · commit 91ae5d634546 · 2024-09-29T17:05:14.000+01:00
IMO this is a slightly clearer name, many of its
uses already use the term "payload".
diff --git a/include/swift/AST/Decl.h b/include/swift/AST/Decl.h
@@ -8507,7 +8507,9 @@ class EnumElementDecl : public DeclContext, public ValueDecl {
     return hasName() ? getBaseIdentifier().str() : "_";
   }
 
-  Type getArgumentInterfaceType() const;
+  /// Retrieve the payload type for the enum element, which is a tuple of the
+  /// associated values, or null if there are no associated values.
+  Type getPayloadInterfaceType() const;
 
   void setParameterList(ParameterList *params);
   ParameterList *getParameterList() const { return Params; }
diff --git a/lib/AST/Decl.cpp b/lib/AST/Decl.cpp
@@ -10601,7 +10601,7 @@ SourceRange EnumElementDecl::getSourceRange() const {
   return {getStartLoc(), getNameLoc()};
 }
 
-Type EnumElementDecl::getArgumentInterfaceType() const {
+Type EnumElementDecl::getPayloadInterfaceType() const {
   if (!hasAssociatedValues())
     return nullptr;
 
diff --git a/lib/IRGen/GenEnum.cpp b/lib/IRGen/GenEnum.cpp
@@ -231,9 +231,9 @@ const {
 
   // Empty payload addresses can be left undefined.
   if (payloadI == ElementsWithPayload.end()) {
-    auto argTy = elt->getParentEnum()->mapTypeIntoContext(
-      elt->getArgumentInterfaceType());
-    return IGF.getTypeInfoForUnlowered(argTy)
+    auto payloadTy = elt->getParentEnum()->mapTypeIntoContext(
+      elt->getPayloadInterfaceType());
+    return IGF.getTypeInfoForUnlowered(payloadTy)
       .getUndefAddress();
   }
 
@@ -254,9 +254,9 @@ const {
 
   // Empty payload addresses can be left undefined.
   if (payloadI == ElementsWithPayload.end()) {
-    auto argTy = Case->getParentEnum()->mapTypeIntoContext(
-      Case->getArgumentInterfaceType());
-    return IGF.getTypeInfoForUnlowered(argTy)
+    auto payloadTy = Case->getParentEnum()->mapTypeIntoContext(
+      Case->getPayloadInterfaceType());
+    return IGF.getTypeInfoForUnlowered(payloadTy)
       .getUndefAddress();
   }
 
@@ -6463,10 +6463,10 @@ EnumImplStrategy::get(TypeConverter &TC, SILType type, EnumDecl *theEnum) {
     // strategy. If the abstract layout of the enum is dependent on generic
     // parameters, then we additionally need to constrain any layout
     // optimizations we perform to things that are reproducible by the runtime.
-    Type origArgType = elt->getArgumentInterfaceType();
-    origArgType = theEnum->mapTypeIntoContext(origArgType);
+    Type origPayloadType = elt->getPayloadInterfaceType();
+    origPayloadType = theEnum->mapTypeIntoContext(origPayloadType);
 
-    auto origArgLoweredTy = TC.IGM.getLoweredType(origArgType);
+    auto origArgLoweredTy = TC.IGM.getLoweredType(origPayloadType);
     auto *origArgTI = &TC.getCompleteTypeInfo(origArgLoweredTy.getASTType());
 
     // If the unsubstituted argument contains a generic parameter type, or
diff --git a/lib/IRGen/GenReflection.cpp b/lib/IRGen/GenReflection.cpp
@@ -942,7 +942,7 @@ class FieldTypeMetadataBuilder : public ReflectionMetadataBuilder {
       flags.setIsIndirectCase();
 
     Type interfaceType = decl->isAvailableDuringLowering()
-                             ? decl->getArgumentInterfaceType()
+                             ? decl->getPayloadInterfaceType()
                              : nullptr;
 
     addField(flags, interfaceType, decl->getBaseIdentifier().str());
diff --git a/lib/IRGen/GenType.cpp b/lib/IRGen/GenType.cpp
@@ -2484,7 +2484,7 @@ namespace {
         if (!elt->hasAssociatedValues() || elt->isIndirect())
           continue;
 
-        if (visit(elt->getArgumentInterfaceType()->getCanonicalType()))
+        if (visit(elt->getPayloadInterfaceType()->getCanonicalType()))
           return true;
       }
       return false;
diff --git a/lib/IRGen/IRGenDebugInfo.cpp b/lib/IRGen/IRGenDebugInfo.cpp
@@ -1358,11 +1358,11 @@ createSpecializedStructOrClassType(NominalOrBoundGenericNominalType *Type,
     SmallVector<llvm::Metadata *, 16> Elements;
     for (auto *ElemDecl : Decl->getAllElements()) {
       std::optional<CompletedDebugTypeInfo> ElemDbgTy;
-      if (auto ArgTy = ElemDecl->getArgumentInterfaceType()) {
+      if (auto PayloadTy = ElemDecl->getPayloadInterfaceType()) {
         // A variant case which carries a payload.
-        ArgTy = ElemDecl->getParentEnum()->mapTypeIntoContext(ArgTy);
-        auto &TI = IGM.getTypeInfoForUnlowered(ArgTy);
-        ElemDbgTy = CompletedDebugTypeInfo::getFromTypeInfo(ArgTy, TI, IGM);
+        PayloadTy = ElemDecl->getParentEnum()->mapTypeIntoContext(PayloadTy);
+        auto &TI = IGM.getTypeInfoForUnlowered(PayloadTy);
+        ElemDbgTy = CompletedDebugTypeInfo::getFromTypeInfo(PayloadTy, TI, IGM);
         if (!ElemDbgTy) {
           // Without complete type info we can only create a forward decl.
           return DBuilder.createForwardDecl(
@@ -1434,11 +1434,11 @@ createSpecializedStructOrClassType(NominalOrBoundGenericNominalType *Type,
     SmallVector<llvm::Metadata *, 16> Elements;
     for (auto *ElemDecl : Decl->getAllElements()) {
       std::optional<DebugTypeInfo> ElemDbgTy;
-      if (auto ArgTy = ElemDecl->getArgumentInterfaceType()) {
+      if (auto PayloadTy = ElemDecl->getPayloadInterfaceType()) {
         // A variant case which carries a payload.
-        ArgTy = ElemDecl->getParentEnum()->mapTypeIntoContext(ArgTy);
+        PayloadTy = ElemDecl->getParentEnum()->mapTypeIntoContext(PayloadTy);
         ElemDbgTy = DebugTypeInfo::getFromTypeInfo(
-            ArgTy, IGM.getTypeInfoForUnlowered(ArgTy), IGM);
+            PayloadTy, IGM.getTypeInfoForUnlowered(PayloadTy), IGM);
         unsigned Offset = 0;
         auto MTy =
             createMemberType(*ElemDbgTy, ElemDecl->getBaseIdentifier().str(),
diff --git a/lib/SIL/IR/AbstractionPattern.cpp b/lib/SIL/IR/AbstractionPattern.cpp
@@ -120,7 +120,7 @@ AbstractionPattern TypeConverter::getAbstractionPattern(EnumElementDecl *decl) {
   auto sig = decl->getParentEnum()
                  ->getGenericSignatureOfContext()
                  .getCanonicalSignature();
-  auto type = sig.getReducedType(decl->getArgumentInterfaceType());
+  auto type = sig.getReducedType(decl->getPayloadInterfaceType());
 
   return AbstractionPattern(sig, type);
 }
diff --git a/lib/SIL/IR/SILType.cpp b/lib/SIL/IR/SILType.cpp
@@ -414,7 +414,7 @@ SILType SILType::getEnumElementType(EnumElementDecl *elt, TypeConverter &TC,
   addFieldSubstitutionsIfNeeded(TC, *this, elt, origEltType);
 
   auto substEltTy = getASTType()->getTypeOfMember(
-      elt, elt->getArgumentInterfaceType());
+      elt, elt->getPayloadInterfaceType());
   auto loweredTy = TC.getLoweredRValueType(
       context, TC.getAbstractionPattern(elt), substEltTy);
 
diff --git a/lib/SIL/IR/TypeLowering.cpp b/lib/SIL/IR/TypeLowering.cpp
@@ -2559,11 +2559,11 @@ namespace {
         }
         
         auto substEltType =
-          elt->getArgumentInterfaceType().subst(subMap)
+          elt->getPayloadInterfaceType().subst(subMap)
              ->getCanonicalType();
         
         auto origEltType = origType.unsafeGetSubstFieldType(elt,
-                              elt->getArgumentInterfaceType()
+                              elt->getPayloadInterfaceType()
                                  ->getReducedType(D->getGenericSignature()),
                               subMap);
         properties.addSubobject(classifyType(origEltType, substEltType,
@@ -2968,11 +2968,11 @@ bool TypeConverter::visitAggregateLeaves(
           // TODO: Callback for indirect elements.
           if (element->isIndirect())
             continue;
-          auto substElementType = element->getArgumentInterfaceType()
+          auto substElementType = element->getPayloadInterfaceType()
                                       .subst(subMap)
                                       ->getCanonicalType();
           auto origElementTy = origTy.unsafeGetSubstFieldType(
-              element, element->getArgumentInterfaceType()->getReducedType(
+              element, element->getPayloadInterfaceType()->getReducedType(
                            decl->getGenericSignature()), subMap);
 
           insertIntoWorklist(substElementType, origElementTy, element,
@@ -5028,7 +5028,7 @@ CanSILBoxType TypeConverter::getBoxTypeForEnumElement(
       enumDecl->getGenericSignature());
 
   if (boxSignature == CanGenericSignature()) {
-    auto eltIntfTy = elt->getArgumentInterfaceType();
+    auto eltIntfTy = elt->getPayloadInterfaceType();
     auto boxVarTy = getLoweredRValueType(context, eltIntfTy);
     auto layout = SILLayout::get(C, nullptr, SILField(boxVarTy, true),
                                  /*captures generics*/ false);
@@ -5039,7 +5039,7 @@ CanSILBoxType TypeConverter::getBoxTypeForEnumElement(
   auto boundEnum = enumType.getRawASTType();
 
   // Lower the enum element's argument in the box's context.
-  auto eltIntfTy = elt->getArgumentInterfaceType();
+  auto eltIntfTy = elt->getPayloadInterfaceType();
 
   auto boxVarTy = getLoweredRValueType(context,
                                        getAbstractionPattern(elt), eltIntfTy);
diff --git a/lib/SIL/Verifier/SILVerifier.cpp b/lib/SIL/Verifier/SILVerifier.cpp
@@ -3620,7 +3620,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {
     require(ud, "UncheckedEnumData must take an enum operand");
     require(UI->getElement()->getParentEnum() == ud,
             "UncheckedEnumData case must be a case of the enum operand type");
-    require(UI->getElement()->getArgumentInterfaceType(),
+    require(UI->getElement()->getPayloadInterfaceType(),
             "UncheckedEnumData case must have a data type");
     require(UI->getOperand()->getType().isObject(),
             "UncheckedEnumData must take an address operand");
@@ -3642,7 +3642,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {
     require(ud, "UncheckedTakeEnumDataAddrInst must take an enum operand");
     require(UI->getElement()->getParentEnum() == ud,
             "UncheckedTakeEnumDataAddrInst case must be a case of the enum operand type");
-    require(UI->getElement()->getArgumentInterfaceType(),
+    require(UI->getElement()->getPayloadInterfaceType(),
             "UncheckedTakeEnumDataAddrInst case must have a data type");
     require(UI->getOperand()->getType().isAddress(),
             "UncheckedTakeEnumDataAddrInst must take an address operand");
diff --git a/lib/SILGen/SILGenDecl.cpp b/lib/SILGen/SILGenDecl.cpp
@@ -1239,7 +1239,7 @@ void EnumElementPatternInitialization::emitEnumMatch(
             value.getType()
                 .getASTType()
                 ->getTypeOfMember(eltDecl,
-                                  eltDecl->getArgumentInterfaceType())
+                                  eltDecl->getPayloadInterfaceType())
                 ->getCanonicalType();
 
         AbstractionPattern origEltTy =
diff --git a/lib/SILGen/SILGenLazyConformance.cpp b/lib/SILGen/SILGenLazyConformance.cpp
@@ -356,7 +356,7 @@ void SILGenModule::emitLazyConformancesForType(NominalTypeDecl *NTD) {
   if (auto *ED = dyn_cast<EnumDecl>(NTD)) {
     for (auto *EED : ED->getAllElements()) {
       if (EED->hasAssociatedValues()) {
-        useConformancesFromType(EED->getArgumentInterfaceType()
+        useConformancesFromType(EED->getPayloadInterfaceType()
                                    ->getReducedType(genericSig));
       }
     }
diff --git a/lib/SILGen/SILGenPattern.cpp b/lib/SILGen/SILGenPattern.cpp
@@ -2208,7 +2208,7 @@ void PatternMatchEmission::emitEnumElementObjectDispatch(
       // Reabstract to the substituted type, if needed.
       CanType substEltTy =
           sourceType
-              ->getTypeOfMember(elt, elt->getArgumentInterfaceType())
+              ->getTypeOfMember(elt, elt->getPayloadInterfaceType())
               ->getCanonicalType();
 
       AbstractionPattern origEltTy =
@@ -2470,7 +2470,7 @@ void PatternMatchEmission::emitEnumElementDispatch(
       // Reabstract to the substituted type, if needed.
       CanType substEltTy =
         sourceType->getTypeOfMember(eltDecl,
-                                    eltDecl->getArgumentInterfaceType())
+                                    eltDecl->getPayloadInterfaceType())
                   ->getCanonicalType();
 
       AbstractionPattern origEltTy =
diff --git a/lib/SILOptimizer/Utils/InstOptUtils.cpp b/lib/SILOptimizer/Utils/InstOptUtils.cpp
@@ -823,7 +823,7 @@ namespace {
         if (!elt->hasAssociatedValues() || elt->isIndirect())
           continue;
 
-        if (visit(elt->getArgumentInterfaceType()->getCanonicalType()))
+        if (visit(elt->getPayloadInterfaceType()->getCanonicalType()))
           return true;
       }
       return false;
diff --git a/lib/Sema/DerivedConformances.cpp b/lib/Sema/DerivedConformances.cpp
@@ -871,8 +871,8 @@ Pattern *DerivedConformance::enumElementPayloadSubpattern(
   if (!enumElementDecl->hasAssociatedValues())
     return nullptr;
 
-  auto argumentType = enumElementDecl->getArgumentInterfaceType();
-  if (auto tupleType = argumentType->getAs<TupleType>()) {
+  auto payloadType = enumElementDecl->getPayloadInterfaceType();
+  if (auto tupleType = payloadType->getAs<TupleType>()) {
     // Either multiple (labeled or unlabeled) arguments, or one labeled
     // argument. Return a tuple pattern that matches the enum element in arity,
     // types, and labels. For example:
@@ -909,7 +909,7 @@ Pattern *DerivedConformance::enumElementPayloadSubpattern(
   // Otherwise, a one-argument unlabeled payload. Return a paren pattern whose
   // underlying type is the same as the payload. For example:
   // case a(Int) => (let a0)
-  auto underlyingType = argumentType->getWithoutParens();
+  auto underlyingType = payloadType->getWithoutParens();
   auto payloadVar = indexedVarDecl(varPrefix, 0, underlyingType, varContext);
   boundVars.push_back(payloadVar);
 
diff --git a/lib/Sema/TypeCheckCircularity.cpp b/lib/Sema/TypeCheckCircularity.cpp
@@ -282,7 +282,7 @@ bool CircularityChecker::expandEnum(CanType type, EnumDecl *E,
     if (!elt->hasAssociatedValues())
       continue;
 
-    auto eltType = elt->getArgumentInterfaceType().subst(subMap);
+    auto eltType = elt->getPayloadInterfaceType().subst(subMap);
     if (addMember(type, elt, eltType, depth))
       return true;
   }
@@ -346,7 +346,7 @@ static size_t findCycleIndex(const Path &path) {
 
 static Type getMemberStorageInterfaceType(ValueDecl *member) {
   if (auto elt = dyn_cast<EnumElementDecl>(member)) {
-    return elt->getArgumentInterfaceType();
+    return elt->getPayloadInterfaceType();
   } else {
     return member->getInterfaceType();
   }
@@ -599,14 +599,14 @@ void CircularityChecker::diagnoseNonWellFoundedEnum(EnumDecl *E) {
       if (!elt->isIndirect() && !E->isIndirect())
         return false;
 
-      auto argTy = elt->getArgumentInterfaceType();
-      if (!argTy)
+      auto payloadTy = elt->getPayloadInterfaceType();
+      if (!payloadTy)
         return false;
 
-      if (auto tuple = argTy->getAs<TupleType>()) {
+      if (auto tuple = payloadTy->getAs<TupleType>()) {
         if (!containsType(tuple, E->getSelfInterfaceType()))
           return false;
-      } else if (auto paren = dyn_cast<ParenType>(argTy.getPointer())) {
+      } else if (auto paren = dyn_cast<ParenType>(payloadTy.getPointer())) {
         if (!E->getSelfInterfaceType()->isEqual(paren->getUnderlyingType()))
           return false;
       }
diff --git a/lib/Sema/TypeCheckInvertible.cpp b/lib/Sema/TypeCheckInvertible.cpp
@@ -321,7 +321,7 @@ bool StorageVisitor::visit(NominalTypeDecl *nominal, DeclContext *dc) {
 
         // Check that the associated value type is Sendable.
         auto elementType = dc->mapTypeIntoContext(
-            element->getArgumentInterfaceType());
+            element->getPayloadInterfaceType());
         if ((*this)(element, elementType))
           return true;
       }
diff --git a/lib/Sema/TypeCheckPattern.cpp b/lib/Sema/TypeCheckPattern.cpp
@@ -1601,7 +1601,7 @@ Pattern *TypeChecker::coercePatternToType(
     }
 
     // If there is a subpattern, push the enum element type down onto it.
-    auto argType = elt->getArgumentInterfaceType();
+    auto payloadType = elt->getPayloadInterfaceType();
     if (EEP->hasSubPattern()) {
       Pattern *sub = EEP->getSubPattern();
       if (!elt->hasAssociatedValues()) {
@@ -1615,8 +1615,8 @@ Pattern *TypeChecker::coercePatternToType(
       }
       
       Type elementType;
-      if (argType)
-        elementType = enumTy->getTypeOfMember(elt, argType);
+      if (payloadType)
+        elementType = enumTy->getTypeOfMember(elt, payloadType);
       else
         elementType = TupleType::getEmpty(Context);
       auto newSubOptions = subOptions;
@@ -1633,11 +1633,11 @@ Pattern *TypeChecker::coercePatternToType(
         return nullptr;
 
       EEP->setSubPattern(sub);
-    } else if (argType) {
+    } else if (payloadType) {
       // Else if the element pattern has no sub-pattern but the element type has
       // associated values, expand it to be semantically equivalent to an
       // element pattern of wildcards.
-      Type elementType = enumTy->getTypeOfMember(elt, argType);
+      Type elementType = enumTy->getTypeOfMember(elt, payloadType);
       SmallVector<TuplePatternElt, 8> elements;
       if (auto *TTy = dyn_cast<TupleType>(elementType.getPointer())) {
         for (auto &elt : TTy->getElements()) {
diff --git a/lib/Sema/TypeCheckSwitchStmt.cpp b/lib/Sema/TypeCheckSwitchStmt.cpp
@@ -846,7 +846,7 @@ namespace {
                 // .e(a: X, b: X)   -> (a: X, b: X)
                 // .f((a: X, b: X)) -> ((a: X, b: X)
                 SmallVector<Space, 4> constElemSpaces;
-                if (auto payloadTy = eed->getArgumentInterfaceType()) {
+                if (auto payloadTy = eed->getPayloadInterfaceType()) {
                   auto eedTy = tp->getCanonicalType()->getTypeOfMember(
                       eed, payloadTy);
                   if (auto *TTy = eedTy->getAs<TupleType>()) {
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
@@ -4337,7 +4337,7 @@ class Serializer::DeclSerializer : public DeclVisitor<DeclSerializer> {
       // reason). However, we need a more robust handling of deserialization
       // dependencies that can handle circularities. rdar://problem/32359173
       collectDependenciesFromType(dependencyTypes,
-                                  nextElt->getArgumentInterfaceType(),
+                                  nextElt->getPayloadInterfaceType(),
                                   /*excluding*/theEnum->getParentModule());
     }
     for (Requirement req : theEnum->getGenericRequirements()) {

Original file line number	Diff line number	Diff line change
`@@ -8507,7 +8507,9 @@ class EnumElementDecl : public DeclContext, public ValueDecl {`
`8507`	`8507`	`return hasName() ? getBaseIdentifier().str() : "_";`
`8508`	`8508`	`}`
`8509`	`8509`
`8510`		`- Type getArgumentInterfaceType() const;`
	`8510`	`+ /// Retrieve the payload type for the enum element, which is a tuple of the`
	`8511`	`+ /// associated values, or null if there are no associated values.`
	`8512`	`+ Type getPayloadInterfaceType() const;`
`8511`	`8513`
`8512`	`8514`	`void setParameterList(ParameterList *params);`
`8513`	`8515`	`ParameterList *getParameterList() const { return Params; }`
Original file line number	Diff line number	Diff line change
`@@ -10601,7 +10601,7 @@ SourceRange EnumElementDecl::getSourceRange() const {`
`10601`	`10601`	`return {getStartLoc(), getNameLoc()};`
`10602`	`10602`	`}`
`10603`	`10603`
`10604`		`-Type EnumElementDecl::getArgumentInterfaceType() const {`
	`10604`	`+Type EnumElementDecl::getPayloadInterfaceType() const {`
`10605`	`10605`	`if (!hasAssociatedValues())`
`10606`	`10606`	`return nullptr;`
`10607`	`10607`
Original file line number	Diff line number	Diff line change
`@@ -2484,7 +2484,7 @@ namespace {`
`2484`	`2484`	`if (!elt->hasAssociatedValues() \|\| elt->isIndirect())`
`2485`	`2485`	`continue;`
`2486`	`2486`
`2487`		`- if (visit(elt->getArgumentInterfaceType()->getCanonicalType()))`
	`2487`	`+ if (visit(elt->getPayloadInterfaceType()->getCanonicalType()))`
`2488`	`2488`	`return true;`
`2489`	`2489`	`}`
`2490`	`2490`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ AbstractionPattern TypeConverter::getAbstractionPattern(EnumElementDecl *decl) {`
`120`	`120`	`auto sig = decl->getParentEnum()`
`121`	`121`	`->getGenericSignatureOfContext()`
`122`	`122`	`.getCanonicalSignature();`
`123`		`- auto type = sig.getReducedType(decl->getArgumentInterfaceType());`
	`123`	`+ auto type = sig.getReducedType(decl->getPayloadInterfaceType());`
`124`	`124`
`125`	`125`	`return AbstractionPattern(sig, type);`
`126`	`126`	`}`