valentina/src/libs/vmisc/qxtcsvmodel.h

/****************************************************************************
** Copyright (c) 2006 - 2011, the LibQxt project.
** See the Qxt AUTHORS file for a list of authors and copyright holders.
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the LibQxt project nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
** <http://libqxt.org>  <foundation@libqxt.org>
*****************************************************************************/

#ifndef QXTCSVMODEL_H
#define QXTCSVMODEL_H

#include <QAbstractTableModel>
#include <QChar>
#include <QFlags>
#include <QIODevice>
#include <QIncompatibleFlag>
#include <QMetaObject>
#include <QModelIndex>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariant>
#include <QtGlobal>

#include "def.h"

class QxtCsvModelPrivate;

#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
class VTextCodec;
#else
class QTextCodec;
using VTextCodec = QTextCodec;
#endif

class QxtCsvModel final : public QAbstractTableModel
{
    Q_OBJECT // NOLINT

public:
    explicit QxtCsvModel(QObject *parent = nullptr);
    explicit QxtCsvModel(QIODevice *file, QObject *parent = nullptr, bool withHeader = false, QChar separator = ',',
                         VTextCodec *codec = nullptr);
    explicit QxtCsvModel(const QString &filename, QObject *parent = nullptr, bool withHeader = false,
                         QChar separator = ',', VTextCodec *codec = nullptr);
    virtual ~QxtCsvModel() = default;

    virtual auto rowCount(const QModelIndex &parent = QModelIndex()) const -> int override;
    virtual auto columnCount(const QModelIndex &parent = QModelIndex()) const -> int override;
    virtual auto data(const QModelIndex &index, int role = Qt::DisplayRole) const -> QVariant override;
    virtual auto setData(const QModelIndex &index, const QVariant &data, int role = Qt::EditRole) -> bool override;
    virtual auto headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const
        -> QVariant override;
    virtual auto setHeaderData(int section, Qt::Orientation orientation, const QVariant &value,
                               int role = Qt::DisplayRole) -> bool override;
    void setHeaderData(const QStringList &data);

    auto text(int row, int column) const -> QString;
    void setText(int row, int column, const QString &value);

    auto headerText(int column) const -> QString;
    void setHeaderText(int column, const QString &value);

    auto insertRow(int row, const QModelIndex &parent = QModelIndex()) -> bool;
    virtual auto insertRows(int row, int count, const QModelIndex &parent = QModelIndex()) -> bool override;

    auto removeRow(int row, const QModelIndex &parent = QModelIndex()) -> bool;
    virtual auto removeRows(int row, int count, const QModelIndex &parent = QModelIndex()) -> bool override;

    auto insertColumn(int col, const QModelIndex &parent = QModelIndex()) -> bool;
    virtual auto insertColumns(int col, int count, const QModelIndex &parent = QModelIndex()) -> bool override;

    auto removeColumn(int col, const QModelIndex &parent = QModelIndex()) -> bool;
    virtual auto removeColumns(int col, int count, const QModelIndex &parent = QModelIndex()) -> bool override;

    void setSource(QIODevice *file, bool withHeader = false, QChar separator = ',', VTextCodec *codec = nullptr);
    void setSource(const QString &filename, bool withHeader = false, QChar separator = ',',
                   VTextCodec *codec = nullptr);

    auto toCSV(QIODevice *file, QString &error, bool withHeader = false, QChar separator = ',',
               VTextCodec *codec = nullptr) const -> bool;
    auto toCSV(const QString &filename, QString &error, bool withHeader = false, QChar separator = ',',
               VTextCodec *codec = nullptr) const -> bool;

    enum QuoteOption
    {
        NoQuotes = 0,
        SingleQuote = 1,
        DoubleQuote = 2,
        BothQuotes = 3,
        NoEscape = 0,
        TwoQuoteEscape = 4,
        BackslashEscape = 8,
        AlwaysQuoteOutput = 16,
        DefaultQuoteMode = BothQuotes | BackslashEscape | AlwaysQuoteOutput
    };
    Q_DECLARE_FLAGS(QuoteMode, QuoteOption)

    auto quoteMode() const -> QuoteMode;
    void setQuoteMode(QuoteMode mode);

    virtual auto flags(const QModelIndex &index) const -> Qt::ItemFlags override;

private:
    Q_DISABLE_COPY_MOVE(QxtCsvModel) // NOLINT
    QXT_DECLARE_PRIVATE(QxtCsvModel)
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QxtCsvModel::QuoteMode)

#endif // QXTCSVMODEL_H