Debian Codegraph @

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

raw
1 //===-- clang-doc/HTMLGeneratorTest.cpp -----------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "ClangDocTest.h"
10 #include "Generators.h"
11 #include "Representation.h"
12 #include "Serialize.h"
13 #include "clang/Basic/Version.h"
14 #include "gtest/gtest.h"
15
16 namespace clang {
17 namespace doc {
18
19 static const std::string ClangDocVersion =
20 clang::getClangToolFullVersion("clang-doc");
21
22 std::unique_ptr<Generator> getHTMLGenerator() {
23 auto G = doc::findGeneratorByName("html");
24 if (!G)
25 return nullptr;
26 return std::move(G.get());
27 }
28
29 ClangDocContext
30 getClangDocContext(std::vector<std::string> UserStylesheets = {},
31 StringRef RepositoryUrl = "") {
32 ClangDocContext CDCtx{
33 {}, "test-project", {}, {}, {}, RepositoryUrl, UserStylesheets};
34 CDCtx.UserStylesheets.insert(
35 CDCtx.UserStylesheets.begin(),
36 "../share/clang/clang-doc-default-stylesheet.css");
37 CDCtx.JsScripts.emplace_back("index.js");
38 return CDCtx;
39 }
40
41 TEST(HTMLGeneratorTest, emitNamespaceHTML) {
42 NamespaceInfo I;
43 I.Name = "Namespace";
44 I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
45
46 I.Children.Namespaces.emplace_back(EmptySID, "ChildNamespace",
47 InfoType::IT_namespace,
48 "Namespace::ChildNamespace", "Namespace");
49 I.Children.Records.emplace_back(EmptySID, "ChildStruct", InfoType::IT_record,
50 "Namespace::ChildStruct", "Namespace");
51 I.Children.Functions.emplace_back();
52 I.Children.Functions.back().Access = AccessSpecifier::AS_none;
53 I.Children.Functions.back().Name = "OneFunction";
54 I.Children.Enums.emplace_back();
55 I.Children.Enums.back().Name = "OneEnum";
56
57 auto G = getHTMLGenerator();
58 assert(G);
59 std::string Buffer;
60 llvm::raw_string_ostream Actual(Buffer);
61 ClangDocContext CDCtx = getClangDocContext({"user-provided-stylesheet.css"});
62 auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
63 assert(!Err);
64 std::string Expected = R"raw(<!DOCTYPE html>
65 <meta charset="utf-8"/>
66 <title>namespace Namespace</title>
67 <link rel="stylesheet" href="../clang-doc-default-stylesheet.css"/>
68 <link rel="stylesheet" href="../user-provided-stylesheet.css"/>
69 <script src="../index_json.js"></script>
70 <script src="../index.js"></script>
71 <header id="project-title">test-project</header>
72 <main>
73 <div id="sidebar-left" path="Namespace" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"></div>
74 <div id="main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
75 <h1>namespace Namespace</h1>
76 <h2 id="Namespaces">Namespaces</h2>
77 <ul>
78 <li>
79 <a href="ChildNamespace/index.html">ChildNamespace</a>
80 </li>
81 </ul>
82 <h2 id="Records">Records</h2>
83 <ul>
84 <li>
85 <a href="ChildStruct.html">ChildStruct</a>
86 </li>
87 </ul>
88 <h2 id="Functions">Functions</h2>
89 <div>
90 <h3 id="0000000000000000000000000000000000000000">OneFunction</h3>
91 <p>OneFunction()</p>
92 </div>
93 <h2 id="Enums">Enums</h2>
94 <div>
95 <h3 id="0000000000000000000000000000000000000000">enum OneEnum</h3>
96 </div>
97 </div>
98 <div id="sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
99 <ol>
100 <li>
101 <span>
102 <a href="#Namespaces">Namespaces</a>
103 </span>
104 </li>
105 <li>
106 <span>
107 <a href="#Records">Records</a>
108 </span>
109 </li>
110 <li>
111 <span>
112 <a href="#Functions">Functions</a>
113 </span>
114 <ul>
115 <li>
116 <span>
117 <a href="#0000000000000000000000000000000000000000">OneFunction</a>
118 </span>
119 </li>
120 </ul>
121 </li>
122 <li>
123 <span>
124 <a href="#Enums">Enums</a>
125 </span>
126 <ul>
127 <li>
128 <span>
129 <a href="#0000000000000000000000000000000000000000">OneEnum</a>
130 </span>
131 </li>
132 </ul>
133 </li>
134 </ol>
135 </div>
136 </main>
137 <footer>
138 <span class="no-break">)raw" +
139 ClangDocVersion + R"raw(</span>
140 </footer>
141 )raw";
142
143 EXPECT_EQ(Expected, Actual.str());
144 }
145
146 TEST(HTMLGeneratorTest, emitRecordHTML) {
147 RecordInfo I;
148 I.Name = "r";
149 I.Path = "X/Y/Z";
150 I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
151
152 I.DefLoc = Location(10, llvm::SmallString<16>{"dir/test.cpp"}, true);
153 I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"});
154
155 SmallString<16> PathTo;
156 llvm::sys::path::native("path/to", PathTo);
157 I.Members.emplace_back(TypeInfo("int"), "X", AccessSpecifier::AS_private);
158 I.TagType = TagTypeKind::Class;
159 I.Parents.emplace_back(EmptySID, "F", InfoType::IT_record, "F", PathTo);
160 I.VirtualParents.emplace_back(EmptySID, "G", InfoType::IT_record);
161
162 I.Children.Records.emplace_back(EmptySID, "ChildStruct", InfoType::IT_record,
163 "X::Y::Z::r::ChildStruct", "X/Y/Z/r");
164 I.Children.Functions.emplace_back();
165 I.Children.Functions.back().Name = "OneFunction";
166 I.Children.Enums.emplace_back();
167 I.Children.Enums.back().Name = "OneEnum";
168
169 auto G = getHTMLGenerator();
170 assert(G);
171 std::string Buffer;
172 llvm::raw_string_ostream Actual(Buffer);
173 ClangDocContext CDCtx = getClangDocContext({}, "http://www.repository.com");
174 auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
175 assert(!Err);
176 std::string Expected = R"raw(<!DOCTYPE html>
177 <meta charset="utf-8"/>
178 <title>class r</title>
179 <link rel="stylesheet" href="../../../clang-doc-default-stylesheet.css"/>
180 <script src="../../../index_json.js"></script>
181 <script src="../../../index.js"></script>
182 <header id="project-title">test-project</header>
183 <main>
184 <div id="sidebar-left" path="X/Y/Z" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"></div>
185 <div id="main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
186 <h1>class r</h1>
187 <p>
188 Defined at line
189 <a href="http://www.repository.com/dir/test.cpp#10">10</a>
190 of file
191 <a href="http://www.repository.com/dir/test.cpp">test.cpp</a>
192 </p>
193 <p>
194 Inherits from
195 <a href="../../../path/to/F.html">F</a>
196 , G
197 </p>
198 <h2 id="Members">Members</h2>
199 <ul>
200 <li>private int X</li>
201 </ul>
202 <h2 id="Records">Records</h2>
203 <ul>
204 <li>
205 <a href="../../../X/Y/Z/r/ChildStruct.html">ChildStruct</a>
206 </li>
207 </ul>
208 <h2 id="Functions">Functions</h2>
209 <div>
210 <h3 id="0000000000000000000000000000000000000000">OneFunction</h3>
211 <p>public OneFunction()</p>
212 </div>
213 <h2 id="Enums">Enums</h2>
214 <div>
215 <h3 id="0000000000000000000000000000000000000000">enum OneEnum</h3>
216 </div>
217 </div>
218 <div id="sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
219 <ol>
220 <li>
221 <span>
222 <a href="#Members">Members</a>
223 </span>
224 </li>
225 <li>
226 <span>
227 <a href="#Records">Records</a>
228 </span>
229 </li>
230 <li>
231 <span>
232 <a href="#Functions">Functions</a>
233 </span>
234 <ul>
235 <li>
236 <span>
237 <a href="#0000000000000000000000000000000000000000">OneFunction</a>
238 </span>
239 </li>
240 </ul>
241 </li>
242 <li>
243 <span>
244 <a href="#Enums">Enums</a>
245 </span>
246 <ul>
247 <li>
248 <span>
249 <a href="#0000000000000000000000000000000000000000">OneEnum</a>
250 </span>
251 </li>
252 </ul>
253 </li>
254 </ol>
255 </div>
256 </main>
257 <footer>
258 <span class="no-break">)raw" +
259 ClangDocVersion + R"raw(</span>
260 </footer>
261 )raw";
262
263 EXPECT_EQ(Expected, Actual.str());
264 }
265
266 TEST(HTMLGeneratorTest, emitFunctionHTML) {
267 FunctionInfo I;
268 I.Name = "f";
269 I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
270
271 I.DefLoc = Location(10, llvm::SmallString<16>{"dir/test.cpp"}, false);
272 I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"});
273
274 I.Access = AccessSpecifier::AS_none;
275
276 SmallString<16> PathTo;
277 llvm::sys::path::native("path/to", PathTo);
278 I.ReturnType = TypeInfo(
279 Reference(EmptySID, "float", InfoType::IT_default, "float", PathTo));
280 I.Params.emplace_back(TypeInfo("int", PathTo), "P");
281 I.IsMethod = true;
282 I.Parent = Reference(EmptySID, "Parent", InfoType::IT_record);
283
284 auto G = getHTMLGenerator();
285 assert(G);
286 std::string Buffer;
287 llvm::raw_string_ostream Actual(Buffer);
288 ClangDocContext CDCtx = getClangDocContext({}, "https://www.repository.com");
289 auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
290 assert(!Err);
291 std::string Expected = R"raw(<!DOCTYPE html>
292 <meta charset="utf-8"/>
293 <title></title>
294 <link rel="stylesheet" href="clang-doc-default-stylesheet.css"/>
295 <script src="index_json.js"></script>
296 <script src="index.js"></script>
297 <header id="project-title">test-project</header>
298 <main>
299 <div id="sidebar-left" path="" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"></div>
300 <div id="main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
301 <h3 id="0000000000000000000000000000000000000000">f</h3>
302 <p>
303 <a href="path/to/float.html">float</a>
304 f(
305 <a href="path/to/int.html">int</a>
306 P)
307 </p>
308 <p>Defined at line 10 of file dir/test.cpp</p>
309 </div>
310 <div id="sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"></div>
311 </main>
312 <footer>
313 <span class="no-break">)raw" +
314 ClangDocVersion + R"raw(</span>
315 </footer>
316 )raw";
317
318 EXPECT_EQ(Expected, Actual.str());
319 }
320
321 TEST(HTMLGeneratorTest, emitEnumHTML) {
322 EnumInfo I;
323 I.Name = "e";
324 I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
325
326 I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}, true);
327 I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"});
328
329 I.Members.emplace_back("X");
330 I.Scoped = true;
331
332 auto G = getHTMLGenerator();
333 assert(G);
334 std::string Buffer;
335 llvm::raw_string_ostream Actual(Buffer);
336 ClangDocContext CDCtx = getClangDocContext({}, "www.repository.com");
337 auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
338 assert(!Err);
339 std::string Expected = R"raw(<!DOCTYPE html>
340 <meta charset="utf-8"/>
341 <title></title>
342 <link rel="stylesheet" href="clang-doc-default-stylesheet.css"/>
343 <script src="index_json.js"></script>
344 <script src="index.js"></script>
345 <header id="project-title">test-project</header>
346 <main>
347 <div id="sidebar-left" path="" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"></div>
348 <div id="main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
349 <h3 id="0000000000000000000000000000000000000000">enum class e</h3>
350 <ul>
351 <li>X</li>
352 </ul>
353 <p>
354 Defined at line
355 <a href="https://www.repository.com/test.cpp#10">10</a>
356 of file
357 <a href="https://www.repository.com/test.cpp">test.cpp</a>
358 </p>
359 </div>
360 <div id="sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"></div>
361 </main>
362 <footer>
363 <span class="no-break">)raw" +
364 ClangDocVersion + R"raw(</span>
365 </footer>
366 )raw";
367
368 EXPECT_EQ(Expected, Actual.str());
369 }
370
371 TEST(HTMLGeneratorTest, emitCommentHTML) {
372 FunctionInfo I;
373 I.Name = "f";
374 I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"});
375 I.ReturnType = TypeInfo("void");
376 I.Params.emplace_back(TypeInfo("int"), "I");
377 I.Params.emplace_back(TypeInfo("int"), "J");
378 I.Access = AccessSpecifier::AS_none;
379
380 CommentInfo Top;
381 Top.Kind = "FullComment";
382
383 Top.Children.emplace_back(std::make_unique<CommentInfo>());
384 CommentInfo *BlankLine = Top.Children.back().get();
385 BlankLine->Kind = "ParagraphComment";
386 BlankLine->Children.emplace_back(std::make_unique<CommentInfo>());
387 BlankLine->Children.back()->Kind = "TextComment";
388
389 Top.Children.emplace_back(std::make_unique<CommentInfo>());
390 CommentInfo *Brief = Top.Children.back().get();
391 Brief->Kind = "ParagraphComment";
392 Brief->Children.emplace_back(std::make_unique<CommentInfo>());
393 Brief->Children.back()->Kind = "TextComment";
394 Brief->Children.back()->Name = "ParagraphComment";
395 Brief->Children.back()->Text = " Brief description.";
396
397 Top.Children.emplace_back(std::make_unique<CommentInfo>());
398 CommentInfo *Extended = Top.Children.back().get();
399 Extended->Kind = "ParagraphComment";
400 Extended->Children.emplace_back(std::make_unique<CommentInfo>());
401 Extended->Children.back()->Kind = "TextComment";
402 Extended->Children.back()->Text = " Extended description that";
403 Extended->Children.emplace_back(std::make_unique<CommentInfo>());
404 Extended->Children.back()->Kind = "TextComment";
405 Extended->Children.back()->Text = " continues onto the next line.";
406
407 Top.Children.emplace_back(std::make_unique<CommentInfo>());
408 CommentInfo *Entities = Top.Children.back().get();
409 Entities->Kind = "ParagraphComment";
410 Entities->Children.emplace_back(std::make_unique<CommentInfo>());
411 Entities->Children.back()->Kind = "TextComment";
412 Entities->Children.back()->Name = "ParagraphComment";
413 Entities->Children.back()->Text =
414 " Comment with html entities: &, <, >, \", \'.";
415
416 I.Description.emplace_back(std::move(Top));
417
418 auto G = getHTMLGenerator();
419 assert(G);
420 std::string Buffer;
421 llvm::raw_string_ostream Actual(Buffer);
422 ClangDocContext CDCtx = getClangDocContext();
423 auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
424 assert(!Err);
425 std::string Expected = R"raw(<!DOCTYPE html>
426 <meta charset="utf-8"/>
427 <title></title>
428 <link rel="stylesheet" href="clang-doc-default-stylesheet.css"/>
429 <script src="index_json.js"></script>
430 <script src="index.js"></script>
431 <header id="project-title">test-project</header>
432 <main>
433 <div id="sidebar-left" path="" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"></div>
434 <div id="main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
435 <h3 id="0000000000000000000000000000000000000000">f</h3>
436 <p>void f(int I, int J)</p>
437 <p>Defined at line 10 of file test.cpp</p>
438 <div>
439 <div>
440 <p> Brief description.</p>
441 <p> Extended description that continues onto the next line.</p>
442 <p> Comment with html entities: &amp;, &lt;, &gt;, &quot;, &apos;.</p>
443 </div>
444 </div>
445 </div>
446 <div id="sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"></div>
447 </main>
448 <footer>
449 <span class="no-break">)raw" +
450 ClangDocVersion + R"raw(</span>
451 </footer>
452 )raw";
453
454 EXPECT_EQ(Expected, Actual.str());
455 }
456
457 } // namespace doc
458 } // namespace clang