Initial ObjectStore Class class (#6521)

Author: jedelbo

src/realm/obj.cpp

@@ -684,7 +684,7 @@ ObjKey Obj::get_backlink(const Table& origin, ColKey origin_col_key, size_t back
     return get_backlink(backlink_col_key, backlink_ndx);
 }
 
-TableView Obj::get_backlink_view(TableRef src_table, ColKey src_col_key)
+TableView Obj::get_backlink_view(TableRef src_table, ColKey src_col_key) const
 {
     TableView tv(src_table, src_col_key, *this);
     tv.do_sync();

src/realm/obj.hpp

@@ -168,7 +168,7 @@ class Obj {
     size_t get_backlink_count() const;
     size_t get_backlink_count(const Table& origin, ColKey origin_col_key) const;
     ObjKey get_backlink(const Table& origin, ColKey origin_col_key, size_t backlink_ndx) const;
-    TableView get_backlink_view(TableRef src_table, ColKey src_col_key);
+    TableView get_backlink_view(TableRef src_table, ColKey src_col_key) const;
 
     // To be used by the query system when a single object should
     // be tested. Will allow a function to be called in the context

src/realm/object-store/CMakeLists.txt

@@ -6,6 +6,7 @@ set(SOURCES
     dictionary.cpp
     index_set.cpp
     list.cpp
+    class.cpp
     object.cpp
     object_changeset.cpp
     object_schema.cpp
@@ -45,6 +46,7 @@ set(HEADERS
     index_set.hpp
     keypath_helpers.hpp
     list.hpp
+    class.hpp
     object.hpp
     object_accessor.hpp
     object_changeset.hpp

src/realm/object-store/c_api/query.cpp

@@ -330,9 +330,8 @@ RLM_API realm_results_t* realm_get_backlinks(realm_object_t* object, realm_class
     return wrap_err([&]() {
         object->verify_attached();
         auto realm = object->realm();
-        auto source_table = realm->read_group().get_table(TableKey{source_table_key});
-        auto backlink_view = object->get_obj().get_backlink_view(source_table, ColKey{property_key});
-        return new realm_results_t{Results{realm, backlink_view}};
+        return new realm_results_t{
+            Results{realm, object->get_obj(), TableKey{source_table_key}, ColKey{property_key}}};
     });
 }
 

src/realm/object-store/class.cpp

@@ -0,0 +1,49 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2023 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+
+#include <realm/object-store/class.hpp>
+#include <realm/object-store/shared_realm.hpp>
+
+namespace realm {
+
+Class::Class(std::shared_ptr<Realm> r, const ObjectSchema* object_schema)
+    : m_realm(std::move(r))
+    , m_object_schema(object_schema)
+    , m_table(m_realm->read_group().get_table(m_object_schema->table_key))
+{
+}
+
+std::pair<Obj, bool> Class::create_object(Mixed pk)
+{
+    bool did_create;
+    auto obj = m_table->create_object_with_primary_key(pk, &did_create);
+    return {obj, did_create};
+}
+
+Obj Class::create_object()
+{
+    return m_table->create_object();
+}
+
+Obj Class::get_object(Mixed pk)
+{
+    return m_table->get_object_with_primary_key(pk);
+}
+
+} // namespace realm

src/realm/object-store/class.hpp

@@ -0,0 +1,85 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2023 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+#ifndef REALM_OS_CLASS_HPP
+#define REALM_OS_CLASS_HPP
+
+#include <realm/obj.hpp>
+#include "realm/parser/keypath_mapping.hpp"
+#include "realm/parser/query_parser.hpp"
+#include <memory>
+
+namespace realm {
+
+class ObjectSchema;
+class Realm;
+class Query;
+
+class Class {
+public:
+    Class(std::shared_ptr<Realm> r, const ObjectSchema* object_schema);
+
+    size_t num_objects() const
+    {
+        return m_table->size();
+    }
+    bool is_embedded()
+    {
+        return m_table->is_embedded();
+    }
+    TableKey get_key() const
+    {
+        return m_table->get_key();
+    }
+    ColKey get_column_key(StringData name) const
+    {
+        return m_table->get_column_key(name);
+    }
+    std::shared_ptr<Realm> get_realm() const noexcept
+    {
+        return m_realm;
+    }
+    TableRef get_table() const noexcept
+    {
+        return m_table;
+    }
+    const ObjectSchema& get_schema() const noexcept
+    {
+        return *m_object_schema;
+    }
+
+    Query get_query(const std::string& query_string, query_parser::Arguments& args,
+                    const query_parser::KeyPathMapping& mapping) const
+    {
+        return m_table->query(query_string, args, mapping);
+    }
+
+
+    std::pair<Obj, bool> create_object(Mixed primary_value);
+    Obj create_object();
+    Obj get_object(Mixed primary_value);
+
+private:
+    std::shared_ptr<Realm> m_realm;
+    const ObjectSchema* m_object_schema;
+    TableRef m_table;
+};
+
+} // namespace realm
+
+#endif // REALM_OS_CLASS_HPP

src/realm/object-store/impl/object_notifier.cpp

@@ -23,10 +23,10 @@
 using namespace realm;
 using namespace realm::_impl;
 
-ObjectNotifier::ObjectNotifier(std::shared_ptr<Realm> realm, TableKey table_key, ObjKey obj_key)
+ObjectNotifier::ObjectNotifier(std::shared_ptr<Realm> realm, const Obj& obj)
     : CollectionNotifier(std::move(realm))
-    , m_table(transaction().get_table(table_key))
-    , m_obj_key(obj_key)
+    , m_table(obj.get_table())
+    , m_obj_key(obj.get_key())
 {
 }
 

src/realm/object-store/impl/object_notifier.hpp

@@ -27,7 +27,7 @@
 namespace realm::_impl {
 class ObjectNotifier : public CollectionNotifier {
 public:
-    ObjectNotifier(std::shared_ptr<Realm> realm, TableKey table_key, ObjKey obj_key);
+    ObjectNotifier(std::shared_ptr<Realm> realm, const Obj&);
 
 private:
     TableRef m_table;

src/realm/object-store/object.cpp

@@ -166,7 +166,7 @@ NotificationToken Object::add_notification_callback(CollectionChangeCallback cal
     verify_attached();
     m_realm->verify_notifications_available();
     if (!m_notifier) {
-        m_notifier = std::make_shared<_impl::ObjectNotifier>(m_realm, m_obj.get_table()->get_key(), m_obj.get_key());
+        m_notifier = std::make_shared<_impl::ObjectNotifier>(m_realm, m_obj);
         _impl::RealmCoordinator::register_notifier(m_notifier);
     }
     return {m_notifier, m_notifier->add_callback(std::move(callback), std::move(key_path_array))};

src/realm/object-store/object_accessor.hpp

@@ -224,9 +224,7 @@ ValueType Object::get_property_value_impl(ContextType& ctx, const Property& prop
         case PropertyType::LinkingObjects: {
             auto target_object_schema = m_realm->schema().find(property.object_type);
             auto link_property = target_object_schema->property_for_name(property.link_origin_property_name);
-            auto table = m_realm->read_group().get_table(target_object_schema->table_key);
-            auto tv = const_cast<Obj&>(m_obj).get_backlink_view(table, ColKey(link_property->column_key));
-            return ctx.box(Results(m_realm, std::move(tv)));
+            return ctx.box(Results(m_realm, m_obj, target_object_schema->table_key, link_property->column_key));
         }
         default:
             REALM_UNREACHABLE();