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

realm / realm-core / 1896

06 Dec 2023 12:17PM UTC coverage: 91.685% (-0.01%) from 91.698%
1896

push

Evergreen

web-flow
Harmonize check on class name length (#7175)

92342 of 169332 branches covered (0.0%)

2 of 2 new or added lines in 2 files covered. (100.0%)

71 existing lines in 14 files now uncovered.

231993 of 253034 relevant lines covered (91.68%)

6494056.8 hits per line

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

88.0
/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
{
20,055,135✔
28
    m_arr = new (&m_storage.m_string_short) ArrayStringShort(a, true);
20,055,135✔
29
}
20,055,135✔
30

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

36
void ArrayString::init_from_mem(MemRef mem) noexcept
37
{
17,993,946✔
38
    char* header = mem.get_addr();
17,993,946✔
39

8,903,343✔
40
    ArrayParent* parent = m_arr->get_parent();
17,993,946✔
41
    size_t ndx_in_parent = m_arr->get_ndx_in_parent();
17,993,946✔
42

8,903,343✔
43
    bool long_strings = Array::get_hasrefs_from_header(header);
17,993,946✔
44
    if (!long_strings) {
17,993,946✔
45
        // Small strings
6,564,756✔
46
        bool is_small = Array::get_wtype_from_header(header) == Array::wtype_Multiply;
13,298,511✔
47
        if (is_small) {
13,298,511✔
48
            auto arr = new (&m_storage.m_string_short) ArrayStringShort(m_alloc, m_nullable);
7,623,795✔
49
            arr->init_from_mem(mem);
7,623,795✔
50
            m_type = Type::small_strings;
7,623,795✔
51
        }
7,623,795✔
52
        else {
5,674,716✔
53
            auto arr = new (&m_storage.m_enum) Array(m_alloc);
5,674,716✔
54
            arr->init_from_mem(mem);
5,674,716✔
55
            m_string_enum_values = std::make_unique<ArrayString>(m_alloc);
5,674,716✔
56
            ArrayParent* p;
5,674,716✔
57
            REALM_ASSERT(m_spec != nullptr);
5,674,716✔
58
            REALM_ASSERT(m_col_ndx != realm::npos);
5,674,716✔
59
            ref_type r = m_spec->get_enumkeys_ref(m_col_ndx, p);
5,674,716✔
60
            m_string_enum_values->init_from_ref(r);
5,674,716✔
61
            m_string_enum_values->set_parent(p, m_col_ndx);
5,674,716✔
62
            m_type = Type::enum_strings;
5,674,716✔
63
        }
5,674,716✔
64
    }
13,298,511✔
65
    else {
4,695,435✔
66
        bool is_big = Array::get_context_flag_from_header(header);
4,695,435✔
67
        if (!is_big) {
4,695,435✔
68
            auto arr = new (&m_storage.m_string_long) ArraySmallBlobs(m_alloc);
1,207,407✔
69
            arr->init_from_mem(mem);
1,207,407✔
70
            m_type = Type::medium_strings;
1,207,407✔
71
        }
1,207,407✔
72
        else {
3,488,028✔
73
            auto arr = new (&m_storage.m_big_blobs) ArrayBigBlobs(m_alloc, m_nullable);
3,488,028✔
74
            arr->init_from_mem(mem);
3,488,028✔
75
            m_type = Type::big_strings;
3,488,028✔
76
        }
3,488,028✔
77
    }
4,695,435✔
78
    m_arr->set_parent(parent, ndx_in_parent);
17,993,946✔
79
}
17,993,946✔
80

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

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

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

104
size_t ArrayString::size() const
105
{
15,423,126✔
106
    switch (m_type) {
15,423,126✔
107
        case Type::small_strings:
6,826,185✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
6,826,185✔
109
        case Type::medium_strings:
432,720✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
432,720✔
111
        case Type::big_strings:
8,164,977✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
8,164,977✔
113
        case Type::enum_strings:
282✔
114
            return static_cast<Array*>(m_arr)->size();
282✔
115
    }
×
116
    return {};
×
117
}
×
118

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

141
void ArrayString::set(size_t ndx, StringData value)
142
{
3,829,494✔
143
    switch (upgrade_leaf(value.size())) {
3,829,494✔
144
        case Type::small_strings:
536,883✔
145
            static_cast<ArrayStringShort*>(m_arr)->set(ndx, value);
536,883✔
146
            break;
536,883✔
147
        case Type::medium_strings:
247,527✔
148
            static_cast<ArraySmallBlobs*>(m_arr)->set_string(ndx, value);
247,527✔
149
            break;
247,527✔
150
        case Type::big_strings:
421,374✔
151
            static_cast<ArrayBigBlobs*>(m_arr)->set_string(ndx, value);
421,374✔
152
            break;
421,374✔
153
        case Type::enum_strings: {
2,625,444✔
154
            size_t sz = m_string_enum_values->size();
2,625,444✔
155
            size_t res = m_string_enum_values->find_first(value, 0, sz);
2,625,444✔
156
            if (res == realm::not_found) {
2,625,444✔
157
                m_string_enum_values->add(value);
9,663✔
158
                res = sz;
9,663✔
159
            }
9,663✔
160
            static_cast<Array*>(m_arr)->set(ndx, res);
2,625,444✔
161
            break;
2,625,444✔
162
        }
×
163
    }
3,829,494✔
164
}
3,829,494✔
165

166
void ArrayString::insert(size_t ndx, StringData value)
167
{
3,371,226✔
168
    switch (upgrade_leaf(value.size())) {
3,371,226✔
169
        case Type::small_strings:
1,028,997✔
170
            static_cast<ArrayStringShort*>(m_arr)->insert(ndx, value);
1,028,997✔
171
            break;
1,028,997✔
172
        case Type::medium_strings:
285,711✔
173
            static_cast<ArraySmallBlobs*>(m_arr)->insert_string(ndx, value);
285,711✔
174
            break;
285,711✔
175
        case Type::big_strings:
745,269✔
176
            static_cast<ArrayBigBlobs*>(m_arr)->insert_string(ndx, value);
745,269✔
177
            break;
745,269✔
178
        case Type::enum_strings: {
1,312,734✔
179
            static_cast<Array*>(m_arr)->insert(ndx, 0);
1,312,734✔
180
            set(ndx, value);
1,312,734✔
181
        }
1,312,734✔
182
    }
3,371,226✔
183
}
3,371,226✔
184

185
StringData ArrayString::get(size_t ndx) const
186
{
22,470,381✔
187
    switch (m_type) {
22,470,381✔
188
        case Type::small_strings:
9,222,864✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
9,222,864✔
190
        case Type::medium_strings:
1,371,123✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
1,371,123✔
192
        case Type::big_strings:
8,811,621✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
8,811,621✔
194
        case Type::enum_strings: {
3,082,128✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
3,082,128✔
196
            return m_string_enum_values->get(index);
3,082,128✔
197
        }
×
198
    }
×
199
    return {};
×
200
}
×
201

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

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

224
bool ArrayString::is_null(size_t ndx) const
225
{
3,603,096✔
226
    switch (m_type) {
3,603,096✔
227
        case Type::small_strings:
484,326✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
484,326✔
229
        case Type::medium_strings:
14,592✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
14,592✔
231
        case Type::big_strings:
3,104,178✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,104,178✔
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
{
182,115✔
243
    switch (m_type) {
182,115✔
244
        case Type::small_strings:
88,824✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
88,824✔
246
            break;
88,824✔
247
        case Type::medium_strings:
58,209✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
58,209✔
249
            break;
58,209✔
250
        case Type::big_strings:
26,751✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
26,751✔
252
            break;
26,751✔
253
        case Type::enum_strings:
8,334✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,334✔
255
            break;
8,334✔
256
    }
182,115✔
257
}
182,115✔
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
{
423✔
285
    switch (m_type) {
423✔
286
        case Type::small_strings:
369✔
287
            static_cast<ArrayStringShort*>(m_arr)->clear();
369✔
288
            break;
369✔
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
    }
423✔
299
}
423✔
300

301
size_t ArrayString::find_first(StringData value, size_t begin, size_t end) const noexcept
302
{
4,080,204✔
303
    switch (m_type) {
4,080,204✔
304
        case Type::small_strings:
3,122,589✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,122,589✔
306
        case Type::medium_strings: {
105,492✔
307
            BinaryData as_binary(value.data(), value.size());
105,492✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
105,492✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
255,999✔
312
            BinaryData as_binary(value.data(), value.size());
255,999✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
255,999✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
596,739✔
317
            size_t sz = m_string_enum_values->size();
596,739✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
596,739✔
319
            if (res != realm::not_found) {
596,739✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
596,739✔
321
            }
596,739✔
UNCOV
322
            break;
×
UNCOV
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,630✔
339
    return arr->get(ndx);
93,630✔
340
}
93,630✔
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,879✔
348
        size_t half = sz / 2;
530,967✔
349
        size_t mid = i + half;
530,967✔
350
        auto probe = get_string(arr, mid);
530,967✔
351
        if (probe < value) {
530,967✔
352
            i = mid + 1;
190,722✔
353
            sz -= half + 1;
190,722✔
354
        }
190,722✔
355
        else {
340,245✔
356
            sz = half;
340,245✔
357
        }
340,245✔
358
    }
530,967✔
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,358,280✔
380
    if (m_type == Type::big_strings)
7,358,280✔
381
        return Type::big_strings;
1,151,484✔
382

3,039,915✔
383
    if (m_type == Type::enum_strings)
6,206,796✔
384
        return Type::enum_strings;
3,937,677✔
385

1,071,486✔
386
    if (m_type == Type::medium_strings) {
2,269,119✔
387
        if (value_size <= medium_string_max_size)
530,868✔
388
            return Type::medium_strings;
530,349✔
389

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

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

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

267✔
408
        m_type = Type::big_strings;
519✔
409
        return Type::big_strings;
519✔
410
    }
519✔
411

805,533✔
412
    // m_type == Type::small
805,533✔
413
    if (value_size <= small_string_max_size)
1,738,251✔
414
        return Type::small_strings;
1,672,932✔
415

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

15,042✔
422
        size_t n = string_short->size();
30,624✔
423
        for (size_t i = 0; i < n; i++) {
65,952✔
424
            string_long.add_string(string_short->get(i)); // Throws
35,328✔
425
        }
35,328✔
426
        auto parent = string_short->get_parent();
30,624✔
427
        auto ndx_in_parent = string_short->get_ndx_in_parent();
30,624✔
428
        string_short->destroy();
30,624✔
429

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

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

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

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

14,751✔
456
        m_type = Type::big_strings;
34,695✔
457
    }
34,695✔
458

29,793✔
459
    return m_type;
65,319✔
460
}
65,319✔
461

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