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

realm / realm-core / 2615

20 Sep 2024 08:37AM UTC coverage: 91.109% (+0.02%) from 91.094%
2615

push

Evergreen

web-flow
New changelog section to prepare for vNext (#8031)

Co-authored-by: jedelbo <572755+jedelbo@users.noreply.github.com>

102798 of 181476 branches covered (56.65%)

217193 of 238389 relevant lines covered (91.11%)

5690059.37 hits per line

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

88.03
/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)
10,062,492✔
27
{
20,239,287✔
28
    m_arr = new (&m_storage) ArrayStringShort(a, true);
20,239,287✔
29
}
20,239,287✔
30

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

36
void ArrayString::init_from_mem(MemRef mem) noexcept
37
{
13,076,565✔
38
    char* header = mem.get_addr();
13,076,565✔
39

40
    ArrayParent* parent = m_arr->get_parent();
13,076,565✔
41
    size_t ndx_in_parent = m_arr->get_ndx_in_parent();
13,076,565✔
42

43
    bool long_strings = Array::get_hasrefs_from_header(header);
13,076,565✔
44
    if (!long_strings) {
13,076,565✔
45
        // Small strings
46
        bool is_small = Array::get_wtype_from_header(header) == Array::wtype_Multiply;
10,262,433✔
47
        if (is_small) {
10,262,433✔
48
            auto arr = new (&m_storage) ArrayStringShort(m_alloc, m_nullable);
6,556,482✔
49
            arr->init_from_mem(mem);
6,556,482✔
50
            m_type = Type::small_strings;
6,556,482✔
51
        }
6,556,482✔
52
        else {
3,705,951✔
53
            auto arr = new (&m_storage) Array(m_alloc);
3,705,951✔
54
            arr->init_from_mem(mem);
3,705,951✔
55
            m_string_enum_values = std::make_unique<ArrayString>(m_alloc);
3,705,951✔
56
            ArrayParent* p;
3,705,951✔
57
            REALM_ASSERT(m_spec != nullptr);
3,705,951✔
58
            REALM_ASSERT(m_col_ndx != realm::npos);
3,705,951✔
59
            ref_type r = m_spec->get_enumkeys_ref(m_col_ndx, p);
3,705,951✔
60
            m_string_enum_values->init_from_ref(r);
3,705,951✔
61
            m_string_enum_values->set_parent(p, m_col_ndx);
3,705,951✔
62
            m_type = Type::enum_strings;
3,705,951✔
63
        }
3,705,951✔
64
    }
10,262,433✔
65
    else {
2,814,132✔
66
        bool is_big = Array::get_context_flag_from_header(header);
2,814,132✔
67
        if (!is_big) {
2,814,132✔
68
            auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
700,506✔
69
            arr->init_from_mem(mem);
700,506✔
70
            m_type = Type::medium_strings;
700,506✔
71
        }
700,506✔
72
        else {
2,113,626✔
73
            auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, m_nullable);
2,113,626✔
74
            arr->init_from_mem(mem);
2,113,626✔
75
            m_type = Type::big_strings;
2,113,626✔
76
        }
2,113,626✔
77
    }
2,814,132✔
78
    m_arr->set_parent(parent, ndx_in_parent);
13,076,565✔
79
}
13,076,565✔
80

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

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

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

104
size_t ArrayString::size() const
105
{
16,469,415✔
106
    switch (m_type) {
16,469,415✔
107
        case Type::small_strings:
6,942,378✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
6,942,378✔
109
        case Type::medium_strings:
454,590✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
454,590✔
111
        case Type::big_strings:
9,114,636✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
9,114,636✔
113
        case Type::enum_strings:
246✔
114
            return static_cast<Array*>(m_arr)->size();
246✔
115
    }
16,469,415✔
116
    return {};
×
117
}
16,469,415✔
118

119
void ArrayString::add(StringData value)
120
{
447,066✔
121
    switch (upgrade_leaf(value.size())) {
447,066✔
122
        case Type::small_strings:
390,492✔
123
            static_cast<ArrayStringShort*>(m_arr)->add(value);
390,492✔
124
            break;
390,492✔
125
        case Type::medium_strings:
28,185✔
126
            static_cast<ArraySmallBlobs*>(m_arr)->add_string(value);
28,185✔
127
            break;
28,185✔
128
        case Type::big_strings:
28,395✔
129
            static_cast<ArrayBigBlobs*>(m_arr)->add_string(value);
28,395✔
130
            break;
28,395✔
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
    }
447,066✔
139
}
447,066✔
140

