Expose diagnostic category via SourceKit

Author: fwcd

lib/AST/DiagnosticEngine.cpp

@@ -1131,9 +1131,9 @@ DiagnosticEngine::diagnosticInfoForDiagnostic(const Diagnostic &diagnostic) {
   StringRef Category;
   if (isAPIDigesterBreakageDiagnostic(diagnostic.getID()))
     Category = "api-digester-breaking-change";
-  if (isDeprecationDiagnostic(diagnostic.getID()))
+  else if (isDeprecationDiagnostic(diagnostic.getID()))
     Category = "deprecation";
-  if (isNoUsageDiagnostic(diagnostic.getID()))
+  else if (isNoUsageDiagnostic(diagnostic.getID()))
     Category = "no-usage";
 
   return DiagnosticInfo(

tools/SourceKit/docs/Protocol.md

@@ -310,16 +310,17 @@ entity ::=
 ```
 diagnostic ::=
 {
-    <key.id>:          (string) // The internal ID of the diagnostic.
-    <key.line>:        (int64)  // The line upon which the diagnostic was emitted.
-    <key.column>:      (int64)  // The column upon which the diagnostic was emitted.
-    <key.filepath>:    (string) // The absolute path to the file that was being parsed
-                                // when the diagnostic was emitted.
-    <key.severity>:    (UID)    // The severity of the diagnostic. Can be one of:
-                                //   - source.diagnostic.severity.note
-                                //   - source.diagnostic.severity.warning
-                                //   - source.diagnostic.severity.error
-    <key.description>: (string) // A description of the diagnostic.
+    <key.id>:             (string) // The internal ID of the diagnostic.
+    <key.line>:           (int64)  // The line upon which the diagnostic was emitted.
+    <key.column>:         (int64)  // The column upon which the diagnostic was emitted.
+    <key.filepath>:       (string) // The absolute path to the file that was being parsed
+                                   // when the diagnostic was emitted.
+    <key.severity>:       (UID)    // The severity of the diagnostic. Can be one of:
+                                   //   - source.diagnostic.severity.note
+                                   //   - source.diagnostic.severity.warning
+                                   //   - source.diagnostic.severity.error
+    <key.description>:    (string) // A description of the diagnostic.
+    [opt] <key.category>: (string) // The category of the diagnostic, e.g. 'deprecation', 'no-usage', ...
 }
 ```
 

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -201,6 +201,7 @@ struct DiagnosticEntryInfoBase {
   };
 
   std::string ID;
+  std::string Category;
   std::string Description;
   unsigned Offset = 0;
   unsigned Line = 0;

tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp

@@ -101,6 +101,7 @@ void EditorDiagConsumer::handleDiagnostic(SourceManager &SM,
   DiagnosticEntryInfo SKInfo;
 
   SKInfo.ID = DiagnosticEngine::diagnosticIDStringFor(Info.ID).str();
+  SKInfo.Category = Info.Category.str();
 
   // Actually substitute the diagnostic arguments into the diagnostic text.
   llvm::SmallString<256> Text;

tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp

@@ -2827,6 +2827,9 @@ static void fillDictionaryForDiagnosticInfoBase(
   if (!Info.ID.empty())
     Elem.set(KeyID, Info.ID);
 
+  if (!Info.Category.empty())
+    Elem.set(KeyCategory, Info.Category);
+
   Elem.set(KeyDescription, Info.Description);
   if (Info.Line != 0) {
     Elem.set(KeyLine, Info.Line);