• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

realm / realm-core / 2115

08 Mar 2024 02:33PM UTC coverage: 90.924% (+0.004%) from 90.92%
2115

push

Evergreen

web-flow
Merge pull request #7436 from realm/release/14.2.0

Release core v14.2.0

93970 of 173178 branches covered (54.26%)

238539 of 262349 relevant lines covered (90.92%)

6184195.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.25
/src/realm/array_string.cpp
1
/*************************************************************************
2
 *
3
 * Copyright 2016 Realm Inc.
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 * http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 *
17
 **************************************************************************/
18

19
#include <realm/array_string.hpp>
20
#include <realm/spec.hpp>
21
#include <realm/mixed.hpp>
22

23
using namespace realm;
24

25
ArrayString::ArrayString(Allocator& a)
26
    : m_alloc(a)
27
{
12,632,493✔
28
    m_arr = new (&m_storage) ArrayStringShort(a, true);
12,632,493✔
29
}
12,632,493✔
30

31
void ArrayString::create()
32
{
229,038✔
33
    static_cast<ArrayStringShort*>(m_arr)->create();
229,038✔
34
}
229,038✔
35

36
void ArrayString::init_from_mem(MemRef mem) noexcept
37
{
11,266,203✔
38
    char* header = mem.get_addr();
11,266,203✔
39

5,572,143✔
40
    ArrayParent* parent = m_arr->get_parent();
11,266,203✔
41
    size_t ndx_in_parent = m_arr->get_ndx_in_parent();
11,266,203✔
42

5,572,143✔
43
    bool long_strings = Array::get_hasrefs_from_header(header);
11,266,203✔
44
    if (!long_strings) {
11,266,203✔
45
        // Small strings
4,194,027✔
46
        bool is_small = Array::get_wtype_from_header(header) == Array::wtype_Multiply;
8,508,144✔
47
        if (is_small) {
8,508,144✔
48
            auto arr = new (&m_storage) ArrayStringShort(m_alloc, m_nullable);
4,805,388✔
49
            arr->init_from_mem(mem);
4,805,388✔
50
            m_type = Type::small_strings;
4,805,388✔
51
        }
4,805,388✔
52
        else {
3,702,756✔
53
            auto arr = new (&m_storage) Array(m_alloc);
3,702,756✔
54
            arr->init_from_mem(mem);
3,702,756✔
55
            m_string_enum_values = std::make_unique<ArrayString>(m_alloc);
3,702,756✔
56
            ArrayParent* p;
3,702,756✔
57
            REALM_ASSERT(m_spec != nullptr);
3,702,756✔
58
            REALM_ASSERT(m_col_ndx != realm::npos);
3,702,756✔
59
            ref_type r = m_spec->get_enumkeys_ref(m_col_ndx, p);
3,702,756✔
60
            m_string_enum_values->init_from_ref(r);
3,702,756✔
61
            m_string_enum_values->set_parent(p, m_col_ndx);
3,702,756✔
62
            m_type = Type::enum_strings;
3,702,756✔
63
        }
3,702,756✔
64
    }
8,508,144✔
65
    else {
2,758,059✔
66
        bool is_big = Array::get_context_flag_from_header(header);
2,758,059✔
67
        if (!is_big) {
2,758,059✔
68
            auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
679,683✔
69
            arr->init_from_mem(mem);
679,683✔
70
            m_type = Type::medium_strings;
679,683✔
71
        }
679,683✔
72
        else {
2,078,376✔
73
            auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, m_nullable);
2,078,376✔
74
            arr->init_from_mem(mem);
2,078,376✔
75
            m_type = Type::big_strings;
2,078,376✔
76
        }
2,078,376✔
77
    }
2,758,059✔
78
    m_arr->set_parent(parent, ndx_in_parent);
11,266,203✔
79
}
11,266,203✔
80

81
void ArrayString::init_from_parent()
82
{
5,081,856✔
83
    ref_type ref = m_arr->get_ref_from_parent();
5,081,856✔
84
    init_from_ref(ref);
5,081,856✔
85
}
5,081,856✔
86

