Add the @QmlNamedElement decorator

Add the decorator and split the registration functions in order to be able to pass a different type name. [ChangeLog][PySide6] The @QmlNamedElement decorator has been added. Task-number: PYSIDE-1709 Change-Id: I081cd33313d7b9c19cb6403ee56ac9d8b1d9e606 Reviewed-by: Christian Tismer <tismer@stackless.com>
author: Friedemann Kleint <Friedemann.Kleint@qt.io> 2022-02-08 09:44:11 +0100
committer: Friedemann Kleint <Friedemann.Kleint@qt.io> 2022-02-09 13:38:52 +0100
commit: 5fccdc85bd3f84506f99cddb71feb2e0a0cccb57 (patch)
tree: b33d280125f54e96b49f135cd7d4bda2ae8eb54d /sources/pyside6
parent: 383e0bfc56e39d5f097e7957f986eb60e8052831 (diff)
8 files changed, 221 insertions, 8 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst b/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst
new file mode 100644
index 000000000..d603e2e83
--- /dev/null
+++ b/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst
@@ -0,0 +1,31 @@
+.. currentmodule:: PySide6.QtQml
+.. _QmlNamedElement:
+
+QmlNamedElement
+***************
+
+.. py:decorator:: QmlNamedElement
+
+   This decorator registers a class it is attached to for use in QML under
+   a name different from the class name, using global variables to specify
+   the import name and version.
+
+   .. code-block:: python
+
+      QML_IMPORT_NAME = "com.library.name"
+      QML_IMPORT_MAJOR_VERSION = 1
+      QML_IMPORT_MINOR_VERSION = 0 # Optional
+
+      @QmlNamedElement("ClassForQml")
+      class ClassWithSomeName(QObject):
+          ...
+
+   Afterwards the class may be used in QML:
+
+   .. code-block:: javascript
+
+      import com.library.name 1.0
+
+      ClassForQml {
+         // ...
+      }
diff --git a/sources/pyside6/libpysideqml/CMakeLists.txt b/sources/pyside6/libpysideqml/CMakeLists.txt
index 00589dc3c..2b12cfe30 100644
--- a/sources/pyside6/libpysideqml/CMakeLists.txt
+++ b/sources/pyside6/libpysideqml/CMakeLists.txt
@@ -5,6 +5,7 @@ set(libpysideqml_SRC
     pysideqmlregistertype.cpp
     pysideqmlmetacallerror.cpp
     pysideqmllistproperty.cpp
+    pysideqmlnamedelement.cpp
     pysideqmluncreatable.cpp
     pysideqmltypeinfo.cpp
 )
diff --git a/sources/pyside6/libpysideqml/pysideqml.cpp b/sources/pyside6/libpysideqml/pysideqml.cpp
index 7acab42c3..c6bcad549 100644
--- a/sources/pyside6/libpysideqml/pysideqml.cpp
+++ b/sources/pyside6/libpysideqml/pysideqml.cpp
@@ -39,7 +39,7 @@
 
 #include "pysideqml.h"
 #include "pysideqmllistproperty_p.h"
-#include "pysideqmluncreatable.h"
+#include "pysideqmlnamedelement_p.h"
 #include "pysideqmluncreatable.h"
 #include "pysideqmlmetacallerror_p.h"
 
@@ -51,6 +51,7 @@ namespace PySide::Qml
 void init(PyObject *module)
 {
     initQtQmlListProperty(module);
+    initQmlNamedElement(module);
     initQmlUncreatable(module);
     PySide::SignalManager::setQmlMetaCallErrorHandler(PySide::Qml::qmlMetaCallErrorHandler);
 }
