File: metaobjectbrowser.cpp

package info (click to toggle)
gammaray 3.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 21,612 kB
  • sloc: cpp: 94,643; ansic: 2,227; sh: 336; python: 164; yacc: 90; lex: 82; xml: 61; makefile: 26
file content (161 lines) | stat: -rw-r--r-- 6,394 bytes parent folder | download | duplicates (2)
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
/*
  metaobjectbrowser.cpp

  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: Kevin Funk <kevin.funk@kdab.com>

  SPDX-License-Identifier: GPL-2.0-or-later

  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/

#include "metaobjectbrowser.h"
#include "metaobjecttreemodel.h"

#include <core/metaobjectregistry.h>
#include <core/probe.h>
#include <core/propertycontroller.h>
#include <core/problemcollector.h>
#include <core/qmetaobjectvalidator.h>
#include <core/remote/serverproxymodel.h>

#include <common/objectbroker.h>
#include <common/metatypedeclarations.h>
#include <common/tools/metaobjectbrowser/qmetaobjectmodel.h>

#include <QDebug>
#include <QSortFilterProxyModel>
#include <QItemSelectionModel>

using namespace GammaRay;

MetaObjectBrowser::MetaObjectBrowser(Probe *probe, QObject *parent)
    : QObject(parent)
    , m_propertyController(new PropertyController(QStringLiteral("com.kdab.GammaRay.MetaObjectBrowser"), this))
    , m_motm(new MetaObjectTreeModel(this))
    , m_model(nullptr)
{
    auto model = new ServerProxyModel<QSortFilterProxyModel>(this);
    model->addRole(QMetaObjectModel::MetaObjectIssues);
    model->addRole(QMetaObjectModel::MetaObjectInvalid);
    model->setSourceModel(m_motm);
    m_model = model;
    probe->registerModel(QStringLiteral("com.kdab.GammaRay.MetaObjectBrowserTreeModel"), m_model);

    QItemSelectionModel *selectionModel = ObjectBroker::selectionModel(m_model);

    connect(selectionModel, &QItemSelectionModel::selectionChanged,
            this, &MetaObjectBrowser::objectSelectionChanged);

    m_propertyController->setMetaObject(nullptr); // init

    connect(probe, &Probe::objectSelected, this, &MetaObjectBrowser::qobjectSelected);
    connect(probe, &Probe::nonQObjectSelected, this, &MetaObjectBrowser::voidPtrObjectSelected);

    ObjectBroker::registerObject(QStringLiteral("com.kdab.GammaRay.MetaObjectBrowser"), this);

    ProblemCollector::registerProblemChecker(QStringLiteral("com.kdab.GammaRay.MetaObjectBrowser.QMetaObjectValidator"),
                                             QStringLiteral("QMetaObject Validator"),
                                             QStringLiteral("Checks for common errors with meta objects, like invocable functions with unregistered parameter types."),
                                             &MetaObjectBrowser::scanForMetaObjectProblems,
                                             /*enabled=*/false);
}

void MetaObjectBrowser::rescanMetaTypes()
{
    Probe::instance()->metaObjectRegistry()->scanMetaTypes();
}

void MetaObjectBrowser::objectSelectionChanged(const QItemSelection &selection)
{
    QModelIndex index;
    if (selection.size() == 1)
        index = selection.first().topLeft();

    if (index.isValid()) {
        const QMetaObject *metaObject = index.data(QMetaObjectModel::MetaObjectRole).value<const QMetaObject *>();
        m_propertyController->setMetaObject(metaObject);
    } else {
        m_propertyController->setMetaObject(nullptr);
    }
}

void MetaObjectBrowser::qobjectSelected(QObject *obj)
{
    if (!obj)
        return;
    metaObjectSelected(obj->metaObject());
}

void MetaObjectBrowser::voidPtrObjectSelected(void *obj, const QString &typeName)
{
    if (typeName != QLatin1String("const QMetaObject*"))
        return;
    metaObjectSelected(static_cast<QMetaObject *>(obj));
}

void MetaObjectBrowser::metaObjectSelected(const QMetaObject *mo)
{
    if (!mo)
        return;
    mo = Probe::instance()->metaObjectRegistry()->canonicalMetaObject(mo);
    const auto indexes = m_model->match(m_model->index(0, 0), QMetaObjectModel::MetaObjectRole,
                                        QVariant::fromValue(mo),
                                        Qt::MatchExactly | Qt::MatchRecursive | Qt::MatchWrap);
    if (indexes.isEmpty()) {
        metaObjectSelected(mo->superClass());
        return;
    }
    ObjectBroker::selectionModel(m_model)->select(
        indexes.first(), QItemSelectionModel::Rows | QItemSelectionModel::ClearAndSelect);
}

QVector<QByteArray> MetaObjectBrowserFactory::selectableTypes() const
{
    return QVector<QByteArray>() << QObject::staticMetaObject.className() << "QMetaObject";
}

void MetaObjectBrowser::scanForMetaObjectProblems()
{
    doProblemScan(nullptr);
}

void MetaObjectBrowser::doProblemScan(const QMetaObject *parent)
{
    auto registry = Probe::instance()->metaObjectRegistry();

    const QVector<const QMetaObject *> metaObjects = registry->childrenOf(parent);

    for (const QMetaObject *mo : metaObjects) {
        if (!registry->isValid(mo) || !registry->isStatic(mo))
            continue;

        auto results = QMetaObjectValidator::check(mo);
        if (results != QMetaObjectValidatorResult::NoIssue) {
            // TODO do we want the Problem descriptions have more detail, i.e. have one problem listed
            //      for each method/property that has issues instead of one for each metaobject?
            Problem p;
            p.severity = Problem::Warning;
            QStringList issueList;

            if (results & QMetaObjectValidatorResult::SignalOverride)
                issueList.push_back(QStringLiteral("overrides base class signal"));
            if (results & QMetaObjectValidatorResult::UnknownMethodParameterType)
                issueList.push_back(QStringLiteral("uses a parameter type not registered with the meta type system"));
            if (results & QMetaObjectValidatorResult::PropertyOverride)
                issueList.push_back(QStringLiteral("overrides base class property"));
            if (results & QMetaObjectValidatorResult::UnknownPropertyType)
                issueList.push_back(QStringLiteral("has a property with a type not registered with the meta type system"));

            p.description = QStringLiteral("%1 %2.").arg(mo->className(), issueList.join(QStringLiteral(", ")));
            p.object = ObjectId(const_cast<QMetaObject *>(mo), "const QMetaObject*");
            p.problemId = QStringLiteral("com.kdab.GammaRay.MetaObjectBrowser.QMetaObjectValidator:%1").arg(reinterpret_cast<quintptr>(mo));
            p.findingCategory = Problem::Scan;
            ProblemCollector::addProblem(p);
        }

        doProblemScan(mo);
    }
}