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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the tools applications 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef SYMBIANDEVICEMANAGER_H
#define SYMBIANDEVICEMANAGER_H
#include "symbianutils_global.h"
#include <QtCore/QIODevice>
#include <QtCore/QExplicitlySharedDataPointer>
#include <QtCore/QSharedPointer>
QT_BEGIN_NAMESPACE
class QDebug;
class QTextStream;
QT_END_NAMESPACE
namespace trk {
class TrkDevice;
}
namespace Coda {
class CodaDevice;
}
namespace SymbianUtils {
struct SymbianDeviceManagerPrivate;
class SymbianDeviceData;
class OstChannel;
enum DeviceCommunicationType {
SerialPortCommunication = 0,
BlueToothCommunication = 1
};
typedef QSharedPointer<Coda::CodaDevice> CodaDevicePtr;
// SymbianDevice: Explicitly shared device data and a TrkDevice
// instance that can be acquired (exclusively) for use.
// A device removal from the manager will result in the
// device being closed.
class SYMBIANUTILS_EXPORT SymbianDevice {
explicit SymbianDevice(SymbianDeviceData *data);
friend class SymbianDeviceManager;
public:
typedef QSharedPointer<trk::TrkDevice> TrkDevicePtr;
SymbianDevice();
SymbianDevice(const SymbianDevice &rhs);
SymbianDevice &operator=(const SymbianDevice &rhs);
~SymbianDevice();
int compare(const SymbianDevice &rhs) const;
DeviceCommunicationType type() const;
bool isNull() const;
QString portName() const;
QString friendlyName() const;
QString additionalInformation() const;
void setAdditionalInformation(const QString &);
bool isOpen() const;
// Windows only.
QString deviceDesc() const;
QString manufacturer() const;
void format(QTextStream &str) const;
QString toString() const;
private:
// Acquire: Mark the device as 'out' and return a shared pointer
// unless it is already in use by another owner. The result should not
// be passed on further.
// TRK only
TrkDevicePtr acquireDevice();
// Give back a device and mark it as 'free'. TRK only.
void releaseDevice(TrkDevicePtr *ptr = 0);
void forcedClose();
QExplicitlySharedDataPointer<SymbianDeviceData> m_data;
};
SYMBIANUTILS_EXPORT QDebug operator<<(QDebug d, const SymbianDevice &);
inline bool operator==(const SymbianDevice &d1, const SymbianDevice &d2)
{ return d1.compare(d2) == 0; }
inline bool operator!=(const SymbianDevice &d1, const SymbianDevice &d2)
{ return d1.compare(d2) != 0; }
inline bool operator<(const SymbianDevice &d1, const SymbianDevice &d2)
{ return d1.compare(d2) < 0; }
/* SymbianDeviceManager: Singleton that maintains a list of Symbian devices.
* and emits change signals.
* On Windows, the update slot must be connected to a [delayed] signal
* emitted from an event handler listening for WM_DEVICECHANGE.
* Device removal will result in the device being closed. */
class SYMBIANUTILS_EXPORT SymbianDeviceManager : public QObject
{
Q_OBJECT
public:
typedef QList<SymbianDevice> SymbianDeviceList;
typedef QSharedPointer<trk::TrkDevice> TrkDevicePtr;
static const char *linuxBlueToothDeviceRootC;
// Do not use this constructor, it is just public for Q_GLOBAL_STATIC
explicit SymbianDeviceManager(QObject *parent = 0);
virtual ~SymbianDeviceManager();
// Singleton access.
static SymbianDeviceManager *instance();
SymbianDeviceList devices() const;
QString toString() const;
// Acquire a TRK device for use. Assuming the port is found, equivalent to devices()[findByPortName(port)].acquireDevice(). See also releaseDevice().
TrkDevicePtr acquireDevice(const QString &port);
//// The TCF code prefers to set up the CodaDevice object itself, so we let it and just handle opening the underlying QIODevice and keeping track of the CodaDevice
//// Returns true if port was opened successfully.
// Gets the CodaDevice, which may or may not be open depending on what other clients have already acquired it.
// Therefore once clients have set up any signals and slots they required, they should check CodaDevice::device()->isOpen()
// and if false, the open failed and they should check device()->errorString() if required.
// Caller should call releaseCodaDevice if they want the port to auto-close itself
CodaDevicePtr getCodaDevice(const QString &port);
// Note this function makes no guarantee that someone else isn't already listening on this channel id, or that there is anything on the other end
// Returns NULL if the port couldn't be opened
OstChannel *getOstChannel(const QString &port, uchar channelId);
// Caller is responsible for disconnecting any signals from aPort - do not assume the CodaDevice will be deleted as a result of this call. On return aPort will be clear()ed.
void releaseCodaDevice(CodaDevicePtr &aPort);
int findByPortName(const QString &p) const;
QString friendlyNameForPort(const QString &port) const;
public slots:
void update();
// Relase a device, make it available for further use.
void releaseDevice(const QString &port);
void setAdditionalInformation(const QString &port, const QString &ai);
signals:
void deviceRemoved(const SymbianUtils::SymbianDevice &d);
void deviceAdded(const SymbianUtils::SymbianDevice &d);
void updated();
private slots:
void delayedClosePort();
private:
void ensureInitialized() const;
void update(bool emitSignals);
SymbianDeviceList serialPorts() const;
SymbianDeviceList blueToothDevices() const;
void customEvent(QEvent *event);
void constructCodaPort(CodaDevicePtr& device, const QString& portName);
SymbianDeviceManagerPrivate *d;
};
SYMBIANUTILS_EXPORT QDebug operator<<(QDebug d, const SymbianDeviceManager &);
struct OstChannelPrivate;
class SYMBIANUTILS_EXPORT OstChannel : public QIODevice
{
Q_OBJECT
public:
void close();
~OstChannel();
void flush();
qint64 bytesAvailable() const;
bool isSequential() const;
bool hasReceivedData() const;
Coda::CodaDevice &codaDevice() const;
private slots:
void ostDataReceived(uchar channelId, const QByteArray &aData);
void deviceAboutToClose();
private:
OstChannel(const CodaDevicePtr &codaPtr, uchar channelId);
Q_DISABLE_COPY(OstChannel)
qint64 readData(char *data, qint64 maxSize);
qint64 writeData(const char *data, qint64 maxSize);
private:
OstChannelPrivate *d;
friend class SymbianDeviceManager;
};
} // namespace SymbianUtils
#endif // SYMBIANDEVICEMANAGER_H
|
