aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/jsapi/qjsvalueiterator.cpp
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@digia.com>2013-08-08 13:02:40 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-08-08 15:35:08 +0200
commit6c51b182f3fc3abdd6330b402c4fe16d623d1b0a (patch)
treef3f997f565d74420102c6f67faaada24b30a9350 /src/qml/jsapi/qjsvalueiterator.cpp
parent3081b4f90f59eeaa64fe3ff59e5bfbc84a16191f (diff)
Move the JS Api into it's own folder
Change-Id: I7ef371ff929387097862121b73a7a5863b51ccf1 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
Diffstat (limited to 'src/qml/jsapi/qjsvalueiterator.cpp')
-rw-r--r--src/qml/jsapi/qjsvalueiterator.cpp206
1 files changed, 206 insertions, 0 deletions
diff --git a/src/qml/jsapi/qjsvalueiterator.cpp b/src/qml/jsapi/qjsvalueiterator.cpp
new file mode 100644
index 0000000000..aa1ecd6e54
--- /dev/null
+++ b/src/qml/jsapi/qjsvalueiterator.cpp
@@ -0,0 +1,206 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtQml module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, 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, Digia gives you certain additional
+** rights. These rights are described in the Digia 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.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qjsvalueiterator.h"
+#include "qjsvalueiterator_p.h"
+#include "qjsvalue_p.h"
+#include "private/qv4string_p.h"
+#include "private/qv4object_p.h"
+#include "private/qv4exception_p.h"
+
+QT_BEGIN_NAMESPACE
+
+QJSValueIteratorPrivate::QJSValueIteratorPrivate(const QJSValue &v)
+ : value(v)
+ , iterator(QJSValuePrivate::get(v)->value.asObject(), QV4::ObjectIterator::NoFlags)
+ , currentName(0)
+ , currentIndex(UINT_MAX)
+ , nextName(0)
+ , nextIndex(UINT_MAX)
+{
+}
+
+
+/*!
+ \class QJSValueIterator
+
+ \brief The QJSValueIterator class provides a Java-style iterator for QJSValue.
+
+ \ingroup qtjavascript
+ \inmodule QtQml
+
+
+ The QJSValueIterator constructor takes a QJSValue as
+ argument. After construction, the iterator is located at the very
+ beginning of the sequence of properties. Here's how to iterate over
+ all the properties of a QJSValue:
+
+ \snippet code/src_script_qjsvalueiterator.cpp 0
+
+ The next() advances the iterator. The name() and value()
+ functions return the name and value of the last item that was
+ jumped over.
+
+ Note that QJSValueIterator only iterates over the QJSValue's
+ own properties; i.e. it does not follow the prototype chain. You can
+ use a loop like this to follow the prototype chain:
+
+ \snippet code/src_script_qjsvalueiterator.cpp 1
+
+ \sa QJSValue::property()
+*/
+
+/*!
+ Constructs an iterator for traversing \a object. The iterator is
+ set to be at the front of the sequence of properties (before the
+ first property).
+*/
+QJSValueIterator::QJSValueIterator(const QJSValue& object)
+ : d_ptr(new QJSValueIteratorPrivate(object))
+{
+ d_ptr->iterator.next(&d_ptr->nextName, &d_ptr->nextIndex, &d_ptr->nextAttributes);
+}
+
+/*!
+ Destroys the iterator.
+*/
+QJSValueIterator::~QJSValueIterator()
+{
+}
+
+/*!
+ Returns true if there is at least one item ahead of the iterator
+ (i.e. the iterator is \e not at the back of the property sequence);
+ otherwise returns false.
+
+ \sa next()
+*/
+bool QJSValueIterator::hasNext() const
+{
+ if (!QJSValuePrivate::get(d_ptr->value)->value.isObject())
+ return false;
+ return d_ptr->nextName != 0 || d_ptr->nextIndex != UINT_MAX;
+}
+
+/*!
+ Advances the iterator by one position.
+ Returns true if there is at least one item ahead of the iterator
+ (i.e. the iterator is \e not at the back of the property sequence);
+ otherwise returns false.
+
+ Calling this function on an iterator located at the back of the
+ container leads to undefined results.
+
+ \sa hasNext(), name()
+*/
+bool QJSValueIterator::next()
+{
+ if (!QJSValuePrivate::get(d_ptr->value)->value.isObject())
+ return false;
+ d_ptr->currentName = d_ptr->nextName;
+ d_ptr->currentIndex = d_ptr->nextIndex;
+ d_ptr->currentAttributes = d_ptr->nextAttributes;
+
+ d_ptr->iterator.next(&d_ptr->nextName, &d_ptr->nextIndex, &d_ptr->nextAttributes);
+ return d_ptr->nextName != 0 || d_ptr->nextIndex != UINT_MAX;
+}
+
+/*!
+ Returns the name of the last property that was jumped over using
+ next().
+
+ \sa value()
+*/
+QString QJSValueIterator::name() const
+{
+ if (!QJSValuePrivate::get(d_ptr->value)->value.isObject())
+ return false;
+ if (d_ptr->currentName)
+ return d_ptr->currentName->toQString();
+ if (d_ptr->currentIndex < UINT_MAX)
+ return QString::number(d_ptr->currentIndex);
+ return QString();
+}
+
+
+/*!
+ Returns the value of the last property that was jumped over using
+ next().
+
+ \sa name()
+*/
+QJSValue QJSValueIterator::value() const
+{
+ if (!QJSValuePrivate::get(d_ptr->value)->value.isObject())
+ return QJSValue();
+
+ QV4::Object *o = d_ptr->iterator.object;
+ QV4::ExecutionEngine *engine = o->internalClass->engine;
+ QV4::ExecutionContext *ctx = engine->current;
+ try {
+ QV4::Value v;
+ if (d_ptr->currentName)
+ v = o->get(d_ptr->currentName);
+ else if (d_ptr->currentIndex != UINT_MAX)
+ v = o->getIndexed(d_ptr->currentIndex);
+ else
+ return QJSValue();
+ return new QJSValuePrivate(engine, v);
+ } catch (QV4::Exception &e) {
+ e.accept(ctx);
+ return QJSValue();
+ }
+}
+
+
+/*!
+ Makes the iterator operate on \a object. The iterator is set to be
+ at the front of the sequence of properties (before the first
+ property).
+*/
+QJSValueIterator& QJSValueIterator::operator=(QJSValue& object)
+{
+ d_ptr->iterator = QV4::ObjectIterator(QJSValuePrivate::get(object)->value.asObject(), QV4::ObjectIterator::NoFlags);
+ d_ptr->iterator.next(&d_ptr->nextName, &d_ptr->nextIndex, &d_ptr->nextAttributes);
+ return *this;
+}
+
+QT_END_NAMESPACE