141
void ArrayString::set(size_t ndx, StringData value)
142
{
3,821,157✔
143
    switch (upgrade_leaf(value.size())) {
3,821,157✔
144
        case Type::small_strings:
573,651✔
145
            static_cast<ArrayStringShort*>(m_arr)->set(ndx, value);
573,651✔
146
            break;
573,651✔
147
        case Type::medium_strings:
238,272✔
148
            static_cast<ArraySmallBlobs*>(m_arr)->set_string(ndx, value);
238,272✔
149
            break;
238,272✔
150
        case Type::big_strings:
385,134✔
151
            static_cast<ArrayBigBlobs*>(m_arr)->set_string(ndx, value);
385,134✔
152
            break;
385,134✔
153
        case Type::enum_strings: {
2,626,008✔
154
            size_t sz = m_string_enum_values->size();
2,626,008✔
155
            size_t res = m_string_enum_values->find_first(value, 0, sz);
2,626,008✔
156
            if (res == realm::not_found) {
2,626,008✔
157
                m_string_enum_values->add(value);
9,714✔
158
                res = sz;
9,714✔
159
            }
9,714✔
160
            static_cast<Array*>(m_arr)->set(ndx, res);
2,626,008✔
161
            break;
2,626,008✔
162
        }
×
163
    }
3,821,157✔
164
}
3,821,157✔
165

166
void ArrayString::insert(size_t ndx, StringData value)
167
{
4,447,713✔
168
    switch (upgrade_leaf(value.size())) {
4,447,713✔
169
        case Type::small_strings:
1,972,971✔
170
            static_cast<ArrayStringShort*>(m_arr)->insert(ndx, value);
1,972,971✔
171
            break;
1,972,971✔
172
        case Type::medium_strings:
295,164✔
173
            static_cast<ArraySmallBlobs*>(m_arr)->insert_string(ndx, value);
295,164✔
174
            break;
295,164✔
175
        case Type::big_strings:
867,678✔
176
            static_cast<ArrayBigBlobs*>(m_arr)->insert_string(ndx, value);
867,678✔
177
            break;
867,678✔
178
        case Type::enum_strings: {
1,312,959✔
179
            static_cast<Array*>(m_arr)->insert(ndx, 0);
1,312,959✔
180
            set(ndx, value);
1,312,959✔
181
        }
1,312,959✔
182
    }
4,447,713✔
183
}
4,447,713✔
184

185
StringData ArrayString::get(size_t ndx) const
186
{
20,977,662✔
187
    switch (m_type) {
20,977,662✔
188
        case Type::small_strings:
11,044,515✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
11,044,515✔
190
        case Type::medium_strings:
887,361✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
887,361✔
192
        case Type::big_strings:
7,914,591✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
7,914,591✔
194
        case Type::enum_strings: {
1,147,860✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
1,147,860✔
196
            return m_string_enum_values->get(index);
1,147,860✔
197
        }
×
198
    }
20,977,662✔
199
    return {};
×
200
}
20,977,662✔
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
{
134,604✔
221
    return Mixed(get(ndx));
134,604✔
222
}
134,604✔
223

224
bool ArrayString::is_null(size_t ndx) const
225
{
4,083,942✔
226
    switch (m_type) {
4,083,942✔
227
        case Type::small_strings:
633,465✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
633,465✔
229
        case Type::medium_strings:
15,333✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
15,333✔
231
        case Type::big_strings:
3,435,192✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,435,192✔
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
    }
4,083,942✔
238
    return {};
×
239
}
4,083,942✔
240

241
void ArrayString::erase(size_t ndx)
242
{
481,440✔
243
    switch (m_type) {
481,440✔
244
        case Type::small_strings:
389,568✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
389,568✔
246
            break;
389,568✔
247
        case Type::medium_strings:
57,081✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
57,081✔
249
            break;
57,081✔
250
        case Type::big_strings:
26,358✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
26,358✔
252
            break;
26,358✔
253
        case Type::enum_strings:
8,478✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,478✔
255
            break;
8,478✔
256
    }
481,440✔
257
}
481,440✔
258

