//---------------------------------------------------------------------------
//	Greenplum Database
//	Copyright (C) 2008 Greenplum, Inc.
//
//	@filename:
//		CSyncHashtableTest.h
//
//	@doc:
//      Test for CSyncHashtable
//---------------------------------------------------------------------------
#ifndef GPOS_CSyncHashtableTest_H
#define GPOS_CSyncHashtableTest_H

#include "gpos/base.h"
#include "gpos/common/CList.h"
#include "gpos/common/CSyncHashtable.h"
#include "gpos/common/CSyncHashtableAccessByKey.h"
#include "gpos/common/CSyncHashtableIter.h"



namespace gpos
{
//---------------------------------------------------------------------------
//	@class:
//		CSyncHashtableTest
//
//	@doc:
//		Wrapper class to avoid compiler confusion about template parameters
//		Contains also unittests for accessor class
//
//---------------------------------------------------------------------------
class CSyncHashtableTest
{
	// prototypes
	struct SElem;

private:
	// types used by testing functions
	using SElemHashtable = CSyncHashtable<SElem, ULONG>;

	using SElemHashtableAccessor = CSyncHashtableAccessByKey<SElem, ULONG>;

	using SElemHashtableIter = CSyncHashtableIter<SElem, ULONG>;

	using SElemHashtableIterAccessor = CSyncHashtableAccessByIter<SElem, ULONG>;

	// function pointer to a hash table task
	using pfuncHashtableTask = void *(*) (void *);

	//---------------------------------------------------------------------------
	//	@class:
	//		SElem
	//
	//	@doc:
	//		Local class for hashtable tests;
	//
	//---------------------------------------------------------------------------
	struct SElem
	{
	private:
		// element's unique id
		ULONG m_id;

	public:
		// generic link
		SLink m_link;

		// hash key
		ULONG m_ulKey;

		// invalid key
		static const ULONG m_ulInvalid;

		// invalid element
		static const SElem m_elemInvalid;

		// simple hash function
		static ULONG
		HashValue(const ULONG &ul)
		{
			return ul;
		}

		static ULONG
		HashValue(const SElem &elem)
		{
			return elem.m_id;
		}

		// equality for object-based comparison
		BOOL
		operator==(const SElem &elem) const
		{
			return elem.m_id == m_id;
		}

		// key equality function for hashtable
		static BOOL
		FEqualKeys(const ULONG &ulkey, const ULONG &ulkeyOther)
		{
			return ulkey == ulkeyOther;
		}

		// element equality function for hashtable
		static BOOL
		Equals(const SElem &elem, const SElem &elemOther)
		{
			return elem == elemOther;
		}

		// ctor
		SElem(ULONG id, ULONG ulKey) : m_id(id), m_ulKey(ulKey)
		{
		}

		// copy ctor
		SElem(const SElem &elem)
		{
			m_id = elem.m_id;
			m_ulKey = elem.m_ulKey;
		}

		SElem &operator=(const SElem &) = default;

		static BOOL
		IsValid(const ULONG &ulKey)
		{
			return !FEqualKeys(m_ulInvalid, ulKey);
		}

		// dummy ctor
		SElem() = default;

		// Id accessor
		ULONG
		Id() const
		{
			return m_id;
		}

	};	// struct SElem

public:
	// actual unittests
	static GPOS_RESULT EresUnittest();
	static GPOS_RESULT EresUnittest_Basics();
	static GPOS_RESULT EresUnittest_Accessor();
	static GPOS_RESULT EresUnittest_ComplexEquality();
	static GPOS_RESULT EresUnittest_SameKeyIteration();
	static GPOS_RESULT EresUnittest_NonConcurrentIteration();
};
}  // namespace gpos

#endif	// !GPOS_CSyncHashtableTest_H

// EOF