Support the qApp macro correctly, final version incl. debug

For short the new features:
- there is a qApp in QtCore, QtGui and QtWidgets for compatibility,
  and also in __builtins__ for a true macro-like experience.
- if you delete any qApp variable, the Q*Application is reset and you can
  start over.

Long description:

There is a qApp macro in Qt5 which is equivalent to Q*Application.instance() .

Python does not have macros. Both PyQt5 and PySide2 have an
according structure in QtWidgets. In the case of PySide2, the qApp
variable is first initialized to None and later to QApplication().

This does not reflect the original sense of the qApp macro, because
 - it only handles QApplication,
 - it does not handle destruction.

This "macro" should live in QtCore, but both PyQt5 and PySide2 decided
to put this in QtWidgets. As a compromize, I propose to put qApp into
all three modules, and into __builtins__ as well, so wherever you
create an application, you find this "macro" in place.

While changing the code, I stumbled over the template
set_qapp_parent_for_orphan. I tried to make sense out of it and finally
removed it. There were no side effects but bug PYSIDE-85 is gone, now.

With some extra effort, I created a singleton qApp that changes itself.
This way, a true macro was simulated. Note that this was not possible
with a garbage collected variable, and I had to make shiboken aware of this.

As the final optimization, I turned qApp also into a fuse variable:
Delete any qApp variable and Q*Application will finish when there is
no extra reference.

Task-number: PYSIDE-85
Task-number: PYSIDE-571
Change-Id: I7a56b19858f63349c98b95778759a6a6de856938
Reviewed-by: Christian Tismer <tismer@stackless.com>

1 files changed, 41 insertions, 5 deletions

diff --git a/sources/shiboken2/libshiboken/basewrapper.cpp b/sources/shiboken2/libshiboken/basewrapper.cpp
index 3f3bcc7f5..0d8758cee 100644
--- a/sources/shiboken2/libshiboken/basewrapper.cpp
+++ b/sources/shiboken2/libshiboken/basewrapper.cpp
@@ -52,6 +52,7 @@
 #include <algorithm>
 #include "threadstatesaver.h"
 #include "signature.h"
+#include "qapp_macro.h"
 
 namespace {
     void _destroyParentInfo(SbkObject* obj, bool keepReference);
@@ -243,7 +244,9 @@ static void SbkDeallocWrapperCommon(PyObject* pyObj, bool canDelete)
     // be invoked and it trying to delete this object while it is still in
     // progress from the first time around, resulting in a double delete and a
     // crash.
-    PyObject_GC_UnTrack(pyObj);
+    // PYSIDE-571: Some objects do not use GC, so check this!
+    if (PyObject_IS_GC(pyObj))
+        PyObject_GC_UnTrack(pyObj);
 
     // Check that Python is still initialized as sometimes this is called by a static destructor
     // after Python interpeter is shutdown.
@@ -278,6 +281,13 @@ void SbkDeallocWrapper(PyObject* pyObj)
     SbkDeallocWrapperCommon(pyObj, true);
 }
 
+void SbkDeallocQAppWrapper(PyObject* pyObj)
+{
+    SbkDeallocWrapper(pyObj);
+    // PYSIDE-571: make sure to create a singleton deleted qApp.
+    MakeSingletonQAppWrapper(NULL);
+}
+
 void SbkDeallocWrapperWithPrivateDtor(PyObject* self)
 {
     SbkDeallocWrapperCommon(self, false);
@@ -375,9 +385,8 @@ PyObject* SbkObjectTypeTpNew(PyTypeObject* metatype, PyObject* args, PyObject* k
     return reinterpret_cast<PyObject*>(newType);
 }
 
-PyObject* SbkObjectTpNew(PyTypeObject* subtype, PyObject*, PyObject*)
+static PyObject *_setupNew(SbkObject *self, PyTypeObject *subtype)
 {
-    SbkObject* self = PyObject_GC_New(SbkObject, subtype);
     Py_INCREF(reinterpret_cast<PyObject*>(subtype));
     SbkObjectPrivate* d = new SbkObjectPrivate;
 
@@ -394,10 +403,35 @@ PyObject* SbkObjectTpNew(PyTypeObject* subtype, PyObject*, PyObject*)
     self->ob_dict = 0;
     self->weakreflist = 0;
     self->d = d;
-    PyObject_GC_Track(reinterpret_cast<PyObject*>(self));
     return reinterpret_cast<PyObject*>(self);
 }
 
+PyObject* SbkObjectTpNew(PyTypeObject *subtype, PyObject *, PyObject *)
+{
+    SbkObject *self = PyObject_GC_New(SbkObject, subtype);
+    PyObject *res = _setupNew(self, subtype);
+    PyObject_GC_Track(reinterpret_cast<PyObject*>(self));
+    return res;
+}
+
+PyObject* SbkQAppTpNew(PyTypeObject* subtype, PyObject *, PyObject *)
+{
+    // PYSIDE-571:
+    // For qApp, we need to create a singleton Python object.
+    // We cannot track this with the GC, because it is a static variable!
+
+    // Python2 has a weird handling of flags in derived classes that Python3
+    // does not have. Observed with bug_307.py.
+    // But it could theoretically also happen with Python3.
+    // Therefore we enforce that there is no GC flag, ever!
+    if (PyType_HasFeature(subtype, Py_TPFLAGS_HAVE_GC)) {
+        subtype->tp_flags &= ~Py_TPFLAGS_HAVE_GC;
+        subtype->tp_free = PyObject_Del;
+    }
+    SbkObject* self = reinterpret_cast<SbkObject*>(MakeSingletonQAppWrapper(subtype));
+    return self == 0 ? 0 : _setupNew(self, subtype);
+}
+
 
 } //extern "C"
 
@@ -1372,7 +1406,9 @@ void deallocData(SbkObject* self, bool cleanup)
     }
     delete self->d; // PYSIDE-205: always delete d.
     Py_XDECREF(self->ob_dict);
-    Py_TYPE(self)->tp_free(self);
+    // PYSIDE-571: qApp is no longer allocated.
+    if (PyObject_IS_GC((PyObject*)self))
+        Py_TYPE(self)->tp_free(self);
 }
 
 void setTypeUserData(SbkObject* wrapper, void* userData, DeleteUserDataFunc d_func)