Merge pull request swiftlang#19508 from nkcsgexi/include-super-class

nkcsgexi · web-flow · commit 3b16f34ad49f · 2018-09-24T14:19:55.000-07:00
swift-module-digester: diagnose super class changes as API breakages
diff --git a/include/swift/AST/DiagnosticsModuleDiffer.def b/include/swift/AST/DiagnosticsModuleDiffer.def
@@ -68,6 +68,10 @@ ERROR(default_associated_type_removed,none,"%0 has removed default type %1", (St
 
 ERROR(protocol_req_added,none,"%0 has been added as a protocol requirement", (StringRef))
 
+ERROR(super_class_removed,none,"%0 has removed its super class %1", (StringRef, StringRef))
+
+ERROR(super_class_changed,none,"%0 has changed its super class from %1 to %2", (StringRef, StringRef, StringRef))
+
 #ifndef DIAG_NO_UNDEF
 # if defined(DIAG)
 #  undef DIAG
diff --git a/include/swift/IDE/DigesterEnums.def b/include/swift/IDE/DigesterEnums.def
@@ -109,6 +109,7 @@ KEY(declAttributes)
 KEY(declKind)
 KEY(ownership)
 KEY(superclassUsr)
+KEY(superclassName)
 KEY(hasDefaultArg)
 KEY(conformingProtocols)
 KEY(enumRawTypeName)
diff --git a/test/api-digester/Inputs/cake1.swift b/test/api-digester/Inputs/cake1.swift
@@ -89,3 +89,5 @@ public protocol RequiementChanges {
   associatedtype removedType
   var removedVar: Int {get}
 }
+
+public class SuperClassRemoval: C3 {}
diff --git a/test/api-digester/Inputs/cake2.swift b/test/api-digester/Inputs/cake2.swift
@@ -96,3 +96,5 @@ public protocol RequiementChanges {
   func addedFunc()
   var addedVar: Int { get }
 }
+
+public class SuperClassRemoval {}
diff --git a/test/api-digester/Outputs/Cake-abi.txt b/test/api-digester/Outputs/Cake-abi.txt
@@ -59,3 +59,7 @@ cake1: AssociatedType AssociatedTypePro.T1 has removed default type Int
 cake2: AssociatedType RequiementChanges.addedTypeWithoutDefault has been added as a protocol requirement
 cake2: Func RequiementChanges.addedFunc() has been added as a protocol requirement
 cake2: Var RequiementChanges.addedVar has been added as a protocol requirement
+
+/* Class Inheritance Change */
+cake1: Class C4 has changed its super class from OldType to NewType
+cake1: Class SuperClassRemoval has removed its super class C3
diff --git a/test/api-digester/Outputs/Cake.txt b/test/api-digester/Outputs/Cake.txt
@@ -44,4 +44,8 @@ cake1: Struct fixedLayoutStruct has removed conformance to P1
 cake1: AssociatedType AssociatedTypePro.T1 has removed default type Int
 cake2: AssociatedType RequiementChanges.addedTypeWithoutDefault has been added as a protocol requirement
 cake2: Func RequiementChanges.addedFunc() has been added as a protocol requirement
-cake2: Var RequiementChanges.addedVar has been added as a protocol requirement
+cake2: Var RequiementChanges.addedVar has been added as a protocol requirement
+
+/* Class Inheritance Change */
+cake1: Class C4 has changed its super class from OldType to NewType
+cake1: Class SuperClassRemoval has removed its super class C3
diff --git a/test/api-digester/Outputs/cake-abi.json b/test/api-digester/Outputs/cake-abi.json
@@ -198,6 +198,7 @@
       "location": "",
       "moduleName": "cake",
       "superclassUsr": "s:4cake2C0C",
+      "superclassName": "C0",
       "children": [
         {
           "kind": "Function",
diff --git a/test/api-digester/Outputs/cake.json b/test/api-digester/Outputs/cake.json
@@ -205,6 +205,7 @@
       "location": "",
       "moduleName": "cake",
       "superclassUsr": "s:4cake2C0C",
+      "superclassName": "C0",
       "children": [
         {
           "kind": "Function",
diff --git a/test/api-digester/Outputs/clang-module-dump.txt b/test/api-digester/Outputs/clang-module-dump.txt
@@ -12,6 +12,7 @@
       "location": "",
       "moduleName": "Foo",
       "superclassUsr": "c:objc(cs)NSObject",
+      "superclassName": "NSObject",
       "conformingProtocols": [
         "ObjcProt",
         "NSObjectProtocol"
diff --git a/tools/swift-api-digester/ModuleAnalyzerNodes.cpp b/tools/swift-api-digester/ModuleAnalyzerNodes.cpp
diff --git a/tools/swift-api-digester/ModuleAnalyzerNodes.h b/tools/swift-api-digester/ModuleAnalyzerNodes.h
diff --git a/tools/swift-api-digester/ModuleDiagsConsumer.cpp b/tools/swift-api-digester/ModuleDiagsConsumer.cpp
diff --git a/tools/swift-api-digester/swift-api-digester.cpp b/tools/swift-api-digester/swift-api-digester.cpp

Original file line number	Diff line number	Diff line change
`@@ -89,3 +89,5 @@ public protocol RequiementChanges {`
`89`	`89`	`associatedtype removedType`
`90`	`90`	`var removedVar: Int {get}`
`91`	`91`	`}`
	`92`	`+`
	`93`	`+public class SuperClassRemoval: C3 {}`
Original file line number	Diff line number	Diff line change
`@@ -96,3 +96,5 @@ public protocol RequiementChanges {`
`96`	`96`	`func addedFunc()`
`97`	`97`	`var addedVar: Int { get }`
`98`	`98`	`}`
	`99`	`+`
	`100`	`+public class SuperClassRemoval {}`
Original file line number	Diff line number	Diff line change
`@@ -198,6 +198,7 @@`
`198`	`198`	`"location": "",`
`199`	`199`	`"moduleName": "cake",`
`200`	`200`	`"superclassUsr": "s:4cake2C0C",`
	`201`	`+ "superclassName": "C0",`
`201`	`202`	`"children": [`
`202`	`203`	`{`
`203`	`204`	`"kind": "Function",`
Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,7 @@`
`205`	`205`	`"location": "",`
`206`	`206`	`"moduleName": "cake",`
`207`	`207`	`"superclassUsr": "s:4cake2C0C",`
	`208`	`+ "superclassName": "C0",`
`208`	`209`	`"children": [`
`209`	`210`	`{`
`210`	`211`	`"kind": "Function",`