valuecodec.h

Go to the documentation of this file.

/*
    This file is part of the Okteta Core library, made within the KDE community.

    Copyright 2003 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 OKTETA_VALUECODEC_H
#define OKTETA_VALUECODEC_H

// lib
#include "oktetacore.h"
#include "oktetacore_export.h"
#include "byte.h"

class QString;


namespace Okteta
{

class OKTETACORE_EXPORT ValueCodec
{
  public:
    static ValueCodec* createCodec( ValueCoding valueCoding );

  public:
    virtual ~ValueCodec();

  protected:
    ValueCodec();

  public: // API to be implemented
    virtual unsigned int encodingWidth() const = 0;
    virtual Byte digitsFilledLimit() const = 0;

    virtual void encode( QString& digits, unsigned int pos, Byte byte ) const = 0;
    // TODO: make this QString* digits
    virtual void encodeShort( QString& digits, unsigned int pos, Byte byte ) const = 0;
    // TODO: make this QString* digits

    virtual bool appendDigit( Byte* byte, unsigned char digit ) const = 0;
    virtual void removeLastDigit( Byte* byte ) const = 0;
    virtual bool isValidDigit( unsigned char digit ) const = 0;
    virtual bool turnToValue( unsigned char* digit ) const = 0;


  public:
    unsigned int decode( Byte* byte, const QString& text, unsigned int pos = 0 ) const;
};


inline ValueCodec::ValueCodec() {}

}

#endif