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
|
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qcanbus.h"
#include "qcanbusfactory.h"
#include <QtCore/qcoreapplication.h>
#include <QtCore/qglobalstatic.h>
#include <QtCore/qlist.h>
#include <QtCore/qobject.h>
#include <QtCore/qpluginloader.h>
#include <private/qfactoryloader_p.h>
#define QCanBusFactory_iid "org.qt-project.Qt.QCanBusFactory"
QT_BEGIN_NAMESPACE
class QCanBusPrivate
{
public:
QCanBusPrivate() { }
QCanBusPrivate(int index, const QCborMap &meta) : meta(meta), index(index) {}
QCborMap meta;
QObject *factory = nullptr;
int index = -1;
};
Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, qFactoryLoader,
(QCanBusFactory_iid, QLatin1String("/canbus")))
typedef QMap<QString, QCanBusPrivate> QCanBusPluginStore;
Q_GLOBAL_STATIC(QCanBusPluginStore, qCanBusPlugins)
static QCanBus *globalInstance = nullptr;
static void loadPlugins()
{
const QList<QPluginParsedMetaData> meta = qFactoryLoader()->metaData();
for (int i = 0; i < meta.count(); i++) {
const QCborMap obj = meta.at(i).value(QtPluginMetaDataKeys::MetaData).toMap();
if (obj.isEmpty())
continue;
qCanBusPlugins()->insert(obj.value(QLatin1String("Key")).toString(), {i, obj});
}
}
/*!
\class QCanBus
\inmodule QtSerialBus
\since 5.8
\brief The QCanBus class handles registration and creation of bus plugins.
QCanBus loads Qt CAN Bus plugins at runtime. The ownership of serial bus plugins is
transferred to the loader.
*/
/*!
Returns a pointer to the QCanBus class. The object is loaded if necessary. QCanBus
uses the singleton design pattern.
*/
QCanBus *QCanBus::instance()
{
if (!globalInstance)
globalInstance = new QCanBus();
return globalInstance;
}
/*!
Returns a list of identifiers for all loaded plugins.
*/
QStringList QCanBus::plugins() const
{
return qCanBusPlugins()->keys();
}
static void setErrorMessage(QString *result, const QString &message)
{
if (!result)
return;
*result = message;
}
static QObject *canBusFactory(const QString &plugin, QString *errorMessage)
{
if (Q_UNLIKELY(!qCanBusPlugins()->contains(plugin))) {
setErrorMessage(errorMessage, QCanBus::tr("No such plugin: '%1'").arg(plugin));
return nullptr;
}
QCanBusPrivate d = qCanBusPlugins()->value(plugin);
if (!d.factory) {
d.factory = qFactoryLoader->instance(d.index);
if (d.factory)
qCanBusPlugins()->insert(plugin, d);
}
if (Q_UNLIKELY(!d.factory))
setErrorMessage(errorMessage, QCanBus::tr("No factory for plugin: '%1'").arg(plugin));
return d.factory;
}
/*!
\since 5.9
Returns the available interfaces for \a plugin. In case of failure, the optional
parameter \a errorMessage returns a textual error description.
\note Some plugins might not or only partially support this function.
For example, the following call returns a list of all available SocketCAN
interfaces (which can be used for \l createDevice()):
\code
QString errorString;
const QList<QCanBusDeviceInfo> devices = QCanBus::instance()->availableDevices(
QStringLiteral("socketcan"), &errorString);
if (!errorString.isEmpty())
qDebug() << errorString;
\endcode
\sa createDevice()
*/
QList<QCanBusDeviceInfo> QCanBus::availableDevices(const QString &plugin, QString *errorMessage) const
{
const QObject *obj = canBusFactory(plugin, errorMessage);
if (Q_UNLIKELY(!obj))
return QList<QCanBusDeviceInfo>();
const QCanBusFactory *factory = qobject_cast<const QCanBusFactory *>(obj);
if (Q_UNLIKELY(!factory)) {
setErrorMessage(errorMessage,
tr("The plugin '%1' does not provide this function.").arg(plugin));
return QList<QCanBusDeviceInfo>();
}
QString errorString;
QList<QCanBusDeviceInfo> result = factory->availableDevices(&errorString);
setErrorMessage(errorMessage, errorString);
return result;
}
/*!
Creates a CAN bus device. \a plugin is the name of the plugin as returned by the \l plugins()
method. \a interfaceName is the CAN bus interface name. In case of failure, the optional
parameter \a errorMessage returns a textual error description.
Ownership of the returned plugin is transferred to the caller.
Returns \c nullptr if no suitable device can be found.
For example, the following call would connect to the SocketCAN interface vcan0:
\code
QString errorString;
QCanBusDevice *device = QCanBus::instance()->createDevice(
QStringLiteral("socketcan"), QStringLiteral("vcan0"), &errorString);
if (!device)
qDebug() << errorString;
else
device->connectDevice();
\endcode
\note The \a interfaceName is plugin-dependent. See the corresponding plugin documentation
for more information: \l {CAN Bus Plugins}. To get a list of available interfaces,
\l availableDevices() can be used.
\sa availableDevices()
*/
QCanBusDevice *QCanBus::createDevice(const QString &plugin, const QString &interfaceName,
QString *errorMessage) const
{
const QObject *obj = canBusFactory(plugin, errorMessage);
if (Q_UNLIKELY(!obj))
return nullptr;
const QCanBusFactory *factory = qobject_cast<const QCanBusFactory *>(obj);
if (Q_LIKELY(factory))
return factory->createDevice(interfaceName, errorMessage);
setErrorMessage(errorMessage,
tr("The plugin '%1' does not provide this function.").arg(plugin));
return nullptr;
}
QCanBus::QCanBus(QObject *parent) :
QObject(parent)
{
loadPlugins();
}
QT_END_NAMESPACE
|
