bytearraybase32streamencoder.h

Go to the documentation of this file.

/*
    This file is part of the Okteta Kasten module, made within the KDE community.

    Copyright 2010 Friedrich W. H. Kossebau <kossebau@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef BYTEARRAYBASE32STREAMENCODER_H
#define BYTEARRAYBASE32STREAMENCODER_H

// lib
#include "abstractbytearraystreamencoder.h"
// Okteta core
#include <oktetacore.h>
// Qt
#include <QtCore/QString>


namespace Kasten2
{

class Base32StreamEncoderSettings
{
  public:
    enum AlgorithmId { ClassicId = 0, HexId = 1, ZHexId = 2 };

  public:
    Base32StreamEncoderSettings();
  public:
    AlgorithmId algorithmId;
};


class ByteArrayBase32StreamEncoder : public AbstractByteArrayStreamEncoder
{
    Q_OBJECT

  public:
    static const int inputGroupLength = 5;

    static const int outputLineLength = 76;
    static const int outputGroupLength = 8;
    static const int maxOutputGroupsPerLine = outputLineLength/outputGroupLength;

    enum InputByteIndex { FirstByte = 0, SecondByte, ThirdByte, FourthByte, FifthByte };

  public:
    ByteArrayBase32StreamEncoder();
    virtual ~ByteArrayBase32StreamEncoder();

  public:
    Base32StreamEncoderSettings settings() const;
    void setSettings( const Base32StreamEncoderSettings& settings );

  protected: // AbstractByteArrayStreamEncoder API
    virtual bool encodeDataToStream( QIODevice* device,
                                     const ByteArrayView* byteArrayView,
                                     const Okteta::AbstractByteArrayModel* byteArrayModel,
                                     const Okteta::AddressRange& range );

  protected:
    Base32StreamEncoderSettings mSettings;
};


inline Base32StreamEncoderSettings ByteArrayBase32StreamEncoder::settings() const { return mSettings; }
inline void ByteArrayBase32StreamEncoder::setSettings( const Base32StreamEncoderSettings& settings )
{
    mSettings = settings;
    emit settingsChanged();
}

}

#endif