Coverage Report

Created: 2026-01-09 06:29

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/qpdf/libqpdf/QPDF_Array.cc
Line
Count
Source
1
#include <qpdf/QPDFObjectHandle_private.hh>
2
3
#include <qpdf/QTC.hh>
4
5
#include <array>
6
#include <utility>
7
8
using namespace std::literals;
9
using namespace qpdf;
10
11
static const QPDFObjectHandle null_oh = QPDFObjectHandle::newNull();
12
13
static size_t
14
to_s(int n)
15
6.64k
{
16
6.64k
    return static_cast<size_t>(n);
17
6.64k
}
18
19
static int
20
to_i(size_t n)
21
251k
{
22
251k
    return static_cast<int>(n);
23
251k
}
24
25
inline void
26
Array::checkOwnership(QPDFObjectHandle const& item) const
27
35.2k
{
28
35.2k
    if (!item) {
29
0
        throw std::logic_error("Attempting to add an uninitialized object to a QPDF_Array.");
30
0
    }
31
35.2k
    if (qpdf() && item.qpdf() && qpdf() != item.qpdf()) {
32
0
        throw std::logic_error(
33
0
            "Attempting to add an object from a different QPDF. Use "
34
0
            "QPDF::copyForeignObject to add objects from another file.");
35
0
    }
36
35.2k
}
37
38
QPDF_Array::QPDF_Array(std::vector<QPDFObjectHandle>&& v, bool sparse)
39
39.6k
{
40
39.6k
    if (sparse) {
41
476
        sp = std::make_unique<Sparse>();
42
126k
        for (auto& item: v) {
43
126k
            if (item.raw_type_code() != ::ot_null || item.indirect()) {
44
53.0k
                sp->elements[sp->size] = std::move(item);
45
53.0k
            }
46
126k
            ++sp->size;
47
126k
        }
48
39.1k
    } else {
49
39.1k
        elements = std::move(v);
50
39.1k
    }
51
39.6k
}
52
53
QPDF_Array*
54
Array::array() const
55
45.6k
{
56
45.6k
    if (auto a = as<QPDF_Array>()) {
57
45.6k
        return a;
58
45.6k
    }
59
60
0
    throw std::runtime_error("Expected an array but found a non-array object");
61
0
    return nullptr; // unreachable
62
45.6k
}
63
64
Array::Array(std::vector<QPDFObjectHandle> const& items) :
65
5.15k
    BaseHandle(QPDFObject::create<QPDF_Array>(items))
66
5.15k
{
67
5.15k
}
68
69
Array::Array(std::vector<QPDFObjectHandle>&& items) :
70
6.96k
    BaseHandle(QPDFObject::create<QPDF_Array>(std::move(items)))
