qcsvreader.h

Go to the documentation of this file.

/*
  Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Library General Public License as published by
  the Free Software Foundation; either version 2 of the License, or (at your
  option) any later version.

  This library is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to the
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/

#ifndef QCSVREADER_H
#define QCSVREADER_H

#include <QtCore/QObject>

class QIODevice;

class QCsvBuilderInterface
{
public:
    virtual ~QCsvBuilderInterface();

    virtual void begin() = 0;

    virtual void beginLine() = 0;

    virtual void field( const QString &data, uint row, uint column ) = 0;

    virtual void endLine() = 0;

    virtual void end() = 0;

    virtual void error( const QString &errorMsg ) = 0;
};

class QCsvReader : public QObject
{
    Q_OBJECT

    Q_PROPERTY( QChar textQuote READ textQuote WRITE setTextQuote )
    Q_PROPERTY( QChar delimiter READ delimiter WRITE setDelimiter )
    Q_PROPERTY( uint startRow READ startRow WRITE setStartRow )

public:
    explicit QCsvReader( QCsvBuilderInterface *builder );

    ~QCsvReader();

    bool read( QIODevice *device );

    void setTextQuote( const QChar &textQuote );

    QChar textQuote() const;

    void setDelimiter( const QChar &delimiter );

    QChar delimiter() const;

    void setStartRow( uint startRow );

    uint startRow() const;

    void setTextCodec( QTextCodec *textCodec );

    QTextCodec *textCodec() const;

    void terminate();

private:
    class Private;
    Private *const d;
};

class QCsvStandardBuilder : public QCsvBuilderInterface
{
public:
    QCsvStandardBuilder();

    ~QCsvStandardBuilder();

    QString lastErrorString() const;

    uint rowCount() const;

    uint columnCount() const;

    QString data( uint row, uint column ) const;

    void begin();
    void beginLine();
    void field( const QString &data, uint row, uint column );
    void endLine();
    void end();
    void error( const QString &errorMsg );

private:
    class Private;
    Private *const d;

    Q_DISABLE_COPY( QCsvStandardBuilder )
};

#endif