gecko/xpcom/glue/nsRefPtrHashtable.h

164 lines
4.0 KiB
C
Raw Normal View History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2012-05-21 04:12:37 -07:00
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsRefPtrHashtable_h__
#define nsRefPtrHashtable_h__
#include "nsBaseHashtable.h"
#include "nsHashKeys.h"
#include "nsAutoPtr.h"
/**
* templated hashtable class maps keys to reference pointers.
* See nsBaseHashtable for complete declaration.
* @param KeyClass a wrapper-class for the hashtable key, see nsHashKeys.h
* for a complete specification.
* @param RefPtr the reference-type being wrapped
* @see nsDataHashtable, nsClassHashtable
*/
template<class KeyClass, class RefPtr>
class nsRefPtrHashtable :
public nsBaseHashtable< KeyClass, nsRefPtr<RefPtr> , RefPtr* >
{
public:
typedef typename KeyClass::KeyType KeyType;
typedef RefPtr* UserDataType;
typedef nsBaseHashtable< KeyClass, nsRefPtr<RefPtr> , RefPtr* > base_type;
/**
* @copydoc nsBaseHashtable::Get
* @param pData This is an XPCOM getter, so pData is already_addrefed.
* If the key doesn't exist, pData will be set to nullptr.
*/
bool Get(KeyType aKey, UserDataType* pData) const;
/**
* Gets a weak reference to the hashtable entry.
* @param aFound If not nullptr, will be set to true if the entry is found,
* to false otherwise.
* @return The entry, or nullptr if not found. Do not release this pointer!
*/
RefPtr* GetWeak(KeyType aKey, bool* aFound = nullptr) const;
};
/**
* Thread-safe version of nsRefPtrHashtable
* @param KeyClass a wrapper-class for the hashtable key, see nsHashKeys.h
* for a complete specification.
* @param RefPtr the reference-type being wrapped
*/
template<class KeyClass, class RefPtr>
class nsRefPtrHashtableMT :
public nsBaseHashtableMT< KeyClass, nsRefPtr<RefPtr> , RefPtr* >
{
public:
typedef typename KeyClass::KeyType KeyType;
typedef RefPtr* UserDataType;
typedef nsBaseHashtableMT< KeyClass, nsRefPtr<RefPtr> , RefPtr* > base_type;
/**
* @copydoc nsBaseHashtable::Get
* @param pData This is an XPCOM getter, so pData is already_addrefed.
* If the key doesn't exist, pData will be set to nullptr.
*/
bool Get(KeyType aKey, UserDataType* pData) const;
// GetWeak does not make sense on a multi-threaded hashtable, where another
// thread may remove the entry (and hence release it) as soon as GetWeak
// returns
};
//
// nsRefPtrHashtable definitions
//
template<class KeyClass, class RefPtr>
bool
nsRefPtrHashtable<KeyClass,RefPtr>::Get
(KeyType aKey, UserDataType* pRefPtr) const
{
typename base_type::EntryType* ent = this->GetEntry(aKey);
if (ent)
{
if (pRefPtr)
{
*pRefPtr = ent->mData;
NS_IF_ADDREF(*pRefPtr);
}
return true;
}
// if the key doesn't exist, set *pRefPtr to null
// so that it is a valid XPCOM getter
if (pRefPtr)
*pRefPtr = nullptr;
return false;
}
template<class KeyClass, class RefPtr>
RefPtr*
nsRefPtrHashtable<KeyClass,RefPtr>::GetWeak
(KeyType aKey, bool* aFound) const
{
typename base_type::EntryType* ent = this->GetEntry(aKey);
if (ent)
{
if (aFound)
*aFound = true;
return ent->mData;
}
// Key does not exist, return nullptr and set aFound to false
if (aFound)
*aFound = false;
return nullptr;
}
//
// nsRefPtrHashtableMT definitions
//
template<class KeyClass, class RefPtr>
bool
nsRefPtrHashtableMT<KeyClass,RefPtr>::Get
(KeyType aKey, UserDataType* pRefPtr) const
{
PR_Lock(this->mLock);
typename base_type::EntryType* ent = this->GetEntry(aKey);
if (ent)
{
if (pRefPtr)
{
*pRefPtr = ent->mData;
NS_IF_ADDREF(*pRefPtr);
}
PR_Unlock(this->mLock);
return true;
}
// if the key doesn't exist, set *pRefPtr to null
// so that it is a valid XPCOM getter
if (pRefPtr)
*pRefPtr = nullptr;
PR_Unlock(this->mLock);
return false;
}
#endif // nsRefPtrHashtable_h__