From be202bd1baf600c7b422c96cc6b47a327e7a9d23 Mon Sep 17 00:00:00 2001
From: Friedemann Kleint <Friedemann.Kleint@qt.io>
Date: Wed, 25 Jul 2018 11:42:39 +0200
Subject: shiboken: Fix the allow-thread attribute to actually have an effect

Previously, calls to BEGIN_ALLOW_THREADS/END_ALLOW_THREADS were always
generated since the value of XML attribute was not used.

Fix it to actually use the value. Since having it default to "no"
caused a number of deadlocks (related to thread functions or functions
calling a virtual function (potentially reimplemented in Python),
introduce "auto" as default value. "auto" turns off
BEGIN_ALLOW_THREADS/END_ALLOW_THREADS for simple getter functions.

Task-number: PYSIDE-743
Change-Id: I4833afef14f2552c75b3424417c2702ce25cb379
Reviewed-by: Christian Tismer <tismer@stackless.com>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
---
 .../ApiExtractor/tests/testmodifyfunction.cpp      | 54 ++++++++++++++++++++++
 .../ApiExtractor/tests/testmodifyfunction.h        |  1 +
 2 files changed, 55 insertions(+)

(limited to 'sources/shiboken2/ApiExtractor/tests')

diff --git a/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.cpp b/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.cpp
index d0a0c9c7a..4743b7167 100644
--- a/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.cpp
+++ b/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.cpp
@@ -220,6 +220,60 @@ void TestModifyFunction::testWithApiVersion()
     QVERIFY(func->ownership(func->ownerClass(), TypeSystem::TargetLangCode, 0) != TypeSystem::CppOwnership);
 }
 
+void TestModifyFunction::testAllowThread()
+{
+    const char cppCode[] =R"CPP(\
+struct A {
+    void f1();
+    void f2();
+    void f3();
+    int getter1() const;
+    int getter2() const;
+};
+)CPP";
+
+    const char xmlCode[] = R"XML(
+<typesystem package='Foo'>
+    <primitive-type name='int'/>
+    <object-type name='A'>
+        <modify-function signature='f2()' allow-thread='auto'/>
+        <modify-function signature='f3()' allow-thread='no'/>
+        <modify-function signature='getter2()const' allow-thread='yes'/>
+    </object-type>
+</typesystem>
+)XML";
+    QScopedPointer<AbstractMetaBuilder> builder(TestUtil::parse(cppCode, xmlCode, false, "0.1"));
+    QVERIFY(!builder.isNull());
+    AbstractMetaClassList classes = builder->classes();
+    const AbstractMetaClass *classA = AbstractMetaClass::findClass(classes, QLatin1String("A"));
+    QVERIFY(classA);
+
+    // Nothing specified, true
+    const AbstractMetaFunction *f1 = classA->findFunction(QLatin1String("f1"));
+    QVERIFY(f1);
+    QVERIFY(f1->allowThread());
+
+    // 'auto' specified, should be true for nontrivial function
+    const AbstractMetaFunction *f2 = classA->findFunction(QLatin1String("f2"));
+    QVERIFY(f2);
+    QVERIFY(f2->allowThread());
+
+    // 'no' specified, should be false
+    const AbstractMetaFunction *f3 = classA->findFunction(QLatin1String("f3"));
+    QVERIFY(f3);
+    QVERIFY(!f3->allowThread());
+
+    // Nothing specified, should be false for simple getter
+    const AbstractMetaFunction *getter1 = classA->findFunction(QLatin1String("getter1"));
+    QVERIFY(getter1);
+    QVERIFY(!getter1->allowThread());
+
+    // Forced to true simple getter
+    const AbstractMetaFunction *getter2 = classA->findFunction(QLatin1String("getter2"));
+    QVERIFY(getter2);
+    QVERIFY(getter2->allowThread()); // Forced to true simple getter
+}
+
 void TestModifyFunction::testGlobalFunctionModification()
 {
     const char* cppCode ="\
diff --git a/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.h b/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.h
index f116b5124..636b3ef34 100644
--- a/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.h
+++ b/sources/shiboken2/ApiExtractor/tests/testmodifyfunction.h
@@ -37,6 +37,7 @@ class TestModifyFunction : public QObject
     private slots:
         void testOwnershipTransfer();
         void testWithApiVersion();
+        void testAllowThread();
         void testRenameArgument_data();
         void testRenameArgument();
         void invalidateAfterUse();
-- 
cgit v1.2.3