Skip to content

[clang-doc] fix CSS, JS paths for HTML Mustache generation #160360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2025
Merged

[clang-doc] fix CSS, JS paths for HTML Mustache generation #160360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions clang-tools-extra/clang-doc/HTMLMustacheGenerator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,11 +274,12 @@ Error MustacheHTMLGenerator::generateDocForInfo(Info *I, raw_ostream &OS,
}

Error MustacheHTMLGenerator::createResources(ClangDocContext &CDCtx) {
std::string ResourcePath(CDCtx.OutDirectory + "/html");
for (const auto &FilePath : CDCtx.UserStylesheets)
if (Error Err = copyFile(FilePath, CDCtx.OutDirectory))
if (Error Err = copyFile(FilePath, ResourcePath))
return Err;
for (const auto &FilePath : CDCtx.JsScripts)
if (Error Err = copyFile(FilePath, CDCtx.OutDirectory))
if (Error Err = copyFile(FilePath, ResourcePath))
return Err;
return Error::success();
}
Expand Down
33 changes: 0 additions & 33 deletions clang-tools-extra/unittests/clang-doc/HTMLMustacheGeneratorTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@
#include "config.h"
#include "support/Utils.h"
#include "clang/Basic/Version.h"
#include "llvm/Support/Path.h"
#include "llvm/Testing/Support/Error.h"
#include "llvm/Testing/Support/SupportHelpers.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

Expand Down Expand Up @@ -48,41 +46,10 @@ getClangDocContext(std::vector<std::string> UserStylesheets = {},
return CDCtx;
}

static void verifyFileContents(const Twine &Path, StringRef Contents) {
auto Buffer = MemoryBuffer::getFile(Path);
ASSERT_TRUE((bool)Buffer);
StringRef Data = Buffer.get()->getBuffer();
ASSERT_EQ(Data, Contents);
}

TEST(HTMLMustacheGeneratorTest, createResources) {
auto G = getHTMLMustacheGenerator();
ASSERT_THAT(G, NotNull()) << "Could not find HTMLMustacheGenerator";
ClangDocContext CDCtx = getClangDocContext();
EXPECT_THAT_ERROR(G->createResources(CDCtx), Failed())
<< "Empty UserStylesheets or JsScripts should fail!";

unittest::TempDir RootTestDirectory("createResourcesTest", /*Unique=*/true);
CDCtx.OutDirectory = RootTestDirectory.path();

unittest::TempFile CSS("clang-doc-mustache", "css", "CSS");
unittest::TempFile JS("mustache", "js", "JavaScript");

CDCtx.UserStylesheets[0] = CSS.path();
CDCtx.JsScripts[0] = JS.path();

EXPECT_THAT_ERROR(G->createResources(CDCtx), Succeeded())
<< "Failed to create resources with valid UserStylesheets and JsScripts";
{
SmallString<256> PathBuf;
llvm::sys::path::append(PathBuf, RootTestDirectory.path(),
"clang-doc-mustache.css");
verifyFileContents(PathBuf, "CSS");
}

{
SmallString<256> PathBuf;
llvm::sys::path::append(PathBuf, RootTestDirectory.path(), "mustache.js");
verifyFileContents(PathBuf, "JavaScript");
}
}