//===--- ProtocolConformance.cpp - AST Protocol Conformance ---------------===// // // This source file is part of the Swift.org open source project // // Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors // Licensed under Apache License v2.0 with Runtime Library Exception // // See http://swift.org/LICENSE.txt for license information // See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors // //===----------------------------------------------------------------------===// // // This file implements the protocol conformance data structures. // //===----------------------------------------------------------------------===// #include "ConformanceLookupTable.h" #include "swift/Basic/Fallthrough.h" #include "swift/AST/ASTContext.h" #include "swift/AST/Decl.h" #include "swift/AST/LazyResolver.h" #include "swift/AST/Module.h" #include "swift/AST/ProtocolConformance.h" #include "swift/AST/Substitution.h" #include "swift/AST/Types.h" #include "swift/AST/TypeWalker.h" #include "llvm/ADT/MapVector.h" #include "llvm/ADT/TinyPtrVector.h" #include "llvm/Support/SaveAndRestore.h" using namespace swift; ProtocolConformanceRef::ProtocolConformanceRef(ProtocolDecl *protocol, ProtocolConformance *conf) { assert(protocol != nullptr && "cannot construct ProtocolConformanceRef with null protocol"); if (conf) { assert(protocol == conf->getProtocol() && "protocol conformance mismatch"); Union = conf; } else { Union = protocol; } } ProtocolDecl *ProtocolConformanceRef::getRequirement() const { if (isConcrete()) { return getConcrete()->getProtocol(); } else { return getAbstract(); } } void *ProtocolConformance::operator new(size_t bytes, ASTContext &context, AllocationArena arena, unsigned alignment) { return context.Allocate(bytes, alignment, arena); } #define CONFORMANCE_SUBCLASS_DISPATCH(Method, Args) \ switch (getKind()) { \ case ProtocolConformanceKind::Normal: \ static_assert(&ProtocolConformance::Method != \ &NormalProtocolConformance::Method, \ "Must override NormalProtocolConformance::" #Method); \ return cast(this)->Method Args; \ case ProtocolConformanceKind::Specialized: \ static_assert(&ProtocolConformance::Method != \ &SpecializedProtocolConformance::Method, \ "Must override SpecializedProtocolConformance::" #Method); \ return cast(this)->Method Args; \ case ProtocolConformanceKind::Inherited: \ static_assert(&ProtocolConformance::Method != \ &InheritedProtocolConformance::Method, \ "Must override InheritedProtocolConformance::" #Method); \ return cast(this)->Method Args; \ } \ llvm_unreachable("bad ProtocolConformanceKind"); /// Get the protocol being conformed to. ProtocolDecl *ProtocolConformance::getProtocol() const { CONFORMANCE_SUBCLASS_DISPATCH(getProtocol, ()) } DeclContext *ProtocolConformance::getDeclContext() const { CONFORMANCE_SUBCLASS_DISPATCH(getDeclContext, ()) } /// Retrieve the state of this conformance. ProtocolConformanceState ProtocolConformance::getState() const { CONFORMANCE_SUBCLASS_DISPATCH(getState, ()) } bool ProtocolConformance::hasTypeWitness(AssociatedTypeDecl *assocType, LazyResolver *resolver) const { CONFORMANCE_SUBCLASS_DISPATCH(hasTypeWitness, (assocType, resolver)); } std::pair ProtocolConformance::getTypeWitnessSubstAndDecl(AssociatedTypeDecl *assocType, LazyResolver *resolver) const { CONFORMANCE_SUBCLASS_DISPATCH(getTypeWitnessSubstAndDecl, (assocType, resolver)) } const Substitution & ProtocolConformance::getTypeWitness(AssociatedTypeDecl *assocType, LazyResolver *resolver) const { return getTypeWitnessSubstAndDecl(assocType, resolver).first; } Type ProtocolConformance::getTypeWitnessByName(Type type, ProtocolConformance *conformance, Identifier name, LazyResolver *resolver) { // For an archetype, retrieve the nested type with the appropriate // name. There are no conformance tables. if (auto archetype = type->getAs()) { return archetype->getNestedTypeValue(name); } // Find the named requirement. AssociatedTypeDecl *assocType = nullptr; auto members = conformance->getProtocol()->lookupDirect(name); for (auto member : members) { assocType = dyn_cast(member); if (assocType) break; } if (!assocType) return nullptr; assert(conformance && "Missing conformance information"); if (!conformance->hasTypeWitness(assocType, resolver)) { return nullptr; } return conformance->getTypeWitness(assocType, resolver).getReplacement(); } ConcreteDeclRef ProtocolConformance::getWitness(ValueDecl *requirement, LazyResolver *resolver) const { CONFORMANCE_SUBCLASS_DISPATCH(getWitness, (requirement, resolver)) } const InheritedConformanceMap & ProtocolConformance::getInheritedConformances() const { CONFORMANCE_SUBCLASS_DISPATCH(getInheritedConformances, ()) } /// Determine whether the witness for the given requirement /// is either the default definition or was otherwise deduced. bool ProtocolConformance::usesDefaultDefinition(ValueDecl *requirement) const { CONFORMANCE_SUBCLASS_DISPATCH(usesDefaultDefinition, (requirement)) } GenericParamList *ProtocolConformance::getGenericParams() const { switch (getKind()) { case ProtocolConformanceKind::Inherited: case ProtocolConformanceKind::Normal: // If we have a normal or inherited protocol conformance, look for its // generic parameters. return getDeclContext()->getGenericParamsOfContext(); case ProtocolConformanceKind::Specialized: // If we have a specialized protocol conformance, since we do not support // currently partial specialization, we know that it cannot have any open // type variables. return nullptr; } } GenericSignature *ProtocolConformance::getGenericSignature() const { switch (getKind()) { case ProtocolConformanceKind::Inherited: case ProtocolConformanceKind::Normal: // If we have a normal or inherited protocol conformance, look for its // generic signature. return getDeclContext()->getGenericSignatureOfContext(); case ProtocolConformanceKind::Specialized: // If we have a specialized protocol conformance, since we do not support // currently partial specialization, we know that it cannot have any open // type variables. return nullptr; } } bool ProtocolConformance::isBehaviorConformance() const { return getRootNormalConformance()->isBehaviorConformance(); } AbstractStorageDecl *ProtocolConformance::getBehaviorDecl() const { return getRootNormalConformance()->getBehaviorDecl(); } void NormalProtocolConformance::resolveLazyInfo() const { assert(Resolver); assert(isComplete()); auto *resolver = Resolver; auto *mutableThis = const_cast(this); mutableThis->Resolver = nullptr; mutableThis->setState(ProtocolConformanceState::Incomplete); resolver->finishNormalConformance(mutableThis, ResolverContextData); mutableThis->setState(ProtocolConformanceState::Complete); } void NormalProtocolConformance::setLazyLoader(LazyMemberLoader *resolver, uint64_t contextData) { assert(!Resolver && "already has a resolver"); Resolver = resolver; ResolverContextData = contextData; } bool NormalProtocolConformance::hasTypeWitness(AssociatedTypeDecl *assocType, LazyResolver *resolver) const { if (Resolver) resolveLazyInfo(); if (TypeWitnesses.find(assocType) != TypeWitnesses.end()) { return true; } if (resolver) { resolver->resolveTypeWitness(this, assocType); if (TypeWitnesses.find(assocType) != TypeWitnesses.end()) { return true; } } return false; } std::pair NormalProtocolConformance::getTypeWitnessSubstAndDecl( AssociatedTypeDecl *assocType, LazyResolver *resolver) const { if (Resolver) resolveLazyInfo(); auto known = TypeWitnesses.find(assocType); if (known == TypeWitnesses.end()) { assert(resolver && "Unable to resolve type witness"); resolver->resolveTypeWitness(this, assocType); known = TypeWitnesses.find(assocType); assert(known != TypeWitnesses.end() && "Didn't resolve witness?"); } return known->second; } void NormalProtocolConformance::setTypeWitness( AssociatedTypeDecl *assocType, const Substitution &substitution, TypeDecl *typeDecl) const { assert(getProtocol() == cast(assocType->getDeclContext()) && "associated type in wrong protocol"); assert(TypeWitnesses.count(assocType) == 0 && "Type witness already known"); assert((!isComplete() || isInvalid()) && "Conformance already complete?"); TypeWitnesses[assocType] = std::make_pair(substitution, typeDecl); } /// Retrieve the value witness corresponding to the given requirement. ConcreteDeclRef NormalProtocolConformance::getWitness( ValueDecl *requirement, LazyResolver *resolver) const { assert(!isa(requirement) && "Request type witness"); if (Resolver) resolveLazyInfo(); auto known = Mapping.find(requirement); if (known == Mapping.end()) { assert(resolver && "Unable to resolve witness without resolver"); resolver->resolveWitness(this, requirement); known = Mapping.find(requirement); } if (known != Mapping.end()) { return known->second; } else { assert((!isComplete() || isInvalid()) && "Resolver did not resolve requirement"); return ConcreteDeclRef(); } } void NormalProtocolConformance::setWitness(ValueDecl *requirement, ConcreteDeclRef witness) const { assert(!isa(requirement) && "Request type witness"); assert(getProtocol() == cast(requirement->getDeclContext()) && "requirement in wrong protocol"); assert(Mapping.count(requirement) == 0 && "Witness already known"); assert((!isComplete() || isInvalid()) && "Conformance already complete?"); Mapping[requirement] = witness; } SpecializedProtocolConformance::SpecializedProtocolConformance( Type conformingType, ProtocolConformance *genericConformance, ArrayRef substitutions) : ProtocolConformance(ProtocolConformanceKind::Specialized, conformingType, // FIXME: interface type should be passed in. // assumes specialized conformance is always fully // specialized conformingType), GenericConformance(genericConformance), GenericSubstitutions(substitutions) { assert(genericConformance->getKind() != ProtocolConformanceKind::Specialized); } SubstitutionIterator SpecializedProtocolConformance::getGenericSubstitutionIterator() const { return SubstitutionIterator( GenericConformance->getDeclContext()->getGenericParamsOfContext(), GenericSubstitutions); } bool SpecializedProtocolConformance::hasTypeWitness( AssociatedTypeDecl *assocType, LazyResolver *resolver) const { return TypeWitnesses.find(assocType) != TypeWitnesses.end() || GenericConformance->hasTypeWitness(assocType, resolver); } std::pair SpecializedProtocolConformance::getTypeWitnessSubstAndDecl( AssociatedTypeDecl *assocType, LazyResolver *resolver) const { // If we've already created this type witness, return it. auto known = TypeWitnesses.find(assocType); if (known != TypeWitnesses.end()) { return known->second; } // Otherwise, perform substitutions to create this witness now. TypeSubstitutionMap substitutionMap = GenericConformance->getGenericParams() ->getSubstitutionMap(GenericSubstitutions); auto genericWitnessAndDecl = GenericConformance->getTypeWitnessSubstAndDecl(assocType, resolver); auto &genericWitness = genericWitnessAndDecl.first; auto *typeDecl = genericWitnessAndDecl.second; auto conformingDC = getDeclContext(); auto conformingModule = conformingDC->getParentModule(); auto specializedType = genericWitness.getReplacement().subst(conformingModule, substitutionMap, None); // If the type witness was unchanged, just copy it directly. if (specializedType.getPointer() == genericWitness.getReplacement().getPointer()) { TypeWitnesses[assocType] = genericWitnessAndDecl; return TypeWitnesses[assocType]; } // Gather the conformances for the type witness. These should never fail. SmallVector conformances; for (auto proto : assocType->getConformingProtocols(resolver)) { auto conforms = conformingModule->lookupConformance(specializedType, proto, resolver); assert((conforms.getInt() == ConformanceKind::Conforms || specializedType->is() || specializedType->isTypeParameter() || specializedType->is()) && "Improperly checked substitution"); conformances.push_back(ProtocolConformanceRef(proto, conforms.getPointer())); } // Form the substitution. auto &ctx = assocType->getASTContext(); TypeWitnesses[assocType] = std::make_pair( Substitution{specializedType, ctx.AllocateCopy(conformances)}, typeDecl); return TypeWitnesses[assocType]; } ConcreteDeclRef SpecializedProtocolConformance::getWitness(ValueDecl *requirement, LazyResolver *resolver) const { // FIXME: Apply substitutions here! return GenericConformance->getWitness(requirement, resolver); } const NormalProtocolConformance * ProtocolConformance::getRootNormalConformance() const { const ProtocolConformance *C = this; while (!isa(C)) { switch (C->getKind()) { case ProtocolConformanceKind::Normal: llvm_unreachable("should have broken out of loop"); case ProtocolConformanceKind::Inherited: C = cast(C) ->getInheritedConformance(); break; case ProtocolConformanceKind::Specialized: C = cast(C) ->getGenericConformance(); break; } } return cast(C); } ProtocolConformance *ProtocolConformance::subst(Module *module, Type substType, ArrayRef subs, TypeSubstitutionMap &subMap, ArchetypeConformanceMap &conformanceMap) { if (getType()->isEqual(substType)) return this; switch (getKind()) { case ProtocolConformanceKind::Normal: if (substType->isSpecialized()) { assert(getType()->isSpecialized() && "substitution mapped non-specialized to specialized?!"); assert(getType()->getNominalOrBoundGenericNominal() == substType->getNominalOrBoundGenericNominal() && "substitution mapped to different nominal?!"); return module->getASTContext() .getSpecializedConformance(substType, this, substType->gatherAllSubstitutions(module, nullptr)); } assert(substType->isEqual(getType()) && "substitution changed non-specialized type?!"); return this; case ProtocolConformanceKind::Inherited: { // Substitute the base. auto inheritedConformance = cast(this)->getInheritedConformance(); ProtocolConformance *newBase; if (inheritedConformance->getType()->isSpecialized()) { newBase = inheritedConformance->subst(module, substType, subs, subMap, conformanceMap); } else { newBase = inheritedConformance; } return module->getASTContext() .getInheritedConformance(substType, newBase); } case ProtocolConformanceKind::Specialized: { // Substitute the substitutions in the specialized conformance. auto spec = cast(this); SmallVector newSubs; newSubs.reserve(spec->getGenericSubstitutions().size()); for (auto &sub : spec->getGenericSubstitutions()) newSubs.push_back(sub.subst(module, subs, subMap, conformanceMap)); auto ctxNewSubs = module->getASTContext().AllocateCopy(newSubs); return module->getASTContext() .getSpecializedConformance(substType, spec->getGenericConformance(), ctxNewSubs); } } llvm_unreachable("bad ProtocolConformanceKind"); } ProtocolConformance * ProtocolConformance::getInheritedConformance(ProtocolDecl *protocol) const { // Preserve specialization through this operation by peeling off the // substitutions from a specialized conformance so we can apply them later. const ProtocolConformance *unspecialized; SubstitutionIterator subs; switch (getKind()) { case ProtocolConformanceKind::Specialized: { auto spec = cast(this); unspecialized = spec->getGenericConformance(); subs = spec->getGenericSubstitutionIterator(); break; } case ProtocolConformanceKind::Normal: case ProtocolConformanceKind::Inherited: unspecialized = this; break; } ProtocolConformance *foundInherited; // Search for the inherited conformance among our immediate parents. auto &inherited = unspecialized->getInheritedConformances(); auto known = inherited.find(protocol); if (known != inherited.end()) { foundInherited = known->second; goto found_inherited; } // If not there, the inherited conformance must be available through one of // our parents. for (auto &inheritedMapping : inherited) if (inheritedMapping.first->inheritsFrom(protocol)) { foundInherited = inheritedMapping.second-> getInheritedConformance(protocol); goto found_inherited; } llvm_unreachable("Can't find the inherited conformance."); found_inherited: // Specialize the inherited conformance, if necessary. if (!subs.empty()) { TypeSubstitutionMap subMap; ArchetypeConformanceMap conformanceMap; // Fill in the substitution and conformance maps. for (auto archAndSub : subs) { auto arch = archAndSub.first; auto sub = archAndSub.second; conformanceMap[arch] = sub.getConformances(); if (arch->isPrimary()) subMap[arch] = sub.getReplacement(); } return foundInherited->subst(getDeclContext()->getParentModule(), getType(), subs.getSubstitutions(), subMap, conformanceMap); } assert((getType()->isEqual(foundInherited->getType()) || foundInherited->getType()->isExactSuperclassOf(getType(), nullptr)) && "inherited conformance does not match type"); return foundInherited; } #pragma mark Protocol conformance lookup void NominalTypeDecl::prepareConformanceTable() const { if (ConformanceTable) return; auto mutableThis = const_cast(this); ASTContext &ctx = getASTContext(); auto resolver = ctx.getLazyResolver(); ConformanceTable = new (ctx) ConformanceLookupTable(ctx, mutableThis, resolver); // If this type declaration was not parsed from source code or introduced // via the Clang importer, don't add any synthesized conformances. if (!getParentSourceFile() && !hasClangNode()) return; // Add any synthesized conformances. if (isa(this)) { if (auto anyObject = getASTContext().getProtocol( KnownProtocolKind::AnyObject)) { ConformanceTable->addSynthesizedConformance(mutableThis, anyObject); } } else if (auto theEnum = dyn_cast(mutableThis)) { if (theEnum->hasOnlyCasesWithoutAssociatedValues()) { // Simple enumerations conform to Equatable. if (auto equatable = ctx.getProtocol(KnownProtocolKind::Equatable)) { ConformanceTable->addSynthesizedConformance(mutableThis, equatable); } // Simple enumerations conform to Hashable. if (auto hashable = getASTContext().getProtocol( KnownProtocolKind::Hashable)) { ConformanceTable->addSynthesizedConformance(mutableThis, hashable); } } // Enumerations with a raw type conform to RawRepresentable. if (resolver) resolver->resolveRawType(theEnum); if (theEnum->hasRawType()) { if (auto rawRepresentable = getASTContext().getProtocol( KnownProtocolKind::RawRepresentable)) { ConformanceTable->addSynthesizedConformance(mutableThis, rawRepresentable); } } } // Add protocols for any synthesized protocol attributes. for (auto attr : getAttrs()) { if (auto synthesizedProto = dyn_cast(attr)) { if (auto proto = getASTContext().getProtocol( synthesizedProto->getProtocolKind())) { ConformanceTable->addSynthesizedConformance(mutableThis, proto); } } } } bool NominalTypeDecl::lookupConformance( Module *module, ProtocolDecl *protocol, SmallVectorImpl &conformances) const { prepareConformanceTable(); return ConformanceTable->lookupConformance( module, const_cast(this), protocol, getASTContext().getLazyResolver(), conformances); } SmallVector NominalTypeDecl::getAllProtocols() const { prepareConformanceTable(); SmallVector result; ConformanceTable->getAllProtocols(const_cast(this), getASTContext().getLazyResolver(), result); return result; } SmallVector NominalTypeDecl::getAllConformances( bool sorted) const { prepareConformanceTable(); SmallVector result; ConformanceTable->getAllConformances(const_cast(this), getASTContext().getLazyResolver(), sorted, result); return result; } void NominalTypeDecl::getImplicitProtocols( SmallVectorImpl &protocols) { prepareConformanceTable(); ConformanceTable->getImplicitProtocols(this, protocols); } void NominalTypeDecl::registerProtocolConformance( ProtocolConformance *conformance) { prepareConformanceTable(); ConformanceTable->registerProtocolConformance(conformance); } ArrayRef NominalTypeDecl::getSatisfiedProtocolRequirementsForMember( const ValueDecl *member, bool sorted) const { assert(member->getDeclContext()->getAsNominalTypeOrNominalTypeExtensionContext() == this); assert(!isa(this)); prepareConformanceTable(); return ConformanceTable->getSatisfiedProtocolRequirementsForMember(member, const_cast(this), getASTContext().getLazyResolver(), sorted); } SmallVector DeclContext::getLocalProtocols( ConformanceLookupKind lookupKind, SmallVectorImpl *diagnostics, bool sorted) const { SmallVector result; // Dig out the nominal type. NominalTypeDecl *nominal = getAsNominalTypeOrNominalTypeExtensionContext(); if (!nominal) return result; // Update to record all potential conformances. nominal->prepareConformanceTable(); nominal->ConformanceTable->lookupConformances( nominal, const_cast(this), getASTContext().getLazyResolver(), lookupKind, &result, nullptr, diagnostics); // Sort if required. if (sorted) { llvm::array_pod_sort(result.begin(), result.end(), &ProtocolType::compareProtocols); } return result; } SmallVector DeclContext::getLocalConformances( ConformanceLookupKind lookupKind, SmallVectorImpl *diagnostics, bool sorted) const { SmallVector result; // Dig out the nominal type. NominalTypeDecl *nominal = getAsNominalTypeOrNominalTypeExtensionContext(); if (!nominal) return result; // Protocols don't have conformances. if (isa(nominal)) return { }; // Update to record all potential conformances. nominal->prepareConformanceTable(); nominal->ConformanceTable->lookupConformances( nominal, const_cast(this), nominal->getASTContext().getLazyResolver(), lookupKind, nullptr, &result, diagnostics); // If requested, sort the results. if (sorted) { llvm::array_pod_sort(result.begin(), result.end(), &ConformanceLookupTable::compareProtocolConformances); } return result; }