src/qml/qml/qqmlboundsignal_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLBOUNDSIGNAL_P_H
  43 #define QQMLBOUNDSIGNAL_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/qmetaobject.h>
  57
  58 #include <private/qqmlabstractexpression_p.h>
  59 #include <private/qqmljavascriptexpression_p.h>
  60 #include <private/qqmlboundsignalexpressionpointer_p.h>
  61 #include <private/qqmlnotifier_p.h>
  62 #include <private/qflagpointer_p.h>
  63 #include <private/qqmlrefcount_p.h>
  64 #include <private/qobject_p.h>
  65
  66 QT_BEGIN_NAMESPACE
  67
  68 class Q_QML_PRIVATE_EXPORT QQmlBoundSignalExpression : public QQmlAbstractExpression, public QQmlJavaScriptExpression, public QQmlRefCount
  69 {
  70 public:
  71     QQmlBoundSignalExpression(QQmlContextData *ctxt, QObject *scope, const QByteArray &expression,
  72                               bool isRewritten, const QString &fileName, int line, int column);
  73     QQmlBoundSignalExpression(QQmlContextData *ctxt, QObject *scope, const QString &expression,
  74                               bool isRewritten, const QString &fileName, int line, int column);
  75
  76     // "inherited" from QQmlJavaScriptExpression.
  77     static QString expressionIdentifier(QQmlJavaScriptExpression *);
  78     static void expressionChanged(QQmlJavaScriptExpression *);
  79
  80     // evaluation of a bound signal expression doesn't return any value
  81     void evaluate(QObject *secondaryScope = 0);
  82
  83     QString sourceFile() const { return m_fileName; }
  84     int lineNumber() const { return m_line; }
  85     int columnNumber() const { return m_column; }
  86     QString expression() const;
  87
  88     QQmlEngine *engine() const { return context() ? context()->engine : 0; }
  89
  90 private:
  91     ~QQmlBoundSignalExpression();
  92
  93     v8::Persistent<v8::Object> m_v8qmlscope;
  94     v8::Persistent<v8::Function> m_v8function;
  95
  96     //either expressionUtf8 or expression will be used (but not both).
  97     //once m_v8function is valid, we clear both expressions, and
  98     //extract it from m_v8function if needed.
  99     QByteArray m_expressionUtf8;
 100     QString m_expression;   //only used when expression needs to be rewritten
 101
 102     QString m_fileName;
 103     int m_line;
 104     int m_column;
 105
 106     bool m_expressionFunctionValid:1;
 107     bool m_expressionFunctionRewritten:1;
 108 };
 109
 110 class Q_QML_PRIVATE_EXPORT QQmlAbstractBoundSignal
 111 {
 112 public:
 113     QQmlAbstractBoundSignal();
 114     virtual ~QQmlAbstractBoundSignal();
 115
 116     virtual int index() const = 0;
 117     virtual QQmlBoundSignalExpression *expression() const = 0;
 118     virtual QQmlBoundSignalExpressionPointer setExpression(QQmlBoundSignalExpression *) = 0;
 119     virtual QQmlBoundSignalExpressionPointer takeExpression(QQmlBoundSignalExpression *) = 0;
 120     virtual QObject *scope() = 0;
 121     virtual bool isEvaluating() const = 0;
 122
 123     void removeFromObject();
 124 protected:
 125     void addToObject(QObject *owner);
 126
 127 private:
 128     friend class QQmlData;
 129     friend class QQmlPropertyPrivate;
 130     friend class QQmlEngineDebugService;
 131     QQmlAbstractBoundSignal **m_prevSignal;
 132     QQmlAbstractBoundSignal  *m_nextSignal;
 133 };
 134
 135 class QQmlBoundSignalParameters;
 136 class Q_QML_PRIVATE_EXPORT QQmlBoundSignal : public QQmlAbstractBoundSignal,
 137                                              public QQmlNotifierEndpoint
 138 {
 139 public:
 140     QQmlBoundSignal(QObject *scope, int signal, QObject *owner, QQmlEngine *engine);
 141     virtual ~QQmlBoundSignal();
 142
 143     int index() const;
 144
 145     QQmlBoundSignalExpression *expression() const;
 146     QQmlBoundSignalExpressionPointer setExpression(QQmlBoundSignalExpression *);
 147     QQmlBoundSignalExpressionPointer takeExpression(QQmlBoundSignalExpression *);
 148     QObject *scope() { return *m_scope; }
 149
 150     bool isEvaluating() const { return m_scope.flag(); }
 151
 152 private:
 153     friend void QQmlBoundSignal_callback(QQmlNotifierEndpoint *, void **);
 154
 155     QQmlBoundSignalExpressionPointer m_expression;
 156     QQmlBoundSignalParameters *m_params;
 157     // We store some flag bits in the following flag pointer.
 158     //    m_scope:flag1 - m_isEvaluating
 159     //    m_scope:flag2 - m_paramsValid
 160     QFlagPointer<QObject> m_scope;
 161     int m_index;
 162
 163     void setIsEvaluating(bool v) { m_scope.setFlagValue(v); }
 164     void setParamsValid(bool v) { m_scope.setFlag2Value(v); }
 165     bool paramsValid() const { return m_scope.flag2(); }
 166 };
 167
 168
 169 QT_END_NAMESPACE
 170
 171 #endif // QQMLBOUNDSIGNAL_P_H