259
void ArrayString::move(ArrayString& dst, size_t ndx)
260
{
1,074✔
261
    size_t sz = size();
1,074✔
262
    for (size_t i = ndx; i < sz; i++) {
115,698✔
263
        dst.add(get(i));
114,624✔
264
    }
114,624✔
265

266
    switch (m_type) {
1,074✔
267
        case Type::small_strings:
1,008✔
268
            static_cast<ArrayStringShort*>(m_arr)->truncate(ndx);
1,008✔
269
            break;
1,008✔
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
    }
1,074✔
281
}
1,074✔
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,130,619✔
303
    switch (m_type) {
4,130,619✔
304
        case Type::small_strings:
3,151,704✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,151,704✔
306
        case Type::medium_strings: {
124,704✔
307
            BinaryData as_binary(value.data(), value.size());
124,704✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
124,704✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
257,001✔
312
            BinaryData as_binary(value.data(), value.size());
257,001✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
257,001✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
597,846✔
317
            size_t sz = m_string_enum_values->size();
597,846✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
597,846✔
319
            if (res != realm::not_found) {
597,846✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
597,846✔
321
            }
597,846✔
322
            break;
×
323
        }
597,846✔
324
    }
4,130,619✔
325
    return not_found;
×
326
}
4,130,619✔
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,681✔
339
    return arr->get(ndx);
93,681✔
340
}
93,681✔
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,930✔
348
        size_t half = sz / 2;
531,018✔
349
        size_t mid = i + half;
531,018✔
350
        auto probe = get_string(arr, mid);
531,018✔
351
        if (probe < value) {
531,018✔
352
            i = mid + 1;
190,857✔
353
            sz -= half + 1;
190,857✔
354
        }
190,857✔
355
        else {
340,161✔
356
            sz = half;
340,161✔
357
        }
340,161✔
358
    }
531,018✔
359
    return i;
234,912✔
360
}
234,912✔
361
} // namespace
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
    }
234,912✔
375
    return realm::npos;
×
376
}
234,912✔
377

378
ArrayString::Type ArrayString::upgrade_leaf(size_t value_size)
379
{
8,711,661✔
380
    if (m_type == Type::big_strings)
8,711,661✔
381
        return Type::big_strings;
1,260,462✔
382

383
    if (m_type == Type::enum_strings)
7,451,199✔
384
        return Type::enum_strings;
3,938,889✔
385

386
    if (m_type == Type::medium_strings) {
3,512,310✔
387
        if (value_size <= medium_string_max_size)
532,248✔
388
            return Type::medium_strings;
531,735✔
389

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

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

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

408
        m_type = Type::big_strings;
513✔
409
        return Type::big_strings;
513✔
410
    }
532,248✔
411

412
    // m_type == Type::small
413
    if (value_size <= small_string_max_size)
2,980,062✔
414
        return Type::small_strings;
2,936,085✔
415

416
    if (value_size <= medium_string_max_size) {
43,977✔
417
        // Upgrade root leaf from small to medium strings
418
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
29,877✔
419
        ArraySmallBlobs string_long(m_alloc);
29,877✔
420
        string_long.create(); // Throws
29,877✔
421

422
        size_t n = string_short->size();
29,877✔
423
        for (size_t i = 0; i < n; i++) {
52,611✔
424
            string_long.add_string(string_short->get(i)); // Throws
22,734✔
425
        }
22,734✔
426
        auto parent = string_short->get_parent();
29,877✔
427
        auto ndx_in_parent = string_short->get_ndx_in_parent();
29,877✔
428
        string_short->destroy();
29,877✔
429

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

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

443
        size_t n = string_short->size();
14,100✔
444
        for (size_t i = 0; i < n; i++) {
34,488✔
445
            big_blobs.add_string(string_short->get(i)); // Throws
20,388✔
446
        }
20,388✔
447
        auto parent = string_short->get_parent();
14,100✔
448
        auto ndx_in_parent = string_short->get_ndx_in_parent();
14,100✔
449
        string_short->destroy();
14,100✔
450

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

456
        m_type = Type::big_strings;
14,100✔
457
    }
14,100✔
458

459
    return m_type;
43,977✔
460
}
2,980,062✔
461

462
void ArrayString::verify() const
463
{
220,491✔
464
#ifdef REALM_DEBUG
220,491✔
465
    switch (m_type) {
220,491✔
466
        case Type::small_strings:
214,038✔
467
            static_cast<ArrayStringShort*>(m_arr)->verify();
214,038✔
468
            break;
214,038✔
469
        case Type::medium_strings:
759✔
470
            static_cast<ArraySmallBlobs*>(m_arr)->verify();
759✔
471
            break;
759✔
472
        case Type::big_strings:
5,448✔
473
            static_cast<ArrayBigBlobs*>(m_arr)->verify();
5,448✔
474
            break;
5,448✔
475
        case Type::enum_strings:
246✔
476
            static_cast<Array*>(m_arr)->verify();
246✔
477
            break;
246✔
478
    }
220,491✔
479
#endif
220,491✔
480
}
220,491✔
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

© 2025 Coveralls, Inc