Merge pull request #7576 from bitjammer/tag-markup-field

[Markup] Add Tag field

rdar://problem/30563792

Author: bitjammer

include/swift/AST/Comment.h

@@ -39,6 +39,10 @@ class DocComment {
     return Parts;
   }
 
+  ArrayRef<StringRef> getTags() const {
+    return Parts.Tags;
+  }
+
   Optional<const swift::markup::Paragraph *> getBrief() const {
     return Parts.Brief;
   }

include/swift/Markup/AST.h

@@ -26,6 +26,7 @@ class MarkupASTNode;
 class Paragraph;
 class ParamField;
 class ReturnsField;
+class TagField;
 class ThrowsField;
 
 /// The basic structure of a doc comment attached to a Swift
@@ -36,6 +37,7 @@ struct CommentParts {
   ArrayRef<ParamField *> ParamFields;
   Optional<const ReturnsField *> ReturnsField;
   Optional<const ThrowsField *> ThrowsField;
+  ArrayRef<StringRef> Tags;
 
   bool isEmpty() const {
     return !Brief.hasValue() &&

include/swift/Markup/ASTNodes.def

@@ -72,6 +72,7 @@ MARKUP_AST_NODE(PrivateExtension, MarkupASTNode)
   MARKUP_AST_NODE(RequiresField, PrivateExtension)
   MARKUP_AST_NODE(SeeField, PrivateExtension)
   MARKUP_AST_NODE(SinceField, PrivateExtension)
+  MARKUP_AST_NODE(TagField, PrivateExtension)
   MARKUP_AST_NODE(TODOField, PrivateExtension)
   MARKUP_AST_NODE(ThrowsField, PrivateExtension)
   MARKUP_AST_NODE(VersionField, PrivateExtension)

include/swift/Markup/SimpleFields.def

@@ -43,6 +43,7 @@ MARKUP_SIMPLE_FIELD(ThrowsField, throws, Throws)
 MARKUP_SIMPLE_FIELD(RequiresField, requires, Requires)
 MARKUP_SIMPLE_FIELD(SeeField, seealso, See)
 MARKUP_SIMPLE_FIELD(SinceField, since, Since)
+MARKUP_SIMPLE_FIELD(TagField, tag, Tag)
 MARKUP_SIMPLE_FIELD(TODOField, todo, TODO)
 MARKUP_SIMPLE_FIELD(VersionField, version, Version)
 MARKUP_SIMPLE_FIELD(WarningField, warning, Warning)

lib/AST/DocComment.cpp

@@ -22,6 +22,7 @@
 #include "swift/AST/PrettyStackTrace.h"
 #include "swift/AST/RawComment.h"
 #include "swift/Markup/Markup.h"
+#include "llvm/ADT/SetVector.h"
 
 using namespace swift;
 
@@ -214,6 +215,7 @@ bool extractSimpleField(
     SmallVectorImpl<const swift::markup::MarkupASTNode *> &BodyNodes) {
   auto Children = L->getChildren();
   SmallVector<swift::markup::MarkupASTNode *, 8> NormalItems;
+  llvm::SmallSetVector<StringRef, 8> Tags;
   for (auto Child : Children) {
     auto I = dyn_cast<swift::markup::Item>(Child);
     if (!I) {
@@ -261,17 +263,25 @@ bool extractSimpleField(
     ParagraphText->setLiteralContent(Remainder);
     auto Field = swift::markup::createSimpleField(MC, Tag, ItemChildren);
 
-    if (auto RF = dyn_cast<swift::markup::ReturnsField>(Field))
+    if (auto RF = dyn_cast<swift::markup::ReturnsField>(Field)) {
       Parts.ReturnsField = RF;
-    else if (auto TF = dyn_cast<swift::markup::ThrowsField>(Field))
+    } else if (auto TF = dyn_cast<swift::markup::ThrowsField>(Field)) {
       Parts.ThrowsField = TF;
-    else
+    } else if (auto TF = dyn_cast<swift::markup::TagField>(Field)) {
+      llvm::SmallString<64> Scratch;
+      llvm::raw_svector_ostream OS(Scratch);
+      printInlinesUnder(TF, OS);
+      Tags.insert(MC.allocateCopy(OS.str()));
+    } else {
       BodyNodes.push_back(Field);
+    }
   }
 
   if (NormalItems.size() != Children.size())
     L->setChildren(NormalItems);
 
+  Parts.Tags = MC.allocateCopy(Tags.getArrayRef());
+
   return NormalItems.size() == 0;
 }