summaryrefslogtreecommitdiffstats
path: root/common/domainadaptor.h
blob: 5d9574bf3197b19f9788724cfc472cddb5fcebf2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
 * Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
 *
 *   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 <QVariant>
#include <QByteArray>
#include <functional>
#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<typename BufferType>
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<QByteArray> availableProperties() const { return mReadAccessors.keys(); }
    void addMapping(const QByteArray &property, const std::function<QVariant(BufferType const *)> &mapping) {
        mReadAccessors.insert(property, mapping);
    }
private:
    QHash<QByteArray, std::function<QVariant(BufferType const *)> > mReadAccessors;
};

template<typename BufferBuilder>
class WritePropertyMapper
{
public:
    virtual void setProperty(const QByteArray &key, const QVariant &value, QList<std::function<void(BufferBuilder &)> > &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<std::function<void(BufferBuilder &)>(const QVariant &, flatbuffers::FlatBufferBuilder &)> &mapping) {
        mWriteAccessors.insert(property, mapping);
    }
private:
    QHash<QByteArray, std::function<std::function<void(BufferBuilder &)>(const QVariant &, flatbuffers::FlatBufferBuilder &)> > mWriteAccessors;
};

/**
 * 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 LocalBuffer, class ResourceBuffer>
class GenericBufferAdaptor : public Akonadi2::ApplicationDomain::BufferAdaptor
{
public:
    GenericBufferAdaptor()
        : BufferAdaptor()
    {

    }

    //TODO remove
    void setProperty(const QByteArray &key, const QVariant &value)
    {
        // if (mResourceMapper && mResourceMapper->hasMapping(key)) {
        //     // mResourceMapper->setProperty(key, value, mResourceBuffer);
        // } else {
        //     // mLocalMapper.;
        // }
    }

    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<QByteArray> availableProperties() const
    {
        QList<QByteArray> props;
        props << mResourceMapper->availableProperties();
        props << mLocalMapper->availableProperties();
        return props;
    }

    LocalBuffer const *mLocalBuffer;
    ResourceBuffer const *mResourceBuffer;
    QSharedPointer<ReadPropertyMapper<LocalBuffer> > mLocalMapper;
    QSharedPointer<ReadPropertyMapper<ResourceBuffer> > mResourceMapper;
};

/**
 * A generic adaptor implementation that uses a property mapper to read/write values.
 */
template <class LocalBuilder, class ResourceBuilder>
class GenericWriteBufferAdaptor : public Akonadi2::ApplicationDomain::BufferAdaptor
{
public:
    GenericWriteBufferAdaptor(const BufferAdaptor &buffer)
        : BufferAdaptor()
    {
        for(const auto &property : buffer.availableProperties()) {
            setProperty(property, buffer.getProperty(property));
        }
    }

    void setProperty(const QByteArray &key, const QVariant &value)
    {
        // if (mResourceMapper && mResourceMapper->hasMapping(key)) {
        //     // mResourceMapper->setProperty(key, value, mResourceBuffer);
        // } else {
        //     // mLocalMapper.;
        // }
    }

    //TODO remove
    virtual QVariant getProperty(const QByteArray &key) const
    {
        Q_ASSERT(false);
    }

    virtual QList<QByteArray> availableProperties() const
    {
        Q_ASSERT(false);
        QList<QByteArray> props;
        return props;
    }

    // LocalBuffer const *mLocalBuffer;
    // ResourceBuffer const *mResourceBuffer;
    QSharedPointer<WritePropertyMapper<LocalBuilder> > mLocalMapper;
    QSharedPointer<WritePropertyMapper<ResourceBuilder> > mResourceMapper;
};

/**
 * Initializes the local property mapper.
 *
 * Provide an implementation for each application domain type.
 */
template <class T>
QSharedPointer<ReadPropertyMapper<T> > initializeReadPropertyMapper();

/**
 * 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<typename DomainType, typename LocalBuffer, typename ResourceBuffer>
class DomainTypeAdaptorFactory
{
public:
    DomainTypeAdaptorFactory() : mLocalMapper(initializeReadPropertyMapper<LocalBuffer>()) {};
    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<Akonadi2::ApplicationDomain::BufferAdaptor> createAdaptor(const Akonadi2::Entity &entity)
    {
        const auto resourceBuffer = Akonadi2::EntityBuffer::readBuffer<ResourceBuffer>(entity.resource());
        const auto localBuffer = Akonadi2::EntityBuffer::readBuffer<LocalBuffer>(entity.local());
        // const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::Metadata>(entity.metadata());

        auto adaptor = QSharedPointer<GenericBufferAdaptor<LocalBuffer, ResourceBuffer> >::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) {};

protected:
    QSharedPointer<ReadPropertyMapper<LocalBuffer> > mLocalMapper;
    QSharedPointer<ReadPropertyMapper<ResourceBuffer> > mResourceMapper;
};