review: rename Attribute to InlineAttributes

Author: QuietMisdreavus

include/swift/Markup/AST.h

@@ -589,16 +589,20 @@ class Image final : public InlineContent,
   }
 };
 
-class Attribute final : public InlineContent, private llvm::TrailingObjects<Image, MarkupASTNode *> {
+class InlineAttributes final : public InlineContent, private llvm::TrailingObjects<Image, MarkupASTNode *> {
   friend TrailingObjects;
 
+  // Note that inline attributes are like links, in that there are child inline nodes that are
+  // collectively styled by the attribute text. The child nodes are the text that should be
+  // displayed.
+
   size_t NumChildren;
   StringRef Attributes;
 
-  Attribute(StringRef Attributes, ArrayRef<MarkupASTNode *> Children);
+  InlineAttributes(StringRef Attributes, ArrayRef<MarkupASTNode *> Children);
 
 public:
-  static Attribute *create(MarkupContext &MC, StringRef Attributes, ArrayRef<MarkupASTNode *> Children);
+  static InlineAttributes *create(MarkupContext &MC, StringRef Attributes, ArrayRef<MarkupASTNode *> Children);
 
   StringRef getAttributes() const { return Attributes; }
 
@@ -611,7 +615,7 @@ class Attribute final : public InlineContent, private llvm::TrailingObjects<Imag
   }
 
   static bool classof(const MarkupASTNode *N) {
-    return N->getKind() == ASTNodeKind::Attribute;
+    return N->getKind() == ASTNodeKind::InlineAttributes;
   }
 };
 

include/swift/Markup/ASTNodes.def

@@ -40,8 +40,8 @@ ABSTRACT_MARKUP_AST_NODE(InlineContent, MarkupASTNode)
   MARKUP_AST_NODE(Strong, InlineContent)
   MARKUP_AST_NODE(Link, InlineContent)
   MARKUP_AST_NODE(Image, InlineContent)
-  MARKUP_AST_NODE(Attribute, InlineContent)
-MARKUP_AST_NODE_RANGE(Inline, Text, Attribute)
+  MARKUP_AST_NODE(InlineAttributes, InlineContent)
+MARKUP_AST_NODE_RANGE(Inline, Text, InlineAttributes)
 
 /// Private Markdown Extensions - these should not be implemented in the
 /// underlying cmark parser.

lib/Frontend/PrintingDiagnosticConsumer.cpp

@@ -142,7 +142,7 @@ namespace {
         }
       }
 
-      void visitAttribute(const Attribute *A) {
+      void visitInlineAttributes(const InlineAttributes *A) {
         print("^[");
         for (const auto *Child : A->getChildren())
           visit(Child);

lib/IDE/CommentConversion.cpp

@@ -72,7 +72,7 @@ struct CommentToXMLConverter {
     llvm_unreachable("Can't print a swift::markup::Document as XML directly");
   }
 
-  void printAttribute(const Attribute *A) {
+  void printInlineAttributes(const InlineAttributes *A) {
     OS << "<Attribute attributes=\"";
     appendWithXMLEscaping(OS, A->getAttributes());
     OS << "\">";
@@ -650,7 +650,7 @@ class DoxygenConverter : public MarkupASTVisitor<DoxygenConverter> {
       visit(Child);
   }
 
-  void visitAttribute(const Attribute *A) {
+  void visitInlineAttributes(const InlineAttributes *A) {
     // attributed strings don't have an analogue in Doxygen, so just print out the text
     for (const auto *Child : A->getChildren())
       visit(Child);

lib/Markup/AST.cpp

@@ -157,14 +157,14 @@ Paragraph *Paragraph::create(MarkupContext &MC,
   return new (Mem) Paragraph(Children);
 }
 
-Attribute::Attribute(StringRef Attributes, ArrayRef<MarkupASTNode *> Children) : InlineContent(ASTNodeKind::Attribute), NumChildren(Children.size()), Attributes(Attributes) {
+InlineAttributes::InlineAttributes(StringRef Attributes, ArrayRef<MarkupASTNode *> Children) : InlineContent(ASTNodeKind::InlineAttributes), NumChildren(Children.size()), Attributes(Attributes) {
   std::uninitialized_copy(Children.begin(), Children.end(), getTrailingObjects<MarkupASTNode *>());
 }
 
-Attribute *Attribute::create(MarkupContext &MC, StringRef Attributes, ArrayRef<MarkupASTNode *> Children) {
-  void *Mem = MC.allocate(totalSizeToAlloc<MarkupASTNode *>(Children.size()), alignof(Attribute));
+InlineAttributes *InlineAttributes::create(MarkupContext &MC, StringRef Attributes, ArrayRef<MarkupASTNode *> Children) {
+  void *Mem = MC.allocate(totalSizeToAlloc<MarkupASTNode *>(Children.size()), alignof(InlineAttributes));
   StringRef AttrsCopy = MC.allocateCopy(Attributes);
-  return new (Mem) Attribute(AttrsCopy, Children);
+  return new (Mem) InlineAttributes(AttrsCopy, Children);
 }
 
 HRule *HRule::create(MarkupContext &MC) {
@@ -418,8 +418,8 @@ void swift::markup::dump(const MarkupASTNode *Node, llvm::raw_ostream &OS,
     dumpChildren(Node->getChildren(), OS, indent + 1);
     break;
   }
-  case swift::markup::ASTNodeKind::Attribute: {
-    auto A = cast<Attribute>(Node);
+  case swift::markup::ASTNodeKind::InlineAttributes: {
+    auto A = cast<InlineAttributes>(Node);
     OS << "Attribute:";
     OS << " Attributes=" << A->getAttributes();
     OS << " Children=" << Node->getChildren().size();

lib/Markup/Markup.cpp

@@ -216,13 +216,13 @@ ParseResult<Link> parseLink(MarkupContext &MC, ParseState State) {
   return { Link::create(MC, Destination, Children), ResultState.next() };
 }
 
-ParseResult<Attribute> parseAttribute(MarkupContext &MC, ParseState State) {
+ParseResult<InlineAttributes> parseAttribute(MarkupContext &MC, ParseState State) {
   assert(cmark_node_get_type(State.Node) == CMARK_NODE_ATTRIBUTE && State.Event == CMARK_EVENT_ENTER);
   std::string Attributes(cmark_node_get_attributes(State.Node));
   SmallVector<MarkupASTNode *, 2> Children;
   auto ResultState = parseChildren(MC, State, Children);
   assert(State.Node == ResultState.Node && ResultState.Event == CMARK_EVENT_EXIT);
-  return { Attribute::create(MC, Attributes, Children), ResultState.next() };
+  return { InlineAttributes::create(MC, Attributes, Children), ResultState.next() };
 }
 
 ParseResult<List> parseList(MarkupContext &MC, ParseState State) {