Add a tool to dump meta objects of QObject-derived classes

Task-number: PYSIDE-957
Change-Id: Ic5790098eef8e554cd437254277a78db4da8264a
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Christian Tismer <tismer@stackless.com>

3 files changed, 197 insertions, 0 deletions

diff --git a/tools/dump_metaobject.py b/tools/dump_metaobject.py
new file mode 100644
index 000000000..7cb7312c9
--- /dev/null
+++ b/tools/dump_metaobject.py
@@ -0,0 +1,127 @@
+#############################################################################
+##
+## Copyright (C) 2020 The Qt Company Ltd.
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of the Qt for Python project.
+##
+## $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$
+##
+#############################################################################
+
+"""Helper functions for formatting information on QMetaObject"""
+
+from PySide2.QtCore import (QMetaClassInfo, QMetaEnum, QMetaMethod,
+                            QMetaProperty, QMetaObject, QObject)
+
+
+def _dump_metaobject_helper(meta_obj, indent):
+    print('{}class {}:'.format(indent, meta_obj.className()))
+    indent += '    '
+
+    info_offset = meta_obj.classInfoOffset()
+    info_count = meta_obj.classInfoCount()
+    if info_offset < info_count:
+        print('{}Info:'.format(indent))
+        for i in range(info_offset, info_count):
+            name = meta_obj.classInfo(i).name()
+            value = meta_obj.classInfo(i).value()
+            print('{}{:4d} {}+{}'.format(indent, i, name, value))
+
+    enumerator_offset = meta_obj.enumeratorOffset()
+    enumerator_count = meta_obj.enumeratorCount()
+    if enumerator_offset < enumerator_count:
+        print('{}Enumerators:'.format(indent))
+        for e in range(enumerator_offset, enumerator_count):
+            meta_enum = meta_obj.enumerator(e)
+            name = meta_enum.name()
+            value_str = ''
+            for k in range(0, meta_enum.keyCount()):
+                if k > 0:
+                    value_str += ', '
+                value_str += '{} = {}'.format(meta_enum.key(k),
+                                              meta_enum.value(k))
+            print('{}{:4d} {} ({})'.format(indent, e, name, value_str))
+
+    property_offset = meta_obj.propertyOffset()
+    property_count = meta_obj.propertyCount()
+    if property_offset < property_count:
+        print('{}Properties:'.format(indent))
+        for p in range(property_offset, property_count):
+            meta_property = meta_obj.property(p)
+            name = meta_property.name()
+            desc = ''
+            if meta_property.isConstant():
+                desc += ', constant'
+            if meta_property.isDesignable:
+                desc += ', designable'
+            if meta_property.isFlagType:
+                desc += ', flag'
+            if meta_property.isEnumType():
+                desc += ', enum'
+            if meta_property.isStored():
+                desc += ', stored'
+            if meta_property.isWritable():
+                desc += ', writable'
+            if meta_property.isResettable:
+                desc += ', resettable'
+            if meta_property.hasNotifySignal() :
+                notify_name = meta_property.notifySignal().name()
+                desc += ', notify={}'.format(bytes(notify_name).decode('utf-8'))
+            print('{}{:4d} {} {}{}'.format(indent, p, meta_property.typeName(),
+                                           name, desc))
+
+    method_offset = meta_obj.methodOffset()
+    method_count = meta_obj.methodCount()
+    if method_offset < method_count:
+        print('{}Methods:'.format(indent))
+        for m in range(method_offset, method_count):
+            method = meta_obj.method(m)
+            signature = bytes(method.methodSignature().data()).decode('utf-8')
+            type = method.methodType()
+            typeString = ''
+            if type == QMetaMethod.Signal:
+                typeString = ' (Signal)'
+            elif type == QMetaMethod.Slot:
+                typeString = ' (Slot)'
+            print('{}{:4d} {}{}'.format(indent, m, signature, typeString))
+
+
+def dump_metaobject(meta_obj):
+    super_classes = [meta_obj]
+    super_class = meta_obj.superClass()
+    while super_class:
+        super_classes.append(super_class)
+        super_class = super_class.superClass()
+    indent = ''
+    for c in reversed(super_classes):
+        _dump_metaobject_helper(c, indent)
+        indent += '    '
diff --git a/tools/metaobject_dump.py b/tools/metaobject_dump.py
new file mode 100644
index 000000000..ae8d0b6be
--- /dev/null
+++ b/tools/metaobject_dump.py
@@ -0,0 +1,67 @@
+#############################################################################
+##
+## Copyright (C) 2020 The Qt Company Ltd.
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of the Qt for Python project.
+##
+## $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$
+##
+#############################################################################
+
+import sys
+from dump_metaobject import dump_metaobject
+
+# Import all widget classes to enable instantiating them by type name
+from PySide2.QtWidgets import *
+
+
+DESC = """
+metaobject_dump.py <class_name>
+
+Dumps the QMetaObject of a class
+
+Example: metaobject_dump QLabel
+"""
+
+
+if __name__ == '__main__':
+    if len(sys.argv) != 2:
+        print(DESC)
+        sys.exit(0)
+    app = QApplication(sys.argv)
+
+    type_name = sys.argv[1]
+    class_instance = eval(type_name + '()')
+    if not class_instance:
+        print('Unable to instantiate {}'.format(type_name))
+        sys.exit(1)
+    dump_metaobject(class_instance.metaObject())
diff --git a/tools/metaobject_dump.pyproject b/tools/metaobject_dump.pyproject
new file mode 100644
index 000000000..f6d85b571
--- /dev/null
+++ b/tools/metaobject_dump.pyproject
@@ -0,0 +1,3 @@
+{
+    "files": ["metaobject_dump.py", "dump_metaobject.py"]
+}