87
void ArrayString::destroy() noexcept
88
{
606✔
89
    if (m_arr->is_attached()) {
606✔
90
        Array::destroy_deep(m_arr->get_ref(), m_alloc);
438✔
91
        detach();
438✔
92
    }
438✔
93
}
606✔
94

95
void ArrayString::detach() noexcept
96
{
326,892✔
97
    m_arr->detach();
326,892✔
98
    // Make sure the object is in a state like right after construction
163,098✔
99
    // Next call must be to create()
163,098✔
100
    m_arr = new (&m_storage) ArrayStringShort(m_alloc, true);
326,892✔
101
    m_type = Type::small_strings;
326,892✔
102
}
326,892✔
103

104
size_t ArrayString::size() const
105
{
13,721,328✔
106
    switch (m_type) {
13,721,328✔
107
        case Type::small_strings:
4,639,332✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
4,639,332✔
109
        case Type::medium_strings:
438,588✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
438,588✔
111
        case Type::big_strings:
8,650,149✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
8,650,149✔
113
        case Type::enum_strings:
246✔
114
            return static_cast<Array*>(m_arr)->size();
246✔
115
    }
×
116
    return {};
×
117
}
×
118

119
void ArrayString::add(StringData value)
120
{
134,583✔
121
    switch (upgrade_leaf(value.size())) {
134,583✔
122
        case Type::small_strings:
79,056✔
123
            static_cast<ArrayStringShort*>(m_arr)->add(value);
79,056✔
124
            break;
79,056✔
125
        case Type::medium_strings:
27,951✔
126
            static_cast<ArraySmallBlobs*>(m_arr)->add_string(value);
27,951✔
127
            break;
27,951✔
128
        case Type::big_strings:
27,576✔
129
            static_cast<ArrayBigBlobs*>(m_arr)->add_string(value);
27,576✔
130
            break;
27,576✔
131
        case Type::enum_strings: {
✔
132
            auto a = static_cast<Array*>(m_arr);
×
133
            size_t ndx = a->size();
×
134
            a->add(0);
×
135
            set(ndx, value);
×
136
            break;
×
137
        }
×
138
    }
134,583✔
139
}
134,583✔
140

141
void ArrayString::set(size_t ndx, StringData value)
142
{
3,742,638✔
143
    switch (upgrade_leaf(value.size())) {
3,742,638✔
144
        case Type::small_strings:
506,913✔
145
            static_cast<ArrayStringShort*>(m_arr)->set(ndx, value);
506,913✔
146
            break;
506,913✔
147
        case Type::medium_strings:
234,381✔
148
            static_cast<ArraySmallBlobs*>(m_arr)->set_string(ndx, value);
234,381✔
149
            break;
234,381✔
150
        case Type::big_strings:
377,178✔
151
            static_cast<ArrayBigBlobs*>(m_arr)->set_string(ndx, value);
377,178✔
152
            break;
377,178✔
153
        case Type::enum_strings: {
2,625,744✔
154
            size_t sz = m_string_enum_values->size();
2,625,744✔
155
            size_t res = m_string_enum_values->find_first(value, 0, sz);
2,625,744✔
156
            if (res == realm::not_found) {
2,625,744✔
157
                m_string_enum_values->add(value);
9,687✔
158
                res = sz;
9,687✔
159
            }
9,687✔
160
            static_cast<Array*>(m_arr)->set(ndx, res);
2,625,744✔
161
            break;
2,625,744✔
162
        }
×
163
    }
3,742,638✔
164
}
3,742,638✔
165

166
void ArrayString::insert(size_t ndx, StringData value)
167
{
3,438,690✔
168
    switch (upgrade_leaf(value.size())) {
3,438,690✔
169
        case Type::small_strings:
1,037,988✔
170
            static_cast<ArrayStringShort*>(m_arr)->insert(ndx, value);
1,037,988✔
171
            break;
1,037,988✔
172
        case Type::medium_strings:
283,176✔
173
            static_cast<ArraySmallBlobs*>(m_arr)->insert_string(ndx, value);
283,176✔
174
            break;
283,176✔
175
        case Type::big_strings:
805,629✔
176
            static_cast<ArrayBigBlobs*>(m_arr)->insert_string(ndx, value);
805,629✔
177
            break;
805,629✔
178
        case Type::enum_strings: {
1,312,809✔
179
            static_cast<Array*>(m_arr)->insert(ndx, 0);
1,312,809✔
180
            set(ndx, value);
1,312,809✔
181
        }
1,312,809✔
182
    }
3,438,690✔
183
}
3,438,690✔
184

