Add python bindings

autotests/pythontest.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+#-*- coding: utf-8 -*-
+
+from __future__ import print_function
+
+import sys
+
+sys.path.append(sys.argv[1])
+
+from PyQt5 import QtCore
+from PyQt5 import QtGui
+from PyQt5 import QtWidgets
+
+from PyKF5 import KConfigCore
+from PyKF5 import KConfigGui
+
+def main():
+    app = QtWidgets.QApplication(sys.argv)
+
+    kcg = KConfigCore.KConfigGroup();
+
+    assert(not kcg.isValid())
+
+    sc = KConfigGui.KStandardShortcut.open()
+    assert(sc == [QtGui.QKeySequence("CTRL+O")])
+
+if __name__ == '__main__':
+    sys.exit(main())

cmake/rules_PyKF5.py

@@ -0,0 +1,305 @@
+#
+# Copyright 2016 by Shaheed Haque (srhaque@theiet.org)
+# Copyright 2016 Stephen Kelly <steveire@gmail.com>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+import os, sys
+
+import rules_engine
+sys.path.append(os.path.dirname(os.path.dirname(rules_engine.__file__)))
+import Qt5Ruleset
+
+from copy import deepcopy
+
+from clang.cindex import AccessSpecifier, CursorKind
+
+def set_skeleton_item_base(container, sip, matcher):
+    if not sip["base_specifiers"] or sip["base_specifiers"][-1].endswith(">"):
+        sip["base_specifiers"] = ["KConfigSkeletonItem"]
+
+def set_skeleton_item_base_gui(container, sip, matcher):
+    sip["base_specifiers"] = ["KConfigSkeletonItem"]
+
+def mark_and_discard_QSharedData(container, sip, matcher):
+    rules_engine.container_mark_abstract(container, sip, matcher)
+    rules_engine.discard_QSharedData_base(container, sip, matcher)
+
+def discard_base(container, sip, matcher):
+    sip["base_specifiers"] = []
+
+def local_container_rules():
+    return [
+        [".*", "KConfigBackend", ".*", ".*", ".*", mark_and_discard_QSharedData],
+        [".*", "KConfigBase", ".*", ".*", ".*", rules_engine.container_mark_abstract],
+
+        [".*KCoreConfigSkeleton.*", ".*ItemString", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemUrl", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemProperty", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemBool", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemInt", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemLongLong", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemUInt", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemULongLong", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemDouble", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemRect", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemPoint", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemSize", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemDateTime", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemStringList", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemUrlList", ".*", ".*", ".*", set_skeleton_item_base],
+        [".*KCoreConfigSkeleton.*", ".*ItemIntList", ".*", ".*", ".*", set_skeleton_item_base],
+
+        ["KConfigSkeleton", "ItemColor", ".*", ".*", ".*", set_skeleton_item_base_gui],
+        ["KConfigSkeleton", "ItemFont", ".*", ".*", ".*", set_skeleton_item_base_gui],
+
+        [".*", "KSharedConfig", ".*", ".*", ".*", rules_engine.discard_QSharedData_base],
+
+        [".*", "KConfigCompilerSignallingItem", ".*", ".*", ".*", rules_engine.container_discard],
+
+        [".*", "KEntryMap", ".*", ".*", ".*", discard_base],
+    ]
+
+def local_function_rules():
+    return [
+        ["KConfigBase", "group", ".*", ".*", ".*const char.*", rules_engine.function_discard],
+        ["KConfigBase", "group", ".*", ".*", ".*QByteArray.*", rules_engine.function_discard],
+        ["KConfigBase", "group", ".*", "const KConfigGroup", ".*", rules_engine.function_discard],
+
+        ["KConfigBase", "groupImpl", ".*", "const KConfigGroup", ".*", rules_engine.function_discard],
+        ["KConfig", "groupImpl", ".*", "const KConfigGroup", ".*", rules_engine.function_discard],
+
+        ["KSharedConfig", "openConfig", ".*", ".*", ".*", rules_engine.function_discard],
+
+        ["KConfigGroup", "KConfigGroup", ".*", ".*", ".*KConfigBase.*", rules_engine.function_discard],
+        ["KConfigGroup", "config", ".*", "const KConfig.*", ".*", rules_engine.function_discard],
+
+        ["KDesktopFile", ".*", ".*", "const KConfigGroup", ".*", rules_engine.function_discard],
+
+        ["KConfigGroup", ".*", ".*", "KConfigGroup", ".*", rules_engine.function_discard],
+
+        ["KCoreConfigSkeleton", "config", ".*", "const KConfig.*", ".*", rules_engine.function_discard],
+        ["KCoreConfigSkeleton", "sharedConfig", ".*", ".*", ".*", rules_engine.function_discard],
+
+        ["KEntryMap", "getEntryOption", ".*", ".*", ".*", rules_engine.function_discard],
+        ["KEntryMap", "setEntryOption", ".*", ".*", ".*", rules_engine.function_discard],
+        ["KEntryMap", "findEntry", ".*", ".*", ".*", rules_engine.function_discard],
+        ["KEntryMap", "findExactEntry", ".*", ".*", ".*", rules_engine.function_discard],
+    ]
+
+def local_typedef_rules():
+    return [
+        ["KConfigSkeletonItem", "DictIterator", rules_engine.typedef_discard],
+        [".*", "KEntryMapIterator", rules_engine.typedef_discard],
+        [".*", "KEntryMapConstIterator", rules_engine.typedef_discard],
+    ]
+
+
+def _kcoreconfigskeleton_item_xxx(function, sip, entry):
+    sip["code"] = """
+        %MethodCode
+            sipCpp = new sipKCoreConfigSkeleton_Item{} (*a0, *a1, a2, a3);
+        %End
+        """.replace("{}", entry["ctx"])
+    sip["parameters"][2] = sip["parameters"][2].replace("&", "")
+
+
+def _kcoreconfigskeleton_item_enum(function, sip, entry):
+    sip["code"] = """
+        %MethodCode
+            sipCpp = new sipKCoreConfigSkeleton_ItemEnum (*a0, *a1, a2, *a3, a4);
+        %End
+        """.replace("{}", entry["ctx"])
+    sip["parameters"][2] = sip["parameters"][2].replace("&", "")
+
+
+def _kcoreconfigskeleton_add_item_xxx(function, sip, entry):
+    sip["code"] = """
+        %MethodCode
+            sipRes = new PyItem{} (sipCpp->currentGroup(), a3->isNull() ? *a0 : *a3, a1, a2);
+            sipCpp->addItem(sipRes, *a0);
+        %End
+        """.format(entry["ctx"])
+
+def _kcoreconfigskeleton_item_add_py_subclass(filename, sip, entry):
+    result = """
+%ModuleHeaderCode
+#include <kcoreconfigskeleton.h>
+"""
+    for ctx in ({"Type": "Bool",      "cpptype": "bool",    "defaultValue": 1},
+                {"Type": "Int",       "cpptype": "qint32",  "defaultValue": 1},
+                {"Type": "UInt",      "cpptype": "quint32", "defaultValue": 1},
+                {"Type": "LongLong",  "cpptype": "qint64",  "defaultValue": 1},
+                {"Type": "ULongLong", "cpptype": "quint64", "defaultValue": 1},
+                {"Type": "Double",    "cpptype": "double",  "defaultValue": 1},
+        ):
+        result += """
+class PyItem{Type} : public KCoreConfigSkeleton::Item{Type}
+{{
+public:
+    PyItem{Type} (const QString &group, const QString &key, {cpptype}& val, {cpptype} defaultValue = {defaultValue}) :
+        KCoreConfigSkeleton::Item{Type} (group, key, this->value, defaultValue),
+        value(val)
+    {{
+    }}
+
+private:
+    {cpptype} value;
+}};
+""".format(**ctx)
+
+    result += """
+class PyItemEnum : public KCoreConfigSkeleton::ItemEnum
+{
+public:
+    PyItemEnum (const QString& group, const QString& key, int& val, const QList<KCoreConfigSkeleton::ItemEnum::Choice>& choices, int defaultValue = 0) :
+        KCoreConfigSkeleton::ItemEnum(group, key, this->value, choices, defaultValue),
+        value(val)
+    {
+    };
+
+private:
+    int value;
+};
+%End\n
+"""
+
+    sip["code"] = result
+
+
+class RuleSet(Qt5Ruleset.RuleSet):
+    def __init__(self):
+        Qt5Ruleset.RuleSet.__init__(self)
+        self._fn_db = rules_engine.FunctionRuleDb(lambda: local_function_rules() + Qt5Ruleset.function_rules())
+        self._container_db = rules_engine.ContainerRuleDb(lambda: local_container_rules() + Qt5Ruleset.container_rules())
+        self._typedef_db = rules_engine.TypedefRuleDb(lambda: local_typedef_rules() + Qt5Ruleset.typedef_rules())
+        self._methodcode = rules_engine.MethodCodeDb({
+            "KCoreConfigSkeleton::ItemBool":
+            {
+                "ItemBool":
+                {
+                    "code": _kcoreconfigskeleton_item_xxx,
+                    "ctx": "Bool",
+                },
+            },
+            "KCoreConfigSkeleton::ItemInt":
+            {
+                "ItemInt":
+                {
+                    "code": _kcoreconfigskeleton_item_xxx,
+                    "ctx": "Int",
+                },
+            },
+            "KCoreConfigSkeleton::ItemLongLong":
+            {
+                "ItemLongLong":
+                {
+                    "code": _kcoreconfigskeleton_item_xxx,
+                    "ctx": "LongLong",
+                },
+            },
+            "KCoreConfigSkeleton::ItemEnum":
+            {
+                "ItemEnum":
+                {
+                    "code": _kcoreconfigskeleton_item_enum,
+                    "ctx": "Enum",
+                },
+            },
+            "KCoreConfigSkeleton::ItemUInt":
+            {
+                "ItemUInt":
+                {
+                    "code": _kcoreconfigskeleton_item_xxx,
+                    "ctx": "UInt",
+                },
+            },
+            "KCoreConfigSkeleton::ItemULongLong":
+            {
+                "ItemULongLong":
+                {
+                    "code": _kcoreconfigskeleton_item_xxx,
+                    "ctx": "ULongLong",
+                },
+            },
+            "KCoreConfigSkeleton::ItemDouble":
+            {
+                "ItemDouble":
+                {
+                    "code": _kcoreconfigskeleton_item_xxx,
+                    "ctx": "Double",
+                },
+            },
+            "KCoreConfigSkeleton":
+            {
+                "addItemBool":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "Bool",
+                },
+                "addItemInt":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "Int",
+                },
+                "addItemUInt":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "UInt",
+                },
+                "addItemLongLong":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "LongLong",
+                },
+                "addItemInt64":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "LongLong",
+                },
+                "addItemULongLong":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "ULongLong",
+                },
+                "addItemUInt64":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "ULongLong",
+                },
+                "addItemDouble":
+                {
+                    "code": _kcoreconfigskeleton_add_item_xxx,
+                    "ctx": "Double",
+                },
+            },
+        })
+
+        self._modulecode = rules_engine.ModuleCodeDb({
+            "kcoreconfigskeleton.h":
+            {
+                "code": _kcoreconfigskeleton_item_add_py_subclass,
+            },
+            })

