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
|
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtSystems module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef SERVICEMETADATA_H
#define SERVICEMETADATA_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include "qserviceframeworkglobal.h"
#include <QXmlStreamReader>
#include <QStringList>
#include <QList>
#include <QSet>
#include "qserviceinterfacedescriptor.h"
#if defined(IGNORE_SERVICEMETADATA_EXPORT) || defined(SERVICE_XML_GENERATOR)
# define SERVICEMETADATA_EXPORT
#else
# define SERVICEMETADATA_EXPORT Q_AUTOTEST_EXPORT
#endif
QT_BEGIN_NAMESPACE
class QIODevice;
// FORWARD DECLARATIONS
class QServiceInterfaceDescriptor;
class SERVICEMETADATA_EXPORT ServiceMetaDataResults
{
public:
ServiceMetaDataResults() : type(0) {}
ServiceMetaDataResults(const ServiceMetaDataResults& other)
{
type = other.type;
location = other.location;
name = other.name;
description = other.description;
interfaces = other.interfaces;
latestInterfaces = other.latestInterfaces;
}
int type;
QString location;
QString name;
QString description;
QList<QServiceInterfaceDescriptor> interfaces;
QList<QServiceInterfaceDescriptor> latestInterfaces;
};
#ifndef QT_NO_DATASTREAM
SERVICEMETADATA_EXPORT QDataStream &operator<<(QDataStream &, const ServiceMetaDataResults &);
SERVICEMETADATA_EXPORT QDataStream &operator>>(QDataStream &, ServiceMetaDataResults &);
#endif
class SERVICEMETADATA_EXPORT ServiceMetaData
{
public:
//! ServiceMetaData::ServiceMetadataErr
/*!
This enum describes the errors that may be returned by the Service metadata parser.
*/
enum ServiceMetadataErr {
SFW_ERROR_NO_SERVICE = 0, /* Can not find service root node in XML file*/
SFW_ERROR_NO_SERVICE_NAME, /* Can not find service name in XML file */
SFW_ERROR_NO_SERVICE_PATH, /* Can not find service filepath in XML file */
SFW_ERROR_NO_SERVICE_INTERFACE, /* No interface for the service in XML file*/
SFW_ERROR_NO_INTERFACE_VERSION, /* Can not find interface version in XML file */
SFW_ERROR_NO_INTERFACE_NAME, /* Can not find interface name in XML file*/
SFW_ERROR_UNABLE_TO_OPEN_FILE, /* Error opening XML file*/
SFW_ERROR_INVALID_XML_FILE, /* Not a valid XML file*/
SFW_ERROR_PARSE_SERVICE, /* Error parsing service node */
SFW_ERROR_PARSE_INTERFACE, /* Error parsing interface node */
SFW_ERROR_DUPLICATED_INTERFACE, /* The same interface is defined twice */
SFW_ERROR_INVALID_VERSION,
SFW_ERROR_DUPLICATED_TAG, /* The tag appears twice */
SFW_ERROR_INVALID_CUSTOM_TAG, /* The customproperty tag is not corectly formatted or otherwise incorrect*/
SFW_ERROR_DUPLICATED_CUSTOM_KEY, /* The customproperty appears twice*/
SFW_ERROR_MULTIPLE_SERVICE_TYPES, /* Both filepath and ipcaddress found in the XML file */
SFW_ERROR_INVALID_FILEPATH, /* Service path cannot contain IPC prefix */
SFW_ERROR_INVALID_XML_VERSION, /* Error parsing serficefw version node */
SFW_ERROR_UNSUPPORTED_IPC, /* Servicefw version doesn't support IPC */
SFW_ERROR_UNSUPPORTED_XML_VERSION /* Unsupported servicefw version supplied */
};
public:
ServiceMetaData(const QString &aXmlFilePath);
ServiceMetaData(QIODevice *device);
~ServiceMetaData();
void setDevice(QIODevice *device);
QIODevice *device() const;
bool extractMetadata();
int getLatestError() const;
ServiceMetaDataResults parseResults() const;
private:
QList<QServiceInterfaceDescriptor> latestInterfaces() const;
QServiceInterfaceDescriptor latestInterfaceVersion(const QString &interfaceName);
bool processVersionElement(QXmlStreamReader &aXMLReader);
bool processServiceElement(QXmlStreamReader &aXMLReader);
bool processInterfaceElement(QXmlStreamReader &aXMLReader);
void clearMetadata();
Q_DISABLE_COPY(ServiceMetaData);
private:
bool lessThan(const QServiceInterfaceDescriptor &d1,
const QServiceInterfaceDescriptor &d2) const;
bool greaterThan(const QString &v1, const QString &v2) const;
bool checkVersion(const QString &version) const;
void transformVersion(const QString &version, int *major, int *minor) const;
QIODevice *xmlDevice;
bool ownsXmlDevice;
QString xmlVersion;
QString serviceName;
QString serviceLocation;
QString serviceDescription;
QService::Type serviceType;
QList<QServiceInterfaceDescriptor> serviceInterfaces;
QSet<QString> duplicates;
int latestError;
QHash<QString, int> m_latestIndex;
};
QT_END_NAMESPACE
#endif // SERVICEMETADATA_H
|