185
StringData ArrayString::get(size_t ndx) const
186
{
19,260,141✔
187
    switch (m_type) {
19,260,141✔
188
        case Type::small_strings:
9,558,396✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
9,558,396✔
190
        case Type::medium_strings:
905,268✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
905,268✔
192
        case Type::big_strings:
7,658,079✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
7,658,079✔
194
        case Type::enum_strings: {
1,141,779✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
1,141,779✔
196
            return m_string_enum_values->get(index);
1,141,779✔
197
        }
×
198
    }
×
199
    return {};
×
200
}
×
201

202
StringData ArrayString::get_legacy(size_t ndx) const
203
{
×
204
    switch (m_type) {
×
205
        case Type::small_strings:
×
206
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
×
207
        case Type::medium_strings:
×
208
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string_legacy(ndx);
×
209
        case Type::big_strings:
×
210
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
×
211
        case Type::enum_strings: {
×
212
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
×
213
            return m_string_enum_values->get(index);
×
214
        }
×
215
    }
×
216
    return {};
×
217
}
×
218

219
Mixed ArrayString::get_any(size_t ndx) const
220
{
132,780✔
221
    return Mixed(get(ndx));
132,780✔
222
}
132,780✔
223

224
bool ArrayString::is_null(size_t ndx) const
225
{
4,059,090✔
226
    switch (m_type) {
4,059,090✔
227
        case Type::small_strings:
712,941✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
712,941✔
229
        case Type::medium_strings:
16,713✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
16,713✔
231
        case Type::big_strings:
3,331,170✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,331,170✔
233
        case Type::enum_strings: {
✔
234
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
×
235
            return m_string_enum_values->is_null(index);
×
236
        }
×
237
    }
×
238
    return {};
×
239
}
×
240

241
void ArrayString::erase(size_t ndx)
242
{
128,613✔
243
    switch (m_type) {
128,613✔
244
        case Type::small_strings:
36,054✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
36,054✔
246
            break;
36,054✔
247
        case Type::medium_strings:
58,350✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
58,350✔
249
            break;
58,350✔
250
        case Type::big_strings:
25,848✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
25,848✔
252
            break;
25,848✔
253
        case Type::enum_strings:
8,361✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,361✔
255
            break;
8,361✔
256
    }
128,613✔
257
}
128,613✔
258

259
void ArrayString::move(ArrayString& dst, size_t ndx)
260
{
66✔
261
    size_t sz = size();
66✔
262
    for (size_t i = ndx; i < sz; i++) {
20,730✔
263
        dst.add(get(i));
20,664✔
264
    }
20,664✔
265

33✔
266
    switch (m_type) {
66✔
267
        case Type::small_strings:
✔
268
            static_cast<ArrayStringShort*>(m_arr)->truncate(ndx);
×
269
            break;
×
270
        case Type::medium_strings:
60✔
271
            static_cast<ArraySmallBlobs*>(m_arr)->truncate(ndx);
60✔
272
            break;
60✔
273
        case Type::big_strings:
6✔
274
            static_cast<ArrayBigBlobs*>(m_arr)->truncate(ndx);
6✔
275
            break;
6✔
276
        case Type::enum_strings:
✔
277
            // this operation will never be called for enumerated columns
278
            REALM_UNREACHABLE();
279
            break;
×
280
    }
66✔
281
}
66✔
282

