зеркало из https://github.com/mozilla/pjs.git
Bug 212919 - Fix const issues in nsDataHashtable on MSVC7 (I'm surprised other
compilers didn't barf already!) r=swalker sr=scc a=asa
This commit is contained in:
bsmedberg%covad.net
Родитель
5135145a58
Коммит
3c425b9ad9
|
|
@ -1,458 +0,0 @@
|
|||
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||||
/* ***** BEGIN LICENSE BLOCK *****
|
||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
||||
*
|
||||
* The contents of this file are subject to the Mozilla Public License Version
|
||||
* 1.1 (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.mozilla.org/MPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
||||
* 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 is C++ hashtable templates.
|
||||
*
|
||||
* The Initial Developer of the Original Code is
|
||||
* Benjamin Smedberg.
|
||||
* Portions created by the Initial Developer are Copyright (C) 2002
|
||||
* the Initial Developer. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
*
|
||||
* Alternatively, the contents of this file may be used under the terms of
|
||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
||||
* of those above. If you wish to allow use of your version of this file only
|
||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
||||
* use your version of this file under the terms of the MPL, indicate your
|
||||
* decision by deleting the provisions above and replace them with the notice
|
||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
||||
* the provisions above, a recipient may use your version of this file under
|
||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
||||
*
|
||||
* ***** END LICENSE BLOCK ***** */
|
||||
|
||||
#ifndef nsBaseHashtable_h__
|
||||
#define nsBaseHashtable_h__
|
||||
|
||||
#include "nsTHashtable.h"
|
||||
#include "prlock.h"
|
||||
#include "nsDebug.h"
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
class nsBaseHashtable; // forward declaration
|
||||
|
||||
/**
|
||||
* the private nsTHashtable::EntryType class used by nsBaseHashtable
|
||||
* @see nsTHashtable for the specification of this class
|
||||
* @see nsBaseHashtable for template parameters
|
||||
*/
|
||||
template<class KeyClass,class DataType>
|
||||
class nsBaseHashtableET : public KeyClass
|
||||
{
|
||||
public:
|
||||
DataType mData;
|
||||
friend class nsTHashtable< nsBaseHashtableET<KeyClass,DataType> >;
|
||||
|
||||
private:
|
||||
typedef typename KeyClass::KeyType KeyType;
|
||||
typedef typename KeyClass::KeyTypePointer KeyTypePointer;
|
||||
|
||||
nsBaseHashtableET(KeyTypePointer aKey);
|
||||
nsBaseHashtableET(const nsBaseHashtableET<KeyClass,DataType>& toCopy);
|
||||
~nsBaseHashtableET();
|
||||
};
|
||||
|
||||
/**
|
||||
* templated hashtable for simple data types
|
||||
* This class manages simple data types that do not need construction or
|
||||
* destruction. Thread-safety is optional, via a flag in Init()
|
||||
*
|
||||
* @param KeyClass a wrapper-class for the hashtable key, see nsHashKeys.h
|
||||
* for a complete specification.
|
||||
* @param DataType the datatype stored in the hashtable,
|
||||
* for example, PRUint32 or nsCOMPtr. If UserDataType is not the same,
|
||||
* DataType must implicitly cast to UserDataType
|
||||
* @param UserDataType the user sees, for example PRUint32 or nsISupports*
|
||||
*/
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
class nsBaseHashtable :
|
||||
protected nsTHashtable< nsBaseHashtableET<KeyClass,DataType> >
|
||||
{
|
||||
public:
|
||||
typedef typename KeyClass::KeyType KeyType;
|
||||
typedef nsBaseHashtableET<KeyClass,DataType> EntryType;
|
||||
|
||||
// default constructor+destructor are fine
|
||||
|
||||
/**
|
||||
* Initialize the object.
|
||||
* @param initSize the initial number of buckets in the hashtable,
|
||||
* default 16
|
||||
* @param threadSafe whether to provide read/write
|
||||
* locking on all class methods
|
||||
* @return PR_TRUE if the object was initialized properly.
|
||||
*/
|
||||
PRBool Init(PRUint32 initSize = PL_DHASH_MIN_SIZE)
|
||||
{ return nsTHashtable<EntryType>::Init(initSize); }
|
||||
|
||||
/**
|
||||
* Check whether the table has been initialized.
|
||||
* This function is especially useful for static hashtables.
|
||||
* @return PR_TRUE if the table has been initialized.
|
||||
*/
|
||||
PRBool IsInitialized() const { return this->mTable.entrySize; }
|
||||
|
||||
/**
|
||||
* Return the number of entries in the table.
|
||||
* @return number of entries
|
||||
*/
|
||||
PRUint32 Count() const
|
||||
{ return nsTHashtable<EntryType>::Count(); }
|
||||
|
||||
/**
|
||||
* retrieve the value for a key.
|
||||
* @param aKey the key to retreive
|
||||
* @param pData data associated with this key will be placed at this
|
||||
* pointer. If you only need to check if the key exists, pData
|
||||
* may be null.
|
||||
* @return PR_TRUE if the key exists. If key does not exist, pData is not
|
||||
* modified.
|
||||
*/
|
||||
PRBool Get(KeyType aKey, UserDataType* pData) const
|
||||
{
|
||||
EntryType* ent = GetEntry(aKey);
|
||||
|
||||
if (!ent)
|
||||
return PR_FALSE;
|
||||
|
||||
if (pData)
|
||||
*pData = ent->mData;
|
||||
|
||||
return PR_TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* put a new value for the associated key
|
||||
* @param aKey the key to put
|
||||
* @param aData the new data
|
||||
* @return always PR_TRUE, unless memory allocation failed
|
||||
*/
|
||||
PRBool Put(KeyType aKey, UserDataType aData)
|
||||
{
|
||||
EntryType* ent = PutEntry(aKey);
|
||||
|
||||
if (!ent)
|
||||
return PR_FALSE;
|
||||
|
||||
ent->mData = aData;
|
||||
|
||||
return PR_TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* remove the data for the associated key
|
||||
* @param aKey the key to remove from the hashtable
|
||||
*/
|
||||
void Remove(KeyType aKey) { RemoveEntry(aKey); }
|
||||
|
||||
/**
|
||||
* function type provided by the application for enumeration.
|
||||
* @param aKey the key being enumerated
|
||||
* @param aData data being enumerated
|
||||
* @parm userArg passed unchanged from Enumerate
|
||||
* @return either
|
||||
* @link PLDHashOperator::PL_DHASH_NEXT PL_DHASH_NEXT @endlink or
|
||||
* @link PLDHashOperator::PL_DHASH_STOP PL_DHASH_STOP @endlink
|
||||
*/
|
||||
typedef PLDHashOperator
|
||||
(*PR_CALLBACK EnumReadFunction)(KeyType aKey,
|
||||
UserDataType aData,
|
||||
void* userArg);
|
||||
|
||||
/**
|
||||
* enumerate entries in the hashtable, without allowing changes
|
||||
* this function read-locks the hashtable, so other threads may read keys
|
||||
* at the same time in multi-thread environments.
|
||||
* @param enumFunc enumeration callback
|
||||
* @param userArg passed unchanged to the EnumReadFunction
|
||||
*/
|
||||
PRUint32 EnumerateRead(EnumReadFunction enumFunc, void* userArg) const
|
||||
{
|
||||
NS_ASSERTION(this->mTable.entrySize,
|
||||
"nsBaseHashtable was not initialized properly.");
|
||||
|
||||
s_EnumReadArgs enumData = { enumFunc, userArg };
|
||||
return PL_DHashTableEnumerate(NS_CONST_CAST(PLDHashTable*, &this->mTable),
|
||||
s_EnumReadStub,
|
||||
&enumData);
|
||||
}
|
||||
|
||||
/**
|
||||
* function type provided by the application for enumeration.
|
||||
* @param aKey the key being enumerated
|
||||
* @param aData Reference to data being enumerated, may be altered. e.g. for
|
||||
* nsInterfaceHashtable this is an nsCOMPtr reference...
|
||||
* @parm userArg passed unchanged from Enumerate
|
||||
* @return bitflag combination of
|
||||
* @link PLDHashOperator::PL_DHASH_REMOVE @endlink,
|
||||
* @link PLDHashOperator::PL_DHASH_NEXT PL_DHASH_NEXT @endlink, or
|
||||
* @link PLDHashOperator::PL_DHASH_STOP PL_DHASH_STOP @endlink
|
||||
*/
|
||||
typedef PLDHashOperator
|
||||
(*PR_CALLBACK EnumFunction)(KeyType aKey,
|
||||
DataType& aData,
|
||||
void* userArg);
|
||||
|
||||
/**
|
||||
* enumerate entries in the hashtable, allowing changes. This
|
||||
* functions write-locks the hashtable.
|
||||
* @param enumFunc enumeration callback
|
||||
* @param userArg passed unchanged to the EnumFunction
|
||||
*/
|
||||
PRUint32 Enumerate(EnumFunction enumFunc, void* userArg)
|
||||
{
|
||||
NS_ASSERTION(this->mTable.entrySize,
|
||||
"nsBaseHashtable was not initialized properly.");
|
||||
|
||||
s_EnumArgs enumData = { enumFunc, userArg };
|
||||
return PL_DHashTableEnumerate(&this->mTable,
|
||||
s_EnumStub,
|
||||
&enumData);
|
||||
}
|
||||
|
||||
/**
|
||||
* reset the hashtable, removing all entries
|
||||
*/
|
||||
void Clear() { nsTHashtable<EntryType>::Clear(); }
|
||||
|
||||
protected:
|
||||
/**
|
||||
* used internally during EnumerateRead. Allocated on the stack.
|
||||
* @param func the enumerator passed to EnumerateRead
|
||||
* @param userArg the userArg passed to EnumerateRead
|
||||
*/
|
||||
struct s_EnumReadArgs
|
||||
{
|
||||
EnumReadFunction func;
|
||||
void* userArg;
|
||||
};
|
||||
|
||||
static PLDHashOperator s_EnumReadStub(PLDHashTable *table,
|
||||
PLDHashEntryHdr *hdr,
|
||||
PRUint32 number,
|
||||
void *arg);
|
||||
|
||||
struct s_EnumArgs
|
||||
{
|
||||
EnumFunction func;
|
||||
void* userArg;
|
||||
};
|
||||
|
||||
static PLDHashOperator s_EnumStub(PLDHashTable *table,
|
||||
PLDHashEntryHdr *hdr,
|
||||
PRUint32 number,
|
||||
void *arg);
|
||||
};
|
||||
|
||||
/**
|
||||
* This class is a thread-safe version of nsBaseHashtable.
|
||||
*/
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
class nsBaseHashtableMT :
|
||||
protected nsBaseHashtable<KeyClass,DataType,UserDataType>
|
||||
{
|
||||
public:
|
||||
typedef typename
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::EntryType EntryType;
|
||||
typedef typename
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::KeyType KeyType;
|
||||
typedef typename
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::EnumFunction EnumFunction;
|
||||
typedef typename
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::EnumReadFunction EnumReadFunction;
|
||||
|
||||
nsBaseHashtableMT() : mLock(nsnull) { }
|
||||
~nsBaseHashtableMT();
|
||||
|
||||
PRBool Init(PRUint32 initSize = PL_DHASH_MIN_SIZE);
|
||||
PRBool IsInitialized() const { return (PRBool) mLock; }
|
||||
PRUint32 Count() const;
|
||||
PRBool Get(KeyType aKey, UserDataType* pData) const;
|
||||
PRBool Put(KeyType aKey, UserDataType aData);
|
||||
void Remove(KeyType aKey);
|
||||
|
||||
PRUint32 EnumerateRead(EnumReadFunction enumFunc, void* userArg) const;
|
||||
PRUint32 Enumerate(EnumFunction enumFunc, void* userArg);
|
||||
void Clear();
|
||||
|
||||
protected:
|
||||
PRLock* mLock;
|
||||
};
|
||||
|
||||
|
||||
//
|
||||
// nsBaseHashtableET definitions
|
||||
//
|
||||
|
||||
template<class KeyClass,class DataType>
|
||||
nsBaseHashtableET<KeyClass,DataType>::nsBaseHashtableET(KeyTypePointer aKey) :
|
||||
KeyClass(aKey)
|
||||
{ }
|
||||
|
||||
template<class KeyClass,class DataType>
|
||||
nsBaseHashtableET<KeyClass,DataType>::nsBaseHashtableET
|
||||
(const nsBaseHashtableET<KeyClass,DataType>& toCopy) :
|
||||
KeyClass(toCopy),
|
||||
mData(toCopy.mData)
|
||||
{ }
|
||||
|
||||
template<class KeyClass,class DataType>
|
||||
nsBaseHashtableET<KeyClass,DataType>::~nsBaseHashtableET()
|
||||
{ }
|
||||
|
||||
|
||||
//
|
||||
// nsBaseHashtable definitions
|
||||
//
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PLDHashOperator
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::s_EnumReadStub
|
||||
(PLDHashTable *table, PLDHashEntryHdr *hdr, PRUint32 number, void* arg)
|
||||
{
|
||||
EntryType* ent = NS_STATIC_CAST(EntryType*, hdr);
|
||||
s_EnumReadArgs* eargs = (s_EnumReadArgs*) arg;
|
||||
|
||||
PLDHashOperator res = (eargs->func)(ent->GetKey(), ent->mData, eargs->userArg);
|
||||
|
||||
NS_ASSERTION( !(res & PL_DHASH_REMOVE ),
|
||||
"PL_DHASH_REMOVE return during const enumeration; ignoring.");
|
||||
|
||||
if (res & PL_DHASH_STOP)
|
||||
return PL_DHASH_STOP;
|
||||
|
||||
return PL_DHASH_NEXT;
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PLDHashOperator
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::s_EnumStub
|
||||
(PLDHashTable *table, PLDHashEntryHdr *hdr, PRUint32 number, void* arg)
|
||||
{
|
||||
EntryType* ent = NS_STATIC_CAST(EntryType*, hdr);
|
||||
s_EnumArgs* eargs = (s_EnumArgs*) arg;
|
||||
|
||||
return (eargs->func)(ent->GetKey(), ent->mData, eargs->userArg);
|
||||
}
|
||||
|
||||
|
||||
//
|
||||
// nsBaseHashtableMT definitions
|
||||
//
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::~nsBaseHashtableMT()
|
||||
{
|
||||
if (this->mLock)
|
||||
PR_DestroyLock(this->mLock);
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PRBool
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Init(PRUint32 initSize)
|
||||
{
|
||||
if (!nsTHashtable<EntryType>::IsInitialized() && !nsTHashtable<EntryType>::Init(initSize))
|
||||
return PR_FALSE;
|
||||
|
||||
this->mLock = PR_NewLock();
|
||||
NS_WARN_IF_FALSE(this->mLock, "Error creating lock during nsBaseHashtableL::Init()");
|
||||
|
||||
return (this->mLock != nsnull);
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PRUint32
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Count() const
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
PRUint32 count = nsTHashtable<EntryType>::Count();
|
||||
PR_Unlock(this->mLock);
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PRBool
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Get(KeyType aKey,
|
||||
UserDataType* pData) const
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
PRBool res =
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::Get(aKey, pData);
|
||||
PR_Unlock(this->mLock);
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PRBool
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Put(KeyType aKey,
|
||||
UserDataType aData)
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
PRBool res =
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::Put(aKey, aData);
|
||||
PR_Unlock(this->mLock);
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
void
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Remove(KeyType aKey)
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::Remove(aKey);
|
||||
PR_Unlock(this->mLock);
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PRUint32
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::EnumerateRead
|
||||
(EnumReadFunction fEnumCall, void* userArg) const
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
PRUint32 count =
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::EnumerateRead(fEnumCall, userArg);
|
||||
PR_Unlock(this->mLock);
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
PRUint32
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Enumerate
|
||||
(EnumFunction fEnumCall, void* userArg)
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
PRUint32 count =
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::Enumerate(fEnumCall, userArg);
|
||||
PR_Unlock(this->mLock);
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
template<class KeyClass,class DataType,class UserDataType>
|
||||
void
|
||||
nsBaseHashtableMT<KeyClass,DataType,UserDataType>::Clear()
|
||||
{
|
||||
PR_Lock(this->mLock);
|
||||
nsBaseHashtable<KeyClass,DataType,UserDataType>::Clear();
|
||||
PR_Unlock(this->mLock);
|
||||
}
|
||||
|
||||
#endif // nsBaseHashtable_h__
|
||||
|
|
@ -1,426 +0,0 @@
|
|||
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||||
/* ***** BEGIN LICENSE BLOCK *****
|
||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
||||
*
|
||||
* The contents of this file are subject to the Mozilla Public License Version
|
||||
* 1.1 (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.mozilla.org/MPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
||||
* 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 is C++ hashtable templates.
|
||||
*
|
||||
* The Initial Developer of the Original Code is
|
||||
* Benjamin Smedberg.
|
||||
* Portions created by the Initial Developer are Copyright (C) 2002
|
||||
* the Initial Developer. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
*
|
||||
* Alternatively, the contents of this file may be used under the terms of
|
||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
||||
* of those above. If you wish to allow use of your version of this file only
|
||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
||||
* use your version of this file under the terms of the MPL, indicate your
|
||||
* decision by deleting the provisions above and replace them with the notice
|
||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
||||
* the provisions above, a recipient may use your version of this file under
|
||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
||||
*
|
||||
* ***** END LICENSE BLOCK ***** */
|
||||
|
||||
#ifndef nsTHashtable_h__
|
||||
#define nsTHashtable_h__
|
||||
|
||||
#include "nscore.h"
|
||||
#include "pldhash.h"
|
||||
#include "nsDebug.h"
|
||||
#include NEW_H
|
||||
|
||||
// helper function for nsTHashtable::Clear()
|
||||
PR_EXTERN(PLDHashOperator) PR_CALLBACK
|
||||
PL_DHashStubEnumRemove(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry,
|
||||
PRUint32 ordinal,
|
||||
void *userArg);
|
||||
|
||||
|
||||
/**
|
||||
* a base class for templated hashtables.
|
||||
*
|
||||
* Clients will rarely need to use this class directly. Check the derived
|
||||
* classes first, to see if they will meet your needs.
|
||||
*
|
||||
* @param EntryType the templated entry-type class that is managed by the
|
||||
* hashtable. <code>EntryType</code> must extend the following declaration,
|
||||
* and <strong>must not declare any virtual functions or derive from classes
|
||||
* with virtual functions.</strong> Any vtable pointer would break the
|
||||
* PLDHashTable code.
|
||||
*<pre> class EntryType : public PLDHashEntryHdr
|
||||
* {
|
||||
* public: or friend nsTHashtable<EntryType>;
|
||||
* // KeyType is what we use when Get()ing or Put()ing this entry
|
||||
* // this should either be a simple datatype (PRUint32, nsISupports*) or
|
||||
* // a const reference (const nsAString&)
|
||||
* typedef something KeyType;
|
||||
* // KeyTypePointer is the pointer-version of KeyType, because pldhash.h
|
||||
* // requires keys to cast to <code>const void*</code>
|
||||
* typedef const something* KeyTypePointer;
|
||||
*
|
||||
* EntryType(KeyTypePointer aKey);
|
||||
*
|
||||
* // the copy constructor must be defined, even if AllowMemMove() == true
|
||||
* // or you will cause link errors!
|
||||
* EntryType(const EntryType& aEnt);
|
||||
*
|
||||
* // the destructor must be defined... or you will cause link errors!
|
||||
* ~EntryType();
|
||||
*
|
||||
* // return the key of this entry
|
||||
* const KeyTypePointer GetKeyPointer() const;
|
||||
*
|
||||
* // KeyEquals(): does this entry match this key?
|
||||
* PRBool KeyEquals(KeyTypePointer aKey) const;
|
||||
*
|
||||
* // KeyToPointer(): Convert KeyType to KeyTypePointer
|
||||
* static KeyTypePointer KeyToPointer(KeyType aKey);
|
||||
*
|
||||
* // HashKey(): calculate the hash number
|
||||
* static PLDHashNumber HashKey(KeyTypePointer aKey);
|
||||
*
|
||||
* // ALLOW_MEMMOVE can we move this class with memmove(), or do we have
|
||||
* // to use the copy constructor?
|
||||
* enum { ALLOW_MEMMOVE = PR_(TRUE or FALSE) };
|
||||
* }</pre>
|
||||
*
|
||||
* @see nsInterfaceHashtable
|
||||
* @see nsDataHashtable
|
||||
* @see nsClassHashtable
|
||||
* @author "Benjamin Smedberg <bsmedberg@covad.net>"
|
||||
*/
|
||||
|
||||
template<class EntryType>
|
||||
class nsTHashtable
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* A dummy constructor; you must call Init() before using this class.
|
||||
*/
|
||||
nsTHashtable();
|
||||
|
||||
/**
|
||||
* destructor, cleans up and deallocates
|
||||
*/
|
||||
~nsTHashtable();
|
||||
|
||||
/**
|
||||
* Initialize the table. This function must be called before any other
|
||||
* class operations. This can fail due to OOM conditions.
|
||||
* @param initSize the initial number of buckets in the hashtable, default 16
|
||||
* @return PR_TRUE if the class was initialized properly.
|
||||
*/
|
||||
PRBool Init(PRUint32 initSize = PL_DHASH_MIN_SIZE);
|
||||
|
||||
/**
|
||||
* Check whether the table has been initialized. This can be useful for static hashtables.
|
||||
* @return the initialization state of the class.
|
||||
*/
|
||||
PRBool IsInitialized() const { return mTable.entrySize; }
|
||||
|
||||
/**
|
||||
* KeyType is typedef'ed for ease of use.
|
||||
*/
|
||||
typedef typename EntryType::KeyType KeyType;
|
||||
|
||||
/**
|
||||
* KeyTypePointer is typedef'ed for ease of use.
|
||||
*/
|
||||
typedef typename EntryType::KeyTypePointer KeyTypePointer;
|
||||
|
||||
/**
|
||||
* Return the number of entries in the table.
|
||||
* @return number of entries
|
||||
*/
|
||||
PRUint32 Count() const { return mTable.entryCount; }
|
||||
|
||||
/**
|
||||
* Get the entry associated with a key.
|
||||
* @param aKey the key to retrieve
|
||||
* @return pointer to the entry class, if the key exists; nsnull if the
|
||||
* key doesn't exist
|
||||
*/
|
||||
EntryType* GetEntry(KeyType aKey) const
|
||||
{
|
||||
NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
|
||||
|
||||
EntryType* entry =
|
||||
NS_REINTERPRET_CAST(EntryType*,
|
||||
PL_DHashTableOperate(
|
||||
NS_CONST_CAST(PLDHashTable*,&mTable),
|
||||
EntryType::KeyToPointer(aKey),
|
||||
PL_DHASH_LOOKUP));
|
||||
return PL_DHASH_ENTRY_IS_BUSY(entry) ? entry : nsnull;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the entry associated with a key, or create a new entry,
|
||||
* @param aKey the key to retrieve
|
||||
* @return pointer to the entry class retreived; nsnull only if memory
|
||||
can't be allocated
|
||||
*/
|
||||
EntryType* PutEntry(KeyType aKey)
|
||||
{
|
||||
NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
|
||||
|
||||
return NS_STATIC_CAST(EntryType*,
|
||||
PL_DHashTableOperate(
|
||||
&mTable,
|
||||
EntryType::KeyToPointer(aKey),
|
||||
PL_DHASH_ADD));
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the entry associated with a key.
|
||||
* @param aKey of the entry to remove
|
||||
*/
|
||||
void RemoveEntry(KeyType aKey)
|
||||
{
|
||||
NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
|
||||
|
||||
PL_DHashTableOperate(&mTable,
|
||||
EntryType::KeyToPointer(aKey),
|
||||
PL_DHASH_REMOVE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the entry associated with a key, but don't resize the hashtable.
|
||||
* This is a low-level method, and is not recommended unless you know what
|
||||
* you're doing and you need the extra performance. This method can be used
|
||||
* during enumeration, while RemoveEntry() cannot.
|
||||
* @param aEntry the entry-pointer to remove (obtained from GetEntry or
|
||||
* the enumerator
|
||||
*/
|
||||
void RawRemoveEntry(EntryType* aEntry)
|
||||
{
|
||||
PL_DHashTableRawRemove(&mTable, aEntry);
|
||||
}
|
||||
|
||||
/**
|
||||
* client must provide an <code>Enumerator</code> function for
|
||||
* EnumerateEntries
|
||||
* @param aEntry the entry being enumerated
|
||||
* @param userArg passed unchanged from <code>EnumerateEntries</code>
|
||||
* @return combination of flags
|
||||
* @link PLDHashOperator::PL_DHASH_NEXT PL_DHASH_NEXT @endlink ,
|
||||
* @link PLDHashOperator::PL_DHASH_STOP PL_DHASH_STOP @endlink ,
|
||||
* @link PLDHashOperator::PL_DHASH_REMOVE PL_DHASH_REMOVE @endlink
|
||||
*/
|
||||
typedef PLDHashOperator (*PR_CALLBACK Enumerator)(EntryType* aEntry, void* userArg);
|
||||
|
||||
/**
|
||||
* Enumerate all the entries of the function.
|
||||
* @param enumFunc the <code>Enumerator</code> function to call
|
||||
* @param userArg a pointer to pass to the
|
||||
* <code>Enumerator</code> function
|
||||
* @return the number of entries actually enumerated
|
||||
*/
|
||||
PRUint32 EnumerateEntries(Enumerator enumFunc, void* userArg)
|
||||
{
|
||||
NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
|
||||
|
||||
s_EnumArgs args = { enumFunc, userArg };
|
||||
return PL_DHashTableEnumerate(&mTable, s_EnumStub, &args);
|
||||
}
|
||||
|
||||
/**
|
||||
* remove all entries, return hashtable to "pristine" state ;)
|
||||
*/
|
||||
void Clear()
|
||||
{
|
||||
NS_ASSERTION(mTable.entrySize, "nsTHashtable was not initialized properly.");
|
||||
|
||||
PL_DHashTableEnumerate(&mTable, PL_DHashStubEnumRemove, nsnull);
|
||||
}
|
||||
|
||||
protected:
|
||||
PLDHashTable mTable;
|
||||
|
||||
static const void* PR_CALLBACK s_GetKey(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry);
|
||||
|
||||
static PLDHashNumber PR_CALLBACK s_HashKey(PLDHashTable *table,
|
||||
const void *key);
|
||||
|
||||
static PRBool PR_CALLBACK s_MatchEntry(PLDHashTable *table,
|
||||
const PLDHashEntryHdr *entry,
|
||||
const void *key);
|
||||
|
||||
static void PR_CALLBACK s_CopyEntry(PLDHashTable *table,
|
||||
const PLDHashEntryHdr *from,
|
||||
PLDHashEntryHdr *to);
|
||||
|
||||
static void PR_CALLBACK s_ClearEntry(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry);
|
||||
|
||||
static PRBool PR_CALLBACK s_InitEntry(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry,
|
||||
const void *key);
|
||||
|
||||
/**
|
||||
* passed internally during enumeration. Allocated on the stack.
|
||||
*
|
||||
* @param userFunc the Enumerator function passed to
|
||||
* EnumerateEntries by the client
|
||||
* @param userArg the userArg passed unaltered
|
||||
*/
|
||||
struct s_EnumArgs
|
||||
{
|
||||
Enumerator userFunc;
|
||||
void* userArg;
|
||||
};
|
||||
|
||||
static PLDHashOperator PR_CALLBACK s_EnumStub(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry,
|
||||
PRUint32 number,
|
||||
void *arg);
|
||||
private:
|
||||
// copy constructor, not implemented
|
||||
nsTHashtable(nsTHashtable<EntryType>& toCopy);
|
||||
|
||||
// assignment operator, not implemented
|
||||
nsTHashtable<EntryType>& operator= (nsTHashtable<EntryType>& toEqual);
|
||||
};
|
||||
|
||||
//
|
||||
// template definitions
|
||||
//
|
||||
|
||||
template<class EntryType>
|
||||
nsTHashtable<EntryType>::nsTHashtable()
|
||||
{
|
||||
// entrySize is our "I'm initialized" indicator
|
||||
mTable.entrySize = 0;
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
nsTHashtable<EntryType>::~nsTHashtable()
|
||||
{
|
||||
if (mTable.entrySize)
|
||||
PL_DHashTableFinish(&mTable);
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
PRBool
|
||||
nsTHashtable<EntryType>::Init(PRUint32 initSize)
|
||||
{
|
||||
if (mTable.entrySize)
|
||||
{
|
||||
NS_ERROR("nsTHashtable::Init() should not be called twice.");
|
||||
return PR_TRUE;
|
||||
}
|
||||
|
||||
static PLDHashTableOps sOps =
|
||||
{
|
||||
::PL_DHashAllocTable,
|
||||
::PL_DHashFreeTable,
|
||||
s_GetKey,
|
||||
s_HashKey,
|
||||
s_MatchEntry,
|
||||
::PL_DHashMoveEntryStub,
|
||||
s_ClearEntry,
|
||||
::PL_DHashFinalizeStub,
|
||||
s_InitEntry
|
||||
};
|
||||
|
||||
if (!EntryType::ALLOW_MEMMOVE)
|
||||
{
|
||||
sOps.moveEntry = s_CopyEntry;
|
||||
}
|
||||
|
||||
if (!PL_DHashTableInit(&mTable, &sOps, nsnull, sizeof(EntryType), initSize))
|
||||
{
|
||||
// if failed, reset "flag"
|
||||
mTable.entrySize = 0;
|
||||
return PR_FALSE;
|
||||
}
|
||||
|
||||
return PR_TRUE;
|
||||
}
|
||||
|
||||
// static definitions
|
||||
|
||||
template<class EntryType>
|
||||
const void*
|
||||
nsTHashtable<EntryType>::s_GetKey(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry)
|
||||
{
|
||||
return ((EntryType*) entry)->GetKeyPointer();
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
PLDHashNumber
|
||||
nsTHashtable<EntryType>::s_HashKey(PLDHashTable *table,
|
||||
const void *key)
|
||||
{
|
||||
return EntryType::HashKey(NS_REINTERPRET_CAST(const KeyTypePointer, key));
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
PRBool
|
||||
nsTHashtable<EntryType>::s_MatchEntry(PLDHashTable *table,
|
||||
const PLDHashEntryHdr *entry,
|
||||
const void *key)
|
||||
{
|
||||
return ((const EntryType*) entry)->KeyEquals(
|
||||
NS_REINTERPRET_CAST(const KeyTypePointer, key));
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
void
|
||||
nsTHashtable<EntryType>::s_CopyEntry(PLDHashTable *table,
|
||||
const PLDHashEntryHdr *from,
|
||||
PLDHashEntryHdr *to)
|
||||
{
|
||||
new(to) EntryType(* NS_REINTERPRET_CAST(const EntryType*,from));
|
||||
|
||||
NS_CONST_CAST(EntryType*,NS_REINTERPRET_CAST(const EntryType*,from))->~EntryType();
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
void
|
||||
nsTHashtable<EntryType>::s_ClearEntry(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry)
|
||||
{
|
||||
NS_REINTERPRET_CAST(EntryType*,entry)->~EntryType();
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
PRBool
|
||||
nsTHashtable<EntryType>::s_InitEntry(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry,
|
||||
const void *key)
|
||||
{
|
||||
new(entry) EntryType(NS_REINTERPRET_CAST(KeyTypePointer,key));
|
||||
return PR_TRUE;
|
||||
}
|
||||
|
||||
template<class EntryType>
|
||||
PLDHashOperator
|
||||
nsTHashtable<EntryType>::s_EnumStub(PLDHashTable *table,
|
||||
PLDHashEntryHdr *entry,
|
||||
PRUint32 number,
|
||||
void *arg)
|
||||
{
|
||||
// dereferences the function-pointer to the user's enumeration function
|
||||
return (* NS_REINTERPRET_CAST(s_EnumArgs*,arg)->userFunc)(
|
||||
NS_REINTERPRET_CAST(EntryType*,entry),
|
||||
NS_REINTERPRET_CAST(s_EnumArgs*,arg)->userArg);
|
||||
}
|
||||
|
||||
#endif // nsTHashtable_h__
|
||||
Загрузка…
Ссылка в новой задаче