Refactor how the storage is used.

This is the initial refactoring to improve how we deal with the storage.

It does a couple of things:
* Rename Sink::Storage to Sink::Storage::DataStore to free up the
  Sink::Storage namespace
* Introduce a Sink::ResourceContext to have a single object that can be
  passed around containing everything that is necessary to operate on a
  resource. This is a lot better than the multiple separate parameters
  that we used to pass around all over the place, while still allowing
  for dependency injection for tests.
* Tie storage access together using the new EntityStore that directly
  works with ApplicationDomainTypes. This gives us a central place where
  main storage, indexes and buffer adaptors are tied together, which
  will also give us a place to implement external indexes, such as a
  fulltextindex using xapian.
* Use ApplicationDomainTypes as the default way to pass around entities.
  Instead of using various ways to pass around entities (buffers,
  buffer adaptors, ApplicationDomainTypes), only use a single way.
  The old approach was confusing, and was only done as:
  * optimization; really shouldn't be necessary and otherwise I'm sure
  we can find better ways to optimize ApplicationDomainType itself.
  * a way to account for entities that have multiple buffers, a concept
  that I no longer deem relevant.

While this commit does the bulk of the work to get there, the following
commits will refactor more stuff to get things back to normal.

1 files changed, 109 insertions, 0 deletions

diff --git a/common/storage/entitystore.h b/common/storage/entitystore.h
new file mode 100644
index 0000000..de29e87
--- /dev/null
+++ b/common/storage/entitystore.h
@@ -0,0 +1,109 @@
+/*
+ * Copyright (C) 2016 Christian Mollekopf <mollekopf@kolabsys.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) version 3, or any
+ * later version accepted by the membership of KDE e.V. (or its
+ * successor approved by the membership of KDE e.V.), which shall
+ * act as a proxy defined in Section 6 of version 3 of the license.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include "sink_export.h"
+
+#include <memory>
+#include "domaintypeadaptorfactoryinterface.h"
+#include "query.h"
+#include "storage.h"
+#include "resourcecontext.h"
+
+namespace Sink {
+class EntityBuffer;
+namespace Storage {
+
+class SINK_EXPORT EntityStore
+{
+public:
+    typedef QSharedPointer<EntityStore> Ptr;
+    EntityStore(const ResourceContext &resourceContext);
+
+    void add(const ApplicationDomain::ApplicationDomainType &);
+    void modify(const ApplicationDomain::ApplicationDomainType &);
+    void remove(const ApplicationDomain::ApplicationDomainType &);
+
+    void startTransaction(Sink::Storage::DataStore::AccessMode);
+    void commitTransaction();
+    void abortTransaction();
+
+    QVector<QByteArray> fullScan(const QByteArray &type);
+    QVector<QByteArray> indexLookup(const QByteArray &type, const Query &query, QSet<QByteArray> &appliedFilters, QByteArray &appliedSorting);
+    QVector<QByteArray> indexLookup(const QByteArray &type, const QByteArray &property, const QVariant &value);
+    void indexLookup(const QByteArray &type, const QByteArray &property, const QVariant &value, const std::function<void(const QByteArray &uid)> &callback);
+    template<typename EntityType, typename PropertyType>
+    void indexLookup(const QVariant &value, const std::function<void(const QByteArray &uid)> &callback) {
+        return indexLookup(ApplicationDomain::getTypeName<EntityType>(), PropertyType::name, value, callback);
+    }
+
+    void readLatest(const QByteArray &type, const QByteArray &uid, const std::function<void(const QByteArray &uid, const EntityBuffer &entity)> callback);
+    void readLatest(const QByteArray &type, const QByteArray &uid, const std::function<void(const ApplicationDomain::ApplicationDomainType &entity)> callback);
+
+    ApplicationDomain::ApplicationDomainType readLatest(const QByteArray &type, const QByteArray &uid);
+
+    template<typename T>
+    T readLatest(const QByteArray &uid) {
+        return T(readLatest(ApplicationDomain::getTypeName<T>(), uid));
+    }
+
+    void readEntity(const QByteArray &type, const QByteArray &uid, const std::function<void(const QByteArray &uid, const EntityBuffer &entity)> callback);
+    void readEntity(const QByteArray &type, const QByteArray &uid, const std::function<void(const ApplicationDomain::ApplicationDomainType &entity)> callback);
+    ApplicationDomain::ApplicationDomainType readEntity(const QByteArray &type, const QByteArray &key);
+
+    template<typename T>
+    T readEntity(const QByteArray &key) {
+        return T(readEntity(ApplicationDomain::getTypeName<T>(), key));
+    }
+
+
+    void readPrevious(const QByteArray &type, const QByteArray &uid, qint64 revision, const std::function<void(const QByteArray &uid, const EntityBuffer &entity)> callback);
+    void readPrevious(const QByteArray &type, const QByteArray &uid, qint64 revision, const std::function<void(const ApplicationDomain::ApplicationDomainType &entity)> callback);
+    ApplicationDomain::ApplicationDomainType readPrevious(const QByteArray &type, const QByteArray &uid, qint64 revision);
+
+    template<typename T>
+    T readPrevious(const QByteArray &uid, qint64 revision) {
+        return T(readPrevious(ApplicationDomain::getTypeName<T>(), uid, revision));
+    }
+
+    void readAllUids(const QByteArray &type, const std::function<void(const QByteArray &uid)> callback);
+
+    void readAll(const QByteArray &type, const std::function<void(const ApplicationDomain::ApplicationDomainType &entity)> &callback);
+
+    template<typename T>
+    void readAll(const std::function<void(const T &entity)> &callback) {
+        return readAll(ApplicationDomain::getTypeName<T>(), [&](const ApplicationDomain::ApplicationDomainType &entity) {
+            callback(T(entity));
+        });
+    }
+
+    void readRevisions(qint64 baseRevision, const QByteArray &type, const std::function<void(const QByteArray &key)> &callback);
+
+    bool contains(const QByteArray &type, const QByteArray &uid);
+
+    qint64 maxRevision();
+
+private:
+    class Private;
+    const QSharedPointer<Private> d;
+};
+
+}
+}