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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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://www.qt.io/licensing. For further information
** use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** 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.
**
****************************************************************************/
#ifndef IDEVICE_H
#define IDEVICE_H
#include "../projectexplorer_export.h"
#include <coreplugin/id.h>
#include <QAbstractSocket>
#include <QList>
#include <QObject>
#include <QSharedPointer>
#include <QVariantMap>
QT_BEGIN_NAMESPACE
class QWidget;
QT_END_NAMESPACE
namespace QSsh { class SshConnectionParameters; }
namespace Utils { class PortList; }
namespace ProjectExplorer {
class DeviceProcess;
class DeviceProcessList;
namespace Internal { class IDevicePrivate; }
class IDeviceWidget;
class DeviceTester;
class PROJECTEXPLORER_EXPORT DeviceProcessSignalOperation : public QObject
{
Q_OBJECT
public:
~DeviceProcessSignalOperation() {}
typedef QSharedPointer<DeviceProcessSignalOperation> Ptr;
virtual void killProcess(int pid) = 0;
virtual void killProcess(const QString &filePath) = 0;
virtual void interruptProcess(int pid) = 0;
virtual void interruptProcess(const QString &filePath) = 0;
void setDebuggerCommand(const QString &cmd);
signals:
// If the error message is empty the operation was successful
void finished(const QString &errorMessage);
protected:
explicit DeviceProcessSignalOperation();
QString m_debuggerCommand;
QString m_errorMessage;
};
class PROJECTEXPLORER_EXPORT PortsGatheringMethod
{
public:
typedef QSharedPointer<const PortsGatheringMethod> Ptr;
virtual ~PortsGatheringMethod();
virtual QByteArray commandLine(QAbstractSocket::NetworkLayerProtocol protocol) const = 0;
virtual QList<int> usedPorts(const QByteArray &commandOutput) const = 0;
};
// See cpp file for documentation.
class PROJECTEXPLORER_EXPORT IDevice
{
public:
typedef QSharedPointer<IDevice> Ptr;
typedef QSharedPointer<const IDevice> ConstPtr;
enum Origin { ManuallyAdded, AutoDetected };
enum MachineType { Hardware, Emulator };
virtual ~IDevice();
QString displayName() const;
void setDisplayName(const QString &name);
// Provide some information on the device suitable for formated
// output, e.g. in tool tips. Get a list of name value pairs.
class DeviceInfoItem {
public:
DeviceInfoItem(const QString &k, const QString &v) : key(k), value(v) { }
QString key;
QString value;
};
typedef QList<DeviceInfoItem> DeviceInfo;
virtual DeviceInfo deviceInformation() const;
Core::Id type() const;
bool isAutoDetected() const;
Core::Id id() const;
virtual QString displayType() const = 0;
virtual IDeviceWidget *createWidget() = 0;
virtual QList<Core::Id> actionIds() const = 0;
virtual QString displayNameForActionId(Core::Id actionId) const = 0;
virtual void executeAction(Core::Id actionId, QWidget *parent = 0) = 0;
// Devices that can auto detect ports need not return a ports gathering method. Such devices can
// obtain a free port on demand. eg: Desktop device.
virtual bool canAutoDetectPorts() const { return false; }
virtual PortsGatheringMethod::Ptr portsGatheringMethod() const;
virtual bool canCreateProcessModel() const { return false; }
virtual DeviceProcessList *createProcessListModel(QObject *parent = 0) const;
virtual bool hasDeviceTester() const { return false; }
virtual DeviceTester *createDeviceTester() const;
virtual bool canCreateProcess() const { return false; }
virtual DeviceProcess *createProcess(QObject *parent) const;
virtual DeviceProcessSignalOperation::Ptr signalOperation() const = 0;
enum DeviceState { DeviceReadyToUse, DeviceConnected, DeviceDisconnected, DeviceStateUnknown };
DeviceState deviceState() const;
void setDeviceState(const DeviceState state);
QString deviceStateToString() const;
virtual void fromMap(const QVariantMap &map);
virtual QVariantMap toMap() const;
virtual Ptr clone() const = 0;
static Core::Id typeFromMap(const QVariantMap &map);
static Core::Id idFromMap(const QVariantMap &map);
static QString defaultPrivateKeyFilePath();
static QString defaultPublicKeyFilePath();
QSsh::SshConnectionParameters sshParameters() const;
void setSshParameters(const QSsh::SshConnectionParameters &sshParameters);
virtual QString qmlProfilerHost() const;
Utils::PortList freePorts() const;
void setFreePorts(const Utils::PortList &freePorts);
MachineType machineType() const;
QString debugServerPath() const;
void setDebugServerPath(const QString &path);
protected:
IDevice();
IDevice(Core::Id type, Origin origin, MachineType machineType, Core::Id id = Core::Id());
IDevice(const IDevice &other);
Ptr sharedFromThis();
ConstPtr sharedFromThis() const;
private:
IDevice &operator=(const IDevice &); // Unimplemented.
int version() const;
Internal::IDevicePrivate *d;
friend class DeviceManager;
};
class PROJECTEXPLORER_EXPORT DeviceTester : public QObject
{
Q_OBJECT
public:
enum TestResult { TestSuccess, TestFailure };
virtual void testDevice(const ProjectExplorer::IDevice::ConstPtr &deviceConfiguration) = 0;
virtual void stopTest() = 0;
signals:
void progressMessage(const QString &message);
void errorMessage(const QString &message);
void finished(ProjectExplorer::DeviceTester::TestResult result);
protected:
explicit DeviceTester(QObject *parent = 0);
};
} // namespace ProjectExplorer
#endif // IDEVICE_H
|
