/* * Copyright (C) 2014 Christian Mollekopf * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the * Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #pragma once #include "entity_generated.h" #include #include #include #include "clientapi.h" //for domain parts #include "event_generated.h" #include "entity_generated.h" #include "metadata_generated.h" #include "entitybuffer.h" /** * The property mapper is a non-typesafe virtual dispatch. * * Instead of using an interface and requring each implementation to override * a virtual method per property, the property mapper can be filled with accessors * that extract the properties from resource types. */ template class ReadPropertyMapper { public: virtual QVariant getProperty(const QByteArray &key, BufferType const *buffer) const { if (mReadAccessors.contains(key)) { auto accessor = mReadAccessors.value(key); return accessor(buffer); } return QVariant(); } bool hasMapping(const QByteArray &key) const { return mReadAccessors.contains(key); } QList availableProperties() const { return mReadAccessors.keys(); } void addMapping(const QByteArray &property, const std::function &mapping) { mReadAccessors.insert(property, mapping); } private: QHash > mReadAccessors; }; template class WritePropertyMapper { public: virtual void setProperty(const QByteArray &key, const QVariant &value, QList > &builderCalls, flatbuffers::FlatBufferBuilder &fbb) const { if (mWriteAccessors.contains(key)) { auto accessor = mWriteAccessors.value(key); builderCalls << accessor(value, fbb); } } bool hasMapping(const QByteArray &key) const { return mWriteAccessors.contains(key); } void addMapping(const QByteArray &property, const std::function(const QVariant &, flatbuffers::FlatBufferBuilder &)> &mapping) { mWriteAccessors.insert(property, mapping); } private: QHash(const QVariant &, flatbuffers::FlatBufferBuilder &)> > mWriteAccessors; }; /** * Defines how to convert qt primitives to flatbuffer ones */ template flatbuffers::uoffset_t variantToProperty(const QVariant &, flatbuffers::FlatBufferBuilder &fbb); /** * Defines how to convert flatbuffer primitives to qt ones */ template QVariant propertyToVariant(const flatbuffers::String *); /** * Create a buffer from a domain object using the provided mappings */ template flatbuffers::Offset createBufferPart(const Akonadi2::ApplicationDomain::ApplicationDomainType &domainObject, flatbuffers::FlatBufferBuilder &fbb, const WritePropertyMapper &mapper) { //First create a primitives such as strings using the mappings QList > propertiesToAddToResource; for (const auto &property : domainObject.changedProperties()) { qWarning() << "copying property " << property; const auto value = domainObject.getProperty(property); if (mapper.hasMapping(property)) { mapper.setProperty(property, domainObject.getProperty(property), propertiesToAddToResource, fbb); } else { qWarning() << "no mapping for property available " << property; } } //Then create all porperties using the above generated builderCalls Builder builder(fbb); for (auto propertyBuilder : propertiesToAddToResource) { propertyBuilder(builder); } return builder.Finish(); } /** * A generic adaptor implementation that uses a property mapper to read/write values. * * TODO: this is the read-only part. Create a write only equivalent */ template class GenericBufferAdaptor : public Akonadi2::ApplicationDomain::BufferAdaptor { public: GenericBufferAdaptor() : BufferAdaptor() { } //TODO remove void setProperty(const QByteArray &key, const QVariant &value) { } virtual QVariant getProperty(const QByteArray &key) const { if (mResourceBuffer && mResourceMapper->hasMapping(key)) { return mResourceMapper->getProperty(key, mResourceBuffer); } else if (mLocalBuffer && mLocalMapper->hasMapping(key)) { return mLocalMapper->getProperty(key, mLocalBuffer); } qWarning() << "no mapping available for key " << key; return QVariant(); } virtual QList availableProperties() const { QList props; props << mResourceMapper->availableProperties(); props << mLocalMapper->availableProperties(); return props; } LocalBuffer const *mLocalBuffer; ResourceBuffer const *mResourceBuffer; QSharedPointer > mLocalMapper; QSharedPointer > mResourceMapper; }; /** * Initializes the local property mapper. * * Provide an implementation for each application domain type. */ template QSharedPointer > initializeReadPropertyMapper(); template QSharedPointer > initializeWritePropertyMapper(); template class DomainTypeAdaptorFactoryInterface { public: virtual ~DomainTypeAdaptorFactoryInterface() {}; virtual QSharedPointer createAdaptor(const Akonadi2::Entity &entity) = 0; virtual void createBuffer(const DomainType &event, flatbuffers::FlatBufferBuilder &fbb) = 0; }; /** * The factory should define how to go from an entitybuffer (local + resource buffer), to a domain type adapter. * It defines how values are split accross local and resource buffer. * This is required by the facade the read the value, and by the pipeline preprocessors to access the domain values in a generic way. */ template class DomainTypeAdaptorFactory : public DomainTypeAdaptorFactoryInterface { public: DomainTypeAdaptorFactory() : mLocalMapper(initializeReadPropertyMapper()), mResourceMapper(QSharedPointer >::create()), mLocalWriteMapper(initializeWritePropertyMapper()), mResourceWriteMapper(QSharedPointer >::create()) {}; virtual ~DomainTypeAdaptorFactory() {}; /** * Creates an adaptor for the given domain and resource types. * * This returns by default a GenericBufferAdaptor initialized with the corresponding property mappers. */ virtual QSharedPointer createAdaptor(const Akonadi2::Entity &entity) Q_DECL_OVERRIDE { const auto resourceBuffer = Akonadi2::EntityBuffer::readBuffer(entity.resource()); const auto localBuffer = Akonadi2::EntityBuffer::readBuffer(entity.local()); // const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer(entity.metadata()); auto adaptor = QSharedPointer >::create(); adaptor->mLocalBuffer = localBuffer; adaptor->mLocalMapper = mLocalMapper; adaptor->mResourceBuffer = resourceBuffer; adaptor->mResourceMapper = mResourceMapper; return adaptor; } virtual void createBuffer(const Akonadi2::ApplicationDomain::Event &event, flatbuffers::FlatBufferBuilder &fbb) Q_DECL_OVERRIDE {}; protected: QSharedPointer > mLocalMapper; QSharedPointer > mResourceMapper; QSharedPointer > mLocalWriteMapper; QSharedPointer > mResourceWriteMapper; };