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

realm / realm-core / 2618

20 Sep 2024 08:37AM UTC coverage: 91.095% (+0.001%) from 91.094%
2618

push

Evergreen

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

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

102792 of 181476 branches covered (56.64%)

217153 of 238382 relevant lines covered (91.09%)

5899459.08 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,033,002✔
27
{
20,179,554✔
28
    m_arr = new (&m_storage) ArrayStringShort(a, true);
20,179,554✔
29
}
20,179,554✔
30

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

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

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

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

81
void ArrayString::init_from_parent()
82
{
6,103,212✔
83
    ref_type ref = m_arr->get_ref_from_parent();
6,103,212✔
84
    init_from_ref(ref);
6,103,212✔
85
}
6,103,212✔
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,194,468✔
97
    m_arr->detach();
4,194,468✔
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,194,468✔
101
    m_type = Type::small_strings;
4,194,468✔
102
}
4,194,468✔
103

104
size_t ArrayString::size() const
105
{
16,461,279✔
106
    switch (m_type) {
16,461,279✔
107
        case Type::small_strings:
6,917,313✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
6,917,313✔
109
        case Type::medium_strings:
450,903✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
450,903✔
111
        case Type::big_strings:
9,161,400✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
9,161,400✔
113
        case Type::enum_strings:
246✔
114
            return static_cast<Array*>(m_arr)->size();
246✔
115
    }
16,461,279✔
116
    return {};
×
117
}
16,461,279✔
118

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

141
void ArrayString::set(size_t ndx, StringData value)
142
{
3,825,912✔
143
    switch (upgrade_leaf(value.size())) {
3,825,912✔
144
        case Type::small_strings:
578,412✔
145
            static_cast<ArrayStringShort*>(m_arr)->set(ndx, value);
578,412✔
146
            break;
578,412✔
147
        case Type::medium_strings:
238,623✔
148
            static_cast<ArraySmallBlobs*>(m_arr)->set_string(ndx, value);
238,623✔
149
            break;
238,623✔
150
        case Type::big_strings:
384,768✔
151
            static_cast<ArrayBigBlobs*>(m_arr)->set_string(ndx, value);
384,768✔
152
            break;
384,768✔
153
        case Type::enum_strings: {
2,625,711✔
154
            size_t sz = m_string_enum_values->size();
2,625,711✔
155
            size_t res = m_string_enum_values->find_first(value, 0, sz);
2,625,711✔
156
            if (res == realm::not_found) {
2,625,711✔
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,625,711✔
161
            break;
2,625,711✔
162
        }
×
163
    }
3,825,912✔
164
}
3,825,912✔
165

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

185
StringData ArrayString::get(size_t ndx) const
186
{
21,047,685✔
187
    switch (m_type) {
21,047,685✔
188
        case Type::small_strings:
11,051,001✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
11,051,001✔
190
        case Type::medium_strings:
910,611✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
910,611✔
192
        case Type::big_strings:
7,960,560✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
7,960,560✔
194
        case Type::enum_strings: {
1,149,051✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
1,149,051✔
196
            return m_string_enum_values->get(index);
1,149,051✔
197
        }
×
198
    }
21,047,685✔
199
    return {};
×
200
}
21,047,685✔
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,987✔
221
    return Mixed(get(ndx));
132,987✔
222
}
132,987✔
223

224
bool ArrayString::is_null(size_t ndx) const
225
{
4,003,740✔
226
    switch (m_type) {
4,003,740✔
227
        case Type::small_strings:
615,897✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
615,897✔
229
        case Type::medium_strings:
12,960✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
12,960✔
231
        case Type::big_strings:
3,374,889✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,374,889✔
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,003,740✔
238
    return {};
×
239
}
4,003,740✔
240

241
void ArrayString::erase(size_t ndx)
242
{
480,114✔
243
    switch (m_type) {
480,114✔
244
        case Type::small_strings:
388,497✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
388,497✔
246
            break;
388,497✔
247
        case Type::medium_strings:
57,255✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
57,255✔
249
            break;
57,255✔
250
        case Type::big_strings:
26,058✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
26,058✔
252
            break;
26,058✔
253
        case Type::enum_strings:
8,346✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,346✔
255
            break;
8,346✔
256
    }
480,114✔
257
}
480,114✔
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++) {
116,892✔
263
        dst.add(get(i));
115,818✔
264
    }
115,818✔
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,128,279✔
303
    switch (m_type) {
4,128,279✔
304
        case Type::small_strings:
3,151,902✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,151,902✔
306
        case Type::medium_strings: {
124,278✔
307
            BinaryData as_binary(value.data(), value.size());
124,278✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
124,278✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
256,401✔
312
            BinaryData as_binary(value.data(), value.size());
256,401✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
256,401✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
596,082✔
317
            size_t sz = m_string_enum_values->size();
596,082✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
596,082✔
319
            if (res != realm::not_found) {
596,082✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
596,082✔
321
            }
596,082✔
322
            break;
×
323
        }
596,082✔
324
    }
4,128,279✔
325
    return not_found;
×
326
}
4,128,279✔
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,887✔
353
            sz -= half + 1;
190,887✔
354
        }
190,887✔
355
        else {
340,119✔
356
            sz = half;
340,119✔
357
        }
340,119✔
358
    }
531,006✔
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,716,680✔
380
    if (m_type == Type::big_strings)
8,716,680✔
381
        return Type::big_strings;
1,259,841✔
382

383
    if (m_type == Type::enum_strings)
7,456,839✔
384
        return Type::enum_strings;
3,938,226✔
385

386
    if (m_type == Type::medium_strings) {
3,518,613✔
387
        if (value_size <= medium_string_max_size)
532,596✔
388
            return Type::medium_strings;
532,083✔
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,951✔
397
            big_blobs.add_string(string_medium->get_string(i)); // Throws
9,438✔
398
        }
9,438✔
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,596✔
411

412
    // m_type == Type::small
413
    if (value_size <= small_string_max_size)
2,986,017✔
414
        return Type::small_strings;
2,944,806✔
415

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

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

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

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

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

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

456
        m_type = Type::big_strings;
11,337✔
457
    }
11,337✔
458

459
    return m_type;
41,211✔
460
}
2,986,017✔
461

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