Long live DOM API for CBOR!

This is very similar to QJsonDocument, but there's no QCborDocument.
QCborValue is that.

[ChangeLog][QtCore] Added QCborValue, QCborArray and QCborMap, classes
that permit DOM-like access to CBOR data. The API is similar to
QJsonValue, QJsonArray and QJsonObject, respectively.

Change-Id: I9741f017961b410c910dfffd14ffca50dd8ef3ba
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

1 files changed, 320 insertions, 0 deletions

diff --git a/src/corelib/serialization/qcbormap.h b/src/corelib/serialization/qcbormap.h
new file mode 100644
index 0000000000..f8adba4c56
--- /dev/null
+++ b/src/corelib/serialization/qcbormap.h
@@ -0,0 +1,320 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 Intel Corporation.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtCore 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QCBORMAP_H
+#define QCBORMAP_H
+
+#include <QtCore/qcborvalue.h>
+#include <QtCore/qpair.h>
+
+#include <initializer_list>
+
+QT_BEGIN_NAMESPACE
+
+template <class Key, class T> class QMap;
+typedef QMap<QString, QVariant> QVariantMap;
+template <class Key, class T> class QHash;
+typedef QHash<QString, QVariant> QVariantHash;
+class QJsonObject;
+
+class QCborContainerPrivate;
+class Q_CORE_EXPORT QCborMap
+{
+public:
+    typedef QPair<QCborValue, QCborValue> value_type;
+    typedef QCborValue key_type;
+    typedef QCborValue mapped_type;
+    typedef qsizetype size_type;
+
+    class ConstIterator;
+    class Iterator {
+        mutable QCborValueRef item;     // points to the value
+        friend class ConstIterator;
+        friend class QCborMap;
+        Iterator(QCborContainerPrivate *dd, qsizetype ii) : item(dd, ii) {}
+    public:
+        typedef std::random_access_iterator_tag iterator_category;
+        typedef qsizetype difference_type;
+        typedef QPair<const QCborValueRef, QCborValueRef> value_type;
+        typedef QPair<const QCborValueRef, QCborValueRef> reference;
+        typedef QPair<const QCborValueRef, QCborValueRef> pointer;
+
+        Q_DECL_CONSTEXPR Iterator() = default;
+        Q_DECL_CONSTEXPR Iterator(const Iterator &) = default;
+        Iterator &operator=(const Iterator &other)
+        {
+            // rebind the reference
+            item.d = other.item.d;
+            item.i = other.item.i;
+            return *this;
+        }
+
+        value_type operator*() const { return { {item.d, item.i - 1}, item }; }
+        QCborValueRef *operator->() const { return &item; }
+        QCborValue key() const { return QCborValueRef(item.d, item.i - 1); }
+        QCborValueRef value() const { return item; }
+
+        bool operator==(const Iterator &o) const { return item.d == o.item.d && item.i == o.item.i; }
+        bool operator!=(const Iterator &o) const { return !(*this == o); }
+        bool operator<(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i < other.item.i; }
+        bool operator<=(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i <= other.item.i; }
+        bool operator>(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i > other.item.i; }
+        bool operator>=(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i >= other.item.i; }
+        bool operator==(const ConstIterator &o) const { return item.d == o.item.d && item.i == o.item.i; }
+        bool operator!=(const ConstIterator &o) const { return !(*this == o); }
+        bool operator<(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i < other.item.i; }
+        bool operator<=(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i <= other.item.i; }
+        bool operator>(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i > other.item.i; }
+        bool operator>=(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i >= other.item.i; }
+        Iterator &operator++() { item.i += 2; return *this; }
+        Iterator operator++(int) { Iterator n = *this; item.i += 2; return n; }
+        Iterator &operator--() { item.i -= 2; return *this; }
+        Iterator operator--(int) { Iterator n = *this; item.i -= 2; return n; }
+        Iterator &operator+=(qsizetype j) { item.i += 2 * j; return *this; }
+        Iterator &operator-=(qsizetype j) { item.i -= 2 * j; return *this; }
+        Iterator operator+(qsizetype j) const { return Iterator({ item.d, item.i + 2 * j }); }
+        Iterator operator-(qsizetype j) const { return Iterator({ item.d, item.i - 2 * j }); }
+        qsizetype operator-(Iterator j) const { return (item.i - j.item.i) / 2; }
+    };
+
+    class ConstIterator {
+        QCborValueRef item;     // points to the value
+        friend class Iterator;
+        friend class QCborMap;
+        ConstIterator(QCborContainerPrivate *dd, qsizetype ii) : item(dd, ii) {}
+    public:
+        typedef std::random_access_iterator_tag iterator_category;
+        typedef qsizetype difference_type;
+        typedef QPair<const QCborValueRef, const QCborValueRef> value_type;
+        typedef QPair<const QCborValueRef, const QCborValueRef> reference;
+        typedef QPair<const QCborValueRef, const QCborValueRef> pointer;
+
+        Q_DECL_CONSTEXPR ConstIterator() = default;
+        Q_DECL_CONSTEXPR ConstIterator(const ConstIterator &) = default;
+        ConstIterator &operator=(const ConstIterator &other)
+        {
+            // rebind the reference
+            item.d = other.item.d;
+            item.i = other.item.i;
+            return *this;
+        }
+
+        value_type operator*() const { return { {item.d, item.i - 1}, item }; }
+        const QCborValueRef *operator->() const { return &item; }
+        QCborValue key() const { return QCborValueRef(item.d, item.i - 1); }
+        QCborValueRef value() const { return item; }
+
+        bool operator==(const Iterator &o) const { return item.d == o.item.d && item.i == o.item.i; }
+        bool operator!=(const Iterator &o) const { return !(*this == o); }
+        bool operator<(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i < other.item.i; }
+        bool operator<=(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i <= other.item.i; }
+        bool operator>(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i > other.item.i; }
+        bool operator>=(const Iterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i >= other.item.i; }
+        bool operator==(const ConstIterator &o) const { return item.d == o.item.d && item.i == o.item.i; }
+        bool operator!=(const ConstIterator &o) const { return !(*this == o); }
+        bool operator<(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i < other.item.i; }
+        bool operator<=(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i <= other.item.i; }
+        bool operator>(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i > other.item.i; }
+        bool operator>=(const ConstIterator& other) const { Q_ASSERT(item.d == other.item.d); return item.i >= other.item.i; }
+        ConstIterator &operator++() { item.i += 2; return *this; }
+        ConstIterator operator++(int) { ConstIterator n = *this; item.i += 2; return n; }
+        ConstIterator &operator--() { item.i -= 2; return *this; }
+        ConstIterator operator--(int) { ConstIterator n = *this; item.i -= 2; return n; }
+        ConstIterator &operator+=(qsizetype j) { item.i += 2 * j; return *this; }
+        ConstIterator &operator-=(qsizetype j) { item.i -= 2 * j; return *this; }
+        ConstIterator operator+(qsizetype j) const { return ConstIterator({ item.d, item.i + 2 * j }); }
+        ConstIterator operator-(qsizetype j) const { return ConstIterator({ item.d, item.i - 2 * j }); }
+        qsizetype operator-(ConstIterator j) const { return (item.i - j.item.i) / 2; }
+    };
+
+    QCborMap()  Q_DECL_NOTHROW;
+    QCborMap(const QCborMap &other) Q_DECL_NOTHROW;
+    QCborMap &operator=(const QCborMap &other) Q_DECL_NOTHROW;
+    QCborMap(std::initializer_list<value_type> args)
+        : QCborMap()
+    {
+        detach(args.size());
+        for (auto pair : args)
+           insert(pair.first, pair.second);
+    }
+    ~QCborMap();
+
+    void swap(QCborMap &other) Q_DECL_NOTHROW
+    {
+        qSwap(d, other.d);
+    }
+
+    QCborValue toCborValue() const { return *this; }
+
+    qsizetype size() const Q_DECL_NOTHROW Q_DECL_PURE_FUNCTION;
+    bool isEmpty() const { return size() == 0; }
+    QVector<QCborValue> keys() const;
+
+    QCborValue value(qint64 key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue value(QLatin1String key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue value(const QString & key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue value(const QCborValue &key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue operator[](qint64 key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue operator[](QLatin1String key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue operator[](const QString & key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValue operator[](const QCborValue &key) const
+    { const_iterator it = find(key); return it == end() ? QCborValue() : it.value(); }
+    QCborValueRef operator[](qint64 key);
+    QCborValueRef operator[](QLatin1String key);
+    QCborValueRef operator[](const QString & key);
+    QCborValueRef operator[](const QCborValue &key);
+
+    void remove(qint64 key)
+    { iterator it = find(key); if (it != end()) erase(it); }
+    void remove(QLatin1String key)
+    { iterator it = find(key); if (it != end()) erase(it); }
+    void remove(const QString & key)
+    { iterator it = find(key); if (it != end()) erase(it); }
+    void remove(const QCborValue &key)
+    { iterator it = find(key); if (it != end()) erase(it); }
+    bool contains(qint64 key) const
+    { const_iterator it = find(key); return it != end(); }
+    bool contains(QLatin1String key) const
+    { const_iterator it = find(key); return it != end(); }
+    bool contains(const QString & key) const
+    { const_iterator it = find(key); return it != end(); }
+    bool contains(const QCborValue &key) const
+    { const_iterator it = find(key); return it != end(); }
+
+    int compare(const QCborMap &other) const Q_DECL_NOTHROW Q_DECL_PURE_FUNCTION;
+#if QT_HAS_INCLUDE(<compare>)
+    std::strong_ordering operator<=>(const QCborMap &other) const
+    {
+        int c = compare(other);
+        if (c > 0) return std::strong_ordering::greater;
+        if (c == 0) return std::strong_ordering::equivalent;
+        return std::strong_ordering::less;
+    }
+#else
+    bool operator==(const QCborMap &other) const Q_DECL_NOTHROW
+    { return compare(other) == 0; }
+    bool operator!=(const QCborMap &other) const Q_DECL_NOTHROW
+    { return !(*this == other); }
+    bool operator<(const QCborMap &other) const
+    { return compare(other) < 0; }
+#endif
+
+    typedef Iterator iterator;
+    typedef ConstIterator const_iterator;
+    iterator begin() { detach(); return iterator{d.data(), 1}; }
+    const_iterator constBegin() const { return const_iterator{d.data(), 1}; }
+    const_iterator begin() const { return constBegin(); }
+    const_iterator cbegin() const { return constBegin(); }
+    iterator end() { detach(); return iterator{d.data(), 2 * size() + 1}; }
+    const_iterator constEnd() const { return const_iterator{d.data(), 2 * size() + 1}; }
+    const_iterator end() const { return constEnd(); }
+    const_iterator cend() const { return constEnd(); }
+    iterator erase(iterator it);
+    iterator erase(const_iterator it) { return erase(iterator{ it.item.d, it.item.i }); }
+    bool empty() const { return isEmpty(); }
+
+    iterator find(qint64 key);
+    iterator find(QLatin1String key);
+    iterator find(const QString & key);
+    iterator find(const QCborValue &key);
+    const_iterator constFind(qint64 key) const;
+    const_iterator constFind(QLatin1String key) const;
+    const_iterator constFind(const QString & key) const;
+    const_iterator constFind(const QCborValue &key) const;
+    const_iterator find(qint64 key) const { return constFind(key); }
+    const_iterator find(QLatin1String key) const { return constFind(key); }
+    const_iterator find(const QString & key) const { return constFind(key); }
+    const_iterator find(const QCborValue &key) const { return constFind(key); }
+
+    iterator insert(qint64 key, const QCborValue &value)
+    {
+        QCborValueRef v = operator[](key);  // detaches
+        v = value;
+        return { d.data(), v.i };
+    }
+    iterator insert(QLatin1String key, const QCborValue &value)
+    {
+        QCborValueRef v = operator[](key);  // detaches
+        v = value;
+        return { d.data(), v.i };
+    }
+    iterator insert(const QString &key, const QCborValue &value)
+    {
+        QCborValueRef v = operator[](key);  // detaches
+        v = value;
+        return { d.data(), v.i };
+    }
+    iterator insert(const QCborValue &key, const QCborValue &value)
+    {
+        QCborValueRef v = operator[](key);  // detaches
+        v = value;
+        return { d.data(), v.i };
+    }
+    iterator insert(value_type v) { return insert(v.first, v.second); }
+
+private:
+    void detach(qsizetype reserve = 0);
+
+    friend QCborValue;
+    explicit QCborMap(QCborContainerPrivate &dd) Q_DECL_NOTHROW;
+    QExplicitlySharedDataPointer<QCborContainerPrivate> d;
+};
+
+Q_DECLARE_SHARED(QCborMap)
+
+inline QCborMap QCborValueRef::toMap() const
+{
+    return concrete().toMap();
+}
+
+inline QCborMap QCborValueRef::toMap(const QCborMap &m) const
+{
+    return concrete().toMap(m);
+}
+
+QT_END_NAMESPACE
+
+#endif // QCBORMAP_H