diff --git a/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp b/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp index 8e8f7053a8f87..41fbe87a713d9 100644 --- a/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp +++ b/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp @@ -18,20 +18,14 @@ //===----------------------------------------------------------------------===// #include "BitcodeReader.h" -#include "BitcodeWriter.h" #include "ClangDoc.h" #include "Generators.h" #include "Representation.h" -#include "clang/AST/AST.h" -#include "clang/AST/Decl.h" -#include "clang/ASTMatchers/ASTMatchFinder.h" +#include "support/Utils.h" #include "clang/ASTMatchers/ASTMatchersInternal.h" -#include "clang/Driver/Options.h" -#include "clang/Frontend/FrontendActions.h" #include "clang/Tooling/AllTUsExecution.h" #include "clang/Tooling/CommonOptionsParser.h" #include "clang/Tooling/Execution.h" -#include "clang/Tooling/Tooling.h" #include "llvm/ADT/APFloat.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/Error.h" @@ -110,22 +104,19 @@ static llvm::cl::opt RepositoryCodeLinePrefix( llvm::cl::desc("Prefix of line code for repository."), llvm::cl::cat(ClangDocCategory)); -enum OutputFormatTy { - md, - yaml, - html, -}; - -static llvm::cl::opt - FormatEnum("format", llvm::cl::desc("Format for outputted docs."), - llvm::cl::values(clEnumValN(OutputFormatTy::yaml, "yaml", - "Documentation in YAML format."), - clEnumValN(OutputFormatTy::md, "md", - "Documentation in MD format."), - clEnumValN(OutputFormatTy::html, "html", - "Documentation in HTML format.")), - llvm::cl::init(OutputFormatTy::yaml), - llvm::cl::cat(ClangDocCategory)); +enum OutputFormatTy { md, yaml, html, mustache }; + +static llvm::cl::opt FormatEnum( + "format", llvm::cl::desc("Format for outputted docs."), + llvm::cl::values(clEnumValN(OutputFormatTy::yaml, "yaml", + "Documentation in YAML format."), + clEnumValN(OutputFormatTy::md, "md", + "Documentation in MD format."), + clEnumValN(OutputFormatTy::html, "html", + "Documentation in HTML format."), + clEnumValN(OutputFormatTy::mustache, "mustache", + "Documentation in mustache HTML format")), + llvm::cl::init(OutputFormatTy::yaml), llvm::cl::cat(ClangDocCategory)); static std::string getFormatString() { switch (FormatEnum) { @@ -135,6 +126,8 @@ static std::string getFormatString() { return "md"; case OutputFormatTy::html: return "html"; + case OutputFormatTy::mustache: + return "mustache"; } llvm_unreachable("Unknown OutputFormatTy"); } @@ -178,13 +171,9 @@ static llvm::Error getDefaultAssetFiles(const char *Argv0, llvm::SmallString<128> AssetsPath; AssetsPath = llvm::sys::path::parent_path(NativeClangDocPath); llvm::sys::path::append(AssetsPath, "..", "share", "clang-doc"); - llvm::SmallString<128> DefaultStylesheet; - llvm::sys::path::native(AssetsPath, DefaultStylesheet); - llvm::sys::path::append(DefaultStylesheet, - "clang-doc-default-stylesheet.css"); - llvm::SmallString<128> IndexJS; - llvm::sys::path::native(AssetsPath, IndexJS); - llvm::sys::path::append(IndexJS, "index.js"); + llvm::SmallString<128> DefaultStylesheet = + appendPathNative(AssetsPath, "clang-doc-default-stylesheet.css"); + llvm::SmallString<128> IndexJS = appendPathNative(AssetsPath, "index.js"); if (!llvm::sys::fs::is_regular_file(IndexJS)) return llvm::createStringError(llvm::inconvertibleErrorCode(), @@ -215,6 +204,30 @@ static llvm::Error getHtmlAssetFiles(const char *Argv0, return getDefaultAssetFiles(Argv0, CDCtx); } +static llvm::Error getMustacheHtmlFiles(const char *Argv0, + clang::doc::ClangDocContext &CDCtx) { + bool IsDir = llvm::sys::fs::is_directory(UserAssetPath); + if (!UserAssetPath.empty() && !IsDir) + llvm::outs() << "Asset path supply is not a directory: " << UserAssetPath + << " falling back to default\n"; + if (IsDir) { + getMustacheHtmlFiles(UserAssetPath, CDCtx); + return llvm::Error::success(); + } + void *MainAddr = (void *)(intptr_t)getExecutablePath; + std::string ClangDocPath = getExecutablePath(Argv0, MainAddr); + llvm::SmallString<128> NativeClangDocPath; + llvm::sys::path::native(ClangDocPath, NativeClangDocPath); + + llvm::SmallString<128> AssetsPath; + AssetsPath = llvm::sys::path::parent_path(NativeClangDocPath); + llvm::sys::path::append(AssetsPath, "..", "share", "clang-doc"); + + getMustacheHtmlFiles(AssetsPath, CDCtx); + + return llvm::Error::success(); +} + /// Make the output of clang-doc deterministic by sorting the children of /// namespaces and records. static void @@ -290,6 +303,13 @@ Example usage for a project using a compile commands database: } } + if (Format == "mustache") { + if (auto Err = getMustacheHtmlFiles(argv[0], CDCtx)) { + llvm::errs() << toString(std::move(Err)) << "\n"; + return 1; + } + } + // Mapping phase llvm::outs() << "Mapping decls...\n"; auto Err = diff --git a/clang-tools-extra/test/clang-doc/basic-project.mustache.test b/clang-tools-extra/test/clang-doc/basic-project.mustache.test new file mode 100644 index 0000000000000..7bfdd4bb1dd3f --- /dev/null +++ b/clang-tools-extra/test/clang-doc/basic-project.mustache.test @@ -0,0 +1,481 @@ +// RUN: rm -rf %t && mkdir -p %t/docs %t/build +// RUN: sed 's|$test_dir|%/S|g' %S/Inputs/basic-project/database_template.json > %t/build/compile_commands.json + +// RUN: clang-doc --format=mustache --output=%t/docs --executor=all-TUs %t/build/compile_commands.json +// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Shape.html -check-prefix=HTML-SHAPE +// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Calculator.html -check-prefix=HTML-CALC +// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Rectangle.html -check-prefix=HTML-RECTANGLE +// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Circle.html -check-prefix=HTML-CIRCLE + +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: Shape +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE: +HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE: +HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:

