Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlabstractexpression_p.h
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 #ifndef QQMLABSTRACTEXPRESSION_P_H
43 #define QQMLABSTRACTEXPRESSION_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 <private/qqmlcontext_p.h>
57 #include <private/qfieldlist_p.h>
58 #include <private/qflagpointer_p.h>
59
60 QT_BEGIN_NAMESPACE
61
62 class Q_QML_PRIVATE_EXPORT QQmlAbstractExpression
63 {
64 public:
65     QQmlAbstractExpression();
66     virtual ~QQmlAbstractExpression();
67
68     bool isValid() const;
69
70     QQmlContextData *context() const;
71     void setContext(QQmlContextData *);
72
73     virtual void refresh();
74
75     class DeleteWatcher {
76     public:
77         inline DeleteWatcher(QQmlAbstractExpression *);
78         inline ~DeleteWatcher();
79         inline bool wasDeleted() const;
80     private:
81         friend class QQmlAbstractExpression;
82         QQmlContextData *_c;
83         QQmlAbstractExpression **_w;
84         QQmlAbstractExpression *_s;
85     };
86
87 private:
88     friend class QQmlContext;
89     friend class QQmlContextData;
90     friend class QQmlContextPrivate;
91
92     QBiPointer<QQmlContextData, DeleteWatcher> m_context;
93     QQmlAbstractExpression **m_prevExpression;
94     QQmlAbstractExpression  *m_nextExpression;
95 };
96
97 QQmlAbstractExpression::DeleteWatcher::DeleteWatcher(QQmlAbstractExpression *e)
98 : _c(0), _w(0), _s(e)
99 {
100     if (e->m_context.isT1()) {
101         _w = &_s;
102         _c = e->m_context.asT1();
103         e->m_context = this;
104     } else {
105         // Another watcher is already registered
106         _w = &e->m_context.asT2()->_s;
107     }
108 }
109
110 QQmlAbstractExpression::DeleteWatcher::~DeleteWatcher()
111 {
112     Q_ASSERT(*_w == 0 || (*_w == _s && _s->m_context.isT2()));
113     if (*_w && _s->m_context.asT2() == this)
114         _s->m_context = _c;
115 }
116
117 bool QQmlAbstractExpression::DeleteWatcher::wasDeleted() const
118 {
119     return *_w == 0;
120 }
121
122 QT_END_NAMESPACE
123
124 #endif // QQMLABSTRACTEXPRESSION_P_H