2018-11-30 22:52:05 +03:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2012-05-21 15:12:37 +04: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/. */
|
2005-02-25 11:59:10 +03:00
|
|
|
#ifndef nsURIHashKey_h__
|
|
|
|
#define nsURIHashKey_h__
|
2003-07-27 19:20:11 +04:00
|
|
|
|
2015-09-16 06:49:53 +03:00
|
|
|
#include "PLDHashTable.h"
|
2003-07-27 19:20:11 +04:00
|
|
|
#include "nsCOMPtr.h"
|
2005-02-23 00:49:45 +03:00
|
|
|
#include "nsIURI.h"
|
2012-03-13 02:53:18 +04:00
|
|
|
#include "nsHashKeys.h"
|
Bug 1415980 - make hash keys movable and not copyable; r=erahm
Everything that goes in a PLDHashtable (and its derivatives, like
nsTHashtable) needs to inherit from PLDHashEntryHdr. But through a lack
of enforcement, copy constructors for these derived classes didn't
explicitly invoke the copy constructor for PLDHashEntryHdr (and the
compiler didn't invoke the copy constructor for us). Instead,
PLDHashTable explicitly copied around the bits that the copy constructor
would have.
The current setup has two problems:
1) Derived classes should be using move construction, not copy
construction, since anything that's shuffling hash table keys/entries
around will be using move construction.
2) Derived classes should take responsibility for transferring bits of
superclass state around, and not rely on something else to handle that.
The second point is not a huge problem for PLDHashTable (PLDHashTable
only has to copy PLDHashEntryHdr's bits in a single place), but future
hash table implementations that might move entries around more
aggressively would have to insert compensation code all over the
place. Additionally, if moving entries is implemented via memcpy (which
is quite common), PLDHashTable copying around bits *again* is
inefficient.
Let's fix all these problems in one go, by:
1) Explicitly declaring the set of constructors that PLDHashEntryHdr
implements (and does not implement). In particular, the copy
constructor is deleted, so any derived classes that attempt to make
themselves copyable will be detected at compile time: the compiler
will complain that the superclass type is not copyable.
This change on its own will result in many compiler errors, so...
2) Change any derived classes to implement move constructors instead of
copy constructors. Note that some of these move constructors are,
strictly speaking, unnecessary, since the relevant classes are moved
via memcpy in nsTHashtable and its derivatives.
2018-09-20 18:20:36 +03:00
|
|
|
#include "mozilla/Move.h"
|
2016-08-26 09:40:57 +03:00
|
|
|
#include "mozilla/Unused.h"
|
2003-07-27 19:20:11 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Hashtable key class to use with nsTHashtable/nsBaseHashtable
|
|
|
|
*/
|
|
|
|
class nsURIHashKey : public PLDHashEntryHdr {
|
|
|
|
public:
|
|
|
|
typedef nsIURI* KeyType;
|
|
|
|
typedef const nsIURI* KeyTypePointer;
|
|
|
|
|
2007-07-08 11:08:04 +04:00
|
|
|
explicit nsURIHashKey(const nsIURI* aKey) : mKey(const_cast<nsIURI*>(aKey)) {
|
|
|
|
MOZ_COUNT_CTOR(nsURIHashKey);
|
|
|
|
}
|
Bug 1415980 - make hash keys movable and not copyable; r=erahm
Everything that goes in a PLDHashtable (and its derivatives, like
nsTHashtable) needs to inherit from PLDHashEntryHdr. But through a lack
of enforcement, copy constructors for these derived classes didn't
explicitly invoke the copy constructor for PLDHashEntryHdr (and the
compiler didn't invoke the copy constructor for us). Instead,
PLDHashTable explicitly copied around the bits that the copy constructor
would have.
The current setup has two problems:
1) Derived classes should be using move construction, not copy
construction, since anything that's shuffling hash table keys/entries
around will be using move construction.
2) Derived classes should take responsibility for transferring bits of
superclass state around, and not rely on something else to handle that.
The second point is not a huge problem for PLDHashTable (PLDHashTable
only has to copy PLDHashEntryHdr's bits in a single place), but future
hash table implementations that might move entries around more
aggressively would have to insert compensation code all over the
place. Additionally, if moving entries is implemented via memcpy (which
is quite common), PLDHashTable copying around bits *again* is
inefficient.
Let's fix all these problems in one go, by:
1) Explicitly declaring the set of constructors that PLDHashEntryHdr
implements (and does not implement). In particular, the copy
constructor is deleted, so any derived classes that attempt to make
themselves copyable will be detected at compile time: the compiler
will complain that the superclass type is not copyable.
This change on its own will result in many compiler errors, so...
2) Change any derived classes to implement move constructors instead of
copy constructors. Note that some of these move constructors are,
strictly speaking, unnecessary, since the relevant classes are moved
via memcpy in nsTHashtable and its derivatives.
2018-09-20 18:20:36 +03:00
|
|
|
nsURIHashKey(nsURIHashKey&& toMove)
|
|
|
|
: PLDHashEntryHdr(std::move(toMove)), mKey(std::move(toMove.mKey)) {
|
|
|
|
MOZ_COUNT_CTOR(nsURIHashKey);
|
|
|
|
}
|
2003-07-27 19:20:11 +04:00
|
|
|
~nsURIHashKey() { MOZ_COUNT_DTOR(nsURIHashKey); }
|
|
|
|
|
|
|
|
nsIURI* GetKey() const { return mKey; }
|
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool KeyEquals(const nsIURI* aKey) const {
|
|
|
|
bool eq;
|
2016-04-19 16:46:34 +03:00
|
|
|
if (!mKey) {
|
|
|
|
return !aKey;
|
|
|
|
}
|
2007-07-08 11:08:04 +04:00
|
|
|
if (NS_SUCCEEDED(mKey->Equals(const_cast<nsIURI*>(aKey), &eq))) {
|
2003-07-27 19:20:11 +04:00
|
|
|
return eq;
|
|
|
|
}
|
2011-10-17 18:59:28 +04:00
|
|
|
return false;
|
2018-11-30 13:46:48 +03:00
|
|
|
}
|
2003-07-27 19:20:11 +04:00
|
|
|
|
|
|
|
static const nsIURI* KeyToPointer(nsIURI* aKey) { return aKey; }
|
|
|
|
static PLDHashNumber HashKey(const nsIURI* aKey) {
|
2016-04-19 16:46:34 +03:00
|
|
|
if (!aKey) {
|
|
|
|
// If the key is null, return hash for empty string.
|
|
|
|
return mozilla::HashString(EmptyCString());
|
2003-07-27 19:20:11 +04:00
|
|
|
}
|
2012-09-02 06:35:17 +04:00
|
|
|
nsAutoCString spec;
|
2016-08-26 09:40:57 +03:00
|
|
|
// If GetSpec() fails, ignoring the failure and proceeding with an
|
|
|
|
// empty |spec| seems like the best thing to do.
|
|
|
|
mozilla::Unused << const_cast<nsIURI*>(aKey)->GetSpec(spec);
|
2012-03-13 02:53:18 +04:00
|
|
|
return mozilla::HashString(spec);
|
2018-11-30 13:46:48 +03:00
|
|
|
}
|
2016-04-19 16:46:34 +03:00
|
|
|
|
2011-10-17 18:59:28 +04:00
|
|
|
enum { ALLOW_MEMMOVE = true };
|
2003-07-27 19:20:11 +04:00
|
|
|
|
2007-05-01 23:26:15 +04:00
|
|
|
protected:
|
2003-07-27 19:20:11 +04:00
|
|
|
nsCOMPtr<nsIURI> mKey;
|
|
|
|
};
|
2005-02-25 11:59:10 +03:00
|
|
|
|
|
|
|
#endif // nsURIHashKey_h__
|