15460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao//===- HashEntry.h ---------------------------------------------------------===// 25460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 35460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// The MCLinker Project 45460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 55460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// This file is distributed under the University of Illinois Open Source 65460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// License. See LICENSE.TXT for details. 75460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 85460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao//===----------------------------------------------------------------------===// 95460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 105460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#ifndef MCLD_HASH_ENTRY_H 115460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#define MCLD_HASH_ENTRY_H 125460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#ifdef ENABLE_UNITTEST 135460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <gtest.h> 145460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#endif 155460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 165460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaonamespace mcld { 175460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 185460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao/** forward declaration **/ 195460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotemplate<typename HashEntryTy> 205460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoclass EntryFactory; 215460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 225460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao/** \class HashEntry 235460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * \brief HashEntry is the item in the bucket of hash table. 245460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * 255460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * mcld::HashEntry illustrates the demand from mcld::HashTable. 265460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * Since HashTable can change the definition of the HashEntry by changing 275460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * the template argument. class mcld::HashEntry here is used to show the 285460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * basic interfaces that HashTable requests. You can define your own entry 295460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * of the hash table which has no relation to mcld::HashEntry 305460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * 315460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * Since mcld::HashEntry here is a special class whose size is changing, 325460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * derive a new class from it is risky. Make sure you understand what you 335460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * are doing when you let a new class inherit from mcld::HashEntry. 345460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao */ 355460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotemplate <typename KeyType, typename ValueType, typename KeyCompare> 365460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoclass HashEntry 375460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao{ 385460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 395460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef KeyType key_type; 405460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef ValueType value_type; 415460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef KeyCompare key_compare; 425460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 435460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoprivate: 445460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef HashEntry<KeyType, ValueType, KeyCompare> Self; 455460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao friend class EntryFactory<Self>; 465460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 475460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoprivate: 485460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao HashEntry(const KeyType& pKey); 495460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ~HashEntry(); 505460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 515460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 525460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao KeyType& key() 535460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_Key; } 545460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 555460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao const KeyType& key() const 565460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_Key; } 575460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 585460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ValueType& value() 595460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_Value; } 605460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 615460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao const ValueType& value() const 625460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_Value; } 635460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 645460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao void setValue(const ValueType& pValue) 655460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { m_Value = pValue; } 665460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 675460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao bool compare(const key_type& pKey); 685460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 695460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 705460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao KeyType m_Key; 715460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ValueType m_Value; 725460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao}; 735460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 745460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaotemplate <typename HashEntryTy> 755460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoclass EntryFactory 765460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao{ 775460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 785460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef HashEntryTy entry_type; 795460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef typename HashEntryTy::key_type key_type; 805460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef typename HashEntryTy::value_type value_type; 815460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 825460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 835460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao EntryFactory(); 845460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ~EntryFactory(); 855460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 865460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao HashEntryTy* produce(const key_type& pKey); 875460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao void destroy(HashEntryTy* pEntry); 885460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao}; 895460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 905460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include "HashEntry.tcc" 915460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 925460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao} // namespace of mcld 935460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 945460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#endif 95affc150dc44fab1911775a49636d0ce85333b634Zonr Chang 96