71
6.96k
{
72
6.96k
}
73
74
Array
75
Array::empty()
76
804
{
77
804
    return Array(std::vector<QPDFObjectHandle>());
78
804
}
79
80
Array::iterator
81
Array::begin()
82
181k
{
83
181k
    if (auto a = as<QPDF_Array>()) {
84
109k
        if (!a->sp) {
85
108k
            return a->elements.begin();
86
108k
        }
87
786
        if (!sp_elements) {
88
786
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
89
786
        }
90
786
        return sp_elements->begin();
91
109k
    }
92
72.4k
    return {};
93
181k
}
94
95
Array::iterator
96
Array::end()
97
181k
{
98
181k
    if (auto a = as<QPDF_Array>()) {
99
109k
        if (!a->sp) {
100
108k
            return a->elements.end();
101
108k
        }
102
786
        if (!sp_elements) {
103
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
104
0
        }
105
786
        return sp_elements->end();
106
109k
    }
107
72.4k
    return {};
108
181k
}
109
110
Array::const_iterator
111
Array::cbegin()
112
0
{
113
0
    if (auto a = as<QPDF_Array>()) {
114
0
        if (!a->sp) {
115
0
            return a->elements.cbegin();
116
0
        }
117
0
        if (!sp_elements) {
118
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
119
0
        }
120
0
        return sp_elements->cbegin();
121
0
    }
122
0
    return {};
123
0
}
124
125
Array::const_iterator
126
Array::cend()
127
0
{
128
0
    if (auto a = as<QPDF_Array>()) {
129
0
        if (!a->sp) {
130
0
            return a->elements.cend();
131
0
        }
132
0
        if (!sp_elements) {
133
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
134
0
        }
135
0
        return sp_elements->cend();
136
0
    }
137
0
    return {};
138
0
}
139
140
Array::const_reverse_iterator
141
Array::crbegin()
142
0
{
143
0
    if (auto a = as<QPDF_Array>()) {
144
0
        if (!a->sp) {
145
0
            return a->elements.crbegin();
146
0
        }
147
0
        if (!sp_elements) {
148
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
149
0
        }
150
0
        return sp_elements->crbegin();
151
0
    }
152
0
    return {};
153
0
}
154
155
Array::const_reverse_iterator
156
Array::crend()
157
0
{
158
0
    if (auto a = as<QPDF_Array>()) {
159
0
        if (!a->sp) {
160
0
            return a->elements.crend();
161
0
        }
162
0
        if (!sp_elements) {
163
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
164
0
        }
165
0
        return sp_elements->crend();
166
0
    }
167
0
    return {};
168
0
}
169
170
QPDFObjectHandle
171
Array::null() const
172
0
{
173
0
    return null_oh;
174
0
}
175
176
size_t
177
Array::size() const
178
191k
{
179
191k
    if (auto a = as<QPDF_Array>()) {
180
151k
        return a->sp ? a->sp->size : a->elements.size();
181
151k
    }
182
40.3k
    return 0;
183
191k
}
184
185
QPDFObjectHandle const&
186
Array::operator[](size_t n) const
187
559k
{
188
559k
    static const QPDFObjectHandle null_obj;
189
559k
    auto a = as<QPDF_Array>();
190
559k
    if (!a) {
191
1.67k
        return null_obj;
192
1.67k
    }
193
557k
    if (a->sp) {
194
23.6k
        auto const& iter = a->sp->elements.find(n);
195
23.6k
        return iter == a->sp->elements.end() ? null_obj : iter->second;
196
23.6k
    }
197
534k
    return n >= a->elements.size() ? null_obj : a->elements[n];
198
557k
}
199
200
QPDFObjectHandle const&
201
Array::operator[](int n) const
202
446k
{
203
446k
    static const QPDFObjectHandle null_obj;
204
446k
    if (n < 0) {
205
2.62k
        return null_obj;
206
2.62k
    }
207
443k
    return (*this)[static_cast<size_t>(n)];
208
446k
}
209
210
QPDFObjectHandle
211
Array::get(size_t n) const
212
78
{
213
78
    if (n >= size()) {
214
0
        return {};
215
0
    }
216
78
    auto a = array();
217
78
    if (!a->sp) {
218
78
        return a->elements[n];
219
78
    }
220
0
    auto const& iter = a->sp->elements.find(n);
221
0
    return iter == a->sp->elements.end() ? null() : iter->second;
222
78
}
223
224
QPDFObjectHandle
225
Array::get(int n) const
226
78
{
227
78
    if (n < 0) {
228
0
        return {};
229
0
    }
230
78
    return get(to_s(n));
231
78
}
232
233
std::vector<QPDFObjectHandle>
234
Array::getAsVector() const
235
9.47k
{
236
9.47k
    auto a = array();
237
9.47k
    if (a->sp) {
238
789
        std::vector<QPDFObjectHandle> v;
239
789
        v.reserve(size());
240
23.6k
        for (auto const& item: a->sp->elements) {
241
23.6k
            v.resize(item.first, null_oh);
242
23.6k
            v.emplace_back(item.second);
243
23.6k
        }
244
789
        v.resize(size(), null_oh);
245
789
        return v;
246
8.68k
    } else {
247
8.68k
        return a->elements;
248
8.68k
    }
249
9.47k
}
250
251
bool
252
Array::set(size_t at, QPDFObjectHandle const& oh)
253
38
{
254
38
    if (at >= size()) {
255
0
        return false;
256
0
    }
257
38
    auto a = array();
258
38
    checkOwnership(oh);
259
38
    if (a->sp) {
260
0
        a->sp->elements[at] = oh;
261
38
    } else {
262
38
        a->elements[at] = oh;
263
38
    }
264
38
    return true;
265
38
}
266
267
bool
268
Array::set(int at, QPDFObjectHandle const& oh)
269
38
{
270
38
    if (at < 0) {
271
0
        return false;
272
0
    }
273
38
    return set(to_s(at), oh);
274
38
}
275
276
void
277
Array::setFromVector(std::vector<QPDFObjectHandle> const& v)
278
0
{
279
0
    auto a = array();
280
0
    a->elements.resize(0);
281
0
    a->elements.reserve(v.size());
282
0
    for (auto const& item: v) {
283
0
        checkOwnership(item);
284
0
        a->elements.emplace_back(item);
285
0
    }
286
0
}
287
288
bool
289
Array::insert(size_t at, QPDFObjectHandle const& item)
290
5.64k
{
291
5.64k
    auto a = array();
292
5.64k
    size_t sz = size();
293
5.64k
    if (at > sz) {
294
0
        return false;
295
0
    }
296
5.64k
    checkOwnership(item);
297
5.64k
    if (at == sz) {
298
        // As special case, also allow insert beyond the end
299
5.64k
        push_back(item);
300
5.64k
        return true;
301
5.64k
    }
302
0
    if (!a->sp) {
303
0
        a->elements.insert(a->elements.cbegin() + to_i(at), item);
304
0
        return true;
305
0
    }
306
0
    auto iter = a->sp->elements.crbegin();
307
0
    while (iter != a->sp->elements.crend()) {
308
0
        auto key = (iter++)->first;
309
0
        if (key >= at) {
310
0
            auto nh = a->sp->elements.extract(key);
311
0
            ++nh.key();
312
0
            a->sp->elements.insert(std::move(nh));
313
0
        } else {
314
0
            break;
315
0
        }
316
0
    }
317
0
    a->sp->elements[at] = item;
318
0
    ++a->sp->size;
319
0
    return true;
320
0
}
321
322
bool
323
Array::insert(int at_i, QPDFObjectHandle const& item)
324
5.64k
{
325
5.64k
    if (at_i < 0) {
326
0
        return false;
327
0
    }
328
5.64k
    return insert(to_s(at_i), item);
329
5.64k
}
330
331
void
332
Array::push_back(QPDFObjectHandle const& item)
333
29.5k
{
334
29.5k
    auto a = array();
335
29.5k
    checkOwnership(item);
336
29.5k
    if (a->sp) {
337
142
        a->sp->elements[(a->sp->size)++] = item;
338
29.4k
    } else {
339
29.4k
        a->elements.emplace_back(item);
340
29.4k
    }
341
29.5k
}
342
343
bool
344
Array::erase(size_t at)
345
884
{
346
884
    auto a = array();
347
884
    if (at >= size()) {
348
0
        return false;
349
0
    }
350
884
    if (!a->sp) {
351
884
        a->elements.erase(a->elements.cbegin() + to_i(at));
352
884
        return true;
353
884
    }
354
0
    auto end = a->sp->elements.end();
355
0
    if (auto iter = a->sp->elements.lower_bound(at); iter != end) {
356
0
        if (iter->first == at) {
357
0
            iter++;
358
0
            a->sp->elements.erase(at);
359
0
        }
360
361
0
        while (iter != end) {
362
0
            auto nh = a->sp->elements.extract(iter++);
363
0
            --nh.key();
364
0
            a->sp->elements.insert(std::move(nh));
365
0
        }
366
0
    }
367
0
    --(a->sp->size);
368
0
    return true;
369
884
}
370
371
bool
372
Array::erase(int at_i)
373
884
{
374
884
    if (at_i < 0) {
375
0
        return false;
376
0
    }
377
884
    return erase(to_s(at_i));
378
884
}
379
380
int
381
QPDFObjectHandle::getArrayNItems() const
382
250k
{
383
250k
    auto s = size();
384
250k
    if (s > 1 || isArray()) {
385
250k
        return to_i(s);
386
250k
    }
387
0
    typeWarning("array", "treating as empty");
388
0
    return 0;
389
250k
}
390
391
QPDFObjectHandle
392
QPDFObjectHandle::getArrayItem(int n) const
393
262k
{
394
262k
    if (auto array = Array(*this)) {
395
262k
        if (auto result = array[n]) {
396
245k
            return result;
397
245k
        }
398
17.2k
        if (n >= 0 && std::cmp_less(n, array.size())) {
399
            // sparse array null
400
17.2k
            return newNull();
401
17.2k
        }
402
0
        objectWarning("returning null for out of bounds array access");
403
0
    } else {
404
0
        typeWarning("array", "returning null");
405
0
    }
406
0
    static auto constexpr msg = " -> null returned from invalid array access"sv;
407
0
    return QPDF_Null::create(obj, msg, "");
408
262k
}
409
410
bool
411
QPDFObjectHandle::isRectangle() const
412
62.1k
{
413
62.1k
    Array array(*this);
414
167k
    for (auto const& oh: array) {
415
167k
        if (!oh.isNumber()) {
416
2.52k
            return false;
417
2.52k
        }
418
167k
    }
419
59.6k
    return array.size() == 4;
420
62.1k
}
421
422
bool
423
QPDFObjectHandle::isMatrix() const
424
7.12k
{
425
7.12k
    Array array(*this);
426
7.12k
    for (auto const& oh: array) {
427
2.42k
        if (!oh.isNumber()) {
428
76
            return false;
429
76
        }
430
2.42k
    }
431
7.05k
    return array.size() == 6;
432
7.12k
}
433
434
QPDFObjectHandle::Rectangle
435
QPDFObjectHandle::getArrayAsRectangle() const
436
29.4k
{
437
29.4k
    Array array(*this);
438
29.4k
    if (array.size() != 4) {
439
1.37k
        return {};
440
1.37k
    }
441
28.1k
    std::array<double, 4> items;
442
139k
    for (size_t i = 0; i < 4; ++i) {
443
111k
        if (!array[i].getValueAsNumber(items[i])) {
444
392
            return {};
445
392
        }
446
111k
    }
447
27.7k
    return {
448
27.7k
        std::min(items[0], items[2]),
449
27.7k
        std::min(items[1], items[3]),
450
27.7k
        std::max(items[0], items[2]),
451
27.7k
        std::max(items[1], items[3])};
452
28.1k
}
453
454
QPDFObjectHandle::Matrix
455
QPDFObjectHandle::getArrayAsMatrix() const
456
317
{
457
317
    Array array(*this);
458
317
    if (array.size() != 6) {
459
0
        return {};
460
0
    }
461
317
    std::array<double, 6> items;
462
2.21k
    for (size_t i = 0; i < 6; ++i) {
463
1.90k
        if (!array[i].getValueAsNumber(items[i])) {
464
0
            return {};
465
0
        }
466
1.90k
    }
467
317
    return {items[0], items[1], items[2], items[3], items[4], items[5]};
468
317
}
469
470
std::vector<QPDFObjectHandle>
471
QPDFObjectHandle::getArrayAsVector() const
472
8.68k
{
473
8.68k
    if (auto array = as_array(strict)) {
474
8.68k
        return array.getAsVector();
475
8.68k
    }
476
0
    typeWarning("array", "treating as empty");
477
0
    QTC::TC("qpdf", "QPDFObjectHandle array treating as empty vector");
478
0
    return {};
479
8.68k
}
480
481
void
482
QPDFObjectHandle::setArrayItem(int n, QPDFObjectHandle const& item)
483
0
{
484
0
    if (auto array = as_array(strict)) {
485
0
        if (!array.set(n, item)) {
486
0
            objectWarning("ignoring attempt to set out of bounds array item");
487
0
        }
488
0
    } else {
489
0
        typeWarning("array", "ignoring attempt to set item");
490
0
    }
491
0
}
492
void
493
QPDFObjectHandle::setArrayFromVector(std::vector<QPDFObjectHandle> const& items)
494
0
{
495
0
    if (auto array = as_array(strict)) {
496
0
        array.setFromVector(items);
497
0
    } else {
498
0
        typeWarning("array", "ignoring attempt to replace items");
499
0
        QTC::TC("qpdf", "QPDFObjectHandle array ignoring replace items");
500
0
    }
501
0
}
502
503
void
504
QPDFObjectHandle::insertItem(int at, QPDFObjectHandle const& item)
505
0
{
506
0
    if (auto array = as_array(strict)) {
507
0
        if (!array.insert(at, item)) {
508
0
            objectWarning("ignoring attempt to insert out of bounds array item");
509
0
            QTC::TC("qpdf", "QPDFObjectHandle insert array bounds");
510
0
        }
511
0
    } else {
512
0
        typeWarning("array", "ignoring attempt to insert item");
513
0
        QTC::TC("qpdf", "QPDFObjectHandle array ignoring insert item");
514
0
    }
515
0
}
516
517
QPDFObjectHandle
518
QPDFObjectHandle::insertItemAndGetNew(int at, QPDFObjectHandle const& item)
519
0
{
520
0
    insertItem(at, item);
521
0
    return item;
522
0
}
523
524
void
525
QPDFObjectHandle::appendItem(QPDFObjectHandle const& item)
526
23.0k
{
527
23.0k
    if (auto array = as_array(strict)) {
528
23.0k
        array.push_back(item);
529
23.0k
    } else {
530
0
        typeWarning("array", "ignoring attempt to append item");
531
0
        QTC::TC("qpdf", "QPDFObjectHandle array ignoring append item");
532
0
    }
533
23.0k
}
534
535
QPDFObjectHandle
536
QPDFObjectHandle::appendItemAndGetNew(QPDFObjectHandle const& item)
537
0
{
538
0
    appendItem(item);
539
0
    return item;
540
0
}
541
542
void
543
QPDFObjectHandle::eraseItem(int at)
544
0
{
545
0
    if (auto array = as_array(strict)) {
546
0
        if (!array.erase(at)) {
547
0
            objectWarning("ignoring attempt to erase out of bounds array item");
548
0
            QTC::TC("qpdf", "QPDFObjectHandle erase array bounds");
549
0
        }
550
0
    } else {
551
0
        typeWarning("array", "ignoring attempt to erase item");
552
0
        QTC::TC("qpdf", "QPDFObjectHandle array ignoring erase item");
553
0
    }
554
0
}
555
556
QPDFObjectHandle
557
QPDFObjectHandle::eraseItemAndGetOld(int at)
558
0
{
559
0
    auto result = Array(*this)[at];
560
0
    eraseItem(at);
561
0
    return result ? result : newNull();
562
0
}
563
564
size_t
565
BaseHandle::size() const
566
291k
{
567
291k
    switch (resolved_type_code()) {
568
263k
    case ::ot_array:
569
263k
        return as<QPDF_Array>()->size();
570
0
    case ::ot_uninitialized:
571
0
    case ::ot_reserved:
572
13.5k
    case ::ot_null:
573
13.5k
    case ::ot_destroyed:
574
13.5k
    case ::ot_unresolved:
575
13.5k
    case ::ot_reference:
576
13.5k
        return 0;
577
71
    case ::ot_boolean:
578
2.95k
    case ::ot_integer:
579
3.63k
    case ::ot_real:
580
3.63k
    case ::ot_string:
581
14.1k
    case ::ot_name:
582
14.4k
    case ::ot_dictionary:
583
14.8k
    case ::ot_stream:
584
14.8k
    case ::ot_inlineimage:
585
14.8k
    case ::ot_operator:
586
14.8k
        return 1;
587
0
    default:
588
0
        throw std::logic_error("Unexpected type code in size"); // unreachable
589
0
        return 0;                                               // unreachable
590
291k
    }
591
291k
}
592
593
QPDFObjectHandle
594
BaseHandle::operator[](size_t n) const
595
2.01k
{
596
2.01k
    if (resolved_type_code() == ::ot_array) {
597
2.01k
        return Array(obj)[n];
598
2.01k
    }
599
0
    if (n < size()) {
600
0
        return *this;
601
0
    }
602
0
    return {};
603
0
}
604
605
QPDFObjectHandle
606
BaseHandle::operator[](int n) const
607
2.01k
{
608
2.01k
    if (n < 0) {
609
0
        return {};
610
0
    }
611
2.01k
    return (*this)[static_cast<size_t>(n)];
612
2.01k
}