Merge pull request swiftlang#18788 from brentdax/indigestion

Add some proper diagnostics to the API digester

Author: nkcsgexi

include/swift/AST/DiagnosticsCommon.def

@@ -93,6 +93,19 @@ ERROR(attr_only_on_parameters, none,
 ERROR(function_type_no_parens,none,
       "single argument function types require parentheses", ())
 
+// FIXME: Used by swift-api-digester. Don't want to set up a separate diagnostics
+// file just for a few errors.
+ERROR(sdk_node_unrecognized_key,none,
+      "unrecognized key '%0' in SDK node", (StringRef))
+ERROR(sdk_node_unrecognized_node_kind,none,
+      "unrecognized SDK node kind '%0'", (StringRef))
+ERROR(sdk_node_unrecognized_type_attr_kind,none,
+      "unrecognized type attribute '%0' in SDK node", (StringRef))
+ERROR(sdk_node_unrecognized_decl_attr_kind,none,
+      "unrecognized declaration attribute '%0' in SDK node", (StringRef))
+ERROR(sdk_node_unrecognized_decl_kind,none,
+      "unrecognized declaration kind '%0' in SDK node", (StringRef))
+
 //------------------------------------------------------------------------------
 // MARK: Circular reference diagnostics
 //------------------------------------------------------------------------------

include/swift/IDE/APIDigesterData.h

@@ -33,7 +33,7 @@ enum class SDKNodeKind: uint8_t {
 #include "DigesterEnums.def"
 };
 
-SDKNodeKind parseSDKNodeKind(StringRef Content);
+Optional<SDKNodeKind> parseSDKNodeKind(StringRef Content);
 
 enum class NodeAnnotation: uint8_t{
 #define NODE_ANNOTATION(NAME) NAME,

lib/IDE/APIDigesterData.cpp

@@ -39,10 +39,11 @@ operator<<(raw_ostream &Out, const NodeAnnotation Value) {
   llvm_unreachable("Undefined SDK node kind.");
 }
 
-SDKNodeKind swift::ide::api::parseSDKNodeKind(StringRef Content) {
-  return llvm::StringSwitch<SDKNodeKind>(Content)
+Optional<SDKNodeKind> swift::ide::api::parseSDKNodeKind(StringRef Content) {
+  return llvm::StringSwitch<Optional<SDKNodeKind>>(Content)
 #define NODE_KIND(NAME, VALUE) .Case(#VALUE, SDKNodeKind::NAME)
 #include "swift/IDE/DigesterEnums.def"
+    .Default(None)
   ;
 }
 
@@ -326,7 +327,7 @@ serializeDiffItem(llvm::BumpPtrAllocator &Alloc,
   switch (parseDiffItemKind(DiffItemKind)) {
   case APIDiffItemKind::ADK_CommonDiffItem: {
     return new (Alloc.Allocate<CommonDiffItem>())
-      CommonDiffItem(parseSDKNodeKind(NodeKind),
+      CommonDiffItem(*parseSDKNodeKind(NodeKind),
                      parseSDKNodeAnnotation(NodeAnnotation), ChildIndex,
                      LeftUsr, RightUsr, LeftComment, RightComment, ModuleName);
   }

test/api-digester/diagnostics.json

@@ -0,0 +1,14 @@
+{
+  "kind": "Root",
+  "name": "TopLevel",
+  "printedName": "TopLevel",
+  "badKey": ["foo", "bar", "baz"],
+  "children": [
+    {
+      "kind": "Zyzyx",
+      "typeAttributes": ["autoclosure", "fnord", "inout", "Available"],
+      "declAttributes": ["Available", "Fnord", "ObjC", "inout"],
+      "declKind": "Subroutine"
+    }
+  ]
+}

test/api-digester/diagnostics.swift

@@ -0,0 +1,13 @@
+// REQUIRES: OS=macosx
+// RUN: not %api-digester -deserialize-sdk -input-paths %S/diagnostics.json -o - 2>&1 | %FileCheck %s
+
+// CHECK: diagnostics.json:5:3: error: unrecognized key 'badKey' in SDK node
+// CHECK: diagnostics.json:8:15: error: unrecognized SDK node kind 'Zyzyx'
+// CHECK: diagnostics.json:9:41: error: unrecognized type attribute 'fnord' in SDK node
+// CHECK: diagnostics.json:9:59: error: unrecognized type attribute 'Available' in SDK node
+// CHECK: diagnostics.json:10:39: error: unrecognized declaration attribute 'Fnord' in SDK node
+// CHECK: diagnostics.json:10:56: error: unrecognized declaration attribute 'inout' in SDK node
+// CHECK: diagnostics.json:11:19: error: unrecognized declaration kind 'Subroutine' in SDK node
+
+// Make sure we don't try to output a result:
+// CHECK-NOT: "kind": "Root",