diff --git a/sources/pyside6/libpysideqml/pysideqmlnamedelement.cpp b/sources/pyside6/libpysideqml/pysideqmlnamedelement.cpp
new file mode 100644
index 000000000..f13b911b2
--- /dev/null
+++ b/sources/pyside6/libpysideqml/pysideqmlnamedelement.cpp
@@ -0,0 +1,113 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt for Python.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** 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-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "pysideqmlnamedelement_p.h"
+#include "pysideqmltypeinfo_p.h"
+#include <pysideclassdecorator_p.h>
+#include <pysideqmlregistertype_p.h>
+
+#include <shiboken.h>
+#include <signature.h>
+
+#include <QtCore/QtGlobal>
+
+class PySideQmlNamedElementPrivate : public PySide::ClassDecorator::StringDecoratorPrivate
+{
+public:
+    PyObject *tp_call(PyObject *self, PyObject *args, PyObject * /* kw */) override;
+    const char *name() const override;
+};
+
+const char *PySideQmlNamedElementPrivate::name() const
+{
+    return "QmlNamedElement";
+}
+
+// The call operator is passed the class type and registers the type
+PyObject *PySideQmlNamedElementPrivate::tp_call(PyObject *self, PyObject *args, PyObject *)
+{
+    PyObject *klass = tp_call_check(args, CheckMode::WrappedType);
+    if (klass == nullptr)
+        return nullptr;
+
+    auto *data = DecoratorPrivate::get<PySideQmlNamedElementPrivate>(self);
+    auto *result = PySide::Qml::qmlNamedElementMacro(klass, data->string().c_str());
+    Py_XINCREF(result);
+    return result;
+}
+
+extern "C" {
+
+PyTypeObject *createPySideQmlNamedElementType(void)
+{
+    auto typeSlots =
+        PySide::ClassDecorator::Methods<PySideQmlNamedElementPrivate>::typeSlots();
+
+    PyType_Spec PySideQmlNamedElementType_spec = {
+        "2:PySide6.QtCore.qmlNamedElement",
+        sizeof(PySideClassDecorator),
+        0,
+        Py_TPFLAGS_DEFAULT,
+        typeSlots.data()
+    };
+    return SbkType_FromSpec(&PySideQmlNamedElementType_spec);
+}
+
+PyTypeObject *PySideQmlNamedElement_TypeF(void)
+{
+    static auto *type = createPySideQmlNamedElementType();
+    return type;
+}
+
+} // extern "C"
+
+static const char *qmlNamedElement_SignatureStrings[] = {
+    "PySide6.QtQml.QmlNamedElement(self,reason:str)",
+    nullptr // Sentinel
+};
+
+void initQmlNamedElement(PyObject *module)
+{
+    if (InitSignatureStrings(PySideQmlNamedElement_TypeF(), qmlNamedElement_SignatureStrings) < 0)
+        return;
+
+    Py_INCREF(PySideQmlNamedElement_TypeF());
+    PyModule_AddObject(module, "QmlNamedElement",
+                       reinterpret_cast<PyObject *>(PySideQmlNamedElement_TypeF()));
+}
diff --git a/sources/pyside6/libpysideqml/pysideqmlnamedelement_p.h b/sources/pyside6/libpysideqml/pysideqmlnamedelement_p.h
new file mode 100644
index 000000000..e31e7b6e3
--- /dev/null
+++ b/sources/pyside6/libpysideqml/pysideqmlnamedelement_p.h
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt for Python.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** 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-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef PYSIDEQMLNAMEDELEMENT_P_H
+#define PYSIDEQMLNAMEDELEMENT_P_H
+
+#include <sbkpython.h>
+
+void initQmlNamedElement(PyObject *module);
+
+#endif // PYSIDEQMLNAMEDELEMENT_P_H
diff --git a/sources/pyside6/libpysideqml/pysideqmlregistertype.cpp b/sources/pyside6/libpysideqml/pysideqmlregistertype.cpp
index ac72b056b..9e5ada666 100644
--- a/sources/pyside6/libpysideqml/pysideqmlregistertype.cpp
+++ b/sources/pyside6/libpysideqml/pysideqmlregistertype.cpp
@@ -374,6 +374,7 @@ enum class RegisterMode {
 
 static PyObject *qmlElementMacroHelper(PyObject *pyObj,
                                        const char *decoratorName,
+                                       const char *typeName = nullptr,
                                        RegisterMode mode = RegisterMode::Normal,
                                        const char *noCreationReason = nullptr)
 {
@@ -383,7 +384,8 @@ static PyObject *qmlElementMacroHelper(PyObject *pyObj,
     }
 
     PyTypeObject *pyObjType = reinterpret_cast<PyTypeObject *>(pyObj);
-    const char *typeName = pyObjType->tp_name;
+    if (typeName == nullptr)
+        typeName = pyObjType->tp_name;
     if (!PySequence_Contains(pyObjType->tp_mro, reinterpret_cast<PyObject *>(qObjectType()))) {
         PyErr_Format(PyExc_TypeError, "This decorator can only be used with classes inherited from QObject, got %s.",
                      typeName);
@@ -431,7 +433,8 @@ static PyObject *qmlElementMacroHelper(PyObject *pyObj,
 
 namespace PySide::Qml {
 
-PyObject *qmlElementMacro(PyObject *pyObj)
+PyObject *qmlElementMacro(PyObject *pyObj, const char *decoratorName,
+                          const char *typeName = nullptr)
 {
     RegisterMode mode = RegisterMode::Normal;
     const auto &info = PySide::Qml::qmlTypeInfo(pyObj);
@@ -439,13 +442,23 @@ PyObject *qmlElementMacro(PyObject *pyObj)
         mode = RegisterMode::Singleton;
     else if (info.flags.testFlag(PySide::Qml::QmlTypeFlag::Uncreatable))
         mode = RegisterMode::Uncreatable;
-    return qmlElementMacroHelper(pyObj, "QmlElement", mode,
+    return qmlElementMacroHelper(pyObj, decoratorName, typeName, mode,
                                  info.noCreationReason.c_str());
 }
 
+PyObject *qmlElementMacro(PyObject *pyObj)
+{
+    return qmlElementMacro(pyObj, "QmlElement");
+}
+
+PyObject *qmlNamedElementMacro(PyObject *pyObj, const char *typeName)
+{
+    return qmlElementMacro(pyObj, "QmlNamedElement", qstrdup(typeName));
+}
+
 PyObject *qmlAnonymousMacro(PyObject *pyObj)
 {
-    return qmlElementMacroHelper(pyObj, "QmlAnonymous",
+    return qmlElementMacroHelper(pyObj, "QmlAnonymous", nullptr,
                                  RegisterMode::Anonymous);
 }
 
diff --git a/sources/pyside6/libpysideqml/pysideqmlregistertype_p.h b/sources/pyside6/libpysideqml/pysideqmlregistertype_p.h
index d357a0392..c4677c6f7 100644
--- a/sources/pyside6/libpysideqml/pysideqmlregistertype_p.h
+++ b/sources/pyside6/libpysideqml/pysideqmlregistertype_p.h
@@ -44,4 +44,11 @@
 
 PyTypeObject *qObjectType();
 
+
+namespace PySide::Qml {
+
+PyObject *qmlNamedElementMacro(PyObject *pyObj, const char *typeName);
+
+}
+
 #endif // PYSIDEQMLREGISTERTYPE_P_H
diff --git a/sources/pyside6/tests/QtQml/registertype.py b/sources/pyside6/tests/QtQml/registertype.py
index 2bfb38d9a..cc5c41706 100644
--- a/sources/pyside6/tests/QtQml/registertype.py
+++ b/sources/pyside6/tests/QtQml/registertype.py
@@ -40,7 +40,7 @@ from helper.helper import quickview_errorstring
 from PySide6.QtCore import Property, QObject, QTimer, QUrl
 from PySide6.QtGui import QGuiApplication, QPen, QColor, QPainter
 from PySide6.QtQml import (qjsEngine, qmlContext, qmlEngine, qmlRegisterType,
-                           ListProperty, QmlElement)
+                           ListProperty, QmlElement, QmlNamedElement)
 from PySide6.QtQuick import QQuickView, QQuickItem, QQuickPaintedItem
 
 
@@ -87,8 +87,8 @@ class PieSlice (QQuickPaintedItem):
         paintCalled = True
 
 
-@QmlElement
-class PieChart (QQuickItem):
+@QmlNamedElement("PieChart")
+class PieChartOriginalName(QQuickItem):
     def __init__(self, parent=None):
         QQuickItem.__init__(self, parent)
         self._name = ''
author	Friedemann Kleint <Friedemann.Kleint@qt.io>	2022-02-08 09:44:11 +0100
committer	Friedemann Kleint <Friedemann.Kleint@qt.io>	2022-02-09 13:38:52 +0100
commit	5fccdc85bd3f84506f99cddb71feb2e0a0cccb57 (patch)
tree	b33d280125f54e96b49f135cd7d4bda2ae8eb54d /sources/pyside6
parent	383e0bfc56e39d5f097e7957f986eb60e8052831 (diff)