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
|
/*
toolfactory.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
/**
@file
This file is part of the GammaRay Plugin API and declares the ToolFactory abstract base class.
@brief
Declares the ToolFactory abstract base class.
@author Volker Krause \<volker.krause@kdab.com\>
*/
#ifndef GAMMARAY_TOOLFACTORY_H
#define GAMMARAY_TOOLFACTORY_H
#include "gammaray_core_export.h"
#include "probe.h"
#include <QMetaType>
#include <QStringList>
#include <QtPlugin>
#include <QVector>
namespace GammaRay {
/*!
* An abstract interface for probe tools.
*
* The ToolFactory class is an abstract base class for creating probe tools
* for GammaRay. Each tool must have a unique identifier.
*/
class GAMMARAY_CORE_EXPORT ToolFactory
{
public:
ToolFactory();
virtual ~ToolFactory();
/*!
* Unique id of this tool
* @return a QString containing the tool id.
*/
virtual QString id() const = 0;
/*!
* Class names of types this tool can handle.
* The tool will only be activated if an object of one of these types
* is seen in the probed application.
* @return a QVector<QByteArray> of class names of types this tool supports.
*/
const QVector<QByteArray> &supportedTypes() const;
/*!
* Set names of supported classes.
* @see supportedTypes()
* @since 2.5
*/
void setSupportedTypes(const QVector<QByteArray> &types);
/*!
* Class names of types this tool can handle as a string.
* @return a comma separated QString of class names of types this tool supports.
*/
QString supportedTypesString() const;
/*!
* Initialize the tool.
* Implement this method to do non-GUI initialization, such as creating
* object tracking models etc.
* @param probe The probe interface allowing access to the object models.
*/
virtual void init(Probe *probe) = 0;
/*!
* Allows to hide a plug-in from the UI.
* This is useful for plug-ins that only provide support for additional
* data types. The value is usually filled in by the plug-in loader
* @return @c true if the plug-in has no tool view.
* @since 2.1
*/
virtual bool isHidden() const;
/*!
* Class names of types this tool can select.
* This must be a subset of supportedTypes(), and is used to check if this
* tool is a viable candidate for object navigation.
* When returning an non-empty result here, you must handle the Probe::objectSelected()
* signal.
*/
virtual QVector<QByteArray> selectableTypes() const;
private:
Q_DISABLE_COPY(ToolFactory)
QVector<QByteArray> m_types;
};
/**
* @brief A templated generic ToolFactory for some data type and tool.
*/
template<typename Type, typename Tool>
class StandardToolFactory : public ToolFactory
{
public:
StandardToolFactory()
{
setSupportedTypes(QVector<QByteArray>() << Type::staticMetaObject.className());
}
QString id() const override
{
return Tool::staticMetaObject.className();
}
void init(Probe *probe) override
{
new Tool(probe, probe);
}
};
}
QT_BEGIN_NAMESPACE
Q_DECLARE_INTERFACE(GammaRay::ToolFactory, "com.kdab.GammaRay.ToolFactory/1.0")
QT_END_NAMESPACE
Q_DECLARE_METATYPE(GammaRay::ToolFactory *)
#endif
|
