Represent diagnostic categories as UIDs in SourceKit (WIP)

Author: fwcd

tools/SourceKit/docs/Protocol.md

@@ -310,17 +310,19 @@ 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.
-    [opt] <key.category>: (string) // The category of the diagnostic, e.g. 'deprecation', 'no-usage', ...
+    <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.categories>: (array) [UID*] // The categories of the diagnostic. Can be:
+                                           //   - source.diagnostic.category.deprecation
+                                           //   - source.diagnostic.category.no_usage
 }
 ```
 

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

@@ -193,6 +193,11 @@ enum class DiagnosticSeverityKind {
   Error
 };
 
+enum class DiagnosticCategory {
+  Deprecation,
+  NoUsage
+};
+
 struct DiagnosticEntryInfoBase {
   struct Fixit {
     unsigned Offset;
@@ -201,12 +206,12 @@ struct DiagnosticEntryInfoBase {
   };
 
   std::string ID;
-  std::string Category;
   std::string Description;
   unsigned Offset = 0;
   unsigned Line = 0;
   unsigned Column = 0;
   std::string Filename;
+  SmallVector<DiagnosticCategory, 1> Categories;
   SmallVector<std::pair<unsigned, unsigned>, 2> Ranges;
   SmallVector<Fixit, 2> Fixits;
   SmallVector<std::string, 1> EducationalNotePaths;

tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp

@@ -101,7 +101,12 @@ void EditorDiagConsumer::handleDiagnostic(SourceManager &SM,
   DiagnosticEntryInfo SKInfo;
 
   SKInfo.ID = DiagnosticEngine::diagnosticIDStringFor(Info.ID).str();
-  SKInfo.Category = Info.Category.str();
+
+  if (Info.Category == "deprecation") {
+    SKInfo.Categories.push_back(DiagnosticCategory::Deprecation);
+  } else if (Info.Category == "no-usage") {
+    SKInfo.Categories.push_back(DiagnosticCategory::NoUsage);
+  }
 
   // Actually substitute the diagnostic arguments into the diagnostic text.
   llvm::SmallString<256> Text;

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

@@ -2827,8 +2827,20 @@ static void fillDictionaryForDiagnosticInfoBase(
   if (!Info.ID.empty())
     Elem.set(KeyID, Info.ID);
 
-  if (!Info.Category.empty())
-    Elem.set(KeyCategory, Info.Category);
+  if (!Info.Categories.empty()) {
+    SmallVector<sourcekitd_uid_t, 1> CategoryUIDs;
+    for (auto C : Info.Categories) {
+      switch (C) {
+      case DiagnosticCategory::Deprecation:
+        CategoryUIDs.push_back(UIDKindDiagDeprecation);
+        break;
+      case DiagnosticCategory::NoUsage:
+        CategoryUIDs.push_back(UIDKindDiagNoUsage);
+        break;
+      }
+    }
+    Elem.set(KeyCategories, CategoryUIDs);
+  }
 
   Elem.set(KeyDescription, Info.Description);
   if (Info.Line != 0) {

utils/gyb_sourcekit_support/UIDs.py

@@ -155,6 +155,7 @@ def __init__(self, internal_name, external_name):
     KEY('ArgIndex', 'key.argindex'),
     KEY('Text', 'key.text'),
     KEY('Category', 'key.category'),
+    KEY('Categories', 'key.categories'),
     KEY('IsFunctionLike', 'key.is_function_like'),
     KEY('IsNonProtocolType', 'key.is_non_protocol_type'),
     KEY('RefactorActions', 'key.refactor_actions'),
@@ -417,6 +418,8 @@ def __init__(self, internal_name, external_name):
     KIND('DiagNote', 'source.diagnostic.severity.note'),
     KIND('DiagWarning', 'source.diagnostic.severity.warning'),
     KIND('DiagError', 'source.diagnostic.severity.error'),
+    KIND('DiagDeprecation', 'source.diagnostic.category.deprecation'),
+    KIND('DiagNoUsage', 'source.diagnostic.category.no_usage'),
     KIND('CodeCompletionEverything', 'source.codecompletion.everything'),
     KIND('CodeCompletionModule', 'source.codecompletion.module'),
     KIND('CodeCompletionKeyword', 'source.codecompletion.keyword'),