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
|
/*
Copyright (c) 2007 Till Adam <adam@kde.org>
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_ITEM_SERIALIZER_P_H
#define AKONADI_ITEM_SERIALIZER_P_H
#include <QtCore/QByteArray>
#include <QtCore/QSet>
#include "akonadiprivate_export.h"
#include "itemserializerplugin.h"
#include <memory>
class QIODevice;
namespace Akonadi {
class Item;
/**
@internal
Serialization/Deserialization of item parts, serializer plugin management.
*/
class AKONADI_TESTS_EXPORT ItemSerializer
{
public:
/** throws ItemSerializerException on failure */
static void deserialize( Item& item, const QByteArray& label, const QByteArray& data, int version, bool external );
/** throws ItemSerializerException on failure */
static void deserialize( Item& item, const QByteArray& label, QIODevice& data, int version );
/** throws ItemSerializerException on failure */
static void serialize( const Item& item, const QByteArray& label, QByteArray& data, int &version );
/** throws ItemSerializerException on failure */
static void serialize( const Item& item, const QByteArray& label, QIODevice& data, int &version );
/**
* Throws ItemSerializerException on failure.
*
* @since 4.4
*/
static void apply( Item& item, const Item &other );
/**
* Returns a list of parts available in the item payload.
*/
static QSet<QByteArray> parts( const Item &item );
/**
* Returns a list of parts available remotely in the item payload.
*
* @since 4.4
*/
static QSet<QByteArray> availableParts( const Item &item );
/**
* Tries to convert the payload in \a item into type with
* metatype-id \a metaTypeId.
*
* Throws ItemSerializerException or returns an Item w/o payload on failure.
*
* @since 4.6
*/
static Item convert( const Item & item, int metaTypeId );
};
/**
@internal
Default implementation for serializer plugin.
*/
class DefaultItemSerializerPlugin : public QObject, public ItemSerializerPlugin
{
Q_OBJECT
Q_INTERFACES( Akonadi::ItemSerializerPlugin )
public:
DefaultItemSerializerPlugin();
bool deserialize( Item&, const QByteArray&, QIODevice&, int );
void serialize( const Item&, const QByteArray&, QIODevice&, int& );
};
/**
@internal
Serializer plugin implementation for std::string
*/
class StdStringItemSerializerPlugin : public QObject, public ItemSerializerPlugin
{
Q_OBJECT
Q_INTERFACES( Akonadi::ItemSerializerPlugin )
public:
StdStringItemSerializerPlugin();
bool deserialize( Item&, const QByteArray&, QIODevice&, int );
void serialize( const Item&, const QByteArray&, QIODevice&, int& );
};
}
#endif
|