Paul Holmes-Higgin 4e2300f095 Updated copyright
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5186 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2007-02-19 17:17:36 +00:00

159 lines
4.3 KiB
C++

/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
#ifndef _DataBuffer_H
#define _DataBuffer_H
// Includes
#include "util\DataPacker.h"
// Classes defined in this header file
namespace Alfresco {
class DataBuffer;
typedef std::auto_ptr<DataBuffer> PTR_DataBuffer;
}
// Constants
namespace Alfresco {
// Default data buffer size
#define DataBufferDefaultSize 256
}
/**
* Data Buffer Class
*
* Dynamic buffer for getting/setting data blocks.
*/
class Alfresco::DataBuffer {
public:
// Class constructors
DataBuffer( unsigned int siz = DataBufferDefaultSize);
DataBuffer( BUFPTR buf, BUFPOS off, BUFLEN len);
// Class destructor
~DataBuffer();
// Getter methods
inline BUFPTR getBuffer( void) { return m_buf; }
BUFLEN getLength( void) const;
unsigned int getLengthInWords( void) const;
BUFLEN getAvailableLength( void) const;
inline BUFLEN getBufferLength(void) const { return m_buflen; }
inline unsigned int getDisplacement( void) const { return m_pos - m_offset; }
inline BUFPOS getOffset( void) { return m_offset; }
inline BUFPOS getPosition( void) { return m_pos; }
// Get data items from the buffer
unsigned char getByte( void);
unsigned int getShort( void);
unsigned int getInt( void);
LONG64 getLong( void);
String getString( bool uni = true);
String getString( unsigned int maxLen, bool uni = true);
unsigned int getShortAt( unsigned int idx);
unsigned int getIntAt( unsigned int idx);
LONG64 getLongAt( unsigned int idx);
// Put data items into the buffer
void putByte( unsigned char byt);
void putShort( unsigned int sval);
void putInt( unsigned int ival);
void putLong( LONG64 lval);
void putShortAt( unsigned int idx, unsigned int sval);
void putIntAt( unsigned int idx, unsigned int ival);
void putLongAt( unsigned int idx, LONG64 lval);
void putString( const String& str, bool uni = true, bool nulTerm = true);
void putFixedString( const String& str, unsigned int len);
BUFPOS putStringAt( const String& str, BUFPOS pos, bool uni = true, bool nulTerm = true);
BUFPOS putFixedStringAt( const String& str, unsigned int len, BUFPOS pos);
void putStringPointer( unsigned int off);
void putZeros( unsigned int cnt);
// Align the buffer position
void wordAlign( void);
void longwordAlign( void);
// Append a raw data block to the buffer
void appendData( BUFPTR buf, BUFPOS off, BUFLEN len);
// Copy the data to the user buffer and update the read position
unsigned int copyData( BUFPTR buf, BUFPOS pos, unsigned int cnt);
// Skip data items in the buffer
void skipBytes( unsigned int len);
// Setter methods
inline void setPosition( BUFPOS pos) { m_pos = pos; }
void setEndOfBuffer( void);
void setLength( BUFLEN len);
private:
// Extend the buffer
void extendBuffer( BUFLEN ext);
void extendBuffer( void);
protected:
// Instance variables
//
// Data buffer
BUFPTR m_buf;
unsigned int m_buflen;
// Flag to indicate if the buffer is owned by this object
bool m_owner;
// Buffer positions/offsets
BUFPOS m_pos;
BUFPOS m_endpos;
BUFPOS m_offset;
};
#endif