imapstreamparser.h

/*
    Copyright (c) 2006 - 2007 Volker Krause <vkrause@kde.org>
    Copyright (c) 2009 Andras Mantia <amantia@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 KIMAP_IMAPSTREAMPARSER_P_H
#define KIMAP_IMAPSTREAMPARSER_P_H

#include "kimap_export.h"

#include <exception>

#include <QtCore/QByteArray>
#include <QtCore/QList>
#include <QtCore/QString>

class QIODevice;

namespace KIMAP {

class ImapParserException : public std::exception
{
  public:
    explicit ImapParserException( const char *what ) throw() : mWhat( what ) {}
    explicit ImapParserException( const QByteArray &what ) throw() : mWhat( what ) {}
    explicit ImapParserException( const QString &what ) throw() : mWhat( what.toUtf8() ) {}
    ImapParserException( const ImapParserException &other ) throw() : std::exception( other ), mWhat( other.what() ) {}
    virtual ~ImapParserException() throw() {}
    const char *what() const throw() { return mWhat.constData(); }
    virtual const char *type() const throw() { return "ImapParserException"; }
  private:
    QByteArray mWhat;
};

class KIMAP_EXPORT ImapStreamParser
{
  public:
    explicit ImapStreamParser( QIODevice *socket, bool serverModeEnabled = false );

    ~ImapStreamParser();

    QString readUtf8String();

    QByteArray readString();

    QList<QByteArray> readParenthesizedList();

    qint64 readNumber( bool * ok = 0 );

    bool hasString();

    bool hasLiteral();

    QByteArray readLiteralPart();

    bool atLiteralEnd() const;

    bool hasList();

    bool atListEnd();

    bool hasResponseCode();

    bool atResponseCodeEnd();

    bool atCommandEnd();

    QByteArray readUntilCommandEnd();

    QByteArray readRemainingData();

    int availableDataSize() const;

    void setData( const QByteArray &data );

  private:
    void stripLeadingSpaces();
    QByteArray parseQuotedString();

    bool waitForMoreData( bool wait);

    void sendContinuationResponse( qint64 size );

    void trimBuffer();

    QIODevice *m_socket;
    bool m_isServerModeEnabled;
    QByteArray m_data;
    int m_position;
    qint64 m_literalSize;
};

}

#endif