aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/qml/qqmlbinding_p.h
blob: 33823d7e7e3d5e2fc1cf6c22cb0590add7bd307d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QQMLBINDING_P_H
#define QQMLBINDING_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include "qqml.h"
#include "qqmlpropertyvaluesource.h"
#include "qqmlexpression.h"
#include "qqmlproperty.h"
#include "qqmlproperty_p.h"

#include <QtCore/QObject>
#include <QtCore/QMetaProperty>

#include <private/qpointervaluepair_p.h>

QT_BEGIN_NAMESPACE

class Q_QML_PRIVATE_EXPORT QQmlAbstractBinding
{
public:
    typedef QWeakPointer<QQmlAbstractBinding> Pointer;

    QQmlAbstractBinding();

    virtual void destroy();

    virtual QString expression() const;

    enum Type { PropertyBinding, ValueTypeProxy };
    virtual Type bindingType() const { return PropertyBinding; }

    // Should return the encoded property index for the binding.  Should return this value
    // even if the binding is not enabled or added to an object.
    // Encoding is:  coreIndex | (valueTypeIndex << 24)
    virtual int propertyIndex() const = 0;
    // Should return the object for the binding.  Should return this object even if the
    // binding is not enabled or added to the object.
    virtual QObject *object() const = 0;

    void setEnabled(bool e) { setEnabled(e, QQmlPropertyPrivate::DontRemoveBinding); }
    virtual void setEnabled(bool, QQmlPropertyPrivate::WriteFlags) = 0;

    void update() { update(QQmlPropertyPrivate::DontRemoveBinding); }
    virtual void update(QQmlPropertyPrivate::WriteFlags) = 0;

    void addToObject();
    void removeFromObject();

    static inline Pointer getPointer(QQmlAbstractBinding *p);

protected:
    virtual ~QQmlAbstractBinding();
    void clear();

    // Called by QQmlPropertyPrivate to "move" a binding to a different property.
    // This is only used for alias properties, and only used by QQmlBinding not
    // V8 or V4 bindings.  The default implementation qFatal()'s to ensure that the
    // method is never called for V4 or V8 bindings.
    virtual void retargetBinding(QObject *, int);
private:
    Pointer weakPointer();

    friend class QQmlData;
    friend class QQmlComponentPrivate;
    friend class QQmlValueTypeProxyBinding;
    friend class QQmlPropertyPrivate;
    friend class QQmlVME;
    friend class QtSharedPointer::ExternalRefCount<QQmlAbstractBinding>;

    typedef QSharedPointer<QQmlAbstractBinding> SharedPointer;
    // To save memory, we also store the rarely used weakPointer() instance in here
    QPointerValuePair<QQmlAbstractBinding*, SharedPointer> m_mePtr;

    QQmlAbstractBinding **m_prevBinding;
    QQmlAbstractBinding  *m_nextBinding;
};

class QQmlValueTypeProxyBinding : public QQmlAbstractBinding
{
public:
    QQmlValueTypeProxyBinding(QObject *o, int coreIndex);

    virtual Type bindingType() const { return ValueTypeProxy; }

    virtual void setEnabled(bool, QQmlPropertyPrivate::WriteFlags);
    virtual void update(QQmlPropertyPrivate::WriteFlags);
    virtual int propertyIndex() const;
    virtual QObject *object() const;

    QQmlAbstractBinding *binding(int propertyIndex);

    void removeBindings(quint32 mask);

protected:
    ~QQmlValueTypeProxyBinding();

private:
    void recursiveEnable(QQmlAbstractBinding *, QQmlPropertyPrivate::WriteFlags);
    void recursiveDisable(QQmlAbstractBinding *);

    friend class QQmlAbstractBinding;
    QObject *m_object;
    int m_index;
    QQmlAbstractBinding *m_bindings;
};

class QQmlContext;
class QQmlBindingPrivate;
class Q_QML_PRIVATE_EXPORT QQmlBinding : public QQmlExpression,
                                                         public QQmlAbstractBinding
{
Q_OBJECT
public:
    enum EvaluateFlag { None = 0x00, RequiresThisObject = 0x01 };
    Q_DECLARE_FLAGS(EvaluateFlags, EvaluateFlag)

    QQmlBinding(const QString &, QObject *, QQmlContext *, QObject *parent=0);
    QQmlBinding(const QString &, QObject *, QQmlContextData *, QObject *parent=0);
    QQmlBinding(const QString &, bool isRewritten, QObject *, QQmlContextData *, 
                        const QString &url, int lineNumber, int columnNumber = 0, QObject *parent=0);
    QQmlBinding(void *, QObject *, QQmlContextData *, QObject *parent=0);

    void setTarget(const QQmlProperty &);
    void setTarget(QObject *, const QQmlPropertyData &, QQmlContextData *);
    QQmlProperty property() const;

    void setEvaluateFlags(EvaluateFlags flags);
    EvaluateFlags evaluateFlags() const;

    bool enabled() const;

    // Inherited from  QQmlAbstractBinding
    virtual void setEnabled(bool, QQmlPropertyPrivate::WriteFlags flags);
    virtual void update(QQmlPropertyPrivate::WriteFlags flags);
    virtual QString expression() const;
    virtual int propertyIndex() const;
    virtual QObject *object() const;
    virtual void retargetBinding(QObject *, int);

    typedef int Identifier;
    static Identifier Invalid;
    static QQmlBinding *createBinding(Identifier, QObject *, QQmlContext *,
                                              const QString &, int, QObject *parent=0);


public Q_SLOTS:
    void update() { update(QQmlPropertyPrivate::DontRemoveBinding); }

protected:
    ~QQmlBinding();

private:
    Q_DECLARE_PRIVATE(QQmlBinding)
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QQmlBinding::EvaluateFlags)

QQmlAbstractBinding::Pointer
QQmlAbstractBinding::getPointer(QQmlAbstractBinding *p)
{
    return p ? p->weakPointer() : Pointer();
}

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QQmlBinding*)

#endif // QQMLBINDING_P_H