/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef _TOOLS_TABLE_HXX
#define _TOOLS_TABLE_HXX

#include "tools/toolsdllapi.h"
#include <tools/solar.h>
#include <tools/contnr.hxx>

// ---------
// - Table -
// ---------

#define TABLE_ENTRY_NOTFOUND   CONTAINER_ENTRY_NOTFOUND

class TOOLS_DLLPUBLIC Table : private Container
{
private:
	sal_uIntPtr	nCount;
//#if 0 // _SOLAR__PRIVATE
	TOOLS_DLLPRIVATE sal_uIntPtr	ImplGetIndex( sal_uIntPtr nKey, sal_uIntPtr* pIndex = NULL ) const;
//#endif
public:
			Table( sal_uInt16 nInitSize = 16, sal_uInt16 nReSize = 16 );
			Table( const Table& rTable ) : Container( rTable )
				{ nCount = rTable.nCount; }

	sal_Bool	Insert( sal_uIntPtr nKey, void* p );
	void*	Remove( sal_uIntPtr nKey );
	void*	Replace( sal_uIntPtr nKey, void* p );
	void*	Get( sal_uIntPtr nKey ) const;

	void	Clear() { Container::Clear(); nCount = 0; }
	sal_uIntPtr	Count() const { return( nCount ); }

	void*	GetCurObject() const;
	sal_uIntPtr	GetCurKey() const { return (sal_uIntPtr)Container::GetCurObject(); }
	sal_uIntPtr	GetKey( const void* p ) const;
	sal_Bool	IsKeyValid( sal_uIntPtr nKey ) const;

	void*	GetObject( sal_uIntPtr nPos ) const
				{ return Container::GetObject( (nPos*2)+1 ); }
	sal_uIntPtr	GetObjectKey( sal_uIntPtr nPos ) const
				{ return (sal_uIntPtr)Container::GetObject( nPos*2 ); }
	sal_uIntPtr	GetUniqueKey( sal_uIntPtr nStartKey = 1 ) const;
	sal_uIntPtr	SearchKey( sal_uIntPtr nKey, sal_uIntPtr* pPos = NULL ) const;

	void*	Seek( sal_uIntPtr nKey );
	void*	Seek( void* p );
	void*	First();
	void*	Last();
	void*	Next();
	void*	Prev();

	Table&	operator =( const Table& rTable );

	sal_Bool	operator ==( const Table& rTable ) const
				{ return Container::operator ==( rTable ); }
	sal_Bool	operator !=( const Table& rTable ) const
				{ return Container::operator !=( rTable ); }
};

inline Table& Table::operator =( const Table& r )
{
	Container::operator =( r );
	nCount = r.nCount;
	return *this;
}

// -----------------
// - DECLARE_TABLE -
// -----------------

#define DECLARE_TABLE( ClassName, Type )								\
class ClassName : private Table 										\
{																		\
public: 																\
				using Table::Clear;										\
				using Table::Count;	    								\
				using Table::GetCurKey;									\
				using Table::GetObjectKey;								\
				using Table::GetUniqueKey;								\
				using Table::SearchKey;									\
				using Table::IsKeyValid;								\
																		\
				ClassName( sal_uInt16 _nInitSize = 16,						\
						   sal_uInt16 _nReSize = 16 ) : 					\
					Table( _nInitSize, _nReSize ) {}					\
				ClassName( const ClassName& rClassName ) :				\
					Table( rClassName ) {}								\
																		\
	sal_Bool		Insert( sal_uIntPtr nKey, Type p )							\
					{ return Table::Insert( nKey, (void*)p ); } 		\
	Type		Remove( sal_uIntPtr nKey )									\
					{ return (Type)Table::Remove( nKey ); } 			\
	Type		Replace( sal_uIntPtr nKey, Type p )							\
					{ return (Type)Table::Replace( nKey, (void*)p ); }	\
	Type		Get( sal_uIntPtr nKey ) const 								\
					{ return (Type)Table::Get( nKey ); }				\
																		\
	Type		GetCurObject() const									\
					{ return (Type)Table::GetCurObject(); } 			\
	sal_uIntPtr		GetKey( const Type p ) const							\
					{ return Table::GetKey( (const void*)p ); } 		\
																		\
	Type		GetObject( sal_uIntPtr nPos ) const							\
					{ return (Type)Table::GetObject( nPos ); }			\
																		\
	Type		Seek( sal_uIntPtr nKey )										\
					{ return (Type)Table::Seek( nKey ); }				\
	Type		Seek( Type p )											\
					{ return (Type)Table::Seek( (void*)p ); }			\
	Type		First() { return (Type)Table::First(); }				\
	Type		Last()	{ return (Type)Table::Last(); } 				\
	Type		Next()	{ return (Type)Table::Next(); } 				\
	Type		Prev()	{ return (Type)Table::Prev(); } 				\
																		\
	ClassName&	operator =( const ClassName& rClassName )				\
					{ Table::operator =( rClassName );					\
					  return *this; }									\
																		\
	sal_Bool		operator ==( const ClassName& rTable ) const			\
					{ return Table::operator ==( rTable ); }			\
	sal_Bool		operator !=( const ClassName& rTable ) const			\
					{ return Table::operator !=( rTable ); }			\
};

#endif // _TOOLS_TABLE_HXX