netwerk/base/public/nsURIHashKey.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Hashtable Keys.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Benjamin Smedberg <bsmedberg@covad.net>
  19  *
  20  * Portions created by the Initial Developer are Copyright (C) 2003
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38 #ifndef nsURIHashKey_h__
  39 #define nsURIHashKey_h__
  40
  41 #include "pldhash.h"
  42 #include "nsCOMPtr.h"
  43 #include "nsCRT.h"
  44 #include "nsIURI.h"
  45
  46 /**
  47  * Hashtable key class to use with nsTHashtable/nsBaseHashtable
  48  */
  49 class nsURIHashKey : public PLDHashEntryHdr
  50 {
  51 public:
  52     typedef nsIURI* KeyType;
  53     typedef const nsIURI* KeyTypePointer;
  54
  55     nsURIHashKey(const nsIURI* aKey) :
  56         mKey(const_cast<nsIURI*>(aKey)) { MOZ_COUNT_CTOR(nsURIHashKey); }
  57     nsURIHashKey(const nsURIHashKey& toCopy) :
  58         mKey(toCopy.mKey) { MOZ_COUNT_CTOR(nsURIHashKey); }
  59     ~nsURIHashKey() { MOZ_COUNT_DTOR(nsURIHashKey); }
  60
  61     nsIURI* GetKey() const { return mKey; }
  62
  63     PRBool KeyEquals(const nsIURI* aKey) const {
  64         PRBool eq;
  65         if (NS_SUCCEEDED(mKey->Equals(const_cast<nsIURI*>(aKey), &eq))) {
  66             return eq;
  67         }
  68         return PR_FALSE;
  69     }
  70
  71     static const nsIURI* KeyToPointer(nsIURI* aKey) { return aKey; }
  72     static PLDHashNumber HashKey(const nsIURI* aKey) {
  73         nsCAutoString spec;
  74         const_cast<nsIURI*>(aKey)->GetSpec(spec);
  75         return nsCRT::HashCode(spec.get());
  76     }
  77
  78     enum { ALLOW_MEMMOVE = PR_TRUE };
  79
  80 protected:
  81     nsCOMPtr<nsIURI> mKey;
  82 };
  83
  84 #endif // nsURIHashKey_h__