Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlnotifier.cpp
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtQml module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #include "qqmlnotifier_p.h"
43 #include "qqmlproperty_p.h"
44 #include <QtCore/qdebug.h>
45 #include <private/qthread_p.h>
46
47 QT_BEGIN_NAMESPACE
48
49 typedef void (*Callback)(QQmlNotifierEndpoint *, void **);
50
51 void QQmlBoundSignal_callback(QQmlNotifierEndpoint *, void **);
52 void QQmlJavaScriptExpressionGuard_callback(QQmlNotifierEndpoint *, void **);
53 void QQmlVMEMetaObjectEndpoint_callback(QQmlNotifierEndpoint *, void **);
54 void QV4BindingsSubscription_callback(QQmlNotifierEndpoint *, void **);
55
56 static Callback QQmlNotifier_callbacks[] = {
57     0,
58     QQmlBoundSignal_callback,
59     QQmlJavaScriptExpressionGuard_callback,
60     QQmlVMEMetaObjectEndpoint_callback,
61     QV4BindingsSubscription_callback
62 };
63
64 void QQmlNotifier::emitNotify(QQmlNotifierEndpoint *endpoint, void **a)
65 {
66     intptr_t originalSenderPtr;
67     intptr_t *disconnectWatch;
68
69     if (!endpoint->isNotifying()) {
70         originalSenderPtr = endpoint->senderPtr;
71         disconnectWatch = &originalSenderPtr;
72         endpoint->senderPtr = intptr_t(disconnectWatch) | 0x1;
73     } else {
74         disconnectWatch = (intptr_t *)(endpoint->senderPtr & ~0x1);
75     }
76
77     if (endpoint->next)
78         emitNotify(endpoint->next, a);
79
80     if (*disconnectWatch) {
81
82         Q_ASSERT(QQmlNotifier_callbacks[endpoint->callback]);
83         QQmlNotifier_callbacks[endpoint->callback](endpoint, a);
84
85         if (disconnectWatch == &originalSenderPtr && originalSenderPtr) {
86             // End of notifying, restore values
87             endpoint->senderPtr = originalSenderPtr;
88         }
89     } 
90 }
91
92 /*! \internal
93     \a sourceSignal MUST be in the signal index range (see QObjectPrivate::signalIndex()).
94     This is different from QMetaMethod::methodIndex().
95 */
96 void QQmlNotifierEndpoint::connect(QObject *source, int sourceSignal, QQmlEngine *engine)
97 {
98     disconnect();
99
100     Q_ASSERT(engine);
101     if (QObjectPrivate::get(source)->threadData->threadId !=
102         QObjectPrivate::get(engine)->threadData->threadId) {
103
104         QString sourceName;
105         QDebug(&sourceName) << source;
106         sourceName = sourceName.left(sourceName.length() - 1);
107         QString engineName;
108         QDebug(&engineName).nospace() << engine;
109         engineName = engineName.left(engineName.length() - 1);
110
111         qFatal("QQmlEngine: Illegal attempt to connect to %s that is in"
112                " a different thread than the QML engine %s.", qPrintable(sourceName),
113                qPrintable(engineName));
114     }
115
116     senderPtr = intptr_t(source);
117     this->sourceSignal = sourceSignal;
118     QQmlPropertyPrivate::flushSignal(source, sourceSignal);
119     QQmlData *ddata = QQmlData::get(source, true);
120     ddata->addNotify(sourceSignal, this);
121     QObjectPrivate * const priv = QObjectPrivate::get(source);
122     priv->connectNotify(QMetaObjectPrivate::signal(source->metaObject(), sourceSignal));
123 }
124
125 QT_END_NAMESPACE
126