283
void ArrayString::clear()
284
{
354✔
285
    switch (m_type) {
354✔
286
        case Type::small_strings:
300✔
287
            static_cast<ArrayStringShort*>(m_arr)->clear();
300✔
288
            break;
300✔
289
        case Type::medium_strings:
6✔
290
            static_cast<ArraySmallBlobs*>(m_arr)->clear();
6✔
291
            break;
6✔
292
        case Type::big_strings:
48✔
293
            static_cast<ArrayBigBlobs*>(m_arr)->clear();
48✔
294
            break;
48✔
295
        case Type::enum_strings:
✔
296
            static_cast<Array*>(m_arr)->clear();
×
297
            break;
×
298
    }
354✔
299
}
354✔
300

301
size_t ArrayString::find_first(StringData value, size_t begin, size_t end) const noexcept
302
{
4,076,925✔
303
    switch (m_type) {
4,076,925✔
304
        case Type::small_strings:
3,121,137✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,121,137✔
306
        case Type::medium_strings: {
105,786✔
307
            BinaryData as_binary(value.data(), value.size());
105,786✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
105,786✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
254,082✔
312
            BinaryData as_binary(value.data(), value.size());
254,082✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
254,082✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
596,181✔
317
            size_t sz = m_string_enum_values->size();
596,181✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
596,181✔
319
            if (res != realm::not_found) {
596,181✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
596,181✔
321
            }
596,181✔
322
            break;
×
323
        }
×
324
    }
×
325
    return not_found;
×
326
}
×
327

328
namespace {
329

330
template <class T>
331
inline StringData get_string(const T* arr, size_t ndx)
332
{
437,337✔
333
    return arr->get_string(ndx);
437,337✔
334
}
437,337✔
335

336
template <>
337
inline StringData get_string(const ArrayStringShort* arr, size_t ndx)
338
{
93,669✔
339
    return arr->get(ndx);
93,669✔
340
}
93,669✔
341

342
template <class T, class U>
343
size_t lower_bound_string(const T* arr, U value)
344
{
234,912✔
345
    size_t i = 0;
234,912✔
346
    size_t sz = arr->size();
234,912✔
347
    while (0 < sz) {
765,918✔
348
        size_t half = sz / 2;
531,006✔
349
        size_t mid = i + half;
531,006✔
350
        auto probe = get_string(arr, mid);
531,006✔
351
        if (probe < value) {
531,006✔
352
            i = mid + 1;
190,857✔
353
            sz -= half + 1;
190,857✔
354
        }
190,857✔
355
        else {
340,149✔
356
            sz = half;
340,149✔
357
        }
340,149✔
358
    }
531,006✔
359
    return i;
234,912✔
360
}
234,912✔
361
}
362

363
size_t ArrayString::lower_bound(StringData value)
364
{
234,912✔
365
    switch (m_type) {
234,912✔
366
        case Type::small_strings:
58,434✔
367
            return lower_bound_string(static_cast<ArrayStringShort*>(m_arr), value);
58,434✔
368
        case Type::medium_strings:
68,418✔
369
            return lower_bound_string(static_cast<ArraySmallBlobs*>(m_arr), value);
68,418✔
370
        case Type::big_strings:
108,060✔
371
            return lower_bound_string(static_cast<ArrayBigBlobs*>(m_arr), value);
108,060✔
372
        case Type::enum_strings:
✔
373
            break;
×
374
    }
×
375
    return realm::npos;
×
376
}
×
377

378
ArrayString::Type ArrayString::upgrade_leaf(size_t value_size)
379
{
7,313,526✔
380
    if (m_type == Type::big_strings)
7,313,526✔
381
        return Type::big_strings;
1,190,100✔
382

2,998,827✔
383
    if (m_type == Type::enum_strings)
6,123,426✔
384
        return Type::enum_strings;
3,938,550✔
385

1,029,528✔
386
    if (m_type == Type::medium_strings) {
2,184,876✔
387
        if (value_size <= medium_string_max_size)
528,975✔
388
            return Type::medium_strings;
528,459✔
389

249✔
390
        // Upgrade root leaf from medium to big strings
249✔
391
        auto string_medium = static_cast<ArraySmallBlobs*>(m_arr);
516✔
392
        ArrayBigBlobs big_blobs(m_alloc, true);
516✔
393
        big_blobs.create(); // Throws
516✔
394

249✔
395
        size_t n = string_medium->size();
516✔
396
        for (size_t i = 0; i < n; i++) {
10,152✔
397
            big_blobs.add_string(string_medium->get_string(i)); // Throws
9,636✔
398
        }
9,636✔
399
        auto parent = string_medium->get_parent();
516✔
400
        auto ndx_in_parent = string_medium->get_ndx_in_parent();
516✔
401
        string_medium->destroy();
516✔
402

249✔
403
        auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, true);
516✔
404
        arr->init_from_mem(big_blobs.get_mem());
516✔
405
        arr->set_parent(parent, ndx_in_parent);
516✔
406
        arr->update_parent();
516✔
407

249✔
408
        m_type = Type::big_strings;
516✔
409
        return Type::big_strings;
516✔
410
    }
