src/declarative/qml/qdeclarativenotifier_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVENOTIFIER_P_H
  43 #define QDECLARATIVENOTIFIER_P_H
  44
  45 #include "qdeclarativedata_p.h"
  46 #include "qdeclarativeguard_p.h"
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 class QDeclarativeNotifierEndpoint;
  51 class Q_DECLARATIVE_EXPORT QDeclarativeNotifier
  52 {
  53 public:
  54     inline QDeclarativeNotifier();
  55     inline ~QDeclarativeNotifier();
  56     inline void notify();
  57
  58 private:
  59     friend class QDeclarativeData;
  60     friend class QDeclarativeNotifierEndpoint;
  61
  62     static void emitNotify(QDeclarativeNotifierEndpoint *);
  63     QDeclarativeNotifierEndpoint *endpoints;
  64 };
  65
  66 class QDeclarativeNotifierEndpoint
  67 {
  68 public:
  69     inline QDeclarativeNotifierEndpoint();
  70     inline ~QDeclarativeNotifierEndpoint();
  71
  72     typedef void (*Callback)(QDeclarativeNotifierEndpoint *);
  73     Callback callback;
  74
  75     inline bool isConnected();
  76     inline bool isConnected(QObject *source, int sourceSignal);
  77     inline bool isConnected(QDeclarativeNotifier *);
  78
  79     void connect(QObject *source, int sourceSignal);
  80     inline void connect(QDeclarativeNotifier *);
  81     inline void disconnect();
  82
  83     inline bool isNotifying() const;
  84     inline void cancelNotify();
  85
  86     void copyAndClear(QDeclarativeNotifierEndpoint &other);
  87
  88 private:
  89     friend class QDeclarativeData;
  90     friend class QDeclarativeNotifier;
  91
  92     union {
  93         QDeclarativeNotifier *notifier;
  94         QObject *source;
  95     };
  96     unsigned int notifying : 1;
  97     signed int sourceSignal : 31;
  98     QDeclarativeNotifierEndpoint **disconnected;
  99     QDeclarativeNotifierEndpoint  *next;
 100     QDeclarativeNotifierEndpoint **prev;
 101 };
 102
 103 QDeclarativeNotifier::QDeclarativeNotifier()
 104 : endpoints(0)
 105 {
 106 }
 107
 108 QDeclarativeNotifier::~QDeclarativeNotifier()
 109 {
 110     QDeclarativeNotifierEndpoint *endpoint = endpoints;
 111     while (endpoint) {
 112         QDeclarativeNotifierEndpoint *n = endpoint;
 113         endpoint = n->next;
 114
 115         n->next = 0;
 116         n->prev = 0;
 117         n->notifier = 0;
 118         n->sourceSignal = -1;
 119         if (n->disconnected) *n->disconnected = 0;
 120         n->disconnected = 0;
 121     }
 122     endpoints = 0;
 123 }
 124
 125 void QDeclarativeNotifier::notify()
 126 {
 127     if (endpoints) emitNotify(endpoints);
 128 }
 129
 130 QDeclarativeNotifierEndpoint::QDeclarativeNotifierEndpoint()
 131 : callback(0), notifier(0), notifying(0), sourceSignal(-1), disconnected(0), next(0), prev(0)
 132 {
 133 }
 134
 135 QDeclarativeNotifierEndpoint::~QDeclarativeNotifierEndpoint()
 136 {
 137     disconnect();
 138 }
 139
 140 bool QDeclarativeNotifierEndpoint::isConnected()
 141 {
 142     return prev != 0;
 143 }
 144
 145 bool QDeclarativeNotifierEndpoint::isConnected(QObject *source, int sourceSignal)
 146 {
 147     return this->sourceSignal != -1 && this->source == source && this->sourceSignal == sourceSignal;
 148 }
 149
 150 bool QDeclarativeNotifierEndpoint::isConnected(QDeclarativeNotifier *notifier)
 151 {
 152     return sourceSignal == -1 && this->notifier == notifier;
 153 }
 154
 155 void QDeclarativeNotifierEndpoint::connect(QDeclarativeNotifier *notifier)
 156 {
 157     disconnect();
 158
 159     next = notifier->endpoints;
 160     if (next) { next->prev = &next; }
 161     notifier->endpoints = this;
 162     prev = &notifier->endpoints;
 163     this->notifier = notifier;
 164 }
 165
 166 void QDeclarativeNotifierEndpoint::disconnect()
 167 {
 168     if (next) next->prev = prev;
 169     if (prev) *prev = next;
 170     if (disconnected) *disconnected = 0;
 171     next = 0;
 172     prev = 0;
 173     disconnected = 0;
 174     notifier = 0;
 175     notifying = 0;
 176     sourceSignal = -1;
 177 }
 178
 179 /*!
 180 Returns true if a notify is in progress.  This means that the signal or QDeclarativeNotifier
 181 that this endpoing is connected to has been triggered, but this endpoint's callback has not
 182 yet been called.
 183
 184 An in progress notify can be cancelled by calling cancelNotify.
 185 */
 186 bool QDeclarativeNotifierEndpoint::isNotifying() const
 187 {
 188     return notifying == 1;
 189 }
 190
 191 /*!
 192 Cancel any notifies that are in progress.
 193 */
 194 void QDeclarativeNotifierEndpoint::cancelNotify()
 195 {
 196     notifying = 0;
 197     if (disconnected) {
 198         *disconnected = 0;
 199         disconnected = 0;
 200     }
 201 }
 202
 203 QT_END_NAMESPACE
 204
 205 #endif // QDECLARATIVENOTIFIER_P_H
 206