Coverage Report

Created: 2026-06-09 07:01

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
86.2k
{
16
86.2k
    return static_cast<size_t>(n);
17
86.2k
}
18
19
static int
20
to_i(size_t n)
21
759k
{
22
759k
    return static_cast<int>(n);
23
759k
}
24
25
inline void
26
Array::checkOwnership(QPDFObjectHandle const& item) const
27
3.37M
{
28
3.37M
    if (!item) {
29
0
        throw std::logic_error("Attempting to add an uninitialized object to a QPDF_Array.");
30
0
    }
31
3.37M
    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
3.37M
}
37
38
QPDF_Array::QPDF_Array(std::vector<QPDFObjectHandle>&& v, bool sparse)
39
71.9k
{
40
71.9k
    if (sparse) {
41
4.30k
        sp = std::make_unique<Sparse>();
42
22.3M
        for (auto& item: v) {
43
22.3M
            if (item.raw_type_code() != ::ot_null || item.indirect()) {
44
21.5M
                sp->elements[sp->size] = std::move(item);
45
21.5M
            }
46
22.3M
            ++sp->size;
47
22.3M
        }
48
67.6k
    } else {
49
67.6k
        elements = std::move(v);
50
67.6k
    }
51
71.9k
}
52
53
QPDF_Array*
54
Array::array() const
55
3.56M
{
56
3.56M
    if (auto a = as<QPDF_Array>()) {
57
3.56M
        return a;
58
3.56M
    }
59
60
0
    throw std::runtime_error("Expected an array but found a non-array object");
61
0
    return nullptr; // unreachable
62
3.56M
}
63
64
Array::Array(std::vector<QPDFObjectHandle> const& items) :
65
37.9k
    BaseHandle(QPDFObject::create<QPDF_Array>(items))
66
37.9k
{
67
37.9k
}
68
69
Array::Array(std::vector<QPDFObjectHandle>&& items) :
70
22.8k
    BaseHandle(QPDFObject::create<QPDF_Array>(std::move(items)))
