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
|
/*
* Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
*
* 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 "sinkcommon_export.h"
#include <QSharedPointer>
#include <QVariant>
#include <QByteArray>
#include <QDebug>
#include "bufferadaptor.h"
namespace Sink {
namespace ApplicationDomain {
/**
* The domain type interface has two purposes:
* * provide a unified interface to read buffers (for zero-copy reading)
* * record changes to generate changesets for modifications
*
* ApplicationDomainTypes don't adhere to any standard and are meant to be extended frequently (hence the non-typesafe interface).
*/
class SINKCOMMON_EXPORT ApplicationDomainType {
public:
typedef QSharedPointer<ApplicationDomainType> Ptr;
ApplicationDomainType();
ApplicationDomainType(const QByteArray &resourceInstanceIdentifier);
ApplicationDomainType(const QByteArray &resourceInstanceIdentifier, const QByteArray &identifier, qint64 revision, const QSharedPointer<BufferAdaptor> &adaptor);
ApplicationDomainType(const ApplicationDomainType &other);
ApplicationDomainType& operator=(const ApplicationDomainType &other);
template <typename DomainType>
static typename DomainType::Ptr getInMemoryRepresentation(const ApplicationDomainType &domainType, const QList<QByteArray> properties = QList<QByteArray>())
{
auto memoryAdaptor = QSharedPointer<Sink::ApplicationDomain::MemoryBufferAdaptor>::create(*(domainType.mAdaptor), properties);
//The identifier still internal refers to the memory-mapped pointer, we need to copy the memory or it will become invalid
return QSharedPointer<DomainType>::create(domainType.mResourceInstanceIdentifier, QByteArray(domainType.mIdentifier.constData(), domainType.mIdentifier.size()), domainType.mRevision, memoryAdaptor);
}
virtual ~ApplicationDomainType();
QVariant getProperty(const QByteArray &key) const;;
void setProperty(const QByteArray &key, const QVariant &value);
void setChangedProperties(const QSet<QByteArray> &changeset);
QByteArrayList changedProperties() const;
qint64 revision() const;
QByteArray resourceInstanceIdentifier() const;
QByteArray identifier() const;
private:
friend QDebug operator<<(QDebug, const ApplicationDomainType &);
QSharedPointer<BufferAdaptor> mAdaptor;
QSet<QByteArray> mChangeSet;
/*
* Each domain object needs to store the resource, identifier, revision triple so we can link back to the storage location.
*/
QByteArray mResourceInstanceIdentifier;
QByteArray mIdentifier;
qint64 mRevision;
};
/*
* Should this be specific to the synclistresultset, in other cases we may want to take revision and resource into account.
*/
inline bool operator==(const ApplicationDomainType& lhs, const ApplicationDomainType& rhs)
{
return lhs.identifier() == rhs.identifier()
&& lhs.resourceInstanceIdentifier() == rhs.resourceInstanceIdentifier();
}
inline QDebug operator<< (QDebug d, const ApplicationDomainType &type)
{
d << "ApplicationDomainType(\n";
for (const auto &property : type.mAdaptor->availableProperties()) {
d << " " << property << "\t" << type.getProperty(property) << "\n";
}
d << ")";
return d;
}
struct SINKCOMMON_EXPORT Entity : public ApplicationDomainType {
typedef QSharedPointer<Entity> Ptr;
using ApplicationDomainType::ApplicationDomainType;
virtual ~Entity();
};
struct SINKCOMMON_EXPORT Event : public Entity {
typedef QSharedPointer<Event> Ptr;
using Entity::Entity;
virtual ~Event();
};
struct SINKCOMMON_EXPORT Todo : public Entity {
typedef QSharedPointer<Todo> Ptr;
using Entity::Entity;
virtual ~Todo();
};
struct SINKCOMMON_EXPORT Calendar : public Entity {
typedef QSharedPointer<Calendar> Ptr;
using Entity::Entity;
virtual ~Calendar();
};
struct SINKCOMMON_EXPORT Mail : public Entity {
typedef QSharedPointer<Mail> Ptr;
using Entity::Entity;
virtual ~Mail();
};
struct SINKCOMMON_EXPORT Folder : public Entity {
typedef QSharedPointer<Folder> Ptr;
using Entity::Entity;
virtual ~Folder();
};
/**
* Represents an sink resource.
*
* This type is used for configuration of resources,
* and for creating and removing resource instances.
*/
struct SINKCOMMON_EXPORT SinkResource : public ApplicationDomainType {
typedef QSharedPointer<SinkResource> Ptr;
using ApplicationDomainType::ApplicationDomainType;
virtual ~SinkResource();
};
/**
* All types need to be registered here an MUST return a different name.
*
* Do not store these types to disk, they may change over time.
*/
template<class DomainType>
QByteArray SINKCOMMON_EXPORT getTypeName();
template<>
QByteArray SINKCOMMON_EXPORT getTypeName<Event>();
template<>
QByteArray SINKCOMMON_EXPORT getTypeName<Todo>();
template<>
QByteArray SINKCOMMON_EXPORT getTypeName<SinkResource>();
template<>
QByteArray SINKCOMMON_EXPORT getTypeName<Mail>();
template<>
QByteArray SINKCOMMON_EXPORT getTypeName<Folder>();
/**
* Type implementation.
*
* Needs to be implemented for every application domain type.
* Contains all non-resource specific, but type-specific code.
*/
template<typename DomainType>
class SINKCOMMON_EXPORT TypeImplementation;
}
}
Q_DECLARE_METATYPE(Sink::ApplicationDomain::ApplicationDomainType)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::ApplicationDomainType::Ptr)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Entity)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Entity::Ptr)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Event)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Event::Ptr)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Mail)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Mail::Ptr)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Folder)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::Folder::Ptr)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::SinkResource)
Q_DECLARE_METATYPE(Sink::ApplicationDomain::SinkResource::Ptr)
|
