blob: b13c92ae6e93261a3a04dd0b90e36772dd1fbfbb (
plain)
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "idevicefactory.h"
#include <projectexplorer/devicesupport/idevice.h>
#include <utils/algorithm.h>
#include <utils/icon.h>
#include <utils/qtcassert.h>
using namespace Utils;
namespace ProjectExplorer {
/*!
\class ProjectExplorer::IDeviceFactory
\brief The IDeviceFactory class implements an interface for classes that
provide services related to a certain type of device.
The factory objects have to be added to the global object pool via
\c ExtensionSystem::PluginManager::addObject().
\sa ExtensionSystem::PluginManager::addObject()
*/
/*!
\fn virtual QString displayName() const = 0
Returns a short, one-line description of the device type this factory
can create.
*/
/*!
\fn virtual IDevice::Ptr create() const
Creates a new device. This may or may not open a wizard.
*/
/*!
\fn virtual bool canRestore(const QVariantMap &map) const = 0
Checks whether this factory can restore a device from the serialized state
specified by \a map.
*/
/*!
\fn virtual IDevice::Ptr restore(const QVariantMap &map) const = 0
Loads a device from a serialized state. Only called if \c canRestore()
returns true for \a map.
*/
/*!
Checks whether this factory can create new devices. This function is used
to hide auto-detect-only factories from the listing of possible devices
to create.
*/
bool IDeviceFactory::canCreate() const
{
return bool(m_creator);
}
IDevice::Ptr IDeviceFactory::create() const
{
return m_creator ? m_creator() : IDevice::Ptr();
}
IDevice::Ptr IDeviceFactory::construct() const
{
return m_constructor ? m_constructor() : IDevice::Ptr();
}
static QList<IDeviceFactory *> g_deviceFactories;
IDeviceFactory *IDeviceFactory::find(Utils::Id type)
{
return Utils::findOrDefault(g_deviceFactories,
[&type](IDeviceFactory *factory) {
return factory->deviceType() == type;
});
}
IDeviceFactory::IDeviceFactory(Utils::Id deviceType)
: m_deviceType(deviceType)
{
g_deviceFactories.append(this);
}
void IDeviceFactory::setIcon(const QIcon &icon)
{
m_icon = icon;
}
void IDeviceFactory::setCombinedIcon(const FilePath &small, const FilePath &large)
{
using namespace Utils;
m_icon = Icon::combinedIcon({Icon({{small, Theme::PanelTextColorDark}}, Icon::Tint),
Icon({{large, Theme::IconsBaseColor}})});
}
void IDeviceFactory::setCreator(const std::function<IDevice::Ptr ()> &creator)
{
QTC_ASSERT(creator, return);
m_creator = creator;
}
void IDeviceFactory::setConstructionFunction(const std::function<IDevice::Ptr ()> &constructor)
{
m_constructor = constructor;
}
void IDeviceFactory::setDisplayName(const QString &displayName)
{
m_displayName = displayName;
}
IDeviceFactory::~IDeviceFactory()
{
g_deviceFactories.removeOne(this);
}
const QList<IDeviceFactory *> IDeviceFactory::allDeviceFactories()
{
return g_deviceFactories;
}
} // namespace ProjectExplorer
|