516✔
411

765,024✔
412
    // m_type == Type::small
765,024✔
413
    if (value_size <= small_string_max_size)
1,655,901✔
414
        return Type::small_strings;
1,623,648✔
415

17,067✔
416
    if (value_size <= medium_string_max_size) {
32,253✔
417
        // Upgrade root leaf from small to medium strings
8,367✔
418
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
17,049✔
419
        ArraySmallBlobs string_long(m_alloc);
17,049✔
420
        string_long.create(); // Throws
17,049✔
421

8,367✔
422
        size_t n = string_short->size();
17,049✔
423
        for (size_t i = 0; i < n; i++) {
38,487✔
424
            string_long.add_string(string_short->get(i)); // Throws
21,438✔
425
        }
21,438✔
426
        auto parent = string_short->get_parent();
17,049✔
427
        auto ndx_in_parent = string_short->get_ndx_in_parent();
17,049✔
428
        string_short->destroy();
17,049✔
429

8,367✔
430
        auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
17,049✔
431
        arr->init_from_mem(string_long.get_mem());
17,049✔
432
        arr->set_parent(parent, ndx_in_parent);
17,049✔
433
        arr->update_parent();
17,049✔
434

8,367✔
435
        m_type = Type::medium_strings;
17,049✔
436
    }
17,049✔
437
    else {
15,204✔
438
        // Upgrade root leaf from small to big strings
8,700✔
439
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
15,204✔
440
        ArrayBigBlobs big_blobs(m_alloc, true);
15,204✔
441
        big_blobs.create(); // Throws
15,204✔
442

8,700✔
443
        size_t n = string_short->size();
15,204✔
444
        for (size_t i = 0; i < n; i++) {
35,289✔
445
            big_blobs.add_string(string_short->get(i)); // Throws
20,085✔
446
        }
20,085✔
447
        auto parent = string_short->get_parent();
15,204✔
448
        auto ndx_in_parent = string_short->get_ndx_in_parent();
15,204✔
449
        string_short->destroy();
15,204✔
450

8,700✔
451
        auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, true);
15,204✔
452
        arr->init_from_mem(big_blobs.get_mem());
15,204✔
453
        arr->set_parent(parent, ndx_in_parent);
15,204✔
454
        arr->update_parent();
15,204✔
455

8,700✔
456
        m_type = Type::big_strings;
15,204✔
457
    }
15,204✔
458

17,067✔
459
    return m_type;
32,253✔
460
}
32,253✔
461

462
void ArrayString::verify() const
463
{
164,223✔
464
#ifdef REALM_DEBUG
164,223✔
465
    switch (m_type) {
164,223✔
466
        case Type::small_strings:
157,812✔
467
            static_cast<ArrayStringShort*>(m_arr)->verify();
157,812✔
468
            break;
157,812✔
469
        case Type::medium_strings:
1,023✔
470
            static_cast<ArraySmallBlobs*>(m_arr)->verify();
1,023✔
471
            break;
1,023✔
472
        case Type::big_strings:
5,142✔
473
            static_cast<ArrayBigBlobs*>(m_arr)->verify();
5,142✔
474
            break;
5,142✔
475
        case Type::enum_strings:
246✔
476
            static_cast<Array*>(m_arr)->verify();
246✔
477
            break;
246✔
478
    }
164,223✔
479
#endif
164,223✔
480
}
164,223✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc