/*
* Copyright (C) 2005-2007 by Daniel Wagner
*
* This file is part of FFADO
* FFADO = Free Firewire (pro-)audio drivers for linux
*
* FFADO is based upon FreeBoB
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*
*/
#ifndef UTIL_CMD_SERIALIZE_H
#define UTIL_CMD_SERIALIZE_H
#include "debugmodule/debugmodule.h"
#include // byte_t and quadlet_t declaration
#include
namespace Util {
// Interfaces
class IOSSerialize {
public:
IOSSerialize() {}
virtual ~IOSSerialize() {}
virtual bool write( byte_t value, const char* name = "" ) = 0;
virtual bool write( uint16_t value, const char* name = "" ) = 0;
virtual bool write( quadlet_t value, const char* name = "" ) = 0;
virtual bool write( const char *values, size_t len, const char* name = "" ) = 0;
};
class IISDeserialize {
public:
IISDeserialize() {}
virtual ~IISDeserialize() {}
virtual bool read( byte_t* value ) = 0;
virtual bool read( uint16_t* value ) = 0;
virtual bool read( quadlet_t* value ) = 0;
// note that the value pointer is not valid outside deserialize()
virtual bool read( char** value, size_t length ) = 0;
virtual bool peek( byte_t* value ) = 0;
virtual bool peek( uint16_t* value, size_t offset )=0;
virtual bool skip( size_t length ) = 0;
virtual int getNrOfConsumedBytes() const = 0;
};
// Specialized implementations of previously defined interfaces
class CoutSerializer: public IOSSerialize {
public:
CoutSerializer()
: IOSSerialize()
, m_cnt( 0 )
{}
virtual ~CoutSerializer() {}
virtual bool write( byte_t value, const char* name = "" );
virtual bool write( uint16_t value, const char* name = "" );
virtual bool write( quadlet_t value, const char* name = "" );
virtual bool write( const char *values, size_t len, const char* name = "" );
private:
unsigned int m_cnt;
DECLARE_DEBUG_MODULE;
};
class StringSerializer: public IOSSerialize {
public:
StringSerializer()
: IOSSerialize()
, m_cnt( 0 )
{}
virtual ~StringSerializer() {}
virtual bool write( byte_t value, const char* name = "" );
virtual bool write( uint16_t value, const char* name = "" );
virtual bool write( quadlet_t value, const char* name = "" );
virtual bool write( const char *values, size_t len, const char* name = "" );
virtual std::string getString( ) { return m_string;};
private:
unsigned int m_cnt;
std::string m_string;
DECLARE_DEBUG_MODULE;
};
class BufferSerialize: public IOSSerialize {
public:
BufferSerialize( unsigned char* buffer, size_t length )
: IOSSerialize()
, m_buffer( buffer )
, m_curPos( m_buffer )
, m_length( length )
{}
virtual ~BufferSerialize() {}
virtual bool write( byte_t value, const char* name = "" );
virtual bool write( uint16_t value, const char* name = "" );
virtual bool write( quadlet_t value, const char* name = "" );
virtual bool write( const char *values, size_t len, const char* name = "" );
int getNrOfProducesBytes() const
{ return m_curPos - m_buffer; }
protected:
inline bool isCurPosValid() const;
private:
unsigned char* m_buffer;
unsigned char* m_curPos;
size_t m_length;
DECLARE_DEBUG_MODULE;
};
class BufferDeserialize: public IISDeserialize {
public:
BufferDeserialize( const unsigned char* buffer, size_t length )
: IISDeserialize()
, m_buffer( const_cast( buffer ) )
, m_curPos( m_buffer )
, m_length( length )
{}
virtual ~BufferDeserialize() {}
virtual bool read( byte_t* value );
virtual bool read( uint16_t* value );
virtual bool read( quadlet_t* value );
// note that the value pointer is not valid outside deserialize()
virtual bool read( char** value, size_t length );
virtual bool peek( byte_t* value );
virtual bool peek( uint16_t* value, size_t offset );
virtual bool skip( size_t length );
int getNrOfConsumedBytes() const
{ return m_curPos - m_buffer; }
protected:
inline bool isCurPosValid() const;
private:
unsigned char* m_buffer; // start of the buffer
unsigned char* m_curPos; // current read pos
size_t m_length; // size of buffer
DECLARE_DEBUG_MODULE;
};
}
#endif // UTIL_CMD_SERIALIZE_H