/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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 Mozilla Communicator client code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "pldhash.h"
#include "nscore.h"
#include "nsCOMPtr.h"

class nsAString;
class nsISupports;

/**
 * nsDoubleHashtableStringSupports
 *
 * A hashtable from string -> nsISupports*.  Holds strong references.
 */
class NS_COM nsDoubleHashtableStringSupports {
public:
  nsDoubleHashtableStringSupports();
  ~nsDoubleHashtableStringSupports();

  /**
   * Get the value referenced by the key.
   * Being a getter, this returns a strong reference.
   * @param aKey the key
   * @return the object referenced by aKey, or nsnull if none
   */
  already_AddRefed<nsISupports> Get(const nsAString& aKey);

  /**
   * Put the value into the hash to be referenced by the key.
   * @param aKey the key
   * @param aResult the return value
   */
  nsresult Put(const nsAString& aKey, nsISupports* aResult);

  /**
   * Remove the entry from the hash referenced by the key.
   * @param aKey the key
   * @param aResult the return value
   */
  nsresult Remove(nsAString& aKey);

  /**
   * Initialize this hashtable.  This MUST be called for the hashtable
   * to work.
   */
  nsresult Init();

protected:
  // Init() is protected because I want people to just be able to use the class
  // without fussing, so it's called in the constructor.
  PLDHashTable mHashTable;
};