aboutsummaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/v8/qscripttools_p.h
blob: f74fbab83f9611267d0d1d9d92fe5c2dc0f15c03 (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
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtScript module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL-ONLY$
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

//
//  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.
//


#ifndef QSCRIPTTOOLS_P_H
#define QSCRIPTTOOLS_P_H

#include <qdebug.h>

QT_BEGIN_NAMESPACE

template<class T>
class QScriptBagContainer;

/*!
  \internal
  \interface
  Helper class for a container. The purpuse of it is to add two pointer properties to a class
  inheriting this class without bloating an interface.

  This class exist only as a memory storage implementation. The only way to use it is to inherit it.
*/
class QScriptLinkedNode
{
protected:
    QScriptLinkedNode()
        : m_next(0)
        , m_prev(0)
    {}

    ~QScriptLinkedNode()
    {
        Q_ASSERT_X(!isUsed(), Q_FUNC_INFO, "Destorying QScriptLinkedNode instance that still is in a container");
    }

private:
    bool isUsed() const
    {
        return m_next || m_prev;
    }

#if defined(Q_NO_TEMPLATE_FRIENDS)
public:
#else
    template<class T>
    friend class QScriptBagContainer;
#endif
    QScriptLinkedNode *m_next;
    QScriptLinkedNode *m_prev;
};

/*!
  \internal
  The QScriptBagContainer is a simple, low level, set like container for a pointer type castable to
  QScriptLinkedNode*.
  Algorithms complexity:
  put: O(1)
  get: O(1)
  forEach: O(n)
  \note This container doesn't take ownership of pointed values.
  \attention All values have to be unique.
*/
template<class T>
class QScriptBagContainer
{
public:
    QScriptBagContainer()
        : m_first(0)
    {}

    /*!
      \internal
      Add a this \a value to this container
    */
    void insert(T* value)
    {
        //dump(Q_FUNC_INFO, value);
        Q_ASSERT_X(!contains(value), Q_FUNC_INFO, "Can't insert a value which is in the bag already");
        QScriptLinkedNode* v = static_cast<QScriptLinkedNode*>(value);
        Q_ASSERT(v);
        Q_ASSERT_X(!v->m_next && !v->m_prev, Q_FUNC_INFO, "Can't insert a value which is in an another bag");

        if (m_first)
            m_first->m_prev = v;

        v->m_next = m_first;
        v->m_prev = 0;
        m_first = v;
    }

    /*!
      \internal
      Remove this \a value from this container
    */
    void remove(T* value)
    {
        //dump(Q_FUNC_INFO, value);
        QScriptLinkedNode* v = static_cast<QScriptLinkedNode*>(value);
        Q_ASSERT(v);

        if (!v->m_next && !v->m_prev && m_first != v) {
            // ignore that value as it is not registered at all
            // FIXME: That may be optimized out if unregister call is removed from ~QtDataBase
            return;
        }

        Q_ASSERT_X(contains(value), Q_FUNC_INFO, "Can't remove a value which is not in the bag");
        Q_ASSERT(v->m_prev || (m_first == v && !v->m_prev));

        if (v->m_next)
            v->m_next->m_prev= v->m_prev;

        if (v->m_prev)
            v->m_prev->m_next = v->m_next;
        else
            m_first = v->m_next;
        // reset removed value
        v->m_next = v->m_prev = 0;
    }

    /*!
      \internal
      Call \a fun for each element in this container. Fun should accept T* as a parameter.
      \note In general it is not allowed to change this container by calling put() or get() unless
      given value is the same as currently procceded by forEach.
    */
    template<class Functor>
    void forEach(Functor fun)
    {
        //dump(Q_FUNC_INFO);
        QScriptLinkedNode *i = m_first;
        QScriptLinkedNode *tmp;
        while (i) {
            tmp = i;
            i = i->m_next;
            fun(static_cast<T*>(tmp));
        }
    }

    /*!
      \internal
      Clear this container.
    */
    void clear()
    {
        m_first = 0;
    }

    /*!
      \internal
      Returns true if this container is empty; false otherwise.
    */
    bool isEmpty() const
    {
        return !m_first;
    }

//    void dump(const char* msg, T* obj = 0) const
//    {
//        qDebug() << msg << obj;
//        qDebug() << m_first;
//        QScriptLinkedNode *i = m_first;
//        while (i) {
//            qDebug() <<"  - " << i << "(" << i->m_prev << ", " << i->m_next <<")";
//            i = i->m_next;
//        }
//    }

private:
    bool contains(T *value) const
    {
        QScriptLinkedNode *i = m_first;
        while (i) {
            if (static_cast<T*>(i) == value)
                return true;
            i = i->m_next;
        }
        return false;
    }
    QScriptLinkedNode *m_first;
};

QT_END_NAMESPACE

#endif //QSCRIPTTOOLS_P_H