summaryrefslogtreecommitdiffstats
path: root/src/tools/uic/customwidgetsinfo.cpp
blob: 6ec418634c27a2fc41f743a7d8de6e181781722a (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
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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include "customwidgetsinfo.h"
#include "driver.h"
#include "ui4.h"
#include "utils.h"

#include <utility>

QT_BEGIN_NAMESPACE

using namespace Qt::StringLiterals;

CustomWidgetsInfo::CustomWidgetsInfo() = default;

void CustomWidgetsInfo::acceptUI(DomUI *node)
{
    m_customWidgets.clear();

    if (node->elementCustomWidgets())
        acceptCustomWidgets(node->elementCustomWidgets());
}

void CustomWidgetsInfo::acceptCustomWidgets(DomCustomWidgets *node)
{
    TreeWalker::acceptCustomWidgets(node);
}

void CustomWidgetsInfo::acceptCustomWidget(DomCustomWidget *node)
{
    if (node->elementClass().isEmpty())
        return;

    m_customWidgets.insert(node->elementClass(), node);
}

bool CustomWidgetsInfo::extends(const QString &classNameIn, QAnyStringView baseClassName) const
{
    if (classNameIn == baseClassName)
        return true;

    QString className = classNameIn;
    while (const DomCustomWidget *c = customWidget(className)) {
        const QString extends = c->elementExtends();
        if (className == extends) // Faulty legacy custom widget entries exist.
            return false;
        if (extends == baseClassName)
            return true;
        className = extends;
    }
    return false;
}

bool CustomWidgetsInfo::extendsOneOf(const QString &classNameIn,
                                     const QStringList &baseClassNames) const
{
    if (baseClassNames.contains(classNameIn))
        return true;

    QString className = classNameIn;
    while (const DomCustomWidget *c = customWidget(className)) {
        const QString extends = c->elementExtends();
        if (className == extends) // Faulty legacy custom widget entries exist.
            return false;
        if (baseClassNames.contains(extends))
            return true;
        className = extends;
    }
    return false;
}

bool CustomWidgetsInfo::isCustomWidgetContainer(const QString &className) const
{
    if (const DomCustomWidget *dcw = m_customWidgets.value(className, nullptr))
        if (dcw->hasElementContainer())
            return dcw->elementContainer() != 0;
    return false;
}

// FIXME in 7.0 - QTBUG-124241
// Remove isAmbiguous logic when widget slots have been disambiguated.
bool CustomWidgetsInfo::isAmbiguous(const QString &className, const QString &signature,
                                    QMetaMethod::MethodType type) const
{
    using TypeMap = QHash<QString, QMetaMethod::MethodType>;
    struct AmbiguousInClass {
        QLatin1StringView className;
        TypeMap methodMap;
    };

    static const QList<AmbiguousInClass> ambiguousList = {

        {"QAction"_L1, {{"triggered"_L1, QMetaMethod::Signal}}},
        {"QCommandLinkButton"_L1, {{"triggered"_L1, QMetaMethod::Signal},
                                   {"clicked"_L1, QMetaMethod::Signal}}},
        {"QPushButton"_L1, {{"triggered"_L1, QMetaMethod::Signal},
                            {"clicked"_L1, QMetaMethod::Signal}}},
        {"QCheckBox"_L1, {{"triggered"_L1, QMetaMethod::Signal},
                          {"clicked"_L1, QMetaMethod::Signal}}},
        {"QRadioButton"_L1, {{"triggered"_L1, QMetaMethod::Signal},
                             {"clicked"_L1, QMetaMethod::Signal}}},
        {"QToolButton"_L1,  {{"triggered"_L1, QMetaMethod::Signal},
                            {"clicked"_L1, QMetaMethod::Signal}}},
        {"QLabel"_L1, {{"setNum"_L1, QMetaMethod::Slot}}},
        {"QGraphicsView"_L1, {{"invalidateScene"_L1, QMetaMethod::Slot}}},
        {"QListView"_L1, {{"dataChanged"_L1, QMetaMethod::Slot}}},
        {"QColumnView"_L1, {{"dataChanged"_L1, QMetaMethod::Slot}}},
        {"QListWidget"_L1, {{"dataChanged"_L1, QMetaMethod::Slot},
                           {"scrollToItem"_L1, QMetaMethod::Slot}}},
        {"QTableView"_L1, {{"dataChanged"_L1, QMetaMethod::Slot}}},
        {"QTableWidget"_L1, {{"dataChanged"_L1, QMetaMethod::Slot},
                            {"scrollToItem"_L1, QMetaMethod::Slot}}},
        {"QTreeView"_L1, {{"dataChanged"_L1, QMetaMethod::Slot},
                         {"verticalScrollbarValueChanged"_L1, QMetaMethod::Slot},
                         {"expandRecursively"_L1, QMetaMethod::Slot}}},
        {"QTreeWidget"_L1, {{"dataChanged"_L1, QMetaMethod::Slot},
                           {"verticalScrollbarValueChanged"_L1, QMetaMethod::Slot}
                           ,{"expandRecursively"_L1, QMetaMethod::Slot}
                           ,{"scrollToItem"_L1, QMetaMethod::Slot}}},
        {"QUndoView"_L1, {{"dataChanged"_L1, QMetaMethod::Slot}}},
        {"QLCDNumber"_L1, {{"display"_L1, QMetaMethod::Slot}}},
        {"QMenuBar"_L1, {{"setVisible"_L1, QMetaMethod::Slot}}},
        {"QTextBrowser"_L1, {{"setSource"_L1, QMetaMethod::Slot}}},

        /*
        The following widgets with ambiguities are not used in the widget designer:

        {"QSplashScreen"_L1, {{"showMessage"_L1, QMetaMethod::Slot}}},
        {"QCompleter"_L1, {{"activated"_L1, QMetaMethod::Signal},
                          {"highlighted"_L1, QMetaMethod::Signal}}},
        {"QSystemTrayIcon"_L1, {{"showMessage"_L1, QMetaMethod::Slot}}},
        {"QStyledItemDelegate"_L1, {{"closeEditor"_L1, QMetaMethod::Signal}}},
        {"QErrorMessage"_L1, {{"showMessage"_L1, QMetaMethod::Slot}}},
        {"QGraphicsDropShadowEffect"_L1, {{"setOffset"_L1, QMetaMethod::Slot}}},
        {"QGraphicsScene"_L1, {{"invalidate"_L1, QMetaMethod::Slot}}},
        {"QItemDelegate"_L1, {{"closeEditor"_L1, QMetaMethod::Signal}}}
        */
    };

    for (auto it = ambiguousList.constBegin(); it != ambiguousList.constEnd(); ++it) {
        if (extends(className, it->className)) {
            const qsizetype pos = signature.indexOf(u'(');
            const QString method = signature.left(pos);
            const auto methodIterator = it->methodMap.find(method);
            return methodIterator != it->methodMap.constEnd() && type == methodIterator.value();
        }
    }
    return false;
}

// Is it ambiguous, resulting in different signals for Python
// "QAbstractButton::clicked(checked=false)"
bool CustomWidgetsInfo::isAmbiguousSignal(const QString &className,
                                          const QString &signalSignature) const
{
    return isAmbiguous(className, signalSignature, QMetaMethod::Signal);
}

bool CustomWidgetsInfo::isAmbiguousSlot(const QString &className,
                                        const QString &signalSignature) const
{
    return isAmbiguous(className, signalSignature, QMetaMethod::Slot);
}

QString CustomWidgetsInfo::realClassName(const QString &className) const
{
    if (className == "Line"_L1)
        return u"QFrame"_s;

    return className;
}

QString CustomWidgetsInfo::customWidgetAddPageMethod(const QString &name) const
{
    if (DomCustomWidget *dcw = m_customWidgets.value(name, nullptr))
        return dcw->elementAddPageMethod();
    return QString();
}

// add page methods for simple containers taking only the widget parameter
QString CustomWidgetsInfo::simpleContainerAddPageMethod(const QString &name) const
{
    using AddPageMethod = std::pair<QString, QString>;

    static const AddPageMethod addPageMethods[] = {
        {u"QStackedWidget"_s, u"addWidget"_s},
        {u"QToolBar"_s, u"addWidget"_s},
        {u"QDockWidget"_s, u"setWidget"_s},
        {u"QScrollArea"_s, u"setWidget"_s},
        {u"QSplitter"_s, u"addWidget"_s},
        {u"QMdiArea"_s, u"addSubWindow"_s}
    };
    for (const auto &m : addPageMethods) {
        if (extends(name, m.first))
            return m.second;
    }
    return QString();
}

QT_END_NAMESPACE