From f14ad74478494cbd9d23af841d6f6b2808afda71 Mon Sep 17 00:00:00 2001 From: PeterChou1 Date: Thu, 27 Jun 2024 16:22:01 -0400 Subject: [PATCH] Reapply [clang-doc] Add --asset option to clang-doc (#96358) Reapply https://github.com/llvm/llvm-project/pull/94717 Adds a new option --asset which allows users to specified the asset folder for the html output of clang-doc. This patch adds a better test for --asset option + fixes bug where clang-doc assumes that user supplied js file is assume to be index.js --- clang-tools-extra/clang-doc/HTMLGenerator.cpp | 13 ++- .../clang-doc/Representation.cpp | 6 +- clang-tools-extra/clang-doc/Representation.h | 5 +- .../clang-doc/tool/ClangDocMain.cpp | 103 ++++++++++++++---- .../clang-doc/Inputs/test-assets/test.css | 3 + .../test/clang-doc/Inputs/test-assets/test.js | 1 + clang-tools-extra/test/clang-doc/assets.cpp | 22 ++++ .../test/clang-doc/basic-project.test | 10 +- .../unittests/clang-doc/HTMLGeneratorTest.cpp | 7 +- 9 files changed, 133 insertions(+), 37 deletions(-) create mode 100644 clang-tools-extra/test/clang-doc/Inputs/test-assets/test.css create mode 100644 clang-tools-extra/test/clang-doc/Inputs/test-assets/test.js create mode 100644 clang-tools-extra/test/clang-doc/assets.cpp diff --git a/clang-tools-extra/clang-doc/HTMLGenerator.cpp b/clang-tools-extra/clang-doc/HTMLGenerator.cpp index c0faf5f7e8fd..43277ecd7710 100644 --- a/clang-tools-extra/clang-doc/HTMLGenerator.cpp +++ b/clang-tools-extra/clang-doc/HTMLGenerator.cpp @@ -289,9 +289,18 @@ genStylesheetsHTML(StringRef InfoPath, const ClangDocContext &CDCtx) { static std::vector> genJsScriptsHTML(StringRef InfoPath, const ClangDocContext &CDCtx) { std::vector> Out; + + // index_json.js is part of every generated HTML file + SmallString<128> IndexJSONPath = computeRelativePath("", InfoPath); + auto IndexJSONNode = std::make_unique(HTMLTag::TAG_SCRIPT); + llvm::sys::path::append(IndexJSONPath, "index_json.js"); + llvm::sys::path::native(IndexJSONPath, llvm::sys::path::Style::posix); + IndexJSONNode->Attributes.emplace_back("src", std::string(IndexJSONPath)); + Out.emplace_back(std::move(IndexJSONNode)); + for (const auto &FilePath : CDCtx.JsScripts) { - auto ScriptNode = std::make_unique(HTMLTag::TAG_SCRIPT); SmallString<128> ScriptPath = computeRelativePath("", InfoPath); + auto ScriptNode = std::make_unique(HTMLTag::TAG_SCRIPT); llvm::sys::path::append(ScriptPath, llvm::sys::path::filename(FilePath)); // Paths in HTML must be in posix-style llvm::sys::path::native(ScriptPath, llvm::sys::path::Style::posix); @@ -1069,7 +1078,7 @@ llvm::Error HTMLGenerator::createResources(ClangDocContext &CDCtx) { if (Err) return Err; } - for (const auto &FilePath : CDCtx.FilesToCopy) { + for (const auto &FilePath : CDCtx.JsScripts) { Err = CopyFile(FilePath, CDCtx.OutDirectory); if (Err) return Err; diff --git a/clang-tools-extra/clang-doc/Representation.cpp b/clang-tools-extra/clang-doc/Representation.cpp index 2afff2929cf7..d08afbb96218 100644 --- a/clang-tools-extra/clang-doc/Representation.cpp +++ b/clang-tools-extra/clang-doc/Representation.cpp @@ -368,11 +368,9 @@ ClangDocContext::ClangDocContext(tooling::ExecutionContext *ECtx, StringRef ProjectName, bool PublicOnly, StringRef OutDirectory, StringRef SourceRoot, StringRef RepositoryUrl, - std::vector UserStylesheets, - std::vector JsScripts) + std::vector UserStylesheets) : ECtx(ECtx), ProjectName(ProjectName), PublicOnly(PublicOnly), - OutDirectory(OutDirectory), UserStylesheets(UserStylesheets), - JsScripts(JsScripts) { + OutDirectory(OutDirectory), UserStylesheets(UserStylesheets) { llvm::SmallString<128> SourceRootDir(SourceRoot); if (SourceRoot.empty()) // If no SourceRoot was provided the current path is used as the default diff --git a/clang-tools-extra/clang-doc/Representation.h b/clang-tools-extra/clang-doc/Representation.h index a6b144eb7fa2..d70c279f7a2b 100644 --- a/clang-tools-extra/clang-doc/Representation.h +++ b/clang-tools-extra/clang-doc/Representation.h @@ -482,8 +482,7 @@ struct ClangDocContext { ClangDocContext(tooling::ExecutionContext *ECtx, StringRef ProjectName, bool PublicOnly, StringRef OutDirectory, StringRef SourceRoot, StringRef RepositoryUrl, - std::vector UserStylesheets, - std::vector JsScripts); + std::vector UserStylesheets); tooling::ExecutionContext *ECtx; std::string ProjectName; // Name of project clang-doc is documenting. bool PublicOnly; // Indicates if only public declarations are documented. @@ -498,8 +497,6 @@ struct ClangDocContext { std::vector UserStylesheets; // JavaScript files that will be imported in allHTML file. std::vector JsScripts; - // Other files that should be copied to OutDirectory, besides UserStylesheets. - std::vector FilesToCopy; Index Idx; }; diff --git a/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp b/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp index 1feb6d3b74d7..6198a6e0cdcc 100644 --- a/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp +++ b/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp @@ -81,6 +81,12 @@ static llvm::cl::list UserStylesheets( llvm::cl::desc("CSS stylesheets to extend the default styles."), llvm::cl::cat(ClangDocCategory)); +static llvm::cl::opt UserAssetPath( + "asset", + llvm::cl::desc("User supplied asset path to " + "override the default css and js files for html output"), + llvm::cl::cat(ClangDocCategory)); + static llvm::cl::opt SourceRoot("source-root", llvm::cl::desc(R"( Directory where processed files are stored. Links to definition locations will only be @@ -127,16 +133,84 @@ std::string getFormatString() { // GetMainExecutable (since some platforms don't support taking the // address of main, and some platforms can't implement GetMainExecutable // without being given the address of a function in the main executable). -std::string GetExecutablePath(const char *Argv0, void *MainAddr) { +std::string getExecutablePath(const char *Argv0, void *MainAddr) { return llvm::sys::fs::getMainExecutable(Argv0, MainAddr); } +llvm::Error getAssetFiles(clang::doc::ClangDocContext &CDCtx) { + using DirIt = llvm::sys::fs::directory_iterator; + std::error_code FileErr; + llvm::SmallString<128> FilePath(UserAssetPath); + for (DirIt DirStart = DirIt(UserAssetPath, FileErr), + DirEnd; + !FileErr && DirStart != DirEnd; DirStart.increment(FileErr)) { + FilePath = DirStart->path(); + if (llvm::sys::fs::is_regular_file(FilePath)) { + if (llvm::sys::path::extension(FilePath) == ".css") + CDCtx.UserStylesheets.insert(CDCtx.UserStylesheets.begin(), + std::string(FilePath)); + else if (llvm::sys::path::extension(FilePath) == ".js") + CDCtx.JsScripts.emplace_back(FilePath.str()); + } + } + if (FileErr) + return llvm::createFileError(FilePath, FileErr); + return llvm::Error::success(); +} + +llvm::Error getDefaultAssetFiles(const char *Argv0, + clang::doc::ClangDocContext &CDCtx) { + 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"); + 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"); + + if (!llvm::sys::fs::is_regular_file(IndexJS)) + return llvm::createStringError(llvm::inconvertibleErrorCode(), + "default index.js file missing at " + + IndexJS + "\n"); + + if (!llvm::sys::fs::is_regular_file(DefaultStylesheet)) + return llvm::createStringError( + llvm::inconvertibleErrorCode(), + "default clang-doc-default-stylesheet.css file missing at " + + DefaultStylesheet + "\n"); + + CDCtx.UserStylesheets.insert(CDCtx.UserStylesheets.begin(), + std::string(DefaultStylesheet)); + CDCtx.JsScripts.emplace_back(IndexJS.str()); + + return llvm::Error::success(); +} + +llvm::Error getHtmlAssetFiles(const char *Argv0, + clang::doc::ClangDocContext &CDCtx) { + if (!UserAssetPath.empty() && + !llvm::sys::fs::is_directory(std::string(UserAssetPath))) + llvm::outs() << "Asset path supply is not a directory: " << UserAssetPath + << " falling back to default\n"; + if (llvm::sys::fs::is_directory(std::string(UserAssetPath))) + return getAssetFiles(CDCtx); + return getDefaultAssetFiles(Argv0, CDCtx); +} + int main(int argc, const char **argv) { llvm::sys::PrintStackTraceOnErrorSignal(argv[0]); std::error_code OK; const char *Overview = - R"(Generates documentation from source code and comments. + R"(Generates documentation from source code and comments. Example usage for files without flags (default): @@ -178,27 +252,14 @@ Example usage for a project using a compile commands database: OutDirectory, SourceRoot, RepositoryUrl, - {UserStylesheets.begin(), UserStylesheets.end()}, - {"index.js", "index_json.js"}}; + {UserStylesheets.begin(), UserStylesheets.end()} + }; if (Format == "html") { - void *MainAddr = (void *)(intptr_t)GetExecutablePath; - std::string ClangDocPath = GetExecutablePath(argv[0], 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"); - 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"); - CDCtx.UserStylesheets.insert(CDCtx.UserStylesheets.begin(), - std::string(DefaultStylesheet)); - CDCtx.FilesToCopy.emplace_back(IndexJS.str()); + if (auto Err = getHtmlAssetFiles(argv[0], CDCtx)) { + llvm::errs() << toString(std::move(Err)) << "\n"; + return 1; + } } // Mapping phase diff --git a/clang-tools-extra/test/clang-doc/Inputs/test-assets/test.css b/clang-tools-extra/test/clang-doc/Inputs/test-assets/test.css new file mode 100644 index 000000000000..5c5532659be5 --- /dev/null +++ b/clang-tools-extra/test/clang-doc/Inputs/test-assets/test.css @@ -0,0 +1,3 @@ +body { + padding: 0; +} \ No newline at end of file diff --git a/clang-tools-extra/test/clang-doc/Inputs/test-assets/test.js b/clang-tools-extra/test/clang-doc/Inputs/test-assets/test.js new file mode 100644 index 000000000000..06f320c59b9b --- /dev/null +++ b/clang-tools-extra/test/clang-doc/Inputs/test-assets/test.js @@ -0,0 +1 @@ +console.log("Hello, world!"); \ No newline at end of file diff --git a/clang-tools-extra/test/clang-doc/assets.cpp b/clang-tools-extra/test/clang-doc/assets.cpp new file mode 100644 index 000000000000..d5a2d20e9224 --- /dev/null +++ b/clang-tools-extra/test/clang-doc/assets.cpp @@ -0,0 +1,22 @@ +// RUN: rm -rf %t && mkdir %t +// RUN: clang-doc --format=html --output=%t --asset=%S/Inputs/test-assets --executor=standalone %s +// RUN: FileCheck %s -input-file=%t/index.html -check-prefix=INDEX +// RUN: FileCheck %s -input-file=%t/test.css -check-prefix=CSS +// RUN: FileCheck %s -input-file=%t/test.js -check-prefix=JS + +// INDEX: +// INDEX-NEXT: +// INDEX-NEXT: Index +// INDEX-NEXT: +// INDEX-NEXT: +// INDEX-NEXT: +// INDEX-NEXT:
+// INDEX-NEXT:
+// INDEX-NEXT: +// INDEX-NEXT:
+ +// CSS: body { +// CSS-NEXT: padding: 0; +// CSS-NEXT: } + +// JS: console.log("Hello, world!"); \ No newline at end of file diff --git a/clang-tools-extra/test/clang-doc/basic-project.test b/clang-tools-extra/test/clang-doc/basic-project.test index c97363883761..3118c2049598 100644 --- a/clang-tools-extra/test/clang-doc/basic-project.test +++ b/clang-tools-extra/test/clang-doc/basic-project.test @@ -57,8 +57,8 @@ // HTML-SHAPE-NEXT: // HTML-SHAPE-NEXT: class Shape // HTML-SHAPE-NEXT: -// HTML-SHAPE-NEXT: -// HTML-SHAPE-NEXT: +// HTML-SHAPE-NEXT: +// HTML-SHAPE-NEXT: // HTML-SHAPE-NEXT:
// HTML-SHAPE-NEXT:
// HTML-SHAPE-NEXT: @@ -122,8 +122,8 @@ // HTML-CALC-NEXT: // HTML-CALC-NEXT: class Calculator // HTML-CALC-NEXT: -// HTML-CALC-NEXT: // HTML-CALC-NEXT: +// HTML-CALC-NEXT: // HTML-CALC-NEXT:
// HTML-CALC-NEXT:
// HTML-CALC-NEXT: @@ -200,8 +200,8 @@ // HTML-RECTANGLE-NEXT: // HTML-RECTANGLE-NEXT: class Rectangle // HTML-RECTANGLE-NEXT: -// HTML-RECTANGLE-NEXT: // HTML-RECTANGLE-NEXT: +// HTML-RECTANGLE-NEXT: // HTML-RECTANGLE-NEXT:
// HTML-RECTANGLE-NEXT:
// HTML-RECTANGLE-NEXT: @@ -281,8 +281,8 @@ // HTML-CIRCLE-NEXT: // HTML-CIRCLE-NEXT: class Circle // HTML-CIRCLE-NEXT: -// HTML-CIRCLE-NEXT: // HTML-CIRCLE-NEXT: +// HTML-CIRCLE-NEXT: // HTML-CIRCLE-NEXT:
// HTML-CIRCLE-NEXT:
// HTML-CIRCLE-NEXT: diff --git a/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp b/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp index 9aabb1ed30e4..e4a7340318b9 100644 --- a/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp +++ b/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp @@ -30,7 +30,7 @@ ClangDocContext getClangDocContext(std::vector UserStylesheets = {}, StringRef RepositoryUrl = "") { ClangDocContext CDCtx{ - {}, "test-project", {}, {}, {}, RepositoryUrl, UserStylesheets, {}}; + {}, "test-project", {}, {}, {}, RepositoryUrl, UserStylesheets}; CDCtx.UserStylesheets.insert( CDCtx.UserStylesheets.begin(), "../share/clang/clang-doc-default-stylesheet.css"); @@ -66,6 +66,7 @@ TEST(HTMLGeneratorTest, emitNamespaceHTML) { namespace Namespace +
test-project
@@ -176,6 +177,7 @@ TEST(HTMLGeneratorTest, emitRecordHTML) { class r +
test-project
@@ -290,6 +292,7 @@ TEST(HTMLGeneratorTest, emitFunctionHTML) { +
test-project
@@ -337,6 +340,7 @@ TEST(HTMLGeneratorTest, emitEnumHTML) { +
test-project
@@ -422,6 +426,7 @@ TEST(HTMLGeneratorTest, emitCommentHTML) { +
test-project