class Shape

+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:

Public Methods

+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:             
+HTML-SHAPE: double area ()
+HTML-SHAPE:             
+HTML-SHAPE:         
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:             
+HTML-SHAPE: double perimeter ()
+HTML-SHAPE:             
+HTML-SHAPE:         
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:             
+HTML-SHAPE: void ~Shape ()
+HTML-SHAPE:             
+HTML-SHAPE:         
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE:
+HTML-SHAPE: +HTML-SHAPE: + + +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: Calculator +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC: +HTML-CALC:
+HTML-CALC:
+HTML-CALC: +HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:

class Calculator

+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:

Public Members

+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC: int public_val
+HTML-CALC:                         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC: const int static_val
+HTML-CALC:                         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:

Public Methods

+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:             
+HTML-CALC: int add (int a, int b)
+HTML-CALC:             
+HTML-CALC:         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:             
+HTML-CALC: int subtract (int a, int b)
+HTML-CALC:             
+HTML-CALC:         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:             
+HTML-CALC: int multiply (int a, int b)
+HTML-CALC:             
+HTML-CALC:         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:             
+HTML-CALC: double divide (int a, int b)
+HTML-CALC:             
+HTML-CALC:         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:             
+HTML-CALC: int mod (int a, int b)
+HTML-CALC:             
+HTML-CALC:         
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC:
+HTML-CALC: +HTML-CALC: + + +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: Rectangle +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE: +HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE: +HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:

class Rectangle

+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:

Protected Members

+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE: double width_
+HTML-RECTANGLE:                         
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE: double height_
+HTML-RECTANGLE:                         
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:

Public Methods

+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:             
+HTML-RECTANGLE: void Rectangle (double width, double height)
+HTML-RECTANGLE:             
+HTML-RECTANGLE:         
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:             
+HTML-RECTANGLE: double area ()
+HTML-RECTANGLE:             
+HTML-RECTANGLE:         
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:             
+HTML-RECTANGLE: double perimeter ()
+HTML-RECTANGLE:             
+HTML-RECTANGLE:         
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE:
+HTML-RECTANGLE: +HTML-RECTANGLE: + + +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: Circle +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE: +HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE: +HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:

class Circle

+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:

Protected Members

+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE: double radius_
+HTML-CIRCLE:                         
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:

Public Methods

+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:             
+HTML-CIRCLE: void Circle (double radius)
+HTML-CIRCLE:             
+HTML-CIRCLE:         
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:             
+HTML-CIRCLE: double area ()
+HTML-CIRCLE:             
+HTML-CIRCLE:         
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:             
+HTML-CIRCLE: double perimeter ()
+HTML-CIRCLE:             
+HTML-CIRCLE:         
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE:
+HTML-CIRCLE: +HTML-CIRCLE: +