This is an archive of the discontinued LLVM Phabricator instance.

[clang-format] Fix style of css file paths
ClosedPublic

Authored by DiegoAstiazaran on Jul 25 2019, 4:48 PM.

Download Raw Diff

Details

Reviewers

juliehockett
jakehehrlich

Commits

rGd6cdd98a25b8: [clang-format] Fix style of css file paths
rCTE367137: [clang-format] Fix style of css file paths
rL367137: [clang-format] Fix style of css file paths

Summary

CSS files included in HTML should have a path in posix style, it should not be different for Windows.

Diff Detail

Repository: rL LLVM

Event Timeline

DiegoAstiazaran created this revision.Jul 25 2019, 4:48 PM

LGTM after adding a comment to explain

clang-tools-extra/clang-doc/HTMLGenerator.cpp
234 ↗	(On Diff #211858)	Comment here why you're explicitly using posix (i.e. HTML uses posix-style paths)

This revision is now accepted and ready to land.Jul 26 2019, 9:34 AM

Add comment.

Closed by commit rL367137: [clang-format] Fix style of css file paths (authored by DiegoAstiazaran). · Explain WhyJul 26 2019, 11:04 AM

This revision was automatically updated to reflect the committed changes.

Herald added a project: Restricted Project. · View Herald TranscriptJul 26 2019, 11:04 AM

Herald added a subscriber: llvm-commits. · View Herald Transcript

Revision Contents

Path

Size

clang-tools-extra/

trunk/

clang-doc/

HTMLGenerator.cpp

2 lines

unittests/

clang-doc/

HTMLGeneratorTest.cpp

17 lines

Diff 211972

clang-tools-extra/trunk/clang-doc/HTMLGenerator.cpp

	Show First 20 Lines • Show All 225 Lines • ▼ Show 20 Lines
	genStylesheetsHTML(StringRef InfoPath, const ClangDocContext &CDCtx) {			genStylesheetsHTML(StringRef InfoPath, const ClangDocContext &CDCtx) {
	std::vector<std::unique_ptr<TagNode>> Out;			std::vector<std::unique_ptr<TagNode>> Out;
	for (const auto &FilePath : CDCtx.UserStylesheets) {			for (const auto &FilePath : CDCtx.UserStylesheets) {
	auto LinkNode = llvm::make_unique<TagNode>(HTMLTag::TAG_LINK);			auto LinkNode = llvm::make_unique<TagNode>(HTMLTag::TAG_LINK);
	LinkNode->Attributes.try_emplace("rel", "stylesheet");			LinkNode->Attributes.try_emplace("rel", "stylesheet");
	SmallString<128> StylesheetPath = computeRelativePath("", InfoPath);			SmallString<128> StylesheetPath = computeRelativePath("", InfoPath);
	llvm::sys::path::append(StylesheetPath,			llvm::sys::path::append(StylesheetPath,
	llvm::sys::path::filename(FilePath));			llvm::sys::path::filename(FilePath));
				// Paths in HTML must be in posix-style
				llvm::sys::path::native(StylesheetPath, llvm::sys::path::Style::posix);
	LinkNode->Attributes.try_emplace("href", StylesheetPath);			LinkNode->Attributes.try_emplace("href", StylesheetPath);
	Out.emplace_back(std::move(LinkNode));			Out.emplace_back(std::move(LinkNode));
	}			}
	return Out;			return Out;
	}			}

	static std::unique_ptr<TagNode> genLink(const Twine &Text, const Twine &Link) {			static std::unique_ptr<TagNode> genLink(const Twine &Text, const Twine &Link) {
	auto LinkNode = llvm::make_unique<TagNode>(HTMLTag::TAG_A, Text);			auto LinkNode = llvm::make_unique<TagNode>(HTMLTag::TAG_A, Text);
	▲ Show 20 Lines • Show All 395 Lines • Show Last 20 Lines

clang-tools-extra/trunk/unittests/clang-doc/HTMLGeneratorTest.cpp

Show First 20 Lines • Show All 104 Lines • ▼ Show 20 Lines	TEST(HTMLGeneratorTest, emitRecordHTML) {

auto G = getHTMLGenerator();		auto G = getHTMLGenerator();
assert(G);		assert(G);
std::string Buffer;		std::string Buffer;
llvm::raw_string_ostream Actual(Buffer);		llvm::raw_string_ostream Actual(Buffer);
ClangDocContext CDCtx = getClangDocContext();		ClangDocContext CDCtx = getClangDocContext();
auto Err = G->generateDocForInfo(&I, Actual, CDCtx);		auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
assert(!Err);		assert(!Err);
SmallString<16> PathToF;
llvm::sys::path::native("../../../path/to/F.html", PathToF);
SmallString<16> PathToInt;
llvm::sys::path::native("../int.html", PathToInt);
SmallString<16> PathToSylesheet;
llvm::sys::path::native("../../../clang-doc-default-stylesheet.css",
PathToSylesheet);
std::string Expected = R"raw(<!DOCTYPE html>		std::string Expected = R"raw(<!DOCTYPE html>
<meta charset="utf-8"/>		<meta charset="utf-8"/>
<title>class r</title>		<title>class r</title>
<link rel="stylesheet" href=")raw" +		<link rel="stylesheet" href="../../../clang-doc-default-stylesheet.css"/>
std::string(PathToSylesheet.str()) +
R"raw("/>
<div>		<div>
<h1>class r</h1>		<h1>class r</h1>
<p>Defined at line 10 of test.cpp</p>		<p>Defined at line 10 of test.cpp</p>
<p>		<p>
Inherits from		Inherits from
<a href=")raw" + std::string(PathToF.str()) +		<a href="../../../path/to/F.html">F</a>
R"raw(">F</a>
, G		, G
</p>		</p>
<h2>Members</h2>		<h2>Members</h2>
<ul>		<ul>
<li>		<li>
private		private
<a href=")raw" + std::string(PathToInt.str()) +		<a href="../int.html">int</a>
R"raw(">int</a>
X		X
</li>		</li>
</ul>		</ul>
<h2>Records</h2>		<h2>Records</h2>
<ul>		<ul>
<li>ChildStruct</li>		<li>ChildStruct</li>
</ul>		</ul>
<h2>Functions</h2>		<h2>Functions</h2>
▲ Show 20 Lines • Show All 171 Lines • Show Last 20 Lines