averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

swift-api-digester: teach the tool to detect [String:Any] changes to [StringRepresentable:Any].

Browse Source 
This allows us to migrate string enum changes from the frameworks.
This commit is contained in:
Xi Ge
2018-03-26 15:32:26 -07:00
parent 08c73914b1
commit b2c437525c
3 changed files with 85 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
tools/swift-api-digester/swift-api-digester.cpp
View File

@@ -277,6 +277,11 @@ enum class KnownTypeKind: uint8_t {
Unknown,
};
enum class KnownProtocolKind: uint8_t {
#define KNOWN_PROTOCOL(NAME) NAME,
#include "swift/IDE/DigesterEnums.def"
};
enum class SDKDeclAttrKind: uint8_t {
#define DECL_ATTR(Name) DAK_##Name,
#include "swift/IDE/DigesterEnums.def"
@@ -831,6 +836,18 @@ public:
}
return None;
}
bool isConformingTo(KnownProtocolKind Kind) const {
StringRef Usr;
switch (Kind) {
#define KNOWN_PROTOCOL(NAME) \
case KnownProtocolKind::NAME: \
return std::find(ConformingProtocols.begin(), \
ConformingProtocols.end(), \
#NAME) != ConformingProtocols.end();
#include "swift/IDE/DigesterEnums.def"
}
}
};
class SDKNodeTypeAlias : public SDKNodeDecl {
@@ -2598,6 +2615,38 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
return false;
}
bool detectDictionaryKeyChange(SDKNodeType *L, SDKNodeType *R) {
if (!IsVisitingLeft)
return false;
if (L->getTypeKind() != KnownTypeKind::Dictionary ||
R->getTypeKind() != KnownTypeKind::Dictionary)
return false;
auto *Left = dyn_cast<SDKNodeTypeNominal>(L);
auto *Right = dyn_cast<SDKNodeTypeNominal>(R);
assert(Left && Right);
assert(Left->getChildrenCount() == 2);
assert(Right->getChildrenCount() == 2);
auto* LKey = dyn_cast<SDKNodeTypeNominal>(*Left->getChildBegin());
auto* RKey = dyn_cast<SDKNodeTypeNominal>(*Right->getChildBegin());
if (!LKey || !RKey)
return false;
if (LKey->getTypeKind() != KnownTypeKind::String)
return false;
auto Results = RKey->getRootNode()->getDescendantsByUsr(RKey->getUsr());
if (Results.empty())
return false;
if (auto DT = dyn_cast<SDKNodeTypeDecl>(Results.front())) {
if (DT->isConformingTo(KnownProtocolKind::RawRepresentable)) {
L->annotate(NodeAnnotation::DictionaryKeyUpdate);
L->annotate(NodeAnnotation::TypeRewrittenRight);
L->addAnnotateComment(NodeAnnotation::TypeRewrittenRight,
DT->getFullyQualifiedName());
return true;
}
}
return false;
}
bool isUnhandledCase(SDKNodeType *Node) {
auto Counter = UpdateMap.findUpdateCounterpart(Node)->getAs<SDKNodeType>();
return Node->getTypeKind() == KnownTypeKind::Void ||
@@ -2628,6 +2677,7 @@ public:
detectOptionalUpdate(Node, Counter)||
detectWrapImplicitOptional(Node, Counter)||
detectUnmanagedUpdate(Node, Counter)||
detectDictionaryKeyChange(Node, Counter) ||
detectTypeRewritten(Node, Counter);
(void) Result;
return;
@@ -2739,6 +2789,7 @@ class DiffItemEmitter : public SDKNodeVisitor {
static StringRef getRightComment(NodePtr Node, NodeAnnotation Anno) {
switch (Anno) {
case NodeAnnotation::DictionaryKeyUpdate:
case NodeAnnotation::TypeRewritten:
return Node->getAnnotateComment(NodeAnnotation::TypeRewrittenRight);
case NodeAnnotation::ModernizeEnum:
@@ -2795,7 +2846,8 @@ class DiffItemEmitter : public SDKNodeVisitor {
NodeAnnotation::GetterToProperty,
NodeAnnotation::ModernizeEnum,
NodeAnnotation::Rename,
NodeAnnotation::NowThrowing
NodeAnnotation::NowThrowing,
NodeAnnotation::DictionaryKeyUpdate,
});
}