Debian Codegraph @

qt6/tests/check_internal_outline.cpp

raw
1 #include <QtTest/QTest>
2 #include <QtCore/QTemporaryFile>
3
4 #include "Outline.h"
5 #include "PDFDoc.h"
6 #include "PDFDocFactory.h"
7
8 class TestInternalOutline : public QObject
9 {
10 Q_OBJECT
11 public:
12 explicit TestInternalOutline(QObject *parent = nullptr) : QObject(parent) { }
13 private Q_SLOTS:
14 void testCreateOutline();
15 void testSetOutline();
16 void testInsertChild();
17 void testRemoveChild();
18 void testSetTitleAndSetPageDest();
19 };
20
21 void TestInternalOutline::testCreateOutline()
22 {
23 QTemporaryFile tempFile;
24 QVERIFY(tempFile.open());
25 tempFile.close();
26
27 const std::string tempFileName = tempFile.fileName().toStdString();
28
29 std::unique_ptr<PDFDoc> doc = PDFDocFactory().createPDFDoc(GooString(TESTDATADIR "/unittestcases/truetype.pdf"));
30 QVERIFY(doc.get());
31
32 // ensure the file has no existing outline
33 Outline *outline = doc->getOutline();
34 QVERIFY(outline != nullptr);
35 auto *outlineItems = outline->getItems();
36 QVERIFY(outlineItems == nullptr);
37
38 // create an empty outline and save the file
39 outline->setOutline({});
40 outlineItems = outline->getItems();
41 // no items will result in a nullptr rather than a 0 length list
42 QVERIFY(outlineItems == nullptr);
43 doc->saveAs(tempFileName);
44
45 /******************************************************/
46
47 const GooString gooTempFileName { tempFileName };
48 doc = PDFDocFactory().createPDFDoc(gooTempFileName);
49 QVERIFY(doc.get());
50
51 // ensure the re-opened file has an outline with no items
52 outline = doc->getOutline();
53 QVERIFY(outline != nullptr);
54 outlineItems = outline->getItems();
55 QVERIFY(outlineItems == nullptr);
56 }
57
58 static std::string getTitle(const OutlineItem *item)
59 {
60 const std::vector<Unicode> &u = item->getTitle();
61 std::string s;
62 for (const auto &c : u) {
63 s.append(1, (char)(c));
64 }
65 return s;
66 }
67
68 void TestInternalOutline::testSetOutline()
69 {
70 QTemporaryFile tempFile;
71 QVERIFY(tempFile.open());
72 tempFile.close();
73
74 const std::string tempFileName = tempFile.fileName().toStdString();
75
76 std::unique_ptr<PDFDoc> doc = PDFDocFactory().createPDFDoc(GooString(TESTDATADIR "/unittestcases/truetype.pdf"));
77 QVERIFY(doc.get());
78
79 // ensure the file has no existing outline
80 Outline *outline = doc->getOutline();
81 QVERIFY(outline != nullptr);
82 auto *outlineItems = outline->getItems();
83 QVERIFY(outlineItems == nullptr);
84
85 // create an outline and save the file
86 outline->setOutline(
87 { { "1", 1, { { "1.1", 1, {} }, { "1.2", 2, {} }, { "1.3", 3, { { "1.3.1", 1, {} }, { "1.3.2", 2, {} }, { "1.3.3", 3, {} }, { "1.3.4", 4, {} } } }, { "1.4", 4, {} } } }, { "2", 2, {} }, { "3", 3, {} }, { "4", 4, {} } });
88 outlineItems = outline->getItems();
89 QVERIFY(outlineItems != nullptr);
90 doc->saveAs(tempFileName);
91 outline = nullptr;
92
93 /******************************************************/
94
95 const GooString gooTempFileName { tempFileName };
96 doc = PDFDocFactory().createPDFDoc(gooTempFileName);
97 QVERIFY(doc.get());
98
99 // ensure the re-opened file has an outline
100 outline = doc->getOutline();
101 QVERIFY(outline != nullptr);
102 outlineItems = outline->getItems();
103
104 QVERIFY(outlineItems != nullptr);
105 QVERIFY(outlineItems->size() == 4);
106
107 OutlineItem *item = outlineItems->at(0);
108 QVERIFY(item != nullptr);
109
110 // c_str() is used so QCOMPARE prints string correctly on disagree
111 QCOMPARE(getTitle(item).c_str(), "1");
112 item = outlineItems->at(1);
113 QVERIFY(item != nullptr);
114 QCOMPARE(getTitle(item).c_str(), "2");
115 item = outlineItems->at(2);
116 QVERIFY(item != nullptr);
117 QCOMPARE(getTitle(item).c_str(), "3");
118 item = outlineItems->at(3);
119 QVERIFY(item != nullptr);
120 QCOMPARE(getTitle(item).c_str(), "4");
121
122 outlineItems = outlineItems->at(0)->getKids();
123 QVERIFY(outlineItems != nullptr);
124 item = outlineItems->at(0);
125 QVERIFY(item != nullptr);
126 QCOMPARE(getTitle(item).c_str(), "1.1");
127 item = outlineItems->at(1);
128 QVERIFY(item != nullptr);
129 QCOMPARE(getTitle(item).c_str(), "1.2");
130 item = outlineItems->at(2);
131 QVERIFY(item != nullptr);
132 QCOMPARE(getTitle(item).c_str(), "1.3");
133 item = outlineItems->at(3);
134 QVERIFY(item != nullptr);
135 QCOMPARE(getTitle(item).c_str(), "1.4");
136
137 outlineItems = outlineItems->at(2)->getKids();
138 QVERIFY(outlineItems != nullptr);
139
140 item = outlineItems->at(0);
141 QVERIFY(item != nullptr);
142 QCOMPARE(getTitle(item).c_str(), "1.3.1");
143 item = outlineItems->at(1);
144 QVERIFY(item != nullptr);
145 QCOMPARE(getTitle(item).c_str(), "1.3.2");
146 item = outlineItems->at(2);
147 QVERIFY(item != nullptr);
148 QCOMPARE(getTitle(item).c_str(), "1.3.3");
149 item = outlineItems->at(3);
150 QVERIFY(item != nullptr);
151 QCOMPARE(getTitle(item).c_str(), "1.3.4");
152 }
153
154 void TestInternalOutline::testInsertChild()
155 {
156 QTemporaryFile tempFile;
157 QVERIFY(tempFile.open());
158 tempFile.close();
159 QTemporaryFile tempFile2;
160 QVERIFY(tempFile2.open());
161 tempFile2.close();
162
163 const std::string tempFileName = tempFile.fileName().toStdString();
164 const std::string tempFileName2 = tempFile2.fileName().toStdString();
165
166 std::unique_ptr<PDFDoc> doc = PDFDocFactory().createPDFDoc(GooString(TESTDATADIR "/unittestcases/truetype.pdf"));
167 QVERIFY(doc.get());
168
169 // ensure the file has no existing outline
170 Outline *outline = doc->getOutline();
171 QVERIFY(outline != nullptr);
172 auto *outlineItems = outline->getItems();
173 QVERIFY(outlineItems == nullptr);
174
175 // create an outline and save the file
176 outline->setOutline({});
177 doc->saveAs(tempFileName);
178 outline = nullptr;
179
180 /******************************************************/
181
182 const GooString gooTempFileName { tempFileName };
183 doc = PDFDocFactory().createPDFDoc(gooTempFileName);
184 QVERIFY(doc.get());
185
186 // ensure the re-opened file has an outline with no items
187 outline = doc->getOutline();
188 QVERIFY(outline != nullptr);
189 // nullptr for 0-length
190 QVERIFY(outline->getItems() == nullptr);
191
192 // insert first one to empty
193 outline->insertChild("2", 1, 0);
194 // insert at the end
195 outline->insertChild("3", 1, 1);
196 // insert at the start
197 outline->insertChild("1", 1, 0);
198
199 // add an item to "2"
200 outlineItems = outline->getItems();
201 QVERIFY(outlineItems != nullptr);
202 QVERIFY(outlineItems->at(1));
203 outlineItems->at(1)->insertChild("2.1", 2, 0);
204 outlineItems->at(1)->insertChild("2.2", 2, 1);
205 outlineItems->at(1)->insertChild("2.4", 2, 2);
206
207 outlineItems->at(1)->insertChild("2.3", 2, 2);
208
209 // save the file
210 doc->saveAs(tempFileName2);
211 outline = nullptr;
212
213 /******************************************************/
214
215 const GooString gooTempFileName2 { tempFileName2 };
216 doc = PDFDocFactory().createPDFDoc(gooTempFileName2);
217 QVERIFY(doc.get());
218
219 // ensure the re-opened file has an outline
220 outline = doc->getOutline();
221 QVERIFY(outline != nullptr);
222
223 outlineItems = outline->getItems();
224
225 QVERIFY(outlineItems != nullptr);
226 QVERIFY(outlineItems->size() == 3);
227
228 OutlineItem *item = outlineItems->at(0);
229 QVERIFY(item != nullptr);
230
231 // c_str() is used so QCOMPARE prints string correctly on disagree
232 QCOMPARE(getTitle(item).c_str(), "1");
233 item = outlineItems->at(1);
234 QVERIFY(item != nullptr);
235 QCOMPARE(getTitle(item).c_str(), "2");
236 item = outlineItems->at(2);
237 QVERIFY(item != nullptr);
238 QCOMPARE(getTitle(item).c_str(), "3");
239
240 outlineItems = outlineItems->at(1)->getKids();
241 item = outlineItems->at(0);
242 QVERIFY(item != nullptr);
243 QCOMPARE(getTitle(item).c_str(), "2.1");
244 item = outlineItems->at(1);
245 QVERIFY(item != nullptr);
246 QCOMPARE(getTitle(item).c_str(), "2.2");
247 item = outlineItems->at(2);
248 QVERIFY(item != nullptr);
249 QCOMPARE(getTitle(item).c_str(), "2.3");
250 item = outlineItems->at(3);
251 QVERIFY(item != nullptr);
252 QCOMPARE(getTitle(item).c_str(), "2.4");
253 }
254
255 void TestInternalOutline::testRemoveChild()
256 {
257 QTemporaryFile tempFile;
258 QVERIFY(tempFile.open());
259 tempFile.close();
260
261 QTemporaryFile tempFile2;
262 QVERIFY(tempFile2.open());
263 tempFile2.close();
264
265 const std::string tempFileName = tempFile.fileName().toStdString();
266 const std::string tempFileName2 = tempFile2.fileName().toStdString();
267
268 std::unique_ptr<PDFDoc> doc = PDFDocFactory().createPDFDoc(GooString(TESTDATADIR "/unittestcases/truetype.pdf"));
269 QVERIFY(doc.get());
270
271 // ensure the file has no existing outline
272 Outline *outline = doc->getOutline();
273 QVERIFY(outline != nullptr);
274 auto *outlineItems = outline->getItems();
275 QVERIFY(outlineItems == nullptr);
276
277 // create an outline and save the file
278 outline->setOutline({ { "1", 1, { { "1.1", 1, {} }, { "1.2", 2, {} }, { "1.3", 3, { { "1.3.1", 1, {} }, { "1.3.2", 2, {} }, { "1.3.3", 3, {} }, { "1.3.4", 4, {} } } }, { "1.4", 4, {} } } },
279 { "2", 2, { { "2.1", 1, {} } } },
280 { "3", 3, { { "3.1", 1, {} }, { "3.2", 2, { { "3.2.1", 1, {} } } } } },
281 { "4", 4, {} } });
282 outlineItems = outline->getItems();
283 QVERIFY(outlineItems != nullptr);
284 doc->saveAs(tempFileName);
285 outline = nullptr;
286
287 /******************************************************/
288
289 const GooString gooTempFileName { tempFileName };
290 doc = PDFDocFactory().createPDFDoc(gooTempFileName);
291 QVERIFY(doc.get());
292
293 outline = doc->getOutline();
294 QVERIFY(outline != nullptr);
295
296 // remove "3"
297 outline->removeChild(2);
298 // remove "1.3.1"
299 outline->getItems()->at(0)->getKids()->at(2)->removeChild(0);
300 // remove "1.3.4"
301 outline->getItems()->at(0)->getKids()->at(2)->removeChild(2);
302 // remove "2.1"
303 outline->getItems()->at(1)->removeChild(0);
304
305 // save the file
306 doc->saveAs(tempFileName2);
307 outline = nullptr;
308
309 /******************************************************/
310
311 const GooString gooTempFileName2 { tempFileName2 };
312 doc = PDFDocFactory().createPDFDoc(gooTempFileName2);
313 QVERIFY(doc.get());
314
315 // ensure the re-opened file has an outline
316 outline = doc->getOutline();
317 QVERIFY(outline != nullptr);
318
319 outlineItems = outline->getItems();
320
321 QVERIFY(outlineItems != nullptr);
322 QVERIFY(outlineItems->size() == 3);
323
324 OutlineItem *item = outlineItems->at(0);
325 QVERIFY(item != nullptr);
326
327 // c_str() is used so QCOMPARE prints string correctly on disagree
328 QCOMPARE(getTitle(item).c_str(), "1");
329 item = outlineItems->at(1);
330 QVERIFY(item != nullptr);
331 QCOMPARE(getTitle(item).c_str(), "2");
332 item = outlineItems->at(2);
333 QVERIFY(item != nullptr);
334 QCOMPARE(getTitle(item).c_str(), "4");
335
336 outlineItems = outlineItems->at(0)->getKids();
337 outlineItems = outlineItems->at(2)->getKids();
338 item = outlineItems->at(0);
339 QVERIFY(item != nullptr);
340 QCOMPARE(getTitle(item).c_str(), "1.3.2");
341 item = outlineItems->at(1);
342 QVERIFY(item != nullptr);
343 QCOMPARE(getTitle(item).c_str(), "1.3.3");
344
345 // verify "2.1" is removed, lst length 0 is returned as a nullptr
346 QVERIFY(outline->getItems()->at(1)->getKids() == nullptr);
347 }
348
349 void TestInternalOutline::testSetTitleAndSetPageDest()
350 {
351 QTemporaryFile tempFile;
352 QVERIFY(tempFile.open());
353 tempFile.close();
354
355 QTemporaryFile tempFile2;
356 QVERIFY(tempFile2.open());
357 tempFile2.close();
358
359 const std::string tempFileName = tempFile.fileName().toStdString();
360 const std::string tempFileName2 = tempFile2.fileName().toStdString();
361
362 std::unique_ptr<PDFDoc> doc = PDFDocFactory().createPDFDoc(GooString(TESTDATADIR "/unittestcases/truetype.pdf"));
363 QVERIFY(doc.get());
364
365 // ensure the file has no existing outline
366 Outline *outline = doc->getOutline();
367 QVERIFY(outline != nullptr);
368 auto *outlineItems = outline->getItems();
369 QVERIFY(outlineItems == nullptr);
370
371 // create an outline and save the file
372 outline->setOutline({ { "1", 1, { { "1.1", 1, {} }, { "1.2", 2, {} }, { "1.3", 3, { { "1.3.1", 1, {} }, { "1.3.2", 2, {} }, { "1.3.3", 3, {} }, { "1.3.4", 4, {} } } }, { "1.4", 4, {} } } },
373 { "2", 2, { { "2.1", 1, {} } } },
374 { "3", 3, { { "3.1", 1, {} }, { "3.2", 2, { { "3.2.1", 1, {} } } } } },
375 { "4", 4, {} } });
376 outlineItems = outline->getItems();
377 QVERIFY(outlineItems != nullptr);
378 doc->saveAs(tempFileName);
379
380 outline = nullptr;
381
382 /******************************************************/
383
384 const GooString gooTempFileName { tempFileName };
385 doc = PDFDocFactory().createPDFDoc(gooTempFileName);
386 QVERIFY(doc.get());
387
388 outline = doc->getOutline();
389 QVERIFY(outline != nullptr);
390
391 // change "1.3.1"
392 OutlineItem *item = outline->getItems()->at(0)->getKids()->at(2)->getKids()->at(0);
393 QCOMPARE(getTitle(item).c_str(), "1.3.1");
394
395 item->setTitle("Changed to a different title");
396
397 item = outline->getItems()->at(2);
398 {
399 const LinkAction *action = item->getAction();
400 QVERIFY(action->getKind() == actionGoTo);
401 const LinkGoTo *gotoAction = dynamic_cast<const LinkGoTo *>(action);
402 const LinkDest *dest = gotoAction->getDest();
403 QVERIFY(dest->isPageRef() == false);
404 QCOMPARE(dest->getPageNum(), 3);
405
406 item->setPageDest(1);
407 }
408
409 // save the file
410 doc->saveAs(tempFileName2);
411 outline = nullptr;
412 item = nullptr;
413
414 /******************************************************/
415
416 const GooString gooTempFileName2 { tempFileName2 };
417 doc = PDFDocFactory().createPDFDoc(gooTempFileName2);
418 QVERIFY(doc.get());
419
420 outline = doc->getOutline();
421 QVERIFY(outline != nullptr);
422
423 item = outline->getItems()->at(0)->getKids()->at(2)->getKids()->at(0);
424 QCOMPARE(getTitle(item).c_str(), "Changed to a different title");
425 {
426 item = outline->getItems()->at(2);
427 const LinkAction *action = item->getAction();
428 QVERIFY(action->getKind() == actionGoTo);
429 const LinkGoTo *gotoAction = dynamic_cast<const LinkGoTo *>(action);
430 const LinkDest *dest = gotoAction->getDest();
431 QVERIFY(dest->isPageRef() == false);
432 QCOMPARE(dest->getPageNum(), 1);
433 }
434 }
435
436 QTEST_GUILESS_MAIN(TestInternalOutline)
437 #include "check_internal_outline.moc"