src/core/CMakeLists.txt

@@ -52,6 +52,32 @@ ecm_generate_headers(KConfigCore_HEADERS
   REQUIRED_HEADERS KConfigCore_HEADERS
 )
 
+find_package(PythonModuleGeneration)
+
+if (PythonModuleGeneration_FOUND)
+  ecm_generate_python_binding(
+    TARGET KF5::ConfigCore
+    PYTHONNAMESPACE PyKF5
+    MODULENAME KConfigCore
+    RULES_FILE "${CMAKE_SOURCE_DIR}/cmake/rules_PyKF5.py"
+    INSTALL_DIR_SUFFIX ${KDE_INSTALL_PYTHONBINDINGSDIR}
+    SIP_DEPENDS
+      QtCore/QtCoremod.sip
+    HEADERS
+      kauthorized.h
+      kconfig.h
+      kconfigbackend.h
+      kconfigbase.h
+      kconfigdata.h
+      kconfiggroup.h
+      kdesktopfile.h
+      ksharedconfig.h
+      kcoreconfigskeleton.h
+      kemailsettings.h
+      conversioncheck.h
+  )
+endif()
+
 install(TARGETS KF5ConfigCore EXPORT KF5ConfigTargets ${KF5_INSTALL_TARGETS_DEFAULT_ARGS})
 
 install(FILES

src/gui/CMakeLists.txt

@@ -36,6 +36,29 @@ ecm_generate_headers(KConfigGui_HEADERS
    REQUIRED_HEADERS KConfigGui_HEADERS
 )
 
+find_package(PythonModuleGeneration)
+
+if (PythonModuleGeneration_FOUND)
+  ecm_generate_python_binding(
+    TARGET KF5::ConfigGui
+    PYTHONNAMESPACE PyKF5
+    MODULENAME KConfigGui
+    RULES_FILE "${CMAKE_SOURCE_DIR}/cmake/rules_PyKF5.py"
+    INSTALL_DIR_SUFFIX ${KDE_INSTALL_PYTHONBINDINGSDIR}
+    SIP_INCLUDES
+      "${CMAKE_BINARY_DIR}/src/core/sip"
+    SIP_DEPENDS
+      QtGui/QtGuimod.sip
+      PyKF5/KConfigCore/KConfigCoremod.sip
+    HEADERS
+      kconfiggui.h
+      kconfigloader.h
+      kconfigskeleton.h
+      kstandardshortcut.h
+      kwindowconfig.h
+  )
+endif()
+
 install(TARGETS KF5ConfigGui EXPORT KF5ConfigTargets ${KF5_INSTALL_TARGETS_DEFAULT_ARGS})
 
 install(FILES