Files
qt-creator/share/qtcreator/qml/qmlpuppet/qmlprivategate/qmlprivategate.cpp
Ulf Hermann 06b09cf4a9 QmlPuppet: Don't compare C string literals with ==
Change-Id: Idaafbc650849744af660e896bf875bdd43e6ae36
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@theqtcompany.com>
2016-04-21 09:50:25 +00:00

796 lines
25 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "qmlprivategate.h"
#include "metaobject.h"
#include "designercustomobjectdata.h"
#include <objectnodeinstance.h>
#include <nodeinstanceserver.h>
#include <QQuickItem>
#include <QQmlComponent>
#include <QFileInfo>
#include <private/qabstractanimation_p.h>
#include <private/qobject_p.h>
#include <private/qquickbehavior_p.h>
#include <private/qquicktext_p.h>
#include <private/qquicktextinput_p.h>
#include <private/qquicktextedit_p.h>
#include <private/qquicktransition_p.h>
#include <private/qquickanimation_p.h>
#include <private/qqmlmetatype_p.h>
#include <private/qqmltimer_p.h>
#include <private/qquickstategroup_p.h>
#include <private/qquickpropertychanges_p.h>
#include <private/qquickstateoperations_p.h>
#include <designersupportdelegate.h>
#include <cstring>
namespace QmlDesigner {
namespace Internal {
namespace QmlPrivateGate {
bool isPropertyBlackListed(const QmlDesigner::PropertyName &propertyName)
{
if (propertyName.contains(".") && propertyName.contains("__"))
return true;
if (propertyName.count(".") > 1)
return true;
return false;
}
static void addToPropertyNameListIfNotBlackListed(PropertyNameList *propertyNameList, const PropertyName &propertyName)
{
if (!isPropertyBlackListed(propertyName))
propertyNameList->append(propertyName);
}
PropertyNameList allPropertyNames(QObject *object,
const PropertyName &baseName,
QObjectList *inspectedObjects)
{
PropertyNameList propertyNameList;
QObjectList localObjectList;
if (inspectedObjects == 0)
inspectedObjects = &localObjectList;
if (inspectedObjects->contains(object))
return propertyNameList;
inspectedObjects->append(object);
const QMetaObject *metaObject = object->metaObject();
for (int index = 0; index < metaObject->propertyCount(); ++index) {
QMetaProperty metaProperty = metaObject->property(index);
QQmlProperty declarativeProperty(object, QLatin1String(metaProperty.name()));
if (declarativeProperty.isValid() && declarativeProperty.propertyTypeCategory() == QQmlProperty::Object) {
if (declarativeProperty.name() != "parent") {
QObject *childObject = QQmlMetaType::toQObject(declarativeProperty.read());
if (childObject)
propertyNameList.append(allPropertyNames(childObject, baseName + PropertyName(metaProperty.name()) + '.', inspectedObjects));
}
} else if (QQmlValueTypeFactory::valueType(metaProperty.userType())) {
QQmlValueType *valueType = QQmlValueTypeFactory::valueType(metaProperty.userType());
valueType->setValue(metaProperty.read(object));
propertyNameList.append(baseName + PropertyName(metaProperty.name()));
propertyNameList.append(allPropertyNames(valueType, baseName + PropertyName(metaProperty.name()) + '.', inspectedObjects));
} else {
propertyNameList.append(baseName + PropertyName(metaProperty.name()));
}
}
return propertyNameList;
}
PropertyNameList propertyNameListForWritableProperties(QObject *object,
const PropertyName &baseName,
QObjectList *inspectedObjects)
{
PropertyNameList propertyNameList;
QObjectList localObjectList;
if (inspectedObjects == 0)
inspectedObjects = &localObjectList;
if (inspectedObjects->contains(object))
return propertyNameList;
inspectedObjects->append(object);
const QMetaObject *metaObject = object->metaObject();
for (int index = 0; index < metaObject->propertyCount(); ++index) {
QMetaProperty metaProperty = metaObject->property(index);
QQmlProperty declarativeProperty(object, QLatin1String(metaProperty.name()));
if (declarativeProperty.isValid() && !declarativeProperty.isWritable() && declarativeProperty.propertyTypeCategory() == QQmlProperty::Object) {
if (declarativeProperty.name() != "parent") {
QObject *childObject = QQmlMetaType::toQObject(declarativeProperty.read());
if (childObject)
propertyNameList.append(propertyNameListForWritableProperties(childObject, baseName + PropertyName(metaProperty.name()) + '.', inspectedObjects));
}
} else if (QQmlValueTypeFactory::valueType(metaProperty.userType())) {
QQmlValueType *valueType = QQmlValueTypeFactory::valueType(metaProperty.userType());
valueType->setValue(metaProperty.read(object));
propertyNameList.append(propertyNameListForWritableProperties(valueType, baseName + PropertyName(metaProperty.name()) + '.', inspectedObjects));
}
if (metaProperty.isReadable() && metaProperty.isWritable()) {
addToPropertyNameListIfNotBlackListed(&propertyNameList, baseName + PropertyName(metaProperty.name()));
}
}
return propertyNameList;
}
static void stopAnimation(QObject *object)
{
if (object == 0)
return;
QQuickTransition *transition = qobject_cast<QQuickTransition*>(object);
QQuickAbstractAnimation *animation = qobject_cast<QQuickAbstractAnimation*>(object);
QQmlTimer *timer = qobject_cast<QQmlTimer*>(object);
if (transition) {
transition->setFromState("");
transition->setToState("");
} else if (animation) {
// QQuickScriptAction *scriptAimation = qobject_cast<QQuickScriptAction*>(animation);
// if (scriptAimation) FIXME
// scriptAimation->setScript(QQmlScriptString());
animation->setLoops(1);
animation->complete();
animation->setDisableUserControl();
} else if (timer) {
timer->blockSignals(true);
}
}
static void allSubObject(QObject *object, QObjectList &objectList)
{
// don't add null pointer and stop if the object is already in the list
if (!object || objectList.contains(object))
return;
objectList.append(object);
for (int index = QObject::staticMetaObject.propertyOffset();
index < object->metaObject()->propertyCount();
index++) {
QMetaProperty metaProperty = object->metaObject()->property(index);
// search recursive in property objects
if (metaProperty.isReadable()
&& metaProperty.isWritable()
&& QQmlMetaType::isQObject(metaProperty.userType())) {
if (strcmp(metaProperty.name(), "parent") != 0) {
QObject *propertyObject = QQmlMetaType::toQObject(metaProperty.read(object));
allSubObject(propertyObject, objectList);
}
}
// search recursive in property object lists
if (metaProperty.isReadable()
&& QQmlMetaType::isList(metaProperty.userType())) {
QQmlListReference list(object, metaProperty.name());
if (list.canCount() && list.canAt()) {
for (int i = 0; i < list.count(); i++) {
QObject *propertyObject = list.at(i);
allSubObject(propertyObject, objectList);
}
}
}
}
// search recursive in object children list
foreach (QObject *childObject, object->children()) {
allSubObject(childObject, objectList);
}
// search recursive in quick item childItems list
QQuickItem *quickItem = qobject_cast<QQuickItem*>(object);
if (quickItem) {
foreach (QQuickItem *childItem, quickItem->childItems()) {
allSubObject(childItem, objectList);
}
}
}
static void fixResourcePathsForObject(QObject *object)
{
if (qgetenv("QMLDESIGNER_RC_PATHS").isEmpty())
return;
PropertyNameList propertyNameList = propertyNameListForWritableProperties(object);
foreach (const PropertyName &propertyName, propertyNameList) {
QQmlProperty property(object, QString::fromUtf8(propertyName), QQmlEngine::contextForObject(object));
const QVariant value = property.read();
const QVariant fixedValue = fixResourcePaths(value);
if (value != fixedValue) {
property.write(fixedValue);
}
}
}
void tweakObjects(QObject *object)
{
QObjectList objectList;
allSubObject(object, objectList);
foreach (QObject* childObject, objectList) {
stopAnimation(childObject);
fixResourcePathsForObject(childObject);
}
}
static QObject *createDummyWindow(QQmlEngine *engine)
{
QQmlComponent component(engine, QUrl(QStringLiteral("qrc:/qtquickplugin/mockfiles/Window.qml")));
return component.create();
}
static bool isWindowMetaObject(const QMetaObject *metaObject)
{
if (metaObject) {
if (metaObject->className() == QByteArrayLiteral("QWindow"))
return true;
return isWindowMetaObject(metaObject->superClass());
}
return false;
}
static bool isWindow(QObject *object) {
if (object)
return isWindowMetaObject(object->metaObject());
return false;
}
static QQmlType *getQmlType(const QString &typeName, int majorNumber, int minorNumber)
{
return QQmlMetaType::qmlType(typeName, majorNumber, minorNumber);
}
static bool isCrashingType(QQmlType *type)
{
if (type) {
if (type->qmlTypeName() == QStringLiteral("QtMultimedia/MediaPlayer"))
return true;
if (type->qmlTypeName() == QStringLiteral("QtMultimedia/Audio"))
return true;
if (type->qmlTypeName() == QStringLiteral("QtQuick.Controls/MenuItem"))
return true;
if (type->qmlTypeName() == QStringLiteral("QtQuick.Controls/Menu"))
return true;
if (type->qmlTypeName() == QStringLiteral("QtQuick/Timer"))
return true;
}
return false;
}
void createNewDynamicProperty(QObject *object, QQmlEngine *engine, const QString &name)
{
MetaObject::getNodeInstanceMetaObject(object, engine)->createNewDynamicProperty(name);
}
void registerNodeInstanceMetaObject(QObject *object, QQmlEngine *engine)
{
// we just create one and the ownership goes automatically to the object in nodeinstance see init method
MetaObject::getNodeInstanceMetaObject(object, engine);
}
QObject *createPrimitive(const QString &typeName, int majorNumber, int minorNumber, QQmlContext *context)
{
ComponentCompleteDisabler disableComponentComplete;
Q_UNUSED(disableComponentComplete)
QObject *object = 0;
QQmlType *type = getQmlType(typeName, majorNumber, minorNumber);
if (isCrashingType(type)) {
object = new QObject;
} else if (type) {
#if (QT_VERSION >= QT_VERSION_CHECK(5, 2, 0)) // TODO remove hack later if we only support >= 5.2
if ( type->isComposite()) {
object = createComponent(type->sourceUrl(), context);
} else
#endif
{
if (type->typeName() == "QQmlComponent") {
object = new QQmlComponent(context->engine(), 0);
} else {
object = type->create();
}
}
if (isWindow(object)) {
delete object;
object = createDummyWindow(context->engine());
}
}
if (!object) {
qWarning() << "QuickDesigner: Cannot create an object of type"
<< QString("%1 %2,%3").arg(typeName).arg(majorNumber).arg(minorNumber)
<< "- type isn't known to declarative meta type system";
}
tweakObjects(object);
if (object && QQmlEngine::contextForObject(object) == 0)
QQmlEngine::setContextForObject(object, context);
QQmlEngine::setObjectOwnership(object, QQmlEngine::CppOwnership);
return object;
}
QVariant fixResourcePaths(const QVariant &value)
{
if (value.type() == QVariant::Url)
{
const QUrl url = value.toUrl();
if (url.scheme() == QLatin1String("qrc")) {
const QString path = QLatin1String("qrc:") + url.path();
QString qrcSearchPath = QString::fromLocal8Bit(qgetenv("QMLDESIGNER_RC_PATHS"));
if (!qrcSearchPath.isEmpty()) {
const QStringList searchPaths = qrcSearchPath.split(QLatin1Char(';'));
foreach (const QString &qrcPath, searchPaths) {
const QStringList qrcDefintion = qrcPath.split(QLatin1Char('='));
if (qrcDefintion.count() == 2) {
QString fixedPath = path;
fixedPath.replace(QLatin1String("qrc:") + qrcDefintion.first(), qrcDefintion.last() + QLatin1Char('/'));
if (QFileInfo(fixedPath).exists()) {
fixedPath.replace(QLatin1String("//"), QLatin1String("/"));
fixedPath.replace(QLatin1Char('\\'), QLatin1Char('/'));
return QUrl(fixedPath);
}
}
}
}
}
}
if (value.type() == QVariant::String) {
const QString str = value.toString();
if (str.contains(QLatin1String("qrc:"))) {
QString qrcSearchPath = QString::fromLocal8Bit(qgetenv("QMLDESIGNER_RC_PATHS"));
if (!qrcSearchPath.isEmpty()) {
const QStringList searchPaths = qrcSearchPath.split(QLatin1Char(';'));
foreach (const QString &qrcPath, searchPaths) {
const QStringList qrcDefintion = qrcPath.split(QLatin1Char('='));
if (qrcDefintion.count() == 2) {
QString fixedPath = str;
fixedPath.replace(QLatin1String("qrc:") + qrcDefintion.first(), qrcDefintion.last() + QLatin1Char('/'));
if (QFileInfo(fixedPath).exists()) {
fixedPath.replace(QLatin1String("//"), QLatin1String("/"));
fixedPath.replace(QLatin1Char('\\'), QLatin1Char('/'));
return fixedPath;
}
}
}
}
}
}
return value;
}
QObject *createComponent(const QUrl &componentUrl, QQmlContext *context)
{
ComponentCompleteDisabler disableComponentComplete;
Q_UNUSED(disableComponentComplete)
QQmlComponent component(context->engine(), componentUrl);
QObject *object = component.beginCreate(context);
QmlPrivateGate::tweakObjects(object);
component.completeCreate();
QQmlEngine::setObjectOwnership(object, QQmlEngine::CppOwnership);
if (component.isError()) {
qWarning() << "Error in:" << Q_FUNC_INFO << componentUrl;
foreach (const QQmlError &error, component.errors())
qWarning() << error;
}
return object;
}
bool hasFullImplementedListInterface(const QQmlListReference &list)
{
return list.isValid() && list.canCount() && list.canAt() && list.canAppend() && list.canClear();
}
void registerCustomData(QObject *object)
{
DesignerCustomObjectData::registerData(object);
}
QVariant getResetValue(QObject *object, const PropertyName &propertyName)
{
return DesignerCustomObjectData::getResetValue(object, propertyName);
}
void doResetProperty(QObject *object, QQmlContext *context, const PropertyName &propertyName)
{
DesignerCustomObjectData::doResetProperty(object, context, propertyName);
}
bool hasValidResetBinding(QObject *object, const PropertyName &propertyName)
{
return DesignerCustomObjectData::hasValidResetBinding(object, propertyName);
}
bool hasBindingForProperty(QObject *object, QQmlContext *context, const PropertyName &propertyName, bool *hasChanged)
{
return DesignerCustomObjectData::hasBindingForProperty(object, context, propertyName, hasChanged);
}
void setPropertyBinding(QObject *object, QQmlContext *context, const PropertyName &propertyName, const QString &expression)
{
DesignerCustomObjectData::setPropertyBinding(object, context, propertyName, expression);
}
void doComponentCompleteRecursive(QObject *object, NodeInstanceServer *nodeInstanceServer)
{
if (object) {
QQuickItem *item = qobject_cast<QQuickItem*>(object);
if (item && DesignerSupport::isComponentComplete(item))
return;
QList<QObject*> childList = object->children();
if (item) {
foreach (QQuickItem *childItem, item->childItems()) {
if (!childList.contains(childItem))
childList.append(childItem);
}
}
foreach (QObject *child, childList) {
if (!nodeInstanceServer->hasInstanceForObject(child))
doComponentCompleteRecursive(child, nodeInstanceServer);
}
if (item) {
static_cast<QQmlParserStatus*>(item)->componentComplete();
} else {
QQmlParserStatus *qmlParserStatus = dynamic_cast< QQmlParserStatus*>(object);
if (qmlParserStatus)
qmlParserStatus->componentComplete();
}
}
}
void keepBindingFromGettingDeleted(QObject *object, QQmlContext *context, const PropertyName &propertyName)
{
DesignerCustomObjectData::keepBindingFromGettingDeleted(object, context, propertyName);
}
bool objectWasDeleted(QObject *object)
{
return QObjectPrivate::get(object)->wasDeleted;
}
void disableNativeTextRendering(QQuickItem *item)
{
QQuickText *text = qobject_cast<QQuickText*>(item);
if (text)
text->setRenderType(QQuickText::QtRendering);
QQuickTextInput *textInput = qobject_cast<QQuickTextInput*>(item);
if (textInput)
textInput->setRenderType(QQuickTextInput::QtRendering);
QQuickTextEdit *textEdit = qobject_cast<QQuickTextEdit*>(item);
if (textEdit)
textEdit->setRenderType(QQuickTextEdit::QtRendering);
}
void disableTextCursor(QQuickItem *item)
{
foreach (QQuickItem *childItem, item->childItems())
disableTextCursor(childItem);
QQuickTextInput *textInput = qobject_cast<QQuickTextInput*>(item);
if (textInput)
textInput->setCursorVisible(false);
QQuickTextEdit *textEdit = qobject_cast<QQuickTextEdit*>(item);
if (textEdit)
textEdit->setCursorVisible(false);
}
void disableTransition(QObject *object)
{
QQuickTransition *transition = qobject_cast<QQuickTransition*>(object);
Q_ASSERT(transition);
transition->setToState("invalidState");
transition->setFromState("invalidState");
}
void disableBehaivour(QObject *object)
{
QQuickBehavior* behavior = qobject_cast<QQuickBehavior*>(object);
Q_ASSERT(behavior);
behavior->setEnabled(false);
}
void stopUnifiedTimer()
{
QUnifiedTimer::instance()->setSlowdownFactor(0.00001);
QUnifiedTimer::instance()->setSlowModeEnabled(true);
}
bool isPropertyQObject(const QMetaProperty &metaProperty)
{
return QQmlMetaType::isQObject(metaProperty.userType());
}
QObject *readQObjectProperty(const QMetaProperty &metaProperty, QObject *object)
{
return QQmlMetaType::toQObject(metaProperty.read(object));
}
namespace States {
bool isStateActive(QObject *object, QQmlContext *context)
{
QQuickState *stateObject = qobject_cast<QQuickState*>(object);
if (!stateObject)
return false;
QQuickStateGroup *stateGroup = stateObject->stateGroup();
QQmlProperty property(object, "name", context);
return stateObject && stateGroup && stateGroup->state() == property.read();
}
void activateState(QObject *object, QQmlContext *context)
{
QQuickState *stateObject = qobject_cast<QQuickState*>(object);
if (!stateObject)
return;
QQuickStateGroup *stateGroup = stateObject->stateGroup();
QQmlProperty property(object, "name", context);
stateGroup->setState(property.read().toString());
}
void deactivateState(QObject *object)
{
QQuickState *stateObject = qobject_cast<QQuickState*>(object);
if (!stateObject)
return;
QQuickStateGroup *stateGroup = stateObject->stateGroup();
if (stateGroup)
stateGroup->setState(QString());
}
bool changeValueInRevertList(QObject *state, QObject *target, const PropertyName &propertyName, const QVariant &value)
{
QQuickState *stateObject = qobject_cast<QQuickState*>(state);
if (!stateObject)
return false;
return stateObject->changeValueInRevertList(target, QString::fromUtf8(propertyName), value);
}
bool updateStateBinding(QObject *state, QObject *target, const PropertyName &propertyName, const QString &expression)
{
QQuickState *stateObject = qobject_cast<QQuickState*>(state);
if (!stateObject)
return false;
return stateObject->changeValueInRevertList(target, QString::fromUtf8(propertyName), expression);
}
bool resetStateProperty(QObject *state, QObject *target, const PropertyName &propertyName, const QVariant & /* resetValue */)
{
QQuickState *stateObject = qobject_cast<QQuickState*>(state);
if (!stateObject)
return false;
return stateObject->removeEntryFromRevertList(target, QString::fromUtf8(propertyName));
}
} //namespace States
namespace PropertyChanges {
void detachFromState(QObject *propertyChanges)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return;
propertyChange->detachFromState();
}
void attachToState(QObject *propertyChanges)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return;
propertyChange->attachToState();
}
QObject *targetObject(QObject *propertyChanges)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return 0;
return propertyChange->object();
}
void removeProperty(QObject *propertyChanges, const PropertyName &propertyName)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return;
propertyChange->removeProperty(QString::fromUtf8(propertyName));
}
QVariant getProperty(QObject *propertyChanges, const PropertyName &propertyName)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return QVariant();
return propertyChange->property(QString::fromUtf8(propertyName));
}
void changeValue(QObject *propertyChanges, const PropertyName &propertyName, const QVariant &value)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return;
propertyChange->changeValue(QString::fromUtf8(propertyName), value);
}
void changeExpression(QObject *propertyChanges, const PropertyName &propertyName, const QString &expression)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return;
propertyChange->changeExpression(QString::fromUtf8(propertyName), expression);
}
QObject *stateObject(QObject *propertyChanges)
{
QQuickPropertyChanges *propertyChange = qobject_cast<QQuickPropertyChanges*>(propertyChanges);
if (!propertyChange)
return 0;
return propertyChange->state();
}
bool isNormalProperty(const PropertyName &propertyName)
{
QMetaObject metaObject = QQuickPropertyChanges::staticMetaObject;
return (metaObject.indexOfProperty(propertyName) > 0); // 'restoreEntryValues', 'explicit'
}
} // namespace PropertyChanges
bool isSubclassOf(QObject *object, const QByteArray &superTypeName)
{
if (object == 0)
return false;
const QMetaObject *metaObject = object->metaObject();
while (metaObject) {
QQmlType *qmlType = QQmlMetaType::qmlType(metaObject);
if (qmlType && qmlType->qmlTypeName() == superTypeName) // ignore version numbers
return true;
if (metaObject->className() == superTypeName)
return true;
metaObject = metaObject->superClass();
}
return false;
}
void getPropertyCache(QObject *object, QQmlEngine *engine)
{
QQmlEnginePrivate::get(engine)->cache(object->metaObject());
}
void registerNotifyPropertyChangeCallBack(void (*callback)(QObject *, const PropertyName &))
{
MetaObject::registerNotifyPropertyChangeCallBack(callback);
}
ComponentCompleteDisabler::ComponentCompleteDisabler()
{
DesignerSupport::disableComponentComplete();
}
ComponentCompleteDisabler::~ComponentCompleteDisabler()
{
DesignerSupport::enableComponentComplete();
}
} // namespace QmlPrivateGate
} // namespace Internal
} // namespace QmlDesigner