/*
 *	PROGRAM:	Client/Server Common Code
 *	MODULE:		ClumpletReader.h
 *	DESCRIPTION:	Secure handling of clumplet buffers
 *
 *  The contents of this file are subject to the Initial
 *  Developer's Public License Version 1.0 (the "License");
 *  you may not use this file except in compliance with the
 *  License. You may obtain a copy of the License at
 *  http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_idpl.
 *
 *  Software distributed under the License is distributed AS IS,
 *  WITHOUT WARRANTY OF ANY KIND, either express or implied.
 *  See the License for the specific language governing rights
 *  and limitations under the License.
 *
 *  The Original Code was created by Nickolay Samofatov
 *  for the Firebird Open Source RDBMS project.
 *
 *  Copyright (c) 2004 Nickolay Samofatov <nickolay@broadviewsoftware.com>
 *  and all contributors signed below.
 *
 *  All Rights Reserved.
 *  Contributor(s): ______________________________________.
 *
 *
 *  $Id: ClumpletReader.h,v 1.3 2004-11-03 08:38:09 skidder Exp $
 *
 */

#ifndef CLUMPLETREADER_H
#define CLUMPLETREADER_H

#include "../common/classes/alloc.h"
#include "../common/classes/array.h"
#include "fb_string.h"

namespace Firebird {

// This class provides read access for clumplet structure
// Note: it doesn't make a copy of buffer it reads
class ClumpletReader : protected AutoStorage {
public:
	ClumpletReader(bool isTagged, const UCHAR* buffer, size_t buffLen);

	// Navigation in clumplet buffer
	bool isEof() { return cur_offset >= getBufferLength(); }
	void moveNext();

    // Methods which work with currently selected clumplet
	UCHAR getClumpTag();
	size_t getClumpLength();

	SLONG getInt();
	SINT64 getBigInt();
	string& getString(string& str);
	const UCHAR* getBytes() { return getBuffer() + cur_offset + 2; }

	// Return the tag for buffer (usually structure version)
	UCHAR getBufferTag();
	size_t getBufferLength() { return getBufferEnd() - getBuffer(); }
	size_t getCurOffset() { return cur_offset; }
	void setCurOffset(size_t newOffset) { cur_offset = newOffset; }
protected:
	size_t cur_offset;
	bool mIsTagged;

	// Methods are virtual so writer can override 'em
	virtual UCHAR* getBuffer() { return const_cast<UCHAR*>(static_buffer); }
	virtual UCHAR* getBufferEnd() { return const_cast<UCHAR*>(static_buffer_end); }

	// These functions are called when error condition is detected by this class. 
	// They may throw exceptions. If they don't reader tries to do something
	// sensible, certainly not overwrite memory or read past the end of buffer

	// This appears to be a programming error in buffer access pattern
	virtual void usage_mistake(const char* what);

	// This is called when passed buffer appears invalid
	virtual void invalid_structure();
private:
	// Assignment and copy constructor not implemented.
	ClumpletReader(const ClumpletReader& from);
	ClumpletReader& operator=(const ClumpletReader& from);

	const UCHAR* static_buffer;
	const UCHAR* static_buffer_end;
};

} // namespace Firebird

#endif