[clang-doc] Fix html entities in rendered text

[DiegoAstiazaran]

Summary

Replace &, <, >, ", and ' with their corresponding html entities in text rendered by HTML generator.

[Eugene.Zelenko]

clang-tools-extra/clang-doc/HTMLGenerator.cpp

181 ↗

(On Diff #211166)

There is printHTMLEscaped() in ADT/StringExtras.h. May b it could be used or common code moved into other function in ADT/StringExtras.h?

[DiegoAstiazaran]

Use printHTMLEscaped() in ADT/StringExtras.h to write HTML entities.

[juliehockett]

LGTM

clang-tools-extra/trunk/clang-doc/HTMLGenerator.cpp

 //===-- HTMLGenerator.cpp - HTML Generator ----------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "Generators.h"
 #include "Representation.h"
+#include "llvm/ADT/StringExtras.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"
 #include <string>
 
 using namespace llvm;
 
 namespace clang {
case HTMLTag::TAG_A:
     return llvm::SmallString<16>("a");
   }
   llvm_unreachable("Unhandled HTMLTag::TagType");
 }
 
 void TextNode::Render(llvm::raw_ostream &OS, int IndentationLevel) {
   if (Indented)
     OS.indent(IndentationLevel * 2);
-  OS << Text;
+  printHTMLEscaped(Text, OS);
 }
 
 void TagNode::Render(llvm::raw_ostream &OS, int IndentationLevel) {
   OS.indent(IndentationLevel * 2);
   OS << "<" << Tag.ToString();
   for (const auto &A : Attributes)
     OS << " " << A.getKey() << "=\"" << A.getValue() << "\"";
   if (SelfClosing) {

clang-tools-extra/trunk/unittests/clang-doc/HTMLGeneratorTest.cpp

TEST(HTMLGeneratorTest, emitCommentHTML) {
   Extended->Kind = "ParagraphComment";
   Extended->Children.emplace_back(llvm::make_unique<CommentInfo>());
   Extended->Children.back()->Kind = "TextComment";
   Extended->Children.back()->Text = " Extended description that";
   Extended->Children.emplace_back(llvm::make_unique<CommentInfo>());
   Extended->Children.back()->Kind = "TextComment";
   Extended->Children.back()->Text = " continues onto the next line.";
 
+  Top.Children.emplace_back(llvm::make_unique<CommentInfo>());
+  CommentInfo *Entities = Top.Children.back().get();
+  Entities->Kind = "ParagraphComment";
+  Entities->Children.emplace_back(llvm::make_unique<CommentInfo>());
+  Entities->Children.back()->Kind = "TextComment";
+  Entities->Children.back()->Name = "ParagraphComment";
+  Entities->Children.back()->Text =
+      " Comment with html entities: &, <, >, \", \'.";
+
   I.Description.emplace_back(std::move(Top));
 
   auto G = getHTMLGenerator();
   assert(G);
   std::string Buffer;
   llvm::raw_string_ostream Actual(Buffer);
   auto Err = G->generateDocForInfo(&I, Actual);
   assert(!Err);
<div>
   <div>
     <div>
       <p>
          Brief description.
       </p>
       <p>
          Extended description that continues onto the next line.
       </p>
+      <p>
+         Comment with html entities: &amp;, &lt;, &gt;, &quot;, &apos;.
+      </p>
     </div>
   </div>
 </div>
 )raw";
 
   EXPECT_EQ(Expected, Actual.str());
 }
 
 } // namespace doc
 } // namespace clang