qt-creator/src/libs/sqlite/sqlitesessionchangeset.h

/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
****************************************************************************/

#pragma once

#include "sqliteblob.h"
#include "sqliteglobal.h"
#include "sqlitevalue.h"

#include <utils/smallstring.h>

#include <memory>
#include <vector>
#include <iosfwd>

struct sqlite3_changeset_iter;

namespace Sqlite {

class Sessions;

enum class Operation : char { Invalid, Insert, Update, Delete };

namespace SessionChangeSetInternal {

class SentinelIterator
{};

class ValueViews
{
public:
    ValueView newValue;
    ValueView oldValue;
};

class SQLITE_EXPORT ConstTupleIterator
{
public:
    using difference_type = int;
    using value_type = ValueView;
    using pointer = const ValueView *;
    using reference = const ValueView &;
    using iterator_category = std::forward_iterator_tag;

    ConstTupleIterator(sqlite3_changeset_iter *sessionIterator,
                       int index,
                       Sqlite::Operation operation)
        : m_sessionIterator{sessionIterator}
        , m_column{index}
        , m_operation{operation}
    {}

    ConstTupleIterator operator++()
    {
        ++m_column;

        return *this;
    }

    friend bool operator==(const ConstTupleIterator &first, const ConstTupleIterator &second)
    {
        return first.m_column == second.m_column;
    }

    friend bool operator!=(const ConstTupleIterator &first, const ConstTupleIterator &second)
    {
        return !(first == second);
    }

    ValueViews operator*() const;

private:
    sqlite3_changeset_iter *m_sessionIterator = {};
    int m_column = 0;
    Sqlite::Operation m_operation = Sqlite::Operation::Invalid;
};

class SQLITE_EXPORT Tuple
{
public:
    using difference_type = int;
    using value_type = ValueView;
    using reference = ValueView &;
    using const_reference = const ValueView &;
    using iterator = ConstTupleIterator;
    using const_iterator = ConstTupleIterator;
    using size_type = int;

    Utils::SmallStringView table;
    sqlite3_changeset_iter *sessionIterator = {};
    int columnCount = 0;
    Sqlite::Operation operation = Sqlite::Operation::Invalid;

    ValueViews operator[](int column) const;
    ConstTupleIterator begin() const { return {sessionIterator, 0, operation}; }
    ConstTupleIterator end() const { return {sessionIterator, columnCount, operation}; }
};

enum class State : char { Invalid, Row, Done };

class SQLITE_EXPORT ConstIterator
{
public:
    using difference_type = long;
    using value_type = Tuple;
    using pointer = const Tuple *;
    using reference = const Tuple &;
    using iterator_category = std::input_iterator_tag;

    ConstIterator(sqlite3_changeset_iter *sessionIterator)
        : m_sessionIterator(sessionIterator)
    {}

    ConstIterator(const ConstIterator &) = delete;
    void operator=(const ConstIterator &) = delete;

    ConstIterator(ConstIterator &&other)
        : m_sessionIterator(other.m_sessionIterator)
        , m_state(other.m_state)
    {
        other.m_sessionIterator = {};
        other.m_state = State::Done;
    }

    ConstIterator &operator=(ConstIterator &&other)
    {
        auto tmp = std::move(other);
        std::swap(tmp, *this);

        return *this;
    }

    ~ConstIterator();

    ConstIterator &operator++();

    friend bool operator==(const ConstIterator &first, const ConstIterator &second)
    {
        return first.m_sessionIterator == second.m_sessionIterator;
    }

    friend bool operator!=(const ConstIterator &first, const ConstIterator &second)
    {
        return !(first == second);
    }

    friend bool operator==(const ConstIterator &first, SentinelIterator)
    {
        return first.m_state == State::Done;
    }

    friend bool operator!=(const ConstIterator &first, SentinelIterator)
    {
        return first.m_state == State::Row;
    }

    friend bool operator==(SentinelIterator first, const ConstIterator &second)
    {
        return second == first;
    }

    friend bool operator!=(SentinelIterator first, const ConstIterator &second)
    {
        return second != first;
    }

    Tuple operator*() const;

    State state() const { return m_state; }

private:
    sqlite3_changeset_iter *m_sessionIterator = {};
    State m_state = State::Invalid;
};
} // namespace SessionChangeSetInternal

class SQLITE_EXPORT SessionChangeSet
{
public:
    SessionChangeSet(BlobView blob);
    SessionChangeSet(Sessions &session);
    ~SessionChangeSet();
    SessionChangeSet(const SessionChangeSet &) = delete;
    void operator=(const SessionChangeSet &) = delete;
    SessionChangeSet(SessionChangeSet &&other) noexcept
    {
        SessionChangeSet temp;
        swap(temp, other);
        swap(temp, *this);
    }
    void operator=(SessionChangeSet &);

    BlobView asBlobView() const;

    friend void swap(SessionChangeSet &first, SessionChangeSet &second) noexcept
    {
        SessionChangeSet temp;
        std::swap(temp.m_data, first.m_data);
        std::swap(temp.m_size, first.m_size);
        std::swap(first.m_data, second.m_data);
        std::swap(first.m_size, second.m_size);
        std::swap(temp.m_data, second.m_data);
        std::swap(temp.m_size, second.m_size);
    }

    SessionChangeSetInternal::ConstIterator begin() const;
    SessionChangeSetInternal::SentinelIterator end() const { return {}; }

    void *data() const { return m_data; }

    int size() const { return m_size; }

private:
    SessionChangeSet() = default;

private:
    void *m_data = nullptr;
    int m_size = {};
};

using SessionChangeSets = std::vector<SessionChangeSet>;

} // namespace Sqlite