71
22.8k
{
72
22.8k
}
73
74
Array
75
Array::empty()
76
3.31k
{
77
3.31k
    return Array(std::vector<QPDFObjectHandle>());
78
3.31k
}
79
80
Array::iterator
81
Array::begin()
82
2.98M
{
83
2.98M
    if (auto a = as<QPDF_Array>()) {
84
2.70M
        if (!a->sp) {
85
2.69M
            return a->elements.begin();
86
2.69M
        }
87
11.1k
        if (!sp_elements) {
88
11.1k
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
89
11.1k
        }
90
11.1k
        return sp_elements->begin();
91
2.70M
    }
92
278k
    return {};
93
2.98M
}
94
95
Array::iterator
96
Array::end()
97
2.98M
{
98
2.98M
    if (auto a = as<QPDF_Array>()) {
99
2.70M
        if (!a->sp) {
100
2.69M
            return a->elements.end();
101
2.69M
        }
102
11.1k
        if (!sp_elements) {
103
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
104
0
        }
105
11.1k
        return sp_elements->end();
106
2.70M
    }
107
278k
    return {};
108
2.98M
}
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
24.6M
{
143
24.6M
    if (auto a = as<QPDF_Array>()) {
144
190k
        if (!a->sp) {
145
190k
            return a->elements.crbegin();
146
190k
        }
147
736
        if (!sp_elements) {
148
736
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
149
736
        }
150
736
        return sp_elements->crbegin();
151
190k
    }
152
24.4M
    return {};
153
24.6M
}
154
155
Array::const_reverse_iterator
156
Array::crend()
157
24.6M
{
158
24.6M
    if (auto a = as<QPDF_Array>()) {
159
190k
        if (!a->sp) {
160
190k
            return a->elements.crend();
161
190k
        }
162
736
        if (!sp_elements) {
163
0
            sp_elements = std::make_unique<std::vector<QPDFObjectHandle>>(getAsVector());
164
0
        }
165
736
        return sp_elements->crend();
166
190k
    }
167
24.4M
    return {};
168
24.6M
}
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
1.11M
{
179
1.11M
    if (auto a = as<QPDF_Array>()) {
180
860k
        return a->sp ? a->sp->size : a->elements.size();
181
860k
    }
182
253k
    return 0;
183
1.11M
}
184
185
QPDFObjectHandle const&
186
Array::operator[](size_t n) const
187
2.73M
{
188
2.73M
    static const QPDFObjectHandle null_obj;
189
2.73M
    auto a = as<QPDF_Array>();
190
2.73M
    if (!a) {
191
5.95k
        return null_obj;
192
5.95k
    }
193
2.73M
    if (a->sp) {
194
169k
        auto const& iter = a->sp->elements.find(n);
195
169k
        return iter == a->sp->elements.end() ? null_obj : iter->second;
196
169k
    }
197
2.56M
    return n >= a->elements.size() ? null_obj : a->elements[n];
198
2.73M
}
199
200
QPDFObjectHandle const&
201
Array::operator[](int n) const
202
2.47M
{
203
2.47M
    static const QPDFObjectHandle null_obj;
204
2.47M
    if (n < 0) {
205
9.41k
        return null_obj;
206
9.41k
    }
207
2.46M
    return (*this)[static_cast<size_t>(n)];
208
2.47M
}
209
210
QPDFObjectHandle
211
Array::get(size_t n) const
212
4.77k
{
213
4.77k
    if (n >= size()) {
214
0
        return {};
215
0
    }
216
4.77k
    auto a = array();
217
4.77k
    if (!a->sp) {
218
4.77k
        return a->elements[n];
219
4.77k
    }
220
0
    auto const& iter = a->sp->elements.find(n);
221
0
    return iter == a->sp->elements.end() ? null() : iter->second;
222
4.77k
}
223
224
QPDFObjectHandle
225
Array::get(int n) const
226
4.77k
{
227
4.77k
    if (n < 0) {
228
0
        return {};
229
0
    }
230
4.77k
    return get(to_s(n));
231
4.77k
}
232
233
std::vector<QPDFObjectHandle>
234
Array::getAsVector() const
235
156k
{
236
156k
    auto a = array();
237
156k
    if (a->sp) {
238
12.4k
        std::vector<QPDFObjectHandle> v;
239
12.4k
        v.reserve(size());
240
160M
        for (auto const& item: a->sp->elements) {
241
160M
            v.resize(item.first, null_oh);
242
160M
            v.emplace_back(item.second);
243
160M
        }
244
12.4k
        v.resize(size(), null_oh);
245
12.4k
        return v;
246
144k
    } else {
247
144k
        return a->elements;
248
144k
    }
249
156k
}
250
251
bool
252
Array::set(size_t at, QPDFObjectHandle const& oh)
253
372
{
254
372
    if (at >= size()) {
255
0
        return false;
256
0
    }
257
372
    auto a = array();
258
372
    checkOwnership(oh);
259
372
    if (a->sp) {
260
8
        a->sp->elements[at] = oh;
261
364
    } else {
262
364
        a->elements[at] = oh;
263
364
    }
264
372
    return true;
265
372
}
266
267
bool
268
Array::set(int at, QPDFObjectHandle const& oh)
269
372
{
270
372
    if (at < 0) {
271
0
        return false;
272
0
    }
273
372
    return set(to_s(at), oh);
274
372
}
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
51.0k
{
291
51.0k
    auto a = array();
292
51.0k
    size_t sz = size();
293
51.0k
    if (at > sz) {
294
0
        return false;
295
0
    }
296
51.0k
    checkOwnership(item);
297
51.0k
    if (at == sz) {
298
        // As special case, also allow insert beyond the end
299
51.0k
        push_back(item);
300
51.0k
        return true;
301
51.0k
    }
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
51.0k
{
325
51.0k
    if (at_i < 0) {
326
0
        return false;
327
0
    }
328
51.0k
    return insert(to_s(at_i), item);
329
51.0k
}
330
331
void
332
Array::push_back(QPDFObjectHandle const& item)
333
3.32M
{
334
3.32M
    auto a = array();
335
3.32M
    checkOwnership(item);
336
3.32M
    if (a->sp) {
337
263
        a->sp->elements[(a->sp->size)++] = item;
338
3.32M
    } else {
339
3.32M
        a->elements.emplace_back(item);
340
3.32M
    }
341
3.32M
}
342
343
bool
344
Array::erase(size_t at)
345
30.0k
{
346
30.0k
    auto a = array();
347
30.0k
    if (at >= size()) {
348
111
        return false;
349
111
    }
350
29.8k
    if (!a->sp) {
351
29.4k
        a->elements.erase(a->elements.cbegin() + to_i(at));
352
29.4k
        return true;
353
29.4k
    }
354
455
    auto end = a->sp->elements.end();
355
455
    if (auto iter = a->sp->elements.lower_bound(at); iter != end) {
356
443
        if (iter->first == at) {
357
396
            iter++;
358
396
            a->sp->elements.erase(at);
359
396
        }
360
361
153k
        while (iter != end) {
362
153k
            auto nh = a->sp->elements.extract(iter++);
363
153k
            --nh.key();
364
153k
            a->sp->elements.insert(std::move(nh));
365
153k
        }
366
443
    }
367
455
    --(a->sp->size);
368
455
    return true;
369
29.8k
}
370
371
bool
372
Array::erase(int at_i)
373
30.0k
{
374
30.0k
    if (at_i < 0) {
375
0
        return false;
376
0
    }
377
30.0k
    return erase(to_s(at_i));
378
30.0k
}
379
380
int
381
QPDFObjectHandle::getArrayNItems() const
382
729k
{
383
729k
    auto s = size();
384
729k
    if (s > 1 || isArray()) {
385
729k
        return to_i(s);
386
729k
    }
387
0
    typeWarning("array", "treating as empty");
388
0
    return 0;
389
729k
}
390
391
QPDFObjectHandle
392
QPDFObjectHandle::getArrayItem(int n) const
393
1.25M
{
394
1.25M
    if (auto array = Array(*this)) {
395
1.25M
        if (auto result = array[n]) {
396
1.14M
            return result;
397
1.14M
        }
398
114k
        if (n >= 0 && std::cmp_less(n, array.size())) {
399
            // sparse array null
400
114k
            return newNull();
401
114k
        }
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
1.25M
}
409
410
bool
411
QPDFObjectHandle::isRectangle() const
412
307k
{
413
307k
    Array array(*this);
414
572k
    for (auto const& oh: array) {
415
572k
        if (!oh.isNumber()) {
416
5.94k
            return false;
417
5.94k
        }
418
572k
    }
419
301k
    return array.size() == 4;
420
307k
}
421
422
bool
423
QPDFObjectHandle::isMatrix() const
424
16.5k
{
425
16.5k
    Array array(*this);
426
16.5k
    for (auto const& oh: array) {
427
4.82k
        if (!oh.isNumber()) {
428
135
            return false;
429
135
        }
430
4.82k
    }
431
16.4k
    return array.size() == 6;
432
16.5k
}
433
434
QPDFObjectHandle::Rectangle
435
QPDFObjectHandle::getArrayAsRectangle() const
436
62.2k
{
437
62.2k
    Array array(*this);
438
62.2k
    if (array.size() != 4) {
439
2.18k
        return {};
440
2.18k
    }
441
60.0k
    std::array<double, 4> items;
442
298k
    for (size_t i = 0; i < 4; ++i) {
443
239k
        if (!array[i].getValueAsNumber(items[i])) {
444
540
            return {};
445
540
        }
446
239k
    }
447
59.4k
    return {
448
59.4k
        std::min(items[0], items[2]),
449
59.4k
        std::min(items[1], items[3]),
450
59.4k
        std::max(items[0], items[2]),
451
59.4k
        std::max(items[1], items[3])};
452
60.0k
}
453
454
QPDFObjectHandle::Matrix
455
QPDFObjectHandle::getArrayAsMatrix() const
456
691
{
457
691
    Array array(*this);
458
691
    if (array.size() != 6) {
459
0
        return {};
460
0
    }
461
691
    std::array<double, 6> items;
462
4.83k
    for (size_t i = 0; i < 6; ++i) {
463
4.14k
        if (!array[i].getValueAsNumber(items[i])) {
464
0
            return {};
465
0
        }
466
4.14k
    }
467
691
    return {items[0], items[1], items[2], items[3], items[4], items[5]};
468
691
}
469
470
std::vector<QPDFObjectHandle>
471
QPDFObjectHandle::getArrayAsVector() const
472
145k
{
473
145k
    if (auto array = as_array(strict)) {
474
145k
        return array.getAsVector();
475
145k
    }
476
0
    typeWarning("array", "treating as empty");
477
0
    QTC::TC("qpdf", "QPDFObjectHandle array treating as empty vector");
478
0
    return {};
479
145k
}
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
3.24M
{
527
3.24M
    if (auto array = as_array(strict)) {
528
3.24M
        array.push_back(item);
529
3.24M
    } else {
530
0
        typeWarning("array", "ignoring attempt to append item");
531
0
        QTC::TC("qpdf", "QPDFObjectHandle array ignoring append item");
532
0
    }
533
3.24M
}
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
4.74k
{
545
4.74k
    if (auto array = as_array(strict)) {
546
3.07k
        if (!array.erase(at)) {
547
111
            objectWarning("ignoring attempt to erase out of bounds array item");
548
111
            QTC::TC("qpdf", "QPDFObjectHandle erase array bounds");
549
111
        }
550
3.07k
    } else {
551
1.66k
        typeWarning("array", "ignoring attempt to erase item");
552
1.66k
        QTC::TC("qpdf", "QPDFObjectHandle array ignoring erase item");
553
1.66k
    }
554
4.74k
}
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
1.45M
{
567
1.45M
    switch (resolved_type_code()) {
568
930k
    case ::ot_array:
569
930k
        return as<QPDF_Array>()->size();
570
92.5k
    case ::ot_uninitialized:
571
92.5k
    case ::ot_reserved:
572
371k
    case ::ot_null:
573
371k
    case ::ot_destroyed:
574
371k
    case ::ot_unresolved:
575
371k
    case ::ot_reference:
576
371k
        return 0;
577
411
    case ::ot_boolean:
578
4.81k
    case ::ot_integer:
579
5.82k
    case ::ot_real:
580
6.07k
    case ::ot_string:
581
142k
    case ::ot_name:
582
150k
    case ::ot_dictionary:
583
151k
    case ::ot_stream:
584
151k
    case ::ot_inlineimage:
585
151k
    case ::ot_operator:
586
151k
        return 1;
587
0
    default:
588
0
        throw std::logic_error("Unexpected type code in size"); // unreachable
589
0
        return 0;                                               // unreachable
590
1.45M
    }
591
1.45M
}
592
593
QPDFObjectHandle
594
BaseHandle::operator[](size_t n) const
595
111k
{
596
111k
    if (resolved_type_code() == ::ot_array) {
597
18.0k
        return Array(obj)[n];
598
18.0k
    }
599
93.0k
    if (n < size()) {
600
231
        return *this;
601
231
    }
602
92.8k
    return {};
603
93.0k
}
604
605
QPDFObjectHandle
606
BaseHandle::operator[](int n) const
607
111k
{
608
111k
    if (n < 0) {
609
0
        return {};
610
0
    }
611
111k
    return (*this)[static_cast<size_t>(n)];
612
111k
}