imapset.h

/*
    Copyright (c) 2007 Volker Krause <vkrause@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_IMAPSET_H
#define KIMAP_IMAPSET_H

#include "kimap_export.h"

#include <QtCore/QByteArray>
#include <QtCore/QDebug>
#include <QtCore/QList>
#include <QtCore/QMetaType>
#include <QtCore/QSharedDataPointer>

namespace KIMAP {

class KIMAP_EXPORT ImapInterval
{
  public:
    typedef qint64 Id;

    typedef QList<ImapInterval> List;

    ImapInterval();

    ImapInterval( const ImapInterval &other );

    explicit ImapInterval( Id begin, Id end = 0 );

    ~ImapInterval();

    ImapInterval& operator=( const ImapInterval &other );

    bool operator==( const ImapInterval &other ) const;

    Id size() const;

    bool hasDefinedBegin() const;

    Id begin() const;

    bool hasDefinedEnd() const;

    Id end() const;

    void setBegin( Id value );

    void setEnd( Id value );

    QByteArray toImapSequence() const;

    static ImapInterval fromImapSequence( const QByteArray &sequence );

  private:
    class Private;
    QSharedDataPointer<Private> d;
};

class KIMAP_EXPORT ImapSet
{
  public:
    typedef qint64 Id;

    ImapSet();

    ImapSet( Id begin, Id end );

    explicit ImapSet( Id value );

    ImapSet( const ImapSet &other );

    ~ImapSet();

    ImapSet& operator=( const ImapSet &other );

    bool operator==( const ImapSet &other ) const;

    void add( Id value );

    void add( const QList<Id> &values );

    void add( const ImapInterval &interval );

    QByteArray toImapSequenceSet() const;

    static ImapSet fromImapSequenceSet( const QByteArray &sequence );

    ImapInterval::List intervals() const;

    bool isEmpty() const;

  private:
    class Private;
    QSharedDataPointer<Private> d;
};

}

KIMAP_EXPORT QDebug& operator<<( QDebug& d, const KIMAP::ImapInterval &interval );
KIMAP_EXPORT QDebug& operator<<( QDebug& d, const KIMAP::ImapSet &set );

Q_DECLARE_METATYPE( KIMAP::ImapInterval )
Q_DECLARE_METATYPE( KIMAP::ImapInterval::List )
Q_DECLARE_METATYPE( KIMAP::ImapSet )

#endif