[clang-doc] add a mustache backend init implementation

Author: PeterChou1

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

@@ -54,6 +54,7 @@ class MustacheTemplateFile : public Template {
     std::unique_ptr<llvm::MemoryBuffer> Buffer = std::move(BufferOrError.get());
     llvm::StringRef FileContent = Buffer->getBuffer();
     registerPartial(Name, FileContent);
+    return llvm::Error::success();
   }
 
   MustacheTemplateFile(StringRef TemplateStr) : Template(TemplateStr) {}
@@ -72,6 +73,7 @@ setupTemplateFiles(const clang::doc::ClangDocContext &CDCtx) {
     return llvm::createFileError("cannot open file", EC);
   }
   NamespaceTemplate = std::move(Template.get());
+  return llvm::Error::success();
 }
 
 llvm::Error 
@@ -118,6 +120,7 @@ MustacheHTMLGenerator::generateDocs(llvm::StringRef RootDir,
       }
     }
   }
+  return llvm::Error::success();
 }
 
 Value extractValue(const Location &L, 
@@ -130,6 +133,8 @@ Value extractValue(const Location &L,
   SmallString<128> FileURL(*RepositoryUrl);
   llvm::sys::path::append(FileURL, llvm::sys::path::Style::posix, L.Filename);
   Obj.insert({"FileURL", FileURL});
+  
+  return Obj;
 }
 
 Value extractValue(const Reference &I, StringRef CurrentDirectory) {
@@ -280,29 +285,39 @@ Value extractValue(const NamespaceInfo &I, const ClangDocContext &CDCtx) {
   Value ArrNamespace = Array();
   for (const Reference& Child : I.Children.Namespaces)
     ArrNamespace.getAsArray()->emplace_back(extractValue(Child, BasePath));
-  NamespaceValue.insert({"Namespace", ArrNamespace});
+  
+  if (!ArrNamespace.getAsArray()->empty())
+    NamespaceValue.insert({"Namespace", Object{{"Links", ArrNamespace}}});
 
   Value ArrRecord = Array();
   for (const Reference& Child : I.Children.Records)
     ArrRecord.getAsArray()->emplace_back(extractValue(Child, BasePath));
-  NamespaceValue.insert({"Record", ArrRecord});
+  
+  if (!ArrRecord.getAsArray()->empty())
+    NamespaceValue.insert({"Record", Object{{"Links", ArrRecord}}});
 
   Value ArrFunction = Array();
   for (const FunctionInfo& Child : I.Children.Functions)
     ArrFunction.getAsArray()->emplace_back(extractValue(Child, BasePath,
                                                         CDCtx));
-  NamespaceValue.insert({"Function", ArrRecord});
+  if (!ArrFunction.getAsArray()->empty())
+    NamespaceValue.insert({"Function", Object{{"Obj", ArrFunction}}});
 
   Value ArrEnum = Array();
   for (const EnumInfo& Child : I.Children.Enums)
     ArrEnum.getAsArray()->emplace_back(extractValue(Child, CDCtx));
-  NamespaceValue.insert({"Enums", ArrEnum });
+  
+  if (!ArrEnum.getAsArray()->empty())
+    NamespaceValue.insert({"Enums", Object{{"Obj", ArrEnum }}});
 
   Value ArrTypedefs = Array();
   for (const TypedefInfo& Child : I.Children.Typedefs) 
     ArrTypedefs.getAsArray()->emplace_back(extractValue(Child));
-  NamespaceValue.insert({"Typedefs", ArrTypedefs });
 
+  if (!ArrTypedefs.getAsArray()->empty())
+    NamespaceValue.insert({"Typedefs", Object{{"Obj", ArrTypedefs }}});
+  
+  return NamespaceValue;
 }
 
 
@@ -313,6 +328,7 @@ MustacheHTMLGenerator::generateDocForInfo(Info *I, llvm::raw_ostream &OS,
   switch (I->IT) {
   case InfoType::IT_namespace: {
     Value V = extractValue(*static_cast<clang::doc::NamespaceInfo *>(I), CDCtx);
+    llvm::outs() << V << "\n";
     OS << NamespaceTemplate->render(V);
     break;
   }
@@ -332,18 +348,18 @@ MustacheHTMLGenerator::generateDocForInfo(Info *I, llvm::raw_ostream &OS,
 }
 
 llvm::Error MustacheHTMLGenerator::createResources(ClangDocContext &CDCtx) {
-  
+  return llvm::Error::success();
 }
 
-const char *MustacheHTMLGenerator::Format = "mustache";
+const char *MustacheHTMLGenerator::Format = "mhtml";
 
 
 static GeneratorRegistry::Add<MustacheHTMLGenerator> MHTML(MustacheHTMLGenerator::Format,
                                                   "Generator for mustache HTML output.");
 
 // This anchor is used to force the linker to link in the generated object
 // file and thus register the generator.
-volatile int HTMLGeneratorAnchorSource = 0;
+volatile int MHTMLGeneratorAnchorSource = 0;
 
 } // namespace doc
 } // namespace clang

clang-tools-extra/clang-doc/assets/template.mustache

@@ -3,21 +3,50 @@
     See https://llvm.org/LICENSE.txt for license information.
     SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
     
-    This file defines the template
+    This file defines the template for generating Namespaces
 }}
 <!DOCTYPE html>
 <html lang="en-US">
     <head>
         <meta charset="utf-8"/>
         <title>{{NamespaceTitle}}</title>
     </head>
