Realm C++ SDK Version v2.2.0

managed_list.hpp

1
2//
3// Copyright 2024 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//
18
19#ifndef CPPREALM_MANAGED_LIST_HPP
20#define CPPREALM_MANAGED_LIST_HPP
21
22#include <cpprealm/macros.hpp>
23#include <cpprealm/notifications.hpp>
24#include <cpprealm/observation.hpp>
25#include <cpprealm/types.hpp>
26
27namespace realm {
28
29 template<typename T>
30 struct managed<std::vector<T>, std::enable_if_t<internal::type_info::is_primitive<T>::value>> : managed_base {
31 using managed<std::vector<T>>::managed_base::operator=;
32
33 class iterator {
34 public:
35 using iterator_category = std::input_iterator_tag;
36
37 bool operator!=(const iterator& other) const
38 {
39 return !(*this == other);
40 }
41
42 bool operator==(const iterator& other) const
43 {
44 return (m_parent == other.m_parent) && (m_i == other.m_i);
45 }
46
47 T operator*() const noexcept
48 {
49 return (*m_parent)[m_i];
50 }
51
52 iterator& operator++()
53 {
54 this->m_i++;
55 return *this;
56 }
57
58 const iterator& operator++(int i)
59 {
60 this->m_i += i;
61 return *this;
62 }
63 private:
64 template<typename, typename>
65 friend struct managed;
66
67 iterator(size_t i, managed<std::vector<T>>* parent)
68 : m_i(i), m_parent(parent)
69 {
70 }
71 size_t m_i;
72 managed<std::vector<T>>* m_parent;
73 };
74 iterator begin()
75 {
76 return iterator(0, this);
77 }
78
79 iterator end()
80 {
81 return iterator(size(), this);
82 }
83 [[nodiscard]] std::vector<T> detach() const {
84 auto list = realm::internal::bridge::list(*m_realm, *m_obj, m_key);
85 using U = typename internal::type_info::type_info<T>::internal_type;
86
87 size_t count = list.size();
88 if (count == 0)
89 return std::vector<T>();
90
91 auto ret = std::vector<T>();
92 ret.reserve(count);
93 for(size_t i = 0; i < count; i++) {
94 if constexpr (internal::type_info::MixedPersistableConcept<T>::value) {
95 ret.push_back(deserialize<T>(realm::internal::bridge::get<U>(list, i)));
96 } else if constexpr (std::is_enum_v<T>) {
97 ret.push_back(deserialize<T>(realm::internal::bridge::get<U>(list, i)));
98 } else {
99 ret.push_back(deserialize(realm::internal::bridge::get<U>(list, i)));
100 }
101 }
102
103 return ret;
104 }
105
106 [[nodiscard]] results<T> as_results() const {
107 return results<T>(realm::internal::bridge::list(*m_realm, *m_obj, m_key).as_results());
108 }
109
110 realm::notification_token observe(std::function<void(realm::collection_change)>&& fn) {
111 auto list = std::make_shared<realm::internal::bridge::list>(*m_realm, *m_obj, m_key);
112 realm::notification_token token = list->add_notification_callback(
113 std::make_shared<realm::collection_callback_wrapper>(
114 std::move(fn),
115 false));
116 token.m_realm = *m_realm;
117 token.m_list = list;
118 return token;
119 }
120
121 // TODO: emulate a reference to the value.
122 T operator[](size_t idx) const {
123 auto list = realm::internal::bridge::list(*m_realm, *m_obj, m_key);
124 using U = typename internal::type_info::type_info<T>::internal_type;
125 if constexpr (internal::type_info::MixedPersistableConcept<T>::value) {
126 return deserialize<T>(realm::internal::bridge::get<U>(list, idx));
127 } else if constexpr (std::is_enum_v<T>) {
128 return static_cast<T>(deserialize<T>(realm::internal::bridge::get<U>(list, idx)));
129 } else {
130 return deserialize(realm::internal::bridge::get<U>(list, idx));
131 }
132 }
133
134 void pop_back() {
135 internal::bridge::list(*m_realm, *m_obj, m_key).remove(size() - 1);
136 }
137 void erase(size_t idx) {
138 internal::bridge::list(*m_realm, *m_obj, m_key).remove(idx);
139 }
140 void clear() {
141 internal::bridge::list(*m_realm, *m_obj, m_key).remove_all();
142 }
143 void push_back(const T& value) {
144 auto list = internal::bridge::list(*m_realm, *m_obj, m_key);
145 list.add(serialize(value));
146 }
147 size_t size() {
148 return internal::bridge::list(*m_realm, *m_obj, m_key).size();
149 }
150 size_t find(const T& a) {
151 if constexpr (std::is_enum_v<T>) {
152 return internal::bridge::list(*m_realm, *m_obj, m_key).find(static_cast<int64_t>(a));
153 } else {
154 return internal::bridge::list(*m_realm, *m_obj, m_key).find(a);
155 }
156 }
157 void set(size_t pos, const T& a) {
158 internal::bridge::list(*m_realm, *m_obj, m_key).set(pos, a);
159 }
160
161 results<T> sort(bool ascending) {
162 return results<T>(internal::bridge::list(*m_realm, *m_obj, m_key)
163 .sort(std::vector<internal::bridge::sort_descriptor>({{"self", ascending}})));
164 }
165
166 private:
167 managed() = default;
168 managed(const managed&) = delete;
169 managed(managed &&) = delete;
170 managed& operator=(const managed&) = delete;
171 managed& operator=(managed&&) = delete;
172 template<typename, typename>
173 friend struct managed;
174 };
175
176 template<typename T>
177 struct managed<std::vector<T*>> : managed_base {
178 public:
179 [[nodiscard]] std::vector<T*> detach() const {
180 auto list = realm::internal::bridge::list(*m_realm, *m_obj, m_key);
181 size_t count = list.size();
182 if (count == 0)
183 return std::vector<T*>();
184 auto ret = std::vector<T*>();
185 ret.reserve(count);
186 for(size_t i = 0; i < count; i++) {
187 managed<T> m(realm::internal::bridge::get<internal::bridge::obj>(list, i), *m_realm);
188 T* v = new T();
189 auto assign = [&m, &v](auto& pair) {
190 (*v).*(std::decay_t<decltype(pair.first)>::ptr) = (m.*(pair.second)).detach();
191 };
192 auto zipped = internal::zip_tuples(managed<T>::schema.ps, managed<T>::managed_pointers());
193 std::apply([&v, &m, &assign](auto && ...pair) {
194 (assign(pair), ...);
195 }, zipped);
196
197 ret.push_back(v);
198 }
199 return ret;
200 }
201
202 [[nodiscard]] results<T*> as_results() const {
203 return results<T*>(realm::internal::bridge::list(*m_realm, *m_obj, m_key).as_results());
204 }
205
206 class iterator {
207 public:
208 using value_type = managed<T>;
209
210 using difference_type = std::ptrdiff_t;
211 using pointer = T*;
212 using reference = T&;
213 using iterator_category = std::forward_iterator_tag;
214
215 bool operator!=(const iterator& other) const
216 {
217 return !(*this == other);
218 }
219
220 bool operator==(const iterator& other) const
221 {
222 return (m_parent == other.m_parent) && (m_i == other.m_i);
223 }
224
225 managed<T> operator*() const noexcept
226 {
227 auto list = realm::internal::bridge::list(*m_parent->m_realm, *m_parent->m_obj, m_parent->m_key);
228 managed<T> m(realm::internal::bridge::get<realm::internal::bridge::obj>(list, m_i), *m_parent->m_realm);
229 return {std::move(m)};
230 }
231
232 iterator& operator++()
233 {
234 this->m_i++;
235 return *this;
236 }
237
238 const iterator& operator++(int i)
239 {
240 this->m_i += i;
241 return *this;
242 }
243 private:
244 template<typename, typename>
245 friend struct managed;
246
247 iterator(size_t i, managed<std::vector<T*>>* parent)
248 : m_i(i), m_parent(parent)
249 {
250 }
251 size_t m_i;
252 managed<std::vector<T*>>* m_parent;
253 };
254
255 iterator begin()
256 {
257 return iterator(0, this);
258 }
259
260 iterator end()
261 {
262 return iterator(size(), this);
263 }
264
265 void pop_back() {
266 internal::bridge::list(*m_realm, *m_obj, m_key).remove(size() - 1);
267 }
268 void erase(size_t idx) {
269 internal::bridge::list(*m_realm, *m_obj, m_key).remove(idx);
270 }
271 void clear() {
272 internal::bridge::list(*m_realm, *m_obj, m_key).remove_all();
273 }
274 void push_back(T* value)
275 {
276 auto list = internal::bridge::list(*m_realm, *m_obj, m_key);
277 auto table = m_obj->get_target_table(m_key);
278 internal::bridge::obj m_obj;
279 if constexpr (managed<T>::schema.HasPrimaryKeyProperty) {
280 auto pk = (*value).*(managed<T>::schema.primary_key().ptr);
281 m_obj = table.create_object_with_primary_key(realm::internal::bridge::mixed(serialize(pk.value)));
282 } else if (managed<T>::schema.is_embedded()) {
283 m_obj = list.add_embedded();
284 } else {
285 m_obj = table.create_object();
286 }
287 std::apply([&m_obj, &value, realm = *m_realm](auto && ...p) {
288 (accessor<typename std::decay_t<decltype(p)>::Result>::set(
289 m_obj, m_obj.get_table().get_column_key(p.name), realm,
290 (*value).*(std::decay_t<decltype(p)>::ptr)), ...);
291 }, managed<T, void>::schema.ps);
292 if (!managed<T>::schema.is_embedded()) {
293 list.add(m_obj.get_key());
294 }
295 }
296 void push_back(const managed<T>& value)
297 {
298 auto list = internal::bridge::list(*m_realm, *m_obj, m_key);
299 if (!managed<T>::schema.is_embedded()) {
300 list.add(value.m_obj.get_key());
301 } else {
302 throw std::logic_error("Cannot add existing embedded object to managed list.");
303 }
304 }
305 void push_back(const managed<T*>& value)
306 {
307 if (!managed<T>::schema.is_embedded()) {
308 auto list = internal::bridge::list(*m_realm, *m_obj, m_key);
309 list.add(value.m_obj->get_key());
310 } else {
311 throw std::logic_error("Cannot add existing embedded object to managed list.");
312 }
313 }
314
315 size_t size() const
316 {
317 return internal::bridge::list(*m_realm, *m_obj, m_key).size();
318 }
319 size_t find(const managed<T>& a) {
320 return internal::bridge::list(*m_realm, *m_obj, m_key).find(a.m_obj.get_key());
321 }
322 size_t find(const typename managed<T*>::ref_type& a) const {
323 return internal::bridge::list(*m_realm, *m_obj, m_key).find(a->m_obj.get_key());
324 }
325 typename managed<T*>::ref_type operator[](size_t idx) const {
326 auto list = realm::internal::bridge::list(*m_realm, *m_obj, m_key);
327 return typename managed<T*>::ref_type(managed<T>(realm::internal::bridge::get<realm::internal::bridge::obj>(list, idx), *m_realm));
328 }
329
330 realm::notification_token observe(std::function<void(realm::collection_change)>&& fn) {
331 auto list = std::make_shared<realm::internal::bridge::list>(*m_realm, *m_obj, m_key);
332 realm::notification_token token = list->add_notification_callback(
333 std::make_shared<realm::collection_callback_wrapper>(
334 std::move(fn),
335 false));
336 token.m_realm = *m_realm;
337 token.m_list = list;
338 return token;
339 }
340
341 results<T> where(const std::string &query, const std::vector<realm::mixed> &arguments) {
342 std::vector<internal::bridge::mixed> mixed_args;
343 for(auto& a : arguments)
344 mixed_args.push_back(serialize(a));
345 return results<T>(internal::bridge::results(*m_realm, m_obj->get_target_table(m_key).query(query, std::move(mixed_args))));
346 }
347
348 results<T> where(std::function<rbool(managed<T> &)> &&fn) {
349 static_assert(sizeof(managed<T>), "Must declare schema for T");
350 auto schema = m_realm->schema().find(managed<T>::schema.name);
351 auto group = m_realm->read_group();
352 auto table_ref = group.get_table(schema.table_key());
353 rbool query = rbool(internal::bridge::query(table_ref));
354 auto query_object = managed<T>::prepare_for_query(*m_realm, &query);
355 auto full_query = fn(query_object).q;
356 return results<T>(internal::bridge::results(*m_realm, full_query));
357 }
358
359 results<T> sort(const std::string &key_path, bool ascending) {
360 auto schema = m_realm->schema().find(managed<T>::schema.name);
361 auto table_ref = m_obj->get_target_table(m_key);
362 return results<T>(internal::bridge::results(*m_realm, table_ref)).sort({{key_path, ascending}});
363 }
364
365 results<T> sort(const std::vector<internal::bridge::sort_descriptor> &sort_descriptors) {
366 auto schema = m_realm->schema().find(managed<T>::schema.name);
367 auto table_ref = m_obj->get_target_table(m_key);
368 return results<T>(internal::bridge::results(*m_realm, table_ref)).sort(sort_descriptors);
369 }
370
371 private:
372 managed() = default;
373 managed(const managed&) = delete;
374 managed(managed &&) = delete;
375 managed& operator=(const managed&) = delete;
376 managed& operator=(managed&&) = delete;
377 template<typename, typename>
378 friend struct managed;
379 };
380} // namespace realm
381
382#endif//CPPREALM_MANAGED_LIST_HPP
Definition: observation.hpp:176
Definition: list.hpp:49
Definition: mixed.hpp:69
Definition: macros.hpp:286
Definition: obj.hpp:62
Definition: notifications.hpp:38
Definition: results.hpp:411