Skip to content

Commit 6d7732b

Browse files
ilovepiPeterChou1
ilovepi
and
PeterChou1
committed
[clang-doc] Implement setupTemplateValue for HTMLMustacheGenerator
This patch implements the business logic for setupTemplateValue, which was split from #133161. The implementation configures the relative path relationships between the various HTML components, and prepares them prior to their use in the generator. Co-authored-by: Peter Chou <[email protected]>
1 parent e215c97 commit 6d7732b

File tree

2 files changed

+73
-5
lines changed

2 files changed

+73
-5
lines changed

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

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,8 +406,26 @@ static json::Value extractValue(const RecordInfo &I,
406406

407407
static Error setupTemplateValue(const ClangDocContext &CDCtx, json::Value &V,
408408
Info *I) {
409-
return createStringError(inconvertibleErrorCode(),
410-
"setupTemplateValue is unimplemented");
409+
V.getAsObject()->insert({"ProjectName", CDCtx.ProjectName});
410+
json::Value StylesheetArr = Array();
411+
auto InfoPath = I->getRelativeFilePath("");
412+
SmallString<128> RelativePath = computeRelativePath("", InfoPath);
413+
for (const auto &FilePath : CDCtx.UserStylesheets) {
414+
SmallString<128> StylesheetPath = RelativePath;
415+
sys::path::append(StylesheetPath, sys::path::filename(FilePath));
416+
sys::path::native(StylesheetPath, sys::path::Style::posix);
417+
StylesheetArr.getAsArray()->emplace_back(StylesheetPath);
418+
}
419+
V.getAsObject()->insert({"Stylesheets", StylesheetArr});
420+
421+
json::Value ScriptArr = Array();
422+
for (auto Script : CDCtx.JsScripts) {
423+
SmallString<128> JsPath = RelativePath;
424+
sys::path::append(JsPath, sys::path::filename(Script));
425+
ScriptArr.getAsArray()->emplace_back(JsPath);
426+
}
427+
V.getAsObject()->insert({"Scripts", ScriptArr});
428+
return Error::success();
411429
}
412430

413431
Error MustacheHTMLGenerator::generateDocForInfo(Info *I, raw_ostream &OS,
@@ -418,6 +436,7 @@ Error MustacheHTMLGenerator::generateDocForInfo(Info *I, raw_ostream &OS,
418436
extractValue(*static_cast<clang::doc::NamespaceInfo *>(I), CDCtx);
419437
if (auto Err = setupTemplateValue(CDCtx, V, I))
420438
return Err;
439+
assert(NamespaceTemplate && "NamespaceTemplate is nullptr.");
421440
NamespaceTemplate->render(V, OS);
422441
break;
423442
}

‎clang-tools-extra/unittests/clang-doc/HTMLMustacheGeneratorTest.cpp

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,57 @@ TEST(HTMLMustacheGeneratorTest, generateDocsForInfo) {
118118
I.Children.Functions.back().Name = "OneFunction";
119119
I.Children.Enums.emplace_back();
120120

121-
EXPECT_THAT_ERROR(G->generateDocForInfo(&I, Actual, CDCtx), Failed());
121+
unittest::TempDir RootTestDirectory("generateDocForInfoTest",
122+
/*Unique=*/true);
123+
CDCtx.OutDirectory = RootTestDirectory.path();
124+
125+
getMustacheHtmlFiles("../../../../../share/clang-doc", CDCtx);
126+
127+
// FIXME: This is a terrible hack, since we can't initialize the templates
128+
// directly. We'll need to update the interfaces so that we can call
129+
// SetupTemplateFiles() from outsize of HTMLMustacheGenerator.cpp
130+
EXPECT_THAT_ERROR(G->generateDocs(RootTestDirectory.path(), {}, CDCtx),
131+
Succeeded())
132+
<< "Failed to generate docs.";
122133

123-
std::string Expected = R"raw()raw";
124-
EXPECT_THAT(Actual.str(), Eq(Expected));
134+
EXPECT_THAT_ERROR(G->generateDocForInfo(&I, Actual, CDCtx), Succeeded());
135+
136+
std::string Expected = R"raw(<!DOCTYPE html>
137+
<html lang="en-US">
138+
<head>
139+
<meta charset="utf-8"/>
140+
<title>namespace Namespace</title>
141+
<link rel="stylesheet" type="text/css" href="../clang-doc-mustache.css"/>
142+
<link rel="stylesheet" type="text/css" href="../"/>
143+
<script src="../mustache-index.js"></script>
144+
<script src="../"></script>
145+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
146+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
147+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/cpp.min.js"></script>
148+
</head>
149+
<body>
150+
<nav class="navbar">
151+
Navbar
152+
</nav>
153+
<main>
154+
<div class="container">
155+
<div class="sidebar">
156+
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
157+
sed do eiusmod tempor incididunt ut labore et dolore magna
158+
aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
159+
laboris nisi ut aliquip ex ea commodo consequat.
160+
Duis aute irure dolor in reprehenderit in voluptate velit esse
161+
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
162+
cupidatat non proident, sunt in culpa qui officia deserunt mollit
163+
anim id est laborum
164+
</div>
165+
<div class="resizer" id="resizer"></div>
166+
<div class="content">
167+
Content
168+
</div>
169+
</div>
170+
</main>
171+
</body>
172+
</html>)raw";
173+
EXPECT_EQ(Actual.str(), Expected);
125174
}

0 commit comments

Comments
 (0)