+    <h1>{{NamespaceTitle}}</h1>
     {{#NamespaceComments}}
-    <p>Namespace Comment Present!</p>
+    <p>Namespace Comment</p>
     {{/NamespaceComments}}
     {{#Namespace}}
-    <p>Namespace Present!</p>
+    <h2 id="Namespace">Namespace</h2>
+    <ul>
+        {{#Links}}
+        <li>
+            <a href="{{Link}}">{{Name}}</a>
+        </li>
+        {{/Links}}
+    </ul>
     {{/Namespace}}
     {{#Record}}
-    <p>Record Present!</p>
+    <h2 id="Class">Class</h2>
+    <ul>
+        {{#Links}}
+        <li>
+            <a href="{{Link}}">{{Name}}</a>
+        </li>
+        {{/Links}}
+    </ul>
     {{/Record}}
+    {{#Function}}
+    <h2 id="Function">Function</h2>
+    <div>
+        {{#Obj}}
+        {{/Obj}}
+    </div>
+    {{/Function}}
+    {{#Enums}}
+    <h2 id="Enums">Enums</h2>
+    <div>
+        {{#Obj}}
+        {{/Obj}}
+    </div>
+    {{/Enums}}
 </html>

clang-tools-extra/clang-doc/tool/ClangDocMain.cpp

@@ -103,6 +103,7 @@ enum OutputFormatTy {
   md,
   yaml,
   html,
+  mhtml
 };
 
 static llvm::cl::opt<OutputFormatTy>
@@ -112,7 +113,9 @@ static llvm::cl::opt<OutputFormatTy>
                                 clEnumValN(OutputFormatTy::md, "md",
                                            "Documentation in MD format."),
                                 clEnumValN(OutputFormatTy::html, "html",
-                                           "Documentation in HTML format.")),
+                                           "Documentation in HTML format."),
+                                clEnumValN(OutputFormatTy::mhtml, "mhtml",
+                                           "Documentation in mHTML format")),
                llvm::cl::init(OutputFormatTy::yaml),
                llvm::cl::cat(ClangDocCategory));
 
@@ -124,6 +127,8 @@ std::string getFormatString() {
     return "md";
   case OutputFormatTy::html:
     return "html";
+  case OutputFormatTy::mhtml:
+    return "mhtml";
   }
   llvm_unreachable("Unknown OutputFormatTy");
 }
@@ -227,6 +232,8 @@ llvm::Error getMustacheHtmlFiles(const char *Argv0,
   llvm::sys::path::native(AssetsPath, MustacheTemplate);
   llvm::sys::path::append(MustacheTemplate, "template.mustache");
   CDCtx.MustacheTemplates.insert({"template", MustacheTemplate.c_str()});
+  
+  return llvm::Error::success();
 }
 
 /// Make the output of clang-doc deterministic by sorting the children of

clang-tools-extra/test/clang-doc/Inputs/basic-project/include/Shape.h

@@ -26,5 +26,3 @@ class Shape {
      */
     virtual double perimeter() const = 0;
 };
-
-