/usr/include/gammaray/core/probe.h is in gammaray-dev 2.7.0-1ubuntu8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
probe.h
This file is part of GammaRay, the Qt application inspection and
manipulation tool.
Copyright (C) 2010-2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
Author: Volker Krause <volker.krause@kdab.com>
Licensees holding valid commercial KDAB GammaRay licenses may use this file in
accordance with GammaRay Commercial License Agreement provided with the Software.
Contact info@kdab.com if any conditions of this licensing are not clear to you.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GAMMARAY_PROBE_H
#define GAMMARAY_PROBE_H
#include "gammaray_core_export.h"
#include "probeinterface.h"
#include "signalspycallbackset.h"
#include <QObject>
#include <QList>
#include <QSet>
#include <QVector>
QT_BEGIN_NAMESPACE
class QItemSelectionModel;
class QModelIndex;
class QThread;
class QPoint;
class QTimer;
class QMutex;
QT_END_NAMESPACE
namespace GammaRay {
class ProbeCreator;
class ObjectListModel;
class ObjectTreeModel;
class MainWindow;
class BenchSuite;
class Server;
class ToolManager;
class GAMMARAY_CORE_EXPORT Probe : public QObject, public ProbeInterface
{
Q_OBJECT
public:
~Probe();
/**
* NOTE: You must hold the object lock when operating on the instance!
*/
static Probe *instance();
/**
* Returns true if the probe is initialized, false otherwise.
*/
static bool isInitialized();
static void objectAdded(QObject *obj, bool fromCtor = false);
static void objectRemoved(QObject *obj);
QAbstractItemModel *objectListModel() const override;
QAbstractItemModel *objectTreeModel() const override;
void registerModel(const QString &objectName, QAbstractItemModel *model) override;
void installGlobalEventFilter(QObject *filter) override;
bool needsObjectDiscovery() const override;
void discoverObject(QObject *object) override;
void selectObject(QObject *object, const QPoint &pos = QPoint()) override;
void selectObject(QObject *object, const QString &toolId,
const QPoint &pos = QPoint()) override;
void selectObject(void *object, const QString &typeName) override;
void registerSignalSpyCallbackSet(const SignalSpyCallbackSet &callbacks) override;
QObject *window() const;
void setWindow(QObject *window);
QObject *probe() const override;
/**
* Lock this to check the validity of a QObject
* and to access it safely afterwards.
*/
static QMutex *objectLock();
/**
* check whether @p obj is still valid
*
* NOTE: the objectLock must be locked when this is called!
*/
bool isValidObject(QObject *obj) const;
bool filterObject(QObject *obj) const override;
/// internal
static void startupHookReceived();
template<typename Func> static void executeSignalCallback(const Func &func);
signals:
/**
* Emitted when the user selected @p object at position @p pos in the probed application.
*/
void objectSelected(QObject *object, const QPoint &pos);
void nonQObjectSelected(void *object, const QString &typeName);
/**
* Emitted for newly created QObjects.
*
* Note:
* - This signal is always emitted from the thread the probe exists in.
* - The signal is emitted delayed enough for the QObject to have been fully constructed,
* i.e. on the next event loop re-entry.
* - The signal is not emitted if the object has been destroyed completely again meanwhile,
* e.g. for objects that only existed on the stack.
* - For objects created and destroyed in other threads, this signal might be emitted after
* its dtor has been entered (in case of short-lived objects), but before it has been finished.
* At this point the dtor might have already emitted the destroyed() signal and informed smart
* pointers about the destruction. This means you must not rely on any of this for object lifetime
* tracking for objects from other threads. Use objectDestroyed() instead.
* - Do not put @p obj into a QWeakPointer, even if it's exclusively handled in the same thread as
* the Probe instance. Qt4 asserts if target code tries to put @p obj into a QSharedPointer afterwards.
* - The objectLock() is locked.
*/
void objectCreated(QObject *obj);
/**
* Emitted for destroyed objects.
*
* Note:
* - This signal is emitted from the thread the probe exists in.
* - The signal is emitted from the end of the QObject dtor, dereferencing @p obj is no longer
* safe at this point.
* - In a multi-threaded application, this signal might reach you way after @p obj has been
* destroyed, see isValidObject() for a way to check if the object is still valid before accessing it.
* - The objectLock() is locked.
*/
void objectDestroyed(QObject *obj);
void objectReparented(QObject *obj);
protected:
bool eventFilter(QObject *receiver, QEvent *event) override;
private slots:
void delayedInit();
void processQueuedObjectChanges();
void handleObjectDestroyed(QObject *obj);
void objectParentChanged();
private:
friend class ProbeCreator;
friend class BenchSuite;
/* Returns @c true if we have working hooks in QtCore, that is we are notified reliably
* about every QObject creation/destruction.
* @since 2.0
*/
bool hasReliableObjectTracking() const;
void objectFullyConstructed(QObject *obj);
void queueCreatedObject(QObject *obj);
void queueDestroyedObject(QObject *obj);
bool isObjectCreationQueued(QObject *obj) const;
void purgeChangesForObject(QObject *obj);
void notifyQueuedObjectChanges();
void findExistingObjects();
/** Check if we are capable of showing widgets. */
static bool canShowWidgets();
void showInProcessUi();
static void createProbe(bool findExisting);
void resendServerAddress();
explicit Probe(QObject *parent = nullptr);
static QAtomicPointer<Probe> s_instance;
/** Set up all needed signal spy callbacks. */
void setupSignalSpyCallbacks();
ObjectListModel *m_objectListModel;
ObjectTreeModel *m_objectTreeModel;
ToolManager *m_toolManager;
QObject *m_window;
QSet<QObject *> m_validObjects;
// all delayed object changes need to go through a single queue, as the order is crucial
struct ObjectChange {
QObject *obj;
enum Type {
Create,
Destroy
} type;
};
QVector<ObjectChange> m_queuedObjectChanges;
QList<QObject *> m_pendingReparents;
QTimer *m_queueTimer;
QVector<QObject *> m_globalEventFilters;
QVector<SignalSpyCallbackSet> m_signalSpyCallbacks;
SignalSpyCallbackSet m_previousSignalSpyCallbackSet;
Server *m_server;
};
}
#endif // GAMMARAY_PROBE_H
|